diff options
author | Rihab Banday <rihab.banday@ericsson.com> | 2020-08-11 08:56:54 +0000 |
---|---|---|
committer | Victor Morales <v.morales@samsung.com> | 2020-08-17 18:39:30 -0400 |
commit | 607c277a52375807d56922cce817c44d6c51bd4a (patch) | |
tree | d10460d88932b3fbdd3b539cba766084662a99a1 /docs/deployment-guide.rst | |
parent | 28d1cee5c7b95ae905a4481245d5d5650c87e101 (diff) |
Adding Deployment Guide
This patch adds a deployment guide that describes the steps to initiate
the deployment.
Change-Id: I1835c0b6eee5945990ae078a20d2e2c92516c6b1
Signed-off-by: Rihab Banday <rihab.banday@ericsson.com>
Diffstat (limited to 'docs/deployment-guide.rst')
-rw-r--r-- | docs/deployment-guide.rst | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/docs/deployment-guide.rst b/docs/deployment-guide.rst new file mode 100644 index 0000000..0875bcf --- /dev/null +++ b/docs/deployment-guide.rst @@ -0,0 +1,60 @@ +=================================== +Welcome to Kuberef's documentation! +=================================== + +Introduction +============ + +Kuberef aims to develop and deliver a Kubernetes-based reference +implementation according to CNTT RA-2 in close collaboration with the +CNTT RI-2 workstream. + +The entire implementation is divided into two stages - Host provisioning +and Kubernetes provisioning. + +This guide describes how to get started with a potential RI-2 deployment +using `Cloud Infra Automation Framework <https://docs.nordix.org/submodules/infra/engine/docs/user-guide.html#framework-user-guide>`_ +for the Host provisioning stage and Intel's `BMRA <https://github.com/intel/container-experience-kits>`_ +for the Kubernetes provisioning stage. + +.. note:: + + This is just an example of a possible RI-2 deployment. Kuberef aims to + support and include other potential hardware and Kubernetes deployers as well. More + details can be found in the `Kuberef Wiki <https://wiki.opnfv.org/spaces/viewspace.action?key=KUB>`_. + +Infrastructure Prerequisites +============================= + +You need one physical server acting as a jump server along with minimum of two additional +servers on which RI-2 will be deployed. Please refer to Chapter 3 in CNTT RI-2 Documentation +for detailed information on the server and network specifications. + +Additionally, please make sure that you have KVM installed and set up on your jump server. This +is needed because the deployment will spin up a VM which will then carry out the host and +Kubernetes installation. + +Deployment +============================= + +Before initiating the deployment, please note the following: + +1. Add your configuration templates, ``pdf.yaml`` and ``idf.yaml`` under ``hw_config/<vendor>``. + +2. Modify the environmental variables defined in ``deploy.env`` to match your setup. + +3. Update ``hw_config/<vendor>/setup_network.sh`` with your correct networking info. This particular + script sets up networking on the provisioned nodes after the host provisioning stage is successful. + +.. note:: + + Depending on your setup, this script might not be needed. #WIP + +Once ready, issue the following command to initiate the deployment + +.. code-block:: bash + + ./deploy.sh + + +Once the deployment is successful, you will have a fully functional RI-2 setup! |