Fixes path for utility library
[apex.git] / docs / installation-instructions / virtualinstall.rst
1 Installation High-Level Overview - Virtual Deployment
2 =====================================================
3
4 The VM nodes deployment operates almost the same way as the bare metal
5 deployment with a few differences.  ``opnfv-deploy`` still deploys an Undercloud
6 VM. In addition to the Undercloud VM a collection of VMs (3 control nodes + 2
7 compute for an HA deployment or 1 control node and 1 compute node for a Non-HA
8 Deployment) will be defined for the target OPNFV deployment.  The part of the
9 toolchain that executes IPMI power instructions calls into libvirt instead of
10 the IPMI interfaces on baremetal servers to operate the power managment.  These
11 VMs are then provisioned with the same disk images and configuration that
12 baremetal would be. To Triple-O these nodes look like they have just built
13 and registered the same way as bare metal nodes, the main difference is the use
14 of a libvirt driver for the power management. Finally, the default
15 network_settings file will deploy without modification. Customizations
16 are welcome but not needed if a generic set of network_settings are
17 acceptable.
18
19 Installation Guide - Virtual Deployment
20 =======================================
21
22 This section goes step-by-step on how to correctly install and provision the OPNFV target system to VM nodes.
23
24 Install Jumphost
25 ----------------
26
27 Follow the instructions in the `Install Bare Metal Jumphost`_ section.
28
29 Running ``opnfv-deploy``
30 ------------------------
31
32 You are now ready to deploy OPNFV!
33 ``opnfv-deploy`` has virtual deployment capability that includes all of
34 the configuration nessesary to deploy OPNFV with no modifications.
35
36 If no modifications are made to the included configurations the target environment
37 will deploy with the following architecture:
38
39     - 1 Undercloud VM
40
41     - The option of 3 control and 2 or more compute VMs (HA Deploy / default)
42       or 1 control and 1 or more compute VM (Non-HA deploy / pass -n)
43
44     - 2-4 networks: provisioning / internal API, storage, private tenant networking
45       and the external network. The storage and tenant networking networks
46       can be collapsed onto the provisioning network.
47
48 Follow the steps below to execute:
49
50 1.  ``sudo opnfv-deploy [ --flat ] -n network_settings.yaml -i inventory.yaml -d deploy_settings.yaml``
51
52 2.  It will take approximately 45 minutes to an hour to stand up Undercloud,
53     define the target virtual machines, configure the deployment and execute the deployment.
54     You will notice different outputs in your shell.
55
56 3.  When the deployment is complete you will see "Overcloud Deployed"
57
58 Verifying the Setup - VMs
59 -------------------------
60
61 To verify the set you can follow the instructions in the `Verifying the Setup`_ section.
62
63 .. _`Install Bare Metal Jumphost`: baremetal.html
64 .. _`Verifying the Setup`: verification.html