Make RoleParameters and key_name descriptions consistent

The key_name default is ignored because the parameter is used in
some mutually exclusive environments where the default doesn't
need to be the same.

Change-Id: I77c1a1159fae38d03b0e59b80ae6bee491d734d7
Partial-Bug: 1700664

diff --git a/common/services.yaml b/common/services.yaml
index 350026c..0bc3462 100644 (file)
--- a/common/services.yaml
+++ b/common/services.yaml
@@ -35,7 +35,7 @@ parameters:
     description: Role name on which the service is applied
     type: string
   RoleParameters:
-    description: Role Specific parameters to be provided to service
+    description: Parameters specific to the role
     default: {}
     type: json
 

diff --git a/deployed-server/deployed-server.yaml b/deployed-server/deployed-server.yaml
index 16deb7d..d116e7c 100644 (file)
--- a/deployed-server/deployed-server.yaml
+++ b/deployed-server/deployed-server.yaml
@@ -9,6 +9,7 @@ parameters:
   key_name:
     type: string
     default: unused
+    description: Name of keypair to assign to servers
   security_groups:
     type: json
     default: []

diff --git a/extraconfig/pre_network/contrail/compute_pre_network.yaml b/extraconfig/pre_network/contrail/compute_pre_network.yaml
index a30330f..69e89f8 100644 (file)
--- a/extraconfig/pre_network/contrail/compute_pre_network.yaml
+++ b/extraconfig/pre_network/contrail/compute_pre_network.yaml
@@ -34,7 +34,7 @@ parameters:
     type: string
   RoleParameters:
     type: json
-    description: Role Specific parameters
+    description: Parameters specific to the role
     default: {}
   ServiceNames:
     type: comma_delimited_list

diff --git a/extraconfig/pre_network/contrail/contrail_dpdk_pre_network.yaml b/extraconfig/pre_network/contrail/contrail_dpdk_pre_network.yaml
index 623eb7e..4b3c673 100644 (file)
--- a/extraconfig/pre_network/contrail/contrail_dpdk_pre_network.yaml
+++ b/extraconfig/pre_network/contrail/contrail_dpdk_pre_network.yaml
@@ -38,7 +38,7 @@ parameters:
     type: string
   RoleParameters:
     type: json
-    description: Role Specific parameters
+    description: Parameters specific to the role
     default: {}
   ServiceNames:
     type: comma_delimited_list

diff --git a/extraconfig/pre_network/host_config_and_reboot.yaml b/extraconfig/pre_network/host_config_and_reboot.yaml
index 5c7cc27..87dbeae 100644 (file)
--- a/extraconfig/pre_network/host_config_and_reboot.yaml
+++ b/extraconfig/pre_network/host_config_and_reboot.yaml
@@ -9,7 +9,7 @@ parameters:
     type: string
   RoleParameters:
     type: json
-    description: Role Specific parameters
+    description: Parameters specific to the role
     default: {}
   ServiceNames:
     type: comma_delimited_list

diff --git a/puppet/blockstorage-role.yaml b/puppet/blockstorage-role.yaml
index 7d58d1d..de7b6b4 100644 (file)
--- a/puppet/blockstorage-role.yaml
+++ b/puppet/blockstorage-role.yaml
@@ -141,7 +141,7 @@ parameters:
       parameter is generated from the parent template.
   RoleParameters:
     type: json
-    description: Role Specific Parameters
+    description: Parameters specific to the role
     default: {}
   DeploymentSwiftDataMap:
     type: json

diff --git a/puppet/cephstorage-role.yaml b/puppet/cephstorage-role.yaml
index 48e5b97..ce44fd6 100644 (file)
--- a/puppet/cephstorage-role.yaml
+++ b/puppet/cephstorage-role.yaml
@@ -147,7 +147,7 @@ parameters:
       parameter is generated from the parent template.
   RoleParameters:
     type: json
-    description: Role Specific Parameters
+    description: Parameters specific to the role
     default: {}
   DeploymentSwiftDataMap:
     type: json

diff --git a/puppet/compute-role.yaml b/puppet/compute-role.yaml
index 3ad6f74..af45793 100644 (file)
--- a/puppet/compute-role.yaml
+++ b/puppet/compute-role.yaml
@@ -159,7 +159,7 @@ parameters:
       parameter is generated from the parent template.
   RoleParameters:
     type: json
-    description: Role Specific Parameters
+    description: Parameters specific to the role
     default: {}
   DeploymentSwiftDataMap:
     type: json

diff --git a/puppet/controller-role.yaml b/puppet/controller-role.yaml
index 933b5e6..38589a4 100644 (file)
--- a/puppet/controller-role.yaml
+++ b/puppet/controller-role.yaml
@@ -173,7 +173,7 @@ parameters:
       parameter is generated from the parent template.
   RoleParameters:
     type: json
-    description: Role Specific Parameters
+    description: Parameters specific to the role
     default: {}
   DeploymentSwiftDataMap:
     type: json

diff --git a/puppet/objectstorage-role.yaml b/puppet/objectstorage-role.yaml
index a03a9da..10e5645 100644 (file)
--- a/puppet/objectstorage-role.yaml
+++ b/puppet/objectstorage-role.yaml
@@ -141,7 +141,7 @@ parameters:
       parameter is generated from the parent template.
   RoleParameters:
     type: json
-    description: Role Specific Parameters
+    description: Parameters specific to the role
     default: {}
   DeploymentSwiftDataMap:
     type: json

diff --git a/puppet/role.role.j2.yaml b/puppet/role.role.j2.yaml
index 18707b9..23d8896 100644 (file)
--- a/puppet/role.role.j2.yaml
+++ b/puppet/role.role.j2.yaml
@@ -180,7 +180,7 @@ parameters:
       parameter is generated from the parent template.
   RoleParameters:
     type: json
-    description: Role Specific Parameters
+    description: Parameters specific to the role
     default: {}
   DeploymentSwiftDataMap:
     type: json

diff --git a/tools/yaml-validate.py b/tools/yaml-validate.py
index 3a2691d..ccaa5bd 100755 (executable)
--- a/tools/yaml-validate.py
+++ b/tools/yaml-validate.py
@@ -58,6 +58,7 @@ PARAMETER_DEFINITION_EXCLUSIONS = {'ManagementNetCidr': ['default'],
                                    'TenantAllocationPools': ['default'],
                                    'InternalApiNetCidr': ['default'],
                                    'UpdateIdentifier': ['description'],
+                                   'key_name': ['default'],
                                    # TODO(bnemec): Address these existing
                                    # inconsistencies.
                                    'NeutronMetadataProxySharedSecret': [
@@ -111,7 +112,6 @@ PARAMETER_DEFINITION_EXCLUSIONS = {'ManagementNetCidr': ['default'],
                                    'StorageNetName': ['description'],
                                    'ManagementNetName': ['description'],
                                    'NeutronPublicInterface': ['description'],
-                                   'RoleParameters': ['description'],
                                    'ManagementInterfaceDefaultRoute':
                                        ['default'],
                                    'image': ['description', 'default'],
@@ -126,7 +126,6 @@ PARAMETER_DEFINITION_EXCLUSIONS = {'ManagementNetCidr': ['default'],
                                    'replacement_policy': ['default'],
                                    'StorageMgmtIpSubnet': ['description'],
                                    'CloudDomain': ['description', 'default'],
-                                   'key_name': ['default', 'description'],
                                    'EnableLoadBalancer': ['description'],
                                    'ControllerExtraConfig': ['description'],
                                    'NovaComputeExtraConfig': ['description'],