Skip to content

Commit

Permalink
Merge pull request #16 from ThinkParQ/master
Browse files Browse the repository at this point in the history
Migrate repository to the ThinkParQ GitHub organization
  • Loading branch information
iamjoemccormick authored Sep 7, 2023
2 parents e357625 + 48cf1f8 commit 7bfb5f0
Show file tree
Hide file tree
Showing 249 changed files with 7,004 additions and 6,243 deletions.
548 changes: 548 additions & 0 deletions .github/workflows/build-test-publish.yaml

Large diffs are not rendered by default.

90 changes: 90 additions & 0 deletions .github/workflows/codeql.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
# ******** NOTE ********
# We have attempted to detect the languages in your repository. Please check
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
name: "Code scanning using CodeQL"

on:
push:
branches: ["master"]
pull_request:
# The branches below must be a subset of the branches above
branches: ["master"]
paths-ignore:
- "**/*.md"
- "**/*.txt"
schedule:
- cron: "26 10 * * 0"

jobs:
analyze:
name: Analyze
# Runner size impacts CodeQL analysis time. To learn more, please see:
# - https://gh.io/recommended-hardware-resources-for-running-codeql
# - https://gh.io/supported-runners-and-hardware-resources
# - https://gh.io/using-larger-runners
# Consider using larger runners for possible analysis time improvements.
runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
timeout-minutes: ${{ (matrix.language == 'swift' && 10) || 20 }} # Setting timeout to double what was actually observed.
permissions:
actions: read
contents: read
security-events: write

strategy:
fail-fast: false
matrix:
language: ["go"] # Note Python was auto detected but only used in release-tools.
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby', 'swift' ]
# Use only 'java' to analyze code written in Java, Kotlin or both
# Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support

steps:
- name: Checkout repository
uses: actions/checkout@v3

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v2
with:
# Enable to debug if fewer lines are scanned than expected:
# https://docs.github.com/en/code-security/code-scanning/troubleshooting-code-scanning/codeql-scanned-fewer-lines-than-expected
#debug: true
languages: ${{ matrix.language }}
# Run the all available queries: https://codeql.github.com/codeql-query-help/go/
queries: security-and-quality
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.

# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
# queries: security-extended,security-and-quality

# Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
# If this step fails, then you should remove it and run the build manually (see below)
# This is the default approach for Go: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages?learn=code_security_actions&learnProduct=code-security#autobuild-for-go
- name: Autobuild
uses: github/codeql-action/autobuild@v2

# ℹ️ Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun

# If the Autobuild fails above, remove it and uncomment the following three lines.
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.

# - run: |
# echo "Run, Build Application using script"
# ./location_of_script_within_repo/buildscript.sh

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2
with:
category: "/language:${{matrix.language}}"
31 changes: 31 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,37 @@
# Changelog
Notable changes to the BeeGFS CSI driver will be documented in this file.

[1.5.0] - PRERELEASE
--------------------

### Added
- Support for Kubernetes 1.26 and 1.27.
- Support for BeeGFS v7.3.4 and v7.4.0.

