mirror of
https://github.com/kata-containers/kata-containers.git
synced 2025-05-10 17:37:37 +00:00
Removed all TOCs now that GitHub auto-generates them. Also updated the documentation requirements doc removing the requirement to add a TOC. Fixes: #2022. Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
30 lines
1009 B
Markdown
30 lines
1009 B
Markdown
## Run the osbuilder tests
|
|
|
|
osbuilder provides a test script that creates all rootfs disk images and
|
|
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. 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
|
|
```
|
|
|
|
## Further information
|
|
|
|
The test script provides various options to modify the way it runs. For full
|
|
details:
|
|
|
|
```
|
|
$ ./test_images.sh -h
|
|
```
|