diff options
Diffstat (limited to 'docs')
35 files changed, 620 insertions, 329 deletions
diff --git a/docs/parser_docs/tosca2heat/examples/Simple_RNC.yaml b/docs/developer/design/examples/Simple_RNC.yaml index 281b064..281b064 100644 --- a/docs/parser_docs/tosca2heat/examples/Simple_RNC.yaml +++ b/docs/developer/design/examples/Simple_RNC.yaml diff --git a/docs/parser_docs/tosca2heat/examples/Simple_RNC_definition.yaml b/docs/developer/design/examples/Simple_RNC_definition.yaml index 7478d98..7478d98 100644 --- a/docs/parser_docs/tosca2heat/examples/Simple_RNC_definition.yaml +++ b/docs/developer/design/examples/Simple_RNC_definition.yaml diff --git a/docs/parser_docs/tosca2heat/examples/TOSCA_nfv_definition_1_0.yaml b/docs/developer/design/examples/TOSCA_nfv_definition_1_0.yaml index c535144..c535144 100644 --- a/docs/parser_docs/tosca2heat/examples/TOSCA_nfv_definition_1_0.yaml +++ b/docs/developer/design/examples/TOSCA_nfv_definition_1_0.yaml diff --git a/docs/parser_docs/yang2tosca/clearwater_tosca.yaml b/docs/developer/design/examples/clearwater_tosca.yaml index 2b4dd52..2b4dd52 100644 --- a/docs/parser_docs/yang2tosca/clearwater_tosca.yaml +++ b/docs/developer/design/examples/clearwater_tosca.yaml diff --git a/docs/parser_docs/images/vRNC_Definition.png b/docs/developer/design/images/vRNC_Definition.png Binary files differindex 84d25e3..84d25e3 100644 --- a/docs/parser_docs/images/vRNC_Definition.png +++ b/docs/developer/design/images/vRNC_Definition.png diff --git a/docs/parser_docs/images/vRNC_Topology.png b/docs/developer/design/images/vRNC_Topology.png Binary files differindex e4f04f1..e4f04f1 100644 --- a/docs/parser_docs/images/vRNC_Topology.png +++ b/docs/developer/design/images/vRNC_Topology.png diff --git a/docs/parser_docs/index.rst b/docs/developer/design/index.rst index 97d22db..ab83cec 100644 --- a/docs/parser_docs/index.rst +++ b/docs/developer/design/index.rst @@ -1,16 +1,15 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -************** -Parser Project -************** +********************************* +OPNFV Parser Design Documentation +********************************* .. toctree:: :numbered: :maxdepth: 6 - intro/intro.rst - yang2tosca/yang2tosca.rst - policy2tosca/policy2tosca.rst - tosca2heat/parser_new_keywords.rst + yang2tosca.rst + policy2tosca.rst + parser_new_keywords.rst vRNC_tosca_intro.rst diff --git a/docs/parser_docs/tosca2heat/parser_new_keywords.rst b/docs/developer/design/parser_new_keywords.rst index f430b1d..f430b1d 100644 --- a/docs/parser_docs/tosca2heat/parser_new_keywords.rst +++ b/docs/developer/design/parser_new_keywords.rst diff --git a/docs/parser_docs/policy2tosca/policy2tosca.rst b/docs/developer/design/policy2tosca.rst index fa238b2..fa238b2 100644 --- a/docs/parser_docs/policy2tosca/policy2tosca.rst +++ b/docs/developer/design/policy2tosca.rst diff --git a/docs/developer/design/vRNC_tosca_intro.rst b/docs/developer/design/vRNC_tosca_intro.rst new file mode 100644 index 0000000..11e1bdb --- /dev/null +++ b/docs/developer/design/vRNC_tosca_intro.rst @@ -0,0 +1,166 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +====================================== +OPNFV Parser tosca2heat - New Keywords +====================================== + +1.NFV-tosca new keywords +------------------------ + +All keywords in nfv tosca are not implemented in code, and will be +implemented by parser. + +1.1 Nodes types +~~~~~~~~~~~~~~~ + +Basic types +^^^^^^^^^^^ + +* tosca.nodes.nfv.VDU +* tosca.nodes.nfv.CP +* tosca.nodes.nfv.VL + +Extend types +^^^^^^^^^^^^ + +* tosca.nodes.nfv.VL.ELine +* tosca.nodes.nfv.VL.ELAN +* tosca.nodes.nfv.VL.ETree +* tosca.nodes.nfv.FP + +1.2 Capability types +~~~~~~~~~~~~~~~~~~~~ + +Basic types +^^^^^^^^^^^ + +* tosca.capabilities.nfv.VirtualBindable +* tosca.capabilities.nfv.VirtualLinkable +* tosca.capabilities.nfv.HA.ActiveActive +* tosca.capabilities.nfv.HA.ActivePassive +* tosca.capabilities.nfv.Metric + +Extend types +^^^^^^^^^^^^ + +* tosca.capabilities.nfv.Forwarder +* tosca.capabilities.nfv.CPU\_extension +* tosca.capabilities.nfv.Memory\_extension +* tosca.capabilities.nfv.Hypervisors +* tosca.capabilities.nfv.PCIe +* tosca.capabilities.nfv.network.Interfaces +* tosca.capabilities.nfv.network.Virtual\_switches +* tosca.capabilities.nfv.Storage + +1.3 Relationship types +~~~~~~~~~~~~~~~~~~~~~~ + +Basic types +^^^^^^^^^^^ + +* tosca.relationships.nfv.VirtualBindsTo +* tosca.relationships.nfv.VirtualLinksTo +* tosca.relationships.nfv.HA +* tosca.relationships.nfv.Monitor + +Extend types +^^^^^^^^^^^^ + +* tosca.relationships.nfv.ForwardsTo + +1.4 Group Types +~~~~~~~~~~~~~~~ + +* tosca.groups.nfv.VNFFG + +2.Simple-tosca new keywords +--------------------------- + +Some keywords are only defined in tosca simple profile,but are not +supported in tosca-paser, and some keywords such as "policy type", are not yet defined +completely so far. + +2.1 topology template keyname +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +* "substitution\_mappings" syntax + + An optional declaration that exports the topology template as an + impletmentation of a node type, which is not supported by tosca-parser. + +2.2 Group types +~~~~~~~~~~~~~~~ + +Basic types +^^^^^^^^^^^ + +* tosca.group.root + +2.3 Policy Types +~~~~~~~~~~~~~~~~ + +Basic types +^^^^^^^^^^^ + +* tosca.policies.Root +* tosca.policies.Placement +* tosca.policies.Scaling + +Extend types +^^^^^^^^^^^^ + +* tosca.policies.Update +* tosca.policies.Performance +* tosca.policy.placement.Antilocate +* tosca.policy.placement.Colocate + + +======================================= +OPNFV Parser tosca2heat - vRNC Topology +======================================= + +The simple vRNC topology is shown below: :numref:`figure_topo` + +.. figure:: images/vRNC_Topology.png + :name: figure_topo + :width: 100% + + vRNC Topology + +- vRNC includes four networks: EMS\_network, CTRL\_network, + Intermedia\_network and extermedia\_network; +- vRNC includes four node types: MM, LB, CM and DM; +- MM: Stands for Maintain Module, which links to EMS\_network, + CTRL\_network and extermedia\_network. It composes of active vdu and + standby vdu. +- CM: Stands for Control Module, which links to CTRL\_network and + intermedia\_network. All CM nodes form resource pool and each node + composes of active vdu and standby vdu. +- DM: Stands for Data Module, which links to CTRL\_network and + intermedia\_network. All DM nodes form resource pool and each node is + a vdu. +- LB: Stands for LineCard Module, which links to CTRL\_network and + intermedia\_network and extermedia\_network. All LB nodes form + resource pool and each node is a vdu. + +========================================= +OPNFV Parser tosca2heat - vRNC Definition +========================================= + +The files dependency and correspoding specificaiton of vRNC definition +are shown below: :numref:`figure_def` + +.. figure:: images/vRNC_Definition.png + :name: figure_def + :width: 100% + + vRNC Definition + +- TOSCA\_definition\_1.0.yaml should be the lastest version, which is + updated by tosca-parser community, but some keywords (such as + substitution\_mappings) in the correspoding standard of + "TOSCA-simple-profile-YAML-v1.0" is not supported. +- TOSCA\_nfv\_definition\_1.0.yaml is a new file, and not implemented + in code, and the correspoding standard of + "tosca-nfv-v1.0-wd02-rev02" is not complete now. diff --git a/docs/parser_docs/yang2tosca/yang2tosca.rst b/docs/developer/design/yang2tosca.rst index 5aaf463..5aaf463 100644 --- a/docs/parser_docs/yang2tosca/yang2tosca.rst +++ b/docs/developer/design/yang2tosca.rst diff --git a/docs/developer/overview/index.rst b/docs/developer/overview/index.rst new file mode 100644 index 0000000..aff89d9 --- /dev/null +++ b/docs/developer/overview/index.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 + +============================================= +OPNFV Parser Danube Overview +============================================= + + +.. toctree:: + :maxdepth: 1 + + overview diff --git a/docs/parser_docs/intro/intro.rst b/docs/developer/overview/overview.rst index af0c358..d1cad64 100644 --- a/docs/parser_docs/intro/intro.rst +++ b/docs/developer/overview/overview.rst @@ -1,9 +1,16 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -============================== -Introduction of Parser Project -============================== +========================================= +OPNFV Parser Danube Overview Doumentation +========================================= + +.. contents:: + :depth: 3 + :local: + +Introduction +--------------- In NFV, various templates (such as descriptors, records and so on) are utilized to describe the deployment requirements (such as basic VM requirements – vCPU, @@ -19,7 +26,10 @@ operators’ descriptors/records into TOSCA/CAMP templates and then further translate TOSCA/CAMP templates into certain common templates, which could be used in IaaS orchestration projects like OpenStack Heat. -For Release B, Parser offers the following capabilities: +Upgrades from Arno +------------------------ + +For Release B, Parser offers the following additional capabilities: * Integration of Heat-Translator Liberty release code. (both heat in-tree code and standalone package are provided) @@ -39,7 +49,10 @@ For Release B, Parser offers the following capabilities: The "example" folder contains examples of tosca-nfv standard and vRNC scenario. See also https://wiki.opnfv.org/parser. -For Release C, Parser offers additional capabilities: +Upgrades from Brumapatra +----------------------- + +For Release C, Parser offers the following additional capabilities: * Policy2Tosca module which enables policy related fields in tosca could be translated into heat orchestration template correctly. Policy2Tosca module could be installed seperately @@ -69,3 +82,8 @@ main details are listed below: * Additional testing support. +Upgrades from Colorado +---------------------- + +For Release D, Parser offers the following additional capabilities: + diff --git a/docs/developer/requirements/index.rst b/docs/developer/requirements/index.rst new file mode 100644 index 0000000..7eddaae --- /dev/null +++ b/docs/developer/requirements/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 Danube Requirements +******************************** + +.. toctree:: + :maxdepth: 1 + + diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/installationprocedure/feature.configuration.rst deleted file mode 100644 index 86d7dfa..0000000 --- a/docs/installationprocedure/feature.configuration.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. 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> - - -Abstract -======== -This document provides information on how to configure required -components during the installation of the platform. diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst deleted file mode 100644 index 1eb7461..0000000 --- a/docs/installationprocedure/index.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International -.. License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Ericsson AB and others. - -******************************************** -Parser Configuration and Configuration Guide -******************************************** -Parser is an open source project and licensed under Apache 2. Parser will help -to provide a tooling mechanism, by parsing and then further translating Telecom -operators deployment descriptors into certain common templates, which could be -used in IaaS orchestration projects like OpenStack Heat(the template file is HOT, -which stands for Heat Orchestrator Template). - -This document contains configuration guide for Parser's three submodules: tosca2heat, -yang2tosca and policy2tosca. Users please refer to user guide for installation and execution -which usually happens after configuration. - - - -.. toctree:: - :numbered: - :maxdepth: 2 - -.. include:: featureconfig.rst -.. include:: installerconfig.rst diff --git a/docs/installationprocedure/policy2tosca.rst b/docs/installationprocedure/policy2tosca.rst deleted file mode 100644 index d6e2348..0000000 --- a/docs/installationprocedure/policy2tosca.rst +++ /dev/null @@ -1,44 +0,0 @@ -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or -# implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -Prerequisites -============= - -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>` - -Installation -============================ - -Please follow the below installation steps to install parser - POLICY2TOSCA. - -Step 1: Clone the parser project. - -.. code-block:: bash - - git clone https://gerrit.opnfv.org/gerrit/parser - -Step 2: Install the policy2tosca module. - -.. code-block:: bash - - cd parser/policy2tosca - python setup.py install diff --git a/docs/installationprocedure/yang2tosca.rst b/docs/installationprocedure/yang2tosca.rst deleted file mode 100644 index 8f4ef91..0000000 --- a/docs/installationprocedure/yang2tosca.rst +++ /dev/null @@ -1,58 +0,0 @@ -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or -# implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -Prerequisites -============= - -Parser 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 - - -Installation -============================ - -Please follow the below installation steps to install parser. - -Step 1: Clone the parser project. - -.. code-block:: bash - - git clone https://gerrit.opnfv.org/gerrit/parser diff --git a/docs/parser_docs/vRNC_tosca_intro.rst b/docs/parser_docs/vRNC_tosca_intro.rst deleted file mode 100644 index 5e33ad3..0000000 --- a/docs/parser_docs/vRNC_tosca_intro.rst +++ /dev/null @@ -1,50 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -================ -1. vRNC Topology -================ - -The simple vRNC topology is shown below: :numref:`figure_topo` - -.. figure:: images/vRNC_Topology.png - :name: figure_topo - :width: 100% - - vRNC Topology - -- vRNC includes four networks: EMS\_network, CTRL\_network, - Intermedia\_network and extermedia\_network; -- vRNC includes four node types: MM, LB, CM and DM; -- MM: Stands for Maintain Module, which links to EMS\_network, - CTRL\_network and extermedia\_network. It composes of active vdu and - standby vdu. -- CM: Stands for Control Module, which links to CTRL\_network and - intermedia\_network. All CM nodes form resource pool and each node - composes of active vdu and standby vdu. -- DM: Stands for Data Module, which links to CTRL\_network and - intermedia\_network. All DM nodes form resource pool and each node is - a vdu. -- LB: Stands for LineCard Module, which links to CTRL\_network and - intermedia\_network and extermedia\_network. All LB nodes form - resource pool and each node is a vdu. - -2. vRNC Definition -================== - -The files dependency and correspoding specificaiton of vRNC definition -are shown below: :numref:`figure_def` - -.. figure:: images/vRNC_Definition.png - :name: figure_def - :width: 100% - - vRNC Definition - -- TOSCA\_definition\_1.0.yaml should be the lastest version, which is - updated by tosca-parser community, but some keywords (such as - substitution\_mappings) in the correspoding standard of - "TOSCA-simple-profile-YAML-v1.0" is not supported. -- TOSCA\_nfv\_definition\_1.0.yaml is a new file, and not implemented - in code, and the correspoding standard of - "tosca-nfv-v1.0-wd02-rev02" is not complete now. diff --git a/docs/installationprocedure/featureconfig.rst b/docs/release/configguide/featureconfig.rst index dc4fc50..a2db7a7 100644 --- a/docs/installationprocedure/featureconfig.rst +++ b/docs/release/configguide/featureconfig.rst @@ -1,6 +1,7 @@ .. 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 configuration ===================== 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/installationprocedure/installerconfig.rst b/docs/release/installation/installation.instruction.rst index 1f796b2..3a1417a 100644 --- a/docs/installationprocedure/installerconfig.rst +++ b/docs/release/installation/installation.instruction.rst @@ -1,6 +1,6 @@ .. 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 general configuration ===================== 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/userguide/featureusage.rst b/docs/release/userguide/feature.userguide.rst index c42330c..c42330c 100644 --- a/docs/userguide/featureusage.rst +++ b/docs/release/userguide/feature.userguide.rst 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. + + diff --git a/docs/testing/index.rst b/docs/testing/index.rst new file mode 100644 index 0000000..99c2cfd --- /dev/null +++ b/docs/testing/index.rst @@ -0,0 +1,14 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 + + +============================================= +OPNFV Parser Danube Overview +============================================= + + +.. toctree:: + :maxdepth: 1 + + testusage diff --git a/docs/userguide/testusage.rst b/docs/testing/testusage.rst index 47f37f1..405d6bd 100644 --- a/docs/userguide/testusage.rst +++ b/docs/testing/testusage.rst @@ -1,6 +1,6 @@ .. 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 test usage =========================== diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst deleted file mode 100644 index 938f9c6..0000000 --- a/docs/userguide/index.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International -.. License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Ericsson AB and others. - -================= -Parser User Guide -================= -Parser is an open source project and licensed under Apache 2. Parser will help -to provide a tooling mechanism, by parsing and then further translating Telecom -operators deployment descriptors into certain common templates, which could be -used in IaaS orchestration projects like OpenStack Heat(the template file is HOT, -which stands for Heat Orchestrator Template). - -This document contains installation guide , execution guide as well as testing guide -for Parser's three submodules: tosca2heat, yang2tosca and policy2tosca. - - -Contents: - -.. toctree:: - :numbered: - :maxdepth: 2 - -.. include:: featureusage.rst -.. include:: testusage.rst diff --git a/docs/userguide/policy2tosca.rst b/docs/userguide/policy2tosca.rst deleted file mode 100644 index 3f4f2e7..0000000 --- a/docs/userguide/policy2tosca.rst +++ /dev/null @@ -1,52 +0,0 @@ -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or -# implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -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/userguide/yang2tosca.rst b/docs/userguide/yang2tosca.rst deleted file mode 100644 index 4708c9a..0000000 --- a/docs/userguide/yang2tosca.rst +++ /dev/null @@ -1,49 +0,0 @@ -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or -# implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -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 |
