Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update contributions.md to include k3d as recommended cluster, add details on e2e test setup, and update kubectl install link. Fixes #1750 #1867

Merged
merged 3 commits into from
Apr 4, 2023
Merged

docs: update contributions.md to include k3d as recommended cluster, add details on e2e test setup, and update kubectl install link. Fixes #1750 #1867

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7579c3c
docs: add k3d as recommended cluster
danielhelfand Feb 17, 2022
16cf45c
docs: add details on setting up cluster for e2e tests
danielhelfand Feb 17, 2022
ee49139
docs: update kubectl install docs
danielhelfand Feb 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ Install:

* [docker](https://docs.docker.com/install/#supported-platforms)
* [golang](https://golang.org/)
* [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
* [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)
* [kustomize](https://github.com/kubernetes-sigs/kustomize/releases)
* [minikube](https://kubernetes.io/docs/setup/minikube/) or Docker for Desktop
* [k3d](https://k3d.io/) recommended

Kustomize is required for unit tests (`make test` is using it), so you [must install it](https://kubectl.docs.kubernetes.io/installation/kustomize/)
locally if you wish to make code contributions to Argo Rollouts.
Expand All @@ -33,7 +33,7 @@ go get -u github.com/golangci/golangci-lint/cmd/golangci-lint
Brew users can quickly install the lot:

```bash
brew install go kubectl kustomize golangci-lint protobuf swagger-codegen
brew install go kubectl kustomize golangci-lint protobuf swagger-codegen k3d
```

Set up environment variables (e.g. is `~/.bashrc`):
Expand Down Expand Up @@ -87,6 +87,15 @@ running. The rollout controller can be started with the command:
make start-e2e
```

Start and prepare your cluster for e2e tests:

```
k3d cluster create
kubectl create ns argo-rollouts
kubectl apply -k manifests/crds
kubectl apply -f test/e2e/crds
```

Then run the e2e tests:

```
Expand Down