Convert role templates to consume roles_data map

Currently we only consume the name with a special-case
for the disable constraints boolean, but it will be more
flexible if we consume the whole roles_data mapping for
each role, so that e.g composable networks and other
per-role customizations can be expressed in these
templates

Partially-Implements: blueprint composable-networks
Depends-On: Id1249b78b3dd87e91d572ffa31b7a541f3cde2c7
Change-Id: I355534ec456479944f66106e957404a660d8f2d2

diff --git a/puppet/role.role.j2.yaml b/puppet/role.role.j2.yaml
index 5aac089..e1a23ab 100644 (file)
--- a/puppet/role.role.j2.yaml
+++ b/puppet/role.role.j2.yaml
@@ -1,18 +1,18 @@
 heat_template_version: pike
-description: 'OpenStack {{role}} node configured by Puppet'
+description: 'OpenStack {{role.name}} node configured by Puppet'
 parameters:
-  Overcloud{{role}}Flavor:
-    description: Flavor for the {{role}} node.
+  Overcloud{{role.name}}Flavor:
+    description: Flavor for the {{role.name}} node.
     default: baremetal
     type: string
-{% if disable_constraints is not defined %}
+{% if role.disable_constraints is not defined %}
     constraints:
       - custom_constraint: nova.flavor
 {% endif %}
-  {{role}}Image:
+  {{role.name}}Image:
     type: string
     default: overcloud-full
-{% if disable_constraints is not defined %}
+{% if role.disable_constraints is not defined %}
     constraints:
       - custom_constraint: glance.image
 {% endif %}
@@ -24,7 +24,7 @@ parameters:
     description: Name of an existing Nova key pair to enable SSH access to the instances
     type: string
     default: default
-{% if disable_constraints is not defined %}
+{% if role.disable_constraints is not defined %}
     constraints:
       - custom_constraint: nova.keypair
 {% endif %}
@@ -63,14 +63,14 @@ parameters:
     default: {}
     description: |
       Additional hiera configuration to inject into the cluster. Note
-      that {{role}}ExtraConfig takes precedence over ExtraConfig.
+      that {{role.name}}ExtraConfig takes precedence over ExtraConfig.
     type: json
-  {{role}}ExtraConfig:
+  {{role.name}}ExtraConfig:
     default: {}
     description: |
       Role specific additional hiera configuration to inject into the cluster.
     type: json
-  {{role}}IPs:
+  {{role.name}}IPs:
     default: {}
     type: json
   NetworkDeploymentActions:
@@ -91,7 +91,7 @@ parameters:
     description: >
       The DNS domain used for the hosts. This must match the
       overcloud_domain_name configured on the undercloud.
-  {{role}}ServerMetadata:
+  {{role.name}}ServerMetadata:
     default: {}
     description: >
       Extra properties or metadata passed to Nova for the created nodes in
@@ -106,7 +106,7 @@ parameters:
       the overcloud. It's accessible via the Nova metadata API. This applies to
       all roles and is merged with a role-specific metadata parameter.
     type: json
-  {{role}}SchedulerHints:
+  {{role.name}}SchedulerHints:
     type: json
     description: Optional scheduler hints to pass to nova
     default: {}
@@ -203,16 +203,16 @@ conditions:
       - ""
 
 resources:
-  {{role}}:
-    type: OS::TripleO::{{role}}Server
+  {{role.name}}:
+    type: OS::TripleO::{{role.name}}Server
     metadata:
       os-collect-config:
         command: {get_param: ConfigCommand}
         splay: {get_param: ConfigCollectSplay}
     properties:
-      image: {get_param: {{role}}Image}
+      image: {get_param: {{role.name}}Image}
       image_update_policy: {get_param: ImageUpdatePolicy}
-      flavor: {get_param: Overcloud{{role}}Flavor}
+      flavor: {get_param: Overcloud{{role.name}}Flavor}
       key_name: {get_param: KeyName}
       networks:
         - network: ctlplane
@@ -226,9 +226,9 @@ resources:
       metadata:
         map_merge:
           - {get_param: ServerMetadata}
-          - {get_param: {{role}}ServerMetadata}
+          - {get_param: {{role.name}}ServerMetadata}
           - {get_param: ServiceMetadataSettings}
