diff options
| -rw-r--r-- | docs/configguide/installerconfig.rst | 3 | ||||
| -rw-r--r-- | docs/installation-instructions/architecture.rst | 12 | ||||
| -rw-r--r-- | docs/installation-instructions/baremetal.rst | 297 | ||||
| -rw-r--r-- | docs/installation-instructions/introduction.rst | 2 | ||||
| -rw-r--r-- | docs/installation-instructions/requirements.rst | 31 | ||||
| -rw-r--r-- | docs/installation-instructions/verification.rst | 70 | ||||
| -rw-r--r-- | docs/installation-instructions/virtualinstall.rst | 56 | ||||
| -rw-r--r-- | docs/release-notes/release-notes.rst | 95 |
8 files changed, 320 insertions, 246 deletions
diff --git a/docs/configguide/installerconfig.rst b/docs/configguide/installerconfig.rst index 8d3681a2..8f35905c 100644 --- a/docs/configguide/installerconfig.rst +++ b/docs/configguide/installerconfig.rst @@ -1,4 +1,5 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. (c) OPNFV diff --git a/docs/installation-instructions/architecture.rst b/docs/installation-instructions/architecture.rst index e9e83105..bf2f9db4 100644 --- a/docs/installation-instructions/architecture.rst +++ b/docs/installation-instructions/architecture.rst @@ -15,10 +15,10 @@ to as the undercloud and the overcloud. The undercloud is used to 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 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. +baremetal provisioning capability. The 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 Undercloud and -Undercloud will use OpenStack's orchestration component call Heat to -execute a deployment will provision the target nodes to become OPNFV. +The overcloud is OPNFV. Configuration will be passed into undercloud and +the undercloud will use OpenStack's orchestration component, named Heat, to +execute a deployment that will provision the target OPNFV nodes. diff --git a/docs/installation-instructions/baremetal.rst b/docs/installation-instructions/baremetal.rst index e60ec9dc..1b22a74c 100644 --- a/docs/installation-instructions/baremetal.rst +++ b/docs/installation-instructions/baremetal.rst @@ -1,151 +1,179 @@ Installation High-Level Overview - Bare Metal Deployment ======================================================== -The setup presumes that you have 6 or more bare metal servers already setup with -network connectivity on at least 2 interfaces for all servers via a TOR switch or -other network implementation. - -The physical TOR switches are **not** automatically configured from the OPNFV reference -platform. All the networks involved in the OPNFV infrastructure as well as the provider -networks and the private tenant VLANs needs to be manually configured. - -The Jumphost can be installed using the bootable ISO or by other means including the -(``opnfv-apex*.rpm``) RPMs, their dependencies and virtualization capabilities. The -Jumphost should then be 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 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``. Alternatively -there are pre-baked deploy_settings files available in ``/etc/opnfv-apex/``. These files are -named with the naming convention os-sdn_controller-enabled_feature-[no]ha.yaml. These files can -be used in place of the ``/etc/opnfv-apex/deploy_settings.yaml`` file if one suites your -deployment needs. Networking definitions gathered under section `Network Requirements`_ are put -into the YAML file ``/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 the 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 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 Undercloud node. - -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 +The setup presumes that you have 6 or more bare metal servers already setup +with network connectivity on at least 1 or more network interfaces for all +servers via a TOR switch or other network implementation. + +The physical TOR switches are **not** automatically configured from the OPNFV +reference platform. All the networks involved in the OPNFV infrastructure as +well as the provider networks and the private tenant VLANs needs to be manually +configured. + +The Jumphost can be installed using the bootable ISO or by using the +(``opnfv-apex*.rpm``) RPMs and their dependencies. The Jumphost should then be +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 for the overcloud nodes. + +``opnfv-deploy`` is then executed in order to deploy the undercloud VM and to +provision the overcloud nodes. ``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``. Alternatively +there are pre-baked deploy_settings files available in ``/etc/opnfv-apex/``. +These files are named with the naming convention +os-sdn_controller-enabled_feature-[no]ha.yaml. These files can be used in place +of the ``/etc/opnfv-apex/deploy_settings.yaml`` file if one suites your +deployment needs. Networking definitions gathered under section +`Network Requirements`_ are put into the YAML file +``/etc/opnfv-apex/network_settings.yaml``. ``opnfv-deploy`` will boot the +undercloud VM and load the target deployment configuration into the +provisioning toolchain. This information includes MAC address, IPMI, +Networking Environment and OPNFV deployment options. + +Once configuration is loaded and the undercloud is configured it will then +reboot the overcloud 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 +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 being booted +and report the properties of it back to the undercloud node. + +After introspection the undercloud will execute a Heat Stack Deployment to +continue node provisioning and configuration. The nodes will reboot and PXE +from the undercloud PXE server again to provision each node using Glance disk +images provided by the undercloud. These disk images include all the necessary +packages and configuration for an OPNFV deployment to execute. Once the disk +images have been written to node's disks the nodes will boot locally and +execute cloud-init which will execute the final node configuration. This configuration is largly completed by executing a puppet apply on each node. 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 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 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. +The VM nodes 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. 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 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. Installation Guide - Bare Metal Deployment ========================================== -This section goes step-by-step on how to correctly install and provision the OPNFV target -system to bare metal nodes. +This section goes step-by-step on how to correctly install and provision the +OPNFV target system to bare metal nodes. Install Bare Metal Jumphost --------------------------- -1a. If your Jumphost does not have CentOS 7 already on it, or you would like to do a fresh - install, then download the Apex bootable ISO from OPNFV artifacts <http://artifacts.opnfv.org/>. - There have been isolated reports of problems with the ISO having trouble completing - installation successfully. In the unexpected event the ISO does not work please workaround - this by downloading the CentOS 7 DVD and performing a "Virtualization Host" install. - If you perform a "Minimal Install" or install type other than "Virtualization Host" simply - run ``sudo yum groupinstall "Virtualization Host" && chkconfig libvirtd on && reboot`` - to install virtualzation support and enable libvirt on boot. If you use the CentOS 7 DVD - proceed to step 1b once the CentOS 7 with "Virtualzation Host" support is completed. - -1b. If your Jump host already has CentOS 7 with libvirt running on it then install the install - the RDO Release RPM: - - ``sudo yum install -y https://www.rdoproject.org/repos/rdo-release.rpm opnfv-apex-{version}.rpm`` - - The RDO Project release repository is needed to install OpenVSwitch, which is a dependency of - opnfv-apex. If you do not have external connectivity to use this repository you need to download - the OpenVSwitch RPM from the RDO Project repositories and install it with the opnfv-apex RPM. - -2a. Boot the ISO off of a USB or other installation media and walk through installing OPNFV CentOS 7. - The ISO comes prepared to be written directly to a USB drive with dd as such: +1a. If your Jumphost does not have CentOS 7 already on it, or you would like to + do a fresh install, then download the Apex bootable ISO from the OPNFV + artifacts site <http://artifacts.opnfv.org/apex.html>. There have been + isolated reports of problems with the ISO having trouble completing + installation successfully. In the unexpected event the ISO does not work + please workaround this by downloading the CentOS 7 DVD and performing a + "Virtualization Host" install. If you perform a "Minimal Install" or + install type other than "Virtualization Host" simply run + ``sudo yum groupinstall "Virtualization Host"`` + ``chkconfig libvirtd on && reboot`` + to install virtualzation support and enable libvirt on boot. If you use the + CentOS 7 DVD proceed to step 1b once the CentOS 7 with "Virtualzation Host" + support is completed. + +1b. If your Jump host already has CentOS 7 with libvirt running on it then + install the install the RDO Release RPM: + + ``sudo yum install -y https://www.rdoproject.org/repos/rdo-release.rpm`` + + The RDO Project release repository is needed to install OpenVSwitch, which + is a dependency of opnfv-apex. If you do not have external connectivity to + use this repository you need to download the OpenVSwitch RPM from the RDO + Project repositories and install it with the opnfv-apex RPM. + +2a. Boot the ISO off of a USB or other installation media and walk through + installing OPNFV CentOS 7. The ISO comes prepared to be written directly + to a USB drive with dd as such: ``dd if=opnfv-apex.iso of=/dev/sdX bs=4M`` - Replace /dev/sdX with the device assigned to your usb drive. Then select the USB device as the - boot media on your Jumphost + Replace /dev/sdX with the device assigned to your usb drive. Then select + the USB device as the boot media on your Jumphost -2b. If your Jump host already has CentOS 7 with libvirt running on it then install the - opnfv-apex RPMs from OPNFV artifacts <http://artifacts.opnfv.org/>. The following RPMS - are available for installation: +2b. If your Jump host already has CentOS 7 with libvirt running on it then + install the opnfv-apex RPMs from the OPNFV artifacts site + <http://artifacts.opnfv.org/apex.html>. The following RPMS are available + for installation: - - opnfv-apex - OpenDaylight L2 / L3 and ONOS support ** - - opnfv-apex-onos - ONOS support ** - - opnfv-apex-opendaylight-sfc - OpenDaylight SFC support ** - - opnfv-apex-undercloud - (required) Undercloud Image - - opnfv-apex-common - (required) Supporting config files and scripts - - python34-markupsafe - (required) Dependency of opnfv-apex-common *** - - python3-jinja2 - (required) Dependency of opnfv-apex-common *** + - opnfv-apex - OpenDaylight L2 / L3 and ONOS support * + - opnfv-apex-onos - ONOS support * + - opnfv-apex-opendaylight-sfc - OpenDaylight SFC support * + - opnfv-apex-undercloud - (reqed) Undercloud Image + - opnfv-apex-common - (reqed) Supporting config files and scripts + - python34-markupsafe - (reqed) Dependency of opnfv-apex-common ** + - python3-jinja2 - (reqed) Dependency of opnfv-apex-common ** - ** One or more of these RPMs is required - Only one of opnfv-apex, opnfv-apex-onos and opnfv-apex-opendaylight-sfc is required. It is - safe to leave the unneeded SDN controller's RPMs uninstalled if you do not intend to use them. + \* One or more of these RPMs is required + Only one of opnfv-apex, opnfv-apex-onos and opnfv-apex-opendaylight-sfc is + required. It is safe to leave the unneeded SDN controller's RPMs + uninstalled if you do not intend to use them. - *** These RPMs are not yet distributed by CentOS or EPEL. - Apex has built these for distribution with Apex while CentOS and EPEL do not distribute them. Once - they are carried in an upstream channel Apex will no longer carry them and they will not need - special handling for installation. + ** These RPMs are not yet distributed by CentOS or EPEL. + Apex has built these for distribution with Apex while CentOS and EPEL do + not distribute them. Once they are carried in an upstream channel Apex will + no longer carry them and they will not need special handling for + installation. - To install these RPMs download them to the local disk on your CentOS 7 install and pass the - file names directly to yum: - ``sudo yum install python34-markupsafe-<version>.rpm python3-jinja2-<version>.rpm`` - ``sudo yum install opnfv-apex-<version>.rpm opnfv-apex-undercloud-<version>.rpm opnfv-apex-common-<version>.rpm`` + To install these RPMs download them to the local disk on your CentOS 7 + install and pass the file names directly to yum: + ``sudo yum install python34-markupsafe-<version>.rpm + python3-jinja2-<version>.rpm`` + ``sudo yum install opnfv-apex-<version>.rpm + opnfv-apex-undercloud-<version>.rpm opnfv-apex-common-<version>.rpm`` -3. After the operating system and the opnfv-apex RPMs are installed, login to your Jumphost as root. +3. After the operating system and the opnfv-apex RPMs are installed, login to + your Jumphost as root. -4. Configure IP addresses on the interfaces that you have selected as your networks. +4. Configure IP addresses on the interfaces that you have selected as your + networks. -5. Configure the IP gateway to the Internet either, preferably on the public interface. +5. Configure the IP gateway to the Internet either, preferably on the public + interface. -6. Configure your ``/etc/resolv.conf`` to point to a DNS server (8.8.8.8 is provided by Google). +6. Configure your ``/etc/resolv.conf`` to point to a DNS server + (8.8.8.8 is provided by Google). Creating a Node Inventory File ------------------------------ -IPMI configuration information gathered in section `Execution Requirements (Bare Metal Only)`_ -needs to be added to the ``inventory.yaml`` file. +IPMI configuration information gathered in section +`Execution Requirements (Bare Metal Only)`_ needs to be added to the +``inventory.yaml`` file. -1. Copy ``/usr/share/doc/opnfv/inventory.yaml.example`` as your inventory file template to - ``/etc/opnfv-apex/inventory.yaml``. +1. Copy ``/usr/share/doc/opnfv/inventory.yaml.example`` as your inventory file + template to ``/etc/opnfv-apex/inventory.yaml``. -2. The nodes dictionary contains a definition block for each baremetal host that will be deployed. - 1 or more compute nodes and 3 controller nodes are required. - (The example file contains blocks for each of these already). +2. The nodes dictionary contains a definition block for each baremetal host + that will be deployed. 1 or more compute nodes and 3 controller nodes are + required. (The example file contains blocks for each of these already). It is optional at this point to add more compute nodes into the node list. 3. Edit the following values for each node: - - ``mac_address``: MAC of the interface that will PXE boot from Undercloud + - ``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 @@ -154,31 +182,36 @@ needs to be added to the ``inventory.yaml`` file. - ``memory``: (Introspected*) Memory available in Mib - ``disk``: (Introspected*) Disk space available in Gb - ``arch``: (Introspected*) System architecture - - ``capabilities``: (Optional**) Intended node role (profile:control or profile:compute) + - ``capabilities``: (Opt**) Node role (profile:control or profile:compute) -* Introspection looks up the overcloud node's resources and overrides these value. You can -leave default values and Apex will get the correct values when it runs introspection on the nodes. +\* *Introspection looks up the overcloud node's resources and overrides these + value. You can leave default values and Apex will get the correct values when + it runs introspection on the nodes.* -** If capabilities profile is not specified then Apex will select node's roles in the OPNFV cluster -in a non-deterministic fashion. +** *If capabilities profile is not specified then Apex will select node's roles + in the OPNFV cluster in a non-deterministic fashion.* Creating the Settings Files --------------------------- -Edit the 2 settings files in /etc/opnfv-apex/. These files have comments to help you customize them. +Edit the 2 settings files in /etc/opnfv-apex/. These files have comments to +help you customize them. 1. deploy_settings.yaml This file includes basic configuration options deployment. - Alternatively, there are pre-built deploy_settings files available in (``/etc/opnfv-apex/``). These - files are named with the naming convention os-sdn_controller-enabled_feature-[no]ha.yaml. These - files can be used in place of the (``/etc/opnfv-apex/deploy_settings.yaml``) file if one suites your - deployment needs. If a pre-built deploy_settings file is choosen there is no need to customize - (``/etc/opnfv-apex/deploy_settings.yaml``). The pre-built file can be used in place of the + Alternatively, there are pre-built deploy_settings files available in + (``/etc/opnfv-apex/``). These files are named with the naming convention + os-sdn_controller-enabled_feature-[no]ha.yaml. These files can be used in + place of the (``/etc/opnfv-apex/deploy_settings.yaml``) file if one suites + your deployment needs. If a pre-built deploy_settings file is choosen there + is no need to customize (``/etc/opnfv-apex/deploy_settings.yaml``). The + pre-built file can be used in place of the (``/etc/opnfv-apex/deploy_settings.yaml``) file. 2. network_settings.yaml This file provides Apex with the networking information that satisfies the - prerequisite `Network Requirements`_. These are specific to your environment. + prerequisite `Network Requirements`_. These are specific to your + environment. Running ``opnfv-deploy`` ------------------------ @@ -189,19 +222,21 @@ You are now ready to deploy OPNFV using Apex! Follow the steps below to execute: 1. Execute opnfv-deploy - ``sudo opnfv-deploy [ --flat ] -n network_settings.yaml -i inventory.yaml -d deploy_settings.yaml`` - If you need more information about the options that can be passed to opnfv-deploy use ``opnfv-deploy --help`` - --flat collapses all networks to a single nic, only uses the admin network from the network settings file. - -n network_settings.yaml allows you to customize your networking topology. + ``sudo opnfv-deploy [ --flat ] -n network_settings.yaml + -i inventory.yaml -d deploy_settings.yaml`` + If you need more information about the options that can be passed to + opnfv-deploy use ``opnfv-deploy --help`` --flat collapses all networks to a + single nic, only uses the admin network from the network settings file. -n + network_settings.yaml allows you to customize your networking topology. 2. Wait while deployment is executed. - If something goes wrong during this part of the process, - it is most likely a problem with the setup of your network or the information in your configuration files. - You will also notice different outputs in your shell. + If something goes wrong during this part of the process, start by reviewing + your network or the information in your configuration files. It's not + uncommon for something small to be overlooked or mis-typed. + You will also notice outputs in your shell as the deployment progresses. -3. The message "Overcloud Deployed" will display when When the deployment is complete. Just above this message there - will be a URL that ends in port http://<host>:5000. This url is also the endpoint for the OPNFV Horizon Dashboard - if connected to on port 80. +3. When the deployment is complete the undercloud IP and ovecloud dashboard + url will be printed. OPNFV has now been deployed using Apex. .. _`Execution Requirements (Bare Metal Only)`: requirements.html#execution-requirements-bare-metal-only .. _`Network Requirements`: requirements.html#network-requirements diff --git a/docs/installation-instructions/introduction.rst b/docs/installation-instructions/introduction.rst index 14fe04be..cc489917 100644 --- a/docs/installation-instructions/introduction.rst +++ b/docs/installation-instructions/introduction.rst @@ -12,7 +12,7 @@ Preface Apex uses Triple-O from the RDO Project OpenStack distribution as a provisioning tool. The Triple-O image based life cycle installation -tool provisions an OPNFV Target System (3 controllers, n number of +tool provisions an OPNFV Target System (3 controllers, 2 or more compute nodes) with OPNFV specific configuration provided by the Apex deployment tool chain. diff --git a/docs/installation-instructions/requirements.rst b/docs/installation-instructions/requirements.rst index af03aac8..bf0a5f3d 100644 --- a/docs/installation-instructions/requirements.rst +++ b/docs/installation-instructions/requirements.rst @@ -12,12 +12,13 @@ The Jumphost requirements are outlined below: 3. libvirt virtualization support. -4. minimum 2 networks and maximum 6 networks, multiple NIC and/or VLAN combinations are supported. - This is virtualized for a VM deployment. +4. minimum 1 networks and maximum 5 networks, multiple NIC and/or VLAN + combinations are supported. This is virtualized for a VM deployment. 5. The Colorado Apex RPMs and their dependencies. -6. 16 GB of RAM for a bare metal deployment, 64 GB of RAM for a VM deployment. +6. 16 GB of RAM for a bare metal deployment, 64 GB of RAM for a VM + deployment. Network Requirements -------------------- @@ -26,22 +27,29 @@ Network requirements include: 1. No DHCP or TFTP server running on networks used by OPNFV. -2. 2-6 separate networks with connectivity between Jumphost and nodes. +2. 1-5 separate networks with connectivity between Jumphost and nodes. - - Control Plane (Provisioning) / Private (API) Network + - Control Plane (Provisioning) - - Internal (Tenant Networking) Network + - Private Tenant-Networking Network* - External Network - Storage Network* -3. Lights out OOB network access from Jumphost with IPMI node enabled (bare metal deployment only). + - Internal API Network* -4. Admin or public network has Internet access, meaning a gateway and DNS availability. +3. Lights out OOB network access from Jumphost with IPMI node enabled + (bare metal deployment only). -| `*` *These networks can be combined with each other or all combined on the Control Plane network.* -| `*` *Non-External networks will be consolidated to the Control Plane network if not specifically configured.* +4. External network is a routable network from outside the cloud, + deployment. The External network is where public internet access would + reside if available. + +\* *These networks can be combined with each other or all combined on the + Control Plane network.* +\* *Non-External networks will be consolidated to the Control Plane network + if not specifically configured.* Bare Metal Node Requirements ---------------------------- @@ -63,4 +71,5 @@ In order to execute a deployment, one must gather the following information: 2. IPMI login information for the nodes (user/pass). -3. MAC address of Control Plane / Provisioning interfaces of the overcloud nodes. +3. MAC address of Control Plane / Provisioning interfaces of the overcloud + nodes. diff --git a/docs/installation-instructions/verification.rst b/docs/installation-instructions/verification.rst index 0ff56322..81e4c8e4 100644 --- a/docs/installation-instructions/verification.rst +++ b/docs/installation-instructions/verification.rst @@ -1,40 +1,43 @@ Verifying the Setup ------------------- -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. For -convenience a utility script has been provided to look up the undercloud's ip address and ssh to the -undercloud all in one command. An optional user name can be passed to indicate whether to connect as -the stack or root user. The stack user is default if a username is not specified. +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. For +convenience a utility script has been provided to look up the undercloud's ip +address and ssh to the undercloud all in one command. An optional user name can +be passed to indicate whether to connect as the stack or root user. The stack +user is default if a username is not specified. | ``opnfv-util undercloud root`` | ``su - stack`` -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. +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) -| ``source overcloudrc`` (Overcloud / OPNFV) +| ``source stackrc`` (undercloud) +| ``source overcloudrc`` (overcloud / OPNFV) -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. +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. | ``source stackrc`` | ``openstack server list`` -The control and compute nodes will be listed in the output of this server list command. The IP -addresses that are listed are the control plane addresses that were used to provision the nodes. -Use these IP addresses to connect to these nodes. Initial authentication requires using the -user heat-admin. +The control and compute nodes will be listed in the output of this server list +command. The IP addresses that are listed are the control plane addresses that +were used to provision the nodes. Use these IP addresses to connect to these +nodes. Initial authentication requires using the user heat-admin. | ``ssh heat-admin@192.0.2.7`` -To begin creating users, images, networks, servers, etc in OPNFV source the overcloudrc file or -retrieve the admin user's credentials from the overcloudrc file and connect to the web Dashboard. +To begin creating users, images, networks, servers, etc in OPNFV source the +overcloudrc file or retrieve the admin user's credentials from the overcloudrc +file and connect to the web Dashboard. You are now able to follow the `OpenStack Verification`_ section. @@ -42,7 +45,8 @@ You are now able to follow the `OpenStack Verification`_ section. OpenStack Verification ---------------------- -Once connected to the OPNFV Dashboard make sure the OPNFV target system is working correctly: +Once connected to the OPNFV Dashboard make sure the OPNFV target system is +working correctly: 1. In the left pane, click Compute -> Images, click Create Image. @@ -55,25 +59,31 @@ Once connected to the OPNFV Dashboard make sure the OPNFV target system is worki 5. Enter a name "internal", click Next. -6. Enter a subnet name "internal_subnet", and enter Network Address ``172.16.1.0/24``, click Next. +6. Enter a subnet name "internal_subnet", and enter Network Address + ``172.16.1.0/24``, click Next. 7. Now go to Project -> Compute -> Instances, click Launch Instance. -8. Enter Instance Name "first_instance", select Instance Boot Source "Boot from image", - and then select Image Name "cirros". +8. Enter Instance Name "first_instance", select Instance Boot Source + "Boot from image", and then select Image Name "cirros". -9. Click Launch, status will cycle though a couple states before becoming "Active". +9. Click Launch, status will cycle though a couple states before becoming + "Active". 10. Steps 7 though 9 can be repeated to launch more instances. -11. Once an instance becomes "Active" their IP addresses will display on the Instances page. +11. Once an instance becomes "Active" their IP addresses will display on the + Instances page. -12. Click the name of an instance, then the "Console" tab and login as "cirros"/"cubswin:)" +12. Click the name of an instance, then the "Console" tab and login as + "cirros"/"cubswin:)" -13. To verify storage is working, click Project -> Compute -> Volumes, Create Volume +13. To verify storage is working, + click Project -> Compute -> Volumes, Create Volume 14. Give the volume a name and a size of 1 GB -15. Once the volume becomes "Available" click the dropdown arrow and attach it to an instance. +15. Once the volume becomes "Available" click the dropdown arrow and attach it + to an instance. Congratulations you have successfully installed OPNFV! diff --git a/docs/installation-instructions/virtualinstall.rst b/docs/installation-instructions/virtualinstall.rst index c2ee66d8..f850b025 100644 --- a/docs/installation-instructions/virtualinstall.rst +++ b/docs/installation-instructions/virtualinstall.rst @@ -2,24 +2,25 @@ Installation High-Level Overview - Virtual Deployment ===================================================== 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 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. +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 +or more compute nodes 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 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. +This section goes step-by-step on how to correctly install and provision the +OPNFV target system to VM nodes. Install Jumphost ---------------- @@ -33,32 +34,35 @@ You are now ready to deploy OPNFV! ``opnfv-deploy`` has virtual deployment capability that includes all of 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: +If no modifications are made to the included configurations the target +environment will deploy with the following architecture: - - 1 Undercloud VM + - 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) - - 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. + - 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 [ --flat ] -n network_settings.yaml -i inventory.yaml -d deploy_settings.yaml`` +1. ``sudo opnfv-deploy [ --flat ] -n network_settings.yaml -i inventory.yaml + -d deploy_settings.yaml`` -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. +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 you will see "Overcloud Deployed" +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. +To verify the set you can follow the instructions in the `Verifying the Setup`_ +section. .. _`Install Bare Metal Jumphost`: baremetal.html .. _`Verifying the Setup`: verification.html diff --git a/docs/release-notes/release-notes.rst b/docs/release-notes/release-notes.rst index a066e075..080d2043 100644 --- a/docs/release-notes/release-notes.rst +++ b/docs/release-notes/release-notes.rst @@ -1,6 +1,6 @@ -============================================================================================ -OPNFV Release Notes for the Brahmaputra release of OPNFV when using Apex as a deployment tool -============================================================================================ +========================================================================== +OPNFV Release Notes for the Colorado release of OPNFV Apex deployment tool +========================================================================== .. contents:: Table of Contents @@ -10,51 +10,60 @@ OPNFV Release Notes for the Brahmaputra release of OPNFV when using Apex as a de Abstract ======== -This document provides the release notes for Brahmaputra release with the Apex deployment toolchain. +This document provides the release notes for Colorado release with the Apex +deployment toolchain. License ======= -All Apex and "common" entities are protected by the Apache License ( http://www.apache.org/licenses/ ) +All Apex and "common" entities are protected by the Apache License +( http://www.apache.org/licenses/ ) Version history =============== -+--------------------+--------------------+--------------------+--------------------+ -| **Date** | **Ver.** | **Author** | **Comment** | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| 2015-09-17 | 1.0.0 | Dan Radez | Rewritten for | -| | | | RDO Manager update | -+--------------------+--------------------+--------------------+--------------------+ ++-------------+-----------+-----------------+----------------------+ +| **Date** | **Ver.** | **Authors** | **Comment** | +| | | | | ++-------------+-----------+-----------------+----------------------+ +| 2016-08-11 | 2.0.0 | Dan Radez | Updates for Colorado | ++-------------+-----------+-----------------+----------------------+ +| 2015-09-17 | 1.0.0 | Dan Radez | Rewritten for | +| | | | RDO Manager update | ++-------------+-----------+-----------------+----------------------+ Important notes =============== -This is the OPNFV Brahmaputra release that implements the deploy stage of the OPNFV CI pipeline via Apex. +This is the OPNFV Colorado release that implements the deploy stage of the +OPNFV CI pipeline via Apex. -Apex is based on RDO Manager. More information at http://rdoproject.org +Apex is based on RDO's Triple-O installation tool chain. +More information at http://rdoproject.org -Carefully follow the installation-instructions which guide a user on how to deploy OPNFV using Apex installer. +Carefully follow the installation-instructions which guide a user on how to +deploy OPNFV using Apex installer. Summary ======= -Brahmaputra release with the Apex deployment toolchain will establish an OPNFV target system -on a Pharos compliant lab infrastructure. The current definition of an OPNFV target system -is and OpenStack Liberty combined with OpenDaylight Beryllium. The system is deployed with -OpenStack High Availability (HA) for most OpenStack services. OpenDaylight is deployed in -non-HA form as HA support is not availble for OpenDaylight at the time of the Brahmaputra -release. Ceph storage is used as Cinder backend, and is the only supported storage for -Brahmaputra. Ceph is setup as 3 OSDs and 3 Monitors, one OSD+Mon per Controller node. +Colorado release with the Apex deployment toolchain will establish an OPNFV +target system on a Pharos compliant lab infrastructure. The current definition +of an OPNFV target system is and OpenStack Liberty combined with OpenDaylight +Beryllium. The system is deployed with OpenStack High Availability (HA) for +most OpenStack services. OpenDaylight is deployed in non-HA form as HA support +is not availble for OpenDaylight at the time of the Colorado release. Ceph +storage is used as Cinder backend, and is the only supported storage for +Colorado. Ceph is setup as 3 OSDs and 3 Monitors, one OSD+Mon per Controller +node. - Documentation is built by Jenkins - .iso image is built by Jenkins - .rpm packages are built by Jenkins -- Jenkins deploys a Brahmaputra release with the Apex deployment toolchain baremetal, - which includes 3 control+network nodes, and 2 compute nodes. +- Jenkins deploys a Colorado release with the Apex deployment toolchain + baremetal, which includes 3 control+network nodes, and 2 compute nodes. Release Data ============ @@ -63,16 +72,16 @@ Release Data | **Project** | apex | | | | +--------------------------------------+--------------------------------------+ -| **Repo/tag** | apex/brahmaputra.1.0 | +| **Repo/tag** | apex/colorado.1.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | brahmaputra.1.0 | +| **Release designation** | colorado.1.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | 2015-02-25 | +| **Release date** | 2016-09-14 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | OPNFV Brahmaputra release | +| **Purpose of the delivery** | OPNFV Colorado release | | | | +--------------------------------------+--------------------------------------+ @@ -81,10 +90,10 @@ Version change Module version changes ~~~~~~~~~~~~~~~~~~~~~~ -This is the first tracked version of the Brahmaputra release with the Apex deployment toolchain. -It is based on following upstream versions: +This is the first tracked version of the Colorado release with the Apex +deployment toolchain. It is based on following upstream versions: -- OpenStack (Liberty release) +- OpenStack (Mitaka release) - OpenDaylight (Beryllium release) @@ -93,11 +102,14 @@ It is based on following upstream versions: Document version changes ~~~~~~~~~~~~~~~~~~~~~~~~ -This is the first tracked version of Brahmaputra release with the Apex deployment toolchain. +This is the first tracked version of Colorado release with the Apex +deployment toolchain. The following documentation is provided with this release: -- OPNFV Installation instructions for the Brahmaputra release with the Apex deployment toolchain - ver. 1.0.0 -- OPNFV Release Notes for the Brahmaputra release with the Apex deployment toolchain - ver. 1.0.0 (this document) +- OPNFV Installation instructions for the Colorado release with the Apex + deployment toolchain - ver. 1.0.0 +- OPNFV Release Notes for the Colorado release with the Apex deployment + toolchain - ver. 1.0.0 (this document) Feature additions ~~~~~~~~~~~~~~~~~ @@ -113,7 +125,7 @@ Feature additions | | | +--------------------------------------+--------------------------------------+ | JIRA: APEX-34 | Migrate and update Release | -| | Documentation for Brahmaputra | +| | Documentation for Colorado | +--------------------------------------+--------------------------------------+ Bug corrections @@ -144,8 +156,10 @@ opnfv-clean - Automatically resets a Target OPNFV Deployment Documentation deliverables ~~~~~~~~~~~~~~~~~~~~~~~~~~ -- OPNFV Installation instructions for the Brahmaputra release with the Apex deployment toolchain - ver. 1.0.0 -- OPNFV Release Notes for the Brahmaputra release with the Apex deployment toolchain - ver. 1.0.0 (this document) +- OPNFV Installation instructions for the Colorado release with the Apex + deployment toolchain - ver. 1.0.0 +- OPNFV Release Notes for the Colorado release with the Apex deployment + toolchain - ver. 1.0.0 (this document) Known Limitations, Issues and Workarounds ========================================= @@ -210,7 +224,8 @@ Workarounds Test Result =========== -The Brahmaputra release with the Apex deployment toolchain has undergone QA test runs with the following results: +The Colorado release with the Apex deployment toolchain has undergone QA +test runs with the following results: +--------------------------------------+--------------------------------------+ | **TEST-SUITE** | **Results:** | @@ -223,9 +238,9 @@ The Brahmaputra release with the Apex deployment toolchain has undergone QA test References ========== -For more information on the OPNFV Brahmaputra release, please see: +For more information on the OPNFV Colorado release, please see: -http://wiki.opnfv.org/releases/brahmaputra +http://wiki.opnfv.org/releases/Colorado :Authors: Tim Rozet (trozet@redhat.com) :Authors: Dan Radez (dradez@redhat.com) |