fix section headers in consistent rule
[opnfvdocs.git] / docs / platformoverview / softwarearchitecture.rst
1 ========================
2 Target software platform
3 ========================
4
5 Software architecture
6 =====================
7
8 This section will provide information which upstream projects, versions and components are
9 integrated in the Brahmaputra release
10
11 OpenStack
12 ---------
13
14 OPNFV uses OpenStack as cloud management system.
15 Brahmaputra is based on OpenStack Liberty Release. It comprises the following sub-projects
16 and modules:
17
18 * Nova (Compute)
19 * Neutron (Network)
20 * Cinder (Block Storage)
21 * Swift (Object Storage)
22 * Ceilometer (Telemetry)
23 * Keystone (Identity)
24 * Glance (Image Service)
25 * Heat (Orchestration)
26 * etc.
27
28 Some of the sub-projects are not deployed in all scenarios.
29 Besides target software, also deployment and test framework use OpenStack components
30 (Fuel, Tempest, Rally)
31
32
33 Operating System
34 ----------------
35
36 OPNFV uses Linux on all target machines. Depending on the installers, different
37 distributions are supported.
38
39 Ubuntu 14 supported by Fuel, Compass and Joid installers
40 CentOS 7 supported by Apex and Compass
41
42
43 SDN Controllers
44 ---------------
45
46 OPNFV Brahmaputra release supports three different SDN controllers:
47
48 * OpenDaylight
49 * ONOS
50 * OpenContrail
51
52 Depending on the SDN controller you are using, the featureset will vary.
53
54 OpenDaylight
55 ++++++++++++
56
57 Editor's note:
58 We need a high level paragraph here and a description of how we use ODL.
59
60
61 ONOS
62 ++++
63
64 Editors note:
65 We need a high level paragraph here and a description of how we use ONOS, especially the
66 relation of ONOS and ONOSFW project's integration and features.
67
68 OpenContrail
69 ++++++++++++
70
71 Editors note:
72 We need a high level paragraph here and a description of how we use OpenContrail, including
73 its vRouter capabilities.
74
75 Data Plane
76 ----------
77
78 Other Components
79 ----------------
80
81 Deployment Architecture
82 =======================
83
84 OPNFV starts with a typical configuration with 3 controller nodes running
85 OpenStack, SDN, etc. and a minimum of 2 compute nodes for deployment of VNFs.
86 A detailed description of this 5 node configuration can be found in pharos documentation.
87
88 The 3 controller nodes allow to provide an HA configuration. The number of compute
89 nodes can be increased dynamically after the initial deployment.
90
91 OPNFV can be deployed on bare metal or in a virtual environment, where each of the hosts
92 is a virtual machine and provides the virtual resources using nested virtualization.
93
94 The initial deployment is done using a so-called "jumphost". This server (either bare metal
95 or virtual) is first installed with the installer program that then installs OpenStack
96 and other components on the controller nodes and compute nodes. See the installer
97 documentation for more details.
98
99 Editors note:
100 In a second level of detail, describe how software is distributed over the 3 controller
101 nodes, compute nodes and other hardware.
102
103 In Brahmaputra, the following scenarios are supported:
104
105
106
107
108 Dynamic View
109 ============
110
111 Editors note: we might skip this section completely for Brahmaputra.
112
113 Or we provide rather short statements. In later versions, we have to describe which
114 software is involved in which way during:
115
116 * VNF Life Cycle (onboarding, instantiate, scaling): we can reference to other documents
117 * Hardware Life Cycle (mainly how to add compute nodes, but also other cases)
118 * ...
119
120
121
122
123