Add docs

JIRA: AUTO-29

On behalf of Gerard Damm to commit his codes.
Keep docs in auto/docs.

Change-Id: Ibf7008d51332af3bdd1176cfe5fccb95714e446e
Signed-off-by: Harry Huang <huangxiangyu5@huawei.com>

diff --git a/docs/release/installation/UC01-installation.instruction.rst b/docs/release/installation/UC01-installation.instruction.rst
new file mode 100644 (file)
index 0000000..9ecb8bd
--- /dev/null
+++ b/docs/release/installation/UC01-installation.instruction.rst
@@ -0,0 +1,212 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
+.. http://creativecommons.org/licenses/by/4.0\r
+.. SPDX-License-Identifier CC-BY-4.0\r
+.. (c) optionally add copywriters name\r
+\r
+========\r
+Abstract\r
+========\r
+\r
+This document describes how to install OPNFV Auto Use Case 1: Edge Cloud, its dependencies and required system resources.\r
+\r
+.. contents::\r
+   :depth: 3\r
+   :local:\r
+\r
+Version history\r
+---------------------\r
+\r
++--------------------+--------------------+--------------------+--------------------+\r
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |\r
+|                    |                    |                    |                    |\r
++--------------------+--------------------+--------------------+--------------------+\r
+| 2015-04-14         | 0.1.0              | Jonas Bjurel       | First draft        |\r
+|                    |                    |                    |                    |\r
++--------------------+--------------------+--------------------+--------------------+\r
+|                    | 0.1.1              |                    |                    |\r
+|                    |                    |                    |                    |\r
++--------------------+--------------------+--------------------+--------------------+\r
+|                    | 1.0                |                    |                    |\r
+|                    |                    |                    |                    |\r
+|                    |                    |                    |                    |\r
++--------------------+--------------------+--------------------+--------------------+\r
+\r
+\r
+Introduction\r
+============\r
+<INTRODUCTION TO THE SCOPE AND INTENTION OF THIS DOCUMENT AS WELL AS TO THE SYSTEM TO BE INSTALLED>\r
+\r
+<EXAMPLE>:\r
+\r
+This document describes the supported software and hardware configurations for the\r
+Fuel OPNFV reference platform as well as providing guidelines on how to install and\r
+configure such reference system.\r
+\r
+Although the available installation options gives a high degree of freedom in how the system is set-up,\r
+with what architecture, services and features, etc., not nearly all of those permutations provides\r
+a OPNFV compliant reference architecture. Following the guidelines in this document ensures\r
+a result that is OPNFV compliant.\r
+\r
+The audience of this document is assumed to have good knowledge in network and Unix/Linux administration.\r
+\r
+\r
+Preface\r
+=======\r
+<DESCRIBE NEEDED PREREQUISITES, PLANNING, ETC.>\r
+\r
+<EXAMPLE>:\r
+\r
+Before starting the installation of Fuel@OPNFV, some planning must preceed.\r
+\r
+First of all, the Fuel@OPNFV .iso image needs to be retrieved,\r
+the Latest stable Arno release of Fuel@OPNFV can be found here: <www.opnfv.org/abc/def>\r
+\r
+Alternatively, you may build the .iso from source by cloning the opnfv/genesis git repository:\r
+<git clone https://<linux foundation uid>@gerrit.opnf.org/gerrit/genesis>\r
+Check-out the Arno release:\r
+<cd genesis; git checkout arno>\r
+Goto the fuel directory and build the .iso\r
+<cd fuel/build; make all>\r
+\r
+Familiarize yourself with the Fuel 6.0.1 version by reading the following documents:\r
+- abc <http://wiki.openstack.org/abc>\r
+- def <http://wiki.openstack.org/def>\r
+- ghi <http://wiki.openstack.org/ghi>\r
+\r
+Secondly, a number of deployment specific parameters must be collected, those are:\r
+\r
+1.     Provider sub-net and gateway information\r
+\r
+2.     Provider VLAN information\r
+\r
+3.     Provider DNS addresses\r
+\r
+4.     Provider NTP addresses\r
+\r
+This information will be needed for the configuration procedures provided in this document.\r
+\r
+\r
+Hardware requirements\r
+=====================\r
+<PROVIDE A LIST OF MINIMUM HARDWARE REQUIREMENTS NEEDED FOR THE INSTALL>\r
+\r
+<EXAMPLE>:\r
+\r
+Following minimum hardware requirements must be met for installation of Fuel@OPNFV:\r
+\r
++--------------------+----------------------------------------------------+\r
+| **HW Aspect**      | **Requirement**                                    |\r
+|                    |                                                    |\r
++--------------------+----------------------------------------------------+\r
+| **# of servers**   | Minimum 5 (3 for non redundant deployment)         |\r
+|                    | 1 Fuel deployment master (may be virtualized)      |\r
+|                    | 3(1) Controllers                                   |\r
+|                    | 1 Compute                                          |\r
++--------------------+----------------------------------------------------+\r
+| **CPU**            | Minimum 1 socket x86_AMD64 Ivy bridge 1.6 GHz      |\r
+|                    |                                                    |\r
++--------------------+----------------------------------------------------+\r
+| **RAM**            | Minimum 16GB/server (Depending on VNF work load)   |\r
+|                    |                                                    |\r
++--------------------+----------------------------------------------------+\r
+| **Disk**           | Minimum 256GB 10kRPM spinning disks                |\r
+|                    |                                                    |\r
++--------------------+----------------------------------------------------+\r
+| **NICs**           | 2(1)x10GE Niantec for Private/Public (Redundant)   |\r
+|                    |                                                    |\r
+|                    | 2(1)x10GE Niantec for SAN (Redundant)              |\r
+|                    |                                                    |\r
+|                    | 2(1)x1GE for admin (PXE) and control (RabitMQ,etc) |\r
+|                    |                                                    |\r
++--------------------+----------------------------------------------------+\r
+\r
+\r
+Top of the rack (TOR) Configuration requirements\r
+================================================\r
+<DESCRIBE NEEDED NETWORK TOPOLOGY SETUP IN THE TORs>\r
+\r
+<EXAMPLE>:\r
+\r
+The switching infrastructure provides connectivity for the OPNFV infra-structure operations as well as\r
+for the tenant networks (East/West) and provider connectivity (North/South bound connectivity).\r
+The switching connectivity can (but does not need to) be fully redundant,\r
+in case it and comprises a redundant 10GE switch pair for "Traffic/Payload/SAN" purposes as well as\r
+a 1GE switch pair for "infrastructure control-, management and administration"\r
+\r
+The switches are **not** automatically configured from the OPNFV reference platform.\r
+All the networks involved in the OPNFV infra-structure as well as the provider networks\r
+and the private tenant VLANs needs to be manually configured.\r
+\r
+This following sections guides through required black-box switch configurations.\r
+\r
+VLAN considerations and blue-print\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+IP Address plan considerations and blue-print\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+\r
+OPNFV Software installation and deployment\r
+==========================================\r
+<DESCRIBE THE FULL PROCEDURES FOR THE INSTALLATION OF THE OPNFV COMPONENT INSTALLATION AND DEPLOYMENT>\r
+\r
+<EXAMPLE>:\r
+\r
+This section describes the installation of the Fuel@OPNFV installation server (Fuel master)\r
+as well as the deployment of the full OPNFV reference platform stack across a server cluster.\r
+Etc.\r
+\r
+Install Fuel master\r
+^^^^^^^^^^^^^^^^^^^^^\r
+\r
+Create an OPNV (Fuel Environment)\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+Configure the OPNFV environment\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+Deploy the OPNFV environment\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+\r
+Installation health-check\r
+=========================\r
+<DESCRIBE ANY MEANS TO DO VERIFY THE INTEGRITY AND HEALTHYNESS OF THE INSTALL>\r
+\r
+<EXAMPLE>:\r
+\r
+Now that the OPNFV environment has been created, and before the post installation configurations is started,\r
+perform a system health check from the Fuel GUI:\r
+\r
+- Select the "Health check" TAB.\r
+- Select all test-cases\r
+- And click "Run tests"\r
+\r
+All test cases except the following should pass:\r
+\r
+Post installation and deployment actions\r
+------------------------------------------\r
+<DESCRIBE ANY POST INSTALLATION ACTIONS/CONFIGURATIONS NEEDED>\r
+\r
+<EXAMPLE>:\r
+After the OPNFV deployment is completed, the following manual changes needs to be performed in order\r
+for the system to work according OPNFV standards.\r
+\r
+**Change host OS password:**\r
+Change the Host OS password by......\r
+\r
+\r
+References\r
+==========\r
+<PROVIDE NEEDED/USEFUL REFERENCES>\r
+\r
+<EXAMPLES>:\r
+\r
+OPNFV\r
+^^^^^^^^^^\r
+\r
+OpenStack\r
+^^^^^^^^^^^\r
+\r
+OpenDaylight\r
+^^^^^^^^^^^^^^^\r

