summaryrefslogtreecommitdiffstats
path: root/docs/platformoverview/introduction.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/platformoverview/introduction.rst')
-rw-r--r--docs/platformoverview/introduction.rst66
1 files changed, 66 insertions, 0 deletions
diff --git a/docs/platformoverview/introduction.rst b/docs/platformoverview/introduction.rst
new file mode 100644
index 000000000..495655106
--- /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.
+
+