From 9f343782f79512bb6423c973f591dcc90b63ab6b Mon Sep 17 00:00:00 2001 From: kalyanreddy Date: Fri, 24 Mar 2017 18:41:29 +0530 Subject: Updating documents of D-release. This patch is used to update the documents of D-release. Change-Id: I9449536e340140f67e0f77ae4120bbc210809169 Co-Authored by:Srinivas Co-Authored by:RajithaY Co-Authored by:shravani paladugula Co-Authored by:Navya Bathula Signed-off-by: Gundarapu Kalyan Reddy (cherry picked from commit 1f4ef5ee33f715c03a85a868f12e89744f889cff) --- docs/installationprocedure/abstract.rst | 4 +- docs/installationprocedure/index.rst | 8 +-- .../kvm4nfv-cicd.installation.instruction.rst | 23 ++++++-- .../kvm4nfv-cicd.release.notes.rst | 61 ++++------------------ 4 files changed, 35 insertions(+), 61 deletions(-) (limited to 'docs/installationprocedure') diff --git a/docs/installationprocedure/abstract.rst b/docs/installationprocedure/abstract.rst index 853db170e..a53450eff 100644 --- a/docs/installationprocedure/abstract.rst +++ b/docs/installationprocedure/abstract.rst @@ -6,6 +6,6 @@ Abstract ******** -This document will give the user instructions on how to deploy available -KVM4NFV CICD build scenario verfied for the Danube release of the OPNFV +This document will give the instructions to user on how to deploy available +KVM4NFV build scenario verfied for the Danube release of the OPNFV platform. diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst index 4f9fa6949..9d75307f4 100644 --- a/docs/installationprocedure/index.rst +++ b/docs/installationprocedure/index.rst @@ -2,9 +2,11 @@ .. http://creativecommons.org/licenses/by/4.0 -********************************** -KVMforNFV Installation instruction -********************************** +.. _kvmfornfv-installation: + +******************************** +KVM4NFV Installation instruction +******************************** .. toctree:: :numbered: diff --git a/docs/installationprocedure/kvm4nfv-cicd.installation.instruction.rst b/docs/installationprocedure/kvm4nfv-cicd.installation.instruction.rst index ef6d32fc9..dedcca34f 100644 --- a/docs/installationprocedure/kvm4nfv-cicd.installation.instruction.rst +++ b/docs/installationprocedure/kvm4nfv-cicd.installation.instruction.rst @@ -2,9 +2,9 @@ .. http://creativecommons.org/licenses/by/4.0 -===================================== -KVM4NFV CICD Installation Instruction -===================================== +================================ +KVM4NFV Installation Instruction +================================ Preparing the installation -------------------------- @@ -17,7 +17,7 @@ HW requirements --------------- These build scripts are triggered on the Jenkins-Slave build server. Currently -Intel POD10 is used as test environment for kvmfornfv to execute cyclictest. As +Intel POD10 is used as test environment for kvm4nfv to execute cyclictest. As part of this test environment Intel pod10-jump is configured as jenkins slave and all the latest build artifacts are downloaded on to it. Intel pod10-node1 is the host on which a guest vm will be launched as a part of running cylictest @@ -67,6 +67,21 @@ the Rpms (on 'centos') and Debians (on 'ubuntu') builds in this case. For Kernel/Qemu RPMs and Debians, sh ./ci/build.sh -p both -o build_output +.. note:: Kvm4nfv can be installed in two ways + + 1. As part of a `scenario deployment`_ + 2. As a `stand alone`_ component + +.. _scenario deployment: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#document-scenarios/kvmfornfv.scenarios.description +.. _stand alone: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#build-instructions + +For installation of kvmfornfv as part of scenario deployment use this `link`_ + +.. code:: bash + + http://artifacts.opnfv.org/kvmfornfv/docs/index.html#document-scenarios/kvmfornfv.scenarios.description + + Installation instructions ------------------------- diff --git a/docs/installationprocedure/kvm4nfv-cicd.release.notes.rst b/docs/installationprocedure/kvm4nfv-cicd.release.notes.rst index 1913be8d7..415182bc7 100644 --- a/docs/installationprocedure/kvm4nfv-cicd.release.notes.rst +++ b/docs/installationprocedure/kvm4nfv-cicd.release.notes.rst @@ -8,12 +8,12 @@ Release Note for KVM4NFV CICD Abstract -======== +-------- This document contains the release notes for the Danube release of OPNFV when using KVM4NFV CICD process. Introduction -============ +------------ Provide a brief introduction of how this configuration is used in OPNFV release using KVM4VFV CICD as scenario. @@ -21,7 +21,7 @@ using KVM4VFV CICD as scenario. Be sure to reference your scenario installation instruction. Release Data -============ +------------ +--------------------------------------+--------------------------------------+ | **Project** | NFV Hypervisors-KVM | @@ -33,39 +33,19 @@ Release Data | **Release designation** | | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | | +| **Release date** | 2017-03-27 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | Automate the KVM4VFV CICD scenario | +| **Purpose of the delivery** | - Automate the KVM4VFV CICD scenario | +| | - Executing latency test cases | +| | - Collection of logs for debugging | | | | +--------------------------------------+--------------------------------------+ -Deliverables ------------- - -Software deliverables -~~~~~~~~~~~~~~~~~~~~~ -Kernel and Qemu- RPM and Debian build packages - -Documentation deliverables -~~~~~~~~~~~~~~~~~~~~~~~~~~ -- KVM4NFV CICD process documentation available under /docs/ under - various categories. - -Version change --------------- -.. This section describes the changes made since the last version of this -.. document. - -Module version change -~~~~~~~~~~~~~~~~~~~~~ -- Build scripts made available for Kernel rpm, Kernel deb, Qemu rpm, Qemu - deb packages. -- Releng scripts made available to trigger these kvm4nfv build scripts for - automating complete CICD process. Document version change -~~~~~~~~~~~~~~~~~~~~~~~ +----------------------- + The following documents are added- - configurationguide - installationprocedure @@ -100,26 +80,6 @@ Feature additions | | | +--------------------------------------+--------------------------------------+ -Bug corrections -~~~~~~~~~~~~~~~ - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | | -| | | -+--------------------------------------+--------------------------------------+ - - -Known Limitations, Issues and Workarounds -========================================= - -System Limitations ------------------- - Known issues ------------ @@ -131,9 +91,6 @@ Known issues +--------------------------------------+--------------------------------------+ | JIRA: | NFV Hypervisors-KVMFORNFV-75 | +--------------------------------------+--------------------------------------+ -| JIRA: | | -+--------------------------------------+--------------------------------------+ - Workarounds ----------- -- cgit 1.2.3-korg