Make many networking parameters consistent

These are mostly the low hanging fruit that only required a few
minor changes to fix.  There are more that require a lot of changes
or might be more controversial that will be done later.

Change-Id: I55cebc92ef37a3bb167f5fae0debe77339395e62
Partial-Bug: 1700664

network/management.yaml

@@ -39,7 +39,7 @@ parameters:
     description: Ip allocation pool range for the management network.
     type: json
   ManagementInterfaceDefaultRoute:
-    default: null
+    default: unset
     description: The default route of the management network.
     type: string
 

network/ports/ctlplane_vip.yaml

@@ -9,8 +9,8 @@ parameters:
     description: Name of the service to lookup
     default: ''
     type: string
-  NetworkName:
+  NetworkName: # Here for compatibility with isolated networks
-    description: # Here for compatibility with isolated networks
+    description: Name of the network where the VIP will be created
     default: ctlplane
     type: string
   PortName:

network/ports/external.yaml

@@ -6,7 +6,7 @@ description: >
 
 parameters:
   ExternalNetName:
-    description: Name of the external neutron network
+    description: The name of the external network.
     default: external
     type: string
   PortName:

network/ports/external_from_pool.yaml

@@ -5,7 +5,7 @@ description: >
 
 parameters:
   ExternalNetName:
-    description: Name of the external network
+    description: The name of the external network.
     default: external
     type: string
   PortName:

network/ports/external_from_pool_v6.yaml

@@ -6,7 +6,7 @@ description: >
 
 parameters:
   ExternalNetName:
-    description: Name of the external network
+    description: The name of the external network.
     default: external
     type: string
   PortName:

network/ports/external_v6.yaml

@@ -6,7 +6,7 @@ description: >
 
 parameters:
   ExternalNetName:
-    description: Name of the external neutron network
+    description: The name of the external network.
     default: external
     type: string
   PortName:

network/ports/internal_api.yaml

@@ -5,7 +5,7 @@ description: >
 
 parameters:
   InternalApiNetName:
-    description: Name of the internal API neutron network
+    description: The name of the internal API network.
     default: internal_api
     type: string
   PortName:

network/ports/internal_api_from_pool.yaml

@@ -5,7 +5,7 @@ description: >
 
 parameters:
   InternalApiNetName:
-    description: Name of the internal API network
+    description: The name of the internal API network.
     default: internal_api
     type: string
   PortName:

network/ports/internal_api_from_pool_v6.yaml

@@ -6,7 +6,7 @@ description: >
 
 parameters:
   InternalApiNetName:
-    description: Name of the internal API network
+    description: The name of the internal API network.
     default: internal_api
     type: string
   PortName:

network/ports/internal_api_v6.yaml

@@ -5,7 +5,7 @@ description: >
 
 parameters:
   InternalApiNetName:
-    description: Name of the internal API neutron network
+    description: The name of the internal API network.
     default: internal_api
     type: string
   PortName:

network/ports/management.yaml

@@ -6,7 +6,7 @@ description: >
 
 parameters:
   ManagementNetName:
-    description: Name of the management neutron network
+    description: The name of the management network.
     default: management
     type: string
   PortName:

network/ports/management_from_pool.yaml

@@ -5,7 +5,7 @@ description: >
 
 parameters:
   ManagementNetName:
-    description: Name of the management network
+    description: The name of the management network.
     default: management
     type: string
   PortName:

network/ports/management_from_pool_v6.yaml

@@ -6,7 +6,7 @@ description: >
 
 parameters:
   ManagementNetName:
-    description: Name of the management network
+    description: The name of the management network.
     default: management
     type: string
   PortName:

network/ports/management_v6.yaml

@@ -6,7 +6,7 @@ description: >
 
 parameters:
   ManagementNetName:
-    description: Name of the management neutron network
+    description: The name of the management network.
     default: management
     type: string
   PortName:

network/ports/net_ip_map.yaml

@@ -14,6 +14,7 @@ parameters:
   ExternalIpSubnet:
     default: ''
     type: string
+    description: IP address/subnet on the external network
   ExternalIpUri:
     default: ''
     type: string
@@ -24,6 +25,7 @@ parameters:
   InternalApiIpSubnet:
     default: ''
     type: string
+    description: IP address/subnet on the internal API network
   InternalApiIpUri:
     default: ''
     type: string
@@ -34,6 +36,7 @@ parameters:
   StorageIpSubnet:
     default: ''
     type: string
+    description: IP address/subnet on the storage network
   StorageIpUri:
     default: ''
     type: string
@@ -44,6 +47,7 @@ parameters:
   StorageMgmtIpSubnet:
     default: ''
     type: string
