From d9fe322a5f211bb86ff29d99e81989e37e69f1d0 Mon Sep 17 00:00:00 2001 From: Jose Carlos Venegas Munoz Date: Mon, 27 Nov 2017 22:31:15 -0600 Subject: [PATCH] image: Add README Add readme do document how to use ./image-builder/image_builder.sh Signed-off-by: Jose Carlos Venegas Munoz --- image-builder/README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 image-builder/README.md diff --git a/image-builder/README.md b/image-builder/README.md new file mode 100644 index 0000000000..929681970c --- /dev/null +++ b/image-builder/README.md @@ -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"