diff --git a/doc/config-reference/source/networking.rst b/doc/config-reference/source/networking.rst index 112b26d346..4359dbb9c6 100644 --- a/doc/config-reference/source/networking.rst +++ b/doc/config-reference/source/networking.rst @@ -5,6 +5,9 @@ Networking service .. toctree:: networking/networking_options_reference.rst + networking/fwaas.rst + networking/lbaas.rst + networking/vpnaas.rst networking/logs.rst networking/sample-configuration-files.rst networking/sample-configuration-files-advanced.rst diff --git a/doc/config-reference/source/networking/fwaas.rst b/doc/config-reference/source/networking/fwaas.rst new file mode 100644 index 0000000000..1eb5233e1e --- /dev/null +++ b/doc/config-reference/source/networking/fwaas.rst @@ -0,0 +1,10 @@ +=========================================== +Firewall-as-a-Service configuration options +=========================================== + +Use the following options in the ``fwaas_driver.ini`` +file for the FWaaS driver. + +.. include:: ../tables/neutron-fwaas.rst +.. include:: ../tables/neutron-fwaas_ngfw.rst +.. include:: ../tables/neutron-fwaas_varmour.rst diff --git a/doc/config-reference/source/networking/lbaas.rst b/doc/config-reference/source/networking/lbaas.rst new file mode 100644 index 0000000000..d51227144c --- /dev/null +++ b/doc/config-reference/source/networking/lbaas.rst @@ -0,0 +1,35 @@ +================================================ +Load-Balancer-as-a-Service configuration options +================================================ + +Use the following options in the ``neutron_lbaas.conf`` file for the +LBaaS agent. + +.. include:: ../tables/neutron-lbaas.rst + +Use the following options in the ``lbaas_agent.ini`` file for the +LBaaS agent. + +.. include:: ../tables/neutron-lbaas_agent.rst + +Use the following options in the ``services_lbaas.conf`` file for the +LBaaS agent. + +.. include:: ../tables/neutron-lbaas_services.rst + +Octavia configuration options +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Use the following options to configure the octavia service. + +.. include:: ../tables/octavia-api.rst +.. include:: ../tables/octavia-auth_token.rst +.. include:: ../tables/octavia-cache.rst +.. include:: ../tables/octavia-common.rst +.. include:: ../tables/octavia-cors.rst +.. include:: ../tables/octavia-database.rst +.. include:: ../tables/octavia-logging.rst +.. include:: ../tables/octavia-rabbitmq.rst +.. include:: ../tables/octavia-redis.rst +.. include:: ../tables/octavia-rpc.rst +.. include:: ../tables/octavia-zeromq.rst diff --git a/doc/config-reference/source/networking/networking_options_reference.rst b/doc/config-reference/source/networking/networking_options_reference.rst index 2c123052b9..b0d8d0bdf0 100644 --- a/doc/config-reference/source/networking/networking_options_reference.rst +++ b/doc/config-reference/source/networking/networking_options_reference.rst @@ -208,69 +208,6 @@ Use the following options to alter DVR-related settings. .. include:: ../tables/neutron-dvr.rst - -Firewall-as-a-Service driver -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Use the following options in the ``fwaas_driver.ini`` -file for the FWaaS driver. - -.. include:: ../tables/neutron-fwaas.rst -.. include:: ../tables/neutron-fwaas_ngfw.rst -.. include:: ../tables/neutron-fwaas_varmour.rst - -Load-Balancer-as-a-Service configuration options -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Use the following options in the ``neutron_lbaas.conf`` file for the -LBaaS agent. - -.. include:: ../tables/neutron-lbaas.rst - -Use the following options in the ``lbaas_agent.ini`` file for the -LBaaS agent. - -.. include:: ../tables/neutron-lbaas_agent.rst - -Use the following options in the ``services_lbaas.conf`` file for the -LBaaS agent. - -.. include:: ../tables/neutron-lbaas_services.rst - - -VPN-as-a-Service configuration options -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Use the following options in the ``vpnaas_agent.ini`` file for the -VPNaaS agent. - -.. include:: ../tables/neutron-vpnaas.rst -.. include:: ../tables/neutron-vpnaas_ipsec.rst -.. include:: ../tables/neutron-vpnaas_openswan.rst -.. include:: ../tables/neutron-vpnaas_strongswan.rst - -.. note:: - - ``strongSwan`` and ``Openswan`` cannot both be installed and enabled at the - same time. The ``vpn_device_driver`` configuration option in the - ``vpnaas_agent.ini`` file is an option that lists the VPN device - drivers that the Networking service will use. You must choose either - ``strongSwan`` or ``Openswan`` as part of the list. - -.. important:: - - Ensure that your ``strongSwan`` version is 5 or newer. - -To declare either one in the ``vpn_device_driver``: - -.. code-block:: ini - - #Openswan - vpn_device_driver = ['neutron_vpnaas.services.vpn.device_drivers.ipsec.OpenSwanDriver'] - - #strongSwan - vpn_device_driver = ['neutron.services.vpn.device_drivers.strongswan_ipsec.StrongSwanDriver'] - IPv6 router advertisement ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -286,23 +223,6 @@ agent. .. include:: ../tables/neutron-l3_agent.rst -Load Balancing service (octavia) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Use the following options to configure the octavia service: - -.. include:: ../tables/octavia-api.rst -.. include:: ../tables/octavia-auth_token.rst -.. include:: ../tables/octavia-cache.rst -.. include:: ../tables/octavia-common.rst -.. include:: ../tables/octavia-cors.rst -.. include:: ../tables/octavia-database.rst -.. include:: ../tables/octavia-logging.rst -.. include:: ../tables/octavia-rabbitmq.rst -.. include:: ../tables/octavia-redis.rst -.. include:: ../tables/octavia-rpc.rst -.. include:: ../tables/octavia-zeromq.rst - Logging ~~~~~~~ diff --git a/doc/config-reference/source/networking/vpnaas.rst b/doc/config-reference/source/networking/vpnaas.rst new file mode 100644 index 0000000000..65b4e9d5ec --- /dev/null +++ b/doc/config-reference/source/networking/vpnaas.rst @@ -0,0 +1,33 @@ +====================================== +VPN-as-a-Service configuration options +====================================== + +Use the following options in the ``vpnaas_agent.ini`` file for the +VPNaaS agent. + +.. include:: ../tables/neutron-vpnaas.rst +.. include:: ../tables/neutron-vpnaas_ipsec.rst +.. include:: ../tables/neutron-vpnaas_openswan.rst +.. include:: ../tables/neutron-vpnaas_strongswan.rst + +.. note:: + + ``strongSwan`` and ``Openswan`` cannot both be installed and enabled at the + same time. The ``vpn_device_driver`` configuration option in the + ``vpnaas_agent.ini`` file is an option that lists the VPN device + drivers that the Networking service will use. You must choose either + ``strongSwan`` or ``Openswan`` as part of the list. + +.. important:: + + Ensure that your ``strongSwan`` version is 5 or newer. + +To declare either one in the ``vpn_device_driver``: + +.. code-block:: ini + + #Openswan + vpn_device_driver = ['neutron_vpnaas.services.vpn.device_drivers.ipsec.OpenSwanDriver'] + + #strongSwan + vpn_device_driver = ['neutron.services.vpn.device_drivers.strongswan_ipsec.StrongSwanDriver']