c63da27c905f3660cb04febda1e310ae316b14cd
[apex.git] / docs / installationprocedure / architecture.rst
1 Triple-O Deployment Architecture
2 ================================
3
4 Apex is based on the OpenStack Triple-O project as distributed by
5 the RDO Project.  It is important to understand the basics
6 of a Triple-O deployment to help make decisions that will assist in
7 successfully deploying OPNFV.
8
9 Triple-O stands for OpenStack On OpenStack.  This means that OpenStack
10 will be used to install OpenStack. The target OPNFV deployment is an
11 OpenStack cloud with NFV features built-in that will be deployed by a
12 smaller all-in-one deployment of OpenStack.  In this deployment
13 methodology there are two OpenStack installations. They are referred
14 to as the undercloud and the overcloud. The undercloud is used to
15 deploy the overcloud.
16
17 The undercloud is the all-in-one installation of OpenStack that includes
18 baremetal provisioning capability.  The undercloud will be deployed as a
19 virtual machine on a jumphost.  This VM is pre-built and distributed as part
20 of the Apex RPM.
21
22 The overcloud is OPNFV. Configuration will be passed into undercloud and
23 the undercloud will use OpenStack's orchestration component, named Heat, to
24 execute a deployment that will provision the target OPNFV nodes.
25
26 OPNFV Scenario Architecture
27 ===========================
28
29 OPNFV distinguishes different types of SDN controllers, deployment options, and
30 features into "scenarios".  These scenarios are universal across all OPNFV
31 installers, although some may or may not be supported by each installer.
32
33 The standard naming convention for a scenario is:
34 <VIM platform>-<SDN type>-<feature>-<ha/noha>
35
36 The only supported VIM type is "OS" (OpenStack), while SDN types can be any
37 supported SDN controller.  "feature" includes things like ovs_dpdk, sfc, etc.
38 "ha" or "noha" determines if the deployment will be highly available.  If "ha"
39 is used at least 3 control nodes are required.
40
41 OPNFV Scenarios in Apex
42 =======================
43
44 Apex provides pre-built scenario files in /etc/opnfv-apex which a user can
45 select from to deploy the desired scenario.  Simply pass the desired file to
46 the installer as a (-d) deploy setting.  Read further in the Apex documentation
47 to learn more about invoking the deploy command.  Below is quick reference
48 matrix for OPNFV scenarios supported in Apex.  Please refer to the respective
49 OPNFV Docs documentation for each scenario in order to see a full scenario
50 description.  The following scenarios correspond to a supported <Scenario>.yaml
51 deploy settings file:
52
53 +-------------------------+------------+-----------------+
54 | **Scenario**            | **Owner**  | **Known Issues**|
55 +-------------------------+------------+-----------------+
56 | os-nosdn-nofeature-ha   | Apex       |                 |
57 +-------------------------+------------+-----------------+
58 | os-nosdn-nofeature-noha | Apex       |                 |
59 +-------------------------+------------+-----------------+
60 | os-nosdn-ovs-noha       | OVS for NFV|                 |
61 +-------------------------+------------+-----------------+
62 | os-nosdn-fdio-noha      | FDS        |                 |
63 +-------------------------+------------+-----------------+
64 | os-odl_l2-nofeature-ha  | Apex       |                 |
65 +-------------------------+------------+-----------------+
66 | os-odl_l3-nofeature-ha  | Apex       | APEX-112        |
67 +-------------------------+------------+-----------------+
68 | os-odl_l2-sfc-noha      | SFC        |                 |
69 +-------------------------+------------+-----------------+
70 | os-odl_l2-bgpvpn-noha   | SDNVPN     |                 |
71 +-------------------------+------------+-----------------+
72 | os-odl_l2-fdio-noha     | FDS        |                 |
73 +-------------------------+------------+-----------------+
74 | os-onos-nofeature-ha    | ONOSFW     |                 |
75 +-------------------------+------------+-----------------+
76 | os-onos-sfc-ha          | ONOSFW     |                 |
77 +-------------------------+------------+-----------------+