+    description: IP address/subnet on the storage mgmt network
   StorageMgmtIpUri:
     default: ''
     type: string
@@ -54,6 +58,7 @@ parameters:
   TenantIpSubnet:
     default: ''
     type: string
+    description: IP address/subnet on the tenant network
   TenantIpUri:
     default: ''
     type: string

network/ports/net_vip_map_external.yaml

@@ -27,24 +27,28 @@ parameters:
   ExternalIpUri:
     default: ''
     type: string
+    description: IP address with brackets in case of IPv6
   InternalApiIp:
     default: ''
     type: string
   InternalApiIpUri:
     default: ''
     type: string
+    description: IP address with brackets in case of IPv6
   StorageIp:
     default: ''
     type: string
   StorageIpUri:
     default: ''
     type: string
+    description: IP address with brackets in case of IPv6
   StorageMgmtIp:
     default: ''
     type: string
   StorageMgmtIpUri:
     default: ''
     type: string
+    description: IP address with brackets in case of IPv6
 
 outputs:
   net_ip_map:

network/ports/net_vip_map_external_v6.yaml

@@ -27,24 +27,28 @@ parameters:
   ExternalIpUri:
     default: ''
     type: string
+    description: IP address with brackets in case of IPv6
   InternalApiIp:
     default: ''
     type: string
   InternalApiIpUri:
     default: ''
     type: string
+    description: IP address with brackets in case of IPv6
   StorageIp:
     default: ''
     type: string
   StorageIpUri:
     default: ''
     type: string
+    description: IP address with brackets in case of IPv6
   StorageMgmtIp:
     default: ''
     type: string
   StorageMgmtIpUri:
     default: ''
     type: string
+    description: IP address with brackets in case of IPv6
 
 outputs:
   net_ip_map:

network/ports/noop.yaml

@@ -12,19 +12,21 @@ parameters:
     description: IP address on the control plane
     type: string
   ControlPlaneNetwork:
-    description: Name of the control plane network
+    description: The name of the undercloud Neutron control plane
     default: ctlplane
     type: string
   PortName:
     description: Name of the port
     default: ''
     type: string
-  NetworkName:
+  NetworkName: # Here for compatibility with vip.yaml
-    description: # Here for compatibility with vip.yaml
+    description: Name of the network where the VIP will be created
-    default: ''
+    default: ctlplane
     type: string
   FixedIPs:
-    description: # Here for compatibility with vip.yaml
+    description: >
+        Control the IP allocation for the VIP port. E.g.
+        [{'ip_address':'1.2.3.4'}]
     default: []
     type: json
   ControlPlaneSubnetCidr: # Override this via parameter_defaults

network/ports/storage.yaml

@@ -5,7 +5,7 @@ description: >
 
 parameters:
   StorageNetName:
-    description: Name of the storage neutron network
+    description: The name of the storage network.
     default: storage
     type: string
   PortName:

network/ports/storage_from_pool.yaml

@@ -5,7 +5,7 @@ description: >
 
 parameters:
   StorageNetName:
-    description: Name of the storage network
+    description: The name of the storage network.
     default: storage
     type: string
   PortName:

network/ports/storage_from_pool_v6.yaml

@@ -6,7 +6,7 @@ description: >
 
 parameters:
   StorageNetName:
-    description: Name of the storage network
+    description: The name of the storage network.
     default: storage
     type: string
   PortName:

network/ports/storage_mgmt.yaml

@@ -5,7 +5,7 @@ description: >
 
 parameters:
   StorageMgmtNetName:
-    description: Name of the storage_mgmt API neutron network
+    description: The name of the Storage management network.
     default: storage_mgmt
     type: string
   PortName:

network/ports/storage_mgmt_from_pool.yaml

@@ -5,7 +5,7 @@ description: >
 
 parameters:
   StorageMgmtNetName:
-    description: Name of the storage MGMT network
+    description: The name of the Storage management network.
     default: storage_mgmt
     type: string
   PortName:
@@ -26,7 +26,7 @@ parameters:
     type: number
   StorageMgmtNetCidr:
     default: '172.16.3.0/24'
-    description: Cidr for the storage MGMT network.
+    description: Cidr for the storage management network.
     type: string
 
 outputs:

network/ports/storage_mgmt_from_pool_v6.yaml

@@ -6,7 +6,7 @@ description: >
 
 parameters:
   StorageMgmtNetName:
-    description: Name of the storage MGMT network
+    description: The name of the Storage management network.
     default: storage_mgmt
     type: string
   PortName:
@@ -27,7 +27,7 @@ parameters:
     type: number
   StorageMgmtNetCidr:
     default: 'fd00:fd00:fd00:4000::/64'
