Platformoverview structured in separate files per section and added some content

Jira: DOCS-42
Next step to create platform overview document.
Proper use of index.rst, separate files per major section.
Started to provide content.

Change-Id: I542ae1ed334d9832bbed24926213ce651d2ae4ce
Signed-off-by: ulik <ulrich.kleber@huawei.com>

diff --git a/docs/platformoverview/deploymenttools.rst b/docs/platformoverview/deploymenttools.rst
new file mode 100644 (file)
index 0000000..996bca2
--- /dev/null
+++ b/docs/platformoverview/deploymenttools.rst
@@ -0,0 +1,46 @@
+----------------
+Deployment Tools
+----------------
+
+Brahmaputra provides 4 different installers.
+
+The installers will deploy the target platform onto a set of virtual or bare metal servers according
+to the configuration files. After the deployment, it doesn't matter which of the installers had been used
+to deploy the target scenario.
+
+
+Apex
+====
+
+Apex is an OPNFV Installation tool based on RDO Manager that deploys OPNFV using the RDO Project
+OpenStack Distribution.
+RDO manager is a Triple-O based installation tool.
+Triple-O is an image based life cycle deployment tool that is a member of the OpenStack Big Tent Governance.
+
+Apex uses Centos on all target platforms and can deploy all SDN controllers.
+
+Compass
+=======
+
+Compass is an installer project based on open source project Compass, which provides automated deployment
+and management of OpenStack and other distributed systems.
+It can be considered as what the LiveCD to a single box for a pool of servers – bootstrapping the server pool.
+
+Compass is based on Ansible.
+It can deploy Ubuntu or Centos as target operating system and ODL and ONOS as SDN controllers.
+
+
+Fuel
+====
+
+Editors note:
+Just a high level intro and link to the main fuel documents.
+
+Joid
+====
+
+Editors note:
+Just a high level intro and link to the main joid documents.
+
+
+

diff --git a/docs/platformoverview/index.rst b/docs/platformoverview/index.rst
index 44a48e5..6f01e57 100644 (file)
--- a/docs/platformoverview/index.rst
+++ b/docs/platformoverview/index.rst
@@ -10,15 +10,14 @@ OPNFV Platform Overview document
 Contents:
 
 .. toctree::
-   :maxdepth: 4
-
-   platformoverview.rst
-
+   :maxdepth: 2
 
+   ./introduction.rst
+   ./softwarearchitecture.rst
+   ./deploymenttools.rst
+   ./testcasesframework.rst
 
 Indices and tables
 ==================
 
