Skip to content

Commit 23904fb

Browse files
authored
Merge pull request #1882 from horis233/update-developemnet-docs
add e2e environment information into DEVELOPMENT.md
2 parents 1c56cbb + e5912b7 commit 23904fb

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

DEVELOPMENT.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,16 @@
1111
[Docker for Mac]: https://store.docker.com/editions/community/docker-ce-desktop-mac
1212
[kubebuilder docs]: https://book.kubebuilder.io/quick-start.html#installation
1313

14+
#### E2E test environments
15+
16+
| Requirement | install docs |
17+
|-------------|----------------------|
18+
| Minikube | [Minikube docs] |
19+
| Kind | [Kind docs] |
20+
21+
[Minikube docs]: https://minikube.sigs.k8s.io/docs/start
22+
[Kind docs]: https://kind.sigs.k8s.io/docs/user/quick-start
23+
1424
### Usage
1525

1626
#### Testing
@@ -28,6 +38,8 @@ To run the e2e tests locally:
2838
$ make e2e-local
2939
```
3040

41+
**NOTE:** Command `make e2e-local` supports Minikube and Kind environments. If you want to run the e2e tests on Minikube, you need to make sure Minikube is deployed in the local environment. If you want to run the e2e tests on Kind, you need to make sure Kind is deployed in the local environment and switch the kubeconfig to an existing Kind cluster.
42+
3143
To run a specific e2e test locally:
3244

3345
```sh

test/e2e/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ This runs a series of tests against the Kubernetes API to verify that OLM is fun
99

1010
## How to use
1111

12-
`make e2e-local` in the root of the repository will fetch golang dependencies, start Minikube, build the appropriate images and run the tests in a fresh namespace each time.
12+
`make e2e-local` in the root of the repository will fetch golang dependencies, start Minikube or using an existing Kind environment, build the appropriate images and run the tests in a fresh namespace each time.
1313

1414
Subsequent runs of the test suite do not need to go through the full setup process. Running individual tests (or the whole suite) can be accomplished by running `./test/e2e/run_e2e_local.sh [TestName]` with an optional test name.

0 commit comments

Comments
 (0)