From: Rihab Banday <rihab.banday@ericsson.com>
Date: Tue, 24 Nov 2020 09:57:06 +0000 (+0100)
Subject: Update documentation for Jerma release
X-Git-Tag: opnfv-10.0.0^0
X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?p=kuberef.git;a=commitdiff_plain;h=d3916f20f0b10da360cc6c38b61e1ee04d6278c5

Update documentation for Jerma release

This patch updates the content of documentation for the
upcoming OPNFV Jerma release.

Change-Id: I9618f2a14cfb85f464ca8817ac86d6b9e011ab1c
Signed-off-by: Rihab Banday <rihab.banday@ericsson.com>
Reviewed-on: https://gerrit.opnfv.org/gerrit/c/kuberef/+/71478
Tested-by: jenkins-ci <jenkins-opnfv-ci@opnfv.org>
Reviewed-by: Victor Morales <chipahuac@hotmail.com>
Reviewed-by: Michael Pedersen <michaelx.pedersen@intel.com>
---

diff --git a/docs/release/installation/deployment-guide.rst b/docs/release/installation/deployment-guide.rst
index 0875bcf..3ec8db5 100644
--- a/docs/release/installation/deployment-guide.rst
+++ b/docs/release/installation/deployment-guide.rst
@@ -9,14 +9,6 @@ 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
@@ -26,35 +18,31 @@ for the Kubernetes provisioning stage.
 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
+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>`_
 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:
+Additionally, please make note of the following:
 
-1. Add your configuration templates, ``pdf.yaml`` and ``idf.yaml`` under ``hw_config/<vendor>``.
+1. Ensure 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.
 
-2. Modify the environmental variables defined in ``deploy.env`` to match your setup.
+2. Generate SSH keypair.
 
-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.
+3. Add user to the sudo and libvirt group and have passwordless sudo enabled.
 
-.. note::
-
-    Depending on your setup, this script might not be needed. #WIP
+4. Install Ansible (tested with 2.9.14) and yq.
 
-Once ready, issue the following command to initiate the deployment
+Deployment
+=============================
 
-.. code-block:: bash
+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>`_
+for instructions to get started with the deployment.
 
-   ./deploy.sh
+Once the deployment is successful, you will have a fully functional RI-2 setup!
 
+Validation of the Reference Implementation
+===========================================
 
-Once the deployment is successful, you will have a fully functional RI-2 setup!
+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>`_.
diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst
index c592e8b..12d4d34 100644
--- a/docs/release/release-notes/release-notes.rst
+++ b/docs/release/release-notes/release-notes.rst
@@ -2,7 +2,16 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) OPNFV, Ericsson AB and others.
 
-Jerma Release
--------------
+OPNFV Jerma Release
+======================
 
-TBD
+This is the first release of the OPNFV Kuberef Project.
+
+* Framework for e2e RI2 deployment on bare-metal hosts (using Bifrost)
+  and on bare-metal hosts provided by Equinix Metal.
+
+* RC2 test suite integration
+
+* Configuration templates for Ericsson and Intel OPNFV Labs
+
+* Verified on Ubuntu 16.04 and CentOS 7