diff --git a/docs/release/installation/UC02-installation.instruction.rst b/docs/release/installation/UC02-installation.instruction.rst
new file mode 100644 (file)
index 0000000..0e126dd
--- /dev/null
+++ b/docs/release/installation/UC02-installation.instruction.rst
@@ -0,0 +1,195 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
+.. http://creativecommons.org/licenses/by/4.0\r
+.. SPDX-License-Identifier CC-BY-4.0\r
+.. (c) optionally add copywriters name\r
+\r
+========\r
+Abstract\r
+========\r
+\r
+This document describes how to install OPNFV Auto Use Case 2: Resiliency Improvements Through ONAP, its dependencies and required system resources.\r
+\r
+.. contents::\r
+   :depth: 3\r
+   :local:\r
+\r
+\r
+\r
+Introduction\r
+============\r
+<INTRODUCTION TO THE SCOPE AND INTENTION OF THIS DOCUMENT AS WELL AS TO THE SYSTEM TO BE INSTALLED>\r
+\r
+<EXAMPLE>:\r
+\r
+This document describes the supported software and hardware configurations for the\r
+Fuel OPNFV reference platform as well as providing guidelines on how to install and\r
+configure such reference system.\r
+\r
+Although the available installation options gives a high degree of freedom in how the system is set-up,\r
+with what architecture, services and features, etc., not nearly all of those permutations provides\r
+a OPNFV compliant reference architecture. Following the guidelines in this document ensures\r
+a result that is OPNFV compliant.\r
+\r
+The audience of this document is assumed to have good knowledge in network and Unix/Linux administration.\r
+\r
+\r
+Preface\r
+=======\r
+<DESCRIBE NEEDED PREREQUISITES, PLANNING, ETC.>\r
+\r
+<EXAMPLE>:\r
+\r
+Before starting the installation of Fuel@OPNFV, some planning must preceed.\r
+\r
+First of all, the Fuel@OPNFV .iso image needs to be retrieved,\r
+the Latest stable Arno release of Fuel@OPNFV can be found here: <www.opnfv.org/abc/def>\r
+\r
+Alternatively, you may build the .iso from source by cloning the opnfv/genesis git repository:\r
+<git clone https://<linux foundation uid>@gerrit.opnf.org/gerrit/genesis>\r
+Check-out the Arno release:\r
+<cd genesis; git checkout arno>\r
+Goto the fuel directory and build the .iso\r
+<cd fuel/build; make all>\r
+\r
+Familiarize yourself with the Fuel 6.0.1 version by reading the following documents:\r
+- abc <http://wiki.openstack.org/abc>\r
+- def <http://wiki.openstack.org/def>\r
+- ghi <http://wiki.openstack.org/ghi>\r
+\r
+Secondly, a number of deployment specific parameters must be collected, those are:\r
+\r
+1.     Provider sub-net and gateway information\r
+\r
+2.     Provider VLAN information\r
+\r
+3.     Provider DNS addresses\r
+\r
+4.     Provider NTP addresses\r
+\r
+This information will be needed for the configuration procedures provided in this document.\r
+\r
+\r
+Hardware requirements\r
+=====================\r
+<PROVIDE A LIST OF MINIMUM HARDWARE REQUIREMENTS NEEDED FOR THE INSTALL>\r
+\r
+<EXAMPLE>:\r
+\r
+Following minimum hardware requirements must be met for installation of Fuel@OPNFV:\r
+\r
++--------------------+----------------------------------------------------+\r
+| **HW Aspect**      | **Requirement**                                    |\r
+|                    |                                                    |\r
++--------------------+----------------------------------------------------+\r
+| **# of servers**   | Minimum 5 (3 for non redundant deployment)         |\r
+|                    | 1 Fuel deployment master (may be virtualized)      |\r
+|                    | 3(1) Controllers                                   |\r
+|                    | 1 Compute                                          |\r
++--------------------+----------------------------------------------------+\r
+| **CPU**            | Minimum 1 socket x86_AMD64 Ivy bridge 1.6 GHz      |\r
+|                    |                                                    |\r
++--------------------+----------------------------------------------------+\r
+| **RAM**            | Minimum 16GB/server (Depending on VNF work load)   |\r
+|                    |                                                    |\r
++--------------------+----------------------------------------------------+\r
+| **Disk**           | Minimum 256GB 10kRPM spinning disks                |\r
+|                    |                                                    |\r
++--------------------+----------------------------------------------------+\r
+| **NICs**           | 2(1)x10GE Niantec for Private/Public (Redundant)   |\r
+|                    |                                                    |\r
+|                    | 2(1)x10GE Niantec for SAN (Redundant)              |\r
+|                    |                                                    |\r
+|                    | 2(1)x1GE for admin (PXE) and control (RabitMQ,etc) |\r
+|                    |                                                    |\r
++--------------------+----------------------------------------------------+\r
+\r
+\r
+Top of the rack (TOR) Configuration requirements\r
+================================================\r
+<DESCRIBE NEEDED NETWORK TOPOLOGY SETUP IN THE TORs>\r
+\r
+<EXAMPLE>:\r
+\r
+The switching infrastructure provides connectivity for the OPNFV infra-structure operations as well as\r
+for the tenant networks (East/West) and provider connectivity (North/South bound connectivity).\r
+The switching connectivity can (but does not need to) be fully redundant,\r
+in case it and comprises a redundant 10GE switch pair for "Traffic/Payload/SAN" purposes as well as\r
+a 1GE switch pair for "infrastructure control-, management and administration"\r
+\r
+The switches are **not** automatically configured from the OPNFV reference platform.\r
+All the networks involved in the OPNFV infra-structure as well as the provider networks\r
+and the private tenant VLANs needs to be manually configured.\r
+\r
+This following sections guides through required black-box switch configurations.\r
+\r
+VLAN considerations and blue-print\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+IP Address plan considerations and blue-print\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+\r
+OPNFV Software installation and deployment\r
+==========================================\r
+<DESCRIBE THE FULL PROCEDURES FOR THE INSTALLATION OF THE OPNFV COMPONENT INSTALLATION AND DEPLOYMENT>\r
+\r
+<EXAMPLE>:\r
+\r
+This section describes the installation of the Fuel@OPNFV installation server (Fuel master)\r
+as well as the deployment of the full OPNFV reference platform stack across a server cluster.\r
+Etc.\r
+\r
+Install Fuel master\r
+^^^^^^^^^^^^^^^^^^^^^\r
+\r
+Create an OPNV (Fuel Environment)\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+Configure the OPNFV environment\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+Deploy the OPNFV environment\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+\r
+Installation health-check\r
+=========================\r
+<DESCRIBE ANY MEANS TO DO VERIFY THE INTEGRITY AND HEALTHYNESS OF THE INSTALL>\r
+\r
+<EXAMPLE>:\r
+\r
+Now that the OPNFV environment has been created, and before the post installation configurations is started,\r
+perform a system health check from the Fuel GUI:\r
+\r
+- Select the "Health check" TAB.\r
+- Select all test-cases\r
+- And click "Run tests"\r
+\r
+All test cases except the following should pass:\r
+\r
+Post installation and deployment actions\r
+------------------------------------------\r
+<DESCRIBE ANY POST INSTALLATION ACTIONS/CONFIGURATIONS NEEDED>\r
+\r
+<EXAMPLE>:\r
+After the OPNFV deployment is completed, the following manual changes needs to be performed in order\r
+for the system to work according OPNFV standards.\r
+\r
+**Change host OS password:**\r
+Change the Host OS password by......\r
+\r
+\r
+References\r
+==========\r
+<PROVIDE NEEDED/USEFUL REFERENCES>\r
+\r
+<EXAMPLES>:\r
+\r
+OPNFV\r
+^^^^^^^^^^\r
+\r
+OpenStack\r
+^^^^^^^^^^^\r
+\r
+OpenDaylight\r
+^^^^^^^^^^^^^^^\r

diff --git a/docs/release/installation/UC03-installation.instruction.rst b/docs/release/installation/UC03-installation.instruction.rst
new file mode 100644 (file)
index 0000000..0221885
--- /dev/null
+++ b/docs/release/installation/UC03-installation.instruction.rst
@@ -0,0 +1,212 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
+.. http://creativecommons.org/licenses/by/4.0\r
+.. SPDX-License-Identifier CC-BY-4.0\r
+.. (c) optionally add copywriters name\r
+\r
+========\r
+Abstract\r
+========\r
+\r
+This document describes how to install OPNFV Auto Use Case 3: Enterprise vCPE, its dependencies and required system resources.\r
+\r
+.. contents::\r
+   :depth: 3\r
+   :local:\r
+\r
+Version history\r
+---------------------\r
+\r
++--------------------+--------------------+--------------------+--------------------+\r
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |\r
+|                    |                    |                    |                    |\r
++--------------------+--------------------+--------------------+--------------------+\r
+| 2015-04-14         | 0.1.0              | Jonas Bjurel       | First draft        |\r
+|                    |                    |                    |                    |\r
++--------------------+--------------------+--------------------+--------------------+\r
+|                    | 0.1.1              |                    |                    |\r
+|                    |                    |                    |                    |\r
++--------------------+--------------------+--------------------+--------------------+\r
+|                    | 1.0                |                    |                    |\r
+|                    |                    |                    |                    |\r
+|                    |                    |                    |                    |\r
++--------------------+--------------------+--------------------+--------------------+\r
+\r
+\r
+Introduction\r
+============\r
+<INTRODUCTION TO THE SCOPE AND INTENTION OF THIS DOCUMENT AS WELL AS TO THE SYSTEM TO BE INSTALLED>\r
+\r
+<EXAMPLE>:\r
+\r
+This document describes the supported software and hardware configurations for the\r
+Fuel OPNFV reference platform as well as providing guidelines on how to install and\r
+configure such reference system.\r
+\r
+Although the available installation options gives a high degree of freedom in how the system is set-up,\r
+with what architecture, services and features, etc., not nearly all of those permutations provides\r
+a OPNFV compliant reference architecture. Following the guidelines in this document ensures\r
+a result that is OPNFV compliant.\r
+\r
+The audience of this document is assumed to have good knowledge in network and Unix/Linux administration.\r
+\r
+\r
+Preface\r
+=======\r
+<DESCRIBE NEEDED PREREQUISITES, PLANNING, ETC.>\r
+\r
+<EXAMPLE>:\r
+\r
+Before starting the installation of Fuel@OPNFV, some planning must preceed.\r
+\r
+First of all, the Fuel@OPNFV .iso image needs to be retrieved,\r
+the Latest stable Arno release of Fuel@OPNFV can be found here: <www.opnfv.org/abc/def>\r
+\r
+Alternatively, you may build the .iso from source by cloning the opnfv/genesis git repository:\r
+<git clone https://<linux foundation uid>@gerrit.opnf.org/gerrit/genesis>\r
+Check-out the Arno release:\r
+<cd genesis; git checkout arno>\r
+Goto the fuel directory and build the .iso\r
+<cd fuel/build; make all>\r
+\r
+Familiarize yourself with the Fuel 6.0.1 version by reading the following documents:\r
+- abc <http://wiki.openstack.org/abc>\r
+- def <http://wiki.openstack.org/def>\r
+- ghi <http://wiki.openstack.org/ghi>\r
+\r
+Secondly, a number of deployment specific parameters must be collected, those are:\r
+\r
+1.     Provider sub-net and gateway information\r
+\r
+2.     Provider VLAN information\r
+\r
+3.     Provider DNS addresses\r
+\r
+4.     Provider NTP addresses\r
+\r
+This information will be needed for the configuration procedures provided in this document.\r
+\r
+\r
+Hardware requirements\r
+=====================\r
+<PROVIDE A LIST OF MINIMUM HARDWARE REQUIREMENTS NEEDED FOR THE INSTALL>\r
+\r
+<EXAMPLE>:\r
+\r
+Following minimum hardware requirements must be met for installation of Fuel@OPNFV:\r
+\r
++--------------------+----------------------------------------------------+\r
+| **HW Aspect**      | **Requirement**                                    |\r
+|                    |                                                    |\r
++--------------------+----------------------------------------------------+\r
+| **# of servers**   | Minimum 5 (3 for non redundant deployment)         |\r
+|                    | 1 Fuel deployment master (may be virtualized)      |\r
+|                    | 3(1) Controllers                                   |\r
+|                    | 1 Compute                                          |\r
++--------------------+----------------------------------------------------+\r
+| **CPU**            | Minimum 1 socket x86_AMD64 Ivy bridge 1.6 GHz      |\r
+|                    |                                                    |\r
++--------------------+----------------------------------------------------+\r
+| **RAM**            | Minimum 16GB/server (Depending on VNF work load)   |\r
+|                    |                                                    |\r
++--------------------+----------------------------------------------------+\r
+| **Disk**           | Minimum 256GB 10kRPM spinning disks                |\r
+|                    |                                                    |\r
++--------------------+----------------------------------------------------+\r
+| **NICs**           | 2(1)x10GE Niantec for Private/Public (Redundant)   |\r
+|                    |                                                    |\r
+|                    | 2(1)x10GE Niantec for SAN (Redundant)              |\r
+|                    |                                                    |\r
+|                    | 2(1)x1GE for admin (PXE) and control (RabitMQ,etc) |\r
+|                    |                                                    |\r
++--------------------+----------------------------------------------------+\r
+\r
+\r
+Top of the rack (TOR) Configuration requirements\r
+================================================\r
+<DESCRIBE NEEDED NETWORK TOPOLOGY SETUP IN THE TORs>\r
+\r
+<EXAMPLE>:\r
+\r
+The switching infrastructure provides connectivity for the OPNFV infra-structure operations as well as\r
+for the tenant networks (East/West) and provider connectivity (North/South bound connectivity).\r
+The switching connectivity can (but does not need to) be fully redundant,\r
+in case it and comprises a redundant 10GE switch pair for "Traffic/Payload/SAN" purposes as well as\r
+a 1GE switch pair for "infrastructure control-, management and administration"\r
+\r
+The switches are **not** automatically configured from the OPNFV reference platform.\r
+All the networks involved in the OPNFV infra-structure as well as the provider networks\r
+and the private tenant VLANs needs to be manually configured.\r
+\r
+This following sections guides through required black-box switch configurations.\r
+\r
+VLAN considerations and blue-print\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+IP Address plan considerations and blue-print\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+\r
+OPNFV Software installation and deployment\r
+==========================================\r
+<DESCRIBE THE FULL PROCEDURES FOR THE INSTALLATION OF THE OPNFV COMPONENT INSTALLATION AND DEPLOYMENT>\r
+\r
+<EXAMPLE>:\r
+\r
+This section describes the installation of the Fuel@OPNFV installation server (Fuel master)\r
+as well as the deployment of the full OPNFV reference platform stack across a server cluster.\r
+Etc.\r
+\r
+Install Fuel master\r
+^^^^^^^^^^^^^^^^^^^^^\r
+\r
+Create an OPNV (Fuel Environment)\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+Configure the OPNFV environment\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+Deploy the OPNFV environment\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+\r
+Installation health-check\r
+=========================\r
+<DESCRIBE ANY MEANS TO DO VERIFY THE INTEGRITY AND HEALTHYNESS OF THE INSTALL>\r
+\r
+<EXAMPLE>:\r
+\r
+Now that the OPNFV environment has been created, and before the post installation configurations is started,\r
+perform a system health check from the Fuel GUI:\r
+\r
+- Select the "Health check" TAB.\r
+- Select all test-cases\r
+- And click "Run tests"\r
+\r
+All test cases except the following should pass:\r
+\r
+Post installation and deployment actions\r
+------------------------------------------\r
+<DESCRIBE ANY POST INSTALLATION ACTIONS/CONFIGURATIONS NEEDED>\r
+\r
+<EXAMPLE>:\r
+After the OPNFV deployment is completed, the following manual changes needs to be performed in order\r
+for the system to work according OPNFV standards.\r
+\r
+**Change host OS password:**\r
+Change the Host OS password by......\r
+\r
+\r
+References\r
+==========\r
+<PROVIDE NEEDED/USEFUL REFERENCES>\r
+\r
+<EXAMPLES>:\r
+\r
+OPNFV\r
+^^^^^^^^^^\r
+\r
+OpenStack\r
+^^^^^^^^^^^\r
+\r
+OpenDaylight\r
+^^^^^^^^^^^^^^^\r

diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst
new file mode 100644 (file)
index 0000000..0120e92
--- /dev/null
+++ b/docs/release/installation/index.rst
@@ -0,0 +1,15 @@
+.. _auto-configguide:\r
+\r
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
+.. http://creativecommons.org/licenses/by/4.0\r
+\r
+=====================================================\r
+OPNFV Auto (ONAP-Automated OPNFV) Configuration Guide\r
+=====================================================\r
+\r
+.. toctree::\r
+   :maxdepth: 1\r
+\r
+   UC01-installation.instruction.rst\r
+   UC02-installation.instruction.rst\r
+   UC03-installation.instruction.rst\r

diff --git a/docs/release/release-notes/UC01-release-notes.rst b/docs/release/release-notes/UC01-release-notes.rst
new file mode 100644 (file)
index 0000000..32d12da
--- /dev/null
+++ b/docs/release/release-notes/UC01-release-notes.rst
@@ -0,0 +1,235 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
+.. http://creativecommons.org/licenses/by/4.0\r
+.. SPDX-License-Identifier CC-BY-4.0\r
+.. (c) optionally add copywriters name\r
+\r
+\r
+This document provides the release notes for Fraser of OPNFV Auto Use Case 1: Edge Cloud.\r
+\r
+.. contents::\r
+   :depth: 3\r
+   :local:\r
+\r
+\r
+Version history\r
+---------------\r
+\r
++--------------------+--------------------+--------------------+--------------------+\r
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |\r
+|                    |                    |                    |                    |\r
++--------------------+--------------------+--------------------+--------------------+\r
+| 2015-04-14         | 0.1.0              | Jonas Bjurel       | First draft        |\r
+|                    |                    |                    |                    |\r
++--------------------+--------------------+--------------------+--------------------+\r
+|                    | 0.1.1              |                    |                    |\r
+|                    |                    |                    |                    |\r
++--------------------+--------------------+--------------------+--------------------+\r
+|                    | 1.0                |                    |                    |\r
+|                    |                    |                    |                    |\r
++--------------------+--------------------+--------------------+--------------------+\r
+\r
+Important notes\r
+===============\r
+\r
+<STATE IMPORTANT NOTES/DEVIATIONS SINCE PREVIOUS ITERATIVE RELEASE AND OTHER IMPORTANT NOTES FOR THIS RELEASE>\r
+\r
+<EXAMPLE>:\r
+\r
+**Attention:** Please be aware that since LSV3 a pre-deploy script must be ran on the Fuel master -\r
+see the OPNFV@Fuel SW installation instructions\r
+\r
+\r
+Summary\r
+=======\r
+\r
+<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>\r
+\r
+<EXAMPLE>:\r
+\r
+Arno Fuel@OPNFV is based the OpenStack Fuel upstream project version 6.0.1,\r
+but adds OPNFV unique components such as OpenDaylight version: Helium as well as other OPNFV unique configurations......\r
+\r
+\r
+Release Data\r
+============\r
+<STATE RELEVANT RELEASE DATA/RECORDS>\r
+\r
+<EXAMPLE>:\r
+\r
++--------------------------------------+--------------------------------------+\r
+| **Project**                          | E.g. Arno/genesis/fuel@opnfv         |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| **Repo/commit-ID**                   | E.g. genesis/adf634a0d4.....         |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| **Release designation**              | E.g. Arno RC2                        |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| **Release date**                     | E.g. 2015-04-16                      |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| **Purpose of the delivery**          | E.g. OPNFV Internal quality assurance|\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+\r
+Version change\r
+^^^^^^^^^^^^^^^^\r
+\r
+Module version changes\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+<STATE WHAT UPSTREAM, - AS WELL AS OPNFV MODULE VERSIONS HAVE CHANGED>\r
+\r
+<EXAMPLE>:\r
+\r
+- Fuel have changed from 5.1 to 6.0.1\r
+\r
+- OpenDaylight has changed from Helium-SR1 to Helium-SR2\r
+\r
+Document version changes\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+<STATE WHAT RELATED DOCUMENTS THAT CHANGES WITH THIS RELEASE>\r
+\r
+<EXAMPLE>:\r
+\r
+- The Fuel@OPNFV installation guide version has changed from version 0.1 to to 0.2\r
+\r
+Reason for version\r
+^^^^^^^^^^^^^^^^^^^^\r
+Feature additions\r
+~~~~~~~~~~~~~~~~~~~~~~~\r
+<STATE ADDED FEATURES BY REFERENCE TO JIRA>\r
+\r
+<EXAMPLE>:\r
+\r
+**JIRA BACK-LOG:**\r
+\r
++--------------------------------------+--------------------------------------+\r
+| **JIRA REFERENCE**                   | **SLOGAN**                           |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| BGS-123                              | ADD OpenDaylight ml2 integration     |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| BGS-456                              | Add auto-deployment of Fuel@OPNFV    |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+\r
+Bug corrections\r
+~~~~~~~~~~~~~~~~~~~~~\r
+\r
+**JIRA TICKETS:**\r
+\r
++--------------------------------------+--------------------------------------+\r
+| **JIRA REFERENCE**                   | **SLOGAN**                           |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| BGS-888                              | Fuel doesn't deploy                  |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| BGS-999                              | Floating IP doesn't work             |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+\r
+Deliverables\r
+----------------\r
+\r
+Software deliverables\r
+^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>\r
+\r
+<EXAMPLE>:\r
+\r
+Documentation deliverables\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>\r
+\r
+<EXAMPLE>:\r
+\r
+\r
+Known Limitations, Issues and Workarounds\r
+=========================================\r
+\r
+System Limitations\r
+^^^^^^^^^^^^^^^^^^^^\r
+<STATE ALL RELEVANT SYSTEM LIMITATIONS>\r
+\r
+<EXAMPLE>:\r
+\r
+**Max number of blades:**   1 Fuel master, 3 Controllers, 20 Compute blades\r
+\r
+**Min number of blades:**   1 Fuel master, 1 Controller, 1 Compute blade\r
+\r
+**Storage:**    Ceph is the only supported storage configuration.\r
+\r
+**Max number of networks:**   3800 (Needs special switch config.)\r
+\r
+**L3Agent:**   L3 agent and floating IPs is not supported.\r
+\r
+Known issues\r
+^^^^^^^^^^^^^^^\r
+<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>\r
+\r
+<EXAMPLE>:\r
+\r
+**JIRA TICKETS:**\r
+\r
++--------------------------------------+--------------------------------------+\r
+| **JIRA REFERENCE**                   | **SLOGAN**                           |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| BGS-987                              | Nova-compute process does            |\r
+|                                      | not re-spawn when killed             |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| BGS-654                              | MOS 5.1 : neutron net-list returns   |\r
+|                                      | "400 Bad request"                    |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+\r
+Workarounds\r
+^^^^^^^^^^^^^^^^^\r
+\r
+<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE>\r
+\r
+<EXAMPLE>:\r
+\r
+- In case the contact with a compute is lost - restart the compute host\r
+- In case the disk is full on a controller - delete all files in /tmp\r
+\r
+Test Result\r
+===========\r
+<STATE THE QA COVERAGE AND RESULTS>\r
+\r
+<EXAMPLE>:\r
+\r
+Fuel@OPNFV Arno RC2 has undergone QA test runs with the following results:\r
+\r
++--------------------------------------+--------------------------------------+\r
+| **TEST-SUITE**                       | **Results:**                         |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| Tempest test suite 123               | Following tests failed:              |\r
+|                                      |                                      |\r
+|                                      | 1. Image resizing....                |\r
+|                                      |                                      |\r
+|                                      | 2. Heat deploy....                   |\r
++--------------------------------------+--------------------------------------+\r
+| Robot test suite 456                 | Following tests failed:              |\r
+|                                      |                                      |\r
+|                                      | 1.......                             |\r
+|                                      |                                      |\r
+|                                      | 2.......                             |\r
++--------------------------------------+--------------------------------------+\r
+\r
+References\r
+==========\r
+<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>\r
+\r
+<EXAMPLE>:\r
+\r
+For more information on the OPNFV Danube release, please see:\r
+\r
+http://opnfv.org/danube\r

diff --git a/docs/release/release-notes/UC02-release-notes.rst b/docs/release/release-notes/UC02-release-notes.rst
new file mode 100644 (file)
index 0000000..183d94f
--- /dev/null
+++ b/docs/release/release-notes/UC02-release-notes.rst
@@ -0,0 +1,219 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
+.. http://creativecommons.org/licenses/by/4.0\r
+.. SPDX-License-Identifier CC-BY-4.0\r
+.. (c) optionally add copywriters name\r
+\r
+\r
+======================================================================\r
+Auto Release Notes: Use Case 2 Resiliency Improvements Through ONAP.\r
+======================================================================\r
+\r
+This document provides the release notes for Fraser release of Auto,\r
+specifically for Use Case 2: Resiliency Improvements Through ONAP.\r
+\r
+\r
+.. contents::\r
+   :depth: 3\r
+   :local:\r
+\r
+\r
+Important notes\r
+===============\r
+\r
+None\r
+\r
+\r
+Summary\r
+=======\r
+\r
+<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>\r
+\r
+<EXAMPLE>:\r
+\r
+Arno Fuel@OPNFV is based the OpenStack Fuel upstream project version 6.0.1,\r
+but adds OPNFV unique components such as OpenDaylight version: Helium as well as other OPNFV unique configurations......\r
+\r
+\r
+Release Data\r
+============\r
+<STATE RELEVANT RELEASE DATA/RECORDS>\r
+\r
+<EXAMPLE>:\r
+\r
++--------------------------------------+--------------------------------------+\r
+| **Project**                          | E.g. Arno/genesis/fuel@opnfv         |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| **Repo/commit-ID**                   | E.g. genesis/adf634a0d4.....         |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| **Release designation**              | E.g. Arno RC2                        |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| **Release date**                     | E.g. 2015-04-16                      |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| **Purpose of the delivery**          | E.g. OPNFV Internal quality assurance|\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+\r
+Version change\r
+^^^^^^^^^^^^^^^^\r
+\r
+Module version changes\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+<STATE WHAT UPSTREAM, - AS WELL AS OPNFV MODULE VERSIONS HAVE CHANGED>\r
+\r
+<EXAMPLE>:\r
+\r
+- Fuel have changed from 5.1 to 6.0.1\r
+\r
+- OpenDaylight has changed from Helium-SR1 to Helium-SR2\r
+\r
+Document version changes\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+<STATE WHAT RELATED DOCUMENTS THAT CHANGES WITH THIS RELEASE>\r
+\r
+<EXAMPLE>:\r
+\r
+- The Fuel@OPNFV installation guide version has changed from version 0.1 to to 0.2\r
+\r
+Reason for version\r
+^^^^^^^^^^^^^^^^^^^^\r
+Feature additions\r
+~~~~~~~~~~~~~~~~~~~~~~~\r
+<STATE ADDED FEATURES BY REFERENCE TO JIRA>\r
+\r
+<EXAMPLE>:\r
+\r
+**JIRA BACK-LOG:**\r
+\r
++--------------------------------------+--------------------------------------+\r
+| **JIRA REFERENCE**                   | **SLOGAN**                           |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| BGS-123                              | ADD OpenDaylight ml2 integration     |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| BGS-456                              | Add auto-deployment of Fuel@OPNFV    |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+\r
+Bug corrections\r
+~~~~~~~~~~~~~~~~~~~~~\r
+\r
+**JIRA TICKETS:**\r
+\r
++--------------------------------------+--------------------------------------+\r
+| **JIRA REFERENCE**                   | **SLOGAN**                           |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| BGS-888                              | Fuel doesn't deploy                  |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| BGS-999                              | Floating IP doesn't work             |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+\r
+Deliverables\r
+----------------\r
+\r
+Software deliverables\r
+^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>\r
+\r
+<EXAMPLE>:\r
+\r
+Documentation deliverables\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>\r
+\r
+<EXAMPLE>:\r
+\r
+\r
+Known Limitations, Issues and Workarounds\r
+=========================================\r
+\r
+System Limitations\r
+^^^^^^^^^^^^^^^^^^^^\r
+<STATE ALL RELEVANT SYSTEM LIMITATIONS>\r
+\r
+<EXAMPLE>:\r
+\r
+**Max number of blades:**   1 Fuel master, 3 Controllers, 20 Compute blades\r
+\r
+**Min number of blades:**   1 Fuel master, 1 Controller, 1 Compute blade\r
+\r
+**Storage:**    Ceph is the only supported storage configuration.\r
+\r
+**Max number of networks:**   3800 (Needs special switch config.)\r
+\r
+**L3Agent:**   L3 agent and floating IPs is not supported.\r
+\r
+Known issues\r
+^^^^^^^^^^^^^^^\r
+<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>\r
+\r
+<EXAMPLE>:\r
+\r
+**JIRA TICKETS:**\r
+\r
++--------------------------------------+--------------------------------------+\r
+| **JIRA REFERENCE**                   | **SLOGAN**                           |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| BGS-987                              | Nova-compute process does            |\r
+|                                      | not re-spawn when killed             |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| BGS-654                              | MOS 5.1 : neutron net-list returns   |\r
+|                                      | "400 Bad request"                    |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+\r
+Workarounds\r
+^^^^^^^^^^^^^^^^^\r
+\r
+<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE>\r
+\r
+<EXAMPLE>:\r
+\r
+- In case the contact with a compute is lost - restart the compute host\r
+- In case the disk is full on a controller - delete all files in /tmp\r
+\r
+Test Result\r
+===========\r
+<STATE THE QA COVERAGE AND RESULTS>\r
+\r
+<EXAMPLE>:\r
+\r
+Fuel@OPNFV Arno RC2 has undergone QA test runs with the following results:\r
+\r
++--------------------------------------+--------------------------------------+\r
+| **TEST-SUITE**                       | **Results:**                         |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| Tempest test suite 123               | Following tests failed:              |\r
+|                                      |                                      |\r
+|                                      | 1. Image resizing....                |\r
+|                                      |                                      |\r
+|                                      | 2. Heat deploy....                   |\r
++--------------------------------------+--------------------------------------+\r
+| Robot test suite 456                 | Following tests failed:              |\r
+|                                      |                                      |\r
+|                                      | 1.......                             |\r
+|                                      |                                      |\r
+|                                      | 2.......                             |\r
++--------------------------------------+--------------------------------------+\r
+\r
+References\r
+==========\r
+<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>\r
+\r
+<EXAMPLE>:\r
+\r
+For more information on the OPNFV Danube release, please see:\r
+\r
+http://opnfv.org/danube\r