-    description: Cidr for the storage MGMT network.
+    description: Cidr for the storage management network.
     type: string
 
 outputs:

network/ports/storage_mgmt_v6.yaml

@@ -5,7 +5,7 @@ description: >
 
 parameters:
   StorageMgmtNetName:
-    description: Name of the storage_mgmt API neutron network
+    description: The name of the Storage management network.
     default: storage_mgmt
     type: string
   PortName:

network/ports/storage_v6.yaml

@@ -5,7 +5,7 @@ description: >
 
 parameters:
   StorageNetName:
-    description: Name of the storage neutron network
+    description: The name of the storage network.
     default: storage
     type: string
   PortName:

network/ports/tenant.yaml

@@ -5,7 +5,7 @@ description: >
 
 parameters:
   TenantNetName:
-    description: Name of the tenant neutron network
+    description: The name of the tenant network.
     default: tenant
     type: string
   PortName:

network/ports/tenant_from_pool.yaml

@@ -5,7 +5,7 @@ description: >
 
 parameters:
   TenantNetName:
-    description: Name of the tenant network
+    description: The name of the tenant network.
     default: tenant
     type: string
   PortName:

network/ports/tenant_from_pool_v6.yaml

@@ -5,7 +5,7 @@ description: >
 
 parameters:
   TenantNetName:
-    description: Name of the tenant network
+    description: The name of the tenant network.
     default: tenant
     type: string
   PortName:

network/ports/tenant_v6.yaml

@@ -5,7 +5,7 @@ description: >
 
 parameters:
   TenantNetName:
-    description: Name of the tenant neutron network
+    description: The name of the tenant network.
     default: tenant
     type: string
   PortName:

network/ports/vip.yaml

@@ -11,7 +11,7 @@ parameters:
     type: string
   NetworkName:
     description: Name of the network where the VIP will be created
-    default: internal_api
+    default: ctlplane
     type: string
   PortName:
     description: Name of the port

network/ports/vip_v6.yaml

@@ -11,7 +11,7 @@ parameters:
     type: string
   NetworkName:
     description: Name of the network where the VIP will be created
-    default: internal_api
+    default: ctlplane
     type: string
   PortName:
     description: Name of the port

overcloud.j2.yaml

@@ -89,7 +89,7 @@ parameters:
     description: Neutron ID or name for ctlplane network.
   NeutronPublicInterface:
     default: nic1
-    description: What interface to bridge onto br-ex for network nodes.
+    description: Which interface to add to the NeutronPhysicalBridge.
     type: string
   PublicVirtualFixedIPs:
     default: []

puppet/services/network/contrail-dpdk.yaml

@@ -31,7 +31,7 @@ parameters:
                  via parameter_defaults in the resource registry.
     type: json
   NeutronMetadataProxySharedSecret:
-    description: Metadata Secret
+    description: Shared secret to prevent spoofing
     type: string
     hidden: true
   ContrailVrouterPhysicalInterface:

puppet/services/network/contrail-tsn.yaml

@@ -31,8 +31,9 @@ parameters:
                  via parameter_defaults in the resource registry.
     type: json
   NeutronMetadataProxySharedSecret:
-    description: Metadata Secret
+    description: Shared secret to prevent spoofing
     type: string
+    hidden: true
   ContrailVrouterPhysicalInterface:
     default: 'eth0'
     description: vRouter physical interface

puppet/services/network/contrail-vrouter.yaml

@@ -31,7 +31,7 @@ parameters:
                  via parameter_defaults in the resource registry.
     type: json
   NeutronMetadataProxySharedSecret:
-    description: Metadata Secret
+    description: Shared secret to prevent spoofing
     type: string
     hidden: true
   ContrailVrouterPhysicalInterface:

puppet/services/neutron-ovs-agent.yaml

@@ -32,8 +32,7 @@ parameters:
     type: json
   NeutronEnableL2Pop:
     type: string
-    description: >
+    description: Enable/disable the L2 population feature in the Neutron agents.
-        Enable/disable the L2 population feature in the Neutron agents.
     default: "False"
   NeutronBridgeMappings:
     description: >
@@ -47,8 +46,7 @@ parameters:
     default: "datacentre:br-ex"
   NeutronTunnelTypes:
     default: 'vxlan'
-    description: |
+    description: The tunnel types for the Neutron tenant network.
-        The tunnel types for the Neutron tenant network.
     type: comma_delimited_list
   NeutronAgentExtensions:
     default: "qos"

puppet/services/ovn-controller.yaml

@@ -45,7 +45,7 @@ parameters:
       bridge on hosts - to a physical name 'datacentre' which can be used
       to create provider networks (and we use this for the default floating
       network) - if changing this either use different post-install network
