Updating the overview doc with recent comments.
[opnfvdocs.git] / docs / platformoverview / softwarearchitecture.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. (c) OPNFV, Huawei
4
5 ===========================
6 OPNFV Platform Architecture
7 ===========================
8
9 The OPNFV project addresses a number of aspects in the development of a consistent virtualization
10 platform including common hardware requirements, software architecture and installed state.
11 The platform architecture as the OPNFV project approaches it is dicussed in the following sections.
12
13 OPNFV Lab Infrastructure
14 ========================
15
16 The `Pharos Project <https://www.opnfv.org/developers/pharos>`_ provides a lab infrastructure
17 that is geographically and technically diverse.
18 Labs instantiate bare-metal and virtual environments that are accessed remotely by the
19 community and used for OPNFV platform and feature development, build, deploy and testing.
20 This helps in developing a highly robust and stable OPNFV platform
21 with well understood performance characteristics.
22
23 Community labs are hosted by OPNFV member companies on a voluntary basis.
24 The Linux Foundation also hosts an OPNFV lab that provides centralised CI
25 and other production resources which are linked to community labs.
26 Future lab capabilities will include the ability easily automate deploy and test of any
27 OPNFV install scenario in any lab environemnt as well as on a virtual infrastructure.
28
29 .. ==> I am not sure this is the best place to include this.
30
31
32 Software architecture
33 =====================
34
35 This section will provide information which upstream projects, versions and components are
36 integrated in the release to implement OPNFV requirement. You can find the list of common
37 requirements for deployment tools here:
38 http://artifacts.opnfv.org/genesisreq/brahmaputra/requirements/requirements.pdf.
39
40 OpenStack
41 ---------
42
43 .. ==> didn't understand Chris' suggestion about reducing the heading level for these sub-topics
44
45 OPNFV integrates OpenStack as cloud management system where Brahmaputra uses the OpenStack Liberty Release.
46 The set of sub-projects deployed in a brahmaputra platform varies slightly depending on the installer and scenario.
47
48 The following table shows which components are deployed.
49
50 +------------+----------------+-----------+-----------+-----------+-----------+
51 | services   | type           | Apex      | Compass   | Fuel      | Joid      |
52 +============+================+===========+===========+===========+===========+
53 | ceilometer | metering       | Available | Available | Available | Available |
54 +------------+----------------+-----------+-----------+-----------+-----------+
55 | cinder     | volume         | Available | Available | Available | Available |
56 +------------+----------------+-----------+-----------+-----------+-----------+
57 | cloud      | cloudformation | ---       | Available | Available | Available |
58 +------------+----------------+-----------+-----------+-----------+-----------+
59 | glance     | image          | Available | Available | Available | Available |
60 +------------+----------------+-----------+-----------+-----------+-----------+
61 | heat       | orchestration  | Available | Available | Available | Available |
62 +------------+----------------+-----------+-----------+-----------+-----------+
63 | keystone   | identity       | Available | Available | Available | Available |
64 +------------+----------------+-----------+-----------+-----------+-----------+
65 | neutron    | network        | Available | Available | Available | Available |
66 +------------+----------------+-----------+-----------+-----------+-----------+
67 | nova       | compute        | Available | Available | Available | Available |
68 +------------+----------------+-----------+-----------+-----------+-----------+
69 | swift      | object-store   | Available | ---       | Available | Available |
70 +------------+----------------+-----------+-----------+-----------+-----------+
71
72
73 Note that additional components of OpenStack are used as part of deployment tools and test frameworks
74 (Fuel, Tempest, Rally).
75
76 For more information about the OpenStack features and usage refer to the
77 `official OpenStack documentation page <http://docs.openstack.org/>`_.
78 Please ensure that you have the Liberty release selected at the
79 ``More Releases & Languages`` drop down menu.
80
81 Operating System
82 ----------------
83
84 OPNFV uses Linux on all target machines. Depending on the installers, different
85 distributions are supported.
86
87 Ubuntu 14 supported by Fuel, Compass and Joid installers
88 CentOS 7 supported by Apex and Compass
89
90
91 SDN Controllers
92 ---------------
93
94 OPNFV Brahmaputra release supports different SDN controllers.
95 Some scenarios don't use an SDN controller but rely just on Neutron networking capabilities.
96
97 Depending on the SDN controller you are using, the featureset available will vary.  More
98 information on feature support and scenarios can be found in the Brahmaputra configuration and
99 user guides.  Brahmaputra also provides scenarios without an SDN controller, just using OpenStack Neutron.
100
101 OpenDaylight is an SDN controller aiming to accelerate
102 adoption of Software-Defined Networking (SDN) and Network Functions Virtualization
103 (NFV) with a transparent approach that fosters new innovation.
104 OpenDaylight runs within a JVM and is installed in OPNFV within a container and integrated with OpenStack
105 using the ODL device driver. The Brahmaputra release of OPNFV integrates the Beryllium release.
106 You can find more information about OpenDaylight among the release artifacts at the
107 `Downloads page <https://www.opendaylight.org/downloads>`_.
108 Please ensure you are using the Beryllium documentation.
109
110 ONOS is an SDN controller written in Java with a distributed architecture with special focus to
111 support scalability, fault tolerance and hardware and software upgrades without
112 interrupting network traffic.
113 More information on the internal design of ONOS may be found in
114 `User's Guide <https://wiki.onosproject.org/display/ONOS/User's+Guide>`_ and
115 `Architecture+Guide <https://wiki.onosproject.org/display/ONOS/Architecture+Guide>`_ on the
116 `wiki of the ONOS project <https://wiki.onosproject.org>`_.
117 ONOS is integrated to OPNFV using a framework ONOSFW and Neutron plugins. Details can be found in the
118 ONOS specific OPNFV documents,
119
120 `Design guide <http://artifacts.opnfv.org/onosfw/brahmaputra/design/design.pdf>`_,
121 `User guide <http://artifacts.opnfv.org/onosfw/brahmaputra/userguide/index.html>`_ and
122 `Config guide <http://artifacts.opnfv.org/onosfw/brahmaputra/configguide/index.html>`_.
123
124 .. OpenContrail SDN controller will be supported in the next drop of the Brahmaputra release.
125
126
127 Data Plane
128 ----------
129
130 OPNFV extends Linux's virtual networking capabilies by using virtual switch
131 and router components including improving those components by requirements
132 specific to telco use cases.
133
134 For instance some scenarios use OpenVSwitch
135 to replace Linux bridges as it offers advantages in terms of mobility, hardware
136 integration and use by network controllers. OPNFV leverages these by upgrade
137 to a specific installation using user-space datapath. This includes changes to
138 other dataplane components, including libvirt, qemu, DPDK etc.
139 Please find more information in
140 `OVSNFV User's Guide <http://artifacts.opnfv.org/ovsnfv/brahmaputra/docs/userguides/userguides.pdf>`_
141
142 Other Components
143 ----------------
144
145 **KVM**
146
147 NFV infrastructure has special requirements on hypervisors with respect of
148 interrupt latency (timing correctness and packet latency in data plane) and
149 live migration.
150
151 Besides additional software changes, this requires
152 some adjustments to system configuration
153 information, like hardware, BIOS, OS, etc.
154
155 .. KVM4NFV is one implementation, we have three implementations of the OS virtualization layer
156 .. to capture here.
157 .. ==> need more input
158
159 Please find more information at
160 `KVM4NFV project documentation <http://artifacts.opnfv.org/kvmfornfv/docs/all/all.pdf>`_
161
162 .. As it is a platform overview I think if we mention KVM as hypervisor we should focus on which version we are using and how as opposed to the OPNFV project that deals with KVM itself.
163
164
165
166 Deployment Architecture
167 =======================
168
169 OPNFV starts with a typical configuration with 3 controller nodes running
170 OpenStack, SDN, etc. and a minimum of 2 compute nodes for deployment of VNFs.
171 A detailed description of this 5 node configuration can be found in pharos documentation.
172
173 The 3 controller nodes allow to provide an HA configuration. The number of compute
174 nodes can be increased dynamically after the initial deployment.
175
176 OPNFV can be deployed on bare metal or in a virtual environment, where each of the hosts
177 is a virtual machine and provides the virtual resources using nested virtualization.
178
179 The initial deployment is done using a so-called "jumphost". This server (either bare metal
180 or virtual) is first installed with the installer program that then installs OpenStack
181 and other components on the controller nodes and compute nodes. See the
182 `OPNFV user guide <http://artifacts.opnfv.org/opnfvdocs/brahmaputra/docs/userguide/userguide.pdf>`_
183 for more details.
184
185 .. Editors note:
186 .. In a second level of detail, describe how software is distributed over the 3 controller
187 .. nodes, compute nodes and other hardware.
188
189
190 In Brahmaputra, different scenarios can be deployed to provide the different feature sets, e.g.
191 HA, IPV6, BGPVPN, KVM, or select the different implementations, e.g. SDN controllers.
192
193 .. ==> Is it described somewhere what we mean by scenarios? If yes, then the original text is better.
194 .. If not, I would give a brief overview here to describe the term.
195
196 The following scenarios are supported, some of them can be deployed using different installers.
197
198 * nosdn-nofeature
199 * odl_l2-ha
200 * odl_l3-ha
201 * odl_l2-bgpvpn-noha
202 * onos-ha
203 * nosdn-ovs-ha
204 * nosdn-kvm-ha
205 * nosdn-ovs_kvm-ha
206
207 Please find more information at:
208 http://artifacts.opnfv.org/opnfvdocs/brahmaputra/configguide/configoptions.html#opnfv-scenario-s.
209