-      scheduler_hints: {get_param: {{role}}SchedulerHints}
+      scheduler_hints: {get_param: {{role.name}}SchedulerHints}
       deployment_swift_data:
         if:
           - deployment_swift_data_map_unset
@@ -261,54 +261,54 @@ resources:
   # For optional operator role-specific userdata
   # Should return a OS::Heat::MultipartMime reference via OS::stack_id
   RoleUserData:
-    type: OS::TripleO::{{role}}::NodeUserData
+    type: OS::TripleO::{{role.name}}::NodeUserData
 
   ExternalPort:
-    type: OS::TripleO::{{role}}::Ports::ExternalPort
+    type: OS::TripleO::{{role.name}}::Ports::ExternalPort
     properties:
-      ControlPlaneIP: {get_attr: [{{role}}, networks, ctlplane, 0]}
-      IPPool: {get_param: {{role}}IPs}
+      ControlPlaneIP: {get_attr: [{{role.name}}, networks, ctlplane, 0]}
+      IPPool: {get_param: {{role.name}}IPs}
       NodeIndex: {get_param: NodeIndex}
 
   InternalApiPort:
-    type: OS::TripleO::{{role}}::Ports::InternalApiPort
+    type: OS::TripleO::{{role.name}}::Ports::InternalApiPort
     properties:
-      ControlPlaneIP: {get_attr: [{{role}}, networks, ctlplane, 0]}
-      IPPool: {get_param: {{role}}IPs}
+      ControlPlaneIP: {get_attr: [{{role.name}}, networks, ctlplane, 0]}
+      IPPool: {get_param: {{role.name}}IPs}
       NodeIndex: {get_param: NodeIndex}
 
   StoragePort:
-    type: OS::TripleO::{{role}}::Ports::StoragePort
+    type: OS::TripleO::{{role.name}}::Ports::StoragePort
     properties:
-      ControlPlaneIP: {get_attr: [{{role}}, networks, ctlplane, 0]}
-      IPPool: {get_param: {{role}}IPs}
+      ControlPlaneIP: {get_attr: [{{role.name}}, networks, ctlplane, 0]}
+      IPPool: {get_param: {{role.name}}IPs}
       NodeIndex: {get_param: NodeIndex}
 
   StorageMgmtPort:
-    type: OS::TripleO::{{role}}::Ports::StorageMgmtPort
+    type: OS::TripleO::{{role.name}}::Ports::StorageMgmtPort
     properties:
-      ControlPlaneIP: {get_attr: [{{role}}, networks, ctlplane, 0]}
-      IPPool: {get_param: {{role}}IPs}
+      ControlPlaneIP: {get_attr: [{{role.name}}, networks, ctlplane, 0]}
+      IPPool: {get_param: {{role.name}}IPs}
       NodeIndex: {get_param: NodeIndex}
 
   TenantPort:
-    type: OS::TripleO::{{role}}::Ports::TenantPort
+    type: OS::TripleO::{{role.name}}::Ports::TenantPort
     properties:
-      ControlPlaneIP: {get_attr: [{{role}}, networks, ctlplane, 0]}
-      IPPool: {get_param: {{role}}IPs}
+      ControlPlaneIP: {get_attr: [{{role.name}}, networks, ctlplane, 0]}
+      IPPool: {get_param: {{role.name}}IPs}
       NodeIndex: {get_param: NodeIndex}
 
   ManagementPort:
-    type: OS::TripleO::{{role}}::Ports::ManagementPort
+    type: OS::TripleO::{{role.name}}::Ports::ManagementPort
     properties:
-      ControlPlaneIP: {get_attr: [{{role}}, networks, ctlplane, 0]}
-      IPPool: {get_param: {{role}}IPs}
+      ControlPlaneIP: {get_attr: [{{role.name}}, networks, ctlplane, 0]}
+      IPPool: {get_param: {{role.name}}IPs}
       NodeIndex: {get_param: NodeIndex}
 
   NetworkConfig:
-    type: OS::TripleO::{{role}}::Net::SoftwareConfig
+    type: OS::TripleO::{{role.name}}::Net::SoftwareConfig
     properties:
-      ControlPlaneIp: {get_attr: [{{role}}, networks, ctlplane, 0]}
+      ControlPlaneIp: {get_attr: [{{role.name}}, networks, ctlplane, 0]}
       ExternalIpSubnet: {get_attr: [ExternalPort, ip_subnet]}
       InternalApiIpSubnet: {get_attr: [InternalApiPort, ip_subnet]}
       StorageIpSubnet: {get_attr: [StoragePort, ip_subnet]}
@@ -319,7 +319,7 @@ resources:
   NetIpMap:
     type: OS::TripleO::Network::Ports::NetIpMap
     properties:
-      ControlPlaneIp: {get_attr: [{{role}}, networks, ctlplane, 0]}
+      ControlPlaneIp: {get_attr: [{{role.name}}, networks, ctlplane, 0]}
       ExternalIp: {get_attr: [ExternalPort, ip_address]}
       ExternalIpSubnet: {get_attr: [ExternalPort, ip_subnet]}
       ExternalIpUri: {get_attr: [ExternalPort, ip_address_uri]}
@@ -348,91 +348,91 @@ resources:
           fqdn:
             list_join:
             - '.'
-            - - {get_attr: [{{role}}, name]}
+            - - {get_attr: [{{role.name}}, name]}
               - external
               - {get_param: CloudDomain}
           short:
             list_join:
             - '.'
-            - - {get_attr: [{{role}}, name]}
+            - - {get_attr: [{{role.name}}, name]}
               - external
         internal_api:
           fqdn:
             list_join:
             - '.'
-            - - {get_attr: [{{role}}, name]}
+            - - {get_attr: [{{role.name}}, name]}
               - internalapi
               - {get_param: CloudDomain}
           short:
             list_join:
             - '.'
-            - - {get_attr: [{{role}}, name]}
+            - - {get_attr: [{{role.name}}, name]}
               - internalapi
         storage:
           fqdn:
             list_join:
             - '.'
-            - - {get_attr: [{{role}}, name]}
+            - - {get_attr: [{{role.name}}, name]}
               - storage
               - {get_param: CloudDomain}
           short:
             list_join:
             - '.'
-            - - {get_attr: [{{role}}, name]}
+            - - {get_attr: [{{role.name}}, name]}
               - storage
         storage_mgmt:
           fqdn:
             list_join:
             - '.'
-            - - {get_attr: [{{role}}, name]}
+            - - {get_attr: [{{role.name}}, name]}
               - storagemgmt
               - {get_param: CloudDomain}
           short:
             list_join:
             - '.'
-            - - {get_attr: [{{role}}, name]}
+            - - {get_attr: [{{role.name}}, name]}
               - storagemgmt
         tenant:
           fqdn:
             list_join:
             - '.'
-            - - {get_attr: [{{role}}, name]}
+            - - {get_attr: [{{role.name}}, name]}
               - tenant
               - {get_param: CloudDomain}
           short:
             list_join:
             - '.'
-            - - {get_attr: [{{role}}, name]}
+            - - {get_attr: [{{role.name}}, name]}
               - tenant
         management:
           fqdn:
             list_join:
             - '.'
-            - - {get_attr: [{{role}}, name]}
+            - - {get_attr: [{{role.name}}, name]}
               - management
               - {get_param: CloudDomain}
           short:
             list_join:
             - '.'
-            - - {get_attr: [{{role}}, name]}
+            - - {get_attr: [{{role.name}}, name]}
               - management
         ctlplane:
           fqdn:
             list_join:
             - '.'
-            - - {get_attr: [{{role}}, name]}
+            - - {get_attr: [{{role.name}}, name]}
               - ctlplane
               - {get_param: CloudDomain}
           short:
             list_join:
             - '.'
-            - - {get_attr: [{{role}}, name]}
+            - - {get_attr: [{{role.name}}, name]}
               - ctlplane
 
   PreNetworkConfig:
-    type: OS::TripleO::{{role}}::PreNetworkConfig
+    type: OS::TripleO::{{role.name}}::PreNetworkConfig
     properties:
-      server: {get_resource: {{role}}}
+      server: {get_resource: {{role.name}}}
       RoleParameters: {get_param: RoleParameters}
       ServiceNames: {get_param: ServiceNames}
 
@@ -442,7 +442,7 @@ resources:
     properties:
       name: NetworkDeployment
       config: {get_resource: NetworkConfig}
-      server: {get_resource: {{role}}}
+      server: {get_resource: {{role.name}}}
       actions: {get_param: NetworkDeploymentActions}
       input_values:
         bridge_name: {get_param: NeutronPhysicalBridge}
@@ -453,7 +453,7 @@ resources:
           - {get_param: NetworkDeploymentActions}
           - []
 
-  {{role}}UpgradeInitConfig:
+  {{role.name}}UpgradeInitConfig:
     type: OS::Heat::SoftwareConfig
     properties:
       group: script
@@ -467,26 +467,26 @@ resources:
 
   # Note we may be able to make this conditional on UpgradeInitCommandNotEmpty
   # but https://bugs.launchpad.net/heat/+bug/1649900 needs fixing first
-  {{role}}UpgradeInitDeployment:
+  {{role.name}}UpgradeInitDeployment:
     type: OS::Heat::SoftwareDeployment
     depends_on: NetworkDeployment
     properties:
-      name: {{role}}UpgradeInitDeployment
-      server: {get_resource: {{role}}}
-      config: {get_resource: {{role}}UpgradeInitConfig}
+      name: {{role.name}}UpgradeInitDeployment
+      server: {get_resource: {{role.name}}}
+      config: {get_resource: {{role.name}}UpgradeInitConfig}
       actions:
         if:
           - server_not_blacklisted
           - ['CREATE', 'UPDATE']
           - []
 
-  {{role}}Deployment:
+  {{role.name}}Deployment:
     type: OS::Heat::StructuredDeployment
-    depends_on: {{role}}UpgradeInitDeployment
+    depends_on: {{role.name}}UpgradeInitDeployment
     properties:
-      name: {{role}}Deployment
-      config: {get_resource: {{role}}Config}
-      server: {get_resource: {{role}}}
+      name: {{role.name}}Deployment
+      config: {get_resource: {{role.name}}Config}
+      server: {get_resource: {{role.name}}}
       input_values:
         enable_package_upgrade: {get_attr: [UpdateDeployment, update_managed_packages]}
       actions:
@@ -495,7 +495,7 @@ resources:
           - ['CREATE', 'UPDATE']
           - []
 
-  {{role}}Config:
+  {{role.name}}Config:
     type: OS::Heat::StructuredConfig
     properties:
       group: hiera
@@ -504,11 +504,11 @@ resources:
           - '"%{::uuid}"'
           - heat_config_%{::deploy_config_name}
           - config_step
-          - {{role.lower()}}_extraconfig
+          - {{role.name.lower()}}_extraconfig
           - extraconfig
           - service_names
           - service_configs
-          - {{role.lower()}}
+          - {{role.name.lower()}}
           - bootstrap_node # provided by allNodesConfig
           - all_nodes # provided by allNodesConfig
           - vip_data # provided by allNodesConfig
@@ -522,9 +522,9 @@ resources:
             map_replace:
               - {get_param: ServiceConfigSettings}
               - values: {get_attr: [NetIpMap, net_ip_map]}
-          {{role.lower()}}_extraconfig: {get_param: {{role}}ExtraConfig}
+          {{role.name.lower()}}_extraconfig: {get_param: {{role.name}}ExtraConfig}
           extraconfig: {get_param: ExtraConfig}
-          {{role.lower()}}:
+          {{role.name.lower()}}:
             tripleo::packages::enable_upgrade: {get_input: enable_package_upgrade}
             tripleo::profile::base::logging::fluentd::fluentd_sources: {get_param: LoggingSources}
             tripleo::profile::base::logging::fluentd::fluentd_groups: {get_param: LoggingGroups}
@@ -538,25 +538,25 @@ resources:
 
   # Resource for site-specific injection of root certificate
   NodeTLSCAData:
-    depends_on: {{role}}Deployment
+    depends_on: {{role.name}}Deployment
     type: OS::TripleO::NodeTLSCAData
     properties:
-      server: {get_resource: {{role}}}
+      server: {get_resource: {{role.name}}}
 
   # Hook for site-specific additional pre-deployment config, e.g extra hieradata
