From 94787144f6d92476854ca6f8ab65427beafea7a4 Mon Sep 17 00:00:00 2001 From: Tim Rozet Date: Tue, 17 Oct 2017 15:25:16 -0400 Subject: Updates docs and scenarios for Euphrates Change-Id: I2da89d7a6ab4b0549edded908acc760b949231e1 Signed-off-by: Tim Rozet --- docs/release/installation/virtual.rst | 102 ++++++++++++++++++++++++++++++++++ 1 file changed, 102 insertions(+) create mode 100644 docs/release/installation/virtual.rst (limited to 'docs/release/installation/virtual.rst') diff --git a/docs/release/installation/virtual.rst b/docs/release/installation/virtual.rst new file mode 100644 index 00000000..9336b8e7 --- /dev/null +++ b/docs/release/installation/virtual.rst @@ -0,0 +1,102 @@ +Installation High-Level Overview - Virtual Deployment +===================================================== + +Deploying virtually is an alternative deployment method to bare metal, where +only a single bare metal Jump Host server is required to execute deployment. +In this deployment type, the Jump Host server will host the undercloud VM along +with any number of OPNFV overcloud control/compute nodes. This deployment type +is useful when physical resources are constrained, or there is a desire to +deploy a temporary sandbox environment. + +The virtual deployment operates almost the same way as the bare metal +deployment with a few differences mainly related to power management. +``opnfv-deploy`` still deploys an undercloud VM. In addition to the undercloud +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. All overcloud VMs are registered +with a Virtual BMC emulator which will service power management (IPMI) +commands. The overcloud VMs are still provisioned with the same disk images +and configuration that baremetal would use. + +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 management. Finally, the default network settings file will deploy without +modification. Customizations are welcome but not needed if a generic set of +network settings are acceptable. + +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 Jump Host +----------------- + +Follow the instructions in the `Install Bare Metal Jump Host`_ section. + +Running ``opnfv-deploy`` +------------------------ + +You are now ready to deploy OPNFV! +``opnfv-deploy`` has virtual deployment capability that includes all of +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: + + - 1 undercloud VM + + - The option of 3 control and 2 or more compute VMs (HA Deploy / default) + or 1 control and 1 or more compute VM (Non-HA deploy / pass -n) + + - 1-5 networks: provisioning, private tenant networking, external, storage + and internal API. The API, storage and tenant networking networks can be + collapsed onto the provisioning network. + +Follow the steps below to execute: + +1. ``sudo opnfv-deploy -v [ --virtual-computes n ] + [ --virtual-cpus n ] [ --virtual-ram n ] + -n network_settings.yaml -d deploy_settings.yaml`` + Note it can also be useful to run the command with the ``--debug`` + argument which will enable a root login on the overcloud nodes with + password: 'opnfv-apex'. It is also useful in some cases to surround the + deploy command with ``nohup``. For example: + ``nohup &``, will allow a deployment to continue even if + ssh access to the Jump Host is lost during deployment. + +2. It will take approximately 45 minutes to an hour to stand up undercloud, + define the target virtual machines, configure the deployment and execute + the deployment. You will notice different outputs in your shell. + +3. When the deployment is complete the IP for the undercloud and a url for the + OpenStack dashboard will be displayed + +Verifying the Setup - VMs +------------------------- + +To verify the set you can follow the instructions in the `Verifying the Setup`_ +section. + +.. _`Install Bare Metal Jump Host`: index.html#install-bare-metal-jump-host +.. _`Verifying the Setup`: index.html#verifying-the-setup -- cgit 1.2.3-korg