From 8e3db7f3dfba567e0df677980f4465a2ffcbce66 Mon Sep 17 00:00:00 2001 From: Eric Ernst Date: Fri, 29 Mar 2019 09:56:55 -0700 Subject: [PATCH 1/6] zun: move to use-cases, utilize images dir Fixes: #417 Signed-off-by: Eric Ernst --- README.md | 2 +- {zun => use-cases/images}/kata-zun1.png | Bin {zun => use-cases/images}/kata-zun2.png | Bin {zun => use-cases/images}/kata-zun3.png | Bin {zun => use-cases/images}/kata-zun4.png | Bin {zun => use-cases/images}/kata-zun5.png | Bin {zun => use-cases}/zun_kata.md | 10 +++++----- 7 files changed, 6 insertions(+), 6 deletions(-) rename {zun => use-cases/images}/kata-zun1.png (100%) rename {zun => use-cases/images}/kata-zun2.png (100%) rename {zun => use-cases/images}/kata-zun3.png (100%) rename {zun => use-cases/images}/kata-zun4.png (100%) rename {zun => use-cases/images}/kata-zun5.png (100%) rename {zun => use-cases}/zun_kata.md (94%) diff --git a/README.md b/README.md index e017ef2ab1..c24eac206b 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ For details of the other Kata Containers repositories, see the [`runc`](https://github.com/opencontainers/runc). * HOWTO: [Kata Containers with k8s and cri-containerd](./how-to/how-to-use-k8s-with-cri-containerd-and-kata.md) -* HOWTO: [OpenStack Zun with Kata Containers](zun/zun_kata.md) +* HOWTO: [OpenStack Zun with Kata Containers](./use-cases/zun_kata.md) * HOWTO: [Kata Containers with Firecracker](https://github.com/kata-containers/documentation/wiki/Initial-release-of-Kata-Containers-with-Firecracker-support) * HOWTO: [Sysctls with Kata Containers](./how-to/how-to-use-sysctls-with-kata.md) * HOWTO: [VM Templating](./how-to/what-is-vm-cache-and-how-do-I-use-it.md) and [VM Cache](./how-to/what-is-vm-cache-and-how-do-I-use-it.md) diff --git a/zun/kata-zun1.png b/use-cases/images/kata-zun1.png similarity index 100% rename from zun/kata-zun1.png rename to use-cases/images/kata-zun1.png diff --git a/zun/kata-zun2.png b/use-cases/images/kata-zun2.png similarity index 100% rename from zun/kata-zun2.png rename to use-cases/images/kata-zun2.png diff --git a/zun/kata-zun3.png b/use-cases/images/kata-zun3.png similarity index 100% rename from zun/kata-zun3.png rename to use-cases/images/kata-zun3.png diff --git a/zun/kata-zun4.png b/use-cases/images/kata-zun4.png similarity index 100% rename from zun/kata-zun4.png rename to use-cases/images/kata-zun4.png diff --git a/zun/kata-zun5.png b/use-cases/images/kata-zun5.png similarity index 100% rename from zun/kata-zun5.png rename to use-cases/images/kata-zun5.png diff --git a/zun/zun_kata.md b/use-cases/zun_kata.md similarity index 94% rename from zun/zun_kata.md rename to use-cases/zun_kata.md index 0faa3651cf..e0101b147b 100644 --- a/zun/zun_kata.md +++ b/use-cases/zun_kata.md @@ -101,22 +101,22 @@ sudo systemctl daemon-reload sudo systemctl restart docker ``` -![kata zun image 1](kata-zun1.png) +![kata zun image 1](./images/kata-zun1.png) Figure 1: Create a busybox container image -![kata zun image 2](kata-zun2.png) +![kata zun image 2](./images/kata-zun2.png) Figure 2: Select `kata-runtime` to use -![kata zun image 3](kata-zun3.png) +![kata zun image 3](./images/kata-zun3.png) Figure 3: Two busybox containers successfully launched -![kata zun image 4](kata-zun4.png) +![kata zun image 4](./images/kata-zun4.png) Figure 4: Test connectivity between Kata Containers -![kata zun image 5](kata-zun5.png) +![kata zun image 5](./images/kata-zun5.png) Figure 5: CLI for Zun From 353b2ecf9f79c561f1e991580c1e70b7b4c7bb72 Mon Sep 17 00:00:00 2001 From: Eric Ernst Date: Fri, 29 Mar 2019 10:04:09 -0700 Subject: [PATCH 2/6] vsocks: move to design directory Let's keep all design documents in the design directory Fixes: #417 Signed-off-by: Eric Ernst --- VSocks.md => design/VSocks.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename VSocks.md => design/VSocks.md (100%) diff --git a/VSocks.md b/design/VSocks.md similarity index 100% rename from VSocks.md rename to design/VSocks.md From c0d63796a22fd3fdae55c2e335eea77c340f7f78 Mon Sep 17 00:00:00 2001 From: Eric Ernst Date: Fri, 29 Mar 2019 10:06:02 -0700 Subject: [PATCH 3/6] constraints: add as part of design documents Let's keep all design documents in the same logical location. Updating the file to be called 'cpu-constraints', though we may want to expand to resource constraints going forward. Fixes: #417 Signed-off-by: Eric Ernst --- Limitations.md | 2 +- design/VSocks.md | 2 +- constraints/cpu.md => design/cpu-constraints.md | 0 3 files changed, 2 insertions(+), 2 deletions(-) rename constraints/cpu.md => design/cpu-constraints.md (100%) diff --git a/Limitations.md b/Limitations.md index 5a4ff50ee6..b82676d9fa 100644 --- a/Limitations.md +++ b/Limitations.md @@ -138,7 +138,7 @@ these commands is potentially challenging. See issue https://github.com/clearcontainers/runtime/issues/341 and [the constraints challenge](#the-constraints-challenge) for more information. For CPUs resource management see -[cpu-constraints](constraints/cpu.md). +[cpu-constraints](design/cpu-constraints.md). ### docker run and shared memory diff --git a/design/VSocks.md b/design/VSocks.md index 302531592e..c17818d4dd 100644 --- a/design/VSocks.md +++ b/design/VSocks.md @@ -130,5 +130,5 @@ the containers are removed automatically. [2]: https://github.com/kata-containers/proxy [3]: https://github.com/hashicorp/yamux [4]: https://wiki.qemu.org/Features/VirtioVsock -[5]: https://github.com/kata-containers/documentation/blob/master/constraints/cpu.md#virtual-cpus-and-kubernetes-pods +[5]: https://github.com/kata-containers/documentation/blob/master/design/cpu-constraints.md#virtual-cpus-and-kubernetes-pods [6]: https://github.com/kata-containers/shim diff --git a/constraints/cpu.md b/design/cpu-constraints.md similarity index 100% rename from constraints/cpu.md rename to design/cpu-constraints.md From daef1791ffe76bd3eeeba2375a20f0ae406e24cc Mon Sep 17 00:00:00 2001 From: Eric Ernst Date: Fri, 29 Mar 2019 10:14:59 -0700 Subject: [PATCH 4/6] arch: move architecture.md to the design directory Fixes: #417 Signed-off-by: Eric Ernst --- README.md | 2 +- Upgrading.md | 2 +- design/README.md | 2 +- .../arch-images}/CNM_detailed_diagram.png | Bin .../arch-images}/CNM_overall_diagram.png | Bin {arch-images => design/arch-images}/DAX.png | Bin {arch-images => design/arch-images}/docker-kata.png | Bin .../kata-containers-network-hotplug-uml.txt | 0 .../kata-containers-network-hotplug.png | Bin .../arch-images}/kata-crio-uml.png | Bin .../arch-images}/kata-crio-uml.txt | 0 .../arch-images}/kata-oci-create.svg | 0 .../arch-images}/kata-oci-create.txt | 0 .../arch-images}/kata-oci-exec.svg | 0 .../arch-images}/kata-oci-exec.txt | 0 .../arch-images}/kata-oci-start.svg | 0 .../arch-images}/kata-oci-start.txt | 0 {arch-images => design/arch-images}/network.png | Bin {arch-images => design/arch-images}/qemu.png | Bin {arch-images => design/arch-images}/shimv2.svg | 0 architecture.md => design/architecture.md | 0 21 files changed, 3 insertions(+), 3 deletions(-) rename {arch-images => design/arch-images}/CNM_detailed_diagram.png (100%) rename {arch-images => design/arch-images}/CNM_overall_diagram.png (100%) rename {arch-images => design/arch-images}/DAX.png (100%) rename {arch-images => design/arch-images}/docker-kata.png (100%) rename {arch-images => design/arch-images}/kata-containers-network-hotplug-uml.txt (100%) rename {arch-images => design/arch-images}/kata-containers-network-hotplug.png (100%) rename {arch-images => design/arch-images}/kata-crio-uml.png (100%) rename {arch-images => design/arch-images}/kata-crio-uml.txt (100%) rename {arch-images => design/arch-images}/kata-oci-create.svg (100%) rename {arch-images => design/arch-images}/kata-oci-create.txt (100%) rename {arch-images => design/arch-images}/kata-oci-exec.svg (100%) rename {arch-images => design/arch-images}/kata-oci-exec.txt (100%) rename {arch-images => design/arch-images}/kata-oci-start.svg (100%) rename {arch-images => design/arch-images}/kata-oci-start.txt (100%) rename {arch-images => design/arch-images}/network.png (100%) rename {arch-images => design/arch-images}/qemu.png (100%) rename {arch-images => design/arch-images}/shimv2.svg (100%) rename architecture.md => design/architecture.md (100%) diff --git a/README.md b/README.md index c24eac206b..81bc07abf2 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ Documents that help to understand and contribute to Kata Containers. ### Design and Implementations -* [Kata Containers Architecture](architecture.md): Architectural overview of Kata Containers +* [Kata Containers Architecture](design/architecture.md): Architectural overview of Kata Containers * [Kata Containers design](./design/README.md): More Kata Containers design documents ### How to Contribute diff --git a/Upgrading.md b/Upgrading.md index 7379ff9268..b62e1dc516 100644 --- a/Upgrading.md +++ b/Upgrading.md @@ -142,7 +142,7 @@ standard package management tools for your distribution. Kata Containers requires additional resources to create a virtual machine container. These resources are called -[Kata Containers assets](https://github.com/kata-containers/documentation/blob/master/architecture.md#assets), +[Kata Containers assets](https://github.com/kata-containers/documentation/blob/master/design/architecture.md#assets), which comprise a guest kernel and a root filesystem or initrd image. This section describes when these components are updated. diff --git a/design/README.md b/design/README.md index 6c4bb32897..fb0000c5f9 100644 --- a/design/README.md +++ b/design/README.md @@ -2,7 +2,7 @@ Kata Containers design documentations, include the -- [Kata Containers architecture](../architecture.md) +- [Kata Containers architecture](architecture.md) - Working scenarios of Kata Containers - [API Design of Kata Containers](kata-api-design.md) - Kata Containers lifecycle diff --git a/arch-images/CNM_detailed_diagram.png b/design/arch-images/CNM_detailed_diagram.png similarity index 100% rename from arch-images/CNM_detailed_diagram.png rename to design/arch-images/CNM_detailed_diagram.png diff --git a/arch-images/CNM_overall_diagram.png b/design/arch-images/CNM_overall_diagram.png similarity index 100% rename from arch-images/CNM_overall_diagram.png rename to design/arch-images/CNM_overall_diagram.png diff --git a/arch-images/DAX.png b/design/arch-images/DAX.png similarity index 100% rename from arch-images/DAX.png rename to design/arch-images/DAX.png diff --git a/arch-images/docker-kata.png b/design/arch-images/docker-kata.png similarity index 100% rename from arch-images/docker-kata.png rename to design/arch-images/docker-kata.png diff --git a/arch-images/kata-containers-network-hotplug-uml.txt b/design/arch-images/kata-containers-network-hotplug-uml.txt similarity index 100% rename from arch-images/kata-containers-network-hotplug-uml.txt rename to design/arch-images/kata-containers-network-hotplug-uml.txt diff --git a/arch-images/kata-containers-network-hotplug.png b/design/arch-images/kata-containers-network-hotplug.png similarity index 100% rename from arch-images/kata-containers-network-hotplug.png rename to design/arch-images/kata-containers-network-hotplug.png diff --git a/arch-images/kata-crio-uml.png b/design/arch-images/kata-crio-uml.png similarity index 100% rename from arch-images/kata-crio-uml.png rename to design/arch-images/kata-crio-uml.png diff --git a/arch-images/kata-crio-uml.txt b/design/arch-images/kata-crio-uml.txt similarity index 100% rename from arch-images/kata-crio-uml.txt rename to design/arch-images/kata-crio-uml.txt diff --git a/arch-images/kata-oci-create.svg b/design/arch-images/kata-oci-create.svg similarity index 100% rename from arch-images/kata-oci-create.svg rename to design/arch-images/kata-oci-create.svg diff --git a/arch-images/kata-oci-create.txt b/design/arch-images/kata-oci-create.txt similarity index 100% rename from arch-images/kata-oci-create.txt rename to design/arch-images/kata-oci-create.txt diff --git a/arch-images/kata-oci-exec.svg b/design/arch-images/kata-oci-exec.svg similarity index 100% rename from arch-images/kata-oci-exec.svg rename to design/arch-images/kata-oci-exec.svg diff --git a/arch-images/kata-oci-exec.txt b/design/arch-images/kata-oci-exec.txt similarity index 100% rename from arch-images/kata-oci-exec.txt rename to design/arch-images/kata-oci-exec.txt diff --git a/arch-images/kata-oci-start.svg b/design/arch-images/kata-oci-start.svg similarity index 100% rename from arch-images/kata-oci-start.svg rename to design/arch-images/kata-oci-start.svg diff --git a/arch-images/kata-oci-start.txt b/design/arch-images/kata-oci-start.txt similarity index 100% rename from arch-images/kata-oci-start.txt rename to design/arch-images/kata-oci-start.txt diff --git a/arch-images/network.png b/design/arch-images/network.png similarity index 100% rename from arch-images/network.png rename to design/arch-images/network.png diff --git a/arch-images/qemu.png b/design/arch-images/qemu.png similarity index 100% rename from arch-images/qemu.png rename to design/arch-images/qemu.png diff --git a/arch-images/shimv2.svg b/design/arch-images/shimv2.svg similarity index 100% rename from arch-images/shimv2.svg rename to design/arch-images/shimv2.svg diff --git a/architecture.md b/design/architecture.md similarity index 100% rename from architecture.md rename to design/architecture.md From 51f12efae93dc5b472778d2f9482f3507e01dc75 Mon Sep 17 00:00:00 2001 From: Eric Ernst Date: Fri, 29 Mar 2019 14:03:59 -0700 Subject: [PATCH 5/6] arch: fix dead link api.proto moved, resulting in a broken link. The original link wasn't very useful in the first place, so simply remove. Signed-off-by: Eric Ernst --- design/architecture.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/design/architecture.md b/design/architecture.md index 7e0b1105ee..f7d07b490e 100644 --- a/design/architecture.md +++ b/design/architecture.md @@ -544,8 +544,7 @@ dedicated master node) calls into a compute kubelet. This kubelet instance is responsible for managing the lifecycle of pods within the nodes and eventually relies on a container runtime to handle execution. The kubelet architecture decouples lifecycle management from container execution through the dedicated -[`gRPC`](https://github.com/kubernetes/kubernetes/blob/master/pkg/kubelet/apis/cri/runtime/v1alpha2/api.proto) -based [Container Runtime Interface (CRI)](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/node/container-runtime-interface-v1.md). +`gRPC` based [Container Runtime Interface (CRI)](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/node/container-runtime-interface-v1.md). In other words, a kubelet is a CRI client and expects a CRI implementation to handle the server side of the interface. From 152330a4fd7fc65ed65c84a45fae4e6dfcbbe32f Mon Sep 17 00:00:00 2001 From: Eric Ernst Date: Fri, 29 Mar 2019 14:12:49 -0700 Subject: [PATCH 6/6] docs: Use relative paths for URLs which are part of this repo Let's make our static testers happy. Signed-off-by: Eric Ernst --- Upgrading.md | 2 +- design/VSocks.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Upgrading.md b/Upgrading.md index b62e1dc516..26fec21879 100644 --- a/Upgrading.md +++ b/Upgrading.md @@ -142,7 +142,7 @@ standard package management tools for your distribution. Kata Containers requires additional resources to create a virtual machine container. These resources are called -[Kata Containers assets](https://github.com/kata-containers/documentation/blob/master/design/architecture.md#assets), +[Kata Containers assets](./design/architecture.md#assets), which comprise a guest kernel and a root filesystem or initrd image. This section describes when these components are updated. diff --git a/design/VSocks.md b/design/VSocks.md index c17818d4dd..4383bc167b 100644 --- a/design/VSocks.md +++ b/design/VSocks.md @@ -130,5 +130,5 @@ the containers are removed automatically. [2]: https://github.com/kata-containers/proxy [3]: https://github.com/hashicorp/yamux [4]: https://wiki.qemu.org/Features/VirtioVsock -[5]: https://github.com/kata-containers/documentation/blob/master/design/cpu-constraints.md#virtual-cpus-and-kubernetes-pods +[5]: ./cpu-constraints.md#virtual-cpus-and-kubernetes-pods [6]: https://github.com/kata-containers/shim