From 97f02fd3d2168135d9837926c0515b3d5b8de6ad Mon Sep 17 00:00:00 2001 From: Guo Ruijing Date: Thu, 8 Nov 2018 16:52:30 +0800 Subject: add scenarior for virlet and kata Change-Id: I24eaa36693b05343f67a3a777d04b7841dca9884 Signed-off-by: Guo Ruijing (cherry picked from commit 554a84f03e586252c5f0fc320acd046a2ae93439) --- docs/index.rst | 14 ++++++++++++++ docs/release/index.rst | 15 +++++++++++++++ docs/release/scenarios/k8-nosdn-virtlet-noha/index.rst | 18 ++++++++++++++++++ .../k8-nosdn-virtlet-noha/scenario.description.rst | 13 +++++++++++++ docs/release/scenarios/k8-ovn-kata-noha/index.rst | 18 ++++++++++++++++++ .../k8-ovn-kata-noha/scenario.description.rst | 17 +++++++++++++++++ docs/release/userguide/kata.rst | 17 ----------------- docs/release/userguide/virlet.rst | 13 ------------- 8 files changed, 95 insertions(+), 30 deletions(-) create mode 100644 docs/index.rst create mode 100644 docs/release/index.rst create mode 100644 docs/release/scenarios/k8-nosdn-virtlet-noha/index.rst create mode 100644 docs/release/scenarios/k8-nosdn-virtlet-noha/scenario.description.rst create mode 100644 docs/release/scenarios/k8-ovn-kata-noha/index.rst create mode 100644 docs/release/scenarios/k8-ovn-kata-noha/scenario.description.rst delete mode 100644 docs/release/userguide/kata.rst delete mode 100644 docs/release/userguide/virlet.rst diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..0a777e2 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,14 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +.. _container4nfv: + +============= +Container4NFV +============= + +.. toctree:: + :maxdepth: 1 + + release/index diff --git a/docs/release/index.rst b/docs/release/index.rst new file mode 100644 index 0000000..e09f09f --- /dev/null +++ b/docs/release/index.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +.. _container4nfv-release: + +==================== +Release Documetation +==================== + +.. toctree:: + :numbered: + :maxdepth: 1 + + scenarios/index diff --git a/docs/release/scenarios/k8-nosdn-virtlet-noha/index.rst b/docs/release/scenarios/k8-nosdn-virtlet-noha/index.rst new file mode 100644 index 0000000..ba7c54e --- /dev/null +++ b/docs/release/scenarios/k8-nosdn-virtlet-noha/index.rst @@ -0,0 +1,18 @@ +.. _k8-nosdn-virtlet-noha: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) + +========================================= +k8-nosdn-virtlet-noha overview and description +========================================= +.. This document will be used to provide a description of the scenario for an end user. +.. You should explain the purpose of the scenario, the types of capabilities provided and +.. the unique components that make up the scenario including how they are used. + +.. toctree:: + :maxdepth: 3 + + ./scenario.description.rst + diff --git a/docs/release/scenarios/k8-nosdn-virtlet-noha/scenario.description.rst b/docs/release/scenarios/k8-nosdn-virtlet-noha/scenario.description.rst new file mode 100644 index 0000000..60902db --- /dev/null +++ b/docs/release/scenarios/k8-nosdn-virtlet-noha/scenario.description.rst @@ -0,0 +1,13 @@ +Virlet implementation for OPNFV +================================= + +This quickstart shows you how to easily install a Kubernetes cluster on VMs running with Vagrant. The installation uses a tool called kubeadm which is part of Kubernetes. + +kubeadm assumes you have a set of machines (virtual or bare metal) that are up and running. In this way we can get a cluster with one master node and 2 workers (default). If you want to increase the number of workers nodes, please check the Vagrantfile inside the project. + +About Virlet +------------ + +(Virlet)[https://github.com/Mirantis/virtlet] is a Kubernetes runtime server / (CRI)[http://blog.kubernetes.io/2016/12/container-runtime-interface-cri-in-kubernetes.html] that enables you to run VM workloads based on QCOW2 images. (CRI is what enables Kubernetes to run non-Docker flavors of containers, such as Rkt.) + +Virlet gives NFV a new direction. Virtlet itself runs as a DaemonSet, essentially acting as a hypervisor and making the CRI proxy available to run the actual VMs. This way, it’s possible to have both Docker and non-Docker pods run on the same node. diff --git a/docs/release/scenarios/k8-ovn-kata-noha/index.rst b/docs/release/scenarios/k8-ovn-kata-noha/index.rst new file mode 100644 index 0000000..fe2cf42 --- /dev/null +++ b/docs/release/scenarios/k8-ovn-kata-noha/index.rst @@ -0,0 +1,18 @@ +.. _k8-ovn-kata-noha: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) + +========================================= +k8-ovn-kata-noha overview and description +========================================= +.. This document will be used to provide a description of the scenario for an end user. +.. You should explain the purpose of the scenario, the types of capabilities provided and +.. the unique components that make up the scenario including how they are used. + +.. toctree:: + :maxdepth: 3 + + ./scenario.description.rst + diff --git a/docs/release/scenarios/k8-ovn-kata-noha/scenario.description.rst b/docs/release/scenarios/k8-ovn-kata-noha/scenario.description.rst new file mode 100644 index 0000000..c7e6340 --- /dev/null +++ b/docs/release/scenarios/k8-ovn-kata-noha/scenario.description.rst @@ -0,0 +1,17 @@ +Kata Containers implementation for OPNFV +======================================== + +Kata Containers is a new open source project building extremely lightweight virtual machines that seamlessly plug into the containers ecosystem. + +CONTAINER4NFV setup a Kubernetes cluster on VMs running with Vagrant and kubeadm. + +kubeadm assumes you have a set of machines (virtual or bare metal) that are up and running. In this way we can get a cluster with one master node and 2 workers (default). If you want to increase the number of workers nodes, please check the Vagrantfile inside the project. + +About Kata Containers +--------------------- + +[Kata Containers](https://katacontainers.io/) is an open source project and community working to build a standard implementation of lightweight Virtual Machines (VMs) that feel and perform like containers, but provide the workload isolation and security advantages of VMs. + +The Kata Containers project will initially comprise six components, including the Agent, Runtime, Proxy, Shim, Kernel and packaging of QEMU 2.9. It is designed to be architecture agnostic, run on multiple hypervisors and be compatible with the OCI specification for Docker containers and CRI for Kubernetes. + +Kata Containers combines technology from Intel Clear Containers and Hyper runV. The code is hosted on Github under the Apache 2 license and the project is managed by the OpenStack Foundation. diff --git a/docs/release/userguide/kata.rst b/docs/release/userguide/kata.rst deleted file mode 100644 index c7e6340..0000000 --- a/docs/release/userguide/kata.rst +++ /dev/null @@ -1,17 +0,0 @@ -Kata Containers implementation for OPNFV -======================================== - -Kata Containers is a new open source project building extremely lightweight virtual machines that seamlessly plug into the containers ecosystem. - -CONTAINER4NFV setup a Kubernetes cluster on VMs running with Vagrant and kubeadm. - -kubeadm assumes you have a set of machines (virtual or bare metal) that are up and running. In this way we can get a cluster with one master node and 2 workers (default). If you want to increase the number of workers nodes, please check the Vagrantfile inside the project. - -About Kata Containers ---------------------- - -[Kata Containers](https://katacontainers.io/) is an open source project and community working to build a standard implementation of lightweight Virtual Machines (VMs) that feel and perform like containers, but provide the workload isolation and security advantages of VMs. - -The Kata Containers project will initially comprise six components, including the Agent, Runtime, Proxy, Shim, Kernel and packaging of QEMU 2.9. It is designed to be architecture agnostic, run on multiple hypervisors and be compatible with the OCI specification for Docker containers and CRI for Kubernetes. - -Kata Containers combines technology from Intel Clear Containers and Hyper runV. The code is hosted on Github under the Apache 2 license and the project is managed by the OpenStack Foundation. diff --git a/docs/release/userguide/virlet.rst b/docs/release/userguide/virlet.rst deleted file mode 100644 index 60902db..0000000 --- a/docs/release/userguide/virlet.rst +++ /dev/null @@ -1,13 +0,0 @@ -Virlet implementation for OPNFV -================================= - -This quickstart shows you how to easily install a Kubernetes cluster on VMs running with Vagrant. The installation uses a tool called kubeadm which is part of Kubernetes. - -kubeadm assumes you have a set of machines (virtual or bare metal) that are up and running. In this way we can get a cluster with one master node and 2 workers (default). If you want to increase the number of workers nodes, please check the Vagrantfile inside the project. - -About Virlet ------------- - -(Virlet)[https://github.com/Mirantis/virtlet] is a Kubernetes runtime server / (CRI)[http://blog.kubernetes.io/2016/12/container-runtime-interface-cri-in-kubernetes.html] that enables you to run VM workloads based on QCOW2 images. (CRI is what enables Kubernetes to run non-Docker flavors of containers, such as Rkt.) - -Virlet gives NFV a new direction. Virtlet itself runs as a DaemonSet, essentially acting as a hypervisor and making the CRI proxy available to run the actual VMs. This way, it’s possible to have both Docker and non-Docker pods run on the same node. -- cgit 1.2.3-korg