docs/deployment-guide.rst

   1 ===================================
   2 Welcome to Kuberef's documentation!
   3 ===================================
   4
   5 Introduction
   6 ============
   7
   8 Kuberef aims to develop and deliver a Kubernetes-based reference
   9 implementation according to CNTT RA-2 in close collaboration with the
  10 CNTT RI-2 workstream.
  11
  12 The entire implementation is divided into two stages - Host provisioning
  13 and Kubernetes provisioning.
  14
  15 This guide describes how to get started with a potential RI-2 deployment
  16 using `Cloud Infra Automation Framework <https://docs.nordix.org/submodules/infra/engine/docs/user-guide.html#framework-user-guide>`_
  17 for the Host provisioning stage and Intel's `BMRA <https://github.com/intel/container-experience-kits>`_
  18 for the Kubernetes provisioning stage.
  19
  20 .. note::
  21
  22     This is just an example of a possible RI-2 deployment. Kuberef aims to
  23     support and include other potential hardware and Kubernetes deployers as well. More
  24     details can be found in the `Kuberef Wiki <https://wiki.opnfv.org/spaces/viewspace.action?key=KUB>`_.
  25
  26 Infrastructure Prerequisites
  27 =============================
  28
  29 You need one physical server acting as a jump server along with minimum of two additional
  30 servers on which RI-2 will be deployed. Please refer to Chapter 3 in CNTT RI-2 Documentation
  31 for detailed information on the server and network specifications.
  32
  33 Additionally, please make sure that you have KVM installed and set up on your jump server. This
  34 is needed because the deployment will spin up a VM which will then carry out the host and
  35 Kubernetes installation.
  36
  37 Deployment
  38 =============================
  39
  40 Before initiating the deployment, please note the following:
  41
  42 1. Add your configuration templates, ``pdf.yaml`` and ``idf.yaml`` under ``hw_config/<vendor>``.
  43
  44 2. Modify the environmental variables defined in ``deploy.env`` to match your setup.
  45
  46 3. Update ``hw_config/<vendor>/setup_network.sh`` with your correct networking info. This particular
  47    script sets up networking on the provisioned nodes after the host provisioning stage is successful.
  48
  49 .. note::
  50
  51     Depending on your setup, this script might not be needed. #WIP
  52
  53 Once ready, issue the following command to initiate the deployment
  54
  55 .. code-block:: bash
  56
  57    ./deploy.sh
  58
  59
  60 Once the deployment is successful, you will have a fully functional RI-2 setup!