summaryrefslogtreecommitdiffstats
path: root/docs/release
diff options
context:
space:
mode:
authorjulien zhang <zhang.jun3g@zte.com.cn>2017-02-28 07:24:24 +0000
committerGerrit Code Review <gerrit@opnfv.org>2017-02-28 07:24:24 +0000
commit9a2b86ff190a16822ec3f68b2c1d070d54a47da9 (patch)
tree7315aac40f9aed6c91f83429791f591b74e79cb3 /docs/release
parent69e33063b3703ae4529b556b63b3c4cc239c3d9a (diff)
parente243c1f9c40c5acee4fb89d99fae05f7a46768be (diff)
Merge "Release D doc update"
Diffstat (limited to 'docs/release')
-rw-r--r--docs/release/configguide/featureconfig.rst21
-rw-r--r--docs/release/configguide/index.rst12
-rw-r--r--docs/release/configguide/postinstall.rst38
-rw-r--r--docs/release/installation/index.rst11
-rw-r--r--docs/release/installation/installation.instruction.rst76
-rw-r--r--docs/release/release-notes/index.rst11
-rw-r--r--docs/release/release-notes/release-notes.rst233
-rw-r--r--docs/release/scenarios/scenario.name/index.rst16
-rw-r--r--docs/release/scenarios/scenario.name/scenario.description.rst39
-rw-r--r--docs/release/userguide/feature.userguide.rst184
-rw-r--r--docs/release/userguide/index.rst23
11 files changed, 664 insertions, 0 deletions
diff --git a/docs/release/configguide/featureconfig.rst b/docs/release/configguide/featureconfig.rst
new file mode 100644
index 0000000..a2db7a7
--- /dev/null
+++ b/docs/release/configguide/featureconfig.rst
@@ -0,0 +1,21 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+
+Parser configuration
+=====================
+Parser can be configured with any installer in current OPNFV, it only depends on
+openstack.
+
+Pre-configuration activities
+----------------------------
+For parser, there is not specific pre-configuration activities.
+
+Hardware configuration
+----------------------
+For parser, there is not hardware configuration needed for any current feature.
+
+Feature configuration
+---------------------
+For parser, there is not specific configure on openstack.
diff --git a/docs/release/configguide/index.rst b/docs/release/configguide/index.rst
new file mode 100644
index 0000000..7ee9b0f
--- /dev/null
+++ b/docs/release/configguide/index.rst
@@ -0,0 +1,12 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+**********************************
+OPNFV Parser Configuration Guide
+**********************************
+
+.. toctree::
+ :maxdepth: 1
+
+ featureconfig
+ postinstall
diff --git a/docs/release/configguide/postinstall.rst b/docs/release/configguide/postinstall.rst
new file mode 100644
index 0000000..53ffcbe
--- /dev/null
+++ b/docs/release/configguide/postinstall.rst
@@ -0,0 +1,38 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+*************************************
+Parser Post Installation Procedure
+*************************************
+
+Add a brief introduction to the methods of validating the installation
+according to this specific installer or feature.
+
+.. contents::
+ :depth: 3
+ :local:
+
+
+Automated post installation activities
+======================================
+Describe specific post installation activities performed by the OPNFV
+deployment pipeline including testing activities and reports. Refer to
+the relevant testing guides, results, and release notes.
+
+note: this section should be singular and derived from the test projects
+once we have one test suite to run for all deploy tools. This is not the
+case yet so each deploy tool will need to provide (hopefully very simillar)
+documentation of this.
+
+
+<Project> post configuration procedures
+=======================================
+Describe any deploy tool or feature specific scripts, tests or procedures
+that should be carried out on the deployment post install and configuration
+in this section.
+
+
+Platform components validation
+==============================
+Describe any component specific validation procedures necessary for your
+deployment tool in this section.
diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst
new file mode 100644
index 0000000..24deb84
--- /dev/null
+++ b/docs/release/installation/index.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
+
+***************************************
+OPNFV Parser Installation Instruction
+***************************************
+
+.. toctree::
+ :maxdepth: 1
+
+ installation.instruction
diff --git a/docs/release/installation/installation.instruction.rst b/docs/release/installation/installation.instruction.rst
new file mode 100644
index 0000000..3a1417a
--- /dev/null
+++ b/docs/release/installation/installation.instruction.rst
@@ -0,0 +1,76 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+Parser general configuration
+=====================
+Parser can be configured with any installer in current OPNFV.
+
+Pre-configuration activities
+-----------------------------
+For parser, there is not specific pre-configuration activities.
+
+Hardware configuration
+-----------------------
+For parser, there is not hardware configuration needed for this specific installer.
+
+Jumphost configuration
+-----------------------
+For parser, there is not intial Jumphost configuration (network and software)needed in order
+to deploy any installer.
+
+
+Parser tosca2heat configuration
+=====================
+For tosca2heat components(tosca-parser and heat-translator) in parser,there are not specific
+configuration of each component in installer.
+
+
+Parser yang2tosca configuration
+=====================
+Parser yang2tosca requires the following to be installed.
+
+1. PYANG
+--------
+
+Please follow the below installation steps.
+
+Step 1: Clone pyang tool or download the zip file from the following link.
+
+.. code-block:: bash
+
+ git clone https://github.com/mbj4668/pyang.git
+
+OR
+
+.. code-block:: bash
+
+ wget https://github.com/mbj4668/pyang/archive/master.zip
+
+Step 2: Change directory to the downloaded directory and run the setup file.
+
+.. code-block:: bash
+
+ cd pyang
+ python setup.py
+
+2. python-lxml
+--------------
+
+Please follow the below installation link. http://lxml.de/installation.html
+
+
+Parser policy2tosca configuration
+============================
+Parser - POLICY2TOSCA requires the following to be installed.
+
+1. cliff
+--------
+
+Install cliff with the following links.
+::
+- `install <http://docs.openstack.org/developer/cliff/install.html>`
+or
+- `demoapp <http://docs.openstack.org/developer/cliff/demoapp.html>
+
+
diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst
new file mode 100644
index 0000000..28dd0b6
--- /dev/null
+++ b/docs/release/release-notes/index.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
+
+****************************
+OPNFV Parser Release Notes
+****************************
+
+.. toctree::
+ :maxdepth: 1
+
+ release-notes
diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst
new file mode 100644
index 0000000..ead095c
--- /dev/null
+++ b/docs/release/release-notes/release-notes.rst
@@ -0,0 +1,233 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+This document provides the release notes for <RELEASE> of <COMPONENT>.
+
+.. contents::
+ :depth: 3
+ :local:
+
+
+Version history
+---------------
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date** | **Ver.** | **Author** | **Comment** |
+| | | | |
++--------------------+--------------------+--------------------+--------------------+
+| 2015-04-14 | 0.1.0 | Jonas Bjurel | First draft |
+| | | | |
++--------------------+--------------------+--------------------+--------------------+
+| | 0.1.1 | | |
+| | | | |
++--------------------+--------------------+--------------------+--------------------+
+| | 1.0 | | |
+| | | | |
++--------------------+--------------------+--------------------+--------------------+
+
+Important notes
+===============
+
+<STATE IMPORTANT NOTES/DEVIATIONS SINCE PREVIOUS ITERATIVE RELEASE AND OTHER IMPORTANT NOTES FOR THIS RELEASE>
+
+<EXAMPLE>:
+
+**Attention:** Please be aware that since LSV3 a pre-deploy script must be ran on the Fuel master -
+see the OPNFV@Fuel SW installation instructions
+
+
+Summary
+=======
+
+<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
+
+<EXAMPLE>:
+
+Arno Fuel@OPNFV is based the OpenStack Fuel upstream project version 6.0.1,
+but adds OPNFV unique components such as OpenDaylight version: Helium as well as other OPNFV unique configurations......
+
+
+Release Data
+============
+<STATE RELEVANT RELEASE DATA/RECORDS>
+
+<EXAMPLE>:
+
++--------------------------------------+--------------------------------------+
+| **Project** | E.g. Arno/genesis/fuel@opnfv |
+| | |
++--------------------------------------+--------------------------------------+
+| **Repo/commit-ID** | E.g. genesis/adf634a0d4..... |
+| | |
++--------------------------------------+--------------------------------------+
+| **Release designation** | E.g. Arno RC2 |
+| | |
++--------------------------------------+--------------------------------------+
+| **Release date** | E.g. 2015-04-16 |
+| | |
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery** | E.g. OPNFV Internal quality assurance|
+| | |
++--------------------------------------+--------------------------------------+
+
+Version change
+^^^^^^^^^^^^^^^^
+
+Module version changes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+<STATE WHAT UPSTREAM, - AS WELL AS OPNFV MODULE VERSIONS HAVE CHANGED>
+
+<EXAMPLE>:
+
+- Fuel have changed from 5.1 to 6.0.1
+
+- OpenDaylight has changed from Helium-SR1 to Helium-SR2
+
+Document version changes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+<STATE WHAT RELATED DOCUMENTS THAT CHANGES WITH THIS RELEASE>
+
+<EXAMPLE>:
+
+- The Fuel@OPNFV installation guide version has changed from version 0.1 to to 0.2
+
+Reason for version
+^^^^^^^^^^^^^^^^^^^^
+Feature additions
+~~~~~~~~~~~~~~~~~~~~~~~
+<STATE ADDED FEATURES BY REFERENCE TO JIRA>
+
+<EXAMPLE>:
+
+**JIRA BACK-LOG:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE** | **SLOGAN** |
+| | |
++--------------------------------------+--------------------------------------+
+| BGS-123 | ADD OpenDaylight ml2 integration |
+| | |
++--------------------------------------+--------------------------------------+
+| BGS-456 | Add auto-deployment of Fuel@OPNFV |
+| | |
++--------------------------------------+--------------------------------------+
+
+Bug corrections
+~~~~~~~~~~~~~~~~~~~~~
+
+**JIRA TICKETS:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE** | **SLOGAN** |
+| | |
++--------------------------------------+--------------------------------------+
+| BGS-888 | Fuel doesn't deploy |
+| | |
++--------------------------------------+--------------------------------------+
+| BGS-999 | Floating IP doesn't work |
+| | |
++--------------------------------------+--------------------------------------+
+
+Deliverables
+----------------
+
+Software deliverables
+^^^^^^^^^^^^^^^^^^^^^^^
+
+<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
+
+<EXAMPLE>:
+
+Documentation deliverables
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
+
+<EXAMPLE>:
+
+
+Known Limitations, Issues and Workarounds
+=========================================
+
+System Limitations
+^^^^^^^^^^^^^^^^^^^^
+<STATE ALL RELEVANT SYSTEM LIMITATIONS>
+
+<EXAMPLE>:
+
+**Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades
+
+**Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade
+
+**Storage:** Ceph is the only supported storage configuration.
+
+**Max number of networks:** 3800 (Needs special switch config.)
+
+**L3Agent:** L3 agent and floating IPs is not supported.
+
+Known issues
+^^^^^^^^^^^^^^^
+<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
+
+<EXAMPLE>:
+
+**JIRA TICKETS:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE** | **SLOGAN** |
+| | |
++--------------------------------------+--------------------------------------+
+| BGS-987 | Nova-compute process does |
+| | not re-spawn when killed |
+| | |
++--------------------------------------+--------------------------------------+
+| BGS-654 | MOS 5.1 : neutron net-list returns |
+| | "400 Bad request" |
+| | |
++--------------------------------------+--------------------------------------+
+
+Workarounds
+^^^^^^^^^^^^^^^^^
+
+<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE>
+
+<EXAMPLE>:
+
+- In case the contact with a compute is lost - restart the compute host
+- In case the disk is full on a controller - delete all files in /tmp
+
+Test Result
+===========
+<STATE THE QA COVERAGE AND RESULTS>
+
+<EXAMPLE>:
+
+Fuel@OPNFV Arno RC2 has undergone QA test runs with the following results:
+
++--------------------------------------+--------------------------------------+
+| **TEST-SUITE** | **Results:** |
+| | |
++--------------------------------------+--------------------------------------+
+| Tempest test suite 123 | Following tests failed: |
+| | |
+| | 1. Image resizing.... |
+| | |
+| | 2. Heat deploy.... |
++--------------------------------------+--------------------------------------+
+| Robot test suite 456 | Following tests failed: |
+| | |
+| | 1....... |
+| | |
+| | 2....... |
++--------------------------------------+--------------------------------------+
+
+References
+==========
+<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
+
+<EXAMPLE>:
+
+For more information on the OPNFV Danube release, please see:
+
+http://opnfv.org/danube
diff --git a/docs/release/scenarios/scenario.name/index.rst b/docs/release/scenarios/scenario.name/index.rst
new file mode 100644
index 0000000..a857e62
--- /dev/null
+++ b/docs/release/scenarios/scenario.name/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
+
+
+****************************************
+<scenario name> overview and description
+****************************************
+.. This document will be used to provide a description of the scenario for an end user.
+.. You should explain the purpose of the scenario, the types of capabilities provided and
+.. the unique components that make up the scenario including how they are used.
+
+.. toctree::
+ :maxdepth: 1
+
+ scenario.description
+
diff --git a/docs/release/scenarios/scenario.name/scenario.description.rst b/docs/release/scenarios/scenario.name/scenario.description.rst
new file mode 100644
index 0000000..8c2cbab
--- /dev/null
+++ b/docs/release/scenarios/scenario.name/scenario.description.rst
@@ -0,0 +1,39 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+This document provides scenario level details for <RELEASE> of <COMPONENT>.
+
+.. contents::
+ :depth: 3
+ :local:
+
+============
+Introduction
+============
+.. In this section explain the purpose of the scenario and the types of capabilities provided
+
+Scenario components and composition
+===================================
+.. In this section describe the unique components that make up the scenario,
+.. what each component provides and why it has been included in order
+.. to communicate to the user the capabilities available in this scenario.
+
+Scenario usage overview
+=======================
+.. Provide a brief overview on how to use the scenario and the features available to the
+.. user. This should be an "introduction" to the userguide document, and explicitly link to it,
+.. where the specifics of the features are covered including examples and API's
+
+Limitations, Issues and Workarounds
+===================================
+.. Explain scenario limitations here, this should be at a design level rather than discussing
+.. faults or bugs. If the system design only provide some expected functionality then provide
+.. some insight at this point.
+
+References
+==========
+
+For more information on the OPNFV Danube release, please visit
+http://www.opnfv.org/danube
+
diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst
new file mode 100644
index 0000000..c42330c
--- /dev/null
+++ b/docs/release/userguide/feature.userguide.rst
@@ -0,0 +1,184 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+Parser tosca2heat Installation
+============================
+
+Please follow the below installation steps to install tosca2heat submodule in parser.
+
+Step 1: Clone the parser project.
+
+.. code-block:: bash
+
+ git clone https://gerrit.opnfv.org/gerrit/parser
+
+Step 2: Install the heat-translator sub project.
+
+.. code-block:: bash
+
+ # uninstall pre-installed tosca-parser
+ pip uninstall -y heat-translator
+
+ # change directory to heat-translator
+ cd parser/tosca2heat/heat-translator
+
+ # install requirements
+ pip install -r requirements.txt
+
+ # install heat-translator
+ python setup.py install
+
+Step 3: Install the tosca-parser sub project.
+
+.. code-block:: bash
+
+ # uninstall pre-installed tosca-parser
+ pip uninstall -y tosca-parser
+
+ # change directory to tosca-parser
+ cd parser/tosca2heat/tosca-parser
+
+ # install requirements
+ pip install -r requirements.txt
+
+ # install tosca-parser
+ python setup.py install
+
+
+ **Notes** It must uninstall pre-installed tosca-parser and heat-translator before install the two
+ components, and install heat-translator before installing tosca-parser, which is sure to use the
+ OPNFV version of tosca-parser and heat-translator other than openstack's components.
+
+Parser tosca2heat Execution
+===========================
+
+Step 1: Change directory to where the tosca yaml files are present, example is
+below with vRNC definiton.
+
+.. code-block:: bash
+
+ cd parser/tosca2heat/tosca-parser/toscaparser/extensions/nfv/tests/data/vRNC/Definitions
+
+
+Step 2: Run the python command heat-translator with the TOSCA yaml file as an input option.
+
+.. code-block:: bash
+
+ heat-translator --template-file=<input file> --template-type=tosca
+ --outpurt-file=<output hot file>
+
+Example:
+
+.. code-block:: bash
+
+ heat-translator --template-file=vRNC.yaml \
+ --template-type=tosca --output-file=vRNC_hot.yaml
+
+Notes: heat-translator will call class of ToscaTemplate in tosca-parser firstly to validate and
+parse input yaml file, then tranlate the file into hot file, if you only want to validate or
+check the input file and don't want to translate, please use tosaca-parser as following:
+
+.. code-block:: bash
+
+ tosca-parser --template-file=<input yaml file>
+
+Example:
+
+.. code-block:: bash
+
+ tosca-parser --template-file=vRNC.yaml
+
+Parser tosca2heat References
+===========================
+Refer two upstream components:
+ https://github.com/openstack/tosca-parser/blob/master/doc/source/usage.rst
+ https://github.com/openstack/heat-translator/blob/master/doc/source/usage.rst
+
+
+
+
+Parser yang2tosca Execution
+============================
+
+Step 1: Change directory to where the scripts are present.
+
+.. code-block:: bash
+
+ cd parser/yang2tosca
+
+Step 2: Copy the YANG file which needs to be converted into TOSCA to
+ current (parser/yang2tosca) folder.
+
+Step 3: Run the python script "parser.py" with the YANG file as an input option.
+
+.. code-block:: bash
+
+ python parser.py -n "YANG filename"
+
+Example:
+
+.. code-block:: bash
+
+ python parser.py -n example.yaml
+
+Step 4: Verify the TOSCA YAMl which file has been created with the same name
+ as the YANG file with a “_tosca” suffix.
+
+.. code-block:: bash
+
+ cat "YANG filename_tosca.yaml"
+
+Example:
+
+.. code-block:: bash
+
+ cat example_tosca.yaml
+
+
+
+
+
+Parser policy2tosca Execution
+============================
+
+Step 1: To see a list of commands available.
+
+.. code-block:: bash
+
+ policy2tosca --help
+
+Step 2: To see help for an individual command, include the command name on the command line
+
+.. code-block:: bash
+
+ policy2tosca help <service>
+
+Step 3: To inject/remove policy types/policy definitions provide the TOSCA file as input to
+policy2tosca command line.
+
+.. code-block:: bash
+
+ policy2tosca <service> [arguments]
+
+Example:
+
+.. code-block:: bash
+
+ policy2tosca add-definition --policy_name rule2 --policy_type tosca.policies.Placement.Geolocation
+--description "test description" --properties region:us-north-1,region:us-north-2,min_inst:2 --targets
+VNF2,VNF4 --metadata "map of strings" --triggers "1,2,3,4" --source example.yaml
+
+
+Step 4: Verify the TOSCA YAMl updated with the injection/removal executed.
+
+.. code-block:: bash
+
+ cat "<source tosca file>"
+
+Example:
+
+.. code-block:: bash
+
+ cat example_tosca.yaml
+
diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst
new file mode 100644
index 0000000..87059c9
--- /dev/null
+++ b/docs/release/userguide/index.rst
@@ -0,0 +1,23 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+=======================
+OPNFV Parser User Guide
+=======================
+
+.. The feature user guide should provide an OPNFV user with enough information to
+.. use the features provided by the feature project in the supported scenarios.
+.. This guide should walk a user through the usage of the features once a scenario
+.. has been deployed and is active according to the installation guide provided
+.. by the installer project.
+
+.. toctree::
+ :maxdepth: 1
+
+ feature.userguide
+.. The feature.userguide.rst file should contain the text for this document
+.. additional documents can be added to this directory and added in the right order
+.. to this file as a list below.
+
+