docs: Add developer guide #30

jodh-intel · 2018-03-20T16:59:59Z

Move the developer guide from the wiki "in-tree".

Fixes #29.

Signed-off-by: James O. D. Hunt james.o.hunt@intel.com

jodh-intel · 2018-03-20T17:01:00Z

@annabellebertooch - fyi 😄

egernst · 2018-03-20T17:01:01Z

I think it looks good, though we'll want review from @klynnrif

jodh-intel · 2018-03-20T17:01:29Z

Hi @klynnrif - could you take a look please? It's a biggie I'm afraid :)

egernst · 2018-03-20T17:05:56Z

Developer-Guide.md

+  - `make`.
+  - `gcc` (required for building the shim and runtime).
+
+- You have installed the Clear Containers `linux-container` and `qemu-lite`


This part is a bit more error prone since we're referring to another install guide, but only a segment of it. This is definitely a short term problem (ie, until we have packages available for these for Kata project), but I think it may be worth explicitly adding these in the meantime. WDYT, @jodh-intel ?

Yep - we really need kata-containers/packaging#1 to be resolved.

I understand the general view but I'm not clear what you want me to add?

I'd consider adding the steps for installing qemu-lite and linux-containers.

I actually left it purposely slightly vague since otherwise we need to be fully prescriptive (apt-get, dnf, yum, etc).

Once we have kata packages we can then start putting together install guides for the different distros as we did for Clear Containers.

FWIW, the same applies to installing docker, golang, etc.

Hi @egernst - How about we keep this as-is for now since:

it's what we already have in the wiki.

it's temporary: we'll replace the vagueness with pointers to install guides once bootstrap repo by importing Clear Containers packaging scripts packaging#1 is resolved?

Works for me.

annebdh · 2018-03-20T17:59:07Z

LGTM. Thanks for moving this over!

klynnrif

Scrubbed for grammar, sentence structure, and flow : a few suggestions. Thanks!

klynnrif · 2018-03-20T21:52:27Z

Developer-Guide.md

