summaryrefslogtreecommitdiffstats
path: root/docs/release/installationprocedure
diff options
context:
space:
mode:
authorkalyanreddy <reddyx.gundarapu@intel.com>2017-03-28 11:34:11 +0530
committerJiang, Yunhong <yunhong.jiang@intel.com>2017-03-28 14:27:51 +0000
commitb04935b08394a9b64b69429215e27f0323065bfa (patch)
treecf0d1e241a2d01a187e408d0cb52b5cf4c3c986e /docs/release/installationprocedure
parent9f343782f79512bb6423c973f591dcc90b63ab6b (diff)
Update documentation structure.
This patch is used to update documentation structure. Change-Id: I50d4ef4256ccfc57a0434123e7532a50000582cf Co-Authored by:Srinivas <srinivas.atmakuri@tcs.com> Co-Authored by:RajithaY<rajithax.yerrumsetty@intel.com> Co-Authored by:shravani paladugula <shravanix.paladugula@intel.com> Co-Authored by:Navya Bathula <navyax.bathula@intel.com> Signed-off-by: Gundarapu Kalyan Reddy <reddyx.gundarapu@intel.com> (cherry picked from commit f1f3cc27f23bdde81c37d8142d4288d811bd5e45)
Diffstat (limited to 'docs/release/installationprocedure')
-rw-r--r--docs/release/installationprocedure/abstract.rst11
-rw-r--r--docs/release/installationprocedure/index.rst16
-rw-r--r--docs/release/installationprocedure/kvm4nfv-cicd.installation.instruction.rst107
-rw-r--r--docs/release/installationprocedure/kvm4nfv-cicd.release.notes.rst103
4 files changed, 237 insertions, 0 deletions
diff --git a/docs/release/installationprocedure/abstract.rst b/docs/release/installationprocedure/abstract.rst
new file mode 100644
index 000000000..a53450eff
--- /dev/null
+++ b/docs/release/installationprocedure/abstract.rst
@@ -0,0 +1,11 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+.. http://creativecommons.org/licenses/by/4.0
+
+********
+Abstract
+********
+
+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/release/installationprocedure/index.rst b/docs/release/installationprocedure/index.rst
new file mode 100644
index 000000000..9d75307f4
--- /dev/null
+++ b/docs/release/installationprocedure/index.rst
@@ -0,0 +1,16 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+.. http://creativecommons.org/licenses/by/4.0
+
+.. _kvmfornfv-installation:
+
+********************************
+KVM4NFV Installation instruction
+********************************
+
+.. toctree::
+ :numbered:
+ :maxdepth: 2
+
+ abstract.rst
+ kvm4nfv-cicd.installation.instruction.rst
diff --git a/docs/release/installationprocedure/kvm4nfv-cicd.installation.instruction.rst b/docs/release/installationprocedure/kvm4nfv-cicd.installation.instruction.rst
new file mode 100644
index 000000000..dedcca34f
--- /dev/null
+++ b/docs/release/installationprocedure/kvm4nfv-cicd.installation.instruction.rst
@@ -0,0 +1,107 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+.. http://creativecommons.org/licenses/by/4.0
+
+================================
+KVM4NFV Installation Instruction
+================================
+
+Preparing the installation
+--------------------------
+
+The OPNFV project- KVM4NFV (https://gerrit.opnfv.org/gerrit/kvmfornfv.git) is
+cloned first, to make the build scripts for Qemu & Kernel, Rpms and Debians
+available.
+
+HW requirements
+---------------
+
+These build scripts are triggered on the Jenkins-Slave build server. Currently
+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
+through yardstick.
+
+Build instructions
+------------------
+
+Builds are possible for the following packages-
+
+**kvmfornfv source code**
+
+The ./ci/build.sh is the main script used to trigger
+the Rpms (on 'centos') and Debians (on 'ubuntu') builds in this case.
+
+* How to build Kernel/Qemu Rpms- To build rpm packages, build.sh script is run
+ with -p and -o option (i.e. if -p package option is passed as "centos" or in
+ default case). Example:
+
+.. code:: bash
+
+ cd kvmfornfv/
+
+ For Kernel/Qemu RPMs,
+ sh ./ci/build.sh -p centos -o build_output
+
+* How to build Kernel/Qemu Debians- To build debian packages, build.sh script
+ is run with -p and -o option (i.e. if -p package option is passed as
+ "ubuntu"). Example:
+
+.. code:: bash
+
+ cd kvmfornfv/
+
+ For Kernel/Qemu Debians,
+ sh ./ci/build.sh -p ubuntu -o build_output
+
+
+* How to build all Kernel & Qemu, Rpms & Debians- To build both debian and rpm
+ packages, build.sh script is run with -p and -o option (i.e. if -p package
+ option is passed as "both"). Example:
+
+.. code:: bash
+
+ cd kvmfornfv/
+
+ 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
+-------------------------
+
+Installation can be done in the following ways-
+
+**1. From kvmfornfv source code**-
+The build packages that are prepared in the above section, are installed
+differently depending on the platform.
+
+Please visit the links for each-
+
+* Centos : https://www.centos.org/docs/5/html/Deployment_Guide-en-US/s1-rpm-using.html
+* Ubuntu : https://help.ubuntu.com/community/InstallingSoftware
+
+**2. Using Fuel installer**-
+
+* Please refer to the document present at /fuel-plugin/README.md
+
+Post-installation activities
+----------------------------
+
+After the packages are built, test these packages by executing the scripts
+present in ci/envs for configuring the host and guest respectively.
diff --git a/docs/release/installationprocedure/kvm4nfv-cicd.release.notes.rst b/docs/release/installationprocedure/kvm4nfv-cicd.release.notes.rst
new file mode 100644
index 000000000..415182bc7
--- /dev/null
+++ b/docs/release/installationprocedure/kvm4nfv-cicd.release.notes.rst
@@ -0,0 +1,103 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+.. http://creativecommons.org/licenses/by/4.0
+
+=============================
+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.
+
+Be sure to reference your scenario installation instruction.
+
+Release Data
+------------
+
++--------------------------------------+--------------------------------------+
+| **Project** | NFV Hypervisors-KVM |
+| | |
++--------------------------------------+--------------------------------------+
+| **Repo/tag** | kvmfornfv |
+| | |
++--------------------------------------+--------------------------------------+
+| **Release designation** | |
+| | |
++--------------------------------------+--------------------------------------+
+| **Release date** | 2017-03-27 |
+| | |
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery** | - Automate the KVM4VFV CICD scenario |
+| | - Executing latency test cases |
+| | - Collection of logs for debugging |
+| | |
++--------------------------------------+--------------------------------------+
+
+
+Document version change
+-----------------------
+
+The following documents are added-
+ - configurationguide
+ - installationprocedure
+ - userguide
+ - overview
+ - glossary
+ - releasenotes
+
+Reason for new version
+----------------------
+
+Feature additions
+~~~~~~~~~~~~~~~~~
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE** | **SLOGAN** |
+| | |
++--------------------------------------+--------------------------------------+
+| JIRA: | NFV Hypervisors-KVMFORNFV-34 |
+| | |
++--------------------------------------+--------------------------------------+
+| JIRA: | NFV Hypervisors-KVMFORNFV-57 |
+| | |
++--------------------------------------+--------------------------------------+
+| JIRA: | NFV Hypervisors-KVMFORNFV-58 |
+| | |
++--------------------------------------+--------------------------------------+
+| JIRA: | NFV Hypervisors-KVMFORNFV-59 |
+| | |
++--------------------------------------+--------------------------------------+
+| JIRA: | NFV Hypervisors-KVMFORNFV-60 |
+| | |
++--------------------------------------+--------------------------------------+
+
+Known issues
+------------
+
+**JIRA TICKETS:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE** | **SLOGAN** |
+| | |
++--------------------------------------+--------------------------------------+
+| JIRA: | NFV Hypervisors-KVMFORNFV-75 |
++--------------------------------------+--------------------------------------+
+
+Workarounds
+-----------
+See JIRA: https://jira.opnfv.org/projects
+
+
+References
+==========
+For more information on the OPNFV Danube release, please visit
+http://www.opnfv.org/danube