Files
kata-containers/image-builder/README.md
Yonatan Gefen 06437bb51e docs: Fix link in README
Correct rootfs builder link in the image builder README.

Fixes #185.

Signed-off-by: Yonatan Gefen <yoni.gefen@gmail.com>
2018-10-24 13:52:00 -04:00

30 lines
769 B
Markdown

* [Creating a guest OS image](#creating-a-guest-os-image)
* [Further information](#further-information)
# 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](/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
```