summaryrefslogtreecommitdiffstats
path: root/docs/release/installationprocedure
diff options
context:
space:
mode:
authorkalyanreddy <reddyx.gundarapu@intel.com>2017-03-28 13:18:51 -0700
committerkalyanreddy <reddyx.gundarapu@intel.com>2017-03-28 14:09:33 -0700
commit3a2eb75a5ba494161655c84a23d11eb9f6a797e9 (patch)
tree1283df921b716636fc03fd2ffb03888ff614802a /docs/release/installationprocedure
parentc1a17f3ad621173a68ad6b083638b0b477c9af6a (diff)
Update documentation structure.
This patch includes adjusting docs directory structure for kvmfornfv project. Change-Id: Ic2f992cd5e8f6808ca3ba088172eb6da342182ba Signed-off-by: Gundarapu Kalyan Reddy <reddyx.gundarapu@intel.com>
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, 0 insertions, 237 deletions
diff --git a/docs/release/installationprocedure/abstract.rst b/docs/release/installationprocedure/abstract.rst
deleted file mode 100644
index a53450eff..000000000
--- a/docs/release/installationprocedure/abstract.rst
+++ /dev/null
@@ -1,11 +0,0 @@
-.. 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
deleted file mode 100644
index 9d75307f4..000000000
--- a/docs/release/installationprocedure/index.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-.. 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
deleted file mode 100644
index dedcca34f..000000000
--- a/docs/release/installationprocedure/kvm4nfv-cicd.installation.instruction.rst
+++ /dev/null
@@ -1,107 +0,0 @@
-.. 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
deleted file mode 100644
index 415182bc7..000000000
--- a/docs/release/installationprocedure/kvm4nfv-cicd.release.notes.rst
+++ /dev/null
@@ -1,103 +0,0 @@
-.. 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