mirror of
https://github.com/kata-containers/kata-containers.git
synced 2025-10-22 04:18:53 +00:00
11c3d81f68
- Removes `CODE_OF_CONDUCT.md` and `CONTRIBUTING.md` from osbuilder directory. - Fixes a reference from `image-builder/README.md` to `rootfs-builder/README.md` - Updates the main `README.md` making a reference to the local `tools/osbuilder/README.md` Signed-off-by: Salvador Fuentes <salvador.fuentes@intel.com>
30 lines
785 B
Markdown
30 lines
785 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](/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
|
|
```
|