-      scripts or be sure to keep 'datacentre' as a mapping network name
+      scripts or be sure to keep 'datacentre' as a mapping network name.
     type: comma_delimited_list
     default: "datacentre:br-ex"
 

tools/yaml-validate.py

@@ -50,81 +50,57 @@ PARAMETER_DEFINITION_EXCLUSIONS = {'ManagementNetCidr': ['default'],
                                    'ExternalAllocationPools': ['default'],
                                    'StorageNetCidr': ['default'],
                                    'StorageAllocationPools': ['default'],
-                                   'StorageMgmtNetCidr': ['default',
+                                   'StorageMgmtNetCidr': ['default'],
-                                                          # FIXME
-                                                          'description'],
                                    'StorageMgmtAllocationPools': ['default'],
                                    'TenantNetCidr': ['default'],
                                    'TenantAllocationPools': ['default'],
                                    'InternalApiNetCidr': ['default'],
+                                   'InternalApiAllocationPools': ['default'],
                                    'UpdateIdentifier': ['description'],
                                    'key_name': ['default'],
+                                   # There's one template that defines this
+                                   # differently, and I'm not sure if we can
+                                   # safely change it.
+                                   'EC2MetadataIp': ['default'],
+                                   # Same as EC2MetadataIp
+                                   'ControlPlaneDefaultRoute': ['default'],
                                    # TODO(bnemec): Address these existing
                                    # inconsistencies.
-                                   'NeutronMetadataProxySharedSecret': [
-                                       'description', 'hidden'],
                                    'ServiceNetMap': ['description', 'default'],
-                                   'EC2MetadataIp': ['default'],
                                    'network': ['default'],
                                    'ControlPlaneIP': ['default',
                                                       'description'],
                                    'ControlPlaneIp': ['default',
                                                       'description'],
                                    'NeutronBigswitchLLDPEnabled': ['default'],
-                                   'NeutronEnableL2Pop': ['description'],
                                    'NeutronWorkers': ['description'],
-                                   'TenantIpSubnet': ['description'],
-                                   'ExternalNetName': ['description'],
-                                   'ControlPlaneDefaultRoute': ['default'],
-                                   'StorageMgmtNetName': ['description'],
                                    'ServerMetadata': ['description'],
-                                   'InternalApiIpUri': ['description'],
                                    'UpgradeLevelNovaCompute': ['default'],
-                                   'StorageMgmtIpUri': ['description'],
                                    'server': ['description'],
                                    'servers': ['description'],
-                                   'FixedIPs': ['description'],
-                                   'ExternalIpSubnet': ['description'],
-                                   'NeutronBridgeMappings': ['description'],
                                    'ExtraConfig': ['description'],
-                                   'InternalApiIpSubnet': ['description'],
                                    'DefaultPasswords': ['description',
                                                         'default'],
                                    'BondInterfaceOvsOptions': ['description',
                                                                'default',
                                                                'constraints'],
                                    'KeyName': ['constraints'],
-                                   'TenantNetName': ['description'],
-                                   'StorageIpSubnet': ['description'],
                                    'OVNSouthboundServerPort': ['description'],
                                    'ExternalInterfaceDefaultRoute':
                                        ['description', 'default'],
-                                   'ExternalIpUri': ['description'],
                                    'IPPool': ['description'],
-                                   'ControlPlaneNetwork': ['description'],
                                    'SSLCertificate': ['description',
                                                       'default',
                                                       'hidden'],
                                    'HostCpusList': ['default', 'constraints'],
-                                   'InternalApiAllocationPools': ['default'],
                                    'NodeIndex': ['description'],
                                    'name': ['description', 'default'],
-                                   'StorageNetName': ['description'],
-                                   'ManagementNetName': ['description'],
-                                   'NeutronPublicInterface': ['description'],
-                                   'ManagementInterfaceDefaultRoute':
-                                       ['default'],
                                    'image': ['description', 'default'],
                                    'NeutronBigswitchAgentEnabled': ['default'],
                                    'EndpointMap': ['description', 'default'],
                                    'DockerManilaConfigImage': ['description',
                                                                'default'],
-                                   'NetworkName': ['default', 'description'],
-                                   'StorageIpUri': ['description'],
-                                   'InternalApiNetName': ['description'],
-                                   'NeutronTunnelTypes': ['description'],
                                    'replacement_policy': ['default'],
-                                   'StorageMgmtIpSubnet': ['description'],
                                    'CloudDomain': ['description', 'default'],
                                    'EnableLoadBalancer': ['description'],
                                    'ControllerExtraConfig': ['description'],