From e042f556c6c25858f328cb6287c164b2514a2561 Mon Sep 17 00:00:00 2001 From: Sofia Wallin Date: Mon, 15 Aug 2016 15:20:50 +0200 Subject: WIP: Created 2 introduction documents for user guide and installation Work on the contant in both installation and user guide Started to add artifacts in the installation instruction and user guide This is a first draft of the installation.introduction.rst and userguide.introduction.rst. Some of the information has been reused from the Brahmaputra docs with modifications. Please comment and add as needed/wanted. Change-Id: I0c6d79aac7d1152ec894986dda251ad2d3c7048e Signed-off-by: Sofia Wallin --- docs/installationprocedure/abstract.rst | 7 - .../feature.configuration.rst | 21 --- docs/installationprocedure/index.rst | 14 +- .../installation.introduction.rst | 84 +++++++++++ .../scenario.installation.instruction.rst | 26 ---- .../scenario.release.notes.rst | 134 ------------------ .../template-os-nosdn-nofeature-ha/abstract.rst | 15 -- .../template-os-nosdn-nofeature-ha/deployment.rst | 32 ----- .../hardware.requirements.rst | 27 ---- .../template-os-nosdn-nofeature-ha/index.rst | 24 ---- .../install.config.rst | 156 --------------------- .../install.optional.rst | 73 ---------- .../installation.rst | 155 -------------------- .../introduction.rst | 18 --- .../template-os-nosdn-nofeature-ha/post.deploy.rst | 16 --- .../template-os-nosdn-nofeature-ha/preparation.rst | 101 ------------- .../template-os-nosdn-nofeature-ha/references.rst | 51 ------- docs/userguide/abstract.rst | 16 --- docs/userguide/common.platform.render.rst | 26 ---- docs/userguide/feature.userguide.render.rst | 15 -- docs/userguide/feature.userguide.template.rst | 12 -- docs/userguide/index.rst | 11 +- docs/userguide/introduction.rst | 65 --------- docs/userguide/onos.rst | 51 ------- docs/userguide/opendaylight.rst | 55 -------- docs/userguide/openstack.rst | 50 ------- docs/userguide/userguide.introduction.rst | 58 ++++++++ 27 files changed, 148 insertions(+), 1165 deletions(-) delete mode 100644 docs/installationprocedure/abstract.rst delete mode 100644 docs/installationprocedure/feature.configuration.rst create mode 100644 docs/installationprocedure/installation.introduction.rst delete mode 100644 docs/installationprocedure/scenario.installation.instruction.rst delete mode 100644 docs/installationprocedure/scenario.release.notes.rst delete mode 100644 docs/installationprocedure/template-os-nosdn-nofeature-ha/abstract.rst delete mode 100644 docs/installationprocedure/template-os-nosdn-nofeature-ha/deployment.rst delete mode 100644 docs/installationprocedure/template-os-nosdn-nofeature-ha/hardware.requirements.rst delete mode 100644 docs/installationprocedure/template-os-nosdn-nofeature-ha/index.rst delete mode 100644 docs/installationprocedure/template-os-nosdn-nofeature-ha/install.config.rst delete mode 100644 docs/installationprocedure/template-os-nosdn-nofeature-ha/install.optional.rst delete mode 100644 docs/installationprocedure/template-os-nosdn-nofeature-ha/installation.rst delete mode 100644 docs/installationprocedure/template-os-nosdn-nofeature-ha/introduction.rst delete mode 100644 docs/installationprocedure/template-os-nosdn-nofeature-ha/post.deploy.rst delete mode 100644 docs/installationprocedure/template-os-nosdn-nofeature-ha/preparation.rst delete mode 100644 docs/installationprocedure/template-os-nosdn-nofeature-ha/references.rst delete mode 100644 docs/userguide/abstract.rst delete mode 100644 docs/userguide/common.platform.render.rst delete mode 100644 docs/userguide/feature.userguide.render.rst delete mode 100644 docs/userguide/feature.userguide.template.rst delete mode 100644 docs/userguide/introduction.rst delete mode 100644 docs/userguide/onos.rst delete mode 100644 docs/userguide/opendaylight.rst delete mode 100644 docs/userguide/openstack.rst create mode 100644 docs/userguide/userguide.introduction.rst (limited to 'docs') diff --git a/docs/installationprocedure/abstract.rst b/docs/installationprocedure/abstract.rst deleted file mode 100644 index b9b85b0c0..000000000 --- a/docs/installationprocedure/abstract.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) - -This document will give the user instructions on how to deploy -available scenarios verfied for the Colorado release of the OPNFV -platform. diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/installationprocedure/feature.configuration.rst deleted file mode 100644 index 267efd5c1..000000000 --- a/docs/installationprocedure/feature.configuration.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) - -===================================================== - installation and configuration instruction -===================================================== - -Abstract -======== -This document provides information on how to configure required -components during the installation of the platform. - -Pre-configuration activites -=========================== -List the information and activities needed as pre configuration. - -Feature configuration -===================== -List the steps needed for the configuration of and of the scenario. - diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst index e69204b98..3d02f310b 100644 --- a/docs/installationprocedure/index.rst +++ b/docs/installationprocedure/index.rst @@ -2,17 +2,13 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Sofia Wallin Ericsson AB -********************** -Installation procedure -********************** -Colorado 1.0 ------------- +****************************** +OPNFV Installation Instruction +****************************** .. toctree:: :numbered: - :maxdepth: 2 + :maxdepth: 3 - abstract.rst - scenario.installation.instruction.rst - scenario.release.notes.rst + installation.introduction.rst diff --git a/docs/installationprocedure/installation.introduction.rst b/docs/installationprocedure/installation.introduction.rst new file mode 100644 index 000000000..ae4a601ae --- /dev/null +++ b/docs/installationprocedure/installation.introduction.rst @@ -0,0 +1,84 @@ +.. 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 + +======== +Abstract +======== + +The following document provides an overview of the instructions required for the installation +of the Colorado release of OPNFV. + +The Colorado release can be installed using a variety of technologies provided by the +integration projects participating in OPNFV: Apex, Compass4Nfv, Fuel and JOID. +Each installer provides the ability to install a common OPNFV platform as well as integrating +additional features delivered through a variety of scenarios by the OPNFV community. + +============ +Introduction +============ + +The OPNFV platform is comprised of a variety of upstream components that may be deployed on your physical +infrastructure. A composition of components, tools and configurations is identified in OPNFV as a +deployment scenario. +The various OPNFV scenarios provide unique features and capabilities that you may want to leverage, +it is important to understand your required target platform capabilities before installing and +configuring your target scenario. + +An OPNFV installation requires either a physical, or virtual, infrastructure environment as defined +in the `Pharos specification `_. +When configuring a physical infrastructure it is strongly advised to follow the Pharos configuration guidelines. + +========= +Scenarios +========= + +OPNFV scenarios are designed to host virtualised network functions (VNF’s) in a variety of deployment +architectures and locations. Each scenario provides specific capabilities and/or components aimed to +solve specific problems for the deployment of VNF’s. +A scenario may, for instance, include components such as OpenStack, OpenDaylight, OVS, KVM etc... +where each scenario will include different source components or configurations. + +To learn more about the scenarios supported in the Colorado release refer to the scenario +description documents provided: + +- Accelerated OVS `os-nosdn-ovs `_ +- FD.io based forwarding `os-nosdn-fdio-noha `_ +- Layer 3 overlay using opendaylight `os-odl-l2-bgpvpn `_ +- FD.io based forwarding using opendaylight SDN `os-odl-12-fdio-noha `_ +- High availability service function chaining `os-odl-l2-sfc-ha `_ +- Service function chaining `os-odl-l2-sfc-noha `_ +- `os-odl-l2-moon-ha `_ + +====================== +Installation Procedure +====================== + +Detailed step by step instructions for working with an installation toolchain and installing +the required scenario are provided by each installation project. The four projects providing installation +support for the OPNFV Colorado release are; Apex, Compass4nfv, Fuel and Joid. + +The instructions for each toolchain can be found in these links: + +- `Apex installation instruction `_ +- `Compass4nfv installation instruction `_ +- `Fuel installation instruction `_ +- `Joid installation instruction `_ + +===================== +OPNFV Test Frameworks +===================== + +If you have elected to install the OPNFV platform using the deployment toolchain provided by OPNFV +your system will have been validated once the installation is completed. +The basic deployment validation only addresses a small component of the capability provided in +the platform and you may desire to execute more exhaustive tests. Some investigation is required to +select the right test suites to run on your platform from the available projects and suites. + +Many of the OPNFV test project provide user-guide documentation and installation instructions as provided below: + +- `Functest user guide `_ +- `Yardstick user guide `_ +- `vSwitchPerf user guide `_ +- `Software Fastpath Service Quality Metrics (SFQM) user guide `_ +- `Bottlenecks user guide `_ diff --git a/docs/installationprocedure/scenario.installation.instruction.rst b/docs/installationprocedure/scenario.installation.instruction.rst deleted file mode 100644 index a3ddd3ac8..000000000 --- a/docs/installationprocedure/scenario.installation.instruction.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) - -=================================== - 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 deleted file mode 100644 index eaffd9b19..000000000 --- a/docs/installationprocedure/scenario.release.notes.rst +++ /dev/null @@ -1,134 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) - -=========================== -Release Note for -=========================== -Colorado 1.0 ------------- - -.. toctree:: - :maxdepth: 2 - -Abstract -======== - -This document contains the release notes for the Colorado release of -OPNFV when using . - -Introduction -============ - -Provide a breif introduction of how this configuration is used in OPNFV relese using as scenario. - -Be sure to reference your scenario installation instruction. - -Release Data -============ - -+--------------------------------------+--------------------------------------+ -| **Project** | | -| | | -+--------------------------------------+--------------------------------------+ -| **Repo/tag** | | -| | | -+--------------------------------------+--------------------------------------+ -| **Release designation** | | -| | | -+--------------------------------------+--------------------------------------+ -| **Release date** | | -| | | -+--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | | -| | | -+--------------------------------------+--------------------------------------+ - -Deliverables ------------- - -Software deliverables -~~~~~~~~~~~~~~~~~~~~~ --based installer iso file - -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: - - -Test Result -=========== -Brahmaputra test result using as deployment tool. - - -References -========== -For more information on the OPNFV Brahmaputra release, please visit -http://www.opnfv.org/brahmaputra - diff --git a/docs/installationprocedure/template-os-nosdn-nofeature-ha/abstract.rst b/docs/installationprocedure/template-os-nosdn-nofeature-ha/abstract.rst deleted file mode 100644 index ae15012ca..000000000 --- a/docs/installationprocedure/template-os-nosdn-nofeature-ha/abstract.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International -.. License. .. http://creativecommons.org/licenses/by/4.0 .. -.. (c) Christopher Price (Ericsson AB) and others - -Abstract -======== -.. Provide a brief abstract of the document and what it provides, in this case a -.. vanilla opnfv deployment using fuel is provided as a template. This template is -.. not accurate and does not provide instructions to deploy a Colorado scenario. - -This document describes how to install the