diff --git a/doc/source/install-guide/configure-network-services-fwaas.rst b/doc/source/install-guide/configure-network-services-fwaas.rst new file mode 100644 index 0000000000..8153bf75ce --- /dev/null +++ b/doc/source/install-guide/configure-network-services-fwaas.rst @@ -0,0 +1,53 @@ +`Home `_ OpenStack-Ansible Installation Guide + +Firewall Service (Optional) +--------------------------- + +The following procedure describes how to modify the +``/etc/openstack_deploy/user_variables.yml`` file to enable FWaaS. + +#. Override the default list of Neutron plugins to include + ``firewall``: + + .. code-block:: yaml + + neutron_plugin_base: + - firewall + - ... + +#. The complete `neutron_plugin_base`, at the time of this writing, is as follows: + + .. code-block:: yaml + + neutron_plugin_base: + - router + - firewall + - lbaas + - vpnaas + - metering + - qos + +#. Execute the Neutron install playbook in order to update the configuration: + + .. code-block:: shell-session + + # cd /opt/openstack-ansible/playbooks + # openstack-ansible os-neutron-install.yml + +#. Execute the Horizon install playbook in order to update the Horizon + configuration to show the FWaaS panels: + + .. code-block:: shell-session + + # cd /opt/openstack-ansible/playbooks + # openstack-ansible os-horizon-install.yml + +The FWaaS default configuration options may be changed through the +`conf override`_ mechanism using the ``neutron_neutron_conf_overrides`` +dict. + +.. _conf override: http://docs.openstack.org/developer/openstack-ansible/install-guide/configure-openstack.html + +-------------- + +.. include:: navigation.txt \ No newline at end of file diff --git a/doc/source/install-guide/configure-network-services-lbaas.rst b/doc/source/install-guide/configure-network-services-lbaas.rst new file mode 100644 index 0000000000..90b68b8ac9 --- /dev/null +++ b/doc/source/install-guide/configure-network-services-lbaas.rst @@ -0,0 +1,94 @@ +`Home `_ OpenStack-Ansible Installation Guide + +Load Balancing Service (Optional) +--------------------------------- + +OpenStack-Ansible currently provides the OpenStack Neutron LBaaS service using +HAProxy as the load balancer. LBaaS has two implementations available: v1 and +v2. + +Both implementations use agents that manage `HAProxy`_ daemons. However, LBaaS +v1 has a limitation of one port per load balancer. LBaaS v2 allows for multiple +ports (called *listeners*) per load balancer. + +.. note:: + + Horizon panels for LBaaS v2 are not yet available. + +.. _HAProxy: http://www.haproxy.org/ + +Deploying LBaaS v1 +~~~~~~~~~~~~~~~~~~ + +.. note:: + + LBaaS v1 was deprecated during the Liberty release and is not recommended + for new deployments. + +#. Start by adding the LBaaS v1 plugin to the ``neutron_plugin_base`` variable + within ``/etc/openstack_deploy/user_variables.yml``. + + .. code-block:: yaml + + neutron_plugin_base: + - router + - metering + - lbaas + + Ensure that ``neutron_plugin_base`` includes all of the plugins that you + want to deploy with Neutron **in addition** to the LBaaS plugin. + +#. Run the Neutron and Horizon playbooks to deploy the LBaaS v1 agent and enable + the LBaaS panels in Horizon. + + .. code-block:: console + + # cd /opt/openstack-ansible/playbooks + # openstack-ansible os-neutron-install.yml + # openstack-ansible os-horizon-install.yml + +Deploying LBaaS v2 +~~~~~~~~~~~~~~~~~~ + +#. Start by adding the LBaaS v2 plugin to the ``neutron_plugin_base`` variable + within ``/etc/openstack_deploy/user_variables.yml``. + + .. code-block:: yaml + + neutron_plugin_base: + - router + - metering + - lbaasv2 + + Ensure that ``neutron_plugin_base`` includes all of the plugins that you + want to deploy with Neutron **in addition** to the LBaaS plugin. + +#. Run the Neutron playbook to deploy the LBaaS v2 agent: + + .. code-block:: console + + # cd /opt/openstack-ansible/playbooks + # openstack-ansible os-neutron-install.yml + +Special notes about LBaaS +~~~~~~~~~~~~~~~~~~~~~~~~~ + +The LBaaS default configuration options may be changed through the +`conf override`_ mechanism using the ``neutron_lbaas_agent_ini_overrides`` +dict. + +LBaaS v1 and v2 agents cannot run at the same time. If a deployer switches from +LBaaS v1 to v2, the v2 agent will be the only agent running. The LBaaS v1 agent +will be stopped along with any load balancers provisioned under the v1 agent. +The same is true if a deployer chooses to move from LBaaS v2 to v1. + +Load balancers are not migrated between LBaaS v1 and v2 automatically. Each +implementation has different code paths and database tables. Deployers will need +to manually delete load balancers, pools, and members before switching LBaaS +versions. Those objects will need to be re-created afterwards. + +.. _conf override: http://docs.openstack.org/developer/openstack-ansible/install-guide/configure-openstack.html + +-------------- + +.. include:: navigation.txt \ No newline at end of file diff --git a/doc/source/install-guide/configure-network-services-vpnaas.rst b/doc/source/install-guide/configure-network-services-vpnaas.rst new file mode 100644 index 0000000000..4214c985f4 --- /dev/null +++ b/doc/source/install-guide/configure-network-services-vpnaas.rst @@ -0,0 +1,50 @@ +`Home `_ OpenStack-Ansible Installation Guide + +Virtual Private Network Service (Optional) +------------------------------------------ + +The following procedure describes how to modify the +``/etc/openstack_deploy/user_variables.yml`` file to enable VPNaaS. + +#. Override the default list of Neutron plugins to include + ``vpnaas``: + + .. code-block:: yaml + + neutron_plugin_base: + - router + - metering + +#. The complete `neutron_plugin_base`, at the time of this writing, is as follows: + + .. code-block:: yaml + + neutron_plugin_base: + - router + - metering + - vpnaas + +#. Execute the Neutron install playbook in order to update the configuration: + + .. code-block:: shell-session + + # cd /opt/openstack-ansible/playbooks + # openstack-ansible os-neutron-install.yml + +#. Execute the Horizon install playbook in order to update the Horizon + configuration to show the VPNaaS panels: + + .. code-block:: shell-session + + # cd /opt/openstack-ansible/playbooks + # openstack-ansible os-horizon-install.yml + +The VPNaaS default configuration options may be changed through the +`conf override`_ mechanism using the ``neutron_neutron_conf_overrides`` +dict. + +.. _conf override: http://docs.openstack.org/developer/openstack-ansible/install-guide/configure-openstack.html + +-------------- + +.. include:: navigation.txt \ No newline at end of file diff --git a/doc/source/install-guide/configure-network-services.rst b/doc/source/install-guide/configure-network-services.rst index d8ebdaa775..aa78a65996 100644 --- a/doc/source/install-guide/configure-network-services.rst +++ b/doc/source/install-guide/configure-network-services.rst @@ -1,191 +1,18 @@ `Home `_ OpenStack-Ansible Installation Guide Configuring the Network Services (Optional) ---------------------------------------------------- +------------------------------------------- + +.. toctree:: + configure-network-services-fwaas.rst + configure-network-services-lbaas.rst + configure-network-services-vpnaas.rst The OpenStack Networking Service, Neutron, includes the following services: - Firewall as a Service (FWaaS) allows for the configuration of a firewall that filters traffic from the router. - Load Balancer as a Service (LBaaS) allows for the configuration of a load balancer that directs traffic to the specified instances. - VPN as a Service (VPNaaS) allows for the configuration of a virtual private network allowing the extension of the private network across a public network. -Firewall Service (Optional) ---------------------------------------------------- - -The following procedure describes how to modify the -``/etc/openstack_deploy/user_variables.yml`` file to enable FWaaS. - -#. Override the default list of Neutron plugins to include - ``firewall``: - - .. code-block:: yaml - - neutron_plugin_base: - - firewall - - ... - -#. The complete `neutron_plugin_base`, at the time of this writing, is as follows: - - .. code-block:: yaml - - neutron_plugin_base: - - router - - firewall - - lbaas - - vpnaas - - metering - - qos - -#. Execute the Neutron install playbook in order to update the configuration: - - .. code-block:: shell-session - - # cd /opt/openstack-ansible/playbooks - # openstack-ansible os-neutron-install.yml - -#. Execute the Horizon install playbook in order to update the Horizon - configuration to show the FWaaS panels: - - .. code-block:: shell-session - - # cd /opt/openstack-ansible/playbooks - # openstack-ansible os-horizon-install.yml - -The FWaaS default configuration options may be changed through the -`conf override`_ mechanism using the ``neutron_neutron_conf_overrides`` -dict. - -Load Balancing Service (Optional) ---------------------------------------------------------- - -OpenStack-Ansible currently provides the OpenStack Neutron LBaaS service using -HAProxy as the load balancer. LBaaS has two implementations available: v1 and -v2. - -Both implementations use agents that manage `HAProxy`_ daemons. However, LBaaS -v1 has a limitation of one port per load balancer. LBaaS v2 allows for multiple -ports (called *listeners*) per load balancer. - -.. note:: - - Horizon panels for LBaaS v2 are not yet available. - -.. _HAProxy: http://www.haproxy.org/ - -Deploying LBaaS v1 -~~~~~~~~~~~~~~~~~~ - -.. note:: - - LBaaS v1 was deprecated during the Liberty release and is not recommended - for new deployments. - -#. Start by adding the LBaaS v1 plugin to the ``neutron_plugin_base`` variable - within ``/etc/openstack_deploy/user_variables.yml``. - - .. code-block:: yaml - - neutron_plugin_base: - - router - - metering - - lbaas - - Ensure that ``neutron_plugin_base`` includes all of the plugins that you - want to deploy with Neutron **in addition** to the LBaaS plugin. - -#. Run the Neutron and Horizon playbooks to deploy the LBaaS v1 agent and enable - the LBaaS panels in Horizon. - - .. code-block:: console - - # cd /opt/openstack-ansible/playbooks - # openstack-ansible os-neutron-install.yml - # openstack-ansible os-horizon-install.yml - -Deploying LBaaS v2 -~~~~~~~~~~~~~~~~~~ - -#. Start by adding the LBaaS v2 plugin to the ``neutron_plugin_base`` variable - within ``/etc/openstack_deploy/user_variables.yml``. - - .. code-block:: yaml - - neutron_plugin_base: - - router - - metering - - lbaasv2 - - Ensure that ``neutron_plugin_base`` includes all of the plugins that you - want to deploy with Neutron **in addition** to the LBaaS plugin. - -#. Run the Neutron playbook to deploy the LBaaS v2 agent: - - .. code-block:: console - - # cd /opt/openstack-ansible/playbooks - # openstack-ansible os-neutron-install.yml - -Special notes about LBaaS -~~~~~~~~~~~~~~~~~~~~~~~~~ - -The LBaaS default configuration options may be changed through the -`conf override`_ mechanism using the ``neutron_lbaas_agent_ini_overrides`` -dict. - -LBaaS v1 and v2 agents cannot run at the same time. If a deployer switches from -LBaaS v1 to v2, the v2 agent will be the only agent running. The LBaaS v1 agent -will be stopped along with any load balancers provisioned under the v1 agent. -The same is true if a deployer chooses to move from LBaaS v2 to v1. - -Load balancers are not migrated between LBaaS v1 and v2 automatically. Each -implementation has different code paths and database tables. Deployers will need -to manually delete load balancers, pools, and members before switching LBaaS -versions. Those objects will need to be re-created afterwards. - -Virtual Private Network Service (Optional) ------------------------------------------- - -The following procedure describes how to modify the -``/etc/openstack_deploy/user_variables.yml`` file to enable VPNaaS. - -#. Override the default list of Neutron plugins to include - ``vpnaas``: - - .. code-block:: yaml - - neutron_plugin_base: - - router - - metering - -#. The complete `neutron_plugin_base`, at the time of this writing, is as follows: - - .. code-block:: yaml - - neutron_plugin_base: - - router - - metering - - vpnaas - -#. Execute the Neutron install playbook in order to update the configuration: - - .. code-block:: shell-session - - # cd /opt/openstack-ansible/playbooks - # openstack-ansible os-neutron-install.yml - -#. Execute the Horizon install playbook in order to update the Horizon - configuration to show the VPNaaS panels: - - .. code-block:: shell-session - - # cd /opt/openstack-ansible/playbooks - # openstack-ansible os-horizon-install.yml - -The VPNaaS default configuration options may be changed through the -`conf override`_ mechanism using the ``neutron_neutron_conf_overrides`` -dict. - -.. _conf override: http://docs.openstack.org/developer/openstack-ansible/install-guide/configure-openstack.html - -------------- .. include:: navigation.txt