Document nova-api-metadata options

Document two options related to nova-api-metadata network configuration.
Edit labels and descriptions in environment_config.yaml. Fix typos.

Change-Id: I0089c7b5ae8ff9fc29bca80829b1c600fb845163

deployment_scripts/puppet/manifests/nsxv-config.pp

@@ -16,7 +16,7 @@ if $settings['nsxv_mgt_reserve_ip'] {
   prepare_network_config(hiera('network_scheme'))
   $network_metadata = hiera('network_metadata')
   $mgt_ip           = $network_metadata['vips']['nsxv_metadataproxy_ip']['ipaddr']
-  $mgt_netmask      = get_network_role_property('mgmt/vip','netmask')
+  $mgt_netmask      = get_network_role_property('mgmt/vip', 'netmask')
   $mgt_gateway      = hiera('management_vrouter_vip')
 } else {
   $mgt_ip      = $settings['nsxv_mgt_net_proxy_ips']

deployment_scripts/puppet/modules/nsxv/manifests/params.pp

@@ -1,6 +1,5 @@
 class nsxv::params {
-  # timout in seconds
-  $neutron_url_timeout = '600'
+  $neutron_url_timeout = '600' # seconds
   $plugin_name = 'nsxv'
   $nova_metadata_port = '8775'
 }

doc/user/source/configuration.rst

@@ -85,7 +85,16 @@ Plugin contains the following settings:
    certificate file* setting will appear providing an option to upload
    CA certificate which emitted NSX Manager certificate.
 
-   To enable Nova metadata service, set the following settings must be set:
+   To enable Nova metadata service, the following settings must be set:
+
+#. Use management network to access the nova-api-metadata -- configure
+   nova-api-metadata service to listen on OpenStack management network. If
+   disabled nova-api-metadata will listen on Public network.
+
+#. Allocate IP address in management network for NSX metadata proxy --
+   automatic IP address allocation, if disabled then user have to manually
+   specify IP address, netmask and gateway to avoid possible collisions. By
+   default management traffic is forwarded into Public network via vrouter IP.
 
 #. Metadata portgroup MoRef ID -- portgroup MoRef ID for metadata proxy service.
 

environment_config.yaml

@@ -118,19 +118,19 @@ attributes:
         action: 'hide'
   nsxv_metadata_listen_mgmt:
     value: false
-    label: 'Use mgmt network to access the metadata server'
-    description: 'Route to metadata server via openstack management network'
+    label: 'Use management network to access the nova-api-metadata'
+    description: 'If disabled nova-api-metadata listens on Public network'
     weight: 86
     type: 'checkbox'
   nsxv_mgt_reserve_ip:
     value: false
-    label: 'Reservation ip address in management network for use with NSXv metadata proxy'
-    description: 'If you tick this checkbox, then ip address for NSXv metadata proxy will be allocated in the managment network openstack. In the parameter "Metadata portgroup MoRef ID",    you must specify the portgroup id, which looks at managmnet network openstack.'
+    label: 'Allocate IP address in management network for NSX metadata proxy'
+    description: 'If enabled, then IP address for NSX metadata proxy will be allocated in the OpenStack management network. In the parameter "Metadata portgroup MoRef ID", you must specify portgroup id, which is adjacent with OpenStack management network'
     weight: 87
     type: 'checkbox'
     restrictions:
       - condition: 'settings:nsxv.nsxv_metadata_listen_mgmt.value == false'
-        message: '"Use mgmt network to access the metadata server" not selected'
+        message: '"Use management network to access the nova-api-metadata" not enabled'
         action: 'disable'
   nsxv_mgt_net_moid:
     value: ''