Merge "Adding mock-detached util function and cleaning up util help output"
[apex.git] / docs / installation-instructions / virtualinstall.rst
index 5ca20d4..c2ee66d 100644 (file)
@@ -1,24 +1,20 @@
 Installation High-Level Overview - Virtual Deployment
 =====================================================
 
-The VM nodes deployment operates almost the same way as the bare metal deploymen
-t with a
-few differences.  ``opnfv-deploy`` still deploys an Instack VM. In addition to t
-he Instack VM
-a collection of VMs (3 control nodes + 2 compute for an HA deployment or 1 contr
-ol node and
-1 compute node for a Non-HA Deployment) will be defined for the target OPNFV dep
-loyment.
-The part of the toolchain that executes IPMI power instructions calls into libvi
-rt instead of
+The VM nodes deployment operates almost the same way as the bare metal
+deployment with a few differences.  ``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 compute node 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 the same disk images and configuration that baremetal would be.
-
-To RDO Manager these nodes look like they have just built and registered the sam
-e way as
-bare metal nodes, the main difference is the use of a libvirt driver for the pow
-er management.
+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 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
 =======================================
@@ -40,19 +36,20 @@ the configuration nessesary 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 Instack VM
+    - 1 Undercloud VM
 
-    - The option of 3 control and 2 compute VMs (HA Deploy / default)
-      or 1 control and 1 compute VM (Non-HA deploy / pass -n)
+    - 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)
 
-    - 2 networks, one for provisioning, internal API,
-      storage and tenant networking traffic and a second for the external network
+    - 2-4 networks: provisioning / internal API, storage, private tenant networking
+      and the external network. The storage and tenant networking networks
+      can be collapsed onto the provisioning network.
 
 Follow the steps below to execute:
 
-1.  ``sudo opnfv-deploy --virtual [ --no-ha ]``
+1.  ``sudo opnfv-deploy [ --flat ] -n network_settings.yaml -i inventory.yaml -d deploy_settings.yaml``
 
-2.  It will take approximately 30 minutes to stand up instack,
+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.
 
@@ -63,21 +60,5 @@ Verifying the Setup - VMs
 
 To verify the set you can follow the instructions in the `Verifying the Setup`_ section.
 
-Before you get started following these instructions you will need to add IP addresses on the networks that have been
-created for the External and provisioning networks. By default the External network is 192.168.37.0/24 and the
-provisioning network is 192.0.2.0/24. To access these networks simply add an IP to brbm and brbm1 and set their link to
-up. This will provide a route from the hypervisor into the virtual networks acting as OpenStack's underlay network in
-the virtual deployment.
-
-| ``ip addr add 192.0.2.252/24 dev brbm``
-| ``ip link set up dev brbm``
-| ``ip addr add 192.168.37.252/24 dev brbm1``
-| ``ip link set up dev brbm1``
-
-Once these IP addresses are assigned and the links are up the gateways on the overcloud's networks should be pingable
-and read to be SSHed to.
-
-| ``ping 192.0.2.1``
-| ``ping 192.168.37.1``
-
-Now continue with the `Verifying the Setup`_ section.
+.. _`Install Bare Metal Jumphost`: baremetal.html
+.. _`Verifying the Setup`: verification.html