-* :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`

diff --git a/docs/platformoverview/introduction.rst b/docs/platformoverview/introduction.rst
new file mode 100644 (file)
index 0000000..4956551
--- /dev/null
+++ b/docs/platformoverview/introduction.rst
@@ -0,0 +1,66 @@
+------------------------
+Introduction
+------------------------
+
+The OPNFV project provides different kinds of output to its users:
+
+1. **Target Software Platform**
+
+   This provides the software which will run as NFVI and VIM in an actual NFV deployment
+   It is an integrated solution of several other open source projects, e.g. OpenStack,
+   Linux, ODL.
+
+2. **Deployment Tools**
+
+   So called installers help the user deploy target software on his hardware.
+   OPNFV provides multiple options to do this.
+
+3. **Test Cases and Framework**
+
+   The target software platform can be verified and evaluated using these testcases.
+   Their goal is to show that the deployed platform is usable to run VNFs.
+
+4. **Documentation**
+
+   OPNFV provides the necessary documents describing target software platform, deployment
+   tools, tests, etc. in their architecture and usage.
+
+5. **Requirements**
+
+   OPNFV community works on requirements of open source projects used in OPNFV to
+   make these projects better suitable for NFV telco carrier use cases.
+   These requirements are described in requirement documents and also forwarded
+   to the "upstream" projects in the format required by these projects.
+
+6. **Community Labs**
+
+   OPNFV creates lab environments not only for development of OPNFV, but also to help
+   build the NFV ecosystem. OPNFV labs follow a defined structure and configuration.
+   Some of the labs have their dedicated tasks in the development environment, some of
+   the labs will be provided for open use.
+
+**OPNFV Releases**
+
+OPNFV bundles the target software, installers, documentation, test cases and lab
+description to releases and provides documentation describing the scope and features
+provided.
+
+Since OPNFV releases contain different options (e.g. for installers, SDN controllers, etc.)
+We define a set of scenarios, that is a set of components, combinations
+and associated configuration.
+This set of scenarios shows which combinations of components and features are tested as
+part of the OPNFV release.
+
+This overview document introduces these components and scenarios on a high level and
+points you to more
+detailed documentation.
+It describes the OPNFV Brahmaputra release.
+
+OPNFV Requirement documents typically describe requirements that will be implemented in
+later releases of OPNFV. Thus they are not part of a release package.
+
+Also community labs are independent of releases. Only the lab description is included in
+the release and describes the requirements of a lab to successfully run Brahmaputra
+deployments.
+
+

diff --git a/docs/platformoverview/platformoverview.rst b/docs/platformoverview/platformoverview.rst
deleted file mode 100644 (file)
index b590f06..0000000
--- a/docs/platformoverview/platformoverview.rst
+++ /dev/null
@@ -1,174 +0,0 @@
-------------------------
-Introduction
-------------------------
-
-The OPNFV project provides different kinds of output to its users:
-
-1. **Target Software Platform**
-
-   This provides the software which will run as NFVI and VIM in an actual NFV deployment
-   It is an integrated solution of several other open source projects, e.g. OpenStack,
-   Linux, ODL.
-
-2. **Deployment Tools**
-
-   So called installers help the user deploy target software on his hardware.
-   OPNFV provides multiple options to do this.
-
-3. **Test Cases and Framework**
-
-   The target software platform can be verified and evaluated using these testcases.
-   Their goal is to show that the deployed platform is usable to run VNFs.
-
-4. **Documentation**
-
-   OPNFV provides the necessary documents describing target software platform, deployment
-   tools, tests, etc. in their architecture and usage.
-
-5. **Requirements**
-
-   OPNFV community works on requirements of open source projects used in OPNFV to
-   make these projects better suitable for NFV telco carrier use cases.
-   These requirements are described in requirement documents and also forwarded
-   to the "upstream" projects in the format required by these projects.
-
-6. **Community Labs**
-
-   OPNFV creates lab environments not only for development of OPNFV, but also to help
-   build the NFV ecosystem. OPNFV labs follow a defined structure and configuration.
-   Some of the labs have their dedicated tasks in the development environment, some of
-   the labs will be provided for open use.
-
-**OPNFV Releases**
-
-OPNFV bundles the target software, installers, documentation, test cases and lab
-description to releases and provides documentation describing the scope and features
-provided.
-
-This overview document introduces these components on a high level and points you to more
-detailed documentation.
-It describes the OPNFV Brahmaputra release.
-
-OPNFV Requirement documents typically describe requirements that will be implemented in
-later releases of OPNFV. Thus they are not part of a release package.
-
-Also community labs are independent of releases. Only the lab description is included in
-the release and describes the requirements of a lab to successfully run Brahmaputra
-deployments.
-
-
-------------------------
-Target software platform
-------------------------
-
-Software architecture
-=====================
-
-This section will provide information which upstream projects, versions and components are
-integrated in the Brahmaputra release
-
-OpenStack
----------
-
-OPNFV uses OpenStack as cloud management system.
-Brahmaputra is based on OpenStack Liberty Release. It comprises the following sub-projects
-and modules:
-
-* Nova
-* Neutron
-* Cinder
-* Ceilometer
-* etc.
-
-Operating System
-----------------
-
-OPNFV uses Linux on all target machines. Depending on the installers, different
-distributions are supported.
-
-Editors note:
-Add a table showing which installer supports which operating system for controller nodes and for compute nodes.
-
-
-SDN Controllers
----------------
-
-OPNFV Brahmaputra release supports three different SDN controllers:
-
-* OpenDaylight
-* ONOS
-* OpenContrail
-
-Depending on the SDN controller you are using, the featureset will vary.
-
-OpenDaylight
-++++++++++++
-
-Editor's note:
-We need a high level paragraph here and a description of how we use ODL.
-
-ONOS
-++++
-
-Editors note:
-We need a high level paragraph here and a description of how we use ONOS, especially the
-relation of ONOS and ONOSFW project's integration and features.
-
-OpenContrail
-++++++++++++
-
-Editors note:
-We need a high level paragraph here and a description of how we use OpenContrail, including
-its vRouter capabilities.
-
-Data Plane
-----------
-
-Other Components
-----------------
-
-Deployment Architecture
-=======================
-
-Editors note:
-Short description that we use a typical configuration with 3 controller nodes running
-OpenStack, SDN, etc. and a minimum of 2 compute nodes for deployment of the VNFs.
-Also mention that we use a "jumphost" for the initial bring-up, and the deployment of the
-test framework.
-
-In a second level of detail, describe how software is distributed over the 3 controller
-nodes, compute nodes and other hardware.
-
-Dynamic View
-============
-
-Editors note: we might skip this section completely for Brahmaputra.
-
-Or we provide rather short statements. In later versions, we have to describe which
-software is involved in which way during:
-
-* VNF Life Cycle (onboarding, instantiate, scaling): we can reference to other documents
-* Hardware Life Cycle (mainly how to add compute nodes, but also other cases)
-* ...
-
-----------------
-Deployment Tools
-----------------
-
-Brahmaputra provides 4 different installers
-
-Editors note:
-A table to summarize main characteristics would be nice
-
-We also need to list restrictions or dependencies like which installer can install which SDN......
-
------------------------
-Testcases and Framework
------------------------
-
-Editors note:
-Just a high level description about the different types of tests and the role of yardstick as central framework.
-
-
-
-

diff --git a/docs/platformoverview/softwarearchitecture.rst b/docs/platformoverview/softwarearchitecture.rst
new file mode 100644 (file)
index 0000000..c8593c4
--- /dev/null
+++ b/docs/platformoverview/softwarearchitecture.rst
@@ -0,0 +1,123 @@
+------------------------
+Target software platform
+------------------------
+
+Software architecture
+=====================
+
+This section will provide information which upstream projects, versions and components are
+integrated in the Brahmaputra release
+
+OpenStack
+---------
+
+OPNFV uses OpenStack as cloud management system.
+Brahmaputra is based on OpenStack Liberty Release. It comprises the following sub-projects
+and modules:
+
+* Nova (Compute)
+* Neutron (Network)
+* Cinder (Block Storage)
+* Swift (Object Storage)
+* Ceilometer (Telemetry)
+* Keystone (Identity)
+* Glance (Image Service)
+* Heat (Orchestration)
+* etc.
+
+Some of the sub-projects are not deployed in all scenarios.
+Besides target software, also deployment and test framework use OpenStack components
+(Fuel, Tempest, Rally)
+
+
+Operating System
+----------------
+
+OPNFV uses Linux on all target machines. Depending on the installers, different
+distributions are supported.
+
+Ubuntu 14 supported by Fuel, Compass and Joid installers
+CentOS 7 supported by Apex and Compass
+
+
+SDN Controllers
+---------------
+
+OPNFV Brahmaputra release supports three different SDN controllers:
+
+* OpenDaylight
+* ONOS
+* OpenContrail
+
+Depending on the SDN controller you are using, the featureset will vary.
+
+OpenDaylight
+++++++++++++
+
+Editor's note:
+We need a high level paragraph here and a description of how we use ODL.
+
+
+ONOS
+++++
+
+Editors note:
+We need a high level paragraph here and a description of how we use ONOS, especially the
+relation of ONOS and ONOSFW project's integration and features.
+
+OpenContrail
+++++++++++++
+
+Editors note:
+We need a high level paragraph here and a description of how we use OpenContrail, including
+its vRouter capabilities.
+
+Data Plane
+----------
+
+Other Components
+----------------
+
+Deployment Architecture
+=======================
+
+OPNFV starts with a typical configuration with 3 controller nodes running
+OpenStack, SDN, etc. and a minimum of 2 compute nodes for deployment of VNFs.
+A detailed description of this 5 node configuration can be found in pharos documentation.
+
+The 3 controller nodes allow to provide an HA configuration. The number of compute
+nodes can be increased dynamically after the initial deployment.
+
+OPNFV can be deployed on bare metal or in a virtual environment, where each of the hosts
+is a virtual machine and provides the virtual resources using nested virtualization.
+
+The initial deployment is done using a so-called "jumphost". This server (either bare metal
+or virtual) is first installed with the installer program that then installs OpenStack
+and other components on the controller nodes and compute nodes. See the installer
+documentation for more details.
+
+Editors note:
+In a second level of detail, describe how software is distributed over the 3 controller
+nodes, compute nodes and other hardware.
+
+In Brahmaputra, the following scenarios are supported:
+
+
+
+
+Dynamic View
+============
+
+Editors note: we might skip this section completely for Brahmaputra.
+
+Or we provide rather short statements. In later versions, we have to describe which
+software is involved in which way during:
+
+* VNF Life Cycle (onboarding, instantiate, scaling): we can reference to other documents
+* Hardware Life Cycle (mainly how to add compute nodes, but also other cases)
+* ...
+
+
+
+
+

diff --git a/docs/platformoverview/testcasesframework.rst b/docs/platformoverview/testcasesframework.rst
new file mode 100644 (file)
index 0000000..f06c98b
--- /dev/null
+++ b/docs/platformoverview/testcasesframework.rst
@@ -0,0 +1,10 @@
+-----------------------
+Testcases and Framework
+-----------------------
+
+Editors note:
+Just a high level description about the different types of tests and the role of yardstick as central framework.
+
+
+
+