docs/release/installation/virtual.rst

   1 Installation High-Level Overview - Virtual Deployment
   2 =====================================================
   3
   4 Deploying virtually is an alternative deployment method to bare metal, where
   5 only a single bare metal Jump Host server is required to execute deployment.
   6 In this deployment type, the Jump Host server will host the undercloud VM along
   7 with any number of OPNFV overcloud control/compute nodes.  This deployment type
   8 is useful when physical resources are constrained, or there is a desire to
   9 deploy a temporary sandbox environment.
  10
  11 The virtual deployment operates almost the same way as the bare metal
  12 deployment with a few differences mainly related to power management.
  13 ``opnfv-deploy`` still deploys an undercloud VM. In addition to the undercloud
  14 VM a collection of VMs (3 control nodes + 2 compute for an HA deployment or 1
  15 control node and 1 or more compute nodes for a Non-HA Deployment) will be
  16 defined for the target OPNFV deployment.  All overcloud VMs are registered
  17 with a Virtual BMC emulator which will service power management (IPMI)
  18 commands.  The overcloud VMs are still provisioned with the same disk images
  19 and configuration that baremetal would use.
  20
  21 To Triple-O these nodes look like they have just built and registered the same
  22 way as bare metal nodes, the main difference is the use of a libvirt driver for
  23 the power management.  Finally, the default network settings file will deploy without
  24 modification.  Customizations are welcome but not needed if a generic set of
  25 network settings are acceptable.
  26
  27 Installation Guide - Virtual Deployment
  28 =======================================
  29
  30 This section goes step-by-step on how to correctly install and provision the
  31 OPNFV target system to VM nodes.
  32
  33 Special Requirements for Virtual Deployments
  34 --------------------------------------------
  35
  36 In scenarios where advanced performance options or features are used, such
  37 as using huge pages with nova instances, DPDK, or iommu; it is required to
  38 enabled nested KVM support.  This allows hardware extensions to be passed to
  39 the overcloud VMs, which will allow the overcloud compute nodes to bring up
  40 KVM guest nova instances, rather than QEMU.  This also provides a great
  41 performance increase even in non-required scenarios and is recommended to be
  42 enabled.
  43
  44 During deployment the Apex installer will detect if nested KVM is enabled,
  45 and if not, it will attempt to enable it; while printing a warning message
  46 if it cannot.  Check to make sure before deployment that Nested
  47 Virtualization is enabled in BIOS, and that the output of ``cat
  48 /sys/module/kvm_intel/parameters/nested`` returns "Y".  Also verify using
  49 ``lsmod`` that the kvm_intel module is loaded for x86_64 machines, and
  50 kvm_amd is loaded for AMD64 machines.
  51
  52 Install Jump Host
  53 -----------------
  54
  55 Follow the instructions in the `Install Bare Metal Jump Host`_ section.
  56
  57 Running ``opnfv-deploy``
  58 ------------------------
  59
  60 You are now ready to deploy OPNFV!
  61 ``opnfv-deploy`` has virtual deployment capability that includes all of
  62 the configuration necessary to deploy OPNFV with no modifications.
  63
  64 If no modifications are made to the included configurations the target
  65 environment will deploy with the following architecture:
  66
  67     - 1 undercloud VM
  68
  69     - The option of 3 control and 2 or more compute VMs (HA Deploy / default)
  70       or 1 control and 1 or more compute VM (Non-HA deploy / pass -n)
  71
  72     - 1-5 networks: provisioning, private tenant networking, external, storage
  73       and internal API. The API, storage and tenant networking networks can be
  74       collapsed onto the provisioning network.
  75
  76 Follow the steps below to execute:
  77
  78 1.  ``sudo opnfv-deploy -v [ --virtual-computes n ]
  79     [ --virtual-cpus n ] [ --virtual-ram n ]
  80     -n network_settings.yaml -d deploy_settings.yaml``
  81     Note it can also be useful to run the command with the ``--debug``
  82     argument which will enable a root login on the overcloud nodes with
  83     password: 'opnfvapex'.  It is also useful in some cases to surround the
  84     deploy command with ``nohup``.  For example:
  85     ``nohup <deploy command> &``, will allow a deployment to continue even if
  86     ssh access to the Jump Host is lost during deployment.
  87
  88 2.  It will take approximately 45 minutes to an hour to stand up undercloud,
  89     define the target virtual machines, configure the deployment and execute
  90     the deployment.  You will notice different outputs in your shell.
  91
  92 3.  When the deployment is complete the IP for the undercloud and a url for the
  93     OpenStack dashboard will be displayed
  94
  95 Verifying the Setup - VMs
  96 -------------------------
  97
  98 To verify the set you can follow the instructions in the `Verifying the Setup`_
  99 section.
 100
 101 .. _`Install Bare Metal Jump Host`: index.html#install-bare-metal-jump-host
 102 .. _`Verifying the Setup`: index.html#verifying-the-setup