diff options
Diffstat (limited to 'docs/release/installation')
| -rw-r--r-- | docs/release/installation/abstract.rst | 6 | ||||
| -rw-r--r-- | docs/release/installation/architecture.rst | 18 | ||||
| -rw-r--r-- | docs/release/installation/baremetal.rst | 8 | ||||
| -rw-r--r-- | docs/release/installation/index.rst | 2 | ||||
| -rw-r--r-- | docs/release/installation/introduction.rst | 4 | ||||
| -rw-r--r-- | docs/release/installation/requirements.rst | 2 | ||||
| -rw-r--r-- | docs/release/installation/virtualinstall.rst | 23 |
7 files changed, 43 insertions, 20 deletions
diff --git a/docs/release/installation/abstract.rst b/docs/release/installation/abstract.rst index b2d92a23..534d8a89 100644 --- a/docs/release/installation/abstract.rst +++ b/docs/release/installation/abstract.rst @@ -1,16 +1,16 @@ Abstract ======== -This document describes how to install the Danube release of OPNFV when +This document describes how to install the Euphrates release of OPNFV when using Apex as a deployment tool covering it's limitations, dependencies and required system resources. License ======= -Danube release of OPNFV when using Apex as a deployment tool Docs +Euphrates release of OPNFV when using Apex as a deployment tool Docs (c) by Tim Rozet (Red Hat) and Dan Radez (Red Hat) -Danube release of OPNFV when using Apex as a deployment tool Docs +Euphrates release of OPNFV when using Apex as a deployment tool Docs are licensed under a Creative Commons Attribution 4.0 International License. You should have received a copy of the license along with this. If not, see <http://creativecommons.org/licenses/by/4.0/>. diff --git a/docs/release/installation/architecture.rst b/docs/release/installation/architecture.rst index ae634cc4..eff5d35d 100644 --- a/docs/release/installation/architecture.rst +++ b/docs/release/installation/architecture.rst @@ -30,7 +30,7 @@ Undercloud ---------- The undercloud is not Highly Available. End users do not depend on the -underloud. It is only for management purposes. +undercloud. It is only for management purposes. Overcloud --------- @@ -47,7 +47,7 @@ will run the following services: - Ceph Monitors and OSDs Stateless OpenStack services - All running statesless OpenStack services are load balanced by HA Proxy. + All running stateless OpenStack services are load balanced by HA Proxy. Pacemaker monitors the services and ensures that they are running. Stateful OpenStack services @@ -65,9 +65,13 @@ RabbitMQ establishment of clustering across cluster members. OpenDaylight - OpenDaylight is currently installed on all three control nodes but only - started on the first control node. OpenDaylight's HA capabilities are not yet - mature enough to be enabled. + OpenDaylight is currently installed on all three control nodes and started as + an HA cluster unless otherwise noted for that scenario. OpenDaylight's + database, known as MD-SAL, breaks up pieces of the database into "shards". + Each shard will have its own election take place, which will determine + which OpenDaylight node is the leader for that shard. The other + OpenDaylight nodes in the cluster will be in standby. Every Open vSwitch + node connects to every OpenDaylight to enable HA. HA Proxy HA Proxy is monitored by Pacemaker to ensure it is running across all nodes @@ -127,9 +131,9 @@ issues per scenario. The following scenarios correspond to a supported +-------------------------+-------------+---------------+ | os-nosdn-ovs-noha | OVS for NFV | Yes | +-------------------------+-------------+---------------+ -| os-nosdn-fdio-ha | FDS | Yes | +| os-nosdn-fdio-ha | FDS | No | +-------------------------+-------------+---------------+ -| os-nosdn-fdio-noha | FDS | Yes | +| os-nosdn-fdio-noha | FDS | No | +-------------------------+-------------+---------------+ | os-nosdn-kvm-ha | KVM for NFV | Yes | +-------------------------+-------------+---------------+ diff --git a/docs/release/installation/baremetal.rst b/docs/release/installation/baremetal.rst index 83cda326..c7b4740e 100644 --- a/docs/release/installation/baremetal.rst +++ b/docs/release/installation/baremetal.rst @@ -50,7 +50,7 @@ images provided by the undercloud. These disk images include all the necessary packages and configuration for an OPNFV deployment to execute. Once the disk images have been written to node's disks the nodes will boot locally and execute cloud-init which will execute the final node configuration. This -configuration is largly completed by executing a puppet apply on each node. +configuration is largely completed by executing a puppet apply on each node. Installation High-Level Overview - VM Deployment ================================================ @@ -62,7 +62,7 @@ VM a collection of VMs (3 control nodes + 2 compute for an HA deployment or 1 control node and 1 or more compute nodes for a Non-HA Deployment) will be defined for the target OPNFV deployment. The part of the toolchain that executes IPMI power instructions calls into libvirt instead of the IPMI -interfaces on baremetal servers to operate the power managment. These VMs are +interfaces on baremetal servers to operate the power management. These VMs are then provisioned with the same disk images and configuration that baremetal would be. @@ -117,7 +117,7 @@ Install Bare Metal Jumphost install the opnfv-apex RPMs using the OPNFV artifacts yum repo. This yum repo is created at release. It will not exist before release day. - ``sudo yum install http://artifacts.opnfv.org/apex/danube/opnfv-apex-release-danube.noarch.rpm`` + ``sudo yum install http://artifacts.opnfv.org/apex/euphrates/opnfv-apex-release-euphrates.noarch.rpm`` Once you have installed the repo definitions for Apex, RDO and EPEL then yum install Apex: @@ -235,7 +235,7 @@ help you customize them. (``/etc/opnfv-apex/``). These files are named with the naming convention os-sdn_controller-enabled_feature-[no]ha.yaml. These files can be used in place of the (``/etc/opnfv-apex/deploy_settings.yaml``) file if one suites - your deployment needs. If a pre-built deploy_settings file is choosen there + your deployment needs. If a pre-built deploy_settings file is chosen there is no need to customize (``/etc/opnfv-apex/deploy_settings.yaml``). The pre-built file can be used in place of the (``/etc/opnfv-apex/deploy_settings.yaml``) file. diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst index 615aa7e5..9ac4c225 100644 --- a/docs/release/installation/index.rst +++ b/docs/release/installation/index.rst @@ -22,7 +22,7 @@ Contents: :Authors: Tim Rozet (trozet@redhat.com) :Authors: Dan Radez (dradez@redhat.com) -:Version: 4.0 +:Version: 5.0 Indices and tables ================== diff --git a/docs/release/installation/introduction.rst b/docs/release/installation/introduction.rst index 18267848..0e376189 100644 --- a/docs/release/installation/introduction.rst +++ b/docs/release/installation/introduction.rst @@ -1,7 +1,7 @@ Introduction ============ -This document describes the steps to install an OPNFV Danube reference +This document describes the steps to install an OPNFV Euphrates reference platform, as defined by the Genesis Project using the Apex installer. The audience is assumed to have a good background in networking @@ -19,7 +19,7 @@ deployment tool chain. The Apex deployment artifacts contain the necessary tools to deploy and configure an OPNFV target system using the Apex deployment toolchain. These artifacts offer the choice of using the Apex bootable ISO -(``opnfv-apex-danube.iso``) to both install CentOS 7 and the +(``opnfv-apex-euphrates.iso``) to both install CentOS 7 and the necessary materials to deploy or the Apex RPMs (``opnfv-apex*.rpm``), and their associated dependencies, which expects installation to a CentOS 7 libvirt enabled host. The RPM contains a collection of diff --git a/docs/release/installation/requirements.rst b/docs/release/installation/requirements.rst index 62c9963e..9c892a3d 100644 --- a/docs/release/installation/requirements.rst +++ b/docs/release/installation/requirements.rst @@ -15,7 +15,7 @@ The Jumphost requirements are outlined below: 4. minimum 1 networks and maximum 5 networks, multiple NIC and/or VLAN combinations are supported. This is virtualized for a VM deployment. -5. The Danube Apex RPMs and their dependencies. +5. The Euphrates Apex RPMs and their dependencies. 6. 16 GB of RAM for a bare metal deployment, 64 GB of RAM for a VM deployment. diff --git a/docs/release/installation/virtualinstall.rst b/docs/release/installation/virtualinstall.rst index 5da2ee3c..61fc4be6 100644 --- a/docs/release/installation/virtualinstall.rst +++ b/docs/release/installation/virtualinstall.rst @@ -8,7 +8,7 @@ undercloud VM. In addition to the undercloud VM a collection of VMs or more compute nodes for a non-HA Deployment) will be defined for the target OPNFV deployment. The part of the toolchain that executes IPMI power instructions calls into libvirt instead of the IPMI interfaces on baremetal -servers to operate the power managment. These VMs are then provisioned with +servers to operate the power management. These VMs are then provisioned with the same disk images and configuration that baremetal would be. To Triple-O these nodes look like they have just built and registered the same way as bare metal nodes, the main difference is the use of a libvirt driver for the power @@ -22,6 +22,25 @@ Installation Guide - Virtual Deployment This section goes step-by-step on how to correctly install and provision the OPNFV target system to VM nodes. +Special Requirements for Virtual Deployments +-------------------------------------------- + +In scenarios where advanced performance options or features are used, such +as using huge pages with nova instances, DPDK, or iommu; it is required to +enabled nested KVM support. This allows hardware extensions to be passed to +the overcloud VMs, which will allow the overcloud compute nodes to bring up +KVM guest nova instances, rather than QEMU. This also provides a great +performance increase even in non-required scenarios and is recommended to be +enabled. + +During deployment the Apex installer will detect if nested KVM is enabled, +and if not, it will attempt to enable it; while printing a warning message +if it cannot. Check to make sure before deployment that Nested +Virtualization is enabled in BIOS, and that the output of ``cat +/sys/module/kvm_intel/parameters/nested`` returns "Y". Also verify using +``lsmod`` that the kvm_intel module is loaded for x86_64 machines, and +kvm_amd is loaded for AMD64 machines. + Install Jumphost ---------------- @@ -32,7 +51,7 @@ Running ``opnfv-deploy`` You are now ready to deploy OPNFV! ``opnfv-deploy`` has virtual deployment capability that includes all of -the configuration nessesary to deploy OPNFV with no modifications. +the configuration necessary to deploy OPNFV with no modifications. If no modifications are made to the included configurations the target environment will deploy with the following architecture: |