-
Notifications
You must be signed in to change notification settings - Fork 1.8k
doc/testing/end-to-end.md: add end-to-end.md doc #408
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.
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
Conversation
doc/testing/end-to-end.md
Outdated
``` | ||
|
||
This will run the tests on the cluster specified by the provided kubeconfig and the | ||
memcached-operator image that it build will be pushed to `<repository>:<tag>`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
that it build
==> that is built
doc/testing/end-to-end.md
Outdated
|
||
### Local Minikube Instance | ||
To run the end-to-end tests on a local minikube cluster, the minikube instance must be | ||
started and its local docker repo must be linked to the host's docker repo. To do this, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
its local docker repo must be linked to the host's docker repo
I think the more clear phrasing here would be to reuse minikube's docker daemon so it can use the local image registry on your machine
. Or something to that effect.
https://kubernetes.io/docs/setup/minikube/#reusing-the-docker-daemon
doc/testing/end-to-end.md
Outdated
``` | ||
|
||
The test will run using the kube config in $HOME/.kube/config (which is where the minikube | ||
kubeconfig is placed by default) and the operator image will be built to directly to the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change
image will be built to directly to the minikube instance's local docker repo
to
image will be built and stored on minikube's local image registry
doc/testing/end-to-end.md
Outdated
minikube instance's local docker repo. | ||
|
||
## Cleanup of the E2E Tests | ||
The end-to-end tests create a new project using the operator-sdk to run in the provided |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor nit but you can replace end-to-end
with e2e
here and throughout the rest of the doc. That acronym is usually clear enough.
LGTM after nits |
8e35c85
to
fadcf4c
Compare
Resolves #406