image: Add README

Add readme do document how to use ./image-builder/image_builder.sh

Signed-off-by: Jose Carlos Venegas Munoz <jose.carlos.venegas.munoz@intel.com>
This commit is contained in:
Jose Carlos Venegas Munoz 2017-11-27 22:31:15 -06:00
parent 52d6b044b7
commit d9fe322a5f

25
image-builder/README.md Normal file
View File

@ -0,0 +1,25 @@
# Kata Containers image generation #
A Kata Containers image is generated by the script `image_builder.sh`
which uses a `rootfs` directory created by the script
`rootfs-builder/rootfs.sh`.
To create a guest OS image run:
```
$ ./image_builder.sh path/to/rootfs
```
Where `path/to/rootfs` is the directory pupulated by `rootfs.sh`. The
script will check for following required binaries:
- `/sbin/init` : The image must contain a `init` binary
- `/bin/kata-agent` : The image contain the Kata [agent]
More information about usage:
```
$ ./image_builder.sh -h
```
[agent]: https://github.com/kata-containers/agent "Kata agent"