-  {{role}}ExtraConfigPre:
-    depends_on: {{role}}Deployment
-    type: OS::TripleO::{{role}}ExtraConfigPre
+  {{role.name}}ExtraConfigPre:
+    depends_on: {{role.name}}Deployment
+    type: OS::TripleO::{{role.name}}ExtraConfigPre
     properties:
-        server: {get_resource: {{role}}}
+        server: {get_resource: {{role.name}}}
 
   # Hook for site-specific additional pre-deployment config,
   # applying to all nodes, e.g node registration/unregistration
   NodeExtraConfig:
-    depends_on: [{{role}}ExtraConfigPre, NodeTLSCAData]
+    depends_on: [{{role.name}}ExtraConfigPre, NodeTLSCAData]
     type: OS::TripleO::NodeExtraConfig
     properties:
-        server: {get_resource: {{role}}}
+        server: {get_resource: {{role.name}}}
 
   UpdateConfig:
     type: OS::TripleO::Tasks::PackageUpdate
@@ -567,7 +567,7 @@ resources:
     properties:
       name: UpdateDeployment
       config: {get_resource: UpdateConfig}
-      server: {get_resource: {{role}}}
+      server: {get_resource: {{role.name}}}
       input_values:
         update_identifier:
           get_param: UpdateIdentifier
@@ -579,17 +579,17 @@ resources:
 
   SshHostPubKey:
     type: OS::TripleO::Ssh::HostPubKey
-    depends_on: {{role}}Deployment
+    depends_on: {{role.name}}Deployment
     properties:
-        server: {get_resource: {{role}}}
+        server: {get_resource: {{role.name}}}
 
 outputs:
   ip_address:
     description: IP address of the server in the ctlplane network
-    value: {get_attr: [{{role}}, networks, ctlplane, 0]}
+    value: {get_attr: [{{role.name}}, networks, ctlplane, 0]}
   hostname:
     description: Hostname of the server
-    value: {get_attr: [{{role}}, name]}
+    value: {get_attr: [{{role.name}}, name]}
   hostname_map:
     description: Mapping of network names to hostnames
     value:
@@ -613,9 +613,9 @@ outputs:
           MANAGEMENTIP MANAGEMENTHOST.DOMAIN MANAGEMENTHOST
           CTLPLANEIP CTLPLANEHOST.DOMAIN CTLPLANEHOST
         params:
-          PRIMARYIP: {get_attr: [NetIpMap, net_ip_map, {get_param: [ServiceNetMap, {{role}}HostnameResolveNetwork]}]}
+          PRIMARYIP: {get_attr: [NetIpMap, net_ip_map, {get_param: [ServiceNetMap, {{role.name}}HostnameResolveNetwork]}]}
           DOMAIN: {get_param: CloudDomain}
-          PRIMARYHOST: {get_attr: [{{role}}, name]}
+          PRIMARYHOST: {get_attr: [{{role.name}}, name]}
           EXTERNALIP: {get_attr: [ExternalPort, ip_address]}
           EXTERNALHOST: {get_attr: [NetHostMap, value, external, short]}
           INTERNAL_APIIP: {get_attr: [InternalApiPort, ip_address]}
@@ -628,7 +628,7 @@ outputs:
           TENANTHOST: {get_attr: [NetHostMap, value, tenant, short]}
           MANAGEMENTIP: {get_attr: [ManagementPort, ip_address]}
           MANAGEMENTHOST: {get_attr: [NetHostMap, value, management, short]}
-          CTLPLANEIP: {get_attr: [{{role}}, networks, ctlplane, 0]}
+          CTLPLANEIP: {get_attr: [{{role.name}}, networks, ctlplane, 0]}
           CTLPLANEHOST: {get_attr: [NetHostMap, value, ctlplane, short]}
   known_hosts_entry:
     description: Entry for ssh known hosts
@@ -643,9 +643,9 @@ TENANTIP,TENANTHOST.DOMAIN,TENANTHOST,\
 MANAGEMENTIP,MANAGEMENTHOST.DOMAIN,MANAGEMENTHOST,\
 CTLPLANEIP,CTLPLANEHOST.DOMAIN,CTLPLANEHOST HOSTSSHPUBKEY"
         params:
