kata-containers/tools/osbuilder/image-builder/README.md
James O. D. Hunt 4f0726bc49 docs: Remove table of contents
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>
2021-07-30 10:58:22 +01:00

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
```