Add a new document covering how and when we will update assets (image, kernel, and hypervisor [for qemu-lite]). Doc can be based on:

• https://github.com/clearcontainers/runtime/blob/master/docs/assets-update.md

Once kata-containers/packaging#1 lands, we should have some tooling to make it easy to create a custom kernel based on the base Kata kernel configuration.

Update the architecture guide with more details on the Containerd CRI Plugin.

Example md @ https://egernst.github.io/posts/Clear-Containers-and-graphics-passthrough

Should verify minimal capabilities required and make use of simple openCL test (hash cat).

Update https://github.com/kata-containers/documentation/blob/master/Developer-Guide.md to explain that qemu-lite is no longer needed.

People are asking how to use it in the kata-dev channel. Let's document it in the dev guide for other's reference.

Explain how to obtain a backtrace by sending SIGUSR1 to a kata component.

There is a typo in the installation in ubuntu docs.

We need an equivalent of:

• https://github.com/clearcontainers/runtime/wiki/Release-Process
• https://github.com/clearcontainers/runtime/wiki/Release-Checklist

Now that kata-containers/runtime#93 has landed, add details of it to the developer guide.

The runtime build now defaults to using vanilla qemu. Update the developer guide to reset that value back to qemu-lite for the time being.

Related: #68.

Require 2 acks from the doc team, for parity with the other repos.

I think https://github.com/kata-containers/documentation/blob/master/Developer-Guide.md#build-and-install-the-kata-containers-runtime may be out of date due to a couple of recent changes:

• the toml config file now has a line for an initrd.img, which is not built and installed by this doc - so kata-runtime fails to load the toml (as the file is not found, which is an error) (a quick fix is to just hand comment out the initrd img line in the toml)
• the toml config file now referes to the system qemu (not the lite version), but on some distros (my Ubuntu machine for instance), the system qemu is old (2.5.0), and does not have the necessary nvdimm options, so errors out. (a quick fix is to update the toml by hand to point back at the lite qemu)

On reading the development guide, I noticed a few changes
that would enhance the readability of the guide. These are just
minor changes.

We need to create an ARCHITECTURE.md that covers the overall system.

This document could, if necessary, reference architecture documents found in each components repository. These would essentially document just themselves. The intent is to define once and reference as many times as needed.

For example, the ARCHITECTURE.md created in this repository may say something like:

For further details on the Kata shim implementation, refer to the shim architecture document

Component repositories

The individual README.md files in each code repository must contain a reference to this central architecture document.

If a component repository has a separate ARCHITECTURE.md this:

• Must be referenced in the components README.md.
• Must itself reference the central ARCHITECTURE.md document.

For an example of what we should be aiming for, see the Clear Containers architecture document:

• https://github.com/clearcontainers/runtime/blob/master/docs/architecture/architecture.md

Diagrams

All diagrams must:

• Be stored along with their corresponding "source" files (for example, if a .png file is referenced, the .svg file that was used to generate the .png must also be stored to allow the diagrams to be updated by all.
• Use freely available open formats for their sources.

Add missing CODE_OF_CONDUCT.md document.

The "Install Guest Kernel Images" section of the document is missing a pointer to the location wherefrom the user should fetch the "vmlinux.container" and "vmlinuz.container" images.

The developer guide in the wiki needs to move "in-tree".

If kata-runtime is already added as a runtime to kata-containers.conf
then you need not add it again. This is helpful when we redo some
of the earlier steps mentioned in the dev-guide and end up updating
docker config again resulting in multiple "--add-runtime kata-runtime=.."
which further results in failure in docker restart.

Ideally Should Be:
[Service]
Type=simple
ExecStart=
ExecStart=/usr/bin/dockerd -D --default-runtime runc --add-runtime kata-runtime=/usr/local/bin/kata-runtime

But Can Be:
[Service]
Type=simple
ExecStart=
ExecStart=/usr/bin/dockerd -D --default-runtime runc --add-runtime kata-runtime=/usr/local/bin/kata-runtime --add-runtime kata-runtime=/usr/local/bin/kata-runtime

Result:
sudo systemctl restart docker
systemctl status docker
● docker.service - Docker Application Container Engine
Loaded: loaded (/usr/lib/systemd/system/docker.service; disabled; vendor preset: disabled)
Drop-In: /etc/systemd/system/docker.service.d
└─kata-containers.conf
Active: failed (Result: exit-code) since Mon 2018-04-09 21:22:08 IST; 536ms ago
Docs: https://docs.docker.com
Process: 21784 ExecStart=/usr/bin/dockerd -D --default-runtime runc --add-runtime kata-runtime=/usr/local/bin/kata-runtime --add-runtime kata-runtime=/usr/l
Main PID: 21784 (code=exited, status=1/FAILURE)
CPU: 59ms

Apr 09 21:22:08 localhost.localdomain dockerd[21784]: -v, --version Print version information
Apr 09 21:22:08 localhost.localdomain dockerd[21784]: and quit
Apr 09 21:22:08 localhost.localdomain dockerd[21784]: Run 'dockerd COMMAND --help' for more information on a command.
Apr 09 21:22:08 localhost.localdomain dockerd[21784]: , Code: 125
Apr 09 21:22:08 localhost.localdomain systemd[1]: docker.service: Service hold-off time over, scheduling restart.
Apr 09 21:22:08 localhost.localdomain systemd[1]: Stopped Docker Application Container Engine.
Apr 09 21:22:08 localhost.localdomain systemd[1]: docker.service: Start request repeated too quickly.
Apr 09 21:22:08 localhost.localdomain systemd[1]: Failed to start Docker Application Container Engine.
Apr 09 21:22:08 localhost.localdomain systemd[1]: docker.service: Unit entered failed state.
Apr 09 21:22:08 localhost.localdomain systemd[1]: docker.service: Failed with result 'exit-code'.

Whilst we wait for kata-containers/agent#169 to finish simmering, we need to document in the developer guide how to manually setup a debug console for debugging purposes.

Add the standard code of conduct document.

When adding a custom agent to the image the following command fails.
sudo install -o root -g root -m 0550 -t rootfs/bin ../../agent/kata-agent

Add ubuntu installation guide for kata containers packages

Add fedora installation guide for kata containers packages

The "Build and install a Kata Containers runtime" link should be "Build and install the Kata Containers runtime" to match the section name in the developer guide.

The README is somewhat sparse. Add some brief explanatory text and a few pointers.

The "release checklist" in the Releases.md should link to https://github.com/kata-containers/documentation/blob/master/Release-Checklist.md, but doesn't ;)

We should require an "ack" from the documentation team before merging any doc changes on PRs.

create a directory in the repo for design document

Add a doc explaining how to "upgrade" from Clear Containers. At this stage, that will actually just be "install kata packages" 😄

We need to create an equivalent of the Clear Containers limitations document.

Every limitation listed MUST be accompanied by a reference to an issue number.

The working scenarios are discussed in kata-containers/runtime#31 as part of the design requirement of Kata Containers.

Include details how to create an entrusted pod.

The dev guide references Clear Containers packages.

Once we have packaged components, we need to update the dev guide to reference the Kata packages instead.

In the "Create an image" section,
in the "Build the image" sub section
I hit the "qemu-img" not installed dependency. It probably needs to be called out upfront in the "Assumptions" section up-top.

Once kata-containers/packaging#1 is resolved and we have OBS packages, we need instructions for all distros we produce packages for.

Now that kata-containers/runtime#98 has landed, we need to update the dev guide for initrd handling.

The dev guide currently only enables agent debug if no kernel params have been specified in the config file. We can do better than than.

We need a brief document explaining that the project uses SPDX license identifiers.

Add details to the developer guide explaining that the recommended way to install Kata is using the OBS binary packages.

Devs can then override particular components by building them from source.

While trying to setup the Dev Environment for Kata I came across some dependencies (e.g make, gcc) which need to be installed before proceeding with the dev env setup. We can also incorporate links to relevant documents (e.g. Golang install steps)