github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-06-28 08:17:37 +00:00
Code Issues Projects Releases Wiki Activity

docs: Fix a few details in developer documentation

Browse Source 
A few assumption were made, making the steps not working directly on
a clean system.

Fixes #134

Signed-off-by: Sebastien Boeuf <sebastien.boeuf@intel.com>
This commit is contained in:
Sebastien Boeuf 2018-06-01 10:46:33 -07:00
parent 1b7a9e3dca
commit e77389dfb9
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Developer-Guide.md
View File

@ -21,8 +21,9 @@
* [Build an initrd image](#build-an-initrd-image) * [Build an initrd image](#build-an-initrd-image)
* [Install the initrd image](#install-the-initrd-image) * [Install the initrd image](#install-the-initrd-image)
* [Install guest kernel images](#install-guest-kernel-images) * [Install guest kernel images](#install-guest-kernel-images)
* [Run Kata Containers with Docker](#run-kata-containers-with-docker)
* [Update Docker configuration](#update-docker-configuration) * [Update Docker configuration](#update-docker-configuration)
* [Create a Kata Container](#create-a-kata-container) * [Create a container using Kata](#create-a-container-using-kata)
* [Troubleshoot Kata Containers](#troubleshoot-kata-containers) * [Troubleshoot Kata Containers](#troubleshoot-kata-containers)
* [Appendices](#appendices) * [Appendices](#appendices)
* [Checking Docker default runtime](#checking-docker-default-runtime) * [Checking Docker default runtime](#checking-docker-default-runtime)
@ -157,6 +158,11 @@ $ go get -d -u github.com/kata-containers/osbuilder
## Create a rootfs image ## Create a rootfs image
### Create a local rootfs ### Create a local rootfs
As a prerequisite, you need to install Docker. Otherwise, you will not be
able to run the `rootfs.sh` script with `USE_DOCKER=true` as expected in
the following example.
``` ```
$ export ROOTFS_DIR=${GOPATH}/src/github.com/kata-containers/osbuilder/rootfs-builder/rootfs $ export ROOTFS_DIR=${GOPATH}/src/github.com/kata-containers/osbuilder/rootfs-builder/rootfs
$ sudo rm -rf ${ROOTFS_DIR} $ sudo rm -rf ${ROOTFS_DIR}
@ -247,6 +253,9 @@ $ (cd /usr/share/kata-containers && sudo ln -sf "$image" kata-containers-initrd.
# Install guest kernel images # Install guest kernel images
As a prerequisite, you need to install `libelf-dev` and `bc`. Otherwise, you
will not be able to build the kernel from sources.
``` ```
$ kernel_arch="$(arch)" $ kernel_arch="$(arch)"
$ tmpdir="$(mktemp -d)" $ tmpdir="$(mktemp -d)"
@ -273,7 +282,9 @@ $ popd
$ rm -rf "${tmpdir}" $ rm -rf "${tmpdir}"
``` ```
# Update Docker configuration # Run Kata Containers with Docker
## Update Docker configuration
``` ```
$ dir=/etc/systemd/system/docker.service.d $ dir=/etc/systemd/system/docker.service.d
@ -285,7 +296,7 @@ $ sudo systemctl daemon-reload
$ sudo systemctl restart docker $ sudo systemctl restart docker
``` ```
# Create a Kata Container ## Create a container using Kata
``` ```
$ sudo docker run -ti --runtime kata-runtime busybox sh $ sudo docker run -ti --runtime kata-runtime busybox sh