tests: Document the changed KATA_DEV_MODE behavior

Document the KATA_DEV_MODE changes explained in the previous commits

Signed-off-by: Cole Robinson <crobinso@redhat.com>
This commit is contained in:
Cole Robinson 2020-03-02 14:35:08 -05:00
parent 0f4eac434b
commit 134175bb9b

View File

@ -8,9 +8,15 @@ initrd images for all supported distributions and then tests them to ensure a
Kata Container can be created with each.
Before the build phase, the test script installs the Docker container manager
and all the Kata components required to run test containers. This step can be
skipped by setting the environment variable `KATA_DEV_MODE` to a non-empty
value.
and all the Kata components required to run test containers. Individual tests
will also alter host `kata-runtime` and `docker` service configuration as needed.
All host config editing can be skipped by setting the environment variable
`KATA_DEV_MODE` to a non-empty value. In this mode, image/initrd targets
will be built but not runtime tested; If your host is configured to have
`kata-runtime` set as the default docker runtime, you will need to switch
to a runtime like `runc`/`crun` so the `docker build` test commands work
correctly.
```
$ ./test_images.sh