kata-containers/tools/osbuilder/initrd-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

23 lines
536 B
Markdown

# Kata Containers initrd image generation
A Kata Containers initrd image is generated using the `initrd_builder.sh` script.
This script uses a rootfs directory created by the `rootfs-builder/rootfs.sh` script.
## Creating a guest OS initrd image
To create a guest OS initrd image run:
```
$ sudo ./initrd_builder.sh path/to/rootfs
```
The `rootfs.sh` script populates the `path/to/rootfs` directory.
## Further information
For more information on how to use the `initrd_builder.sh` script, run:
```
$ ./initrd_builder.sh -h
```