diff --git a/doc/source/install-guide-revised-draft/app-advanced-config-options.rst b/doc/source/install-guide-revised-draft/app-advanced-config-options.rst index 57410c3aa1..f734dd9dcd 100644 --- a/doc/source/install-guide-revised-draft/app-advanced-config-options.rst +++ b/doc/source/install-guide-revised-draft/app-advanced-config-options.rst @@ -1,8 +1,8 @@ `Home `_ OpenStack-Ansible Installation Guide -====================== -Advanced configuration -====================== +=================================== +Appendix D: Advanced configuration +=================================== .. toctree:: :maxdepth: 2 diff --git a/doc/source/install-guide-revised-draft/app-custom-layouts.rst b/doc/source/install-guide-revised-draft/app-custom-layouts.rst index c727116b17..33cb3fd78a 100644 --- a/doc/source/install-guide-revised-draft/app-custom-layouts.rst +++ b/doc/source/install-guide-revised-draft/app-custom-layouts.rst @@ -1,7 +1,7 @@ `Home `_ OpenStack-Ansible Installation Guide ================================================== -Appendix E: Customizing host and service layouts +Appendix C: Customizing host and service layouts ================================================== Understanding the default layout diff --git a/doc/source/install-guide-revised-draft/app-nuage.rst b/doc/source/install-guide-revised-draft/app-nuage.rst deleted file mode 100644 index c456350f31..0000000000 --- a/doc/source/install-guide-revised-draft/app-nuage.rst +++ /dev/null @@ -1,148 +0,0 @@ -`Home `__ OpenStack-Ansible Installation Guide - -====================================== -Appendix C. Using Nuage Neutron Plugin -====================================== - -Introduction -~~~~~~~~~~~~ - -This document describes the steps required to deploy Nuage Networks VCS -with OpenStack-Ansible (OSA). These steps include: - -- Install prerequisites. - -- Configure Neutron to use the Nuage Networks Neutron plugin. - -- Configure the Nuage Networks Neutron plugin. - -- Download Nuage Networks VCS components and playbooks. - -- Execute the playbooks. - -Prerequisites -~~~~~~~~~~~~~ - -#. The deployment environment has been configured according to OSA - best-practices. This includes cloning OSA software and bootstrapping - Ansible. See `OpenStack-Ansible Install Guide `_ -#. VCS stand-alone components, VSD and VSC, have been configured and - deployed. (See Nuage Networks VSD and VSC Install Guides.) -#. Nuage VRS playbooks have been cloned to the deployment host from - `https://github.com/nuagenetworks/nuage-openstack-ansible `_. - This guide assumes a deployment host path of - /opt/nuage-openstack-ansible - -Configure Nuage Neutron Plugin -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Configuring the Neutron plugin requires creating/editing of parameters -in following two files: - -- ``/etc/openstack_deploy/user_nuage_vars.yml`` - -- ``/etc/openstack_deploy/user_variables.yml`` - -On the deployment host, copy the Nuage user variables file from -``/opt/nuage-openstack-ansible/etc/user_nuage_vars.yml`` to -``/etc/openstack_deploy/`` folder. - - .. code-block:: shell-session - - # cp /opt/nuage-openstack-ansible/etc/user_nuage_vars.yml /etc/openstack_deploy/ - -Also modify the following parameters in this file as per your Nuage VCS -environment: - -#. Replace *VSD Enterprise Name* parameter with user desired name of VSD - Enterprise: - - .. code-block:: yaml - - nuage_net_partition_name: "" - -#. Replace *VSD IP* and *VSD GUI Port* parameters as per your VSD - configuration: - - .. code-block:: yaml - - nuage_vsd_ip: ":" - -#. Replace *VSD Username, VSD Password* and *VSD Organization Name* with - login credentials for VSD GUI as per your environment: - - .. code-block:: yaml - - nuage_vsd_username: "" - - nuage_vsd_password: "" - - nuage_vsd_organization: "" - -#. Replace *Nuage VSP Version* with the Nuage VSP release you plan on - using for Integration; For eg: If you seem to use Nuage VSP release 3.2; - this value would be *v3\_2* - - .. code-block:: yaml - - nuage_base_uri_version: "" - -#. Replace *Nuage VSD CMS Id* with the CMS-Id generated by VSD to manage - your OpenStack cluster: - - .. code-block:: yaml - - nuage_cms_id: "" - -#. Replace *Active VSC-IP* with the IP address of your active VSC node - and *Standby VSC-IP* with the IP address of your standby VSC node. - - .. code-block:: yaml - - active_controller: "" - - standby_controller: "" - -#. Replace *Local Package Repository* with the link of your local - repository hosting the Nuage VRS packages, e.g. ``http://192.0.2.10/debs/3.2/vrs/`` - - .. code-block:: yaml - - nuage_vrs_debs_repo: "deb " - -#. On the Deployment host, add the following lines to your - ``/etc/openstack_deploy/user_variables.yml`` file, replacing the - *Local PyPi Mirror URL* with the link to the pypi server hosting your - Nuage OpenStack Python packages in “.whl” format. - - .. code-block:: yaml - - neutron_plugin_type: "nuage" - nova_network_type: "nuage" - pip_links: - - { name: "openstack_release", link: "{{ openstack_repo_url }}/os-releases/{{ openstack_release }}/" } - - { name: "nuage_repo", link: "" } - -Installation -~~~~~~~~~~~~ - -#. After multi-node OpenStack cluster is setup as detailed above; start - the OpenStack deployment as listed in the OpenStack-Ansible Install guide by - running all playbooks in sequence on the deployment host - -#. After OpenStack deployment is complete; run the Nuage VRS playbooks - in ``/opt/nuage-openstack-ansible/nuage_playbook`` on - your deployment host to deploy Nuage VRS on all compute target hosts in - the OpenStack cluster: - - .. code-block:: shell-session - - # cd /opt/nuage-openstack-ansible/nuage_playbooks - # openstack-ansible nuage_all.yml - -Note: For Nuage Networks VSP software packages, user documentation and licenses -please reach out with a query to info@nuagenetworks.net - --------------- - -.. include:: navigation.txt diff --git a/doc/source/install-guide-revised-draft/app-plumgrid.rst b/doc/source/install-guide-revised-draft/app-plumgrid.rst deleted file mode 100644 index faf249cfe6..0000000000 --- a/doc/source/install-guide-revised-draft/app-plumgrid.rst +++ /dev/null @@ -1,157 +0,0 @@ -`Home `__ OpenStack-Ansible Installation Guide - -========================================== -Appendix D: Using PLUMgrid Neutron plugin -========================================== - -Installing source and host networking -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -#. Clone the PLUMgrid ansible repository under the ``/opt/`` directory: - - .. code-block:: shell-session - - # git clone -b TAG https://github.com/plumgrid/plumgrid-ansible.git /opt/plumgrid-ansible - - Replace *``TAG``* with the current stable release tag. - -#. PLUMgrid will take over networking for the entire cluster. The - bridges ``br-vxlan`` and ``br-vlan`` only need to be present to avoid - relevant containers from erroring out on infra hosts. They do not - need to be attached to any host interface or a valid network. - -#. PLUMgrid requires two networks: a `Management` and a `Fabric` network. - Management is typically shared via the standard ``br-mgmt`` and Fabric - must be specified in the PLUMgrid configuration file described below. - The Fabric interface must be untagged and unbridged. - -Neutron configurations -~~~~~~~~~~~~~~~~~~~~~~ - -To setup the neutron configuration to install PLUMgrid as the -core neutron plugin, create a user space variable file -``/etc/openstack_deploy/user_pg_neutron.yml`` and insert the following -parameters. - -#. Set the ``neutron_plugin_type`` parameter to ``plumgrid``: - - .. code-block:: yaml - - # Neutron Plugins - neutron_plugin_type: plumgrid - -#. In the same file, disable the installation of unnecessary ``neutron-agents`` - in the ``neutron_services`` dictionary, by setting their ``service_en`` - parameters to ``False``: - - .. code-block:: yaml - - neutron_metering: False - neutron_l3: False - neutron_lbaas: False - neutron_lbaasv2: False - neutron_vpnaas: False - - -PLUMgrid configurations -~~~~~~~~~~~~~~~~~~~~~~~ - -On the deployment host, create a PLUMgrid user variables file using the sample -in ``/opt/plumgrid-ansible/etc/user_pg_vars.yml.example`` and copy it to -``/etc/openstack_deploy/user_pg_vars.yml``. You must configure the -following parameters. - -#. Replace ``PG_REPO_HOST`` with a valid repo URL hosting PLUMgrid - packages: - - .. code-block:: yaml - - plumgrid_repo: PG_REPO_HOST - -#. Replace ``INFRA_IPs`` with comma separated Infrastructure Node IPs and - ``PG_VIP`` with an unallocated IP on the management network. This will - be used to access the PLUMgrid UI: - - .. code-block:: yaml - - plumgrid_ip: INFRA_IPs - pg_vip: PG_VIP - -#. Replace ``FABRIC_IFC`` with the name of the interface that will be used - for PLUMgrid Fabric. - - .. note:: - - PLUMgrid Fabric must be an untagged unbridged raw interface such as ``eth0``. - - .. code-block:: yaml - - fabric_interface: FABRIC_IFC - -#. Fill in the ``fabric_ifc_override`` and ``mgmt_override`` dicts with - node ``hostname: interface_name`` to override the default interface - names. - -#. Obtain a PLUMgrid License file, rename to ``pg_license`` and place it under - ``/var/lib/plumgrid/pg_license`` on the deployment host. - -Gateway Hosts -~~~~~~~~~~~~~ - -PLUMgrid-enabled OpenStack clusters contain one or more gateway nodes -that are used for providing connectivity with external resources, such as -external networks, bare-metal servers, or network service -appliances. In addition to the `Management` and `Fabric` networks required -by PLUMgrid nodes, gateways require dedicated external interfaces referred -to as ``gateway_devs`` in the configuration files. - -#. Add a ``gateway_hosts`` section to - ``/etc/openstack_deploy/openstack_user_config.yml``: - - .. code-block:: yaml - - gateway_hosts: - gateway1: - ip: GW01_IP_ADDRESS - gateway2: - ip: GW02_IP_ADDRESS - - Replace ``*_IP_ADDRESS`` with the IP address of the ``br-mgmt`` container management - bridge on each Gateway host. - -#. Add a ``gateway_hosts`` section to the end of the PLUMgrid - ``user_pg_vars.yml`` file: - - .. note:: - - This must contain hostnames and ``gateway_dev`` names for each - gateway in the cluster. - - .. code-block:: yaml - - gateway_hosts: - - hostname: gateway1 - gateway_devs: - - eth3 - - eth4 - -Installation -~~~~~~~~~~~~ - -#. Run the PLUMgrid playbooks (do this before the ``openstack-setup.yml`` - playbook is run): - - .. code-block:: shell-session - - # cd /opt/plumgrid-ansible/plumgrid_playbooks - # openstack-ansible plumgrid_all.yml - -.. note:: - - Contact PLUMgrid for an Installation Pack: info@plumgrid.com - This includes a full trial commercial license, packages, deployment documentation, - and automation scripts for the entire workflow described above. - --------------- - -.. include:: navigation.txt diff --git a/doc/source/install-guide-revised-draft/app.rst b/doc/source/install-guide-revised-draft/app.rst index e71c3dc32d..9be083458c 100644 --- a/doc/source/install-guide-revised-draft/app.rst +++ b/doc/source/install-guide-revised-draft/app.rst @@ -8,8 +8,6 @@ Appendices :maxdepth: 2 app-configfiles.rst - app-advanced-config-options.rst app-resources.rst - app-plumgrid.rst - app-nuage.rst app-custom-layouts.rst + app-advanced-config-options.rst