Replace previous links in the documentation

[kuberef.git] / docs / release / installation / deployment-guide.rst

diff --git a/docs/release/installation/deployment-guide.rst b/docs/release/installation/deployment-guide.rst
index b96b616..c6f4107 100644 (file)
--- a/docs/release/installation/deployment-guide.rst
+++ b/docs/release/installation/deployment-guide.rst
@@ -1,3 +1,7 @@
+.. SPDX-FileCopyrightText: 2021 Anuket contributors
+..
+.. SPDX-License-Identifier: CC-BY-4.0
+
 ===================================
 Welcome to Kuberef's documentation!
 ===================================
@@ -6,19 +10,19 @@ 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.
+implementation according to Anuket RA-2 in close collaboration with the
+Anuket RI-2 workstream.
 
 .. 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>`_.
+    details can be found in the `Kuberef Wiki <https://wiki.anuket.io/display/HOME/Kuberef>`_.
 
 Infrastructure Prerequisites
 =============================
 
-Please refer to Chapter 3 of `CNTT RI-2 Documentation <https://github.com/cntt-n/CNTT/blob/master/doc/ref_impl/cntt-ri2/chapters/chapter03.md>`_
+Please refer to Chapter 3 of `Anuket RI-2 Documentation <https://cntt.readthedocs.io/en/latest/ref_impl/cntt-ri2/chapters/chapter03.html>`_
 for detailed information on the server and network specifications.
 
 Additionally, please make note of the following:
@@ -31,7 +35,7 @@ Additionally, please make note of the following:
 
 3. Add user to the sudo and libvirt group and have passwordless sudo enabled.
 
-4. Install Ansible (tested with 2.9.14) and yq.
+4. Install Ansible (tested with 2.9.14), yq (v3.4.1), jq and virtual-env.
 
 Installing and configuring the prerequisites will depend on the operating system installed on the jump server. Below are additional details for setting up some of the more popular distributions.
 
@@ -100,16 +104,29 @@ Generate SSH keypair
 
 * ``ssh-keygen -t rsa -b 4096``
 
-Deployment
-=============================
+Deployment on Baremetal and Provider Infrastructure
+===================================================
 
-Please refer to Chapter 4 of `CNTT RI-2 Documentation <https://github.com/cntt-n/CNTT/blob/master/doc/ref_impl/cntt-ri2/chapters/chapter04.md>`_
+Please refer to Chapter 4 of `Anuket RI-2 Documentation <https://cntt.readthedocs.io/en/latest/ref_impl/cntt-ri2/chapters/chapter04.html>`_
 for instructions to get started with the deployment.
 
-Once the deployment is successful, you will have a fully functional RI-2 setup!
+Deployment on Virtualized Infrastructure
+========================================
+
+Following are the steps to spin up a minimalistic Kuberef deployment on VMs aimed for development and testing use-cases:
+
+* Set ``VENDOR=libvirt-vms``, ``DISTRO=ubuntu1804`` in ``deploy.env``. Additionally, ensure that other environmental variables defined in this file match your setup.
+* The hardware and network configurations for the VMs are defined under ``hw_config/libvirt-vms``. Currently, the configuration for one master and one worker VM is defined, but additional VM's can be added as desired. Additionally, the default values of hardware storage, CPU information, etc. can be adapted as per need.
+* Once ready, initiate the deployment by running ``dev/deploy_on_vms.sh`.
+
+After the successful completion of the deployment, you can do ``virsh list`` to list the provisioned VM's and connect to them over SSH using user ``root``. The SSH public key of the user is already added by the installer in the VM's. The IP of the VMs can be found under ``hw_config/libvirt-vms/pdf.yaml``.
+
+Verify that all services in the VM's are running by ``kubectl get all --all-namespaces``.
+
+Note that this feature is currently only supported on Ubuntu 18.04. For other OS, additional configuration might be needed.
 
 Validation of the Reference Implementation
 ===========================================
 
-Kuberef has been validated by running test cases defined in CNTT RC2 Cookbook.
-For setting up RC2 Conformance toolchain, please refer to `CNTT RC-2 Chapter 03 <https://github.com/cntt-n/CNTT/blob/master/doc/ref_cert/RC2/chapters/chapter03.md>`_.
+Kuberef is validated by running test cases defined in Anuket RC-2 Cookbook.
+For setting up RC-2 Conformance toolchain, please refer to `Anuket RC-2 Chapter 03 <https://cntt.readthedocs.io/en/latest/ref_cert/RC2/chapters/chapter03.html>`_.