x/vmware-nsx
Code Issues Proposed changes

Clarify NSX-V vs. NSX-T

Browse Source 
NSX-T is the common name, not "Transformers" or "v3". This makes that
change throughout the docs and conf help. It also fixes a broken link
to the NSX-T pubs.

This change does not rename conf groups and options that use "v3".
That should be considered for a follow-on effort (with appropriate
deprecation).

Change-Id: I466f60e4476cedc439e17cba39a333a3853a32d9
This commit is contained in:
Matthew Edmonds 2018-06-22 15:25:59 -04:00
parent 1a7454a261
commit 042b6a6600
5 changed files with 37 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
api-ref/rest.md
View File

@ -19,9 +19,8 @@ for the neutron API applies here as well.
The VMware NSX neutron extensions supported by your plugin will depend on the version The VMware NSX neutron extensions supported by your plugin will depend on the version
of VMware NSX used. Two versions described herein are: of VMware NSX used. Two versions described herein are:
* [NSX for vSphere](https://www.vmware.com/support/pubs/nsx_pubs.html) aka 'NSX-v'. * [NSX for vSphere](https://www.vmware.com/support/pubs/nsx_pubs.html) aka 'NSX-V'.
* [NSX Transformers](https://my.vmware.com/web/vmware/details?productId=580&downloadGroup=NSX-v3-101) * [NSX-T](https://docs.vmware.com/en/VMware-NSX-T/index.html).
aka 'NSX-v3'.
@ -53,7 +52,7 @@ when interfacing with the NSX manager backend.
Resource attribute extension. Resource attribute extension.
###### Supported NSX Versions ###### Supported NSX Versions
NSX-v. NSX-V.
###### Supported Verbs ###### Supported Verbs
None (read-only). None (read-only).
@ -116,7 +115,7 @@ providing the ability to specify per-subnet DHCP MTU via the
Resource attribute extension. Resource attribute extension.
###### Supported NSX Versions ###### Supported NSX Versions
NSX-v. NSX-V.
###### Supported Verbs ###### Supported Verbs
POST, PUT POST, PUT
@ -179,7 +178,7 @@ providing the ability to specify per-subnet DNS search via the
Resource attribute extension. Resource attribute extension.
###### Supported NSX Versions ###### Supported NSX Versions
NSX-v. NSX-V.
###### Supported Verbs ###### Supported Verbs
POST, PUT POST, PUT
@ -242,7 +241,7 @@ providing the ability to enable MAC learning on the associated port via the
Resource attribute extension. Resource attribute extension.
###### Supported NSX Versions ###### Supported NSX Versions
NSX-v3. NSX-T.
###### Supported Verbs ###### Supported Verbs
POST, PUT POST, PUT
@ -320,7 +319,7 @@ onto physical networks in NSX.
Resource attribute extensions. Resource attribute extensions.
###### Supported NSX Versions ###### Supported NSX Versions
NSX-v3, NSX-v. NSX-T, NSX-V.
###### Supported Verbs ###### Supported Verbs
See the See the
@ -379,7 +378,7 @@ security groups belonging to the said port.
Resource attribute extensions. Resource attribute extensions.
###### Supported NSX Versions ###### Supported NSX Versions
NSX-v3, NSX-v. NSX-T, NSX-V.
###### Supported Verbs ###### Supported Verbs
The `provider` attribute on neutron security groups is only settable during creation (POST). The `provider` attribute on neutron security groups is only settable during creation (POST).
@ -544,14 +543,14 @@ GET port
###### Description ###### Description
Extends neutron [routers](https://developer.openstack.org/api-ref/networking/v2/#routers-routers) Extends neutron [routers](https://developer.openstack.org/api-ref/networking/v2/#routers-routers)
by adding the `router_size` attribute to support configuration of NSX-v by adding the `router_size` attribute to support configuration of NSX-V
edge size. edge size.
###### Extension Type ###### Extension Type
Resource attribute extension. Resource attribute extension.
###### Supported NSX Versions ###### Supported NSX Versions
NSX-v. NSX-V.
###### Supported Verbs ###### Supported Verbs
POST, PUT POST, PUT
@ -560,7 +559,7 @@ POST, PUT
[routers](https://developer.openstack.org/api-ref/networking/v2/#routers-routers) [routers](https://developer.openstack.org/api-ref/networking/v2/#routers-routers)
###### Extension Attribute(s) ###### Extension Attribute(s)
* `router_size`: The NSX-v edge size to use. * `router_size`: The NSX-V edge size to use.
###### Example Response ###### Example Response
```json ```json
@ -608,14 +607,14 @@ POST, PUT
###### Description ###### Description
Extends neutron [routers](https://developer.openstack.org/api-ref/networking/v2/#routers-routers) Extends neutron [routers](https://developer.openstack.org/api-ref/networking/v2/#routers-routers)
by adding the `router_type` attribute to support configuration of NSX-v by adding the `router_type` attribute to support configuration of NSX-V
router type. router type.
###### Extension Type ###### Extension Type
Resource attribute extension. Resource attribute extension.
###### Supported NSX Versions ###### Supported NSX Versions
NSX-v. NSX-V.
###### Supported Verbs ###### Supported Verbs
POST, PUT POST, PUT
@ -624,7 +623,7 @@ POST, PUT
[routers](https://developer.openstack.org/api-ref/networking/v2/#routers-routers) [routers](https://developer.openstack.org/api-ref/networking/v2/#routers-routers)
###### Extension Attribute(s) ###### Extension Attribute(s)
* `router_type`: The NSX-v router type. Must be either `shared` or `exclusive`. * `router_type`: The NSX-V router type. Must be either `shared` or `exclusive`.
###### Example Response ###### Example Response
```json ```json
@ -680,7 +679,7 @@ by adding a `local_ip_prefix` attribute allowing rules to be created with IP pre
Resource attribute extension. Resource attribute extension.
###### Supported NSX Versions ###### Supported NSX Versions
NSX-v3, NSXv. NSX-T, NSXv.
###### Supported Verbs ###### Supported Verbs
POST; using an IP prefix on a rule can only be done when creating the rule. POST; using an IP prefix on a rule can only be done when creating the rule.
@ -721,7 +720,7 @@ with a boolean attribute `logging` to enable per security group logging on NSX.
Resource attribute extension. Resource attribute extension.
###### Supported NSX Versions ###### Supported NSX Versions
NSX-v3, NSX-v. NSX-T, NSX-V.
###### Supported Verbs ###### Supported Verbs
POST, PUT. POST, PUT.
@ -809,7 +808,7 @@ the `vnic_index` attribute enabling per-port assignment of a VNIC index.
Resource attribute extension. Resource attribute extension.
###### Supported NSX Versions ###### Supported NSX Versions
NSX-v. NSX-V.
###### Supported Verbs ###### Supported Verbs
POST, PUT. POST, PUT.

26
doc/source/admin_util.rst
View File

@ -1,11 +1,11 @@
Admin Utility Admin Utility
============= =============
The NSXv and the NSXv3 support the nsxadmin utility. This enables and administrator to determine and rectify inconsistencies between the Neutron DB and the NSX. NSX-V and NSX-T support the nsxadmin utility. This enables and administrator to determine and rectify inconsistencies between the Neutron DB and NSX.
usage: nsxadmin -r <resources> -o <operation> usage: nsxadmin -r <resources> -o <operation>
NSXv Plugin NSX-V Plugin
----------- ------------
The following resources are supported: 'security-groups', 'edges', 'networks', 'firewall-sections', 'orphaned-edges', 'spoofguard-policy', 'missing-edges', 'backup-edges', 'nsx-security-groups', 'dhcp-binding' and 'metadata' The following resources are supported: 'security-groups', 'edges', 'networks', 'firewall-sections', 'orphaned-edges', 'spoofguard-policy', 'missing-edges', 'backup-edges', 'nsx-security-groups', 'dhcp-binding' and 'metadata'
@ -171,7 +171,7 @@ Routers
nsxadmin -r routers -o nsx-recreate --property edge-id=edge-308 nsxadmin -r routers -o nsx-recreate --property edge-id=edge-308
- Recreate a router on the nsx backend by removing it from the current edge (if any), and attaching to a new one:: - Recreate a router on the NSX backend by removing it from the current edge (if any), and attaching to a new one::
nsxadmin -r routers -o nsx-recreate --property router-id=8cdd6d06-b457-4cbb-a0b1-41e08ccce287 nsxadmin -r routers -o nsx-recreate --property router-id=8cdd6d06-b457-4cbb-a0b1-41e08ccce287
@ -241,7 +241,7 @@ Security Groups, Firewall and Spoofguard
nsxadmin -r firewall-section -o nsx-clean nsxadmin -r firewall-section -o nsx-clean
- Reorder the nsx L3 firewall sections to correctly support the policy security groups - Reorder the NSX L3 firewall sections to correctly support the policy security groups
nsxadmin -r firewall-sections -o nsx-reorder nsxadmin -r firewall-sections -o nsx-reorder
@ -297,7 +297,7 @@ Config
nsxadmin -r config -o validate nsxadmin -r config -o validate
NSXv3 Plugin NSX-T Plugin
------------ ------------
The following resources are supported: 'security-groups', 'routers', 'networks', 'nsx-security-groups', 'dhcp-binding', 'metadata-proxy', 'orphaned-dhcp-servers', 'firewall-sections', 'certificate', 'orphaned-networks', 'orphaned-routers', The following resources are supported: 'security-groups', 'routers', 'networks', 'nsx-security-groups', 'dhcp-binding', 'metadata-proxy', 'orphaned-dhcp-servers', 'firewall-sections', 'certificate', 'orphaned-networks', 'orphaned-routers',
@ -355,7 +355,7 @@ Ports
nsxadmin -r ports -o list-mismatches nsxadmin -r ports -o list-mismatches
- Update the VMs ports (all or of a specific project) on the backend after migrating nsx-v -> nsx-v3:: - Update the VMs ports (all or of a specific project) on the backend after migrating NSX-V -> NSX-T::
nsxadmin -r ports -o nsx-migrate-v-v3 (--property project-id=<> --property host-moref=<> --property respool-moref=<> --property net-name=<> --property datastore-moref=<>)) --plugin nsxv3 nsxadmin -r ports -o nsx-migrate-v-v3 (--property project-id=<> --property host-moref=<> --property respool-moref=<> --property net-name=<> --property datastore-moref=<>)) --plugin nsxv3
@ -386,7 +386,7 @@ Security Groups & NSX Security Groups
nsxadmin -r security-groups -o fix-mismatch nsxadmin -r security-groups -o fix-mismatch
- Update NSX security groups dynamic criteria for NSXv3 CrossHairs:: - Update NSX security groups dynamic criteria for NSX-T CrossHairs::
nsxadmin -r nsx-security-groups -o migrate-to-dynamic-criteria nsxadmin -r nsx-security-groups -o migrate-to-dynamic-criteria
@ -419,7 +419,7 @@ Metadata Proxy
nsxadmin -r metadata-proxy -o list nsxadmin -r metadata-proxy -o list
- Resync metadata proxies for NSXv3 version 1.1.0 and above (enable md proxy, or update the uuid). This is only for migrating to native metadata support:: - Resync metadata proxies for NSX-T version 1.1.0 and above (enable md proxy, or update the uuid). This is only for migrating to native metadata support::
nsxadmin -r metadata-proxy -o nsx-update --property metadata_proxy_uuid=<metadata_proxy_uuid> nsxadmin -r metadata-proxy -o nsx-update --property metadata_proxy_uuid=<metadata_proxy_uuid>
@ -434,7 +434,7 @@ DHCP Bindings
nsxadmin -r dhcp-binding -o list nsxadmin -r dhcp-binding -o list
- Resync DHCP bindings for NSXv3 version 1.1.0 and above. This is only for migrating to native DHCP support:: - Resync DHCP bindings for NSX-T version 1.1.0 and above. This is only for migrating to native DHCP support::
nsxadmin -r dhcp-binding -o nsx-update --property dhcp_profile_uuid=<dhcp_profile_uuid> nsxadmin -r dhcp-binding -o nsx-update --property dhcp_profile_uuid=<dhcp_profile_uuid>
@ -445,11 +445,11 @@ DHCP Bindings
Orphaned DHCP Servers Orphaned DHCP Servers
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
- List orphaned DHCP servers (exist on NSXv3 backend but don't have a corresponding binding in Neutron DB):: - List orphaned DHCP servers (exist on NSX-T backend but don't have a corresponding binding in Neutron DB)::
nsxadmin -r orphaned-dhcp-servers -o nsx-list nsxadmin -r orphaned-dhcp-servers -o nsx-list
- Clean orphaned DHCP servers (delete logical DHCP servers from NSXv3 backend):: - Clean orphaned DHCP servers (delete logical DHCP servers from NSX-T backend)::
nsxadmin -r orphaned-dhcp-servers -o nsx-clean nsxadmin -r orphaned-dhcp-servers -o nsx-clean
@ -547,7 +547,7 @@ Config
NSXtvd Plugin NSXtvd Plugin
------------- -------------
- All the nsx-v/v3 utilities can be used by calling - All the NSX-V/T utilities can be used by calling
nsxadmin --plugin nsxv/v3 -r <> -o <> nsxadmin --plugin nsxv/v3 -r <> -o <>

8
doc/source/devstack.rst
View File

@ -5,8 +5,8 @@ Below are the options for configuring the NSX plugin with DevStack. Prior
to doing this DevStack needs to be downloaded. After updating the relevant to doing this DevStack needs to be downloaded. After updating the relevant
configuration file(s) run ./stack.sh configuration file(s) run ./stack.sh
NSXv NSX-V
---- -----
LBaaS v2 Driver LBaaS v2 Driver
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
@ -119,7 +119,7 @@ Add neutron-vpnaas repo as an external repository and configure following flags
NEUTRON_VPNAAS_SERVICE_PROVIDER=VPN:vmware:vmware_nsx.services.vpnaas.nsxv.ipsec_driver.NSXvIPsecVpnDriver:default NEUTRON_VPNAAS_SERVICE_PROVIDER=VPN:vmware:vmware_nsx.services.vpnaas.nsxv.ipsec_driver.NSXvIPsecVpnDriver:default
NSXv3 NSX-T
----- -----
QoS Driver QoS Driver
@ -162,7 +162,7 @@ Trunk Driver
Enable trunk service and configure following flags in ``local.conf``:: Enable trunk service and configure following flags in ``local.conf``::
[[local]|[localrc]] [[local]|[localrc]]
# Trunk plugin NSXv3 driver config # Trunk plugin NSX-T driver config
ENABLED_SERVICES+=,q-trunk ENABLED_SERVICES+=,q-trunk
Q_SERVICE_PLUGIN_CLASSES=trunk Q_SERVICE_PLUGIN_CLASSES=trunk

2
doc/source/housekeeper.rst
View File

@ -58,7 +58,7 @@ via a timing mechanism such as Linux cron.
Plugin Jobs Plugin Jobs
----------- -----------
NSX-v NSX-V
~~~~~ ~~~~~
error_dhcp_edge: scans for DHCP Edge appliances which are in ERROR state. error_dhcp_edge: scans for DHCP Edge appliances which are in ERROR state.

4
vmware_nsx/common/config.py
View File

@ -233,7 +233,7 @@ cluster_opts = [
nsx_common_opts = [ nsx_common_opts = [
cfg.StrOpt('nsx_l2gw_driver', cfg.StrOpt('nsx_l2gw_driver',
help=_("Specify the class path for the Layer 2 gateway " help=_("Specify the class path for the Layer 2 gateway "
"backend driver(i.e. NSXv3/NSX-V). This field will be " "backend driver (i.e. NSX-T/NSX-V). This field will be "
"used when a L2 Gateway service plugin is configured.")), "used when a L2 Gateway service plugin is configured.")),
cfg.StrOpt('locking_coordinator_url', cfg.StrOpt('locking_coordinator_url',
help=_("(Optional) URL for distributed locking coordination " help=_("(Optional) URL for distributed locking coordination "
@ -246,7 +246,7 @@ nsx_common_opts = [
help=_("If true, the server then allows the caller to " help=_("If true, the server then allows the caller to "
"specify the id of resources. This should only " "specify the id of resources. This should only "
"be enabled in order to allow one to migrate an " "be enabled in order to allow one to migrate an "
"existing install of neutron to the nsx-v3 plugin.")), "existing install of neutron to the NSX-T plugin.")),
cfg.ListOpt('nsx_extension_drivers', cfg.ListOpt('nsx_extension_drivers',
default=[], default=[],
help=_("An ordered list of extension driver " help=_("An ordered list of extension driver "