Update Docs With Incluster Testing Support#526
Merged
Conversation
openshift-ci-robot
added
the
size/L
hasbro17
reviewed
Sep 25, 2018
|
|
||
| The operator-sdk build command compiles the code, builds the executables, | ||
| and generates Kubernetes manifests. After build completes, the image would be built locally in docker. Then it needs to be pushed to remote registry. | ||
| The operator-sdk build command compiles the code and builds the executables. After build completes, the image is built locally in docker. Then it needs to be pushed to remote registry. |
Contributor
There was a problem hiding this comment.
pushed to a remote registry
hasbro17
reviewed
Sep 25, 2018
| and generates Kubernetes manifests. After build completes, the image would be built locally in docker. Then it needs to be pushed to remote registry. | ||
| The operator-sdk build command compiles the code and builds the executables. After build completes, the image is built locally in docker. Then it needs to be pushed to remote registry. | ||
|
|
||
| If `--enable-tests` is set, the buld command will also build the testing binary and add it to the docker image. |
AlexNPavel
changed the title
openshift-ci-robot
added
the
do-not-merge/work-in-progress
hasbro17
reviewed
Sep 25, 2018
| ##### Flags | ||
| * `-k, --kubeconfig` string - location of kubeconfig for kubernetes cluster | ||
| * `-g, --global-init` string - location of global resource manifest yaml file | ||
| * `-n, --namespaced-init` string - location of namespaced resource manifest yaml file |
Contributor
There was a problem hiding this comment.
We need to revise the flags a bit to make them consistent.
Let's get rid of short flags to avoid naming collisions.
And change:
namespaced-inittonamespaced-manifestglobal-inittoglobal-manifest- Keep
--namespaceas the flag for running the tests in a single namespace
AlexNPavel
force-pushed
the
incluster-docs
branch
from
30ae025 to
c435bae
Compare
Contributor
Author
|
Rebased due to weird travis config issues |
Contributor
Author
|
PR for flags: #528 |
AlexNPavel
force-pushed
the
incluster-docs
branch
from
a83b8a0 to
c435bae
Compare
AlexNPavel
force-pushed
the
incluster-docs
branch
from
c435bae to
2218b72
Compare
AlexNPavel
changed the title
openshift-ci-robot
removed
the
do-not-merge/work-in-progress
Contributor
Author
|
/cc @hasbro17 @fanminshi |
hasbro17
reviewed
Sep 25, 2018
| * `--kubeconfig` string - location of kubeconfig for kubernetes cluster | ||
| * `--image-pull-policy` string - set test pod image pull policy. Allowed values: Always, Never (default "Always") | ||
| * `--namespace` string - namespace to run tests in (default "default") | ||
| * `--pending-timeout` int - timeout for testing pod in pending state (default 60) |
Contributor
There was a problem hiding this comment.
timeout in seconds for the testing pod to stay in pending state (default 60s)
hasbro17
reviewed
Sep 25, 2018
| ok github.com/operator-framework/operator-sdk-samples/memcached-operator/test/e2e 20.410s | ||
| ``` | ||
|
|
||
| #### cluster - Runs the tests within a cluster |
Contributor
There was a problem hiding this comment.
cluster
Runs the e2e tests packaged in an operator image as a pod in the cluster
Args
<image>the operator image that is used to run the tests in a pod
hasbro17
reviewed
Sep 25, 2018
| * `-n, --namespaced-init` string - location of namespaced resource manifest yaml file | ||
| * `-f, --go-test-flags` string - extra arguments to pass to `go test` (e.g. -f "-v -parallel=2") | ||
| * `-h, --help` - help for test | ||
| #### local - Runs the tests locally |
Contributor
There was a problem hiding this comment.
Args
<test-location>location of e2e test files e.g "./test/e2e"
hasbro17
reviewed
Sep 25, 2018
| ##### Flags | ||
| * `--kubeconfig` string - location of kubeconfig for kubernetes cluster | ||
| * `--global-manifest` string - location of global resource manifest yaml file | ||
| * `--namespaced-manifest` string - location of namespaced resource manifest yaml file |
Contributor
There was a problem hiding this comment.
Let's clearly specify the defaults for all these flags here. Especially the --namespaced-manifest flag which combines the expected files deploy/sa.yaml,deploy/rbac.yaml and deploy/operator.yaml.
hasbro17
reviewed
Sep 25, 2018
| and generates Kubernetes manifests. After build completes, the image would be built locally in docker. Then it needs to be pushed to remote registry. | ||
| The operator-sdk build command compiles the code and builds the executables. After build completes, the image is built locally in docker. Then it needs to be pushed to a remote registry. | ||
|
|
||
| If `--enable-tests` is set, the build command will also build the testing binary and add it to the docker image. |
Contributor
There was a problem hiding this comment.
Mention that this also creates an example deploy/test-pod.yaml that you can use to run the image as a test-pod.
AlexNPavel
force-pushed
the
incluster-docs
branch
from
a3bda38 to
4d0c2e2
Compare
hasbro17
reviewed
Sep 25, 2018
| Test Successfully Completed | ||
| ``` | ||
|
|
||
| If the tests fail, the command will output the errors in the standard `go test` loggin/error format. |
Contributor
There was a problem hiding this comment.
How about a little clarification on how the command actually runs the test. So its clear how this is different from test local. e.g:
The test command will deploy a test pod in the given namespace that will run the e2e tests packaged in the image.
The command will wait until the tests succeed(pod phase=Succeeded ) or fail(pod phase=Failed ).
If the tests fail, the command will output the test pod logs which should be the standard go test error logs.
Contributor
|
LGTM after nit. |
johnkim76
pushed a commit
to johnkim76/operator-sdk
that referenced
this pull request
Sep 27, 2018
* doc/test-framework: update test framework walkthrough * doc/sdk-cli-reference.md: update for incluster testing support
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updates docs to match changes made in #469