mirror of
https://github.com/kata-containers/kata-containers.git
synced 2025-08-15 06:34:03 +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>
27 lines
680 B
Markdown
27 lines
680 B
Markdown
# Kata Containers image generation
|
|
|
|
A Kata Containers disk image is generated using the `image_builder.sh` script.
|
|
This uses a rootfs directory created by the `rootfs-builder/rootfs.sh` script.
|
|
|
|
## Creating a guest OS image
|
|
|
|
To create a guest OS image run:
|
|
|
|
```
|
|
$ sudo ./image_builder.sh path/to/rootfs
|
|
```
|
|
|
|
Where `path/to/rootfs` is the directory populated by `rootfs.sh`.
|
|
|
|
> **Note**: If you are building an image from an Alpine rootfs, see
|
|
> the important note [here](/tools/osbuilder/rootfs-builder/README.md#rootfs-requirements).
|
|
|
|
## Further information
|
|
|
|
For more information about usage (including how to adjust the size of the
|
|
image), run:
|
|
|
|
```
|
|
$ ./image_builder.sh -h
|
|
```
|