+* [Install guest kernel images](#install-guest-kernel-images)
+* [Update Docker configuration](#update-docker-configuration)
+* [Create a Kata Container](#create-a-kata-container)
+* [Problem determination](#problem-determination)


I suggest titling this section "Troubleshoot" to keep the list parallel.

klynnrif · 2018-03-20T21:58:13Z

Developer-Guide.md

+
+- You have installed the Clear Containers `linux-container` and `qemu-lite`
+  packages containing the guest kernel images and hypervisor. These packages
+  are automatically installed when you install Clear Containers, but can be


Suggested rewrite to make this sentence active: "These packages automatically install when you install Clear Containers, but can be installed separately:"

klynnrif · 2018-03-20T21:58:40Z

Developer-Guide.md

+$ make && sudo -E PATH=$PATH make install
+```
+
+The build will create:


The build will create the following:

klynnrif · 2018-03-20T21:59:58Z

Developer-Guide.md

+
+# Check hardware requirements
+
+You can now check if your system is capable of creating a Kata Container by running:


You can check if your system is capable of creating a Kata Container by running the following:

klynnrif · 2018-03-20T22:00:43Z

Developer-Guide.md

+$ sudo kata-runtime kata-check
+```
+
+If your system is *not* able to run Kata Containers, this command will error and explain why.


If your system is not able to run Kata Containers, the previous command will error and explain why.

klynnrif · 2018-03-20T22:06:18Z

Developer-Guide.md

+
+> **Note:**
+> 
+> - You must ensure that the *default Docker runtime* is `runc` to make use of the `USE_DOCKER` variable. If that is not the case, simply remove the variable from the command above. See [Checking Docker default runtime](#checking-docker-default-runtime).


...If that is not the case, remove the variable from the previous command...

klynnrif · 2018-03-20T22:06:47Z

Developer-Guide.md

+
+> **Note:**
+>
+> - You only do this step if you wish to test with the latest version of the agent.


You only do this step if you test with the latest version of the agent.

klynnrif · 2018-03-20T22:07:16Z

Developer-Guide.md

+
+> **Notes:**
+> 
+> - You must ensure that the *default Docker runtime* is `runc` to make use of the `USE_DOCKER` variable. If that is not the case, simply remove the variable from the command above. See [Checking Docker default runtime](#checking-docker-default-runtime).


...If that is not the case, remove the variable from the previous command...

klynnrif · 2018-03-20T22:08:52Z

Developer-Guide.md

+> **Notes:**
+> 
+> - You must ensure that the *default Docker runtime* is `runc` to make use of the `USE_DOCKER` variable. If that is not the case, simply remove the variable from the command above. See [Checking Docker default runtime](#checking-docker-default-runtime).
+> - If you do *not* wish to build under Docker, remove the `USE_DOCKER` variable above and ensure the `qemu-img` command is available on your system.


If you do not wish to build under Docker, remove the USE_DOCKER variable in the previous command and ensure the qemu-img command is available on your system.

klynnrif · 2018-03-20T22:10:22Z

Developer-Guide.md

+
+# Problem determination
+
+If you are unable to create a Kata Container, please run the


If you are unable to create a Kata Container, run the...

jodh-intel · 2018-03-21T08:51:33Z

Thanks for reviewing @klynnrif! Branch updated.

jodh-intel · 2018-03-21T08:53:21Z

Technically, this PR is also blocked on kata-containers/runtime#80. If I can't get that into a PR today, I'll remove the mention of the kata-collect-data.sh script in the "Troubleshoot" section (or mark this PR as do-not-merge until kata-containers/runtime#80 is resolved).

klynnrif

lgtm!

Move the developer guide from the wiki "in-tree". Fixes kata-containers#29. Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>

jodh-intel · 2018-03-21T16:58:58Z

Hi @egernst - I've remove mention of the data collection script as kata-containers/runtime#80 is unlikely to land today. I'll raise a follow-on PR for this doc once that PR has landed.

jodh-intel · 2018-03-21T17:01:27Z

https://github.com/kata-containers/documentation/wiki/Developer-Guide updated to point to https://github.com/kata-containers/documentation/blob/master/Developer-Guide.md.

jodh-intel · 2018-03-21T17:03:40Z

Issue to remove mention of Clear Containers packages once we have Kata packages: #33.

scripts: Add an "auto-size" feature

jodh-intel added the review label Mar 20, 2018

egernst reviewed Mar 20, 2018

View reviewed changes

jodh-intel mentioned this pull request Mar 20, 2018

README.md: Added links to developer guide and others #28

Closed

klynnrif suggested changes Mar 20, 2018

View reviewed changes

jodh-intel force-pushed the add-dev-guide branch from 43583e5 to ea4c5df Compare March 21, 2018 08:51

klynnrif approved these changes Mar 21, 2018

View reviewed changes

egernst approved these changes Mar 21, 2018

View reviewed changes

docs: Add developer guide

2ab1a3f

Move the developer guide from the wiki "in-tree". Fixes kata-containers#29. Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>

jodh-intel force-pushed the add-dev-guide branch from ea4c5df to 2ab1a3f Compare March 21, 2018 16:58

egernst merged commit 893d9d1 into kata-containers:master Mar 21, 2018

egernst removed the review label Mar 21, 2018

devimc pushed a commit to devimc/kata-documentation that referenced this pull request Sep 2, 2019

Merge pull request kata-containers#30 from harche/image_size

4ccd771

scripts: Add an "auto-size" feature


		# Check hardware requirements

		You can now check if your system is capable of creating a Kata Container by running:


		# Problem determination

		If you are unable to create a Kata Container, please run the

docs: Add developer guide #30

docs: Add developer guide #30

Uh oh!

Conversation

jodh-intel commented Mar 20, 2018

Uh oh!

jodh-intel commented Mar 20, 2018

Uh oh!

egernst commented Mar 20, 2018

Uh oh!

jodh-intel commented Mar 20, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

annebdh commented Mar 20, 2018

Uh oh!

klynnrif left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jodh-intel commented Mar 21, 2018

Uh oh!

jodh-intel commented Mar 21, 2018

Uh oh!

klynnrif left a comment

Choose a reason for hiding this comment

Uh oh!

jodh-intel commented Mar 21, 2018

Uh oh!

jodh-intel commented Mar 21, 2018

Uh oh!

jodh-intel commented Mar 21, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants