diff options
Diffstat (limited to 'docs/installationprocedure')
| -rw-r--r-- | docs/installationprocedure/abstract.rst | 0 | ||||
| -rw-r--r-- | docs/installationprocedure/index.rst | 15 | ||||
| -rw-r--r-- | docs/installationprocedure/scenario.installation.instruction.rst | 26 | ||||
| -rw-r--r-- | docs/installationprocedure/scenario.release.notes.rst | 132 |
4 files changed, 173 insertions, 0 deletions
diff --git a/docs/installationprocedure/abstract.rst b/docs/installationprocedure/abstract.rst new file mode 100644 index 000000000..e69de29bb --- /dev/null +++ b/docs/installationprocedure/abstract.rst diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst new file mode 100644 index 000000000..9503c7b50 --- /dev/null +++ b/docs/installationprocedure/index.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Sofia Wallin Ericsson AB + +********************** +Installation procedure +********************** + +.. toctree:: + :numbered: + :maxdepth: 2 + + abstract.rst + scenario.installation.instruction + diff --git a/docs/installationprocedure/scenario.installation.instruction.rst b/docs/installationprocedure/scenario.installation.instruction.rst new file mode 100644 index 000000000..a3ddd3ac8 --- /dev/null +++ b/docs/installationprocedure/scenario.installation.instruction.rst @@ -0,0 +1,26 @@ +.. 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> + +=================================== +<scenario> installation instruction +=================================== + +Preparing the installation +-------------------------- +.. List the activities needed prior to installation and dependent feature configurations that +.. need to be is to be configured during this process. + +HW requirements +--------------- +.. A generic Pharos lab preparation instruction will be provided, this section should describe +.. scenario has any specific hardware or hardware configuration needs. + +Installation instruction +------------------------ +.. List of steps needed to install each verified installer. + +Post-installation activities +---------------------------- +.. List the activities needed post installation. + diff --git a/docs/installationprocedure/scenario.release.notes.rst b/docs/installationprocedure/scenario.release.notes.rst new file mode 100644 index 000000000..545e1d9bf --- /dev/null +++ b/docs/installationprocedure/scenario.release.notes.rst @@ -0,0 +1,132 @@ +.. 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> + +================================================= +Release Note for the Brahmaputra release of OPNFV +================================================= + +.. toctree:: + :maxdepth: 2 + +Abstract +======== + +This document compiles the release notes for the Brahmaputra release of +OPNFV when using <XYZ> as a deployment tool. + +Introduction +============ + +Provide a breif introduction of how this release is used in OPNFV relese using <XYZ> as a deployment tool + +Be sure to reference your installation-instructions. + +Release Data +============ + ++--------------------------------------+--------------------------------------+ +| **Project** | | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/tag** | | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | | +| | | ++--------------------------------------+--------------------------------------+ + +Deliverables +------------ + +Software deliverables +~~~~~~~~~~~~~~~~~~~~~ +<XYZ>-based installer iso file <iso file version> + +Documentation deliverables +~~~~~~~~~~~~~~~~~~~~~~~~~~ +- + +Version change +-------------- +.. This section describes the changes made since the last version of this document. + +Module version change +~~~~~~~~~~~~~~~~~~~~~ + +Document version change +~~~~~~~~~~~~~~~~~~~~~~~ + +Reason for new version +---------------------- + +Feature additions +~~~~~~~~~~~~~~~~~ + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | | +| | | ++--------------------------------------+--------------------------------------+ + +Bug corrections +~~~~~~~~~~~~~~~ + +**JIRA TICKETS:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | | +| | | ++--------------------------------------+--------------------------------------+ + + +Known Limitations, Issues and Workarounds +========================================= + +System Limitations +------------------ + +Known issues +------------ + +**JIRA TICKETS:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | | ++--------------------------------------+--------------------------------------+ +| JIRA: | | ++--------------------------------------+--------------------------------------+ + + +Workarounds +----------- +See JIRA: <link> + + +Test Result +=========== +Brahmaputra test result using <XYZ> as deployment tool. +<link> + +References +========== +For more information on the OPNFV Brahmaputra release, please visit +http://www.opnfv.org/brahmaputra + |