Merge "Make many networking parameters consistent"

31 files changed, 50 insertions, 35 deletions

diff --git a/network/ports/ctlplane_vip.yaml b/network/ports/ctlplane_vip.yaml
index bb54ca62..f874c30d 100644
--- a/network/ports/ctlplane_vip.yaml
+++ b/network/ports/ctlplane_vip.yaml
@@ -9,8 +9,8 @@ parameters:
     description: Name of the service to lookup
     default: ''
     type: string
-  NetworkName:
-    description: # Here for compatibility with isolated networks
+  NetworkName: # Here for compatibility with isolated networks
+    description: Name of the network where the VIP will be created
     default: ctlplane
     type: string
   PortName:
diff --git a/network/ports/external.yaml b/network/ports/external.yaml
index a02cc284..72922093 100644
--- a/network/ports/external.yaml
+++ b/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:
diff --git a/network/ports/external_from_pool.yaml b/network/ports/external_from_pool.yaml
index d2610c69..a14aa90b 100644
--- a/network/ports/external_from_pool.yaml
+++ b/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:
diff --git a/network/ports/external_from_pool_v6.yaml b/network/ports/external_from_pool_v6.yaml
index e5fe8d71..2aa51267 100644
--- a/network/ports/external_from_pool_v6.yaml
+++ b/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:
diff --git a/network/ports/external_v6.yaml b/network/ports/external_v6.yaml
index 12d61cce..5a1b5ae3 100644
--- a/network/ports/external_v6.yaml
+++ b/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:
diff --git a/network/ports/internal_api.yaml b/network/ports/internal_api.yaml
index f258080a..e9eb7875 100644
--- a/network/ports/internal_api.yaml
+++ b/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:
diff --git a/network/ports/internal_api_from_pool.yaml b/network/ports/internal_api_from_pool.yaml
index cb87fd54..31c72daf 100644
--- a/network/ports/internal_api_from_pool.yaml
+++ b/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:
diff --git a/network/ports/internal_api_from_pool_v6.yaml b/network/ports/internal_api_from_pool_v6.yaml
index 12a0731b..657310ed 100644
--- a/network/ports/internal_api_from_pool_v6.yaml
+++ b/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:
diff --git a/network/ports/internal_api_v6.yaml b/network/ports/internal_api_v6.yaml
index 46e6e187..6a9e7083 100644
--- a/network/ports/internal_api_v6.yaml
+++ b/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:
diff --git a/network/ports/management.yaml b/network/ports/management.yaml
index dd62033b..417d0612 100644
--- a/network/ports/management.yaml
+++ b/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:
diff --git a/network/ports/management_from_pool.yaml b/network/ports/management_from_pool.yaml
index 188be68c..4815d163 100644
--- a/network/ports/management_from_pool.yaml
+++ b/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:
diff --git a/network/ports/management_from_pool_v6.yaml b/network/ports/management_from_pool_v6.yaml
index b5d44259..2a7d3b1d 100644
--- a/network/ports/management_from_pool_v6.yaml
+++ b/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:
diff --git a/network/ports/management_v6.yaml b/network/ports/management_v6.yaml
index 977502a8..9de06d9c 100644
--- a/network/ports/management_v6.yaml
+++ b/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:
diff --git a/network/ports/net_ip_map.yaml b/network/ports/net_ip_map.yaml
index a6971b0f..ce58e96f 100644
--- a/network/ports/net_ip_map.yaml
+++ b/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
diff --git a/network/ports/net_vip_map_external.yaml b/network/ports/net_vip_map_external.yaml
index 018bf2bb..d0847882 100644
--- a/network/ports/net_vip_map_external.yaml
+++ b/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:
diff --git a/network/ports/net_vip_map_external_v6.yaml b/network/ports/net_vip_map_external_v6.yaml
index aa40cf17..72e60cb2 100644
--- a/network/ports/net_vip_map_external_v6.yaml
+++ b/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:
diff --git a/network/ports/noop.yaml b/network/ports/noop.yaml
index 8030bfc0..9f39c4ff 100644
--- a/network/ports/noop.yaml
+++ b/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:
-    description: # Here for compatibility with vip.yaml
-    default: ''
+  NetworkName: # Here for compatibility with vip.yaml
+    description: Name of the network where the VIP will be created
+    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
diff --git a/network/ports/storage.yaml b/network/ports/storage.yaml
index 5c1aba1a..13e51ccf 100644
--- a/network/ports/storage.yaml
+++ b/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:
diff --git a/network/ports/storage_from_pool.yaml b/network/ports/storage_from_pool.yaml
index ca5993fc..11aa20c7 100644
--- a/network/ports/storage_from_pool.yaml
+++ b/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:
diff --git a/network/ports/storage_from_pool_v6.yaml b/network/ports/storage_from_pool_v6.yaml
index ec7cd2f0..2d2c3055 100644
--- a/network/ports/storage_from_pool_v6.yaml
+++ b/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:
diff --git a/network/ports/storage_mgmt.yaml b/network/ports/storage_mgmt.yaml
index 94b058a2..c06c58ef 100644
--- a/network/ports/storage_mgmt.yaml
+++ b/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:
diff --git a/network/ports/storage_mgmt_from_pool.yaml b/network/ports/storage_mgmt_from_pool.yaml
index 63b2e154..07308a70 100644
--- a/network/ports/storage_mgmt_from_pool.yaml
+++ b/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:
diff --git a/network/ports/storage_mgmt_from_pool_v6.yaml b/network/ports/storage_mgmt_from_pool_v6.yaml
index 6d0b8794..1b30f0ce 100644
--- a/network/ports/storage_mgmt_from_pool_v6.yaml
+++ b/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:
diff --git a/network/ports/storage_mgmt_v6.yaml b/network/ports/storage_mgmt_v6.yaml
index 3d70c690..c10b1393 100644
--- a/network/ports/storage_mgmt_v6.yaml
+++ b/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:
diff --git a/network/ports/storage_v6.yaml b/network/ports/storage_v6.yaml
index 6137d241..c7d47c54 100644
--- a/network/ports/storage_v6.yaml
+++ b/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:
diff --git a/network/ports/tenant.yaml b/network/ports/tenant.yaml
index a56b0f43..6c5eee38 100644
--- a/network/ports/tenant.yaml
+++ b/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:
diff --git a/network/ports/tenant_from_pool.yaml b/network/ports/tenant_from_pool.yaml
index 03ff6d11..94c419df 100644
--- a/network/ports/tenant_from_pool.yaml
+++ b/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:
diff --git a/network/ports/tenant_from_pool_v6.yaml b/network/ports/tenant_from_pool_v6.yaml
index d45faf06..cc2b619a 100644
--- a/network/ports/tenant_from_pool_v6.yaml
+++ b/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:
diff --git a/network/ports/tenant_v6.yaml b/network/ports/tenant_v6.yaml
index d23e91f7..47d52d8a 100644
--- a/network/ports/tenant_v6.yaml
+++ b/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:
diff --git a/network/ports/vip.yaml b/network/ports/vip.yaml
index 70b4482c..f47760c8 100644
--- a/network/ports/vip.yaml
+++ b/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
diff --git a/network/ports/vip_v6.yaml b/network/ports/vip_v6.yaml
index 09f646a6..90525a31 100644
--- a/network/ports/vip_v6.yaml
+++ b/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