diff --git a/docs/release/release-notes/UC03-release-notes.rst b/docs/release/release-notes/UC03-release-notes.rst
new file mode 100644 (file)
index 0000000..62b6ea7
--- /dev/null
+++ b/docs/release/release-notes/UC03-release-notes.rst
@@ -0,0 +1,235 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
+.. http://creativecommons.org/licenses/by/4.0\r
+.. SPDX-License-Identifier CC-BY-4.0\r
+.. (c) optionally add copywriters name\r
+\r
+\r
+This document provides the release notes for Fraser of OPNFV Auto Use Case 3: Enterprise vCPE.\r
+\r
+.. contents::\r
+   :depth: 3\r
+   :local:\r
+\r
+\r
+Version history\r
+---------------\r
+\r
++--------------------+--------------------+--------------------+--------------------+\r
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |\r
+|                    |                    |                    |                    |\r
++--------------------+--------------------+--------------------+--------------------+\r
+| 2015-04-14         | 0.1.0              | Jonas Bjurel       | First draft        |\r
+|                    |                    |                    |                    |\r
++--------------------+--------------------+--------------------+--------------------+\r
+|                    | 0.1.1              |                    |                    |\r
+|                    |                    |                    |                    |\r
++--------------------+--------------------+--------------------+--------------------+\r
+|                    | 1.0                |                    |                    |\r
+|                    |                    |                    |                    |\r
++--------------------+--------------------+--------------------+--------------------+\r
+\r
+Important notes\r
+===============\r
+\r
+<STATE IMPORTANT NOTES/DEVIATIONS SINCE PREVIOUS ITERATIVE RELEASE AND OTHER IMPORTANT NOTES FOR THIS RELEASE>\r
+\r
+<EXAMPLE>:\r
+\r
+**Attention:** Please be aware that since LSV3 a pre-deploy script must be ran on the Fuel master -\r
+see the OPNFV@Fuel SW installation instructions\r
+\r
+\r
+Summary\r
+=======\r
+\r
+<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>\r
+\r
+<EXAMPLE>:\r
+\r
+Arno Fuel@OPNFV is based the OpenStack Fuel upstream project version 6.0.1,\r
+but adds OPNFV unique components such as OpenDaylight version: Helium as well as other OPNFV unique configurations......\r
+\r
+\r
+Release Data\r
+============\r
+<STATE RELEVANT RELEASE DATA/RECORDS>\r
+\r
+<EXAMPLE>:\r
+\r
++--------------------------------------+--------------------------------------+\r
+| **Project**                          | E.g. Arno/genesis/fuel@opnfv         |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| **Repo/commit-ID**                   | E.g. genesis/adf634a0d4.....         |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| **Release designation**              | E.g. Arno RC2                        |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| **Release date**                     | E.g. 2015-04-16                      |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| **Purpose of the delivery**          | E.g. OPNFV Internal quality assurance|\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+\r
+Version change\r
+^^^^^^^^^^^^^^^^\r
+\r
+Module version changes\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+<STATE WHAT UPSTREAM, - AS WELL AS OPNFV MODULE VERSIONS HAVE CHANGED>\r
+\r
+<EXAMPLE>:\r
+\r
+- Fuel have changed from 5.1 to 6.0.1\r
+\r
+- OpenDaylight has changed from Helium-SR1 to Helium-SR2\r
+\r
+Document version changes\r
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
+<STATE WHAT RELATED DOCUMENTS THAT CHANGES WITH THIS RELEASE>\r
+\r
+<EXAMPLE>:\r
+\r
+- The Fuel@OPNFV installation guide version has changed from version 0.1 to to 0.2\r
+\r
+Reason for version\r
+^^^^^^^^^^^^^^^^^^^^\r
+Feature additions\r
+~~~~~~~~~~~~~~~~~~~~~~~\r
+<STATE ADDED FEATURES BY REFERENCE TO JIRA>\r
+\r
+<EXAMPLE>:\r
+\r
+**JIRA BACK-LOG:**\r
+\r
++--------------------------------------+--------------------------------------+\r
+| **JIRA REFERENCE**                   | **SLOGAN**                           |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| BGS-123                              | ADD OpenDaylight ml2 integration     |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| BGS-456                              | Add auto-deployment of Fuel@OPNFV    |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+\r
+Bug corrections\r
+~~~~~~~~~~~~~~~~~~~~~\r
+\r
+**JIRA TICKETS:**\r
+\r
++--------------------------------------+--------------------------------------+\r
+| **JIRA REFERENCE**                   | **SLOGAN**                           |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| BGS-888                              | Fuel doesn't deploy                  |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| BGS-999                              | Floating IP doesn't work             |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+\r
+Deliverables\r
+----------------\r
+\r
+Software deliverables\r
+^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>\r
+\r
+<EXAMPLE>:\r
+\r
+Documentation deliverables\r
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>\r
+\r
+<EXAMPLE>:\r
+\r
+\r
+Known Limitations, Issues and Workarounds\r
+=========================================\r
+\r
+System Limitations\r
+^^^^^^^^^^^^^^^^^^^^\r
+<STATE ALL RELEVANT SYSTEM LIMITATIONS>\r
+\r
+<EXAMPLE>:\r
+\r
+**Max number of blades:**   1 Fuel master, 3 Controllers, 20 Compute blades\r
+\r
+**Min number of blades:**   1 Fuel master, 1 Controller, 1 Compute blade\r
+\r
+**Storage:**    Ceph is the only supported storage configuration.\r
+\r
+**Max number of networks:**   3800 (Needs special switch config.)\r
+\r
+**L3Agent:**   L3 agent and floating IPs is not supported.\r
+\r
+Known issues\r
+^^^^^^^^^^^^^^^\r
+<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>\r
+\r
+<EXAMPLE>:\r
+\r
+**JIRA TICKETS:**\r
+\r
++--------------------------------------+--------------------------------------+\r
+| **JIRA REFERENCE**                   | **SLOGAN**                           |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| BGS-987                              | Nova-compute process does            |\r
+|                                      | not re-spawn when killed             |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| BGS-654                              | MOS 5.1 : neutron net-list returns   |\r
+|                                      | "400 Bad request"                    |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+\r
+Workarounds\r
+^^^^^^^^^^^^^^^^^\r
+\r
+<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE>\r
+\r
+<EXAMPLE>:\r
+\r
+- In case the contact with a compute is lost - restart the compute host\r
+- In case the disk is full on a controller - delete all files in /tmp\r
+\r
+Test Result\r
+===========\r
+<STATE THE QA COVERAGE AND RESULTS>\r
+\r
+<EXAMPLE>:\r
+\r
+Fuel@OPNFV Arno RC2 has undergone QA test runs with the following results:\r
+\r
++--------------------------------------+--------------------------------------+\r
+| **TEST-SUITE**                       | **Results:**                         |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| Tempest test suite 123               | Following tests failed:              |\r
+|                                      |                                      |\r
+|                                      | 1. Image resizing....                |\r
+|                                      |                                      |\r
+|                                      | 2. Heat deploy....                   |\r
++--------------------------------------+--------------------------------------+\r
+| Robot test suite 456                 | Following tests failed:              |\r
+|                                      |                                      |\r
+|                                      | 1.......                             |\r
+|                                      |                                      |\r
+|                                      | 2.......                             |\r
++--------------------------------------+--------------------------------------+\r
+\r
+References\r
+==========\r
+<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>\r
+\r
+<EXAMPLE>:\r
+\r
+For more information on the OPNFV Danube release, please see:\r
+\r
+http://opnfv.org/danube\r

diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst
new file mode 100644 (file)
index 0000000..da23ecc
--- /dev/null
+++ b/docs/release/release-notes/index.rst
@@ -0,0 +1,15 @@
+.. _auto-releasenotes:\r
+\r
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
+.. http://creativecommons.org/licenses/by/4.0\r
+\r
+===============================================\r
+OPNFV Auto (ONAP-Automated OPNFV) Release Notes\r
+===============================================\r
+\r
+.. toctree::\r
+   :maxdepth: 1\r
+\r
+   UC01-release-notes.rst\r
+   UC02-release-notes.rst\r
+   UC03-release-notes.rst\r

diff --git a/docs/release/userguide/UC01-feature.userguide.rst b/docs/release/userguide/UC01-feature.userguide.rst
new file mode 100644 (file)
index 0000000..28e1097
--- /dev/null
+++ b/docs/release/userguide/UC01-feature.userguide.rst
@@ -0,0 +1,24 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
+.. http://creativecommons.org/licenses/by/4.0\r
+.. SPDX-License-Identifier CC-BY-4.0\r
+.. (c) optionally add copywriters name\r
+\r
+.. contents::\r
+   :depth: 3\r
+   :local:\r
+\r
+OPNFV Auto Use Case 1: Edge Cloud description\r
+=========================================================\r
+.. Describe the specific features and how it is realised in the scenario in a brief manner\r
+.. to ensure the user understand the context for the user guide instructions to follow.\r
+\r
+OPNFV Auto Use Case 1: Edge Cloud capabilities and usage\r
+=========================================================\r
+.. Describe the specific capabilities and usage for <XYZ> feature.\r
+.. Provide enough information that a user will be able to operate the feature on a deployed scenario.\r
+\r
+<Feature and API usage guidelines and example>\r
+=========================================================\r
+.. Describe with examples how to use specific features, provide API examples and details required to\r
+.. operate the feature on the platform.\r
+\r

diff --git a/docs/release/userguide/UC02-feature.userguide.rst b/docs/release/userguide/UC02-feature.userguide.rst
new file mode 100644 (file)
index 0000000..39f0fd3
--- /dev/null
+++ b/docs/release/userguide/UC02-feature.userguide.rst
@@ -0,0 +1,119 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
+.. http://creativecommons.org/licenses/by/4.0\r
+.. SPDX-License-Identifier CC-BY-4.0\r
+.. (c) optionally add copywriters name\r
+\r
+\r
+================================================================\r
+Auto User Guide: Use Case 2 Resiliency Improvements Through ONAP\r
+================================================================\r
+\r
+This document provides the release notes for Fraser release of Auto,\r
+specifically for Use Case 2: Resiliency Improvements Through ONAP.\r
+\r
+.. contents::\r
+   :depth: 3\r
+   :local:\r
+\r
+\r
+Description\r
+===========\r
+\r
+This use case illustrates VNF failure recovery time reduction with ONAP, thanks to its automated monitoring and management.\r
+It simulates an underlying problem (failure, stress, etc.: any adverse condition in the network that can impact VNFs),\r
+tracks a VNF, and measures the amount of time it takes for ONAP to restore the VNF functionality. \r
+\r
+The benefit for NFV edge service providers is to assess what degree of added VIM+NFVI platform resilience for VNFs is obtained by\r
+leveraging ONAP closed-loop control, vs. VIM+NFVI self-managed resilience (which may not be aware of the VNF or the corresponding\r
+end-to-end Service, but only of underlying resources such as VMs and servers).\r
+\r
+Preconditions:\r
+#. hardware environment in which Edge cloud may be deployed\r
+#. Edge cloud has been deployed and is ready for operation\r
+#. ONAP has been deployed onto a cloud and is interfaced (i.e. provisioned for API access) to the Edge cloud\r
+#. Components of ONAP have been deployed on the Edge cloud as necessary for specific test objectives\r
+\r
+In future releases, Auto Use cases will also include the deployment of ONAP (if not already installed), the deployment\r
+of test VNFs (pre-existing VNFs in pre-existing ONAP can be used in the test as well), the configuration of ONAP for\r
+monitoring these VNFs (policies, CLAMP, DCAE), in addition to the test scripts which simulate a problem and measures recovery time.\r
+\r
+Different types of problems can be simulated, hence the identification of multiple test cases corresponding to this use case,\r
+as illustrated in this diagram:\r
+\r
+.. image:: auto-UC02-testcases.jpg\r
+\r
+\r
+Test execution high-level description\r
+=====================================\r
+\r
+The following two MSCs (Message Sequence Charts) show the actors and high-level interactions.\r
+\r
+The first MSC shows the preparation activities (assuming the hardware, network, cloud, and ONAP have already been installed):\r
+onboarding and deployment of VNFs (via ONAP portal and modules in sequence: SDC, VID, SO), and ONAP configuration\r
+(policy framework, closed-loops in CLAMP, activation of DCAE).\r
+\r
+.. image:: auto-UC02-preparation.jpg\r
+\r
+The second MSC illustrates the pattern of all test cases for the Resiliency Improvements:\r
+* simulate the chosen problem (a.k.a. a "Challenge") for this test case, for example suspend a VM which may be used by a VNF\r
+* start tracking the target VNF of this test case\r
+* measure the ONAP-orchestrated VNF Recovery Time\r
+* then the test stops simulating the problem (for example: resume the VM that was suspended),\r
+\r
+In parallel, the MSC also shows the sequence of events happening in ONAP, thanks to its configuration to provide Service\r
+Assurance for the VNF.\r
+\r
+.. image:: auto-UC02-pattern.jpg\r
+\r
+\r
+Test design: data model, implementation modules\r
+===============================================\r
+\r
+The high-level design of classes shows the identification of several entities:\r
+* Test Case: as identified above, each is a special case of the overall use case (e.g., categorized by challenge type)\r
+* Test Definition: gathers all the information necessary to run a certain test case\r
+* Metric Definition: describes a certain metric that may be measured, in addition to Recovery Time\r
+* Challenge Definition: describe the challenge (problem, failure, stress, ...) simulated by the test case\r
+* Recipient: entity that can receive commands and send responses, and that is queried by the Test Definition or Challenge Definition\r
+(a recipient would be typically a management service, with interfaces (CLI or API) for clients to query)\r
+* Resources: with 3 types (VNF, cloud virtual resource such as a VM, physical resource such as a server)\r
+\r
+Three of these entities have execution-time corresponding classes:\r
+* Test Execution, which captures all the relevant data of the execution of a Test Definition\r
+* Challenge Execution, which captures all the relevant data of the execution of a Challenge Definition\r
+* Metric Value, which captures the a quantitative measurement of a Metric Definition (with a timestamp)\r
+\r
+.. image:: auto-UC02-data1.jpg\r
+\r
+The following diagram illustrates an implementation-independent design of the attributes of these entities:\r
+.. image:: auto-UC02-data2.jpg\r
+\r
+This next diagram shows the Python classes and attributes, as implemented by this Use Case (for all test cases):\r
+\r
+.. image:: auto-UC02-data3.jpg\r
+\r
+Test definition data is stored in serialization files (Python pickles), while test execution data is stored in CSV\r
+files, for easier post-analysis.\r
+\r
+The module design is straightforward: functions and classes for managing data, for interfacing with recipients,\r
+for executing tests, and for interacting with the test user (choosing a Test Definition, showing the details\r
+of a Test Definition, starting the execution).\r
+\r
+.. image:: auto-UC02-module1.jpg\r
+\r
+This last diagram shows the test user menu functions:\r
+\r
+.. image:: auto-UC02-module2.jpg\r
+\r
+In future releases of Auto, testing environments such as FuncTest and Yardstick might be leveraged.\r
+\r
+Also, anonymized test results could be collected from users willing to share them, and aggregates could be\r
+maintained as benchmarks.\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r

diff --git a/docs/release/userguide/UC03-feature.userguide.rst b/docs/release/userguide/UC03-feature.userguide.rst
new file mode 100644 (file)
index 0000000..d7d47d3
--- /dev/null
+++ b/docs/release/userguide/UC03-feature.userguide.rst
@@ -0,0 +1,24 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
+.. http://creativecommons.org/licenses/by/4.0\r
+.. SPDX-License-Identifier CC-BY-4.0\r
+.. (c) optionally add copywriters name\r
+\r
+.. contents::\r
+   :depth: 3\r
+   :local:\r
+\r
+OPNFV Auto Use Case 3: Enterprise vCPE description\r
+=============================================================\r
+.. Describe the specific features and how it is realised in the scenario in a brief manner\r
+.. to ensure the user understand the context for the user guide instructions to follow.\r
+\r
+OPNFV Auto Use Case 3: Enterprise vCPE capabilities and usage\r
+=============================================================\r
+.. Describe the specific capabilities and usage for <XYZ> feature.\r
+.. Provide enough information that a user will be able to operate the feature on a deployed scenario.\r
+\r
+<Feature and API usage guidelines and example>\r
+=============================================================\r
+.. Describe with examples how to use specific features, provide API examples and details required to\r
+.. operate the feature on the platform.\r
+\r

diff --git a/docs/release/userguide/auto-UC02-control-loop-flow.png b/docs/release/userguide/auto-UC02-control-loop-flow.png
new file mode 100644 (file)
index 0000000..b234ece
Binary files /dev/null and b/docs/release/userguide/auto-UC02-control-loop-flow.png differ

diff --git a/docs/release/userguide/auto-UC02-data1.jpg b/docs/release/userguide/auto-UC02-data1.jpg
new file mode 100644 (file)
index 0000000..02a60ba
Binary files /dev/null and b/docs/release/userguide/auto-UC02-data1.jpg differ

diff --git a/docs/release/userguide/auto-UC02-data2.jpg b/docs/release/userguide/auto-UC02-data2.jpg
new file mode 100644 (file)
index 0000000..7096c96
Binary files /dev/null and b/docs/release/userguide/auto-UC02-data2.jpg differ

diff --git a/docs/release/userguide/auto-UC02-data3.jpg b/docs/release/userguide/auto-UC02-data3.jpg
new file mode 100644 (file)
index 0000000..8e8921d
Binary files /dev/null and b/docs/release/userguide/auto-UC02-data3.jpg differ

diff --git a/docs/release/userguide/auto-UC02-module1.jpg b/docs/release/userguide/auto-UC02-module1.jpg
new file mode 100644 (file)
index 0000000..184ab95
Binary files /dev/null and b/docs/release/userguide/auto-UC02-module1.jpg differ

diff --git a/docs/release/userguide/auto-UC02-module2.jpg b/docs/release/userguide/auto-UC02-module2.jpg
new file mode 100644 (file)
index 0000000..b95f42d
Binary files /dev/null and b/docs/release/userguide/auto-UC02-module2.jpg differ

diff --git a/docs/release/userguide/auto-UC02-pattern.jpg b/docs/release/userguide/auto-UC02-pattern.jpg
new file mode 100644 (file)
index 0000000..b2c9dee
Binary files /dev/null and b/docs/release/userguide/auto-UC02-pattern.jpg differ

diff --git a/docs/release/userguide/auto-UC02-preparation.jpg b/docs/release/userguide/auto-UC02-preparation.jpg
new file mode 100644 (file)
index 0000000..e2c0ba5
Binary files /dev/null and b/docs/release/userguide/auto-UC02-preparation.jpg differ

diff --git a/docs/release/userguide/auto-UC02-testcases.jpg b/docs/release/userguide/auto-UC02-testcases.jpg
new file mode 100644 (file)
index 0000000..ccb676f
Binary files /dev/null and b/docs/release/userguide/auto-UC02-testcases.jpg differ

diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst
new file mode 100644 (file)
index 0000000..d59be9f
--- /dev/null
+++ b/docs/release/userguide/index.rst
@@ -0,0 +1,29 @@
+.. _auto-userguide:\r
+\r
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
+.. http://creativecommons.org/licenses/by/4.0\r
+.. (c) <optionally add copywriters name>\r
+\r
+\r
+============================================\r
+OPNFV Auto (ONAP-Automated OPNFV) User Guide\r
+============================================\r
+\r
+.. The feature user guide should provide an OPNFV user with enough information to\r
+.. use the features provided by the feature project in the supported scenarios.\r
+.. This guide should walk a user through the usage of the features once a scenario\r
+.. has been deployed and is active according to the installation guide provided\r
+.. by the installer project.\r
+\r
+.. toctree::\r
+   :maxdepth: 1\r
+\r
+   UC01-feature.userguide.rst\r
+   UC02-feature.userguide.rst\r
+   UC03-feature.userguide.rst\r
+   \r
+.. The feature.userguide.rst files should contain the text for this document\r
+.. additional documents can be added to this directory and added in the right order\r
+.. to this file as a list below.\r
+\r
+\r