diff options
Diffstat (limited to 'docs/installation-instructions')
| -rw-r--r-- | docs/installation-instructions/architecture.rst | 53 | ||||
| -rw-r--r-- | docs/installation-instructions/requirements.rst | 6 |
2 files changed, 58 insertions, 1 deletions
diff --git a/docs/installation-instructions/architecture.rst b/docs/installation-instructions/architecture.rst index bf2f9db4..c63da27c 100644 --- a/docs/installation-instructions/architecture.rst +++ b/docs/installation-instructions/architecture.rst @@ -22,3 +22,56 @@ of the Apex RPM. The overcloud is OPNFV. Configuration will be passed into undercloud and the undercloud will use OpenStack's orchestration component, named Heat, to execute a deployment that will provision the target OPNFV nodes. + +OPNFV Scenario Architecture +=========================== + +OPNFV distinguishes different types of SDN controllers, deployment options, and +features into "scenarios". These scenarios are universal across all OPNFV +installers, although some may or may not be supported by each installer. + +The standard naming convention for a scenario is: +<VIM platform>-<SDN type>-<feature>-<ha/noha> + +The only supported VIM type is "OS" (OpenStack), while SDN types can be any +supported SDN controller. "feature" includes things like ovs_dpdk, sfc, etc. +"ha" or "noha" determines if the deployment will be highly available. If "ha" +is used at least 3 control nodes are required. + +OPNFV Scenarios in Apex +======================= + +Apex provides pre-built scenario files in /etc/opnfv-apex which a user can +select from to deploy the desired scenario. Simply pass the desired file to +the installer as a (-d) deploy setting. Read further in the Apex documentation +to learn more about invoking the deploy command. Below is quick reference +matrix for OPNFV scenarios supported in Apex. Please refer to the respective +OPNFV Docs documentation for each scenario in order to see a full scenario +description. The following scenarios correspond to a supported <Scenario>.yaml +deploy settings file: + ++-------------------------+------------+-----------------+ +| **Scenario** | **Owner** | **Known Issues**| ++-------------------------+------------+-----------------+ +| os-nosdn-nofeature-ha | Apex | | ++-------------------------+------------+-----------------+ +| os-nosdn-nofeature-noha | Apex | | ++-------------------------+------------+-----------------+ +| os-nosdn-ovs-noha | OVS for NFV| | ++-------------------------+------------+-----------------+ +| os-nosdn-fdio-noha | FDS | | ++-------------------------+------------+-----------------+ +| os-odl_l2-nofeature-ha | Apex | | ++-------------------------+------------+-----------------+ +| os-odl_l3-nofeature-ha | Apex | APEX-112 | ++-------------------------+------------+-----------------+ +| os-odl_l2-sfc-noha | SFC | | ++-------------------------+------------+-----------------+ +| os-odl_l2-bgpvpn-noha | SDNVPN | | ++-------------------------+------------+-----------------+ +| os-odl_l2-fdio-noha | FDS | | ++-------------------------+------------+-----------------+ +| os-onos-nofeature-ha | ONOSFW | | ++-------------------------+------------+-----------------+ +| os-onos-sfc-ha | ONOSFW | | ++-------------------------+------------+-----------------+ diff --git a/docs/installation-instructions/requirements.rst b/docs/installation-instructions/requirements.rst index bf0a5f3d..d54d584b 100644 --- a/docs/installation-instructions/requirements.rst +++ b/docs/installation-instructions/requirements.rst @@ -37,7 +37,7 @@ Network requirements include: - Storage Network* - - Internal API Network* + - Internal API Network* (required for IPv6 \*\*) 3. Lights out OOB network access from Jumphost with IPMI node enabled (bare metal deployment only). @@ -50,6 +50,10 @@ Network requirements include: Control Plane network.* \* *Non-External networks will be consolidated to the Control Plane network if not specifically configured.* +\*\* *Internal API network, by default, is collapsed with provisioning in IPv4 + deployments, this is not possible with the current lack of PXE boot + support and therefore the API network is required to be its own + network in an IPv6 deployment.* Bare Metal Node Requirements ---------------------------- |