diff --git a/.github/workflows/build-test-publish-operator.yaml b/.github/workflows/build-test-publish-operator.yaml new file mode 100644 index 00000000..8bf8b677 --- /dev/null +++ b/.github/workflows/build-test-publish-operator.yaml @@ -0,0 +1,360 @@ +name: "Test and Publish BeeGFS CSI Driver Operator" + +# Adapted from: +# https://docs.github.com/en/actions/using-workflows/triggering-a-workflow +# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on +# https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_run +on: + workflow_dispatch: + # This workflow should run after we've built the CSI driver container image and it is available as test package. + workflow_run: + workflows: [Test and Publish BeeGFS CSI Driver] + types: + - completed + +env: + # Container image registry to publish images to: + REGISTRY: ghcr.io + # Where to push an image of the operator that will be retained (for master builds or releases) without a specific tag: + IMAGE_NAME: ghcr.io/thinkparq/beegfs-csi-driver-operator + # Where to push an image of the operator for testing without a specific tag: + TEST_IMAGE_NAME: ghcr.io/thinkparq/test-beegfs-csi-driver-operator + # Where to push an image of the bundle for testing without a specific tag: + TEST_BUNDLE_NAME: ghcr.io/thinkparq/test-beegfs-csi-driver-bundle + # What container image should be deployed by the operator for testing the BeeGFS CSI driver deployment: + TEST_CSI_IMAGE_NAME: ghcr.io/thinkparq/test-beegfs-csi-driver + + # Note for all test images the github.sha will be used as the tag. + +jobs: + build-and-unit-test: + runs-on: ubuntu-22.04 + timeout-minutes: 5 + permissions: + packages: write + contents: read + steps: + - uses: actions/checkout@v3 + with: + # Work around for how release-tools verify-subtree.sh verifies release-tools has not been modified. + fetch-depth: "0" + + - name: Set up Go + uses: actions/setup-go@v4 + with: + go-version: 1.20.4 + # Dependencies are cached by default: https://github.com/actions/setup-go#v4 + # This can be explicitly disabled if it ever causes problems. + + # TODO: Cache this dependency for reuse here and in e2e tests. + # https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go#caching-dependencies + # Adapted from https://sdk.operatorframework.io/docs/installation/#install-from-github-release + - name: Install the Operator SDK + run: | + export ARCH=$(case $(uname -m) in x86_64) echo -n amd64 ;; aarch64) echo -n arm64 ;; *) echo -n $(uname -m) ;; esac) + export OS=$(uname | awk '{print tolower($0)}') + export OPERATOR_SDK_DL_URL=https://github.com/operator-framework/operator-sdk/releases/download/v1.25.0 + curl -LO ${OPERATOR_SDK_DL_URL}/operator-sdk_${OS}_${ARCH} + chmod +x operator-sdk_${OS}_${ARCH} && sudo mv operator-sdk_${OS}_${ARCH} /usr/local/bin/operator-sdk + + - name: Log into GitHub container registry + uses: docker/login-action@v2 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + # For now just tag the image with the commit ID and publish as a test package. + # This ensures subsequent jobs in this workflow run use the correct image. + # If the operator passes all tests, it can be retagged as a master or release build. + - name: Build, test, and push operator as a test package + run: | + cd operator + make -e IMG=${{ env.TEST_IMAGE_NAME }}:${{ github.sha }} build docker-build + # Build bundle without modification to verify that generated code and manifests are up to date. + make bundle + if ! git diff --exit-code > /dev/null; then + # The above make steps have run all generators. The developer making changes should also + # have run all generators and committed the result. Do not proceed if the generators run + # here produce different output than the developer committed. + echo "ERROR: Generated code and/or manifests are not up to date" + git diff + exit 1 + fi + + make -e IMG=${{ env.TEST_IMAGE_NAME }}:${{ github.sha }} docker-push + + # The bundle container built in this step can only be used for testing. + # This is because it references an operator image tag that will be cleaned up after this workflow completes. + # This is fine because a bundle container is not actually used to release the operator (the pristine bundle directory is used instead). + - name: Build and push the operator bundle as a test package + run: | + cd operator + make -e IMG=${{ env.TEST_IMAGE_NAME }}:${{ github.sha }} -e BUNDLE_IMG=${{ env.TEST_BUNDLE_NAME }}:${{ github.sha }} bundle bundle-build bundle-push + + e2e-tests: + runs-on: ubuntu-22.04 + timeout-minutes: 10 + needs: build-and-unit-test + strategy: + fail-fast: true + matrix: + k8s-version: [1.26.3] # TODO: Expand tested versions (1.24.15, 1.25.11, 1.26.3, 1.27.3) + beegfs-version: [7.3.4] # TODO: Expand tested versions + permissions: + packages: read + contents: read + steps: + - uses: actions/checkout@v3 + + - name: Deploy Kubernetes ${{ matrix.k8s-version }} using Minikube + uses: medyagh/setup-minikube@latest + with: + #driver: none + # Cannot use "none" driver with OLM. + kubernetes-version: ${{ matrix.k8s-version }} + mount-path: "/etc/beegfs:/etc/beegfs" + + # TODO: Cache this dependency for reuse here and above. + # https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go#caching-dependencies + # Adapted from https://sdk.operatorframework.io/docs/installation/#install-from-github-release + - name: Install the Operator SDK + run: | + export ARCH=$(case $(uname -m) in x86_64) echo -n amd64 ;; aarch64) echo -n arm64 ;; *) echo -n $(uname -m) ;; esac) + export OS=$(uname | awk '{print tolower($0)}') + export OPERATOR_SDK_DL_URL=https://github.com/operator-framework/operator-sdk/releases/download/v1.25.0 + curl -LO ${OPERATOR_SDK_DL_URL}/operator-sdk_${OS}_${ARCH} + chmod +x operator-sdk_${OS}_${ARCH} && sudo mv operator-sdk_${OS}_${ARCH} /usr/local/bin/operator-sdk + + - name: Run Operator Scorecard + run: | + operator-sdk scorecard ./operator/bundle -w 180s > /tmp/scorecard.txt 2>&1 || (echo "SCORECARD FAILURE!" && exit 1) + + - name: Save the Operator Scorecard results as an artifact + uses: actions/upload-artifact@v3 + if: ${{ always() }} + with: + name: operator-scorecard-k8s-${{ matrix.k8s-version }} + path: /tmp/scorecard.txt + + - name: Install Operator Lifecycle Manager (OLM) + run: | + curl -L https://github.com/operator-framework/operator-lifecycle-manager/releases/download/v0.25.0/install.sh -o install.sh + chmod +x install.sh + ./install.sh v0.25.0 + + - name: Deploy BeeGFS ${{ matrix.beegfs-version }} for testing and expose as a service to the host OS + run: | + export BEEGFS_VERSION=$(echo ${{ matrix.beegfs-version }}) + export BEEGFS_SECRET=$(echo ${{ secrets.CONN_AUTH_SECRET }}) + envsubst < test/env/beegfs-ubuntu/beegfs-fs-1.yaml | kubectl apply -f - + + MAX_ATTEMPTS=36 + SLEEP_TIME=5 + COUNTER=0 + + # If we try to expose the service to the host OS before the pod is ready we'll get an error. + # Make sure the BeeGFS FS started before we continue. + while [ $COUNTER -lt $MAX_ATTEMPTS ]; do + POD_STATUS=$(kubectl get pods beegfs-fs-1-0 -o jsonpath='{.status.phase}') + echo "Pod status: ${POD_STATUS}" + if [ "${POD_STATUS}" == "Running" ]; then + echo "Verified BeeGFS FS pod is running." + break + else + echo "Pod is not running, waiting for ${SLEEP_TIME} seconds..." + sleep ${SLEEP_TIME} + COUNTER=$((COUNTER+1)) + fi + done + + if [ $COUNTER -eq $MAX_ATTEMPTS ]; then + echo "BeeGFS FS pod did not reach 'Running' status within the maximum allowed time. Outputting debug information and exiting with error..." + kubectl get pods -A + kubectl describe pod beegfs-fs-1-0 + docker images + exit 1 + fi + + # Adapted from https://minikube.sigs.k8s.io/docs/handbook/accessing/ + # Exposes the service directly to the host operating system. + # This is required to mount BeeGFS since the kernel module is outside the container. + # For some reason we don't need to override the ephemeral port and can use the actual 800* ports. + minikube service beegfs-fs-1-svc + + # TODO: Cache BeeGFS packages https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows + # https://stackoverflow.com/questions/59269850/caching-apt-packages-in-github-actions-workflow + - name: Install the BeeGFS ${{ matrix.beegfs-version }} DKMS client + run: | + sudo wget -P /etc/apt/sources.list.d/. https://www.beegfs.io/release/beegfs_${{ matrix.beegfs-version }}/dists/beegfs-focal.list + sudo wget -q https://www.beegfs.io/release/beegfs_${{ matrix.beegfs-version }}/gpg/GPG-KEY-beegfs -O- | sudo apt-key add - + sudo apt-get update && sudo apt-get install beegfs-client-dkms beegfs-helperd beegfs-utils -y + sudo sed -i 's/connDisableAuthentication = false/connDisableAuthentication = true/' /etc/beegfs/beegfs-helperd.conf + sudo systemctl start beegfs-helperd && sudo systemctl enable beegfs-helperd + + - name: Install BeeGFS ${{ matrix.beegfs-version }} beegfs-ctl tool into the Minikube container + run: | + minikube ssh "sudo apt-get update" + minikube ssh "sudo apt-get install wget -y" + minikube ssh "sudo wget -q https://www.beegfs.io/release/beegfs_${{ matrix.beegfs-version }}/gpg/GPG-KEY-beegfs -O- | sudo apt-key add -" + minikube ssh "sudo wget -P /etc/apt/sources.list.d/ https://www.beegfs.io/release/beegfs_${{ matrix.beegfs-version }}/dists/beegfs-focal.list" + minikube ssh "sudo apt-get update" + minikube ssh "sudo apt-get install beegfs-utils -y" + + - name: Use operator-sdk to create a pod to serve the bundle to OLM via subscription + run: | + operator-sdk run bundle ${{ env.TEST_BUNDLE_NAME }}:${{ github.sha }} + + # TODO (BCSI-7): Actually run e2e tests using Ginko with an appropriate timeout. + + - name: Deploy a BeeGFSDriver object + run: | + export CSI_IMAGE_NAME=$(echo ${{ env.TEST_CSI_IMAGE_NAME }}) + export CSI_IMAGE_TAG=$(echo ${{ github.sha }}) + export BEEGFS_SECRET=$(echo ${{ secrets.CONN_AUTH_SECRET }}) + export BEEGFS_MGMTD=$(kubectl get nodes -o=jsonpath='{.items[0].status.addresses[?(@.type=="InternalIP")].address}') + envsubst < test/env/beegfs-ubuntu/csi-beegfs-cr.yaml | kubectl apply -f - + + - name: Deploy all examples to verify the driver is available + run: | + minikube ssh "sudo echo ${{ secrets.CONN_AUTH_SECRET }} | sudo tee /etc/beegfs/connAuth" + minikube ssh "sudo sed -i '0,/connAuthFile[[:space:]]*=[[:space:]]*/s//connAuthFile = \/etc\/beegfs\/connAuth/' /etc/beegfs/beegfs-client.conf" + minikube ssh "sudo sed -i '0,/sysMgmtdHost[[:space:]]*=[[:space:]]*/s//sysMgmtdHost = localhost/' /etc/beegfs/beegfs-client.conf" + minikube ssh "sudo beegfs-ctl --cfgFile=/etc/beegfs/beegfs-client.conf --unmounted --createdir /k8s" + minikube ssh "sudo beegfs-ctl --cfgFile=/etc/beegfs/beegfs-client.conf --unmounted --createdir /k8s/all" + minikube ssh "sudo beegfs-ctl --cfgFile=/etc/beegfs/beegfs-client.conf --unmounted --createdir /k8s/all/static" + minikube ssh "sudo beegfs-ctl --cfgFile=/etc/beegfs/beegfs-client.conf --unmounted --createdir /k8s/all/static-ro" + export BEEGFS_MGMTD=$(kubectl get nodes -o=jsonpath='{.items[0].status.addresses[?(@.type=="InternalIP")].address}') + for file in examples/k8s/all/*; do sed -i 's/localhost/'"${BEEGFS_MGMTD}"'/g' "$file"; done + kubectl apply -f examples/k8s/all + + # If the controller or node service failed to start, our test pod would still be in phase pending. + # We'll check periodically if the pod has started and if we reach the max number of attempts fail with debug output. + - name: Wait and verify the test pod is running + run: | + MAX_ATTEMPTS=36 + SLEEP_TIME=5 + COUNTER=0 + + while [ $COUNTER -lt $MAX_ATTEMPTS ]; do + POD_STATUS=$(kubectl get pods csi-beegfs-all-app -o jsonpath='{.status.phase}') + echo "Pod status: ${POD_STATUS}" + if [ "${POD_STATUS}" == "Running" ]; then + echo "Verified test pod is running." + break + else + echo "Pod is not running, waiting for ${SLEEP_TIME} seconds..." + sleep ${SLEEP_TIME} + COUNTER=$((COUNTER+1)) + fi + done + + if [ $COUNTER -eq $MAX_ATTEMPTS ]; then + echo "Test pod did not reach 'Running' status within the maximum allowed time. Outputting debug information and exiting with error..." + kubectl get pods -A + kubectl describe pod csi-beegfs-controller-0 + POD_NAME=$(kubectl get pods -o jsonpath='{range .items[*]}{.metadata.name}{"\n"}{end}' | grep 'csi-beegfs-node-') + kubectl describe pod $POD_NAME + kubectl describe pod csi-beegfs-all-app + docker images + exit 1 + fi + + publish-images: + runs-on: ubuntu-22.04 + timeout-minutes: 5 + needs: e2e-tests + if: github.event_name != 'pull_request' + permissions: + packages: write + contents: read + steps: + - uses: actions/checkout@v3 + + - name: Install Cosign + uses: sigstore/cosign-installer@v3.1.1 + with: + cosign-release: "v2.1.1" + + - name: Pull tested operator image from ghcr.io + run: | + docker pull ${{ env.TEST_IMAGE_NAME }}:${{ github.sha }} + + - name: Log into the GitHub Container Registry + uses: docker/login-action@v2 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + # This uses the semantic versioning option for https://github.com/docker/metadata-action#semver + - name: Extract metadata for published operator container image + id: meta + uses: docker/metadata-action@v4 + with: + images: | + ${{ env.IMAGE_NAME }} + tags: | + type=ref,event=branch + type=ref,event=pr + type=semver,pattern={{version}},prefix=v + type=semver,pattern={{major}}.{{minor}},prefix=v + + # TODO: Consider adding labels available as steps.meta.output.labels. + - name: Tag and push the operator image to GitHub Container Registry + run: | + tags=$(echo "${{ steps.meta.outputs.tags }}" | tr '\n' ' ') + for tag in $tags; do + docker tag ${{ env.TEST_IMAGE_NAME }}:${{ github.sha }} $tag + docker push $tag + done + + # Adapted from: + # https://github.blog/2021-12-06-safeguard-container-signing-capability-actions/ + # https://github.com/sigstore/cosign-installer#usage + - name: Sign operator image with Cosign + run: | + tags=$(echo "${{ steps.meta.outputs.tags }}" | tr '\n' ' ') + for tag in $tags; do + DIGEST=$(docker image inspect $tag --format '{{index .RepoDigests 0}}') + cosign sign --yes --key env://COSIGN_PRIVATE_KEY \ + -a "repo=${{ github.repository }}" \ + -a "run=${{ github.run_id }}" \ + -a "ref=${{ github.sha }}" \ + $DIGEST + done + env: + COSIGN_PRIVATE_KEY: ${{ secrets.COSIGN_PRIVATE_KEY }} + COSIGN_PASSWORD: ${{ secrets.COSIGN_PASSWORD }} + + # We'll keep around a few old test packages to (a) avoid deleting image for workflows running in parallel, + # and (b) it may be useful to pull a package to troubleshoot workflow failures. + cleanup-test-images: + runs-on: ubuntu-22.04 + timeout-minutes: 3 + needs: publish-images + if: always() + steps: + - name: Extract package names + run: | + test_image_name="${{ env.TEST_IMAGE_NAME }}" + test_image_pkg=${test_image_name##*/} + echo "TEST_IMAGE_PKG=$test_image_pkg" >> $GITHUB_ENV + + test_bundle_name="${{ env.TEST_BUNDLE_NAME }}" + test_bundle_pkg=${test_bundle_name##*/} + echo "TEST_BUNDLE_PKG=$test_bundle_pkg" >> $GITHUB_ENV + + - name: Cleanup old ${{ env.TEST_IMAGE_PKG }} packages + uses: actions/delete-package-versions@v4 + with: + package-name: "${{ env.TEST_IMAGE_PKG }}" + package-type: "container" + min-versions-to-keep: 5 + + - name: Cleanup old ${{ env.TEST_BUNDLE_PKG }} packages + uses: actions/delete-package-versions@v4 + with: + package-name: "${{ env.TEST_BUNDLE_PKG }}" + package-type: "container" + min-versions-to-keep: 5 diff --git a/.github/workflows/build-test-publish.yaml b/.github/workflows/build-test-publish.yaml new file mode 100644 index 00000000..06af60f1 --- /dev/null +++ b/.github/workflows/build-test-publish.yaml @@ -0,0 +1,262 @@ +name: "Test and Publish BeeGFS CSI Driver" + +on: + workflow_dispatch: + push: + branches: + - "master" + tags: + - "v*" + pull_request: + branches: + - "master" + +env: + # Container image registry to publish images to: + REGISTRY: ghcr.io + # Where to push an image of the CSI driver that will be retained (for master builds or releases) without a specific tag: + IMAGE_NAME: ghcr.io/thinkparq/beegfs-csi-driver + # Where to push an image of the CSI driver for testing (including the operator) without a specific tag: + TEST_IMAGE_NAME: ghcr.io/thinkparq/test-beegfs-csi-driver + + # Note for all test images the github.sha will be used as the tag. + +jobs: + build-and-unit-test: + runs-on: ubuntu-22.04 + timeout-minutes: 5 + permissions: + packages: write + contents: read + steps: + - uses: actions/checkout@v3 + with: + # Work around for how release-tools verify-subtree.sh verifies release-tools has not been modified. + fetch-depth: "0" + + - name: Set up Go + uses: actions/setup-go@v4 + with: + go-version: 1.20.4 + # Dependencies are cached by default: https://github.com/actions/setup-go#v4 + # This can be explicitly disabled if it ever causes problems. + + - name: Build the container image + run: | + export SHELL=/bin/bash + make container + echo -n "verifying images:" + docker images + + - name: Install test dependencies + run: | + go install github.com/onsi/ginkgo/v2/ginkgo@v2.4.0 + timeout-minutes: 5 + + - name: Run unit tests + run: | + ACK_GINKGO_DEPRECATIONS=1.16.5 TESTARGS="-v -ginkgo.v" make test + # TODO: Consider if we should write the results to a file and keep it as an artifact. + # For example using: https://github.com/marketplace/actions/junit-report-action + # TODO: Can we cache anything here? test-vendor downloads a lot of stuff. + # https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go#caching-dependencies + + - name: Log into the GitHub Container Registry + uses: docker/login-action@v2 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + # Push the image for reuse in subsequent steps, jobs, and workflows. + # For now just tag with the commit ID to ensure subsequent jobs in this workflow run use the correct image. + - name: Tag and push the CSI driver as a test package + run: | + docker tag beegfs-csi-driver:latest ${{ env.TEST_IMAGE_NAME }}:${{ github.sha }} + docker push ${{ env.TEST_IMAGE_NAME }}:${{ github.sha }} + + e2e-tests: + runs-on: ubuntu-22.04 + timeout-minutes: 10 + needs: build-and-unit-test + strategy: + fail-fast: true + matrix: + k8s-version: [1.24.15, 1.25.11, 1.26.3, 1.27.3] + beegfs-version: [7.3.4] + permissions: + packages: read + contents: read + steps: + - uses: actions/checkout@v3 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v2 + + - name: Deploy Kubernetes ${{ matrix.k8s-version }} using Minikube + uses: medyagh/setup-minikube@latest + with: + driver: none + kubernetes-version: ${{ matrix.k8s-version }} + + - name: Deploy BeeGFS ${{ matrix.beegfs-version }} for testing + run: | + export BEEGFS_VERSION=$(echo ${{ matrix.beegfs-version }}) + export BEEGFS_SECRET=$(echo ${{ secrets.CONN_AUTH_SECRET }}) + envsubst < test/env/beegfs-ubuntu/beegfs-fs-1.yaml | kubectl apply -f - + kubectl get pods -A + + # TODO: Cache BeeGFS packages https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows + # https://stackoverflow.com/questions/59269850/caching-apt-packages-in-github-actions-workflow + - name: Install the BeeGFS ${{ matrix.beegfs-version }} DKMS client + run: | + sudo wget -P /etc/apt/sources.list.d/. https://www.beegfs.io/release/beegfs_${{ matrix.beegfs-version }}/dists/beegfs-focal.list + sudo wget -q https://www.beegfs.io/release/beegfs_${{ matrix.beegfs-version }}/gpg/GPG-KEY-beegfs -O- | sudo apt-key add - + sudo apt-get update && sudo apt-get install beegfs-client-dkms beegfs-helperd beegfs-utils -y + sudo sed -i 's/connDisableAuthentication = false/connDisableAuthentication = true/' /etc/beegfs/beegfs-helperd.conf + sudo systemctl start beegfs-helperd && sudo systemctl enable beegfs-helperd + + - name: Deploy the BeeGFS CSI driver + run: | + export BEEGFS_SECRET=$(echo ${{ secrets.CONN_AUTH_SECRET }}) + envsubst < test/env/beegfs-ubuntu/csi-beegfs-connauth.yaml > deploy/k8s/overlays/default/csi-beegfs-connauth.yaml + # TODO: Enable once the K8s versions in the matrix are added to versions/ + # sed -i 's?/versions/latest?/versions/v${{ matrix.k8s-version }}?g' deploy/k8s/overlays/default/kustomization.yaml + echo -e "\nimages:\n - name: ${{ env.IMAGE_NAME }}\n newName: ${{ env.TEST_IMAGE_NAME }}\n newTag: ${{ github.sha }}" >> deploy/k8s/overlays/default/kustomization.yaml + kubectl apply -k deploy/k8s/overlays/default + + # TODO (BCSI-7): Actually run e2e tests using Ginko with an appropriate timeout. + + - name: Deploy all examples to verify the driver is available + run: | + echo "${{ secrets.CONN_AUTH_SECRET }}" | sudo tee /etc/beegfs/connAuth + sudo sed -i '0,/connAuthFile[[:space:]]*=[[:space:]]*/s//connAuthFile = \/etc\/beegfs\/connAuth/' /etc/beegfs/beegfs-client.conf + sudo sed -i '0,/sysMgmtdHost[[:space:]]*=[[:space:]]*/s//sysMgmtdHost = localhost/' /etc/beegfs/beegfs-client.conf + sudo beegfs-ctl --cfgFile=/etc/beegfs/beegfs-client.conf --unmounted --createdir /k8s + sudo beegfs-ctl --cfgFile=/etc/beegfs/beegfs-client.conf --unmounted --createdir /k8s/all + sudo beegfs-ctl --cfgFile=/etc/beegfs/beegfs-client.conf --unmounted --createdir /k8s/all/static + sudo beegfs-ctl --cfgFile=/etc/beegfs/beegfs-client.conf --unmounted --createdir /k8s/all/static-ro + kubectl apply -f examples/k8s/all + + # If the controller or node service failed to start, our test pod would still be in phase pending. + # We'll check periodically if the pod has started and if we reach the max number of attempts fail with debug output. + - name: Wait and verify the test pod is running + run: | + MAX_ATTEMPTS=36 + SLEEP_TIME=5 + COUNTER=0 + + while [ $COUNTER -lt $MAX_ATTEMPTS ]; do + POD_STATUS=$(kubectl get pods csi-beegfs-all-app -o jsonpath='{.status.phase}') + echo "Pod status: ${POD_STATUS}" + if [ "${POD_STATUS}" == "Running" ]; then + echo "Verified test pod is running." + break + else + echo "Pod is not running, waiting for ${SLEEP_TIME} seconds..." + sleep ${SLEEP_TIME} + COUNTER=$((COUNTER+1)) + fi + done + + if [ $COUNTER -eq $MAX_ATTEMPTS ]; then + echo "Test pod did not reach 'Running' status within the maximum allowed time. Outputting debug information and exiting with error..." + kubectl get pods -A + kubectl describe pod -n beegfs-csi csi-beegfs-controller-0 + POD_NAME=$(kubectl get pods -n beegfs-csi -o jsonpath='{range .items[*]}{.metadata.name}{"\n"}{end}' | grep 'csi-beegfs-node-') + kubectl describe pod -n beegfs-csi $POD_NAME + kubectl describe pod csi-beegfs-all-app + docker images + exit 1 + fi + + publish-images: + runs-on: ubuntu-22.04 + timeout-minutes: 5 + needs: e2e-tests + if: github.event_name != 'pull_request' + permissions: + packages: write + contents: read + steps: + - uses: actions/checkout@v3 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v2 + + - name: Install Cosign + uses: sigstore/cosign-installer@v3.1.1 + with: + cosign-release: "v2.1.1" + + - name: Pull tested CSI driver image from ghcr.io + run: | + docker pull ${{ env.TEST_IMAGE_NAME }}:${{ github.sha }} + + - name: Log in to the GitHub Container Registry + uses: docker/login-action@v2 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + # This uses the semantic versioning option for https://github.com/docker/metadata-action#semver + - name: Extract metadata for container image + id: meta + uses: docker/metadata-action@v4 + with: + images: | + ${{ env.IMAGE_NAME }} + tags: | + type=ref,event=branch + type=ref,event=pr + type=semver,pattern={{version}},prefix=v + type=semver,pattern={{major}}.{{minor}},prefix=v + + # TODO: Consider adding labels available as steps.meta.output.labels. + - name: Tag and push the image to GitHub Container Registry + run: | + tags=$(echo "${{ steps.meta.outputs.tags }}" | tr '\n' ' ') + for tag in $tags; do + docker tag ${{ env.TEST_IMAGE_NAME }}:${{ github.sha }} $tag + docker push $tag + done + + # Adapted from: + # https://github.blog/2021-12-06-safeguard-container-signing-capability-actions/ + # https://github.com/sigstore/cosign-installer#usage + - name: Sign image with Cosign + run: | + tags=$(echo "${{ steps.meta.outputs.tags }}" | tr '\n' ' ') + for tag in $tags; do + DIGEST=$(docker image inspect $tag --format '{{index .RepoDigests 0}}') + cosign sign --yes --key env://COSIGN_PRIVATE_KEY \ + -a "repo=${{ github.repository }}" \ + -a "run=${{ github.run_id }}" \ + -a "ref=${{ github.sha }}" \ + $DIGEST + done + env: + COSIGN_PRIVATE_KEY: ${{ secrets.COSIGN_PRIVATE_KEY }} + COSIGN_PASSWORD: ${{ secrets.COSIGN_PASSWORD }} + + # We'll keep around a few old test packages to (a) avoid deleting image for workflows running in parallel, + # and (b) it may be useful to pull a package to troubleshoot workflow failures. + cleanup-test-images: + runs-on: ubuntu-22.04 + timeout-minutes: 3 + needs: publish-images + if: always() + steps: + - name: Extract package names + run: | + test_image_name="${{ env.TEST_IMAGE_NAME }}" + test_image_pkg=${test_image_name##*/} + echo "TEST_IMAGE_PKG=$test_image_pkg" >> $GITHUB_ENV + + - name: Cleanup old ${{ env.TEST_IMAGE_PKG }} packages + uses: actions/delete-package-versions@v4 + with: + package-name: "${{ env.TEST_IMAGE_PKG }}" + package-type: "container" + min-versions-to-keep: 5 diff --git a/.github/workflows/codeql.yaml b/.github/workflows/codeql.yaml new file mode 100644 index 00000000..96a215b3 --- /dev/null +++ b/.github/workflows/codeql.yaml @@ -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}}" diff --git a/CHANGELOG.md b/CHANGELOG.md index dce8fdc1..a6fdb051 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,12 @@ # Changelog Notable changes to the BeeGFS CSI driver will be documented in this file. +[1.5.0] - PRERELEASE +-------------------- + +### Changed +- Migrated project to the ThinkParQ GitHub organization. +- Migrated container images from DockerHub to GitHub Container Registry. [1.4.0] - 2022-12-12 -------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5de2f182..4c386ad6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,16 +1,63 @@ -# Contributing +# Contributing 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 + +- [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 @@ -18,21 +65,10 @@ steps before submitting your PR. 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 @@ -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. diff --git a/Dockerfile b/Dockerfile index c9b783c8..c4a8599e 100644 --- a/Dockerfile +++ b/Dockerfile @@ -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/ diff --git a/Jenkinsfile b/Jenkinsfile deleted file mode 100644 index 09fc0e07..00000000 --- a/Jenkinsfile +++ /dev/null @@ -1,478 +0,0 @@ -// Copyright 2021 NetApp, Inc. All Rights Reserved. -// Licensed under the Apache License, Version 2.0. - -// Set up build parameters so any branch can be manually rebuilt with different values. -properties([ - parameters([ - string(name: 'hubProjectVersion', defaultValue: '', description: 'Set this to force a Black Duck scan and ' + - 'manually tag it to a particular Black Duck version (e.g. 1.0.1).'), - booleanParam(name: 'shouldEndToEndTest', defaultValue: false, description: 'Set this to true to force ' + - 'end-to-end testing for a branch build. Note that end-to-end testing always occurs on PR and master ' + - 'builds.') - ]) -]) - -paddedBuildNumber = env.BUILD_NUMBER.padLeft(4, '0') -imageName = 'beegfs-csi-driver' // release-tools gives significance to the name of the /cmd/beegfs-csi-driver directory. -releaseToolsImageTag = 'beegfs-csi-driver:latest' // The "make container" method in build.make uses this tag. - -hubProjectName = 'esg-beegfs-csi-driver' -hubProjectVersion = '' -shouldHubScan = false -if (params.hubProjectVersion != '') { - // Scan the project and tag the manually selected version if the hubProjectVersion build parameter is set. - hubProjectVersion = params.hubProjectVersion - shouldHubScan = true -} else if (env.BRANCH_NAME.matches('(master)|(release-.+)')) { - // Scan the project and tag the branch name if this is the release or master branch. - hubProjectVersion = env.BRANCH_NAME - shouldHubScan = true -} - -shouldEndToEndTest = params.shouldEndToEndTest // Definitely end-to-end test if requested. -if (env.BRANCH_NAME.matches('(master)|(release-.+)|PR-.+')) { // Always end-to-end test master, release, and PR builds. - shouldEndToEndTest = true -} - -// We do NOT rely on release-tools tagging mechanism for internal builds because it does not provide mechanisms for -// overwriting image tags, etc. -remoteImageName = "docker.repo.eng.netapp.com/globalcicd/apheleia/${imageName}" -imageTag = "${remoteImageName}:${env.BRANCH_NAME}" // e.g. .../globalcicd/apheleia/beegfs-csi-driver:my-branch -uniqueImageTag = "${imageTag}-${paddedBuildNumber}" // e.g. .../globalcicd/apheleia/beegfs-csi-driver:my-branch-0005 - -operatorImageName = "${remoteImageName}-operator" -operatorImageTag = "${operatorImageName}:${env.BRANCH_NAME}" -uniqueOperatorImageTag = "${operatorImageTag}-${paddedBuildNumber}" - -bundleImageName = "${operatorImageName}-bundle" -bundleImageTag = "${bundleImageName}:${env.BRANCH_NAME}" -uniqueBundleImageTag = "${bundleImageTag}-${paddedBuildNumber}" - -pipeline { - agent any - - options { - timestamps() - timeout(time: 3, unit: 'HOURS') - buildDiscarder(logRotator(artifactNumToKeepStr: '15')) - } - - stages { - stage('Unit Test') { - options { - timeout(time: 10, unit: 'MINUTES') - } - steps { - // release-tools always uses a container named k8s-shellcheck in its test. Make sure each node is only - // using this tag for one build at a time. - lock(resource: "k8s-shellcheck-${env.NODE_NAME}") { - script { - def testCommand = 'ACK_GINKGO_DEPRECATIONS=1.16.5 TESTARGS="-v -ginkgo.v" make test > ' + - 'results/unit-test.log' - sh "make check-go-version" - if (env.BRANCH_NAME.matches('(master)|(release-.+)|(PR-.+)')) { - // When JOB_NAME is empty, the conditional logic in release-tools/verify-vendor.sh allows - // for vendor testing. - sh "mkdir results/ && JOB_NAME= ${testCommand}" - } else { - // When JOB_NAME is not empty (automatically set by Jenkins), the conditional logic in - // release-tools/verify-vendor.sh does not allow for vendor testing. This is good, because - // vendor testing forces a download of all modules, which is time/bandwidth intensive. - sh "mkdir results/ && ${testCommand}" - } - } - } - } - } - stage('Build Container') { - steps { - // release-tools always builds the container with the same releaseToolsImageTag - // (e.g. beegfs-csi-driver:latest). Make sure each node is only using this tag for one build at a time. - lock(resource: "${releaseToolsImageTag}-${env.NODE_NAME}") { - sh """ - set +e # don't exit on failure - make container - RETURN_CODE=\$? # remember return code - docker tag ${releaseToolsImageTag} ${uniqueImageTag} - docker rmi ${imageName}:latest # clean up before releasing lock - exit \$RETURN_CODE - """ - } - } - } - stage('Push Container') { - options { - timeout(time: 5, unit: 'MINUTES') - } - steps { - withDockerRegistry([credentialsId: 'mswbuild', url: 'https://docker.repo.eng.netapp.com']) { - sh """ - docker tag ${uniqueImageTag} ${imageTag} - docker push ${uniqueImageTag} - docker push ${imageTag} - """ - } - } - } - // The operator built in this step can be retagged and released to Docker Hub as needed. - stage('Build, Test, and Push Operator') { - options { - timeout(time: 5, unit: 'MINUTES') - } - steps { - // envtest sets up a variety of services that listen on different ports. While we can change the ports - // used relatively easily, we cannot easily make the ports random. Better to make sure envtest is only - // in use by one build at a time on a particular node. - lock(resource: "envtest-${env.NODE_NAME}") { - sh """ - cd operator - make -e IMG=${uniqueOperatorImageTag} build docker-build - # Build bundle without modification to verify that generated code and manifests are up to date. - make bundle - if [[ \$(git diff) ]] - then - # The above make steps have run all generators. The developer making changes should also - # have run all generators and committed the result. Do not proceed if the generators run - # here produce different output than the developer committed. - echo "ERROR: Generated code and/or manifests are not up to date" - git diff - exit 1 - fi - """ - } - withDockerRegistry([credentialsId: 'mswbuild', url: 'https://docker.repo.eng.netapp.com']) { - sh """ - cd operator - docker tag ${uniqueOperatorImageTag} ${operatorImageTag} - make -e IMG=${uniqueOperatorImageTag} docker-push - make -e IMG=${operatorImageTag} docker-push - """ - } - } - } - // The bundle container built in this step can only be used for testing, as it references an operator image tag - // that does not exist on Docker Hub. This is fine because a bundle container is not actually used to release - // an operator (the pristine bundle directory is used instead). - stage('Build and Push Bundle') { - options { - timeout(time: 5, unit: 'MINUTES') - } - steps { - withDockerRegistry([credentialsId: 'mswbuild', url: 'https://docker.repo.eng.netapp.com']) { - sh """ - cd operator - make -e IMG=${uniqueOperatorImageTag} -e BUNDLE_IMG=${uniqueBundleImageTag} bundle bundle-build bundle-push - make -e IMG=${operatorImageTag} -e BUNDLE_IMG=${bundleImageTag} bundle bundle-build bundle-push - """ - } - } - } - stage("BlackDuck Scan") { - options { - timeout(time: 10, unit: 'MINUTES') - } - when { - expression { shouldHubScan } - } - steps { - // Do not scan the vendor directory. Everything in the vendor director is already discovered by the - // GO_MOD detector and scanning it provides duplicate results with erroneous versions. - synopsys_detect detectProperties: """ - --detect.project.name=${hubProjectName} \ - --detect.project.version.name=${hubProjectVersion} \ - --detect.cleanup=false \ - --detect.output.path=blackduck \ - --detect.project.code.location.unmap=true \ - --detect.detector.search.depth=50 \ - --detect.code.location.name=${hubProjectName}_${hubProjectVersion}_application_code \ - --detect.bom.aggregate.name=${hubProjectName}_${hubProjectVersion}_application_bom \ - --detect.excluded.directories=vendor/,blackduck/ \ - --detect.go.mod.enable.verification=true - """ - synopsys_detect detectProperties: """ - --detect.project.name=${hubProjectName} \ - --detect.project.version.name=${hubProjectVersion} \ - --detect.cleanup=false \ - --detect.output.path=blackduck \ - --detect.project.code.location.unmap=true \ - --detect.detector.search.depth=50 \ - --detect.code.location.name=${hubProjectName}_${hubProjectVersion}_container_code \ - --detect.bom.aggregate.name=${hubProjectName}_${hubProjectVersion}_container_bom \ - --detect.docker.image=${uniqueImageTag} \ - --detect.docker.passthrough.service.distro.default=apk \ - --detect.docker.path=/usr/bin/docker \ - --detect.tools=DOCKER \ - --detect.tools=SIGNATURE_SCAN - """ - synopsys_detect detectProperties: """ - --detect.project.name=${hubProjectName} \ - --detect.project.version.name=${hubProjectVersion} \ - --detect.cleanup=false \ - --detect.output.path=blackduck \ - --detect.project.code.location.unmap=true \ - --detect.detector.search.depth=50 \ - --detect.code.location.name=${hubProjectName}_${hubProjectVersion}_operator_container_code \ - --detect.bom.aggregate.name=${hubProjectName}_${hubProjectVersion}_operator_container_bom \ - --detect.docker.image=${uniqueOperatorImageTag} \ - --detect.docker.path=/usr/bin/docker \ - --detect.tools=DOCKER \ - --detect.tools=SIGNATURE_SCAN - """ - } - post { - success { - // Exclude .tar.gz files to avoid archiving large(ish) Docker extractions. - archiveArtifacts(artifacts: 'blackduck/runs/**', excludes: '**/*.tar.gz') - } - } - } - stage("End-to-End Test") { - when { - expression { shouldEndToEndTest } - } - options { - timeout(time: 6, unit: 'HOURS') - } - environment { - // OpenShift will not remember authorized keys between upgrades, so it is not practical to do an - // ssh-copy-id from a Jenkins worker node to each OpenShift node. - SSH_OPENSHIFT = credentials('ssh-openshift') - } - steps { - script { - TestEnvironment[] testEnvironments - if (env.BRANCH_NAME.matches('master')) { - testEnvironments = [ - new TestEnvironment("1.22", "beegfs-7.3-rh8", "1.22", "root", false), - new TestEnvironment("1.23-ubuntu-rdma", "beegfs-7.3-rh8-rdma", "1.23", "user", false), - new TestEnvironment("1.24-rhel8-rdma", "beegfs-7.2-rh8-rdma", "1.24", "root", false), - new TestEnvironment("1.25-rhel9-rdma", "beegfs-7.3-rh8-rdma", "1.25", "root", false), - new TestEnvironment("openshift", "beegfs-7.2-rh8-rdma", "1.24", "root", true) - ] - } else { - testEnvironments = [ - new TestEnvironment("1.22", "beegfs-7.3-rh8", "1.22", "root", false), - new TestEnvironment("1.23-ubuntu-rdma", "beegfs-7.3-rh8-rdma", "1.23", "user", false), - new TestEnvironment("1.24-rhel8-rdma", "beegfs-7.2-rh8-rdma", "1.24", "root", false), - new TestEnvironment("1.25-rhel9-rdma", "beegfs-7.3-rh8-rdma", "1.25", "root", false), - new TestEnvironment("openshift", "beegfs-7.2-rh8-rdma", "1.24", "root", true) - ] - } - - def integrationJobs = [:] - testEnvironments.each { testEnv -> - integrationJobs["kubernetes: ${testEnv.k8sCluster}, beegfs: ${testEnv.beegfsHost}"] = { - runIntegrationSuite(testEnv) - } - } - parallel integrationJobs - } - } - } - stage("Nomad Test") { - when { - branch 'master' - } - options { - timeout(time: 5, unit: 'MINUTES') - } - environment { - NOMAD_ADDR = credentials('address-nomad') - NOMAD_CACERT = credentials('ca-nomad') - CSI_CONTAINER_IMAGE = "${uniqueImageTag}" - CONTAINER_DRIVER = 'docker' - } - steps { - // We currently only test Nomad with a single BeeGFS "environment" (and thus simply hard code the - // directory containing necessary files here). It will be fairly easy to abstract this to multiple - // environments (like we do for end-to-end Kubernetes testing) if it ever makes sense. - // If this script fails, we consider Nomad testing to have failed. - sh 'test/nomad/test-nomad.sh test/nomad/beegfs-7.3-rh8/ > results/nomad.log 2>&1' - } - } - } - - post { - always { - // We must use a script block to use if. We must use an if block to ensure e-mails only send on desired - // branches. (The when directive is only available in a stage, and there are no stages in post.) - script { - if (env.BRANCH_NAME.matches('master')) { - // The Mailer plugin automatically sends e-mails on failed builds and on the first successful build - // after a failed build. - step([$class: 'Mailer', - // notifyEveryUnstableBuild may be controversial for some projects. However, for the BeeGFS - // CSI driver we never have unstable builds (only succeess or failures). Setting true for now. - notifyEveryUnstableBuild: true, - recipients: "ng-esg-apheleia@netapp.com", - ]) - } - } - } - cleanup { - archiveArtifacts(artifacts: 'results/**/*') - sh """ - docker image list | grep ${env.BRANCH_NAME} | awk '{ print \$1 ":" \$2 }' | xargs -r docker rmi - """ - deleteDir() - } - } -} - -def runIntegrationSuite(TestEnvironment testEnv) { - // For parallel testing skip the Disruptive and Serial tagged tests - String ginkgoSkipRegexRegular = "\\[Disruptive\\]|\\[Serial\\]" - String ginkgoSkipRegexDisruptive = "" - // Skip the [Slow] tests except on master. - // Ginkgo requires a \ escape and Groovy requires a \ escape for every \. - if (!env.BRANCH_NAME.matches('master')) { - ginkgoSkipRegexRegular += "|\\[Slow\\]" - ginkgoSkipRegexDisruptive += "\\[Slow\\]" - } - // TODO(gmarks, A463): Remove after all versions are no longer supported. - if (testEnv.k8sVersion.matches('(1.22)|(1.23)')) { - // This test is not included in the Disruptive or Serial set so we don't need to exclude it - // from the testCommandDisruptive command. - ginkgoSkipRegexRegular += "|provisioning should mount multiple PV pointing to the same storage on the same node" - // The following test covers a feature that is alpha in releases prior to 1.24 and is a Serial test - // so should be excluded from the Disruptive test run. - if (ginkgoSkipRegexDisruptive.length() > 0) { - ginkgoSkipRegexDisruptive += "|" - } - ginkgoSkipRegexDisruptive += "provisioning should provision storage with any volume data source" - } - - def jobID = "${testEnv.k8sCluster}-${testEnv.beegfsHost}" - def resultsDir = "${WORKSPACE}/results/${jobID}" - def junitPath = "results/${jobID}/*.xml" - sh "mkdir -p ${resultsDir}" - def testCommand = "ginkgo -v -procs 8 -no-color -skip '${ginkgoSkipRegexRegular}'" + - " -timeout 60m -junit-report parallel-junit.xml -output-dir ${resultsDir} ./test/e2e/ -- -report-dir ${resultsDir} -static-vol-dir-name ${testEnv.k8sCluster}" - def testCommandDisruptive = "ginkgo -v -no-color -skip '${ginkgoSkipRegexDisruptive}' -focus '\\[Disruptive\\]|\\[Serial\\]'" + - " -timeout 60m -junit-report serial-junit.xml -output-dir ${resultsDir} ./test/e2e/ -- -report-dir ${resultsDir} -static-vol-dir-name ${testEnv.k8sCluster}" - // Redirect output for easier reading. - testCommand += " > ${resultsDir}/ginkgo-parallel.log 2>&1" - testCommandDisruptive += " > ${resultsDir}/ginkgo-serial.log 2>&1" - - echo "Running test using kubernetes version ${testEnv.k8sCluster} with beegfs version ${testEnv.beegfsHost}" - lock(resource: "${testEnv.k8sCluster}") { - if (testEnv.useOperator) { - withCredentials([ - usernamePassword(credentialsId: "credentials-${testEnv.k8sCluster}", usernameVariable: "OC_USERNAME", passwordVariable: "OC_PASSWORD"), - string(credentialsId: "address-${testEnv.k8sCluster}", variable: "OC_ADDRESS")]) { - try { - // We escape the $ on OC_ADDRESS, etc. to avoid Groovy interpolation for secrets. - // - // We are not using a secret KUBECONFIG here as we do in the non-OpenShift deployment. However, - // we still need to set KUBECONFIG to point to an empty file in the workspace so "oc login" won't - // modify the Jenkins user's ~/.kube/config. - // - // It's a bit awkward to include Scorecard testing here, because Scorecard currently only evaluates - // our bundle (doesn't really do integration tests) and currently isn't expected to get different - // results on different clusters. However: - // 1) We need kubeconfig access to a cluster to run Scorecard. - // 2) We may eventually write custom tests with cluster-dependent results. - sh """ - export KUBECONFIG="${env.WORKSPACE}/kubeconfig-${jobID}" - oc login \${OC_ADDRESS} --username=\${OC_USERNAME} --password=\${OC_PASSWORD} --insecure-skip-tls-verify=true - oc delete --cascade=foreground -f test/env/${testEnv.beegfsHost}/csi-beegfs-cr.yaml || true - operator-sdk cleanup beegfs-csi-driver-operator || true - while [ "\$(oc get pod | grep beegfs-csi-driver-operator)" ]; do - echo "waiting for bundle cleanup" - sleep 5 - done - operator-sdk scorecard ./operator/bundle -w 180s > ${resultsDir}/scorecard.txt 2>&1 || (echo "SCORECARD FAILURE!" && exit 1) - # TODO(webere, A460): Remove the --index-image argument when - # https://github.com/operator-framework/operator-registry/issues/984 is resolved. - # NOTE: the workaround is not needed but leaving the comment temporarily - # operator-sdk run bundle --index-image=quay.io/operator-framework/opm:v1.23.0 ${uniqueBundleImageTag} - operator-sdk run bundle ${uniqueBundleImageTag} - sed 's/tag: replaced-by-jenkins/tag: ${uniqueImageTag.split(':')[1]}/g' test/env/${testEnv.beegfsHost}/csi-beegfs-cr.yaml | kubectl apply -f - - export KUBE_SSH_USER=\${SSH_OPENSHIFT_USR} - export KUBE_SSH_KEY_PATH=\${SSH_OPENSHIFT} - ${testCommand} || (echo "INTEGRATION TEST FAILURE!" && exit 1) - ${testCommandDisruptive} || (echo "DISRUPTIVE INTEGRATION TEST FAILURE!" && exit 1) - """ - } finally { - sh """ - export KUBECONFIG="${env.WORKSPACE}/kubeconfig-${jobID}" - oc get ns --no-headers | awk '{print \$1}' | grep -e provisioning- -e stress- -e beegfs- -e multivolume- -e ephemeral- -e volumemode- -e disruptive- | - grep -v beegfs-csi | xargs kubectl delete ns --cascade=foreground || true - oc delete -f test/env/${testEnv.beegfsHost}/csi-beegfs-cr.yaml || true - operator-sdk cleanup beegfs-csi-driver-operator || true - oc delete sc \$(oc get sc -A | grep beegfs.csi.netapp.com | awk 'match(\$6,/[0-9]+d/) {print \$1}') || true - """ - // Use junit here (on a per-environment basis) instead of once in post so Jenkins visualizer makes - // it clear which environment failed. - junit junitPath - } - } - } else { - // Credentials variables are always local to the withCredentials block, so multiple - // instances of the KUBECONFIG variable can exist without issue when running in parallel. - withCredentials([file(credentialsId: "kubeconfig-${testEnv.k8sCluster}", variable: "KUBECONFIG")]) { - def overlay = "deploy/k8s/overlays/${jobID}" - sh """ - cp -r deploy/k8s/overlays/default ${overlay} - (cd ${overlay} && \\ - kustomize edit set image docker.io/netapp/beegfs-csi-driver=${uniqueImageTag} && \\ - sed -i 's?/versions/latest?/versions/v${testEnv.k8sVersion}?g' kustomization.yaml) - """ - try { - // The two kubectl get ... lines are used to clean up any beegfs CSI driver currently - // running on the cluster. We can't simply delete using -k deploy/k8s/overlay-xxx/ because a previous - // user might have deployed the driver using a different deployment scheme. - // - // It's a bit awkward to include Scorecard testing here, because Scorecard currently only evaluates - // our bundle (doesn't really do integration tests) and currently isn't expected to get different - // results on different clusters. However: - // 1) We need kubeconfig access to a cluster to run Scorecard. - // 2) We may eventually write custom tests with cluster-dependent results. - sh """ - kubectl get sts -A | grep csi-beegfs | awk '{print \$2 " -n " \$1}' | xargs kubectl delete --cascade=foreground sts || true - kubectl get ds -A | grep csi-beegfs | awk '{print \$2 " -n " \$1}' | xargs kubectl delete --cascade=foreground ds || true - operator-sdk scorecard ./operator/bundle -w 180s > ${resultsDir}/scorecard.txt 2>&1 || (echo "SCORECARD FAILURE!" && exit 1) - cp test/env/${testEnv.beegfsHost}/csi-beegfs-config.yaml ${overlay}/csi-beegfs-config.yaml - cp test/env/${testEnv.beegfsHost}/csi-beegfs-connauth.yaml ${overlay}/csi-beegfs-connauth.yaml - kubectl apply -k ${overlay} - export KUBE_SSH_USER=${testEnv.sshUser} - ${testCommand} || (echo "INTEGRATION TEST FAILURE!" && exit 1) - ${testCommandDisruptive} || (echo "DISRUPTIVE INTEGRATION TEST FAILURE!" && exit 1) - """ - } finally { - sh """ - kubectl get ns --no-headers | awk '{print \$1}' | grep -e provisioning- -e stress- -e beegfs- -e multivolume- -e ephemeral- -e volumemode- -e disruptive- | - grep -v beegfs-csi | xargs kubectl delete ns --cascade=foreground || true - kubectl delete --cascade=foreground -k ${overlay} || true - kubectl delete sc \$(kubectl get sc -A | grep beegfs.csi.netapp.com | awk 'match(\$6,/[0-9]+d/) {print \$1}') || true - """ - // Use junit here (on a per-environment basis) instead of once in post so Jenkins visualizer makes - // it clear which environment failed. - junit junitPath - } - } - } - } -} - -// TestEnvironment is a JavaBean type class used only to store data about a particular test environment. It mainly -// exists to allow storing strings AND booleans describing a test environment in one structure. -class TestEnvironment { - String k8sCluster - String beegfsHost - String k8sVersion - String sshUser - // useOperator could somewhat equivalently be called inOpenShift. When this is true, we assume testing occurs in an - // OpenShift cluster (which carries certain extra burdens) AND the driver should be deployed using the operator and - // OLM. If we ever increase our test coverage so that we use OLM in a Kubesprayed cluster or deploy to OpenShift - // without OLM, we may need to decouple this field into useOperator and inOpenShift. - boolean useOperator - - TestEnvironment(String k8sCluster, String beegfsHost, String k8sVersion, String sshUser, boolean useOperator) { - this.k8sCluster = k8sCluster - this.beegfsHost = beegfsHost - this.k8sVersion = k8sVersion - this.sshUser = sshUser - this.useOperator = useOperator - } -} diff --git a/Jenkinsfile.coverity b/Jenkinsfile.coverity deleted file mode 100644 index c783e7ac..00000000 --- a/Jenkinsfile.coverity +++ /dev/null @@ -1,63 +0,0 @@ -// Copyright 2021 NetApp, Inc. All Rights Reserved. -// Licensed under the Apache License, Version 2.0. - -// This pipeline enables Coverity static application security testing on BeeGFS CSI driver Go components. It is -// written to automatically run nightly. For now, configure Jenkins to detect and run it only on the master branch. It -// may be possible to extend scanning to other branches if the need arises. - -pipeline { - agent any - - triggers { - // Run sometime between 12:00 AM and 3:59 AM daily. - cron('H H(0-3) * * *') - } - - options { - timestamps() - timeout(time: 2, unit: 'HOURS') - buildDiscarder(logRotator(artifactNumToKeepStr: '15')) - } - - environment { - WORKSPACE = "${env.WORKSPACE}" - COVERITY_HOSTNAME="coverity.cls.eng.netapp.com" - COVERITY_PORT=9090 - COVERITY_CREDS= credentials('coverity-creds') // stored in Jenkins - COVERITY_STREAM='BeeGFS_CSI_Driver' - CA_FILE= credentials('coverity-certs') // stored in Jenkins - ANALYSIS_TOOLS_BIN="/usr/local/cov-analysis-linux64/bin" // pre-installed on Jenkins nodes - INTERMEDIATE_DIR="$WORKSPACE/CoverityIDIR" - CONFIG_FILE="$WORKSPACE/coverityconfig/coverity_config.xml" - } - - stages { - stage('Coverity Scan') { - steps { - // NetApp developers, please refer to - // https://confluence.ngage.netapp.com/display/DEVTS/Coverity+Scan+Process for details about the - // Coverity scan process/commands - - echo "Run cov-configure to configure Coverity compiler for Go..." - sh '$ANALYSIS_TOOLS_BIN/cov-configure --config $CONFIG_FILE --go' - - // cov-build intercepts all "go build" commands and generates a modified binary in INTERMEDIATE_DIR - // that can be analyzed by cov-analyze. - echo "Run cov-build for all Go components (chwrap, driver, operator)" - sh '$ANALYSIS_TOOLS_BIN/cov-build --dir $INTERMEDIATE_DIR --config $CONFIG_FILE bash -c "make build-chwrap build-beegfs-csi-driver; cd operator && make build"' - - echo "Run cov-analyze on the intermediate code under ..." - sh '$ANALYSIS_TOOLS_BIN/cov-analyze --dir $INTERMEDIATE_DIR --strip-path $WORKSPACE --all' - - echo "Run cov-commit-defects to push the analysis results to Coverity" - sh '$ANALYSIS_TOOLS_BIN/cov-commit-defects --dir $INTERMEDIATE_DIR --url "https://coverity.cls.eng.netapp.com" --user $COVERITY_CREDS_USR --password $COVERITY_CREDS_PSW --certs $CA_FILE --stream $COVERITY_STREAM' - } - } - } - - post { - cleanup { - deleteDir() - } - } -} diff --git a/NOTICE b/NOTICE deleted file mode 100644 index 86540bc9..00000000 --- a/NOTICE +++ /dev/null @@ -1,3081 +0,0 @@ -NetApp Notice Report - -Copyright 2022 - -About this document -The following copyright statements and licenses apply to the software components that are distributed with the esg-beegfs-csi-driver version 1.4.0 product. This product does not necessarily use all the software components referred to below. - -Where required, source code is published at the following location. -https://opensource.netapp.com/ - -You may also request a copy of the open source code by submitting a written request to ng-opensource-request@netapp.com or by writing to: - -NetApp Inc. -Attention: IP Legal Department (Open Source Request) -3060 Olsen Drive -San Jose, CA 95128 - -Your request must include: - -1.The name of the component or binary file(s) for which you are requesting the open source code. -2.The name and version number of the NetApp product containing the component or binary file(s). -3.The date you received the NetApp product. -4.Your name. -5.Your company name (if applicable). -6.Your return mailing address and email. - -This offer is valid for three years from the date you acquired the esg-beegfs-csi-driver products or for as long as the applicable license requires this offer to be valid. We may charge you a fee to cover the cost of physical media and processing. Notwithstanding any other agreement or provision, NetApp disclaims all liability and warranties with respect to any source code made available by any method provided above. - -Components: - -armon/go-socks5 20160902-snapshot-e7533296 : MIT License - -AWS SDK for Go 1.38.49 : (MIT License AND BSD 2-clause "Simplified" License AND Apache License 2.0 AND BSD 3-clause "New" or "Revised" License) - -base-files 10.3+deb10u10 : GNU General Public License v2.0 or later - -benbjohnson-clock v1.1.0 : MIT License - -beorn7-perks v1.0.1 : MIT License - -blang-semver v4.0.0 : MIT License - -cespare/xxhash v2.1.2 : MIT License - -client-go v0.25.3 : Apache License 2.0 - -client_golang v1.12.2 : Apache License 2.0 - -container-storage-interface/spec v1.7.0 : Apache License 2.0 - -docker-registry 2.8.1 : Apache License 2.0 - -evanphx/json-patch v4.12.0 : BSD 3-clause "New" or "Revised" License - -evanphx/json-patch v5.6.0 : BSD 3-clause "New" or "Revised" License - -felixge/httpsnoop v1.0.1 : MIT License - -fsnotify-fsnotify 1.5.4 : BSD 3-clause "New" or "Revised" License - -github.com/go-logr/zapr v1.2.3 : Apache License 2.0 - -github.com/golang-jwt/jwt v4.2.0 : MIT License - -github.com/kubernetes-csi/csi-lib-utils v0.11.0 : Apache License 2.0 - -github.com/moby/spdystream v0.2.0 : Apache License 2.0 - -github.com/munnerz/goautoneg 20191010-snapshot-a7dc8b61 : BSD 3-clause "New" or "Revised" License - -Go programming language 1.18.7 : (BSD 3-clause "New" or "Revised" License AND Public Domain) - -Go Testify 1.8.0 : MIT License - -go-autorest v14.2.0 : Apache License 2.0 - -go-check-check 20200227-snapshot-8fa46927 : BSD 2-clause "Simplified" License - -go-inf-inf v0.9.1 : BSD 3-clause "New" or "Revised" License - -go-ini-ini v1.67.0 : Apache License 2.0 - -go-logr/logr v1.2.3 : Apache License 2.0 - -go-openapi/jsonpointer v0.19.5 : Apache License 2.0 - -go-restful v3.8.0 : MIT License - -go-spew v1.1.1 : ISC License - -go-tomb-tomb 20150422-snapshot-dd632973 : BSD 3-clause "New" or "Revised" License - -go-zap v1.21.0 : MIT License - -go.uber.org/goleak v1.2.0 : MIT License - -go.uber.org/multierr v1.6.0 : MIT License - -GoDoc Text v0.2.0 : MIT License - -gogo-protobuf v1.3.2 : BSD 3-clause "New" or "Revised" License - -golang protobuf v1.5.2 : BSD 3-clause "New" or "Revised" License - -golang-github-spf13-pflag-dev v1.0.5 : BSD 3-clause "New" or "Revised" License - -golang.org/x/crypto v0.1.0 : BSD 3-clause "New" or "Revised" License - -golang.org/x/net v0.2.0 : BSD 3-clause "New" or "Revised" License - -golang.org/x/oauth2 20211104-snapshot-d3ed0bb2 : BSD 3-clause "New" or "Revised" License - -golang.org/x/sys v0.2.0 : BSD 3-clause "New" or "Revised" License - -golang.org/x/term v0.2.0 : BSD 3-clause "New" or "Revised" License - -golang.org/x/time 20220608-snapshot-579cf78f : BSD 3-clause "New" or "Revised" License - -golang/appengine v1.6.7 : Apache License 2.0 - -golang/text v0.4.0 : BSD 3-clause "New" or "Revised" License - -gomega v1.24.0 : MIT License - -gomodules/jsonpatch v2.2.0 : Apache License 2.0 - -Google Cloud Client Libraries for Go v0.97.0 : Apache License 2.0 - -google-gofuzz v1.1.0 : Apache License 2.0 - -google.golang.org/protobuf v1.28.0 : BSD 3-clause "New" or "Revised" License - -google/gnostic v0.5.7-v3refs : Apache License 2.0 - -google/go-cmp v0.5.9 : BSD 3-clause "New" or "Revised" License - -google/go-genproto 20220502-snapshot-c8bf987b : Apache License 2.0 - -google/uuid v1.3.0 : BSD 3-clause "New" or "Revised" License - -goproxy 20180725-snapshot-947c36da : BSD 3-clause "New" or "Revised" License - -groupcache 20210331-snapshot-41bb18bf : Apache License 2.0 - -grpc-gateway v1.16.0 : BSD 3-clause "New" or "Revised" License - -grpc-go v1.50.1 : Apache License 2.0 - -inconshreveable/mousetrap 1.0.0 : Apache License 2.0 - -jmespath-go-jmespath v0.4.0 : Apache License 2.0 - -josharian/intern v1.0.0 : MIT License - -jsoniter-go v1.1.12 : MIT License - -jsonreference v0.19.5 : Apache License 2.0 - -k8s.io/kubelet v0.25.3 : Apache License 2.0 - -k8s.io/utils 20220728-snapshot-ee6ede2d : Apache License 2.0 - -kr/pretty v0.2.0 : MIT License - -kubernetes/api v0.25.3 : Apache License 2.0 - -kubernetes/apiextensions-apiserver v0.25.3 : Apache License 2.0 - -kubernetes/apimachinery v0.25.3 : Apache License 2.0 - -kubernetes/component-base v0.25.3 : Apache License 2.0 - -kubernetes/mount-utils v0.25.3 : Apache License 2.0 - -kubernetes/pod-security-admission v0.25.3 : Apache License 2.0 - -mailru/easyjson v0.7.6 : MIT License - -matttproud-golang_protobuf_extensions v1.0.1 : Apache License 2.0 - -mergo 0.3.12 : BSD 3-clause "New" or "Revised" License - -modern-go/concurrent 20180305-snapshot-bacd9c7e : Apache License 2.0 - -modern-go/reflect2 v1.0.2 : Apache License 2.0 - -NetBase 5.6 : GNU General Public License v2.0 or later - -nxadm/tail v1.4.8 : MIT License - -onsi/ginkgo 1.16.5 : MIT License - -onsi/ginkgo v2.4.0 : MIT License - -open-telemetry/opentelemetry-go-contrib 0.20.0 : Apache License 2.0 - -opencontainers/go-digest 1.0.0 : Apache License 2.0 - -opencontainers/selinux v1.10.2 : Apache License 2.0 - -pkg/errors v0.9.1 : BSD 2-clause "Simplified" License - -pmezard-go-difflib 1.0.0 : BSD 3-clause "New" or "Revised" License - -prometheus-client_model v0.2.0 : Apache License 2.0 - -prometheus-common v0.32.1 : Apache License 2.0 - -prometheus-procfs v0.7.3 : Apache License 2.0 - -purell v1.1.1 : BSD 3-clause "New" or "Revised" License - -sigs.k8s.io/controller-runtime v0.13.1 : Apache License 2.0 - -sigs.k8s.io/json 20220713-snapshot-f223a00b : (Apache License 2.0 AND BSD 3-clause "New" or "Revised" License) - -sigs.k8s.io/yaml v1.3.0 : Apache License 2.0 - -spf13-afero v1.9.2 : Apache License 2.0 - -spf13-cobra v1.4.0 : Apache License 2.0 - -swag v0.19.14 : Apache License 2.0 - -Time Zone Database 2021a : Public Domain - -uber-go/atomic 1.7.0 : MIT License - -urlesc 20170810-snapshot-de5bf2ad : BSD 3-clause "New" or "Revised" License - -yaml for Go v2.4.0 : Apache License 2.0 - -yaml for Go v3.0.1 : (MIT License AND Apache License 2.0) - - -Licenses: - - -Apache License 2.0 - -(AWS SDK for Go 1.38.49, client-go v0.25.3, client_golang v1.12.2, container-storage-interface/spec v1.7.0, docker-registry 2.8.1, github.com/go-logr/zapr v1.2.3, github.com/kubernetes-csi/csi-lib-utils v0.11.0, github.com/moby/spdystream v0.2.0, go-autorest v14.2.0, go-ini-ini v1.67.0, go-logr/logr v1.2.3, go-openapi/jsonpointer v0.19.5, golang/appengine v1.6.7, gomodules/jsonpatch v2.2.0, Google Cloud Client Libraries for Go v0.97.0, google-gofuzz v1.1.0, google/gnostic v0.5.7-v3refs, google/go-genproto 20220502-snapshot-c8bf987b, groupcache 20210331-snapshot-41bb18bf, grpc-go v1.50.1, inconshreveable/mousetrap 1.0.0, jmespath-go-jmespath v0.4.0, jsonreference v0.19.5, k8s.io/kubelet v0.25.3, k8s.io/utils 20220728-snapshot-ee6ede2d, kubernetes/api v0.25.3, kubernetes/apiextensions-apiserver v0.25.3, kubernetes/apimachinery v0.25.3, kubernetes/component-base v0.25.3, kubernetes/mount-utils v0.25.3, kubernetes/pod-security-admission v0.25.3, matttproud-golang_protobuf_extensions v1.0.1, modern-go/concurrent 20180305-snapshot-bacd9c7e, modern-go/reflect2 v1.0.2, open-telemetry/opentelemetry-go-contrib 0.20.0, opencontainers/go-digest 1.0.0, opencontainers/selinux v1.10.2, prometheus-client_model v0.2.0, prometheus-common v0.32.1, prometheus-procfs v0.7.3, sigs.k8s.io/controller-runtime v0.13.1, sigs.k8s.io/json 20220713-snapshot-f223a00b, sigs.k8s.io/yaml v1.3.0, spf13-afero v1.9.2, spf13-cobra v1.4.0, swag v0.19.14, yaml for Go v2.4.0, yaml for Go v3.0.1) - -Apache License - -Version 2.0, January 2004 - -========================= - - - - - -http://www.apache.org/licenses/ - - - -TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - - -1. Definitions. - - - -"License" shall mean the terms and conditions for use, reproduction, and - -distribution as defined by Sections 1 through 9 of this document. - - - -"Licensor" shall mean the copyright owner or entity authorized by the copyright - -owner that is granting the License. - - - -"Legal Entity" shall mean the union of the acting entity and all other entities - -that control, are controlled by, or are under common control with that entity. - -For the purposes of this definition, "control" means (i) the power, direct or - -indirect, to cause the direction or management of such entity, whether by - -contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the - -outstanding shares, or (iii) beneficial ownership of such entity. - - - -"You" (or "Your") shall mean an individual or Legal Entity exercising permissions - -granted by this License. - - - -"Source" form shall mean the preferred form for making modifications, including - -but not limited to software source code, documentation source, and configuration - -files. - - - -"Object" form shall mean any form resulting from mechanical transformation or - -translation of a Source form, including but not limited to compiled object code, - -generated documentation, and conversions to other media types. - - - -"Work" shall mean the work of authorship, whether in Source or Object form, made - -available under the License, as indicated by a copyright notice that is included - -in or attached to the work (an example is provided in the Appendix below). - - - -"Derivative Works" shall mean any work, whether in Source or Object form, that is - -based on (or derived from) the Work and for which the editorial revisions, - -annotations, elaborations, or other modifications represent, as a whole, an - -original work of authorship. For the purposes of this License, Derivative Works - -shall not include works that remain separable from, or merely link (or bind by - -name) to the interfaces of, the Work and Derivative Works thereof. - - - -"Contribution" shall mean any work of authorship, including the original version - -of the Work and any modifications or additions to that Work or Derivative Works - -thereof, that is intentionally submitted to Licensor for inclusion in the Work by - -the copyright owner or by an individual or Legal Entity authorized to submit on - -behalf of the copyright owner. For the purposes of this definition, "submitted" - -means any form of electronic, verbal, or written communication sent to the - -Licensor or its representatives, including but not limited to communication on - -electronic mailing lists, source code control systems, and issue tracking systems - -that are managed by, or on behalf of, the Licensor for the purpose of discussing - -and improving the Work, but excluding communication that is conspicuously marked - -or otherwise designated in writing by the copyright owner as "Not a - -Contribution." - - - -"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of - -whom a Contribution has been received by Licensor and subsequently incorporated - -within the Work. - - - -2. Grant of Copyright License. Subject to the terms and conditions of this - -License, each Contributor hereby grants to You a perpetual, worldwide, - -non-exclusive, no-charge, royalty-free, irrevocable copyright license to - -reproduce, prepare Derivative Works of, publicly display, publicly perform, - -sublicense, and distribute the Work and such Derivative Works in Source or Object - -form. - - - -3. Grant of Patent License. Subject to the terms and conditions of this License, - -each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, - -no-charge, royalty-free, irrevocable (except as stated in this section) patent - -license to make, have made, use, offer to sell, sell, import, and otherwise - -transfer the Work, where such license applies only to those patent claims - -licensable by such Contributor that are necessarily infringed by their - -Contribution(s) alone or by combination of their Contribution(s) with the Work to - -which such Contribution(s) was submitted. If You institute patent litigation - -against any entity (including a cross-claim or counterclaim in a lawsuit) - -alleging that the Work or a Contribution incorporated within the Work constitutes - -direct or contributory patent infringement, then any patent licenses granted to - -You under this License for that Work shall terminate as of the date such - -litigation is filed. - - - -4. Redistribution. You may reproduce and distribute copies of the Work or - -Derivative Works thereof in any medium, with or without modifications, and in - -Source or Object form, provided that You meet the following conditions: - - - - a. You must give any other recipients of the Work or Derivative Works a copy of - - this License; and - - - - b. You must cause any modified files to carry prominent notices stating that - - You changed the files; and - - - - c. You must retain, in the Source form of any Derivative Works that You - - distribute, all copyright, patent, trademark, and attribution notices from - - the Source form of the Work, excluding those notices that do not pertain to - - any part of the Derivative Works; and - - - - d. If the Work includes a "NOTICE" text file as part of its distribution, then - - any Derivative Works that You distribute must include a readable copy of the - - attribution notices contained within such NOTICE file, excluding those - - notices that do not pertain to any part of the Derivative Works, in at least - - one of the following places: within a NOTICE text file distributed as part of - - the Derivative Works; within the Source form or documentation, if provided - - along with the Derivative Works; or, within a display generated by the - - Derivative Works, if and wherever such third-party notices normally appear. - - The contents of the NOTICE file are for informational purposes only and do - - not modify the License. You may add Your own attribution notices within - - Derivative Works that You distribute, alongside or as an addendum to the - - NOTICE text from the Work, provided that such additional attribution notices - - cannot be construed as modifying the License. - - - -You may add Your own copyright statement to Your modifications and may provide - -additional or different license terms and conditions for use, reproduction, or - -distribution of Your modifications, or for any such Derivative Works as a whole, - -provided Your use, reproduction, and distribution of the Work otherwise complies - -with the conditions stated in this License. - - - -5. Submission of Contributions. Unless You explicitly state otherwise, any - -Contribution intentionally submitted for inclusion in the Work by You to the - -Licensor shall be under the terms and conditions of this License, without any - -additional terms or conditions. Notwithstanding the above, nothing herein shall - -supersede or modify the terms of any separate license agreement you may have - -executed with Licensor regarding such Contributions. - - - -6. Trademarks. This License does not grant permission to use the trade names, - -trademarks, service marks, or product names of the Licensor, except as required - -for reasonable and customary use in describing the origin of the Work and - -reproducing the content of the NOTICE file. - - - -7. Disclaimer of Warranty. Unless required by applicable law or agreed to in - -writing, Licensor provides the Work (and each Contributor provides its - -Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, - -either express or implied, including, without limitation, any warranties or - -conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - -PARTICULAR PURPOSE. You are solely responsible for determining the - -appropriateness of using or redistributing the Work and assume any risks - -associated with Your exercise of permissions under this License. - - - -8. Limitation of Liability. In no event and under no legal theory, whether in - -tort (including negligence), contract, or otherwise, unless required by - -applicable law (such as deliberate and grossly negligent acts) or agreed to in - -writing, shall any Contributor be liable to You for damages, including any - -direct, indirect, special, incidental, or consequential damages of any character - -arising as a result of this License or out of the use or inability to use the - -Work (including but not limited to damages for loss of goodwill, work stoppage, - -computer failure or malfunction, or any and all other commercial damages or - -losses), even if such Contributor has been advised of the possibility of such - -damages. - - - -9. Accepting Warranty or Additional Liability. While redistributing the Work or - -Derivative Works thereof, You may choose to offer, and charge a fee for, - -acceptance of support, warranty, indemnity, or other liability obligations and/or - -rights consistent with this License. However, in accepting such obligations, You - -may act only on Your own behalf and on Your sole responsibility, not on behalf of - -any other Contributor, and only if You agree to indemnify, defend, and hold each - -Contributor harmless for any liability incurred by, or claims asserted against, - -such Contributor by reason of your accepting any such warranty or additional - -liability. - - - -END OF TERMS AND CONDITIONS - - - -APPENDIX: How to apply the Apache License to your work - - - -To apply the Apache License to your work, attach the following boilerplate - -notice, with the fields enclosed by brackets "[]" replaced with your own - -identifying information. (Don't include the brackets!) The text should be - -enclosed in the appropriate comment syntax for the file format. We also recommend - -that a file or class name and description of purpose be included on the same - -"printed page" as the copyright notice for easier identification within - -third-party archives. - - - - Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, - - Version 2.0 (the "License"); you may not use this file except in compliance - - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law - - or agreed to in writing, software distributed under the License is - - distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - - KIND, either express or implied. See the License for the specific language - - governing permissions and limitations under the License. - ---- - -BSD 2-clause "Simplified" License - -(AWS SDK for Go 1.38.49, go-check-check 20200227-snapshot-8fa46927) - -BSD Two Clause License - -====================== - - - -Redistribution and use in source and binary forms, with or without modification, - -are permitted provided that the following conditions are met: - - - - 1. Redistributions of source code must retain the above copyright notice, this - - list of conditions and the following disclaimer. - - - - 2. Redistributions in binary form must reproduce the above copyright notice, - - this list of conditions and the following disclaimer in the documentation - - and/or other materials provided with the distribution. - - - -THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED - -WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF - -MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT - -SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, - -EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT - -OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - -INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, - -STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY - -OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH - -DAMAGE. - ---- - -BSD 2-clause "Simplified" License - -(pkg/errors v0.9.1) - -Copyright (c) 2015, Dave Cheney - -All rights reserved. - - - -Redistribution and use in source and binary forms, with or without - -modification, are permitted provided that the following conditions are met: - - - -* Redistributions of source code must retain the above copyright notice, this - - list of conditions and the following disclaimer. - - - -* Redistributions in binary form must reproduce the above copyright notice, - - this list of conditions and the following disclaimer in the documentation - - and/or other materials provided with the distribution. - - - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE - -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE - -FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL - -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR - -SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER - -CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, - -OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE - ---- - -BSD 3-clause "New" or "Revised" License - -(AWS SDK for Go 1.38.49) - -Copyright (c) 2009 The Go Authors. All rights reserved. - - - -Redistribution and use in source and binary forms, with or without - -modification, are permitted provided that the following conditions are - -met: - - - - * Redistributions of source code must retain the above copyright - -notice, this list of conditions and the following disclaimer. - - * Redistributions in binary form must reproduce the above - -copyright notice, this list of conditions and the following disclaimer - -in the documentation and/or other materials provided with the - -distribution. - - * Neither the name of Google Inc. nor the names of its - -contributors may be used to endorse or promote products derived from - -this software without specific prior written permission. - - - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - -OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE - ---- - -BSD 3-clause "New" or "Revised" License - -(google/uuid v1.3.0) - -Copyright (c) 2009,2014 Google Inc. All rights reserved. - - - -Redistribution and use in source and binary forms, with or without - -modification, are permitted provided that the following conditions are - -met: - - - - * Redistributions of source code must retain the above copyright - -notice, this list of conditions and the following disclaimer. - - * Redistributions in binary form must reproduce the above - -copyright notice, this list of conditions and the following disclaimer - -in the documentation and/or other materials provided with the - -distribution. - - * Neither the name of Google Inc. nor the names of its - -contributors may be used to endorse or promote products derived from - -this software without specific prior written permission. - - - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - -OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE - ---- - -BSD 3-clause "New" or "Revised" License - -(go-tomb-tomb 20150422-snapshot-dd632973) - -Copyright (c) 2010-2011 - Gustavo Niemeyer - - - -All rights reserved. - - - -Redistribution and use in source and binary forms, with or without - -modification, are permitted provided that the following conditions are met: - - - - * Redistributions of source code must retain the above copyright notice, - - this list of conditions and the following disclaimer. - - * Redistributions in binary form must reproduce the above copyright notice, - - this list of conditions and the following disclaimer in the documentation - - and/or other materials provided with the distribution. - - * Neither the name of the copyright holder nor the names of its - - contributors may be used to endorse or promote products derived from - - this software without specific prior written permission. - - - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR - -CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, - -EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, - -PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR - -PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF - -LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING - -NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS - -SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE - ---- - -BSD 3-clause "New" or "Revised" License - -(golang-github-spf13-pflag-dev v1.0.5) - -Copyright (c) 2012 Alex Ogier. All rights reserved. - -Copyright (c) 2012 The Go Authors. All rights reserved. - - - -Redistribution and use in source and binary forms, with or without - -modification, are permitted provided that the following conditions are - -met: - - - - * Redistributions of source code must retain the above copyright - -notice, this list of conditions and the following disclaimer. - - * Redistributions in binary form must reproduce the above - -copyright notice, this list of conditions and the following disclaimer - -in the documentation and/or other materials provided with the - -distribution. - - * Neither the name of Google Inc. nor the names of its - -contributors may be used to endorse or promote products derived from - -this software without specific prior written permission. - - - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - -OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE - ---- - -BSD 3-clause "New" or "Revised" License - -(go-inf-inf v0.9.1) - -Copyright (c) 2012 Pter Surnyi. Portions Copyright (c) 2009 The Go - -Authors. All rights reserved. - - - -Redistribution and use in source and binary forms, with or without - -modification, are permitted provided that the following conditions are - -met: - - - - * Redistributions of source code must retain the above copyright - -notice, this list of conditions and the following disclaimer. - - * Redistributions in binary form must reproduce the above - -copyright notice, this list of conditions and the following disclaimer - -in the documentation and/or other materials provided with the - -distribution. - - * Neither the name of Google Inc. nor the names of its - -contributors may be used to endorse or promote products derived from - -this software without specific prior written permission. - - - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - -OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE - ---- - -BSD 3-clause "New" or "Revised" License - -(urlesc 20170810-snapshot-de5bf2ad) - -Copyright (c) 2012 The Go Authors. All rights reserved. - - - -Redistribution and use in source and binary forms, with or without - -modification, are permitted provided that the following conditions are - -met: - - - - * Redistributions of source code must retain the above copyright - -notice, this list of conditions and the following disclaimer. - - * Redistributions in binary form must reproduce the above - -copyright notice, this list of conditions and the following disclaimer - -in the documentation and/or other materials provided with the - -distribution. - - * Neither the name of Google Inc. nor the names of its - -contributors may be used to endorse or promote products derived from - -this software without specific prior written permission. - - - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - -OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE - ---- - -BSD 3-clause "New" or "Revised" License - -(purell v1.1.1) - -Copyright (c) 2012, Martin Angers - -All rights reserved. - - - -Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - - - -* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - - - -* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. - - - -* Neither the name of the author nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. - - - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE - ---- - -BSD 3-clause "New" or "Revised" License - -(mergo 0.3.12) - -Copyright (c) 2013 Dario Casta. All rights reserved. - -Copyright (c) 2012 The Go Authors. All rights reserved. - - - -Redistribution and use in source and binary forms, with or without - -modification, are permitted provided that the following conditions are - -met: - - - - * Redistributions of source code must retain the above copyright - -notice, this list of conditions and the following disclaimer. - - * Redistributions in binary form must reproduce the above - -copyright notice, this list of conditions and the following disclaimer - -in the documentation and/or other materials provided with the - -distribution. - - * Neither the name of Google Inc. nor the names of its - -contributors may be used to endorse or promote products derived from - -this software without specific prior written permission. - - - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - -OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE - ---- - -BSD 3-clause "New" or "Revised" License - -(evanphx/json-patch v4.12.0, evanphx/json-patch v5.6.0) - -Copyright (c) 2014, Evan Phoenix - -All rights reserved. - - - -Redistribution and use in source and binary forms, with or without - -modification, are permitted provided that the following conditions are met: - - - -* Redistributions of source code must retain the above copyright notice, this - - list of conditions and the following disclaimer. - -* Redistributions in binary form must reproduce the above copyright notice, - - this list of conditions and the following disclaimer in the documentation - - and/or other materials provided with the distribution. - -* Neither the name of the Evan Phoenix nor the names of its contributors - - may be used to endorse or promote products derived from this software - - without specific prior written permission. - - - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE - -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE - -FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL - -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR - -SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER - -CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, - -OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE - ---- - -BSD 3-clause "New" or "Revised" License - -(grpc-gateway v1.16.0) - -Copyright (c) 2015, Gengo, Inc. - -All rights reserved. - - - -Redistribution and use in source and binary forms, with or without modification, - -are permitted provided that the following conditions are met: - - - - * Redistributions of source code must retain the above copyright notice, - - this list of conditions and the following disclaimer. - - - - * Redistributions in binary form must reproduce the above copyright notice, - - this list of conditions and the following disclaimer in the documentation - - and/or other materials provided with the distribution. - - - - * Neither the name of Gengo, Inc. nor the names of its - - contributors may be used to endorse or promote products derived from this - - software without specific prior written permission. - - - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND - -ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED - -WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE - -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR - -ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES - -(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; - -LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON - -ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS - -SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE - ---- - -BSD 3-clause "New" or "Revised" License - -(fsnotify-fsnotify 1.5.4, github.com/munnerz/goautoneg 20191010-snapshot-a7dc8b61, Go programming language 1.18.7, golang.org/x/crypto v0.1.0, golang.org/x/net v0.2.0, golang.org/x/oauth2 20211104-snapshot-d3ed0bb2, golang.org/x/sys v0.2.0, golang.org/x/term v0.2.0, golang.org/x/time 20220608-snapshot-579cf78f, golang/text v0.4.0, google.golang.org/protobuf v1.28.0, google/go-cmp v0.5.9, goproxy 20180725-snapshot-947c36da, sigs.k8s.io/json 20220713-snapshot-f223a00b) - -Copyright (c) , - -All rights reserved. - - - -Redistribution and use in source and binary forms, with or without modification, - -are permitted provided that the following conditions are met: - - - - * Redistributions of source code must retain the above copyright notice, this - - list of conditions and the following disclaimer. - - - - * Redistributions in binary form must reproduce the above copyright notice, - - this list of conditions and the following disclaimer in the documentation - - and/or other materials provided with the distribution. - - - - * Neither the name of the nor the names of its contributors may - - be used to endorse or promote products derived from this software without - - specific prior written permission. - - - - - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND - -ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED - -WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE - -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR - -ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES - -(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS - -OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING - -NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN - -IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - ---- - -BSD 3-clause "New" or "Revised" License - -(golang protobuf v1.5.2) - -Copyright 2010 The Go Authors. All rights reserved. - - - -Redistribution and use in source and binary forms, with or without - -modification, are permitted provided that the following conditions are - -met: - - - - * Redistributions of source code must retain the above copyright - -notice, this list of conditions and the following disclaimer. - - * Redistributions in binary form must reproduce the above - -copyright notice, this list of conditions and the following disclaimer - -in the documentation and/or other materials provided with the - -distribution. - - * Neither the name of Google Inc. nor the names of its - -contributors may be used to endorse or promote products derived from - -this software without specific prior written permission. - - - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - -OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE - ---- - -BSD 3-clause "New" or "Revised" License - -(gogo-protobuf v1.3.2) - -Copyright 2010 The Go Authors. All rights reserved. - -https://github.com/golang/protobuf - - - -Redistribution and use in source and binary forms, with or without - -modification, are permitted provided that the following conditions are - -met: - - - - * Redistributions of source code must retain the above copyright - -notice, this list of conditions and the following disclaimer. - - * Redistributions in binary form must reproduce the above - -copyright notice, this list of conditions and the following disclaimer - -in the documentation and/or other materials provided with the - -distribution. - - * Neither the name of Google Inc. nor the names of its - -contributors may be used to endorse or promote products derived from - -this software without specific prior written permission. - - - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - -OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE - ---- - -BSD 3-clause "New" or "Revised" License - -(pmezard-go-difflib 1.0.0) - -Source: https://github.com/pmezard/go-difflib - - - -Files: * - -Copyright: 2013 Patrick Mzard - -License: BSD-3-clause - - - -Files: debian/* - -Copyright: 2016 Dmitry Smirnov - -License: BSD-3-clause - - - -License: BSD-3-clause - - - -Redistribution and use in source and binary forms, with or without - - modification, are permitted provided that the following conditions are - - met: - - . - - Redistributions of source code must retain the above copyright - - notice, this list of conditions and the following disclaimer. - - . - - Redistributions in binary form must reproduce the above copyright - - notice, this list of conditions and the following disclaimer in the - - documentation and/or other materials provided with the distribution. - - . - - The names of its contributors may not be used to endorse or promote - - products derived from this software without specific prior written - - permission. - - . - - THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS - - IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED - - TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A - - PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - - HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - - SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED - - TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR - - PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF - - LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING - - NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS - - SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE - ---- - -GNU General Public License v2.0 or later - -(base-files 10.3+deb10u10, NetBase 5.6) - -The GNU General Public License (GPL) - -==================================== - - - - - -Version 2, June 1991 - --------------------- - - - -Copyright (C) 1989, 1991 Free Software Foundation, Inc. - -59 Temple Place, Suite 330, Boston, MA 02111-1307 USAEveryone is permitted to copy and distribute verbatim copies - -of this license document, but changing it is not allowed. - - - -Preamble - - - -The licenses for most software are designed to take away your freedom to share - -and change it. By contrast, the GNU General Public License is intended to - -guarantee your freedom to share and change free software--to make sure the - -software is free for all its users. This General Public License applies to most - -of the Free Software Foundation's software and to any other program whose authors - -commit to using it. (Some other Free Software Foundation software is covered by - -the GNU Library General Public License instead.) You can apply it to your - -programs, too. - - - -When we speak of free software, we are referring to freedom, not price. Our - -General Public Licenses are designed to make sure that you have the freedom to - -distribute copies of free software (and charge for this service if you wish), - -that you receive source code or can get it if you want it, that you can change - -the software or use pieces of it in new free programs; and that you know you can - -do these things. - - - -To protect your rights, we need to make restrictions that forbid anyone to deny - -you these rights or to ask you to surrender the rights. These restrictions - -translate to certain responsibilities for you if you distribute copies of the - -software, or if you modify it. - - - -For example, if you distribute copies of such a program, whether gratis or for a - -fee, you must give the recipients all the rights that you have. You must make - -sure that they, too, receive or can get the source code. And you must show them - -these terms so they know their rights. - - - -We protect your rights with two steps: (1) copyright the software, and (2) offer - -you this license which gives you legal permission to copy, distribute and/or - -modify the software. - - - -Also, for each author's protection and ours, we want to make certain that - -everyone understands that there is no warranty for this free software. If the - -software is modified by someone else and passed on, we want its recipients to - -know that what they have is not the original, so that any problems introduced by - -others will not reflect on the original authors' reputations. - - - -Finally, any free program is threatened constantly by software patents. We wish - -to avoid the danger that redistributors of a free program will individually - -obtain patent licenses, in effect making the program proprietary. To prevent - -this, we have made it clear that any patent must be licensed for everyone's free - -use or not licensed at all. - - - -The precise terms and conditions for copying, distribution and modification - -follow. - - - -TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - - - 1. This License applies to any program or other work which contains a notice - - placed by the copyright holder saying it may be distributed under the terms - - of this General Public License. The "Program", below, refers to any such - - program or work, and a "work based on the Program" means either the Program - - or any derivative work under copyright law: that is to say, a work containing - - the Program or a portion of it, either verbatim or with modifications and/or - - translated into another language. (Hereinafter, translation is included - - without limitation in the term "modification".) Each licensee is addressed as - - "you". - - - - Activities other than copying, distribution and modification are not covered - - by this License; they are outside its scope. The act of running the Program - - is not restricted, and the output from the Program is covered only if its - - contents constitute a work based on the Program (independent of having been - - made by running the Program). Whether that is true depends on what the - - Program does. - - - - 2. You may copy and distribute verbatim copies of the Program's source code as - - you receive it, in any medium, provided that you conspicuously and - - appropriately publish on each copy an appropriate copyright notice and - - disclaimer of warranty; keep intact all the notices that refer to this - - License and to the absence of any warranty; and give any other recipients of - - the Program a copy of this License along with the Program. - - - - You may charge a fee for the physical act of transferring a copy, and you may - - at your option offer warranty protection in exchange for a fee. - - - - 3. You may modify your copy or copies of the Program or any portion of it, thus - - forming a work based on the Program, and copy and distribute such - - modifications or work under the terms of Section 1 above, provided that you - - also meet all of these conditions: - - - - a. You must cause the modified files to carry prominent notices stating - - that you changed the files and the date of any change. - - - - b. You must cause any work that you distribute or publish, that in whole or - - in part contains or is derived from the Program or any part thereof, to - - be licensed as a whole at no charge to all third parties under the terms - - of this License. - - - - c. If the modified program normally reads commands interactively when run, - - you must cause it, when started running for such interactive use in the - - most ordinary way, to print or display an announcement including an - - appropriate copyright notice and a notice that there is no warranty (or - - else, saying that you provide a warranty) and that users may redistribute - - the program under these conditions, and telling the user how to view a - - copy of this License. (Exception: if the Program itself is interactive - - but does not normally print such an announcement, your work based on the - - Program is not required to print an announcement.) - - - - These requirements apply to the modified work as a whole. If identifiable - - sections of that work are not derived from the Program, and can be reasonably - - considered independent and separate works in themselves, then this License, - - and its terms, do not apply to those sections when you distribute them as - - separate works. But when you distribute the same sections as part of a whole - - which is a work based on the Program, the distribution of the whole must be - - on the terms of this License, whose permissions for other licensees extend to - - the entire whole, and thus to each and every part regardless of who wrote it. - - - - Thus, it is not the intent of this section to claim rights or contest your - - rights to work written entirely by you; rather, the intent is to exercise the - - right to control the distribution of derivative or collective works based on - - the Program. - - - - In addition, mere aggregation of another work not based on the Program with - - the Program (or with a work based on the Program) on a volume of a storage or - - distribution medium does not bring the other work under the scope of this - - License. - - - - 4. You may copy and distribute the Program (or a work based on it, under - - Section 2) in object code or executable form under the terms of Sections 1 - - and 2 above provided that you also do one of the following: - - - - a. Accompany it with the complete corresponding machine-readable source - - code, which must be distributed under the terms of Sections 1 and 2 above - - on a medium customarily used for software interchange; or, - - - - b. Accompany it with a written offer, valid for at least three years, to - - give any third party, for a charge no more than your cost of physically - - performing source distribution, a complete machine-readable copy of the - - corresponding source code, to be distributed under the terms of Sections - - 1 and 2 above on a medium customarily used for software interchange; or, - - - - c. Accompany it with the information you received as to the offer to - - distribute corresponding source code. (This alternative is allowed only - - for noncommercial distribution and only if you received the program in - - object code or executable form with such an offer, in accord with - - Subsection b above.) - - - - The source code for a work means the preferred form of the work for making - - modifications to it. For an executable work, complete source code means all - - the source code for all modules it contains, plus any associated interface - - definition files, plus the scripts used to control compilation and - - installation of the executable. However, as a special exception, the source - - code distributed need not include anything that is normally distributed (in - - either source or binary form) with the major components (compiler, kernel, - - and so on) of the operating system on which the executable runs, unless that - - component itself accompanies the executable. - - - - If distribution of executable or object code is made by offering access to - - copy from a designated place, then offering equivalent access to copy the - - source code from the same place counts as distribution of the source code, - - even though third parties are not compelled to copy the source along with the - - object code. - - - - 5. You may not copy, modify, sublicense, or distribute the Program except as - - expressly provided under this License. Any attempt otherwise to copy, modify, - - sublicense or distribute the Program is void, and will automatically - - terminate your rights under this License. However, parties who have received - - copies, or rights, from you under this License will not have their licenses - - terminated so long as such parties remain in full compliance. - - - - 6. You are not required to accept this License, since you have not signed it. - - However, nothing else grants you permission to modify or distribute the - - Program or its derivative works. These actions are prohibited by law if you - - do not accept this License. Therefore, by modifying or distributing the - - Program (or any work based on the Program), you indicate your acceptance of - - this License to do so, and all its terms and conditions for copying, - - distributing or modifying the Program or works based on it. - - - - 7. Each time you redistribute the Program (or any work based on the Program), - - the recipient automatically receives a license from the original licensor to - - copy, distribute or modify the Program subject to these terms and conditions. - - You may not impose any further restrictions on the recipients' exercise of - - the rights granted herein. You are not responsible for enforcing compliance - - by third parties to this License. - - - - 8. If, as a consequence of a court judgment or allegation of patent - - infringement or for any other reason (not limited to patent issues), - - conditions are imposed on you (whether by court order, agreement or - - otherwise) that contradict the conditions of this License, they do not excuse - - you from the conditions of this License. If you cannot distribute so as to - - satisfy simultaneously your obligations under this License and any other - - pertinent obligations, then as a consequence you may not distribute the - - Program at all. For example, if a patent license would not permit - - royalty-free redistribution of the Program by all those who receive copies - - directly or indirectly through you, then the only way you could satisfy both - - it and this License would be to refrain entirely from distribution of the - - Program. - - - - If any portion of this section is held invalid or unenforceable under any - - particular circumstance, the balance of the section is intended to apply and - - the section as a whole is intended to apply in other circumstances. - - - - It is not the purpose of this section to induce you to infringe any patents - - or other property right claims or to contest validity of any such claims; - - this section has the sole purpose of protecting the integrity of the free - - software distribution system, which is implemented by public license - - practices. Many people have made generous contributions to the wide range of - - software distributed through that system in reliance on consistent - - application of that system; it is up to the author/donor to decide if he or - - she is willing to distribute software through any other system and a licensee - - cannot impose that choice. - - - - This section is intended to make thoroughly clear what is believed to be a - - consequence of the rest of this License. - - - - 9. If the distribution and/or use of the Program is restricted in certain - - countries either by patents or by copyrighted interfaces, the original - - copyright holder who places the Program under this License may add an - - explicit geographical distribution limitation excluding those countries, so - - that distribution is permitted only in or among countries not thus excluded. - - In such case, this License incorporates the limitation as if written in the - - body of this License. - - - - 10. The Free Software Foundation may publish revised and/or new versions of the - - General Public License from time to time. Such new versions will be similar - - in spirit to the present version, but may differ in detail to address new - - problems or concerns. - - - - Each version is given a distinguishing version number. If the Program - - specifies a version number of this License which applies to it and "any later - - version", you have the option of following the terms and conditions either of - - that version or of any later version published by the Free Software - - Foundation. If the Program does not specify a version number of this License, - - you may choose any version ever published by the Free Software Foundation. - - - - 11. If you wish to incorporate parts of the Program into other free programs - - whose distribution conditions are different, write to the author to ask for - - permission. For software which is copyrighted by the Free Software - - Foundation, write to the Free Software Foundation; we sometimes make - - exceptions for this. Our decision will be guided by the two goals of - - preserving the free status of all derivatives of our free software and of - - promoting the sharing and reuse of software generally. - - - - NO WARRANTY - - - - 12. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR - - THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE - - STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE - - PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, - - INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND - - FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND - - PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, - - YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - - - 13. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL - - ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE - - THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY - - GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE - - OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR - - DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR - - A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH - - HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. - - - - END OF TERMS AND CONDITIONS - - - -How to Apply These Terms to Your New Programs - - - -If you develop a new program, and you want it to be of the greatest possible use - -to the public, the best way to achieve this is to make it free software which - -everyone can redistribute and change under these terms. - - - -To do so, attach the following notices to the program. It is safest to attach - -them to the start of each source file to most effectively convey the exclusion of - -warranty; and each file should have at least the "copyright" line and a pointer - -to where the full notice is found. - - - -one line to give the program's name and a brief idea of what it does.Copyright (C) - - - -This program is free software; you can redistribute it and/or - -modify it under the terms of the GNU General Public License - -as published by the Free Software Foundation; either version 2 - -of the License, or (at your option) any later version. - - - -This program is distributed in the hope that it will be useful, - -but WITHOUT ANY WARRANTY; without even the implied warranty of - -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - -GNU General Public License for more details. - - - -You should have received a copy of the GNU General Public License - -along with this program; if not, write to the Free Software - -Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - - - -Also add information on how to contact you by electronic and paper mail. - - - -If the program is interactive, make it output a short notice like this when it - -starts in an interactive mode: - - - -Gnomovision version 69, Copyright (C) year name of author - -Gnomovision comes with ABSOLUTELY NO WARRANTY; for details - -type `show w'. This is free software, and you are welcome - -to redistribute it under certain conditions; type `show c' - -for details. - - - -The hypothetical commands `show w' and `show c' should show the appropriate parts - -of the General Public License. Of course, the commands you use may be called - -something other than `show w' and `show c'; they could even be mouse-clicks or - -menu items--whatever suits your program. - - - -You should also get your employer (if you work as a programmer) or your school, - -if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a - -sample; alter the names: - - - -Yoyodyne, Inc., hereby disclaims all copyright - -interest in the program `Gnomovision' - -(which makes passes at compilers) written - -by James Hacker. - - - -signature of Ty Coon, 1 April 1989 - -Ty Coon, President of Vice - - - -This General Public License does not permit incorporating your program into - -proprietary programs. If your program is a subroutine library, you may consider - -it more useful to permit linking proprietary applications with the library. If - -this is what you want to do, use the GNU Library General Public License instead - -of this License. - ---- - -ISC License - -(go-spew v1.1.1) - -ISC License - - - -Copyright (c) 2012-2016 Dave Collins - - - -Permission to use, copy, modify, and/or distribute this software for any - -purpose with or without fee is hereby granted, provided that the above - -copyright notice and this permission notice appear in all copies. - - - -THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES - -WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - -MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR - -ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES - -WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN - -ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF - -OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE - ---- - -MIT License - -(nxadm/tail v1.4.8) - -# The MIT License (MIT) - - - -# Copyright 2015 Hewlett Packard Enterprise Development LP - -Copyright (c) 2014 ActiveState - - - -Permission is hereby granted, free of charge, to any person obtaining a copy - -of this software and associated documentation files (the "Software"), to deal - -in the Software without restriction, including without limitation the rights - -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - -copies of the Software, and to permit persons to whom the Software is - -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all - -copies or substantial portions of the Software. - - - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - -SOFTWARE - ---- - -MIT License - -(beorn7-perks v1.0.1) - -Copyright (C) 2013 Blake Mizerany - - - -Permission is hereby granted, free of charge, to any person obtaining - -a copy of this software and associated documentation files (the - -"Software"), to deal in the Software without restriction, including - -without limitation the rights to use, copy, modify, merge, publish, - -distribute, sublicense, and/or sell copies of the Software, and to - -permit persons to whom the Software is furnished to do so, subject to - -the following conditions: - - - -The above copyright notice and this permission notice shall be - -included in all copies or substantial portions of the Software. - - - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND - -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE - -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION - -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION - -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE - ---- - -MIT License - -(github.com/golang-jwt/jwt v4.2.0) - -Copyright (c) 2012 Dave Grijalva - -Copyright (c) 2021 golang-jwt maintainers - - - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: - - - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. - - - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE - ---- - -MIT License - -(onsi/ginkgo 1.16.5) - -Copyright (c) 2013-2014 Onsi Fakhouri - - - -Permission is hereby granted, free of charge, to any person obtaining - -a copy of this software and associated documentation files (the - -"Software"), to deal in the Software without restriction, including - -without limitation the rights to use, copy, modify, merge, publish, - -distribute, sublicense, and/or sell copies of the Software, and to - -permit persons to whom the Software is furnished to do so, subject to - -the following conditions: - - - -The above copyright notice and this permission notice shall be - -included in all copies or substantial portions of the Software. - - - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND - -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE - -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION - -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION - -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE - ---- - -MIT License - -(cespare/xxhash v2.1.2) - -Copyright (c) 2016 Caleb Spare - - - -MIT License - - - -Permission is hereby granted, free of charge, to any person obtaining - -a copy of this software and associated documentation files (the - -"Software"), to deal in the Software without restriction, including - -without limitation the rights to use, copy, modify, merge, publish, - -distribute, sublicense, and/or sell copies of the Software, and to - -permit persons to whom the Software is furnished to do so, subject to - -the following conditions: - - - -The above copyright notice and this permission notice shall be - -included in all copies or substantial portions of the Software. - - - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND - -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE - -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION - -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION - -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE - ---- - -MIT License - -(felixge/httpsnoop v1.0.1) - -Copyright (c) 2016 Felix Geisendrfer (felix@debuggable.com) - - - -Permission is hereby granted, free of charge, to any person obtaining a copy - - of this software and associated documentation files (the "Software"), to deal - - in the Software without restriction, including without limitation the rights - - to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - - copies of the Software, and to permit persons to whom the Software is - - furnished to do so, subject to the following conditions: - - - - The above copyright notice and this permission notice shall be included in - - all copies or substantial portions of the Software. - - - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - - FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - - AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - - LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - - OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN - - THE SOFTWARE - ---- - -MIT License - -(mailru/easyjson v0.7.6) - -Copyright (c) 2016 Mail.Ru Group - - - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: - - - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. - - - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE - ---- - -MIT License - -(uber-go/atomic 1.7.0) - -Copyright (c) 2016 Uber Technologies, Inc. - - - -Permission is hereby granted, free of charge, to any person obtaining a copy - -of this software and associated documentation files (the "Software"), to deal - -in the Software without restriction, including without limitation the rights - -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - -copies of the Software, and to permit persons to whom the Software is - -furnished to do so, subject to the following conditions: - - - -The above copyright notice and this permission notice shall be included in - -all copies or substantial portions of the Software. - - - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN - -THE SOFTWARE - ---- - -MIT License - -(go-zap v1.21.0) - -Copyright (c) 2016-2017 Uber Technologies, Inc. - - - -Permission is hereby granted, free of charge, to any person obtaining a copy - -of this software and associated documentation files (the "Software"), to deal - -in the Software without restriction, including without limitation the rights - -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - -copies of the Software, and to permit persons to whom the Software is - -furnished to do so, subject to the following conditions: - - - -The above copyright notice and this permission notice shall be included in - -all copies or substantial portions of the Software. - - - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN - -THE SOFTWARE - ---- - -MIT License - -(go.uber.org/multierr v1.6.0) - -Copyright (c) 2017 Uber Technologies, Inc. - - - -Permission is hereby granted, free of charge, to any person obtaining a copy - -of this software and associated documentation files (the "Software"), to deal - -in the Software without restriction, including without limitation the rights - -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - -copies of the Software, and to permit persons to whom the Software is - -furnished to do so, subject to the following conditions: - - - -The above copyright notice and this permission notice shall be included in - -all copies or substantial portions of the Software. - - - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN - -THE SOFTWARE - ---- - -MIT License - -(kr/pretty v0.2.0) - -Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ - -Upstream-Name: github.com/kr/pretty - -Source: https://github.com/kr/pretty/ - - - -Files: * - -Copyright: 20112016 Keith Rarick - -License: Expat - - - -Files: debian/* - -Copyright: 2013 Tonnerre Lombard - -License: Expat - - - -License: Expat - - - -Permission is hereby granted, free of charge, to any person obtaining a copy - - of this software and associated documentation files (the "Software"), to deal - - in the Software without restriction, including without limitation the rights - - to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - - copies of the Software, and to permit persons to whom the Software is - - furnished to do so, subject to the following conditions: - - . - - The above copyright notice and this permission notice shall be included in - - all copies or substantial portions of the Software. - - . - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - - FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - - AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - - LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - - OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN - - THE SOFTWARE - ---- - -MIT License - -(GoDoc Text v0.2.0) - -Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ - -Upstream-Name: github.com/kr/text - -Source: https://github.com/kr/text/ - - - -Files: * - -Copyright: 2013 Keith Rarick - -License: Expat - - - -Files: debian/* - -Copyright: 2013 Tonnerre Lombard - -License: Expat - - - -License: Expat - - - -Permission is hereby granted, free of charge, to any person obtaining a copy - - of this software and associated documentation files (the "Software"), to deal - - in the Software without restriction, including without limitation the rights - - to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - - copies of the Software, and to permit persons to whom the Software is - - furnished to do so, subject to the following conditions: - - . - - The above copyright notice and this permission notice shall be included in - - all copies or substantial portions of the Software. - - . - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - - FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - - AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - - LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - - OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN - - THE SOFTWARE - ---- - -MIT License - -(jsoniter-go v1.1.12) - -MIT License - - - -Copyright (c) 2016 json-iterator - - - -Permission is hereby granted, free of charge, to any person obtaining a copy - -of this software and associated documentation files (the "Software"), to deal - -in the Software without restriction, including without limitation the rights - -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - -copies of the Software, and to permit persons to whom the Software is - -furnished to do so, subject to the following conditions: - - - -The above copyright notice and this permission notice shall be included in all - -copies or substantial portions of the Software. - - - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - -SOFTWARE - ---- - -MIT License - -(josharian/intern v1.0.0) - -MIT License - - - -Copyright (c) 2019 Josh Bleecher Snyder - - - -Permission is hereby granted, free of charge, to any person obtaining a copy - -of this software and associated documentation files (the "Software"), to deal - -in the Software without restriction, including without limitation the rights - -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - -copies of the Software, and to permit persons to whom the Software is - -furnished to do so, subject to the following conditions: - - - -The above copyright notice and this permission notice shall be included in all - -copies or substantial portions of the Software. - - - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - -SOFTWARE - ---- - -MIT License - -(blang-semver v4.0.0) - -The MIT License - - - -Copyright (c) 2014 Benedikt Lang - - - -Permission is hereby granted, free of charge, to any person obtaining a copy - -of this software and associated documentation files (the "Software"), to deal - -in the Software without restriction, including without limitation the rights - -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - -copies of the Software, and to permit persons to whom the Software is - -furnished to do so, subject to the following conditions: - - - -The above copyright notice and this permission notice shall be included in - -all copies or substantial portions of the Software. - - - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN - -THE SOFTWARE - ---- - -MIT License - -(AWS SDK for Go 1.38.49, Go Testify 1.8.0, go-restful v3.8.0, go.uber.org/goleak v1.2.0, gomega v1.24.0, onsi/ginkgo v2.4.0, yaml for Go v3.0.1) - -The MIT License - -=============== - - - -Copyright (c) - - - -Permission is hereby granted, free of charge, to any person obtaining a copy of - -this software and associated documentation files (the "Software"), to deal in the - -Software without restriction, including without limitation the rights to use, - -copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the - -Software, and to permit persons to whom the Software is furnished to do so, - -subject to the following conditions: - - - -The above copyright notice and this permission notice shall be included in all - -copies or substantial portions of the Software. - - - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS - -FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR - -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN - -AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION - -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - ---- - -MIT License - -(armon/go-socks5 20160902-snapshot-e7533296) - -The MIT License (MIT) - - - -Copyright (c) 2014 Armon Dadgar - - - -Permission is hereby granted, free of charge, to any person obtaining a copy of - -this software and associated documentation files (the "Software"), to deal in - -the Software without restriction, including without limitation the rights to - -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of - -the Software, and to permit persons to whom the Software is furnished to do so, - -subject to the following conditions: - - - -The above copyright notice and this permission notice shall be included in all - -copies or substantial portions of the Software. - - - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS - -FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR - -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER - -IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN - -CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE - ---- - -MIT License - -(benbjohnson-clock v1.1.0) - -The MIT License (MIT) - - - -Copyright (c) 2014 Ben Johnson - - - -Permission is hereby granted, free of charge, to any person obtaining a copy - -of this software and associated documentation files (the "Software"), to deal - -in the Software without restriction, including without limitation the rights - -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - -copies of the Software, and to permit persons to whom the Software is - -furnished to do so, subject to the following conditions: - - - -The above copyright notice and this permission notice shall be included in all - -copies or substantial portions of the Software. - - - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - -SOFTWARE - ---- - -Public Domain - -(Go programming language 1.18.7, Time Zone Database 2021a) - -Public domain code is not subject to any license. - ---- diff --git a/README.md b/README.md index 836835c9..4497857e 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,29 @@ -# BeeGFS CSI Driver - -[![License](https://img.shields.io/github/license/netapp/beegfs-csi-driver)](LICENSE) -[![Docker pulls](https://img.shields.io/docker/pulls/netapp/beegfs-csi-driver)](https://hub.docker.com/r/netapp/beegfs-csi-driver) -[![Go report card](https://goreportcard.com/badge/github.com/netapp/beegfs-csi-driver)](https://goreportcard.com/report/github.com/netapp/beegfs-csi-driver) - - -## Contents - -* [Overview](#overview) -* [Compatibility](#compatibility) -* [Support](#support) -* [Getting Started](#getting-started) -* [Basic Use and Examples](#basic-use) -* [Contributing](#contributing-to-the-project) -* [Releases](#releases) -* [Versioning](#versioning) -* [License](#license) -* [Maintainers](#maintainers) +# BeeGFS CSI Driver + + + +[![License](https://img.shields.io/github/license/thinkparq/beegfs-csi-driver)](LICENSE) +[![Build, Test, and Publish Container Images](https://github.com/ThinkParQ/beegfs-csi-driver/actions/workflows/build-test-publish.yaml/badge.svg)](https://github.com/ThinkParQ/beegfs-csi-driver/actions/workflows/build-test-publish.yaml) + +## Contents + +- [Overview](#overview) + - [Notable Features](#notable-features) +- [Compatibility](#compatibility) + - [Known Incompatibilities](#known-incompatibilities) + - [BeeGFS CSI Driver compatibility with BeeGFS 7.2.7+ and 7.3.1+](#beegfs-csi-driver-compatibility-with-beegfs-727-and-731) +- [Support](#support) +- [Getting Started](#getting-started) + - [Prerequisite(s)](#prerequisites) + - [Quick Start](#quick-start) +- [Basic Use](#basic-use) + - [Dynamic Storage Provisioning:](#dynamic-storage-provisioning) + - [Static Provisioning:](#static-provisioning) + - [Examples](#examples) +- [Contributing to the Project](#contributing-to-the-project) +- [Releases](#releases) +- [Versioning](#versioning) +- [License](#license) *** @@ -33,7 +40,7 @@ The driver can be easily deployed using the provided Kubernetes manifests. Optionally the [BeeGFS CSI Driver Operator](operator/README.md) can be used to automate day-1 (install/ configure) and day-2 (reconfigure/update) tasks for the driver. This especially simplifies discovery and installation from Operator -Lifecycle Manger (OLM) enabled clusters like Red Hat OpenShift. +Lifecycle Manger (OLM) enabled clusters. ### Notable Features @@ -70,15 +77,16 @@ table describes the versions of each component used in testing each release of the BeeGFS CSI driver. These configurations should be considered compatible and supported. -| beegfs.csi.netapp.com | K8s Versions | Red Hat OpenShift Versions | BeeGFS Client Versions | CSI Version | -| ---------------------- | -------------------------------- | ------------------------------------ | ---------------------- | ------------ | -| v1.4.0 | 1.22.6, 1.23.5, 1.24.1, 1.25.2 | 4.11 (RHEL only; RHCOS experimental) | 7.3.2, 7.2.8 | v1.7.0 | -| v1.3.0 | 1.21.4, 1.22.3, 1.23.1, 1.24.1 | 4.10 (RHEL only; RHCOS experimental) | 7.3.1, 7.2.7 | v1.6.0 | -| v1.2.2 | 1.20.11, 1.21.4, 1.22.3, 1.23.1 | 4.10 (RHEL only; RHCOS experimental) | 7.3.0, 7.2.6 [^1] | v1.5.0 | -| v1.2.1 | 1.19.15, 1.20.11, 1.21.4, 1.22.3 | 4.9 (RHEL only) | 7.2.5 [^1] | v1.5.0 | -| v1.2.0 | 1.18, 1.19, 1.20, 1.21 | 4.8 (RHEL only) | 7.2.4 [^1] | v1.5.0 | -| v1.1.0 | 1.18, 1.19, 1.20 | | 7.2.1 [^1] | v1.3.0 | -| v1.0.0 | 1.19 | | 7.2 [^1] | v1.3.0 | +| beegfs.csi.netapp.com | K8s Versions | Red Hat OpenShift Versions | BeeGFS Client Versions | CSI Version | +| --------------------- | -------------------------------- | ------------------------------------------ | ---------------------- | ----------- | +| v1.5.0 (prerelease) | 1.24.15, 1.25.11, 1.26.3, 1.27.3 | [No longer tested.](docs/compatibility.md) | 7.3.3 | v1.7.0 | +| v1.4.0 | 1.22.6, 1.23.5, 1.24.1, 1.25.2 | 4.11 (RHEL only; RHCOS experimental) | 7.3.2, 7.2.8 | v1.7.0 | +| v1.3.0 | 1.21.4, 1.22.3, 1.23.1, 1.24.1 | 4.10 (RHEL only; RHCOS experimental) | 7.3.1, 7.2.7 | v1.6.0 | +| v1.2.2 | 1.20.11, 1.21.4, 1.22.3, 1.23.1 | 4.10 (RHEL only; RHCOS experimental) | 7.3.0, 7.2.6 [^1] | v1.5.0 | +| v1.2.1 | 1.19.15, 1.20.11, 1.21.4, 1.22.3 | 4.9 (RHEL only) | 7.2.5 [^1] | v1.5.0 | +| v1.2.0 | 1.18, 1.19, 1.20, 1.21 | 4.8 (RHEL only) | 7.2.4 [^1] | v1.5.0 | +| v1.1.0 | 1.18, 1.19, 1.20 | | 7.2.1 [^1] | v1.3.0 | +| v1.0.0 | 1.19 | | 7.2 [^1] | v1.3.0 | See the [compatibility guide](docs/compatibility.md) for more details on expectations of compatibility for the BeeGFS CSI driver. @@ -125,7 +133,7 @@ issues with components outside of the compatibility matrix will depend on the details of the issue. If you have any questions, feature requests, or would like to report an issue -please submit them at https://github.com/NetApp/beegfs-csi-driver/issues. +please submit them at https://github.com/ThinkParQ/beegfs-csi-driver/issues. *** @@ -171,7 +179,7 @@ deployment guide](operator/README.md). 1. On a machine with kubectl and access to the Kubernetes cluster where you want to deploy the BeeGFS CSI driver clone this repository: `git clone - https://github.com/NetApp/beegfs-csi-driver.git`. + https://github.com/ThinkParQ/beegfs-csi-driver.git`. 2. Change to the BeeGFS CSI driver directory (`cd beegfs-csi-driver`). 3. In BeeGFS versions 7.3.1+ or 7.2.7+, explicit connAuth configuration is required. Do one of the following or see [ConnAuth @@ -273,6 +281,13 @@ given a version number MAJOR.MINOR.PATCH, we increment the: * PATCH version when: small bug or security fixes are needed in a more timely manner. +When upgrading the driver using default Kustomize (`kubectl`) deployment option, +it is recommended to reference the [upgrade +notes](deploy/k8s/README.md#upgrade-notes) for your particular upgrade path. +While the driver itself may be backwards compatible, if you used a non-standard +file layout or customized the Kubernetes manifests used to deploy the driver, +you may need to make adjustments to your manifests. + *** @@ -282,10 +297,3 @@ Apache License 2.0 *** - -## Maintainers - -* Joe McCormick (@iamjoemccormick). -* Eric Weber (@ejweber). -* Garrett Marks (@gmarks-ntap). -* Cole Krizek (@ckrizek). diff --git a/deploy/k8s/README.md b/deploy/k8s/README.md index 6cfa041c..8a651433 100644 --- a/deploy/k8s/README.md +++ b/deploy/k8s/README.md @@ -1,11 +1,13 @@ -# Kustomize Specific Deployment Details +# Kustomize Specific Deployment Details -## Contents +## Contents -* [Basics](#basics) -* [Upgrading to v1.2.0](#upgrade-1.2.0-kubernetes-deployment) -* [Upgrading to v1.4.0](#upgrade-1.4.0-kubernetes-deployment) +- [Basics](#basics) +- [Upgrade Notes](#upgrade-notes) + - [Upgrading to v1.2.0](#upgrading-to-v120) + - [Upgrading to v1.4.0](#upgrading-to-v140) + - [Upgrading to v1.5.0](#upgrading-to-v150) ## Basics @@ -46,6 +48,8 @@ by the development team to the base manifests or version patches will be picked up when you pull a new version of the project and your custom modifications will continue to work unless otherwise noted. +## Upgrade Notes + ### Upgrading to v1.2.0 @@ -99,3 +103,32 @@ images: Note: Overriding driver container image name is not common and most overlays will not need to be modified. + + +### Upgrading to v1.5.0 + +v1.5.0 changes the default driver container image name from +`docker.io/netapp/beegfs-csi-driver` to `ghcr.io/thinkparq/beegfs-csi-driver:v1.5.0` as +part of migrating the BeeGFS CSI driver to a new GitHub organization. + +If you were previously using an overlay to override this image name, you must +update your overlay with the new default name. + +This kustomization stanza: +``` +images: + - name: docker.io/netapp/beegfs-csi-driver + newName: some.location/beegfs-csi-driver + newTag: some-tag +``` + +Becomes this kustomization stanza: +``` +images: + - name: ghcr.io/thinkparq/beegfs-csi-driver:v1.5.0 + newName: some.location/beegfs-csi-driver + newTag: some-tag +``` + +Note: Overriding driver container image name is not common and most overlays +will not need to be modified. diff --git a/deploy/k8s/bases/csi-beegfs-controller.yaml b/deploy/k8s/bases/csi-beegfs-controller.yaml index 3a29f249..200c6a05 100644 --- a/deploy/k8s/bases/csi-beegfs-controller.yaml +++ b/deploy/k8s/bases/csi-beegfs-controller.yaml @@ -33,12 +33,12 @@ spec: - --volume-name-uuid-length=8 - -v=$(LOG_LEVEL) securityContext: - # On SELinux enabled systems, a non-privileged sidecar container cannot access the unix domain socket - # created by the privileged driver container. + # On SELinux enabled systems, a non-privileged sidecar container cannot access the unix domain socket + # created by the privileged driver container. privileged: true env: - name: LOG_LEVEL - value: '3' + value: "3" volumeMounts: - mountPath: /csi name: socket-dir @@ -49,7 +49,7 @@ spec: cpu: 80m memory: 24Mi - name: beegfs - image: docker.io/netapp/beegfs-csi-driver:v1.4.0 + image: ghcr.io/thinkparq/beegfs-csi-driver:v1.5.0 args: - --driver-name=beegfs.csi.netapp.com - --node-id=$(KUBE_NODE_NAME) @@ -70,7 +70,7 @@ spec: apiVersion: v1 fieldPath: spec.nodeName - name: LOG_LEVEL - value: '3' + value: "3" volumeMounts: - mountPath: /csi name: socket-dir @@ -82,7 +82,7 @@ spec: # Because we chwrap mount/umount, we must propagate the container's /host mounts to the node. mountPropagation: Bidirectional name: host-dir - readOnly: true # We should NOT write arbitrarily to the host filesystem. + readOnly: true # We should NOT write arbitrarily to the host filesystem. - mountPath: /var/lib/kubelet/plugins/beegfs.csi.netapp.com # We must know whether a directory is a mount point in order to decide how to handle it. mountPropagation: HostToContainer @@ -105,11 +105,11 @@ spec: path: /var/lib/kubelet/plugins/beegfs.csi.netapp.com type: DirectoryOrCreate name: plugin-dir - - emptyDir: { } + - emptyDir: {} name: socket-dir - configMap: - name: csi-beegfs-config # kustomized + name: csi-beegfs-config # kustomized name: config-dir - secret: - secretName: csi-beegfs-connauth # kustomized + secretName: csi-beegfs-connauth # kustomized name: connauth-dir diff --git a/deploy/k8s/bases/csi-beegfs-node.yaml b/deploy/k8s/bases/csi-beegfs-node.yaml index 92bda85c..87a41287 100644 --- a/deploy/k8s/bases/csi-beegfs-node.yaml +++ b/deploy/k8s/bases/csi-beegfs-node.yaml @@ -29,16 +29,16 @@ spec: - -v=$(LOG_LEVEL) env: - name: LOG_LEVEL - value: '3' + value: "3" securityContext: - # On SELinux enabled systems, a non-privileged sidecar container cannot access the unix domain socket - # created by the privileged driver container. + # On SELinux enabled systems, a non-privileged sidecar container cannot access the unix domain socket + # created by the privileged driver container. privileged: true volumeMounts: - - mountPath: /csi - name: socket-dir - - mountPath: /registration - name: registration-dir + - mountPath: /csi + name: socket-dir + - mountPath: /registration + name: registration-dir resources: limits: memory: 128Mi @@ -46,7 +46,7 @@ spec: cpu: 80m memory: 10Mi - name: beegfs - image: docker.io/netapp/beegfs-csi-driver:v1.4.0 + image: ghcr.io/thinkparq/beegfs-csi-driver:v1.5.0 args: - --driver-name=beegfs.csi.netapp.com - --node-id=$(KUBE_NODE_NAME) @@ -61,16 +61,16 @@ spec: apiVersion: v1 fieldPath: spec.nodeName - name: LOG_LEVEL - value: '3' + value: "3" securityContext: # Privileged is required for bidirectional mount propagation and to run the mount command. # Adding the SYS_ADMIN capability is insufficient in certain environments (e.g. when AppArmor is enabled). privileged: true ports: - - containerPort: 9898 - hostPort: 9898 # Must be same as containerPort when hostNetwork=true. - name: healthz - protocol: TCP + - containerPort: 9898 + hostPort: 9898 # Must be same as containerPort when hostNetwork=true. + name: healthz + protocol: TCP livenessProbe: failureThreshold: 5 httpGet: @@ -84,7 +84,7 @@ spec: - mountPath: /host mountPropagation: Bidirectional name: host-dir - readOnly: true # We should NOT write arbitrarily to the host filesystem. + readOnly: true # We should NOT write arbitrarily to the host filesystem. # Because we chwrap mount/umount, we must propagate the container's /host mounts to the node. - mountPath: /var/lib/kubelet/pods # We must know whether a directory is a mount point in order to decide how to handle it. @@ -108,12 +108,12 @@ spec: memory: 20Mi - name: liveness-probe volumeMounts: - - mountPath: /csi - name: socket-dir + - mountPath: /csi + name: socket-dir image: k8s.gcr.io/sig-storage/livenessprobe:v2.6.0 args: - - --csi-address=/csi/csi.sock - - --health-port=9898 + - --csi-address=/csi/csi.sock + - --health-port=9898 resources: limits: memory: 128Mi @@ -149,8 +149,8 @@ spec: type: DirectoryOrCreate name: socket-dir - configMap: - name: csi-beegfs-config # kustomized + name: csi-beegfs-config # kustomized name: config-dir - secret: - secretName: csi-beegfs-connauth # kustomized + secretName: csi-beegfs-connauth # kustomized name: connauth-dir diff --git a/deploy/k8s/deploy.go b/deploy/k8s/deploy.go index 7aed0892..8f4c2abb 100644 --- a/deploy/k8s/deploy.go +++ b/deploy/k8s/deploy.go @@ -55,7 +55,7 @@ const ( // These are expected Config Map and Secret keys within the manifests. Some operator logic is based off the expectation // that keys have these names. deploy_test.go attempts to ensure that a developer can not change these names -//without understanding that operator code must be refactored. +// without understanding that operator code must be refactored. const ( KeyNameConfigMap = "csi-beegfs-config.yaml" KeyNameSecret = "csi-beegfs-connauth.yaml" diff --git a/deploy/k8s/overlays/default-dev/kustomization.yaml b/deploy/k8s/overlays/default-dev/kustomization.yaml index b1e8b0cf..d38e3fb8 100644 --- a/deploy/k8s/overlays/default-dev/kustomization.yaml +++ b/deploy/k8s/overlays/default-dev/kustomization.yaml @@ -5,7 +5,7 @@ apiVersion: kustomize.config.k8s.io/v1beta1 kind: Kustomization namespace: default bases: - - ../../versions/latest # Modify this to select a specific Kubernetes version. + - ../../versions/latest # Modify this to select a specific Kubernetes version. patchesStrategicMerge: # See ../examples/patches for additional patch ideas. - patches/image-pull-policy.yaml @@ -29,7 +29,7 @@ secretGenerator: files: - csi-beegfs-connauth.yaml -# The images section is used to transform the image name to specify the specific image to use in the deployment +# The images section is used to transform the image name to specify the specific image to use in the deployment # manifests. This section can be used to adjust the registry and image names and tags for air-gapped environments # or other scenarios where custom containers names are used. You can adjust the registry and/or location within # a registry with the newName field. You can change the tag being used with the NewTag field. You can also @@ -37,9 +37,9 @@ secretGenerator: # See https://kubectl.docs.kubernetes.io/references/kustomize/builtins/#_imagetagtransformer_ # for more information on how to use this section. images: - - name: docker.io/netapp/beegfs-csi-driver - newName: docker.repo.eng.netapp.com/globalcicd/apheleia/beegfs-csi-driver - newTag: master + - name: ghcr.io/thinkparq/beegfs-csi-driver + newName: beegfs-csi-driver + newTag: latest # digest: - name: k8s.gcr.io/sig-storage/csi-provisioner newName: docker.repo.eng.netapp.com/sig-storage/csi-provisioner @@ -49,4 +49,4 @@ images: # newTag: - name: k8s.gcr.io/sig-storage/csi-node-driver-registrar newName: docker.repo.eng.netapp.com/sig-storage/csi-node-driver-registrar - # newTag: \ No newline at end of file + # newTag: diff --git a/deploy/k8s/overlays/default/kustomization.yaml b/deploy/k8s/overlays/default/kustomization.yaml index c033b5f0..092cf466 100644 --- a/deploy/k8s/overlays/default/kustomization.yaml +++ b/deploy/k8s/overlays/default/kustomization.yaml @@ -3,9 +3,9 @@ apiVersion: kustomize.config.k8s.io/v1beta1 kind: Kustomization -namespace: beegfs-csi # Modify this to deploy to a different namespace. +namespace: beegfs-csi # Modify this to deploy to a different namespace. bases: - - ../../versions/latest # Modify this to select a specific Kubernetes version. + - ../../versions/latest # Modify this to select a specific Kubernetes version. resources: - namespace.yaml patchesStrategicMerge: @@ -29,8 +29,7 @@ secretGenerator: - name: csi-beegfs-connauth files: - csi-beegfs-connauth.yaml - -# The images section is used to transform the image name to specify the specific image to use in the deployment +# The images section is used to transform the image name to specify the specific image to use in the deployment # manifests. This section can be used to adjust the registry and image names and tags for air-gapped environments # or other scenarios where custom containers names are used. You can adjust the registry and/or location within # a registry with the newName field. You can change the tag being used with the NewTag field. You can also @@ -38,8 +37,8 @@ secretGenerator: # See https://kubectl.docs.kubernetes.io/references/kustomize/builtins/#_imagetagtransformer_ # for more information on how to use this section. #images: -# - name: docker.io/netapp/beegfs-csi-driver -# newTag: v1.3.0 +# - name: ghcr.io/thinkparq/beegfs-csi-driver +# newTag: v1.5.0 # digest: sha256:9027762e2ae434aa52a071a484b0a7e26018c64d0fb884f7f8cff0af970c4eb8 # - name: k8s.gcr.io/sig-storage/csi-provisioner # newName: diff --git a/deploy/nomad/controller.nomad b/deploy/nomad/controller.nomad index 6ef45573..1fde7d34 100644 --- a/deploy/nomad/controller.nomad +++ b/deploy/nomad/controller.nomad @@ -22,7 +22,7 @@ job "beegfs-csi-plugin-controller" { driver = "docker" config { - image = "docker.io/netapp/beegfs-csi-driver:v1.4.0" + image = "ghcr.io/thinkparq/beegfs-csi-driver:v1.5.0" # chwrap is used to execute the beegfs-ctl binary already installed on the host. We also read the # beegfs-client.conf template already installed on the host. @@ -83,7 +83,7 @@ job "beegfs-csi-plugin-controller" { # LIKELY TO REQUIRE MODIFICATION. # csi-beegfs-config.yaml is the primary means of configuring the BeeGFS CSI driver. See - # https://github.com/NetApp/beegfs-csi-driver/blob/master/docs/deployment.md#managing-beegfs-client-configuration + # https://github.com/ThinkParQ/beegfs-csi-driver/blob/master/docs/deployment.md#managing-beegfs-client-configuration # for details. # This stanza must be kept in sync with its partner in node.nomad. template { @@ -95,7 +95,7 @@ EOH # LIKELY TO REQUIRE MODIFICATION. # csi-beegfs-connauth.yaml container connauth information required by the BeeGFS client to mount secured file - # systems. See https://github.com/NetApp/beegfs-csi-driver/blob/master/docs/deployment.md#connauth-configuration + # systems. See https://github.com/ThinkParQ/beegfs-csi-driver/blob/master/docs/deployment.md#connauth-configuration # for details. # This stanza must be kept in sync with its partner in node.nomad. template { diff --git a/deploy/nomad/node.nomad b/deploy/nomad/node.nomad index fd7071e1..bb8557e0 100644 --- a/deploy/nomad/node.nomad +++ b/deploy/nomad/node.nomad @@ -20,7 +20,7 @@ job "beegfs-csi-plugin-node" { driver = "docker" config { - image = "docker.io/netapp/beegfs-csi-driver:v1.4.0" + image = "ghcr.io/thinkparq/beegfs-csi-driver:v1.5.0" # chwrap is used to execute the beegfs-ctl binary already installed on the host. We also read the # beegfs-client.conf template already installed on the host. @@ -82,7 +82,7 @@ job "beegfs-csi-plugin-node" { # LIKELY TO REQUIRE MODIFICATION. # csi-beegfs-config.yaml is the primary means of configuring the BeeGFS CSI driver. See - # https://github.com/NetApp/beegfs-csi-driver/blob/master/docs/deployment.md#managing-beegfs-client-configuration + # https://github.com/ThinkParQ/beegfs-csi-driver/blob/master/docs/deployment.md#managing-beegfs-client-configuration # for details. # This stanza must be kept in sync with its partner in controller.nomad. template { @@ -94,7 +94,7 @@ EOH # LIKELY TO REQUIRE MODIFICATION. # csi-beegfs-connauth.yaml container connauth information required by the BeeGFS client to mount secured file - # systems. See https://github.com/NetApp/beegfs-csi-driver/blob/master/docs/deployment.md#connauth-configuration + # systems. See https://github.com/ThinkParQ/beegfs-csi-driver/blob/master/docs/deployment.md#connauth-configuration # for details. # This stanza must be kept in sync with its partner in controller.nomad. template { diff --git a/docs/compatibility.md b/docs/compatibility.md index 86553d5f..22dba12d 100644 --- a/docs/compatibility.md +++ b/docs/compatibility.md @@ -1,4 +1,4 @@ -# BeeGFS CSI Driver Compatibility +# BeeGFS CSI Driver Compatibility The goal for the BeeGFS CSI driver is to maintain compatibility with relevant versions of Kubernetes as well as relevant version of BeeGFS. With this goal in @@ -7,12 +7,15 @@ version compatibility and testing. *** -## Contents +## Contents -* [Kubernetes](#kubernetes) -* [BeeGFS](#beegfs) -* [OpenShift](#openshift) -* [Nomad](#nomad) +- [Kubernetes](#kubernetes) + - [Supporting New Kubernetes Releases](#supporting-new-kubernetes-releases) + - [Dropping Compatibility Support For Old Kubernetes Releases](#dropping-compatibility-support-for-old-kubernetes-releases) +- [BeeGFS](#beegfs) + - [BeeGFS Version Support](#beegfs-version-support) +- [OpenShift](#openshift) +- [Nomad](#nomad) *** @@ -79,9 +82,14 @@ the BeeGFS driver. ## OpenShift -A new version of the driver and the operator that can be used to deploy -and/or upgrade the driver will be tested on the latest supported version of -OpenShift. +Starting from version v1.5.0, the BeeGFS CSI driver will no longer be tested +with RedHat OpenShift. While we expect that the driver will continue to function +with RedHat OpenShift, we have decided to suspend direct testing against this +platform due to the associated licensing and other costs of maintaining the +necessary test environments. If this change impacts your use of the driver, we +encourage you to open an issue so we can understand your specific use case and +discuss potential avenues to resume testing with OpenShift, or alternatively, +with the community version, OKD. *** diff --git a/docs/deployment.md b/docs/deployment.md index 56cb3ede..e5ad797d 100644 --- a/docs/deployment.md +++ b/docs/deployment.md @@ -1,32 +1,41 @@ -# BeeGFS CSI Driver Deployment +# BeeGFS CSI Driver Deployment -## Contents - -* [Verifying BeeGFS CSI Driver Image Signatures](#verifying-beegfs-csi-driver-image-signatures) - * [Manual Image Verification](#manual-image-verification) - * [Download Certificates and Tools](#download-certificates-and-tools) - * [Verify the Signing Certificate is Trusted](#verify-the-signing-certificate-is-trusted) - * [Extract the Public Key From the Certificate](#extract-the-public-key-from-the-certificate) - * [Validate the BeeGFS CSI Driver Image Signatures](#validate-the-beegfs-csi-driver-image-signatures) - * [Automating Image Verification with Admission Controllers](#automating-image-verification) -* [Deploying to Kubernetes](#deploying-to-kubernetes) - * [Kubernetes Node Preparation](#kubernetes-node-preparation) - * [Kubernetes Deployment](#kubernetes-deployment) - * [Air-Gapped Kubernetes Deployment](#air-gapped-kubernetes-deployment) - * [Deployment to Kubernetes Clusters with Mixed Nodes](#mixed-kubernetes-deployment) - * [Deployment to Kubernetes Using the Operator](#operator-deployment) -* [Example Application Deployment](#example-application-deployment) -* [Managing BeeGFS Client Configuration](#managing-beegfs-client-configuration) - * [General Configuration](#general-configuration) - * [ConnAuth Configuration](#connauth-configuration) - * [BeeGFS Helperd Configuration](#beegfs-helperd) - * [Kubernetes Configuration](#kubernetes-configuration) - * [BeeGFS Client Parameters](#beegfs-client-parameters) -* [Notes for Kubernetes Administrators](#kubernetes-administrator-notes) - * [Security and Networking Considerations](#security-considerations) - * [Resource and Performance Considerations](#resource-and-performance-considerations) -* [Removing the Driver from Kubernetes](#removing-the-driver-from-kubernetes) +## Contents + +- [Verifying BeeGFS CSI Driver Image Signatures](#verifying-beegfs-csi-driver-image-signatures) + - [Manual Image Verification](#manual-image-verification) + - [Prerequisites: Download the public key and tools](#prerequisites-download-the-public-key-and-tools) + - [Steps: Validate the BeeGFS CSI Driver image signatures](#steps-validate-the-beegfs-csi-driver-image-signatures) + - [Automating Image Verification with Admission Controllers](#automating-image-verification-with-admission-controllers) +- [Deploying to Kubernetes](#deploying-to-kubernetes) + - [Kubernetes Node Preparation](#kubernetes-node-preparation) + - [Kubernetes Deployment](#kubernetes-deployment) + - [Air-Gapped Kubernetes Deployment](#air-gapped-kubernetes-deployment) + - [Deployment to Kubernetes Clusters With Mixed Nodes](#deployment-to-kubernetes-clusters-with-mixed-nodes) + - [Deployment to Kubernetes Using the Operator](#deployment-to-kubernetes-using-the-operator) +- [Example Application Deployment](#example-application-deployment) +- [Managing BeeGFS Client Configuration](#managing-beegfs-client-configuration) + - [General Configuration](#general-configuration) + - [ConnAuth Configuration](#connauth-configuration) + - [Option 1: Use Connection Authentication](#option-1-use-connection-authentication) + - [Option 2: Disable Connection Authentication](#option-2-disable-connection-authentication) + - [BeeGFS Helperd Configuration](#beegfs-helperd-configuration) + - [Kubernetes Configuration](#kubernetes-configuration) + - [BeeGFS Client Parameters (beegfsClientConf)](#beegfs-client-parameters-beegfsclientconf) + - [Notable](#notable) + - [No Effect](#no-effect) + - [Unsupported](#unsupported) + - [Tested](#tested) + - [Untested](#untested) + - [BeeGFS Client Parameter Compatibility](#beegfs-client-parameter-compatibility) + - [BeeGFS 7.3 Client](#beegfs-73-client) +- [Notes for Kubernetes Administrators](#notes-for-kubernetes-administrators) + - [Security and Networking Considerations](#security-and-networking-considerations) + - [Resource and Performance Considerations](#resource-and-performance-considerations) + - [Limit the number of in-flight requests.](#limit-the-number-of-in-flight-requests) + - [Managing CPU and Memory Requests and Limits](#managing-cpu-and-memory-requests-and-limits) +- [Removing the Driver from Kubernetes](#removing-the-driver-from-kubernetes) *** @@ -43,68 +52,39 @@ is optional. ### Manual Image Verification - -#### Download Certificates and Tools +#### Prerequisites: Download the public key and tools The following tools and files should be available on a Linux host. - * The openssl command. * The [cosign](https://github.com/sigstore/cosign/releases) utility. - * The certificate and CA chain file used to generate the image signatures. - * Download the files from the [BeeGFS CSI driver - releases](https://github.com/NetApp/beegfs-csi-driver/releases) page. + * The Cosign public key versioned in the repository at + [release/cosign.pub](../release/cosign.pub). - -#### Verify the Signing Certificate is Trusted -Use the following openssl command to validate that the certificate used for -signing the images was signed by a trusted Certificate Authority. - -``` -openssl verify -show_chain -CAfile beegfs-csi-signer-ca-chain.crt beegfs-csi-signer.crt -``` - -If this command returns Ok then the certificate in the beegfs-csi-signer.crt was -signed by a trusted CA. - - -#### Extract the Public Key From the Certificate - -This step is optional. - -The cosign command can use either the certificate or the public key to validate -the image signatures. If you just want to manually validate the images you can -skip the step of extracting the public key. If you want to automate image -verification in Kubernetes you may need the public key instead of the -certificate. - -``` -openssl x509 -in beegfs-csi-signer.crt -inform PEM -pubkey -noout > beegfs-csi-signer-pubkey.pem -``` - - -#### Validate the BeeGFS CSI Driver Image Signatures +#### Steps: Validate the BeeGFS CSI Driver image signatures Identify the image you want to validate. You can validate the image with either -the version tag or the image digest. Starting with v1.40 of the BeeGFS CSI -driver the image digests will be documented on the [BeeGFS CSI Driver GitHub -Releases](https://github.com/NetApp/beegfs-csi-driver/releases) page for -reference. +the version tag or the image digest. Starting with v1.5.0 of the BeeGFS CSI +driver the public key used to sign each release will be maintained at +[release/cosign.pub](../release/cosign.pub). Use the cosign command to validate the signature of the BeeGFS CSI driver -container. Make sure to use the appropriate tag or digest that you want to use -instead of the example tag and digest. +container. Make sure to use the appropriate key file name and tag or digest that +you want to use instead of the placeholders. + +OPTION 1: Validate the image using the version tag: -Validate the image by digest using the certificate file. ``` -cosign verify --cert beegfs-csi-signer.crt --cert-chain beegfs-csi-signer-ca-chain.crt docker.io/netapp/beegfs-csi-driver@sha256:9027762e2ae434aa52a071a484b0a7e26018c64d0fb884f7f8cff0af970c4eb8 +cosign verify --key > ghcr.io/thinkparq/beegfs-csi-driver: ``` -or +Example: `cosign verify --key cosign.pub ghcr.io/thinkparq/beegfs-csi-driver:v1.5.0` + +OPTION 2: Validate the image using the version tag and digest: -Validate the image by tag using the extracted public key. ``` -cosign verify --key beegfs-csi-signer-pubkey.pem docker.io/netapp/beegfs-csi-driver:v1.4.0 +cosign verify --key ghcr.io/thinkparq/beegfs-csi-driver:@SHA256: ``` +Example: `cosign verify --key cosign.pub ghcr.io/thinkparq/beegfs-csi-driver:v1.5.0@SHA256:a6efb4f870003f28a2ee421690f4f9d0e5b8eed0e24b3881fb816a760eb6dfea` ### Automating Image Verification with Admission Controllers @@ -164,7 +144,7 @@ README](../deploy/k8s/README.md). Steps: * On a machine with kubectl and access to the Kubernetes cluster where you want to deploy the BeeGFS CSI driver clone this repository: `git clone - https://github.com/NetApp/beegfs-csi-driver.git`. + https://github.com/ThinkParQ/beegfs-csi-driver.git`. * Create a new kustomize overlay (changes made to the default overlay will be overwritten in subsequent driver versions): `cp -r deploy/k8s/overlays/default deploy/k8s/overlays/my-overlay`. @@ -982,7 +962,7 @@ configuration. If you're experiencing any issues, find functionality lacking, or our documentation is unclear, we'd appreciate if you let us know: -https://github.com/NetApp/beegfs-csi-driver/issues. +https://github.com/ThinkParQ/beegfs-csi-driver/issues. The driver can be removed using `kubectl delete -k` (kustomize) and the original deployment manifests. On a machine with kubectl and access to the Kubernetes diff --git a/docs/developer-docs.md b/docs/developer-docs.md index 73b54858..8e05cb31 100644 --- a/docs/developer-docs.md +++ b/docs/developer-docs.md @@ -1,13 +1,19 @@ -# BeeGFS CSI Driver Developer Documentation - -## Contents - -* [Overview](#overview) -* [Building the Project](#building-the-project) -* [Developer Kubernetes Deployment](#developer-kubernetes-deployment) -* [Style Guidelines](#style-guidelines) - * [YAML Files](#style-guidelines-yaml) -* [Frequently Asked Questions](#frequently-asked-questions) +# BeeGFS CSI Driver Developer Documentation + +## Contents + +- [Overview](#overview) +- [Building the Project](#building-the-project) + - [Building the binaries](#building-the-binaries) + - [Building the containers](#building-the-containers) + - [Building and pushing the containers](#building-and-pushing-the-containers) +- [Developer Kubernetes Deployment](#developer-kubernetes-deployment) +- [Style Guidelines](#style-guidelines) + - [YAML Files](#yaml-files) +- [Frequently Asked Questions](#frequently-asked-questions) + - [Why do we use sigs.k8s.io/yaml instead of gopkg.in/yaml?](#why-do-we-use-sigsk8sioyaml-instead-of-gopkginyaml) + - [Why do we use JSON tags instead of YAML tags on our Go structs?](#why-do-we-use-json-tags-instead-of-yaml-tags-on-our-go-structs) + - [Why must beegfsClientConf values be strings in the driver configuration file?](#why-must-beegfsclientconf-values-be-strings-in-the-driver-configuration-file) *** diff --git a/docs/nomad.md b/docs/nomad.md index 472ca398..09c04752 100644 --- a/docs/nomad.md +++ b/docs/nomad.md @@ -1,17 +1,17 @@ -# BeeGFS CSI Driver on Hashicorp Nomad +# BeeGFS CSI Driver on Hashicorp Nomad -## Contents +## Contents -* [Overview](#overview) -* [Maturity and Compatibility](#maturity-compatibility) -* [Deployment](#deployment) -* [Usage](#usage) -* [Known Issues](#known-issues) - * [Driver Logs Appear Empty](#empty-logs) - * [Podman Task Driver Unsupported](#podman-unsupported) - * [Error Listing Nomad Volumes (Verbose)](#list-verbose-error) -* [Troubleshooting](#troubleshooting) - * [Failed to Load a Map File](#map-file-fail) +- [Overview](#overview) +- [Maturity and Compatiblity](#maturity-and-compatiblity) +- [Deployment](#deployment) +- [Usage](#usage) +- [Known Issues](#known-issues) + - [Driver Logs Appear Empty](#driver-logs-appear-empty) + - [Podman Task Driver Unsupported](#podman-task-driver-unsupported) + - [Error Listing Nomad Volumes (Verbose)](#error-listing-nomad-volumes-verbose) +- [Troubleshooting](#troubleshooting) + - [Failed to Load a Map File](#failed-to-load-a-map-file) ## Overview @@ -40,12 +40,12 @@ an ALPHA level of maturity. The current BeeGFS CSI driver release is tested with the following Nomad and Nomad task driver versions: -| Component | Version | Status | Notes | -| ------------------------- | -------- | ------ | -------------------------------------------------------------- | -| Nomad | 1.4.2 | pass | Other versions 1.3.3+ MAY work. Versions 1.3.2- will NOT work. | -| Docker Task Driver | 1.4.2 | pass | Can consume driver volumes and deploy the driver. | -| Isolated Exec Task Driver | 1.4.2 | pass | Can consume driver volumes. | -| Podman Task Driver | 0.4.0 | fail | See known issues. | +| Component | Version | Status | Notes | +| ------------------------- | ------- | ------ | -------------------------------------------------------------- | +| Nomad | 1.4.2 | pass | Other versions 1.3.3+ MAY work. Versions 1.3.2- will NOT work. | +| Docker Task Driver | 1.4.2 | pass | Can consume driver volumes and deploy the driver. | +| Isolated Exec Task Driver | 1.4.2 | pass | Can consume driver volumes. | +| Podman Task Driver | 0.4.0 | fail | See known issues. | ## Deployment diff --git a/docs/quotas.md b/docs/quotas.md index 11792968..10b4ce98 100644 --- a/docs/quotas.md +++ b/docs/quotas.md @@ -1,12 +1,15 @@ -# Using BeeGFS Quotas with the CSI Driver +# Using BeeGFS Quotas with the CSI Driver -## Contents +## Contents -* [Overview](#overview) -* [Prerequisites](#prerequisites) -* [Enabling Quotas](#enabling-quotas) -* [Tracking BeeGFS Consumption by Storage Class](#tracking-beegfs-consumption-by-sc) +- [Overview](#overview) +- [Prerequisites](#prerequisites) +- [Enabling Quotas](#enabling-quotas) +- [Tracking BeeGFS Consumption by Storage Class](#tracking-beegfs-consumption-by-storage-class) + - [Introduction](#introduction) + - [Linux User/Group IDs and Containers](#linux-usergroup-ids-and-containers) + - [Example Steps to setup a Storage Class that use setgid to set a specific group](#example-steps-to-setup-a-storage-class-that-use-setgid-to-set-a-specific-group) *** @@ -234,8 +237,8 @@ spec: Quota information for storage pool Default (ID: 1): user/group || size || chunk files - name | id || used | hard || used | hard - --------------|------||------------|------------||---------|--------- + | name | id | | used | hard | | used | hard | + | ---- | --- ||------------|------------||---------|--------- k8s-sc| 1000|| 0 Byte| unlimited|| 0|unlimited ``` Note: As verified in the `ls -l` output the file we created takes 0 bytes so diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 0b0750d3..4ad514f0 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -1,16 +1,21 @@ -# Troubleshooting Guide +# Troubleshooting Guide -## Contents - -* [Overview](#overview) -* [Kubernetes](#kubernetes) - * [Determining the BeeGFS Client Configuration for a PVC](#k8s-determining-the-beegfs-client-conf-for-a-pvc) - * [Orphaned BeeGFS Mounts Remain on Nodes](#orphan-mounts) -* [Access Denied Issues](#access-denied-issues) - * [Discretionary Access Control](#discretionary-access-control) - * [SELinux](#selinux) -* [Frequent Slow Operations and/or gRPC ABORTED Response Codes](#frequent-slow-operations--grpc-aborted-response-codes) +## Contents + +- [Overview](#overview) +- [Kubernetes](#kubernetes) + - [Determining the BeeGFS Client Configuration for a PVC](#determining-the-beegfs-client-configuration-for-a-pvc) + - [Orphaned Mounts Remain on Nodes](#orphaned-mounts-remain-on-nodes) + - [General Symptoms](#general-symptoms) + - [Outdated Driver or Node Unstage Timeout Exceeded](#outdated-driver-or-node-unstage-timeout-exceeded) + - [Missing vol\_data.json](#missing-vol_datajson) + - [Cleanup](#cleanup) +- [Access Denied Issues](#access-denied-issues) + - [Discretionary Access Control](#discretionary-access-control) + - [SELinux](#selinux) +- [Frequent Slow Operations and/or gRPC ABORTED Response Codes](#frequent-slow-operations-andor-grpc-aborted-response-codes) +- [Pod Stuck In Terminating after Subpath Deletion](#pod-stuck-in-terminating-after-subpath-deletion) *** @@ -19,7 +24,7 @@ This section provides guidance and tips around troubleshooting issues that come up using the driver. For anything not covered here, please [submit an -issue](https://github.com/NetApp/beegfs-csi-driver/issues) using the label +issue](https://github.com/ThinkParQ/beegfs-csi-driver/issues) using the label "question". Suspected bugs should be submitted with the label "bug". *** @@ -303,7 +308,7 @@ also alleviate this issue. It is not recommended to take this action on a produc *** -## Freqeunt Slow Operations and/or gRPC ABORTED Response Codes +## Frequent Slow Operations and/or gRPC ABORTED Response Codes The controller service must execute multiple beegfs-ctl commands to fulfill a CreateVolume request. In an optimal networking environment, each command takes milliseconds to complete and CreateVolume returns quickly. However, each diff --git a/docs/usage.md b/docs/usage.md index 9fb45b5f..0eb409b4 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -1,15 +1,46 @@ -# BeeGFS CSI Driver Usage +# BeeGFS CSI Driver Usage -## Contents - -* [Important Concepts](#important-concepts) -* [Dynamic Provisioning Workflow](#dynamic-provisioning-workflow) -* [Static Provisioning Workflow](#static-provisioning-workflow) -* [Best Practices](#best-practices) -* [Managing ReadOnly Volumes](#managing-readonly-volumes) -* [Notes for BeeGFS Administrators](#notes-for-beegfs-administrators) -* [Limitations and Known Issues](#limitations-and-known-issues) +## Contents + +- [Important Concepts](#important-concepts) + - [Definition of a "Volume"](#definition-of-a-volume) + - [Capacity](#capacity) + - [Static vs Dynamic Provisioning](#static-vs-dynamic-provisioning) + - [Dynamic Provisioning Use Case](#dynamic-provisioning-use-case) + - [Static Provisioning Use Case](#static-provisioning-use-case) + - [Client Configuration and Tuning](#client-configuration-and-tuning) +- [Dynamic Provisioning Workflow](#dynamic-provisioning-workflow) + - [Assumptions](#assumptions) + - [High Level](#high-level) + - [Create a Storage Class](#create-a-storage-class) + - [Create a Persistent Volume Claim](#create-a-persistent-volume-claim) + - [Create a Pod, Deployment, Stateful Set, etc.](#create-a-pod-deployment-stateful-set-etc) +- [Static Provisioning Workflow](#static-provisioning-workflow) + - [Assumptions](#assumptions-1) + - [High Level](#high-level-1) + - [Create a Persistent Volume](#create-a-persistent-volume) + - [Create a Persistent Volume Claim](#create-a-persistent-volume-claim-1) + - [Create a Pod, Deployment, Stateful Set, etc.](#create-a-pod-deployment-stateful-set-etc-1) +- [Best Practices](#best-practices) +- [Managing ReadOnly Volumes](#managing-readonly-volumes) + - [Configuring ReadOnly Volumes Within a Pod Specification](#configuring-readonly-volumes-within-a-pod-specification) + - [Using The Container VolumeMount Method](#using-the-container-volumemount-method) + - [Using the Volumes PersistentVolumeClaim Method](#using-the-volumes-persistentvolumeclaim-method) + - [Additional Considerations](#additional-considerations) + - [Configuring ReadOnly Volumes With MountOptions](#configuring-readonly-volumes-with-mountoptions) + - [Configuring ReadOnly on a PersistentVolume](#configuring-readonly-on-a-persistentvolume) + - [Configuring ReadOnly on a StorageClass](#configuring-readonly-on-a-storageclass) +- [Notes for BeeGFS Administrators](#notes-for-beegfs-administrators) + - [General](#general) + - [BeeGFS Mount Options](#beegfs-mount-options) + - [Memory Consumption with RDMA](#memory-consumption-with-rdma) + - [Permissions](#permissions) + - [fsGroup Behavior](#fsgroup-behavior) +- [Limitations and Known Issues](#limitations-and-known-issues) + - [General](#general-1) + - [Read Only and Access Modes in Kubernetes](#read-only-and-access-modes-in-kubernetes) + - [Long paths may cause errors](#long-paths-may-cause-errors) *** @@ -126,11 +157,11 @@ utility in the `--setpattern` mode can be passed with the prefix the newly created subdirectory has the same striping configuration as its parent. The following `stripePattern/` parameters work with the driver: -| Prefix | Parameter | Required | Accepted patterns | Example | Default -| ------ | --------- | -------- | ----------------- | ------- | ------- -| stripePattern/ | storagePoolID | no | unsigned integer | 1 | file system default -| stripePattern/ | chunkSize | no | unsigned integer + k (kilo) or m (mega) | 512k
1m | file system default -| stripePattern/ | numTargets | no | unsigned integer | 4 | file system default +| Prefix | Parameter | Required | Accepted patterns | Example | Default | +| -------------- | ------------- | -------- | --------------------------------------- | ---------- | ------------------- | +| stripePattern/ | storagePoolID | no | unsigned integer | 1 | file system default | +| stripePattern/ | chunkSize | no | unsigned integer + k (kilo) or m (mega) | 512k
1m | file system default | +| stripePattern/ | numTargets | no | unsigned integer | 4 | file system default | NOTE: While the driver expects values with certain patterns (e.g. unsigned integer), Kubernetes only accepts string values in Storage Classes. These @@ -149,11 +180,11 @@ administrators may want to [change the default permissions](#permissions) on a per-Storage-Class basis, in particular if [integration with BeeGFS quotas is desired](quotas.md). The following `permissions/` parameters allow this fine-grained control: -| Prefix | Parameter | Required | Accepted patterns | Example | Default -| ------ | --------- | -------- | ----------------- | ------- | ------- -| permissions/ | uid | no | unsigned integer | 1000 | 0 (root) -| permissions/ | gid | no | unsigned integer | 1000 | 0 (root) -| permissions/ | mode | no | three or four digit octal notation | 755
0755 | 0777 +| Prefix | Parameter | Required | Accepted patterns | Example | Default | +| ------------ | --------- | -------- | ---------------------------------- | ----------- | -------- | +| permissions/ | uid | no | unsigned integer | 1000 | 0 (root) | +| permissions/ | gid | no | unsigned integer | 1000 | 0 (root) | +| permissions/ | mode | no | three or four digit octal notation | 755
0755 | 0777 | NOTE: While the driver expects values with certain patterns (e.g. unsigned integer), Kubernetes only accepts string values in Storage Classes. These diff --git a/examples/k8s/all/all-app.yaml b/examples/k8s/all/all-app.yaml index 080c4853..43269f64 100644 --- a/examples/k8s/all/all-app.yaml +++ b/examples/k8s/all/all-app.yaml @@ -9,14 +9,14 @@ spec: - name: csi-beegfs-all-app image: alpine:latest volumeMounts: - - mountPath: /mnt/dyn - name: csi-beegfs-dyn-volume - - mountPath: /mnt/ge - name: csi-beegfs-ge-volume - - mountPath: /mnt/static - name: csi-beegfs-static-volume - - mountPath: /mnt/static-ro - name: csi-beegfs-static-ro-volume + - mountPath: /mnt/dyn + name: csi-beegfs-dyn-volume + - mountPath: /mnt/ge + name: csi-beegfs-ge-volume + - mountPath: /mnt/static + name: csi-beegfs-static-volume + - mountPath: /mnt/static-ro + name: csi-beegfs-static-ro-volume # Replace "name" with a unique k8s cluster name to disambiguate files touched by pods with UUIDs that collide among separate k8s clusters. # The "command": # - Creates a file with the pod's UUID as its name to demonstrate the ability to write to BeeGFS. @@ -25,12 +25,17 @@ spec: # -> kubectl exec -it csi-beegfs-all-app -- ash # -> ls /mnt/dyn # -> ls /mnt/ge - # -> ls /mnt/static + # -> ls /mnt/static # Confirm that the pod has read-only access to BeeGFS: # -> kubectl exec -it csi-beegfs-all-app -- ash # -> touch /mnt/static-ro/file # This should fail to write the file # -> ls /mnt/static-ro - command: [ "ash", "-c", 'touch "/mnt/dyn/touched-by-${POD_UUID}" "/mnt/ge/touched-by-${POD_UUID}" "/mnt/static/touched-by-k8s-name-${POD_UUID}" && sleep 7d'] + command: + [ + "ash", + "-c", + 'touch "/mnt/dyn/touched-by-${POD_UUID}" "/mnt/ge/touched-by-${POD_UUID}" "/mnt/static/touched-by-k8s-name-${POD_UUID}" && sleep 7d', + ] env: - name: POD_UUID valueFrom: @@ -40,13 +45,12 @@ spec: - name: csi-beegfs-dyn-volume persistentVolumeClaim: claimName: csi-beegfs-dyn-pvc # defined in dyn-pvc.yaml - volumes: - name: csi-beegfs-ge-volume ephemeral: volumeClaimTemplate: # similar to ../dyn/dyn-pvc.yaml spec: accessModes: - - ReadWriteMany + - ReadWriteMany resources: requests: storage: 100Gi diff --git a/examples/nomad/volume.hcl b/examples/nomad/volume.hcl index 32ed7fee..dc6e3231 100644 --- a/examples/nomad/volume.hcl +++ b/examples/nomad/volume.hcl @@ -11,11 +11,11 @@ type = "csi" plugin_id = "beegfs-csi-plugin" # Passed by Nomad to the BeeGFS CSI driver, but ignored (see -# https://github.com/NetApp/beegfs-csi-driver/blob/master/docs/usage.md#capacity for details). +# https://github.com/ThinkParQ/beegfs-csi-driver/blob/master/docs/usage.md#capacity for details). capacity_min = "1MB" # Passed by Nomad to the BeeGFS CSI driver, but ignored (see -# https://github.com/NetApp/beegfs-csi-driver/blob/master/docs/usage.md#capacity for details). +# https://github.com/ThinkParQ/beegfs-csi-driver/blob/master/docs/usage.md#capacity for details). capacity_max = "1GB" # Any number of capabilities can be passed to the BeeGFS CSI driver by Nomad. @@ -30,7 +30,7 @@ capability { } # BeeGFS CSI driver-specific parameters passed by Nomad during volume creation. See -# https://github.com/NetApp/beegfs-csi-driver/blob/master/docs/usage.md#create-a-storage-class for allowed parameters. +# https://github.com/ThinkParQ/beegfs-csi-driver/blob/master/docs/usage.md#create-a-storage-class for allowed parameters. # sysMgmtdHost and volDirBasePath are required. parameters { # Change this to the IP address or FQDN of the BeeGFS management service for an accessible BeeGFS file system. diff --git a/operator/Dockerfile b/operator/Dockerfile index 6f09bd34..cdbc8c61 100644 --- a/operator/Dockerfile +++ b/operator/Dockerfile @@ -7,6 +7,9 @@ # Use distroless as minimal base image to package the manager binary. Refer to # https://github.com/GoogleContainerTools/distroless for more details. FROM gcr.io/distroless/static:nonroot +LABEL org.opencontainers.image.description="BeeGFS CSI Driver Operator" +LABEL org.opencontainers.image.source="https://github.com/ThinkParQ/beegfs-csi-driver/operator" +LABEL org.opencontainers.image.licenses="Apache-2.0" WORKDIR / COPY bin/manager . USER 65532:65532 diff --git a/operator/README.md b/operator/README.md index 1c267b0c..cf403e9c 100644 --- a/operator/README.md +++ b/operator/README.md @@ -1,25 +1,26 @@ -# BeeGFS CSI Driver Operator +# BeeGFS CSI Driver Operator -## Contents +## Contents -* [Overview](#overview) -* [Requirements](#requirements) -* [Verify the Operator Signature](#verify-operator-signature) - * [Verify Trust in the Signing Certificate](#verify-trust-in-the-signing-certificate) - * [Validate the BeeGFS CSI Driver Operator Image Signature](#validate-the-beegfs-csi-driver-operator-image-signature) -* [Install the Operator](#install-operator) - * [Install from the Openshift Console](#install-operator-openshift-console) - * [Install the Operator from OperatorHub](#install-operator-operator-hub) - * [Install from Manifests](#install-operator-manifests) -* [Install the Driver](#install-driver) - * [BeegfsDriver Custom Resource Fields](#crd-fields) - * [ConnAuth Configuration](#connauth-configuration) - * [Install from the OpenShift Console](#install-driver-openshift-console) - * [Install Using kubectl or oc](#install-driver-kubectl-oc) -* [Modify the Driver Configuration](#modify-driver-configuration) -* [Upgrade the Driver](#upgrade-driver) -* [Uninstall the Driver and/or Operator](#uninstall) +- [Overview](#overview) +- [Requirements](#requirements) +- [Verify the Operator Image Signature](#verify-the-operator-image-signature) + - [Verify Trust in the Signing Certificate](#verify-trust-in-the-signing-certificate) + - [Validate the BeeGFS CSI Driver Operator Image Signature](#validate-the-beegfs-csi-driver-operator-image-signature) +- [Install the Operator](#install-the-operator) + - [Install from OperatorHub](#install-from-operatorhub) + - [Install from the OpenShift Console (deprecated)](#install-from-the-openshift-console-deprecated) + - [Install from Manifests](#install-from-manifests) +- [Install the Driver](#install-the-driver) + - [BeegfsDriver Custom Resource Fields](#beegfsdriver-custom-resource-fields) + - [ConnAuth Configuration](#connauth-configuration) + - [Verify the BeeGFS CSI Driver Image Signature](#verify-the-beegfs-csi-driver-image-signature) + - [Install from the OpenShift Console (deprecated)](#install-from-the-openshift-console-deprecated-1) + - [Install Using kubectl](#install-using-kubectl) +- [Modify the Driver Configuration](#modify-the-driver-configuration) +- [Upgrade the Driver](#upgrade-the-driver) +- [Uninstall the Driver and/or Operator](#uninstall-the-driver-andor-operator) ## Overview @@ -112,17 +113,6 @@ operator. ## Install the Operator -### Install from the OpenShift Console - - -Operators are first-class citizens in OpenShift and are easy to install from -the OpenShift console. As a user with administrative permissions: - -1. Navigate to the OperatorHub pane of the console. -1. Search for and click on the BeeGFS CSI driver operator. It is a "community" - operator tagged for "storage". -1. Click "Install", verify the defaults, and click "Install" again. - ### Install from OperatorHub @@ -145,6 +135,17 @@ manual way by creating a Subscription that references a Catalog Source. See the [OLM documentation](https://olm.operatorframework.io/docs/tasks/install-operator-with-olm/) for details. +### Install from the OpenShift Console (deprecated) + + +Operators are first-class citizens in OpenShift and are easy to install from +the OpenShift console. As a user with administrative permissions: + +1. Navigate to the OperatorHub pane of the console. +1. Search for and click on the BeeGFS CSI driver operator. It is a "community" + operator tagged for "storage". +1. Click "Install", verify the defaults, and click "Install" again. + ### Install from Manifests @@ -313,7 +314,7 @@ would deploy the image ```docker.io/netapp/beegfs-csi-driver:v1.4.0```. In this case the image ```docker.io/netapp/beegfs-csi-driver:v1.4.0``` would be the image to use with for the signature verification. -### Install from the OpenShift Console +### Install from the OpenShift Console (deprecated) Operator "operands" are first-class citizens in OpenShift and are easy to @@ -331,7 +332,7 @@ install from the OpenShift console. As a user with administrative permissions: figure out what fields exist for configuration. 1. Click "Create". -### Install Using kubectl or oc +### Install Using kubectl Use this method if you have installed the operator either from OperatorHub or diff --git a/operator/api/v1/groupversion_info.go b/operator/api/v1/groupversion_info.go index 4372d9c4..528bf978 100644 --- a/operator/api/v1/groupversion_info.go +++ b/operator/api/v1/groupversion_info.go @@ -15,8 +15,8 @@ limitations under the License. */ // Package v1 contains API Schema definitions for the beegfs v1 API group -//+kubebuilder:object:generate=true -//+groupName=beegfs.csi.netapp.com +// +kubebuilder:object:generate=true +// +groupName=beegfs.csi.netapp.com package v1 import ( diff --git a/operator/docs/developer-docs.md b/operator/docs/developer-docs.md index 85b08a68..889ca6cb 100644 --- a/operator/docs/developer-docs.md +++ b/operator/docs/developer-docs.md @@ -1,27 +1,28 @@ -# BeeGFS CSI Driver Operator Developer Documentation +# BeeGFS CSI Driver Operator Developer Documentation -## Contents +## Contents -* [Overview](#overview) -* [Important Links](#important-links) -* [Development Environment](#development-environment) -* [Directory Structure](#directory-structure) -* [General Workflows](#general-workflows) - * [Build and Test the Operator Controller Manager](#build-and-test-the-operator-controller-manager) - * [Change the BeegfsDrivers API](#change-the-beegfsdrivers-api) - * [Change the Behavior of the Controller](#change-the-behavior-of-the-controller) - * [Change the Way OLM Displays or Installs the Operator](#change-the-way-olm-displays-or-installs-the-operator) - * [Prepare Changes For a Pull Request](#prepare-changes-for-a-pull-request) - * [Update the operator-sdk version](#update-the-operator-sdk-version) -* [Testing](#testing) - * [Bundle Validation](#bundle-validation) - * [Unit Testing](#unit-testing) - * [Integration Testing with EnvTest](#envtest) - * [Functional Testing](#functional-testing) - * [Run Operator Locally Against Any Cluster](#functional-testing-run-local) - * [Run Operator With OLM Integration Using OpenShift Console](#functional-testing-install-bundle) - * [Install Operator as if From OperatorHub in OpenShift Console](#functional-testing-install-openshift) +- [Overview](#overview) +- [Important Links](#important-links) +- [Development Environment](#development-environment) +- [Directory Structure](#directory-structure) +- [General Workflows](#general-workflows) + - [Build and Test the Operator Controller Manager](#build-and-test-the-operator-controller-manager) + - [Change the BeegfsDrivers API](#change-the-beegfsdrivers-api) + - [Change the Behavior of the Controller](#change-the-behavior-of-the-controller) + - [Change the Way OLM Displays or Installs the Operator](#change-the-way-olm-displays-or-installs-the-operator) + - [Prepare Changes For a Pull Request](#prepare-changes-for-a-pull-request) + - [Update the operator-sdk version](#update-the-operator-sdk-version) +- [Testing](#testing) + - [Bundle Validation](#bundle-validation) + - [Unit Testing](#unit-testing) + - [Integration Testing with EnvTest](#integration-testing-with-envtest) + - [Functional Testing](#functional-testing) + - [Run Operator Locally Against Any Cluster](#run-operator-locally-against-any-cluster) + - [Run Operator With OLM Integration Using kubectl](#run-operator-with-olm-integration-using-kubectl) + - [Run Operator With OLM Integration Using OpenShift Console (Deprecated)](#run-operator-with-olm-integration-using-openshift-console-deprecated) + - [Install Operator as if From OperatorHub in OpenShift Console (Deprecated)](#install-operator-as-if-from-operatorhub-in-openshift-console-deprecated) ## Overview @@ -305,7 +306,49 @@ In a separate terminal window (the first is consumed by the running operator): As commands are executed, logs in the first terminal window show the actions the operator is taking. -#### Run Operator With OLM Integration Using OpenShift Console +#### Run Operator With OLM Integration Using kubectl + +Prerequisites: + +* You have `kubectl` access to Kubernetes cluster with the Operator Life Cycle + Manager (OLM) already installed. + * Refer to the OLM documentation for how to [get + started](https://olm.operatorframework.io/docs/getting-started/.) +* The Kubernetes cluster does NOT have a running BeeGFS CSI driver operator or + BeeGFS CSI driver deployment. +* The go.mod referenced Go version is installed on the path. +* operator-sdk is installed on the path. + +Steps: + +1. In a terminal, navigate to the *operator/* directory. +2. Set the IMAGE_TAG_BASE environment variable so that it refers to a + container registry namespace you have access to. For example, `export + IMAGE_TAG_BASE=ghcr.io/thinkparq/test-beegfs-csi-driver-operator`. +3. Set the VERSION environment variable. For example, execute + `export VERSION=1.5.0`. The version MUST be semantic (e.g. 0.1.0) and + consistent through all operator related make commands. It is easiest to + simply use the VERSION already specified in *operator/Makefile* if there + is no compelling reason not to. +4. Execute `make build docker-build docker-push` to build the operator and + push it to the configured registry namespace. +5. Execute `make manifests bundle bundle-build bundle-push` to build and push a + bundle image operator-sdk can understand. +6. Execute `operator-sdk run bundle $IMAGE_TAG_BASE-bundle:v$VERSION` to cause + operator-sdk to create a pod that serves the bundle to OLM via subscription + (as well as other OLM objects). +7. To verify the operator is deployed run `kubectl get operators -A` +8. Experiment with creating/modifying/deleting BeegfsDriver objects. + NOTE: For many test cases, you will want to set the + `containerImageOverrides.beegfsCsiDriver.image` and/or + `containerImageOverrides.beegfsCsiDriver.tag` fields before deploying a CR + to ensure the default driver image (usually the last released version) is not + used. +9. In the terminal, execute `operator-sdk cleanup beegfs-csi-driver-operator` + to undo the above steps. + + +#### Run Operator With OLM Integration Using OpenShift Console (Deprecated) Much of the reason we created the operator was for installation of the driver @@ -369,7 +412,7 @@ Steps: 1. In the terminal, execute `operator-sdk cleanup beegfs-csi-driver-operator` to undo the above steps. -#### Install Operator as if From OperatorHub in OpenShift Console +#### Install Operator as if From OperatorHub in OpenShift Console (Deprecated) This test method simulates the entire OpenShift deployment workflow. It adds to diff --git a/pkg/beegfs/beegfs.go b/pkg/beegfs/beegfs.go index 5214f77a..635ce9b7 100644 --- a/pkg/beegfs/beegfs.go +++ b/pkg/beegfs/beegfs.go @@ -65,30 +65,32 @@ type beegfs struct { // Path variables rooted from BeeGFS have the suffix PathBeegfsRoot. // // From the host's perspective (file or directory names in "") (all variable names represent absolute paths): -// / -// |-- ... -// |-- mountDirPath -// |-- "beegfs-client.conf" (clientConfPath) -// |-- "connInterfacesFile" -// |-- "connNetFilterFile" -// |-- "connRDMAInterfacesFile" -// |-- "connTcpOnlyFilterFile" -// |-- "mount" (mountPath) -// |-- ... -// |-- ".csi" -// |-- volumes -// |-- csiDirPath -// |-- volDirBasePath -// |-- volDirPath (same as volDirPathBeegfsRoot) +// +// / +// |-- ... +// |-- mountDirPath +// |-- "beegfs-client.conf" (clientConfPath) +// |-- "connInterfacesFile" +// |-- "connNetFilterFile" +// |-- "connRDMAInterfacesFile" +// |-- "connTcpOnlyFilterFile" +// |-- "mount" (mountPath) +// |-- ... +// |-- ".csi" +// |-- volumes +// |-- csiDirPath +// |-- volDirBasePath +// |-- volDirPath (same as volDirPathBeegfsRoot) // // From the perspective of the BeeGFS file system (all variable names represent absolute paths): -// / -// |-- ... -// |-- volDirBasePathBeegfsRoot (same as volDirBasePath) -// |-- ".csi" -// |-- volumes -// |-- csiDirPathBeegfsRoot (same as csiDirPath) -// |-- volDirPathBeegfsRoot (same as volDirPath) +// +// / +// |-- ... +// |-- volDirBasePathBeegfsRoot (same as volDirBasePath) +// |-- ".csi" +// |-- volumes +// |-- csiDirPathBeegfsRoot (same as csiDirPath) +// |-- volDirPathBeegfsRoot (same as volDirPath) type beegfsVolume struct { config beegfsv1.BeegfsConfig clientConfPath string // absolute path to beegfs-client.conf from host root (e.g. /.../mountDirPath/beegfs-client.conf) diff --git a/pkg/beegfs/controllerserver.go b/pkg/beegfs/controllerserver.go index 8d1c8522..67b3c552 100644 --- a/pkg/beegfs/controllerserver.go +++ b/pkg/beegfs/controllerserver.go @@ -494,7 +494,7 @@ func getPermissionsConfigFromParams(reqParams map[string]string) (permissionsCon // (*controllerServer) newBeegfsVolume is a wrapper around newBeegfsVolume that makes it easier to call in the context // of the controller service. (*controllerServer) newBeegfsVolume selects the mountDirPath and passes the controller -//service's PluginConfig. +// service's PluginConfig. func (cs *controllerServer) newBeegfsVolume(sysMgmtdHost, volDirBasePathBeegfsRoot, volName string) beegfsVolume { volDirPathBeegfsRoot := path.Join(volDirBasePathBeegfsRoot, volName) // This volumeID construction duplicates the one further down in the stack. We do it anyway to generate an diff --git a/release/cosign.pub b/release/cosign.pub new file mode 100644 index 00000000..78733385 --- /dev/null +++ b/release/cosign.pub @@ -0,0 +1,4 @@ +-----BEGIN PUBLIC KEY----- +MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEzgTzYltBmNQmgO/n6GBBuZeC+ZsR +wSRXEqEFeBoXhSPSCJ1degXrPd5VJznDDR0mEzNgIa5zl0aGfUV7CnstEw== +-----END PUBLIC KEY----- diff --git a/test/e2e/README.md b/test/e2e/README.md index 4ba515cd..09a9549a 100644 --- a/test/e2e/README.md +++ b/test/e2e/README.md @@ -1,12 +1,15 @@ -# BeeGFS CSI Driver End-to-End Testing - -## Contents -* [Overview](#overview) -* [Requirements](#requirements) -* [CI Environments](#ci-environments) -* [Test Commands](#test-commands) - * [Ginkgo](#ginkgo) - * [Go Test](#go-test) +# BeeGFS CSI Driver End-to-End Testing + +> **Warning** +> This document has not been updated yet to reflect the project's migration to the ThinkParQ organization. + +## Contents +- [Overview](#overview) +- [Requirements](#requirements) +- [CI Environments](#ci-environments) +- [Test Commands](#test-commands) + - [Ginkgo](#ginkgo) + - [Go Test](#go-test) ## Overview diff --git a/test/e2e/utils/driver_config.go b/test/e2e/utils/driver_config.go index 2c6b4486..d3a3434a 100644 --- a/test/e2e/utils/driver_config.go +++ b/test/e2e/utils/driver_config.go @@ -26,9 +26,10 @@ import ( var beegfsDriverResource = schema.GroupVersionResource{Group: "beegfs.csi.netapp.com", Version: "v1", Resource: "beegfsdrivers"} // GetBeegfsDriverInUse returns a pointer to a BeegfsDriver if one and only one exists on the cluster. Consuming tests fail if: -// * The cluster knows about the BeegfsDriver resource but has non. -// * The cluster has more than one BeegfsDriver. -// * The attempt to list BeegfsDrivers fails for an unknown reason. +// - The cluster knows about the BeegfsDriver resource but has non. +// - The cluster has more than one BeegfsDriver. +// - The attempt to list BeegfsDrivers fails for an unknown reason. +// // GetBeegfsDriverInUse returns nil if the cluster doesn't know about BeegfsDriver resources. func GetBeegfsDriverInUse(dc dynamic.Interface) *beegfsv1.BeegfsDriver { // Use the client-go dynamic client to get a list of unstructured objects that match the BeegfsDriver schema. @@ -49,8 +50,8 @@ func GetBeegfsDriverInUse(dc dynamic.Interface) *beegfsv1.BeegfsDriver { } // GetConfigMapInUse returns the ConfigMap being used to configure the BeeGFS CSI driver. Consuming tests fail if: -// * The BeeGFS CSI driver controller service isn't using a ConfigMap (this is virtually impossible). -// * The ConfigMap can't be retrieved. +// - The BeeGFS CSI driver controller service isn't using a ConfigMap (this is virtually impossible). +// - The ConfigMap can't be retrieved. func GetConfigMapInUse(cs clientset.Interface) corev1.ConfigMap { // There may be many old ConfigMaps on the cluster. We need to get the one actually being used. controllerPod := GetRunningControllerPodOrFail(cs) diff --git a/test/env/beegfs-7.2-rh8-rdma/csi-beegfs-config.yaml b/test/env/beegfs-7.2-rh8-rdma/csi-beegfs-config.yaml deleted file mode 100644 index 20495bff..00000000 --- a/test/env/beegfs-7.2-rh8-rdma/csi-beegfs-config.yaml +++ /dev/null @@ -1,27 +0,0 @@ -# Copyright 2021 NetApp, Inc. All Rights Reserved. -# Licensed under the Apache License, Version 2.0. - -# Use this file as instructed in the General Configuration section of /docs/deployment.md. See -# /deploy/k8s/overlays/examples/csi-beegfs-config.yaml for a worst-case example of what to put in this file. Kustomize -# will automatically transform this file into a correct ConfigMap readable by the deployed driver. If this file is left -# unmodified, the driver will deploy correctly with no custom configuration. - -config: - # Test file systems are intentionally misconfigured to first advertise an interface/address that is unreachable. This - # connNetFilter configuration overcomes that misconfiguration and speeds up mounting for test cases that don't make - # use of it. - connNetFilter: - - 192.168.55.0/24 - - 10.113.4.0/24 -fileSystemSpecificConfigs: - - sysMgmtdHost: 192.168.55.15 - config: - beegfsClientConf: - connDisableAuthentication: "true" - connUseRDMA: "true" - - sysMgmtdHost: 192.168.55.16 - config: - beegfsClientConf: - connMgmtdPortTCP: "9009" - connMgmtdPortUDP: "9009" - connUseRDMA: "true" diff --git a/test/env/beegfs-7.2-rh8-rdma/csi-beegfs-connauth.yaml b/test/env/beegfs-7.2-rh8-rdma/csi-beegfs-connauth.yaml deleted file mode 100644 index e202a52e..00000000 --- a/test/env/beegfs-7.2-rh8-rdma/csi-beegfs-connauth.yaml +++ /dev/null @@ -1,10 +0,0 @@ -# Copyright 2021 NetApp, Inc. All Rights Reserved. -# Licensed under the Apache License, Version 2.0. - -# Use this file as instructed in the ConnAuth Configuration section of /docs/deployment.md. See -# /deploy/k8s/overlays/examples/csi-beegfs-connauth.yaml for an example of what to put in this file. Kustomize will -# automatically transform this file into a correct Secret readable by the deployed driver. If this file is left -# unmodified, the driver will deploy correctly with no custom configuration. - -- sysMgmtdHost: 192.168.55.16 - connAuth: secret1 diff --git a/test/env/beegfs-7.2-rh8-rdma/csi-beegfs-cr.yaml b/test/env/beegfs-7.2-rh8-rdma/csi-beegfs-cr.yaml deleted file mode 100644 index e040b48f..00000000 --- a/test/env/beegfs-7.2-rh8-rdma/csi-beegfs-cr.yaml +++ /dev/null @@ -1,56 +0,0 @@ -# Copyright 2021 NetApp, Inc. All Rights Reserved. -# Licensed under the Apache License, Version 2.0. - -# In a typical deployment with the operator, an administrator would pre-create this secret or edit it after it was -# created. For testing purposes it is easiest to simply deploy it here. - -kind: Secret -apiVersion: v1 -metadata: - name: csi-beegfs-connauth -stringData: - csi-beegfs-connauth.yaml: | - - sysMgmtdHost: 192.168.55.16 - connAuth: secret1 - ---- - -kind: BeegfsDriver -apiVersion: beegfs.csi.netapp.com/v1 -metadata: - name: csi-beegfs-cr # CR must have this name. -spec: - containerImageOverrides: - # This block allows us to use sed to select the driver image tag the operator uses when deployed with Jenkins. We - # pass the tag this way (instead of building it into the operator binary) so the operator image Jenkins builds can - # remain clean (i.e. it can be retagged and pushed to Docker Hub). - beegfsCsiDriver: - image: docker.repo.eng.netapp.com/globalcicd/apheleia/beegfs-csi-driver - tag: replaced-by-jenkins - nodeAffinityControllerService: - preferredDuringSchedulingIgnoredDuringExecution: - - weight: 50 - preference: - matchExpressions: - - key: node-role.kubernetes.io/master - operator: Exists - pluginConfig: - config: - # Test file systems are intentionally misconfigured to first advertise an interface/address that is unreachable. - # This connNetFilter configuration overcomes that misconfiguration and speeds up mounting for test cases that - # don't make use of it. - connNetFilter: - - 192.168.55.0/24 - - 10.113.4.0/24 - fileSystemSpecificConfigs: - - sysMgmtdHost: 192.168.55.15 - config: - beegfsClientConf: - connDisableAuthentication: "true" - connUseRDMA: "true" - - sysMgmtdHost: 192.168.55.16 - config: - beegfsClientConf: - connMgmtdPortTCP: "9009" - connMgmtdPortUDP: "9009" - connUseRDMA: "true" diff --git a/test/env/beegfs-7.2-rh8/csi-beegfs-config.yaml b/test/env/beegfs-7.2-rh8/csi-beegfs-config.yaml deleted file mode 100644 index ae7ec3ec..00000000 --- a/test/env/beegfs-7.2-rh8/csi-beegfs-config.yaml +++ /dev/null @@ -1,26 +0,0 @@ -# Copyright 2021 NetApp, Inc. All Rights Reserved. -# Licensed under the Apache License, Version 2.0. - -# Use this file as instructed in the General Configuration section of /docs/deployment.md. See -# /deploy/k8s/overlays/examples/csi-beegfs-config.yaml for a worst-case example of what to put in this file. Kustomize -# will automatically transform this file into a correct ConfigMap readable by the deployed driver. If this file is left -# unmodified, the driver will deploy correctly with no custom configuration. - -config: - # Test file systems are intentionally misconfigured to first advertise an interface/address that is unreachable. This - # connNetFilter configuration overcomes that misconfiguration and speeds up mounting for test cases that don't make - # use of it. - beegfsClientConf: - connUseRDMA: "false" - connNetFilter: - - 10.113.4.0/24 -fileSystemSpecificConfigs: - - sysMgmtdHost: 10.113.4.65 - config: - beegfsClientConf: - connDisableAuthentication: "true" - - sysMgmtdHost: 10.113.4.66 - config: - beegfsClientConf: - connMgmtdPortTCP: "9009" - connMgmtdPortUDP: "9009" diff --git a/test/env/beegfs-7.2-rh8/csi-beegfs-cr.yaml b/test/env/beegfs-7.2-rh8/csi-beegfs-cr.yaml deleted file mode 100644 index 578ec5a1..00000000 --- a/test/env/beegfs-7.2-rh8/csi-beegfs-cr.yaml +++ /dev/null @@ -1,55 +0,0 @@ -# Copyright 2021 NetApp, Inc. All Rights Reserved. -# Licensed under the Apache License, Version 2.0. - -# In a typical deployment with the operator, an administrator would pre-create this secret or edit it after it was -# created. For testing purposes it is easiest to simply deploy it here. - -kind: Secret -apiVersion: v1 -metadata: - name: csi-beegfs-connauth -stringData: - csi-beegfs-connauth.yaml: | - - sysMgmtdHost: 10.113.4.66 - connAuth: secret1 - ---- - -kind: BeegfsDriver -apiVersion: beegfs.csi.netapp.com/v1 -metadata: - name: csi-beegfs-cr # CR must have this name. -spec: - containerImageOverrides: - # This block allows us to use sed to select the driver image tag the operator uses when deployed with Jenkins. We - # pass the tag this way (instead of building it into the operator binary) so the operator image Jenkins builds can - # remain clean (i.e. it can be retagged and pushed to Docker Hub). - beegfsCsiDriver: - image: docker.repo.eng.netapp.com/globalcicd/apheleia/beegfs-csi-driver - tag: replaced-by-jenkins - nodeAffinityControllerService: - preferredDuringSchedulingIgnoredDuringExecution: - - weight: 50 - preference: - matchExpressions: - - key: node-role.kubernetes.io/master - operator: Exists - pluginConfig: - config: - # Test file systems are intentionally misconfigured to first advertise an interface/address that is unreachable. - # This connNetFilter configuration overcomes that misconfiguration and speeds up mounting for test cases that - # don't make use of it. - beegfsClientConf: - connUseRDMA: "false" - connNetFilter: - - 10.113.4.0/24 - fileSystemSpecificConfigs: - - sysMgmtdHost: 10.113.4.65 - config: - beegfsClientConf: - connDisableAuthentication: "true" - - sysMgmtdHost: 10.113.4.66 - config: - beegfsClientConf: - connMgmtdPortTCP: "9009" - connMgmtdPortUDP: "9009" diff --git a/test/env/beegfs-7.3-rh8-rdma/csi-beegfs-config.yaml b/test/env/beegfs-7.3-rh8-rdma/csi-beegfs-config.yaml deleted file mode 100644 index d0ee7bd6..00000000 --- a/test/env/beegfs-7.3-rh8-rdma/csi-beegfs-config.yaml +++ /dev/null @@ -1,27 +0,0 @@ -# Copyright 2021 NetApp, Inc. All Rights Reserved. -# Licensed under the Apache License, Version 2.0. - -# Use this file as instructed in the General Configuration section of /docs/deployment.md. See -# /deploy/k8s/overlays/examples/csi-beegfs-config.yaml for a worst-case example of what to put in this file. Kustomize -# will automatically transform this file into a correct ConfigMap readable by the deployed driver. If this file is left -# unmodified, the driver will deploy correctly with no custom configuration. - -config: - # Test file systems are intentionally misconfigured to first advertise an interface/address that is unreachable. This - # connNetFilter configuration overcomes that misconfiguration and speeds up mounting for test cases that don't make - # use of it. - connNetFilter: - - 192.168.55.0/24 - - 10.113.4.0/24 -fileSystemSpecificConfigs: - - sysMgmtdHost: 192.168.55.17 - config: - beegfsClientConf: - connDisableAuthentication: "true" - connUseRDMA: "true" - - sysMgmtdHost: 192.168.55.18 - config: - beegfsClientConf: - connMgmtdPortTCP: "9009" - connMgmtdPortUDP: "9009" - connUseRDMA: "true" diff --git a/test/env/beegfs-7.3-rh8-rdma/csi-beegfs-connauth.yaml b/test/env/beegfs-7.3-rh8-rdma/csi-beegfs-connauth.yaml deleted file mode 100644 index 4bed67cb..00000000 --- a/test/env/beegfs-7.3-rh8-rdma/csi-beegfs-connauth.yaml +++ /dev/null @@ -1,10 +0,0 @@ -# Copyright 2021 NetApp, Inc. All Rights Reserved. -# Licensed under the Apache License, Version 2.0. - -# Use this file as instructed in the ConnAuth Configuration section of /docs/deployment.md. See -# /deploy/k8s/overlays/examples/csi-beegfs-connauth.yaml for an example of what to put in this file. Kustomize will -# automatically transform this file into a correct Secret readable by the deployed driver. If this file is left -# unmodified, the driver will deploy correctly with no custom configuration. - -- sysMgmtdHost: 192.168.55.18 - connAuth: secret1 diff --git a/test/env/beegfs-7.3-rh8-rdma/csi-beegfs-cr.yaml b/test/env/beegfs-7.3-rh8-rdma/csi-beegfs-cr.yaml deleted file mode 100644 index 6a535aa7..00000000 --- a/test/env/beegfs-7.3-rh8-rdma/csi-beegfs-cr.yaml +++ /dev/null @@ -1,56 +0,0 @@ -# Copyright 2021 NetApp, Inc. All Rights Reserved. -# Licensed under the Apache License, Version 2.0. - -# In a typical deployment with the operator, an administrator would pre-create this secret or edit it after it was -# created. For testing purposes it is easiest to simply deploy it here. - -kind: Secret -apiVersion: v1 -metadata: - name: csi-beegfs-connauth -stringData: - csi-beegfs-connauth.yaml: | - - sysMgmtdHost: 192.168.55.18 - connAuth: secret1 - ---- - -kind: BeegfsDriver -apiVersion: beegfs.csi.netapp.com/v1 -metadata: - name: csi-beegfs-cr # CR must have this name. -spec: - containerImageOverrides: - # This block allows us to use sed to select the driver image tag the operator uses when deployed with Jenkins. We - # pass the tag this way (instead of building it into the operator binary) so the operator image Jenkins builds can - # remain clean (i.e. it can be retagged and pushed to Docker Hub). - beegfsCsiDriver: - image: docker.repo.eng.netapp.com/globalcicd/apheleia/beegfs-csi-driver - tag: replaced-by-jenkins - nodeAffinityControllerService: - preferredDuringSchedulingIgnoredDuringExecution: - - weight: 50 - preference: - matchExpressions: - - key: node-role.kubernetes.io/master - operator: Exists - pluginConfig: - config: - # Test file systems are intentionally misconfigured to first advertise an interface/address that is unreachable. - # This connNetFilter configuration overcomes that misconfiguration and speeds up mounting for test cases that - # don't make use of it. - connNetFilter: - - 192.168.55.0/24 - - 10.113.4.0/24 - fileSystemSpecificConfigs: - - sysMgmtdHost: 192.168.55.17 - config: - beegfsClientConf: - connDisableAuthentication: "true" - connUseRDMA: "true" - - sysMgmtdHost: 192.168.55.18 - config: - beegfsClientConf: - connMgmtdPortTCP: "9009" - connMgmtdPortUDP: "9009" - connUseRDMA: "true" diff --git a/test/env/beegfs-7.3-rh8/csi-beegfs-config.yaml b/test/env/beegfs-7.3-rh8/csi-beegfs-config.yaml deleted file mode 100644 index b1acf385..00000000 --- a/test/env/beegfs-7.3-rh8/csi-beegfs-config.yaml +++ /dev/null @@ -1,26 +0,0 @@ -# Copyright 2021 NetApp, Inc. All Rights Reserved. -# Licensed under the Apache License, Version 2.0. - -# Use this file as instructed in the General Configuration section of /docs/deployment.md. See -# /deploy/k8s/overlays/examples/csi-beegfs-config.yaml for a worst-case example of what to put in this file. Kustomize -# will automatically transform this file into a correct ConfigMap readable by the deployed driver. If this file is left -# unmodified, the driver will deploy correctly with no custom configuration. - -config: - # Test file systems are intentionally misconfigured to first advertise an interface/address that is unreachable. This - # connNetFilter configuration overcomes that misconfiguration and speeds up mounting for test cases that don't make - # use of it. - beegfsClientConf: - connUseRDMA: "false" - connNetFilter: - - 10.113.4.0/24 -fileSystemSpecificConfigs: - - sysMgmtdHost: 10.113.4.71 - config: - beegfsClientConf: - connDisableAuthentication: "true" - - sysMgmtdHost: 10.113.4.72 - config: - beegfsClientConf: - connMgmtdPortTCP: "9009" - connMgmtdPortUDP: "9009" diff --git a/test/env/beegfs-7.3-rh8/csi-beegfs-connauth.yaml b/test/env/beegfs-7.3-rh8/csi-beegfs-connauth.yaml deleted file mode 100644 index de89fade..00000000 --- a/test/env/beegfs-7.3-rh8/csi-beegfs-connauth.yaml +++ /dev/null @@ -1,10 +0,0 @@ -# Copyright 2021 NetApp, Inc. All Rights Reserved. -# Licensed under the Apache License, Version 2.0. - -# Use this file as instructed in the ConnAuth Configuration section of /docs/deployment.md. See -# /deploy/k8s/overlays/examples/csi-beegfs-connauth.yaml for an example of what to put in this file. Kustomize will -# automatically transform this file into a correct Secret readable by the deployed driver. If this file is left -# unmodified, the driver will deploy correctly with no custom configuration. - -- sysMgmtdHost: 10.113.4.72 - connAuth: secret1 diff --git a/test/env/beegfs-7.3-rh8/csi-beegfs-cr.yaml b/test/env/beegfs-7.3-rh8/csi-beegfs-cr.yaml deleted file mode 100644 index 26c15c34..00000000 --- a/test/env/beegfs-7.3-rh8/csi-beegfs-cr.yaml +++ /dev/null @@ -1,55 +0,0 @@ -# Copyright 2021 NetApp, Inc. All Rights Reserved. -# Licensed under the Apache License, Version 2.0. - -# In a typical deployment with the operator, an administrator would pre-create this secret or edit it after it was -# created. For testing purposes it is easiest to simply deploy it here. - -kind: Secret -apiVersion: v1 -metadata: - name: csi-beegfs-connauth -stringData: - csi-beegfs-connauth.yaml: | - - sysMgmtdHost: 10.113.4.72 - connAuth: secret1 - ---- - -kind: BeegfsDriver -apiVersion: beegfs.csi.netapp.com/v1 -metadata: - name: csi-beegfs-cr # CR must have this name. -spec: - containerImageOverrides: - # This block allows us to use sed to select the driver image tag the operator uses when deployed with Jenkins. We - # pass the tag this way (instead of building it into the operator binary) so the operator image Jenkins builds can - # remain clean (i.e. it can be retagged and pushed to Docker Hub). - beegfsCsiDriver: - image: docker.repo.eng.netapp.com/globalcicd/apheleia/beegfs-csi-driver - tag: replaced-by-jenkins - nodeAffinityControllerService: - preferredDuringSchedulingIgnoredDuringExecution: - - weight: 50 - preference: - matchExpressions: - - key: node-role.kubernetes.io/master - operator: Exists - pluginConfig: - config: - # Test file systems are intentionally misconfigured to first advertise an interface/address that is unreachable. - # This connNetFilter configuration overcomes that misconfiguration and speeds up mounting for test cases that - # don't make use of it. - beegfsClientConf: - connUseRDMA: "false" - connNetFilter: - - 10.113.4.0/24 - fileSystemSpecificConfigs: - - sysMgmtdHost: 10.113.4.71 - config: - beegfsClientConf: - connDisableAuthentication: "true" - - sysMgmtdHost: 10.113.4.72 - config: - beegfsClientConf: - connMgmtdPortTCP: "9009" - connMgmtdPortUDP: "9009" diff --git a/test/env/beegfs-ubuntu/beegfs-fs-1.yaml b/test/env/beegfs-ubuntu/beegfs-fs-1.yaml new file mode 100644 index 00000000..3469121c --- /dev/null +++ b/test/env/beegfs-ubuntu/beegfs-fs-1.yaml @@ -0,0 +1,90 @@ +kind: StatefulSet +apiVersion: apps/v1 +metadata: + name: beegfs-fs-1 +spec: + serviceName: "beegfs-fs-1" + replicas: 1 + selector: + matchLabels: + app: beegfs-fs-1 + template: + metadata: + annotations: + kubectl.kubernetes.io/default-container: beegfs + labels: + app: beegfs-fs-1 + spec: + hostNetwork: true # This is the easiest (but not necessarily the best) way for clients to access the file system. + containers: + - name: beegfs-mgmtd + image: beegfs/beegfs-mgmtd:${BEEGFS_VERSION} + args: + - storeMgmtdDirectory=/mnt/mgmt_tgt_mgmt01 + - storeAllowFirstRunInit=false + env: + - name: beegfs_setup_1 + value: beegfs-setup-mgmtd -p /mnt/mgmt_tgt_mgmt01 -C -S mgmt_tgt_mgmt01 + - name: CONN_AUTH_FILE_DATA + value: "${BEEGFS_SECRET}" + - name: beegfs-meta + image: beegfs/beegfs-meta:${BEEGFS_VERSION} + args: + - storeMetaDirectory=/mnt/meta_01_tgt_0101 + - storeAllowFirstRunInit=false + - sysMgmtdHost=localhost + env: + - name: beegfs_setup_1 + value: beegfs-setup-meta -C -p /mnt/meta_01_tgt_0101 -s 1 -S meta_01 + - name: CONN_AUTH_FILE_DATA + value: "${BEEGFS_SECRET}" + - name: beegfs-storage + image: beegfs/beegfs-storage:${BEEGFS_VERSION} + args: + - storeStorageDirectory=/mnt/stor_01_tgt_101,/mnt/stor_01_tgt_102 + - storeAllowFirstRunInit=false + - sysMgmtdHost=localhost + env: + - name: beegfs_setup_1 + value: beegfs-setup-storage -C -p /mnt/stor_01_tgt_101 -s 1 -S stor_01_tgt_101 -i 101 + - name: beegfs_setup_2 + value: beegfs-setup-storage -C -p /mnt/stor_01_tgt_102 -s 1 -S stor_01_tgt_101 -i 102 + - name: CONN_AUTH_FILE_DATA + value: "${BEEGFS_SECRET}" +--- +apiVersion: v1 +kind: Service +metadata: + name: beegfs-fs-1-svc +spec: + type: NodePort + selector: + app: beegfs-fs-1 + ports: + # Mgmt ports + - name: mgmt-tcp + protocol: TCP + port: 8008 + targetPort: 8008 + - name: mgmt-udp + protocol: UDP + port: 8008 + targetPort: 8008 + # Meta ports + - name: meta-tcp + protocol: TCP + port: 8005 + targetPort: 8005 + - name: meta-udp + protocol: UDP + port: 8005 + targetPort: 8005 + # Storage ports + - name: storage-tcp + protocol: TCP + port: 8003 + targetPort: 8003 + - name: storage-udp + protocol: UDP + port: 8003 + targetPort: 8003 diff --git a/test/env/beegfs-7.2-rh8/csi-beegfs-connauth.yaml b/test/env/beegfs-ubuntu/csi-beegfs-connauth.yaml similarity index 51% rename from test/env/beegfs-7.2-rh8/csi-beegfs-connauth.yaml rename to test/env/beegfs-ubuntu/csi-beegfs-connauth.yaml index b0c57e9b..a30f9a7d 100644 --- a/test/env/beegfs-7.2-rh8/csi-beegfs-connauth.yaml +++ b/test/env/beegfs-ubuntu/csi-beegfs-connauth.yaml @@ -1,10 +1,6 @@ -# Copyright 2021 NetApp, Inc. All Rights Reserved. -# Licensed under the Apache License, Version 2.0. - # Use this file as instructed in the ConnAuth Configuration section of /docs/deployment.md. See -# /deploy/k8s/overlays/examples/csi-beegfs-connauth.yaml for an example of what to put in this file. Kustomize will +# /deploy/k8s/examples/csi-beegfs-connauth.yaml for an example of what to put in this file. Kustomize will # automatically transform this file into a correct Secret readable by the deployed driver. If this file is left # unmodified, the driver will deploy correctly with no custom configuration. - -- sysMgmtdHost: 10.113.4.66 - connAuth: secret1 +- sysMgmtdHost: localhost + connAuth: ${BEEGFS_SECRET} diff --git a/test/env/beegfs-ubuntu/csi-beegfs-cr.yaml b/test/env/beegfs-ubuntu/csi-beegfs-cr.yaml new file mode 100644 index 00000000..4d0121e6 --- /dev/null +++ b/test/env/beegfs-ubuntu/csi-beegfs-cr.yaml @@ -0,0 +1,35 @@ +# Copyright 2021 NetApp, Inc. All Rights Reserved. +# Licensed under the Apache License, Version 2.0. + +# In a typical deployment with the operator, an administrator would pre-create this secret or edit it after it was +# created. For testing purposes it is easiest to simply deploy it here. + +kind: Secret +apiVersion: v1 +metadata: + name: csi-beegfs-connauth +stringData: + csi-beegfs-connauth.yaml: | + - sysMgmtdHost: "${BEEGFS_MGMTD}" + connAuth: "${BEEGFS_SECRET}" + +--- +kind: BeegfsDriver +apiVersion: beegfs.csi.netapp.com/v1 +metadata: + name: csi-beegfs-cr # CR must have this name. +spec: + containerImageOverrides: + beegfsCsiDriver: + image: "${CSI_IMAGE_NAME}" + tag: "${CSI_IMAGE_TAG}" + nodeAffinityControllerService: + preferredDuringSchedulingIgnoredDuringExecution: + - weight: 50 + preference: + matchExpressions: + - key: node-role.kubernetes.io/master + operator: Exists + pluginConfig: + # config: + # fileSystemSpecificConfigs: diff --git a/test/nomad/beegfs-7.3-rh8/docker/controller.nomad b/test/nomad/beegfs-7.3-rh8/docker/controller.nomad index 0450dfae..77b4afa5 100644 --- a/test/nomad/beegfs-7.3-rh8/docker/controller.nomad +++ b/test/nomad/beegfs-7.3-rh8/docker/controller.nomad @@ -81,7 +81,7 @@ job "beegfs-csi-plugin-controller" { # LIKELY TO REQUIRE MODIFICATION. # csi-beegfs-config.yaml is the primary means of configuring the BeeGFS CSI driver. See - # https://github.com/NetApp/beegfs-csi-driver/blob/master/docs/deployment.md#managing-beegfs-client-configuration + # https://github.com/ThinkParQ/beegfs-csi-driver/blob/master/docs/deployment.md#managing-beegfs-client-configuration # for details. # This stanza must be kept in sync with its partner in node.nomad. template { @@ -110,7 +110,7 @@ EOH # LIKELY TO REQUIRE MODIFICATION. # csi-beegfs-connauth.yaml container connauth information required by the BeeGFS client to mount secured file - # systems. See https://github.com/NetApp/beegfs-csi-driver/blob/master/docs/deployment.md#connauth-configuration + # systems. See https://github.com/ThinkParQ/beegfs-csi-driver/blob/master/docs/deployment.md#connauth-configuration # for details. # This stanza must be kept in sync with its partner in node.nomad. template { diff --git a/test/nomad/beegfs-7.3-rh8/docker/node.nomad b/test/nomad/beegfs-7.3-rh8/docker/node.nomad index f6fbea3c..5cfb6665 100644 --- a/test/nomad/beegfs-7.3-rh8/docker/node.nomad +++ b/test/nomad/beegfs-7.3-rh8/docker/node.nomad @@ -80,7 +80,7 @@ job "beegfs-csi-plugin-node" { # LIKELY TO REQUIRE MODIFICATION. # csi-beegfs-config.yaml is the primary means of configuring the BeeGFS CSI driver. See - # https://github.com/NetApp/beegfs-csi-driver/blob/master/docs/deployment.md#managing-beegfs-client-configuration + # https://github.com/ThinkParQ/beegfs-csi-driver/blob/master/docs/deployment.md#managing-beegfs-client-configuration # for details. # This stanza must be kept in sync with its partner in controller.nomad. template { @@ -109,7 +109,7 @@ EOH # LIKELY TO REQUIRE MODIFICATION. # csi-beegfs-connauth.yaml container connauth information required by the BeeGFS client to mount secured file - # systems. See https://github.com/NetApp/beegfs-csi-driver/blob/master/docs/deployment.md#connauth-configuration + # systems. See https://github.com/ThinkParQ/beegfs-csi-driver/blob/master/docs/deployment.md#connauth-configuration # for details. # This stanza must be kept in sync with its partner in controller.nomad. template { diff --git a/test/nomad/beegfs-7.3-rh8/podman/controller.nomad b/test/nomad/beegfs-7.3-rh8/podman/controller.nomad index f9d43aac..78e91692 100644 --- a/test/nomad/beegfs-7.3-rh8/podman/controller.nomad +++ b/test/nomad/beegfs-7.3-rh8/podman/controller.nomad @@ -66,7 +66,7 @@ job "beegfs-csi-plugin-controller" { # LIKELY TO REQUIRE MODIFICATION. # csi-beegfs-config.yaml is the primary means of configuring the BeeGFS CSI driver. See - # https://github.com/NetApp/beegfs-csi-driver/blob/master/docs/deployment.md#managing-beegfs-client-configuration + # https://github.com/ThinkParQ/beegfs-csi-driver/blob/master/docs/deployment.md#managing-beegfs-client-configuration # for details. # This stanza must be kept in sync with its partner in node.nomad. template { @@ -95,7 +95,7 @@ EOH # LIKELY TO REQUIRE MODIFICATION. # csi-beegfs-connauth.yaml container connauth information required by the BeeGFS client to mount secured file - # systems. See https://github.com/NetApp/beegfs-csi-driver/blob/master/docs/deployment.md#connauth-configuration + # systems. See https://github.com/ThinkParQ/beegfs-csi-driver/blob/master/docs/deployment.md#connauth-configuration # for details. # This stanza must be kept in sync with its partner in node.nomad. template { diff --git a/test/nomad/beegfs-7.3-rh8/podman/node.nomad b/test/nomad/beegfs-7.3-rh8/podman/node.nomad index ac859b0f..965bcff8 100644 --- a/test/nomad/beegfs-7.3-rh8/podman/node.nomad +++ b/test/nomad/beegfs-7.3-rh8/podman/node.nomad @@ -73,7 +73,7 @@ job "beegfs-csi-plugin-node" { # LIKELY TO REQUIRE MODIFICATION. # csi-beegfs-config.yaml is the primary means of configuring the BeeGFS CSI driver. See - # https://github.com/NetApp/beegfs-csi-driver/blob/master/docs/deployment.md#managing-beegfs-client-configuration + # https://github.com/ThinkParQ/beegfs-csi-driver/blob/master/docs/deployment.md#managing-beegfs-client-configuration # for details. # This stanza must be kept in sync with its partner in controller.nomad. template { @@ -102,7 +102,7 @@ EOH # LIKELY TO REQUIRE MODIFICATION. # csi-beegfs-connauth.yaml container connauth information required by the BeeGFS client to mount secured file - # systems. See https://github.com/NetApp/beegfs-csi-driver/blob/master/docs/deployment.md#connauth-configuration + # systems. See https://github.com/ThinkParQ/beegfs-csi-driver/blob/master/docs/deployment.md#connauth-configuration # for details. # This stanza must be kept in sync with its partner in controller.nomad. template { diff --git a/test/nomad/beegfs-7.3-rh8/volume.hcl b/test/nomad/beegfs-7.3-rh8/volume.hcl index f1c61ccb..62719c35 100644 --- a/test/nomad/beegfs-7.3-rh8/volume.hcl +++ b/test/nomad/beegfs-7.3-rh8/volume.hcl @@ -11,11 +11,11 @@ type = "csi" plugin_id = "beegfs-csi-plugin" # Passed by Nomad to the BeeGFS CSI driver, but ignored (see -# https://github.com/NetApp/beegfs-csi-driver/blob/master/docs/usage.md#capacity for details). +# https://github.com/ThinkParQ/beegfs-csi-driver/blob/master/docs/usage.md#capacity for details). capacity_min = "1MB" # Passed by Nomad to the BeeGFS CSI driver, but ignored (see -# https://github.com/NetApp/beegfs-csi-driver/blob/master/docs/usage.md#capacity for details). +# https://github.com/ThinkParQ/beegfs-csi-driver/blob/master/docs/usage.md#capacity for details). capacity_max = "1GB" # Any number of capabilities can be passed to the BeeGFS CSI driver by Nomad. @@ -30,7 +30,7 @@ capability { } # BeeGFS CSI driver-specific parameters passed by Nomad during volume creation. See -# https://github.com/NetApp/beegfs-csi-driver/blob/master/docs/usage.md#create-a-storage-class for allowed parameters. +# https://github.com/ThinkParQ/beegfs-csi-driver/blob/master/docs/usage.md#create-a-storage-class for allowed parameters. # sysMgmtdHost and volDirBasePath are required. parameters { # Change this to the IP address or FQDN of the BeeGFS management service for an accessible BeeGFS file system.