Skip to content

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

Merged
merged 4 commits into from
Aug 15, 2018

Conversation

AlexNPavel
Copy link
Contributor

Resolves #406

```

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>`.
Copy link
Contributor

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


### 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,
Copy link
Contributor

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

```

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
Copy link
Contributor

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

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
Copy link
Contributor

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.

@hasbro17
Copy link
Contributor

LGTM after nits

@AlexNPavel AlexNPavel merged commit a1c1181 into operator-framework:master Aug 15, 2018
@AlexNPavel AlexNPavel deleted the doc-testing branch August 15, 2018 17:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants