-
Notifications
You must be signed in to change notification settings - Fork 778
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2079 from ConnorJC3/devx-improvements
Developer Experience Improvements
- Loading branch information
Showing
11 changed files
with
245 additions
and
162 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,46 +1,101 @@ | ||
| # Contributing guidelines | ||
| # Contributing Guidelines | ||
|
|
||
| ## Sign the CLA | ||
| ## Prerequisites | ||
|
|
||
| Kubernetes projects require that you sign a Contributor License Agreement (CLA) before we can accept your pull requests. Please see https://git.k8s.io/community/CLA.md for more info | ||
|
|
||
| ## Contributing A Patch | ||
| If you are new to CSI, please go through the [CSI Spec](https://github.com/container-storage-interface/spec/blob/master/spec.md) and [General CSI driver development guideline](https://kubernetes-csi.github.io/docs/developing.html) to get some basic understanding of CSI driver before you start. | ||
|
|
||
| 1. Submit an issue describing your proposed change to the repo in question. | ||
| 1. The [repo owners](OWNERS) will respond to your issue promptly. | ||
| ## Contributing a Patch | ||
|
|
||
| 1. (Optional, but recommended for large changes) Submit an issue describing your proposed change to the repo in question. | ||
| 1. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above). | ||
| 1. Fork the desired repo, develop and test your code changes. | ||
| 1. Submit a pull request. | ||
| 1. Fork the desired repo, develop and test your code changes (see "Development Quickstart Guide" below). | ||
| 1. When your changes are complete - including tests and documentation if necessary, [submit a pull request](https://github.com/kubernetes-sigs/aws-ebs-csi-driver/compare). | ||
| 1. Reviewer(s) from the [repo owners](OWNERS) will review your PR. Communicate with your reviewers and address their feedback as required. | ||
| 1. After merge, your change will typically be included in the next minor release of the EBS CSI Driver and associated Helm chart, which is performed monthly. | ||
|
|
||
| ## Development Quickstart Guide | ||
|
|
||
| This guide demonstrates the basic workflow for developing for the EBS CSI Driver. More detailed documentation of the available `make` targets is available in the [Makefile documentation](docs/makefile.md). | ||
|
|
||
| ### 1. Local development | ||
|
|
||
| If your changes are Helm-only, skip to section 2 (manual testing) below after making your changes. | ||
|
|
||
| Run `make` to build a driver binary, and thus discover compiler/syntax errors. | ||
|
|
||
| When your change is ready for testing, run `make test` to execute the unit test suite for the driver. If you are making a significant change to the driver (such as a bugfix or new feature), add new unit tests or update existing tests where applicable. | ||
|
|
||
| ### 2. Cluster setup | ||
|
|
||
| When your change is ready to test in a real Kubernetes cluster, create a `kops` cluster to test the driver against: | ||
| ```bash | ||
| make cluster/create | ||
| ``` | ||
|
|
||
| If your change affects the Windows implementation of the driver, instead create an `eksctl` cluster with Windows nodes: | ||
| ```bash | ||
| export WINDOWS="true" | ||
| # Note: CLUSTER_TYPE must be set for all e2e tests and cluster deletion | ||
| # Re-export it if necessary (for example, if running tests in a separate terminal tab) | ||
| export CLUSTER_TYPE="eksctl" | ||
| make cluster/create | ||
| ``` | ||
|
|
||
| Export the `KUBECONFIG` environment variable to access the cluster for manual testing: | ||
| ```bash | ||
| eval "$(make cluster/kubeconfig)" | ||
| ``` | ||
|
|
||
| To test a change, build the driver image and then install it: | ||
| ```bash | ||
| make cluster/image | ||
| # If testing a Helm-based change, you can use HELM_EXTRA_FLAGS | ||
| # to set your new paremeters for testing, for example: | ||
| # export HELM_EXTRA_FLAGS="--set=controller.newParameter=true" | ||
| make cluster/install | ||
| ``` | ||
|
|
||
| When you are finished manually testing, uninstall the driver: | ||
| ```bash | ||
| make cluster/uninstall | ||
| ``` | ||
|
|
||
| ### 3. Automated E2E tests | ||
|
|
||
| Before running any E2E tests, you must create a cluster (see step 2) and build an image if you have not already done so: | ||
| ```bash | ||
| make cluster/image | ||
| ``` | ||
|
|
||
| ## Development | ||
| Please go through [CSI Spec](https://github.com/container-storage-interface/spec/blob/master/spec.md) and [General CSI driver development guideline](https://kubernetes-csi.github.io/docs/developing.html) to get some basic understanding of CSI driver before you start. | ||
| The driver should not be preinstalled when running E2E tests (the tests will automatically install the driver). If it is, uninstall it first: | ||
| ```bash | ||
| make cluster/uninstall | ||
| ``` | ||
|
|
||
| ### Requirements | ||
| * Golang 1.15.+ | ||
| * [Ginkgo](https://github.com/onsi/ginkgo) in your PATH for integration testing and end-to-end testing | ||
| * Docker 17.05+ for releasing | ||
| If you are making a change to the driver, the recommended test suite to run is the external tests: | ||
| ```bash | ||
| # Normal external tests (excluding Windows tests) | ||
| make e2e/external | ||
| # Additionally, run the windows tests if changing Windows behavior | ||
| make e2e/external-windows | ||
| ``` | ||
|
|
||
| ### Dependency | ||
| Dependencies are managed through go module. To build the project simply type: `make` | ||
| If you are making a change to the Helm chart, the recommended test suite to run is the Helm `ct` tests: | ||
| ```bash | ||
| make e2e/helm-ct | ||
| ``` | ||
|
|
||
| ### Testing | ||
| * To execute all unit tests, run: `make test` | ||
| * To execute sanity test run: `make test-sanity` | ||
| * To execute integration tests, run: `make test-integration` | ||
| * To execute e2e tests, run: `make test-e2e-single-az` and `make test-e2e-multi-az` | ||
| After finishing testing, cleanup your cluster : | ||
| ```bash | ||
| make cluster/delete | ||
| ``` | ||
|
|
||
| ### Release Process | ||
| Please see [Release Process](./docs/release.md). | ||
| ### 4. Before submitting a PR | ||
|
|
||
| **Notes**: | ||
| * Sanity tests make sure the driver complies with the CSI specification | ||
| * EC2 instance is required to run integration test, since it is exercising the actual flow of creating EBS volume, attaching it and read/write on the disk. See [Integration Testing](./tests/integration/README.md) for more details. | ||
| * E2E tests exercises various driver functionalities in Kubernetes cluster. See [E2E Testing](./tests/e2e/README.md) for more details. | ||
| Run `make update` to automatically format go source files and re-generate automatically generated files. If `make update` produces any changes, commit them before submitting a PR. | ||
|
|
||
| ### Helm and manifests | ||
| The Helm chart for this project is in the `charts/aws-ebs-csi-driver` directory. The manifests for this project are in the `deploy/kubernetes` directory. All of the manifests except kustomize patches are generated by running `helm template`. This keeps the Helm chart and the manifests in sync. | ||
| Run `make verify` to run linters and other similar code checking tools. Fix any issues `make verify` discovers before submitting a PR. | ||
|
|
||
| When updating the Helm chart: | ||
| * Generate manifests: `make generate-kustomize` | ||
| * There are values files in `deploy/kubernetes/values` used for generating some of the manifests | ||
| * When adding a new resource template to the Helm chart please update the `generate-kustomize` make target, the `deploy/kubernetes/values` files, and the appropriate kustomization.yaml file(s). | ||
| Your PR should contain a full set of unit/E2E tests when applicable. If introducing a change that is not exercised fully by automated testing (such as a new Helm parameter), please provide evidence of the feature working as intended in the PR description. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| #!/bin/bash | ||
|
|
||
| # Copyright 2024 The Kubernetes Authors. | ||
| # | ||
| # 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. | ||
|
|
||
| # This script deletes a cluster that was created by `create-cluster.sh` | ||
| # CLUSTER_NAME and CLUSTER_TYPE are expected to be specified by the caller | ||
| # All other environment variables have default values (see config.sh) but | ||
| # many can be overridden on demand if needed | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| BASE_DIR="$(dirname "$(realpath "${BASH_SOURCE[0]}")")" | ||
| BIN="${BASE_DIR}/../../bin" | ||
|
|
||
| source "${BASE_DIR}/config.sh" | ||
| source "${BASE_DIR}/util.sh" | ||
|
|
||
| if [ -z "${HELM_VALUES_FILE:-}" ]; then | ||
| if [[ "${CLUSTER_TYPE}" == "kops" ]]; then | ||
| HELM_VALUES_FILE="${BASE_DIR}/kops/values.yaml" | ||
| elif [[ "${CLUSTER_TYPE}" == "eksctl" ]]; then | ||
| HELM_VALUES_FILE="${BASE_DIR}/eksctl/values.yaml" | ||
| else | ||
| echo "Cluster type ${CLUSTER_TYPE} is invalid, must be kops or eksctl" >&2 | ||
| exit 1 | ||
| fi | ||
| fi | ||
|
|
||
| loudecho "Installing driver via ${DEPLOY_METHOD}" | ||
| install_driver | ||
| loudecho "Sucessfully installed driver via ${DEPLOY_METHOD}" |
Oops, something went wrong.