summaryrefslogtreecommitdiffstats
path: root/docs/platformoverview/platformoverview.rst
blob: b590f06f7907fa3496b8304bf15ab0184e5af4a5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
------------------------
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.