vagrant/README.md

   1 # Kubernetes Reference Deployment
   2
   3 ## Summary
   4
   5 This project offers a reference for deploying a Kubernetes cluster
   6 that satisfies the requirements of [ONAP multicloud/k8s plugin][1]. Its
   7 ansible playbooks allow to provision a deployment on Bare-metal or
   8 Virtual Machines.
   9
  10 ![Diagram](../doc/img/diagram.png)
  11
  12 # Components
  13
  14 | Name           | Description                                   | Source                            | Status |
  15 |:--------------:|:----------------------------------------------|:----------------------------------|:------:|
  16 | Kubernetes     | Base Kubernetes deployment                    | [kubespray][2]                    | Done   |
  17 | ovn-kubernetes | Integrates Opensource Virtual Networking      | [configure-ovn-kubernetes.yml][3] | Tested |
  18 | Virtlet        | Allows to run VMs                             | [configure-virtlet.yml][4]        | Tested |
  19 | Multus         | Provides Multiple Network support in a pod    | [configure-multus.yml][5]         | Tested |
  20 | NFD            | Node feature discovery                        | [configure-nfd.yml][7]            | Tested |
  21 | Istio          | Service Mesh platform                         | [configure-istio.yml][8]          | Tested |
  22
  23 ## Deployment
  24
  25 The [installer](installer.sh) bash script contains the minimal
  26 Ubuntu instructions required for running this project.
  27
  28 ### Virtual Machines
  29
  30 This project uses [Vagrant tool][6] for provisioning Virtual Machines
  31 automatically. The [setup](setup.sh) bash script contains the
  32 Linux instructions to install dependencies and plugins required for
  33 its usage. This script supports two Virtualization technologies
  34 (Libvirt and VirtualBox).
  35
  36     $ ./setup.sh -p libvirt
  37
  38 Once Vagrant is installed, it's possible to provision a cluster using
  39 the following instructions:
  40
  41     $ vagrant up && vagrant up installer
  42
  43 ## License
  44
  45 Apache-2.0
  46
  47 [1]: https://git.onap.org/multicloud/k8s
  48 [2]: https://github.com/kubernetes-incubator/kubespray
  49 [3]: playbooks/configure-ovn-kubernetes.yml
  50 [4]: playbooks/configure-virtlet.yml
  51 [5]: playbooks/configure-multus.yml
  52 [6]: https://www.vagrantup.com/
  53 [7]: playbooks/configure-nfd.yml
  54 [8]: playbooks/configure-istio.yml