From d4006d8ddd77a1a78fa6854cab0ca122c0e5f448 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Tue, 15 May 2018 15:33:58 +0100 Subject: [PATCH 1/3] docs: Make dev guide warning clearer Add some extra words to make the warning about the dev guide audience clearer. Signed-off-by: James O. D. Hunt --- Developer-Guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Developer-Guide.md b/Developer-Guide.md index 4bd36f28f4..da4dfb641c 100644 --- a/Developer-Guide.md +++ b/Developer-Guide.md @@ -27,7 +27,7 @@ # Warning -This document is written **specifically for developers**. +This document is written **specifically for developers**: it is not intended for end users. # Assumptions From 244e50e3e4d36cca626241248b14fa440a8fa061 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Tue, 15 May 2018 15:34:32 +0100 Subject: [PATCH 2/3] docs: Update dev guide for OBS packages Add details of how to install the packaged components to start off with a working system. This involved splitting out part of the "Assumptions" section into a new "Initial setup" section. Fixes #80. Signed-off-by: James O. D. Hunt --- Developer-Guide.md | 30 +++++++++++++++++++++--------- 1 file changed, 21 insertions(+), 9 deletions(-) diff --git a/Developer-Guide.md b/Developer-Guide.md index da4dfb641c..bd69cb7f1a 100644 --- a/Developer-Guide.md +++ b/Developer-Guide.md @@ -1,5 +1,7 @@ * [Warning](#warning) * [Assumptions](#assumptions) +* [Initial setup](#initial-setup) +* [Requirements to build individual components](#requirements-to-build-individual-components) * [Build and install the Kata Containers runtime](#build-and-install-the-kata-containers-runtime) * [Check hardware requirements](#check-hardware-requirements) * [Configure to use initrd or rootfs image](#configure-to-use-initrd-or-rootfs-image) @@ -32,17 +34,27 @@ This document is written **specifically for developers**: it is not intended for # Assumptions - You are working on a non-critical test or development system. -- You already have the following installed: - - [Docker](https://www.docker.com/). - - [golang](https://golang.org/dl) version 1.8.3 or newer. - - `make`. - - `gcc` (required for building the shim and runtime). -- You have installed the `qemu-lite` package containing the hypervisor. This package - is automatically installed when you install Clear Containers, but can be - installed separately as well: +# Initial setup - https://github.com/clearcontainers/runtime/wiki/Installation +The recommended way to create a development environment is to first install the +packaged versions of the Kata Containers components to create a working +system: + + * [Fedora\*](install/fedora-installation-guide.md) + * [Ubuntu\*](install/ubuntu-installation-guide.md) + +The installation guide instructions will install all required Kata Containers +components, plus Docker*, the hypervisor, and the Kata Containers image and +guest kernel. + +# Requirements to build individual components + +You need to install the following to build Kata Containers components: + +- [golang](https://golang.org/dl) version 1.8.3 or newer. +- `make`. +- `gcc` (required for building the shim and runtime). # Build and install the Kata Containers runtime From 3347bd769c879bf3e96ca7ab01969ca05e507640 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Thu, 17 May 2018 14:05:32 +0100 Subject: [PATCH 3/3] docs: Mention versions database for golang in dev guide Provide a pointer to the versions database to allow developers to see the range of golang versions known to work. Signed-off-by: James O. D. Hunt --- Developer-Guide.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Developer-Guide.md b/Developer-Guide.md index bd69cb7f1a..d16d58639f 100644 --- a/Developer-Guide.md +++ b/Developer-Guide.md @@ -53,6 +53,10 @@ guest kernel. You need to install the following to build Kata Containers components: - [golang](https://golang.org/dl) version 1.8.3 or newer. + + To view the versions of go known to work, see the `golang` entry in the + [versions database](https://github.com/kata-containers/runtime/blob/master/versions.yaml). + - `make`. - `gcc` (required for building the shim and runtime).