-          PRIMARYIP: {get_attr: [NetIpMap, net_ip_map, {get_param: [ServiceNetMap, {{role}}HostnameResolveNetwork]}]}
+          PRIMARYIP: {get_attr: [NetIpMap, net_ip_map, {get_param: [ServiceNetMap, {{role.name}}HostnameResolveNetwork]}]}
           DOMAIN: {get_param: CloudDomain}
-          PRIMARYHOST: {get_attr: [{{role}}, name]}
+          PRIMARYHOST: {get_attr: [{{role.name}}, name]}
           EXTERNALIP: {get_attr: [ExternalPort, ip_address]}
           EXTERNALHOST: {get_attr: [NetHostMap, value, external, short]}
           INTERNAL_APIIP: {get_attr: [InternalApiPort, ip_address]}
@@ -658,13 +658,13 @@ CTLPLANEIP,CTLPLANEHOST.DOMAIN,CTLPLANEHOST HOSTSSHPUBKEY"
           TENANTHOST: {get_attr: [NetHostMap, value, tenant, short]}
           MANAGEMENTIP: {get_attr: [ManagementPort, ip_address]}
           MANAGEMENTHOST: {get_attr: [NetHostMap, value, management, short]}
-          CTLPLANEIP: {get_attr: [{{role}}, networks, ctlplane, 0]}
+          CTLPLANEIP: {get_attr: [{{role.name}}, networks, ctlplane, 0]}
           CTLPLANEHOST: {get_attr: [NetHostMap, value, ctlplane, short]}
           HOSTSSHPUBKEY: {get_attr: [SshHostPubKey, ecdsa]}
   nova_server_resource:
-    description: Heat resource handle for {{role}} server
+    description: Heat resource handle for {{role.name}} server
     value:
-      {get_resource: {{role}}}
+      {get_resource: {{role.name}}}
     condition: server_not_blacklisted
   external_ip_address:
     description: IP address of the server in the external network
@@ -686,4 +686,4 @@ CTLPLANEIP,CTLPLANEHOST.DOMAIN,CTLPLANEHOST HOSTSSHPUBKEY"
     value: {get_attr: [ManagementPort, ip_address]}
   os_collect_config:
     description: The os-collect-config configuration associated with this server resource
-    value: {get_attr: [{{role}}, os_collect_config]}
+    value: {get_attr: [{{role.name}}, os_collect_config]}

diff --git a/tools/process-templates.py b/tools/process-templates.py
index 69ed96a..c7d5ed9 100755 (executable)
--- a/tools/process-templates.py
+++ b/tools/process-templates.py
@@ -138,19 +138,31 @@ def process_templates(template_path, role_data_path, output_dir,
                         print("jinja2 rendering roles %s" % ","
                               .join(role_names))
                         for role in role_names:
-                            j2_data = {'role': role}
-                            # (dprince) For the undercloud installer we don't
-                            # want to have heat check nova/glance API's
-                            if r_map[role].get('disable_constraints', False):
-                                j2_data['disable_constraints'] = True
+                            j2_data = {'role': r_map[role]}
                             out_f = "-".join(
                                 [role.lower(),
                                  os.path.basename(f).replace('.role.j2.yaml',
                                                              '.yaml')])
                             out_f_path = os.path.join(out_dir, out_f)
                             if not (out_f_path in excl_templates):
-                                _j2_render_to_file(template_data, j2_data,
-                                                   out_f_path, overwrite)
+                                if '{{role.name}}' in template_data:
+                                    j2_data = {'role': r_map[role]}
+                                    _j2_render_to_file(template_data, j2_data,
+                                                       out_f_path, overwrite)
+                                else:
+                                    # Backwards compatibility with templates
+                                    # that specify {{role}} vs {{role.name}}
+                                    j2_data = {'role': role}
+                                    # (dprince) For the undercloud installer we
+                                    # don'twant to have heat check nova/glance
+                                    # API's
+                                    if r_map[role].get('disable_constraints',
+                                                       False):
+                                        j2_data['disable_constraints'] = True
+                                    _j2_render_to_file(
+                                        template_data,j2_data,
+                                        out_f_path, overwrite)
+
                             else:
                                 print('skipping rendering of %s' % out_f_path)
                 elif f.endswith('.j2.yaml'):