diff --git a/doc/source/devstack.rst b/doc/source/devstack.rst new file mode 100644 index 0000000000..84777b46dc --- /dev/null +++ b/doc/source/devstack.rst @@ -0,0 +1,155 @@ +NSX DevStack Configurations +=========================== + +Below are the options for configuring the NSX plugin with DevStack. Prior +to doing this DevStack needs to be downloaded. After updating the relevant +configuration file(s) run ./stack.sh + +NSXv +---- + +LBaaS v2 Driver +~~~~~~~~~~~~~~~ + +Add lbaas repo as an external repository and configure following flags in ``local.conf``:: + + [[local]|[localrc]] + enable_plugin neutron-lbaas https://git.openstack.org/openstack/neutron-lbaas + enable_service q-lbaasv2 + +Configure the service provider:: + [[post-config|$NEUTRON_LBAAS_CONF]] + [service_providers] + service_provider = LOADBALANCERV2:VMWareEdge:neutron_lbaas.drivers.vmware.edge_driver_v2.EdgeLoadBalancerDriverV2:default + +QoS Driver +~~~~~~~~~~ + +Enable the qos in ``local.conf``:: + + [[local|localrc]] + ENABLED_SERVICES=q-qos + +For NSXv set the service plugin in ``local.conf``, and enable the dvs features:: + + [[post-config|$NEUTRON_CONF]] + [DEFAULT] + service_plugins = vmware_nsxv_qos + + [[local|localrc]] + NSXV_USE_DVS_FEATURES = True + +Optional: Update the nsx qos_peak_bw_multiplier in nsx.ini (default value is 2.0):: + + [NSX] + qos_peak_bw_multiplier = + +L2GW Driver +~~~~~~~~~~~ + +Add networking-l2gw repo as an external repository and configure following flags in ``local.conf``:: + + [[local|localrc]] + enable_plugin networking-l2gw https://github.com/openstack/networking-l2gw + ENABLED_SERVICES+=l2gw-plugin + NETWORKING_L2GW_SERVICE_DRIVER=L2GW:vmware-nsx-l2gw:vmware_nsx.services.l2gateway.nsx_v.driver.NsxvL2GatewayDriver:default + +IPAM Driver +~~~~~~~~~~~ + +Update the ``local.conf`` file:: + + [[post-config|$NEUTRON_CONF]] + [DEFAULT] + ipam_driver = vmware_nsxv_ipam + +Flow Classifier +~~~~~~~~~~~~~~~ + +Update the ``local.conf`` file:: + + [[local|localrc]] + enable_plugin networking-sfc https://git.openstack.org/openstack/networking-sfc master + + [[post-config|$NEUTRON_CONF]] + [DEFAULT] + service_plugins = networking_sfc.services.flowclassifier.plugin.FlowClassifierPlugin + + [flowclassifier] + drivers = vmware-nsxv-sfc + + [nsxv] + service_insertion_profile_id = + +In order to prevent tenants from changing the flow classifier, please add the following +lines to the policy.json file:: + + "create_flow_classifier": "rule:admin_only", + "update_flow_classifier": "rule:admin_only", + "delete_flow_classifier": "rule:admin_only", + "get_flow_classifier": "rule:admin_only" + +NSXv3 +----- + +QoS Driver +~~~~~~~~~~ + +Enable the qos in ``local.conf``:: + + [[local|localrc]] + ENABLED_SERVICES=q-qos + + [[post-config|$NEUTRON_CONF]] + [DEFAULT] + service_plugins = neutron.services.qos.qos_plugin.QoSPlugin + + [qos] + notification_drivers = vmware_nsxv3_message_queue + +Optional: Update the nsx qos_peak_bw_multiplier in nsx.ini (default value is 2.0):: + + [NSX] + qos_peak_bw_multiplier = + +L2GW Driver +~~~~~~~~~~~ + +Add networking-l2gw repo as an external repository and configure following flags in ``local.conf``:: + + [[local|localrc]] + enable_plugin networking-l2gw https://github.com/openstack/networking-l2gw + ENABLED_SERVICES+=l2gw-plugin + NETWORKING_L2GW_SERVICE_DRIVER=L2GW:vmware-nsx-l2gw:vmware_nsx.services.l2gateway.nsx_v3.driver.NsxV3Driver:default + DEFAULT_BRIDGE_CLUSTER_UUID= + +IPAM Driver +~~~~~~~~~~~ + +Update the ``local.conf`` file:: + + [[post-config|$NEUTRON_CONF]] + [DEFAULT] + ipam_driver = vmware_nsxv3_ipam + +Trunk Driver +~~~~~~~~~~~~ + +Enable trunk service and configure following flags in ``local.conf``:: + + [[local]|[localrc]] + # Trunk plugin NSXv3 driver config + ENABLED_SERVICES+=,q-trunk + Q_SERVICE_PLUGIN_CLASSES=trunk + +TaaS Driver +~~~~~~~~~~~ + +Add tap-as-a-service repo as an external repository and configure following flags in ``local.conf``:: + + [[local]|[localrc]] + # TaaS plugin NSXv3 driver config + enable_plugin tap-as-a-service https://github.com/openstack/tap-as-a-service + enable_service taas + TAAS_SERVICE_DRIVER=TAAS:vmware_nsx_taas:vmware_nsx.services.neutron_taas.nsx_v3.driver.NsxV3Driver:default + diff --git a/vmware_nsx/services/flowclassifier/nsx_v/README.rst b/vmware_nsx/services/flowclassifier/nsx_v/README.rst deleted file mode 100644 index ce1790f9f2..0000000000 --- a/vmware_nsx/services/flowclassifier/nsx_v/README.rst +++ /dev/null @@ -1,30 +0,0 @@ -=============================================================== - Enabling NSX Flow Classifier for service insertion in DevStack -=============================================================== - -1. Download DevStack - -2. Update the ``local.conf`` file:: - - [[local|localrc]] - enable_plugin networking-sfc https://git.openstack.org/openstack/networking-sfc master - - [[post-config|$NEUTRON_CONF]] - [DEFAULT] - service_plugins = networking_sfc.services.flowclassifier.plugin.FlowClassifierPlugin - - [flowclassifier] - drivers = vmware-nsxv-sfc - - [nsxv] - service_insertion_profile_id = - -3. In order to prevent tenants from changing the flow classifier, please add the following - lines to the policy.json file: - - "create_flow_classifier": "rule:admin_only", - "update_flow_classifier": "rule:admin_only", - "delete_flow_classifier": "rule:admin_only", - "get_flow_classifier": "rule:admin_only" - -4. run ``stack.sh`` diff --git a/vmware_nsx/services/ipam/nsx_v/README.rst b/vmware_nsx/services/ipam/nsx_v/README.rst deleted file mode 100644 index 47be1330ed..0000000000 --- a/vmware_nsx/services/ipam/nsx_v/README.rst +++ /dev/null @@ -1,13 +0,0 @@ -================================================================ - Enabling NSXv IPAM for external & provider networks in Devstack -================================================================ - -1. Download DevStack - -2. Update the ``local.conf`` file:: - - [[post-config|$NEUTRON_CONF]] - [DEFAULT] - ipam_driver = vmware_nsxv_ipam - -3. run ``stack.sh`` diff --git a/vmware_nsx/services/ipam/nsx_v3/README.rst b/vmware_nsx/services/ipam/nsx_v3/README.rst deleted file mode 100644 index 5dca2a152c..0000000000 --- a/vmware_nsx/services/ipam/nsx_v3/README.rst +++ /dev/null @@ -1,13 +0,0 @@ -================================================================= - Enabling NSXv3 IPAM for external & provider networks in Devstack -================================================================= - -1. Download DevStack - -2. Update the ``local.conf`` file:: - - [[post-config|$NEUTRON_CONF]] - [DEFAULT] - ipam_driver = vmware_nsxv3_ipam - -3. run ``stack.sh`` diff --git a/vmware_nsx/services/l2gateway/README.rst b/vmware_nsx/services/l2gateway/README.rst deleted file mode 100644 index 369eb711be..0000000000 --- a/vmware_nsx/services/l2gateway/README.rst +++ /dev/null @@ -1,35 +0,0 @@ -============================================ - Enabling NSX L2 Gateway Plugin in DevStack -============================================ - -Following steps are meant for L2GW service in neutron for stable/mitaka* release onwards. - -- Download DevStack - -- Add networking-l2gw repo as an external repository and configure following flags in ``local.conf``:: - - [[local|localrc]] - enable_plugin networking-l2gw https://github.com/openstack/networking-l2gw - ENABLED_SERVICES+=l2gw-plugin - -- For NSX|v3 include the following additional flags in ``local.conf``:: - - [[local|localrc]] - NETWORKING_L2GW_SERVICE_DRIVER=L2GW:vmware-nsx-l2gw:vmware_nsx.services.l2gateway.nsx_v3.driver.NsxV3Driver:default - DEFAULT_BRIDGE_CLUSTER_UUID= - -- For NSX|V include the following additional flags in ``local.conf``:: - - [[local|localrc]] - NETWORKING_L2GW_SERVICE_DRIVER=L2GW:vmware-nsx-l2gw:vmware_nsx.services.l2gateway.nsx_v.driver.NsxvL2GatewayDriver:default - -- Run ``stack.sh`` - -\* Configuration for stable/liberty release in ``local.conf``:: - - [[local|localrc]] - enable_plugin networking-l2gw https://github.com/openstack/networking-l2gw - NSX_L2GW_DRIVER='vmware_nsx.services.l2gateway.nsx_v3.driver.NsxV3Driver' # NSXv3 driver - NSX_L2GW_DRIVER='vmware_nsx.services.l2gateway.nsx_v.driver.NsxvL2GatewayDriver' # NSX|V driver - Q_SERVICE_PLUGIN_CLASSES=vmware_nsx_l2gw - DEFAULT_BRIDGE_CLUSTER_UUID= diff --git a/vmware_nsx/services/neutron_taas/README.rst b/vmware_nsx/services/neutron_taas/README.rst deleted file mode 100644 index a952b6dcd2..0000000000 --- a/vmware_nsx/services/neutron_taas/README.rst +++ /dev/null @@ -1,13 +0,0 @@ -================================================= - Enabling NSX Tap-as-a-Service Plugin in DevStack -================================================= - -1. Download DevStack - -2. Add tap-as-a-service repo as an external repository and configure following flags in ``local.conf``:: - - [[local]|[localrc]] - # TaaS plugin NSXv3 driver config - enable_plugin tap-as-a-service https://github.com/openstack/tap-as-a-service - enable_service taas - TAAS_SERVICE_DRIVER=TAAS:vmware_nsx_taas:vmware_nsx.services.neutron_taas.nsx_v3.driver.NsxV3Driver:default diff --git a/vmware_nsx/services/qos/README.rst b/vmware_nsx/services/qos/README.rst deleted file mode 100644 index 3d899b12cd..0000000000 --- a/vmware_nsx/services/qos/README.rst +++ /dev/null @@ -1,35 +0,0 @@ -============================================ - Enabling NSX QoS in DevStack -============================================ - -1. Download DevStack - -2. Enable the qos in ``local.conf``:: - - [[local|localrc]] - ENABLED_SERVICES=q-qos - -3. For NSXv set the service plugin in ``local.conf``, and enable the dvs features:: - - [[post-config|$NEUTRON_CONF]] - [DEFAULT] - service_plugins = vmware_nsxv_qos - - [[local|localrc]] - NSXV_USE_DVS_FEATURES = True - -4. For NSXv3 set the service plugin and notification_driver in ``local.conf``:: - - [[post-config|$NEUTRON_CONF]] - [DEFAULT] - service_plugins = neutron.services.qos.qos_plugin.QoSPlugin - - [qos] - notification_drivers = vmware_nsxv3_message_queue - -5. Optional: Update the nsx qos_peak_bw_multiplier in nsx.ini (default value is 2.0):: - - [NSX] - qos_peak_bw_multiplier = - -6. run ``stack.sh`` diff --git a/vmware_nsx/services/trunk/README.rst b/vmware_nsx/services/trunk/README.rst deleted file mode 100644 index da1b176a12..0000000000 --- a/vmware_nsx/services/trunk/README.rst +++ /dev/null @@ -1,12 +0,0 @@ -========================================= - Enabling NSX trunk driver using DevStack -========================================= - -1. Download DevStack - -2. Enable trunk service and configure following flags in ``local.conf``:: - - [[local]|[localrc]] - # Trunk plugin NSXv3 driver config - ENABLED_SERVICES+=,q-trunk - Q_SERVICE_PLUGIN_CLASSES=trunk