fix section headers in consistent rule
[opnfvdocs.git] / docs / platformoverview / introduction.rst
1 ============
2 Introduction
3 ============
4
5 The OPNFV project provides different kinds of output to its users:
6
7 1. **Target Software Platform**
8
9    This provides the software which will run as NFVI and VIM in an actual NFV deployment
10    It is an integrated solution of several other open source projects, e.g. OpenStack,
11    Linux, ODL.
12
13 2. **Deployment Tools**
14
15    So called installers help the user deploy target software on his hardware.
16    OPNFV provides multiple options to do this.
17
18 3. **Test Cases and Framework**
19
20    The target software platform can be verified and evaluated using these testcases.
21    Their goal is to show that the deployed platform is usable to run VNFs.
22
23 4. **Documentation**
24
25    OPNFV provides the necessary documents describing target software platform, deployment
26    tools, tests, etc. in their architecture and usage.
27
28 5. **Requirements**
29
30    OPNFV community works on requirements of open source projects used in OPNFV to
31    make these projects better suitable for NFV telco carrier use cases.
32    These requirements are described in requirement documents and also forwarded
33    to the "upstream" projects in the format required by these projects.
34
35 6. **Community Labs**
36
37    OPNFV creates lab environments not only for development of OPNFV, but also to help
38    build the NFV ecosystem. OPNFV labs follow a defined structure and configuration.
39    Some of the labs have their dedicated tasks in the development environment, some of
40    the labs will be provided for open use.
41
42 **OPNFV Releases**
43
44 OPNFV bundles the target software, installers, documentation, test cases and lab
45 description to releases and provides documentation describing the scope and features
46 provided.
47
48 Since OPNFV releases contain different options (e.g. for installers, SDN controllers, etc.)
49 We define a set of scenarios, that is a set of components, combinations
50 and associated configuration.
51 This set of scenarios shows which combinations of components and features are tested as
52 part of the OPNFV release.
53
54 This overview document introduces these components and scenarios on a high level and
55 points you to more
56 detailed documentation.
57 It describes the OPNFV Brahmaputra release.
58
59 OPNFV Requirement documents typically describe requirements that will be implemented in
60 later releases of OPNFV. Thus they are not part of a release package.
61
62 Also community labs are independent of releases. Only the lab description is included in
63 the release and describes the requirements of a lab to successfully run Brahmaputra
64 deployments.