diff options
Diffstat (limited to 'docs/release/userguide')
| -rw-r--r-- | docs/release/userguide/img/multus_pod_example.png | bin | 0 -> 13917 bytes | |||
| -rw-r--r-- | docs/release/userguide/index.rst | 4 | ||||
| -rw-r--r-- | docs/release/userguide/install.rst | 32 | ||||
| -rw-r--r-- | docs/release/userguide/multus.rst | 29 | ||||
| -rw-r--r-- | docs/release/userguide/ovsdpdk.rst | 13 | ||||
| -rw-r--r-- | docs/release/userguide/virlet.rst | 13 | ||||
| -rw-r--r-- | docs/release/userguide/weave.rst | 10 |
7 files changed, 100 insertions, 1 deletions
diff --git a/docs/release/userguide/img/multus_pod_example.png b/docs/release/userguide/img/multus_pod_example.png Binary files differnew file mode 100644 index 0000000..64995f1 --- /dev/null +++ b/docs/release/userguide/img/multus_pod_example.png diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst index 3dc6bc8..d92f7bd 100644 --- a/docs/release/userguide/index.rst +++ b/docs/release/userguide/index.rst @@ -16,3 +16,7 @@ Container4NFV User Guide install.rst scenario.rst + multus.rst + weave.rst + ovsdpdk.rst + virlet.rst diff --git a/docs/release/userguide/install.rst b/docs/release/userguide/install.rst index 07d0bbd..241dd49 100644 --- a/docs/release/userguide/install.rst +++ b/docs/release/userguide/install.rst @@ -1,11 +1,20 @@ Installation ============ -Vagrant is installed in Ubuntu 16.04. +This quickstart shows you how to easily install a Kubernetes cluster on VMs running with Vagrant. You can find the four projects inside `container4nfv/src/vagrant` and their documentation: +- kubeadm_basic: weave.rst +- kubeadm_multus: multus.rst +- kubeadm_ovsdpdk: ovs-dpdk.rst +- kubeadm_virtlet: virtlet.rst + +Vagrant is installed in Ubuntu 16.04 64bit. vagrant is to create kubernetes cluster using kubeadm. kubernetes installation by kubeadm can be refered to https://kubernetes.io/docs/getting-started-guides/kubeadm. +e release +========= + Vagrant Setup ------------- @@ -29,3 +38,24 @@ K8s Cleanup ----------- vagrant destroy -f + +f release +========= + +Vagrant Setup +------------- +1. `setup_vagrant.sh` may install all for you. The project uses vagrant with libvirt as default because of performance. + +``` +container4nfv/src/vagrant# ./setup_vagrant.sh +``` + +Consequently, we need to reboot to make libvirtd group effective. + +2. Deploy: + +To test all the projects inside `vagrant/` just run the next script: + +``` +container4nfv/ci# ./deploy.sh +``` diff --git a/docs/release/userguide/multus.rst b/docs/release/userguide/multus.rst new file mode 100644 index 0000000..fbdbeb9 --- /dev/null +++ b/docs/release/userguide/multus.rst @@ -0,0 +1,29 @@ +Multus 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 Multus +------------ + +[Multus](https://github.com/Intel-Corp/multus-cni) is a CNI proxy and arbiter of other CNI plugins. + +With the help of Multus CNI plugin, multiple interfaces can be added at the same time when deploying a pod. Notably, Virtual Network Functions (VNFs) are typically requiring connectivity to multiple network interfaces. + +The Multus CNI has the following features: +- It is a contact between the container runtime and other plugins, and it doesn't have any of its own net configuration, it calls other plugins like flannel/calico to do the real net conf. job. +- Multus reuses the concept of invoking the delegates in flannel, it groups the multi plugins into delegates and invoke each other in sequential order, according to the JSON scheme in the cni configuration. +- No. of plugins supported is dependent upon the number of delegates in the conf file. +- Master plugin invokes "eth0" interface in the pod, rest of plugins(Mininon plugins eg: sriov,ipam) invoke interfaces as "net0", "net1".. "netn". +- The "masterplugin" is the only net conf option of Multus cni, it identifies the primary network. The default route will point to the primary network. + + +Multus example +-------------- + +.. image:: img/multus_pod_example.png + :width: 800px + :alt: Multus Pod example diff --git a/docs/release/userguide/ovsdpdk.rst b/docs/release/userguide/ovsdpdk.rst new file mode 100644 index 0000000..661e4c4 --- /dev/null +++ b/docs/release/userguide/ovsdpdk.rst @@ -0,0 +1,13 @@ +Ovsdpdk 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 OvS-dpdk +-------------- + +Open vSwitch* with the Data Plane Development Kit [OvS-DPDK](http://openvswitch.org/) is a high performance, open source virtual switch. + +Using DPDK with OVS gives us tremendous performance benefits. Similar to other DPDK-based applications, we see a huge increase in network packet throughput and much lower latencies. diff --git a/docs/release/userguide/virlet.rst b/docs/release/userguide/virlet.rst new file mode 100644 index 0000000..60902db --- /dev/null +++ b/docs/release/userguide/virlet.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/userguide/weave.rst b/docs/release/userguide/weave.rst new file mode 100644 index 0000000..db45b13 --- /dev/null +++ b/docs/release/userguide/weave.rst @@ -0,0 +1,10 @@ +Nginx 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 `kubeadm_basic/`. + +About Nginx +----------- +Nginx is a web server which can also be used as a reverse proxy, load balancer and HTTP cache. |
