From 012f1d08b075ec53d3b1174cfd7a93b246385d08 Mon Sep 17 00:00:00 2001 From: Dan Radez Date: Wed, 23 Mar 2016 14:31:09 -0400 Subject: Renaming Instack to Undercloud This commit is not backwards compatible with cleaning. VMs named Instack will need to be manually removed. Change-Id: I6829119e43a0a572da07e6d9757c5208c7fe91d4 --- docs/installation-instructions/architecture.rst | 6 +++--- docs/installation-instructions/baremetal.rst | 20 ++++++++++---------- docs/installation-instructions/introduction.rst | 2 +- docs/installation-instructions/verification.rst | 14 +++++++------- docs/installation-instructions/virtualinstall.rst | 8 ++++---- 5 files changed, 25 insertions(+), 25 deletions(-) (limited to 'docs') diff --git a/docs/installation-instructions/architecture.rst b/docs/installation-instructions/architecture.rst index 33b96bd0..f38afcc9 100644 --- a/docs/installation-instructions/architecture.rst +++ b/docs/installation-instructions/architecture.rst @@ -16,9 +16,9 @@ deploy the overcloud. The undercloud is the all-in-one installation of OpenStack that includes baremetal provisioning. RDO Manager's deployment of the undercloud is -call Instack. Instack will be deployed as a virtual machine on a jumphost. +call Undercloud. Undercloud will be deployed as a virtual machine on a jumphost. This VM is pre-built and distributed as part of the Apex RPM. -The overcloud is OPNFV. Configuration will be passed into Instack and -Instack will use OpenStack's orchestration component call Heat to +The overcloud is OPNFV. Configuration will be passed into Undercloud and +Undercloud will use OpenStack's orchestration component call Heat to execute a deployment will provision the target nodes to become OPNFV. diff --git a/docs/installation-instructions/baremetal.rst b/docs/installation-instructions/baremetal.rst index a4a05094..af4ced11 100644 --- a/docs/installation-instructions/baremetal.rst +++ b/docs/installation-instructions/baremetal.rst @@ -14,27 +14,27 @@ The Jumphost can be installed using the bootable ISO or by other means including configured with an IP gateway on its admin or public interface and configured with a working DNS server. The Jumphost should also have routable access to the lights out network. -``opnfv-deploy`` is then executed in order to deploy the Instack VM. ``opnfv-deploy`` uses +``opnfv-deploy`` is then executed in order to deploy the Undercloud VM. ``opnfv-deploy`` uses three configuration files in order to know how to install and provision the OPNFV target system. The information gathered under section `Execution Requirements (Bare Metal Only)`_ is put into the YAML file (``/etc/opnfv-apex/inventory.yaml``) configuration file. Deployment options are put into the YAML file (``/etc/opnfv-apex/deploy_settings.yaml``). Networking definitions gathered under section `Network Requirements`_ are put into the YAML file -(``/etc/opnfv-apex/network_settings.yaml``). ``opnfv-deploy`` will boot the Instack VM +(``/etc/opnfv-apex/network_settings.yaml``). ``opnfv-deploy`` will boot the Undercloud VM and load the target deployment configuration into the provisioning toolchain. This includes MAC address, IPMI, Networking Environment and OPNFV deployment options. -Once configuration is loaded and Instack is configured it will then reboot the nodes via IPMI. +Once configuration is loaded and Undercloud is configured it will then reboot the nodes via IPMI. The nodes should already be set to PXE boot first off the admin interface. The nodes will -first PXE off of the Instack PXE server and go through a discovery/introspection process. +first PXE off of the Undercloud PXE server and go through a discovery/introspection process. Introspection boots off of custom introspection PXE images. These images are designed to look at the properties of the hardware that is booting off of them and report the properties of -it back to the Instack node. +it back to the Undercloud node. -After introspection Instack will execute a Heat Stack Deployment to being node provisioning -and configuration. The nodes will reboot and PXE again off the Instack PXE server to -provision each node using the Glance disk images provided by Instack. These disk images +After introspection Undercloud will execute a Heat Stack Deployment to being node provisioning +and configuration. The nodes will reboot and PXE again off the Undercloud PXE server to +provision each node using the Glance disk images provided by Undercloud These disk images include all the necessary packages and configuration for an OPNFV deployment to execute. Once the node's disk images have been written to disk the nodes will boot off the newly written disks and execute cloud-init which will execute the final node configuration. This @@ -44,7 +44,7 @@ Installation High-Level Overview - VM Deployment ================================================ The VM nodes deployment operates almost the same way as the bare metal deployment with a -few differences. ``opnfv-deploy`` still deploys an Instack VM. In addition to the Instack VM +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 @@ -132,7 +132,7 @@ needs to be added to the ``inventory.yaml`` file. 3. Edit the following values for each node: - - ``mac_address``: MAC of the interface that will PXE boot from Instack + - ``mac_address``: MAC of the interface that will PXE boot from Undercloud - ``ipmi_ip``: IPMI IP Address - ``ipmi_user``: IPMI username - ``ipmi_password``: IPMI password diff --git a/docs/installation-instructions/introduction.rst b/docs/installation-instructions/introduction.rst index af8e03b6..25452614 100644 --- a/docs/installation-instructions/introduction.rst +++ b/docs/installation-instructions/introduction.rst @@ -34,7 +34,7 @@ is the same RPM included in the ISO and includes all the necessary disk images and configuration files to execute an OPNFV deployment. Either method will prepare a host to the same ready state for OPNFV deployment. -``opnfv-deploy`` instantiates an RDO Manager Instack VM server using libvirt +``opnfv-deploy`` instantiates an RDO Manager Undercloud VM server using libvirt as its provider. This VM is then configured and used to provision the OPNFV target deployment (3 controllers, n compute nodes). These nodes can be either virtual or bare metal. This guide contains instructions for diff --git a/docs/installation-instructions/verification.rst b/docs/installation-instructions/verification.rst index a574c316..bf3356bc 100644 --- a/docs/installation-instructions/verification.rst +++ b/docs/installation-instructions/verification.rst @@ -1,22 +1,22 @@ Verifying the Setup ------------------- -Once the deployment has finished, the OPNFV deployment can be accessed via the Instack node. From -the jump host ssh to the instack host and become the stack user. Alternativly ssh keys have been -setup such that the root user on the jump host can ssh to Instack directly as the stack user. +Once the deployment has finished, the OPNFV deployment can be accessed via the Undercloud node. From +the jump host ssh to the Undercloud host and become the stack user. Alternativly ssh keys have been +setup such that the root user on the jump host can ssh to Undercloud directly as the stack user. | ``ssh root@192.0.2.1`` | ``su - stack`` -Once connected to Instack as the stack user look for two keystone files that can be used to +Once connected to Undercloud as the stack user look for two keystone files that can be used to interact with the undercloud and the overcloud. Source the appropriate RC file to interact with the respective OpenStack deployment. -| ``source stackrc`` (undercloud / Instack) +| ``source stackrc`` (Undercloud) | ``source overcloudrc`` (overcloud / OPNFV) -The contents of these files include the credentials for the administrative user for Instack and -OPNFV respectivly. At this point both Instack and OPNFV can be interacted with just as any +The contents of these files include the credentials for the administrative user for Undercloud and +OPNFV respectivly. At this point both Undercloud and OPNFV can be interacted with just as any OpenStack installation can be. Start by listing the nodes in the undercloud that were used to deploy the overcloud. diff --git a/docs/installation-instructions/virtualinstall.rst b/docs/installation-instructions/virtualinstall.rst index 7232952d..c568e135 100644 --- a/docs/installation-instructions/virtualinstall.rst +++ b/docs/installation-instructions/virtualinstall.rst @@ -3,8 +3,8 @@ 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 +few differences. ``opnfv-deploy`` still deploys an Undercloud VM. In addition to t +he Undercloud 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 @@ -40,7 +40,7 @@ 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) @@ -52,7 +52,7 @@ Follow the steps below to execute: 1. ``sudo opnfv-deploy --virtual [ --no-ha ]`` -2. It will take approximately 30 minutes to stand up instack, +2. It will take approximately 30 minutes to stand up Undercloud, define the target virtual machines, configure the deployment and execute the deployment. You will notice different outputs in your shell. -- cgit 1.2.3-korg