### Changed
- Migrated project to the ThinkParQ GitHub organization.
- Updated deployment manifests to accommodate new container registries. See the
[upgrade instructions](deploy/k8s/README.md##upgrading-to-v150) if you were
previously overriding image names or tags with a Kustomize overlay.
- BeeGFS CSI driver container images have been migrated from DockerHub to
GitHub Container Registry. This changes the default driver container name from
`docker.io/netapp/beegfs-csi-driver` to
`ghcr.io/thinkparq/beegfs-csi-driver:v1.5.0`.
- [Kubernetes CSI sidecar
containers](https://kubernetes-csi.github.io/docs/sidecar-containers.html)
have been migrated from `k8s.gcr.io` to `registry.k8s.io` since the former has
been
[deprecated](https://kubernetes.io/blog/2023/03/10/image-registry-redirect/).

### Deprecated
- Kubernetes v1.23 and v1.24 support will be dropped in the next driver release according
to our [support
policy](docs/compatibility.md#dropping-compatibility-support-for-old-kubernetes-releases).

### Removed
- Testing/support for RedHat OpenShift.
- [See the compatibility documentation](docs/compatibility.md#openshift) for more information about this change.
- Testing/support for Kubernetes v1.22 and BeeGFS v7.2.x.

[1.4.0] - 2022-12-12
--------------------
Expand Down
74 changes: 55 additions & 19 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,74 @@
# Contributing
# Contributing <!-- omit in toc -->
Thank you for your interest in contributing to the BeeGFS CSI driver project! 🎉

We appreciate that you want to take the time to contribute! Please follow these
steps before submitting your PR.

# Contents <!-- omit in toc -->

- [Developer Certificate of Origin (DCO)](#developer-certificate-of-origin-dco)
- [Creating a Pull Request](#creating-a-pull-request)
- [BeeGFS CSI Driver Team's Commitment](#beegfs-csi-driver-teams-commitment)

# Developer Certificate of Origin (DCO)

At this time signing a formal Contributor License Agreement is not required, but this requirement may be instated in the future. By contributing to this project, you agree to v1.1 of the [Developer Certificate of Origin (DCO)](https://developercertificate.org/), a copy of which is included before. This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution.

```text
Developer Certificate of Origin
Version 1.1
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
```

# Creating a Pull Request

1. Please search [existing
issues](https://github.com/NetApp/beegfs-csi-driver/issues) to determine if
issues](https://github.com/ThinkParQ/beegfs-csi-driver/issues) to determine if
an issue already exists for what you intend to contribute.
2. If the issue does not exist, [create a new
one](https://github.com/NetApp/beegfs-csi-driver/issues/new) that explains
one](https://github.com/ThinkParQ/beegfs-csi-driver/issues/new) that explains
the bug or feature request.
* Let us know in the issue that you plan on creating a pull request for it.
This helps us to keep track of the pull request and avoid any duplicate
efforts.
3. Before creating a pull request, write up a brief proposal in the issue
describing what your change would be and how it would work so that others can
comment.
* It's better to wait for feedback from someone on NetApp's BeeGFS CSI
driver development team before writing code. We don't have an SLA for our
feedback, but we will do our best to respond in a timely manner (at a
minimum, to give you an idea if you're on the right track and that you
should proceed, or not).
4. Sign and submit [NetApp's Corporate Contributor License Agreement
(CCLA)](https://netapp.tap.thinksmart.com/prod/Portal/ShowWorkFlow/AnonymousEmbed/3d2f3aa5-9161-4970-997d-e482b0b033fa).
* From the **Project Name** dropdown select `BeeGFS CSI Driver`.
* For the **Project Website** specify
`https://github.com/NetApp/beegfs-csi-driver`
5. If you've made it this far, have written the code that solves your issue, and
addressed the review comments, then feel free to create your pull request.

Important: **NetApp will NOT look at the PR or any of the code submitted in the
PR if the CCLA is not on file with NetApp Legal.**
* It's better to wait for feedback from the maintainers before writing code.
We don't have an SLA for our feedback, but we will do our best to respond
in a timely manner (at a minimum, to give you an idea if you're on the
right track and that you should proceed, or not).

# BeeGFS CSI Driver Team's Commitment
While we truly appreciate your efforts on pull requests, we **cannot** commit to
Expand All @@ -42,7 +78,7 @@ including your PR in the BeeGFS CSI driver project. Here are a few reasons why:
including:
* Adding appropriate unit and end-to-end test coverage for new/changed
functionality.
* Ensuring adherence with NetApp and industry standards around security and
* Ensuring adherence with ThinkParQ and industry standards around security and
licensing.
* Validating new functionality doesn't raise long-term maintainability and/or
supportability concerns.
Expand Down
5 changes: 4 additions & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,11 @@
# https://github.com/GoogleContainerTools/distroless for more details.
FROM gcr.io/distroless/static:latest

LABEL maintainers="NetApp"
LABEL maintainers="ThinkParQ"
LABEL description="BeeGFS CSI Driver"
LABEL org.opencontainers.image.description="BeeGFS CSI Driver"
LABEL org.opencontainers.image.source="https://github.com/ThinkParQ/beegfs-csi-driver"
LABEL org.opencontainers.image.licenses="Apache-2.0"

# Copy all built binaries to netapp/ directory.
COPY bin/beegfs-csi-driver bin/chwrap netapp/
Expand Down
Loading

0 comments on commit 7bfb5f0

Please sign in to comment.