summaryrefslogtreecommitdiffstats
path: root/docs/platformoverview/introduction.rst
diff options
context:
space:
mode:
authorChristopherPrice <christopher.price@ericsson.com>2016-02-24 23:20:43 +0100
committerChristopherPrice <christopher.price@ericsson.com>2016-02-25 01:37:23 +0100
commit4cb9b020b922c090061a2dee77fa8ad77394d7b9 (patch)
treef6bd875052a1736050581250245fe7b08ab44ed0 /docs/platformoverview/introduction.rst
parent0d5c7b5b68fda47b1ee908ea9e002b30881ed83b (diff)
Updating the overview doc with recent comments.
Change-Id: I181279f9b0a4330bb98a3e0d40ecb2687d976b92 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
Diffstat (limited to 'docs/platformoverview/introduction.rst')
-rw-r--r--docs/platformoverview/introduction.rst24
1 files changed, 12 insertions, 12 deletions
diff --git a/docs/platformoverview/introduction.rst b/docs/platformoverview/introduction.rst
index 0c878afbb..eab30e9b1 100644
--- a/docs/platformoverview/introduction.rst
+++ b/docs/platformoverview/introduction.rst
@@ -12,7 +12,7 @@ Introduction
OPNFV is an integration effort that takes outputs from several open source communities to build a NFV platform. This task of integration leads to providing different kinds of output to its users.
-The primary goal of the OPNFV project is the **target software platform**, which is a integrated solution
+The primary goal of the OPNFV project is the target software platform, which is a integrated solution
of a set of components/building blocks of the ETSI ISG NFV reference architecture.
In the Brahmaputra release, this is limited to the NFVI and VIM blocks.
OPNFV users will be able to deploy their VNFs there using some MANO solution.
@@ -22,9 +22,9 @@ possible and a subset is provided and tested by the Brahmaputra release. These s
are called here scenarios.
Besides the target software platform, OPNFV provides a set of tools that helps the user
-deploy this target software platform on a set of servers. These tools are called
-**installers**. Brahmaputra provides multiple options here. Naturally the different installers
-have different capabilities, that is they support deployment of different **scenarios**.
+deploy this target software platform on a set of servers. These tools are installers.
+Brahmaputra provides multiple options here. Naturally the different installers
+have different capabilities, that is they support deployment of different scenarios.
The installers allow users to deploy OPNFV target software platform on a bare metal environment
or a set of virtual machines. In both cases, some hosts (bare metal or virtual) will act
@@ -36,33 +36,33 @@ The jump server also can be bare metal or virtual.
This configuration - jump servers and a set of typically 5 nodes to run the target software platform -
is also described as part of an OPNFV release. This allows the users to build their own labs
accordingly and deploy OPNFV easily. A lab compliant to this description sometimes is called
-**"Pharos-compliant"** after the OPNFV project providing the lab description.
+"Pharos-compliant" after the OPNFV project providing the lab description.
-Another major part of the OPNFV release is a **testing framework** and test cases.
+Another major part of the OPNFV release is a testing framework and test cases.
This test framework allows users to verify their deployment of the OPNFV target software platform.
It will execute and test major functions of the platform relevant to NFV applications (VNFs) so
the user can be confident that VNFs can successfully run.
-Of course, the OPNFV releases come with the necessary **documentation**, describing
-target software platform, deployment tools, tests, etc. in their architecture, configuration and usage.
+OPNFV releases come with the necessary documentation describing
+target software platform, deployment tools, test cases, etc. in their architecture, configuration and usage.
The most important documents here are configuration guides and user guides that help to set up
a OPNFV deployment and use it.
-The OPNFV project takes major effort to provide **lab environments** to the community.
+The OPNFV project takes major effort to provide lab environments to the community.
The OPNFV community labs of course need to be Pharos-compliant. They are used for OPNFV development
tasks and release creation, but should also provide users with the opportunity to run their own
OPNFV tests. OPNFV community labs are not part of a OPNFV release.
Please find more information on the labs in the
-`Pharos project documentation <http://artifacts.opnfv.org/pharos/docs/index.html>`_.
+`Pharos project documentation <http://artifacts.opnfv.org/pharos/brahmaputra/docs/index.html>`_.
-We should also mention that OPNFV works on **requirements** of open source projects used in OPNFV to
+We should also mention that OPNFV 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.
These requirement documents are not bound to OPNFV releases.
OPNFV bundles the target software, installers, documentation, test cases and lab
-description to **releases**.
+description to releases.
This overview document introduces these components and scenarios on a high level and
points you to more detailed documentation.