common/deploy-steps.j2

   1 # certain initialization steps (run in a container) will occur
   2 # on the role marked as primary controller or the first role listed
   3 {%- set primary_role = [roles[0]] -%}
   4 {%- for role in roles -%}
   5   {%- if 'primary' in role.tags and 'controller' in role.tags -%}
   6     {%- set _ = primary_role.pop() -%}
   7     {%- set _ = primary_role.append(role) -%}
   8   {%- endif -%}
   9 {%- endfor -%}
  10 {%- set primary_role_name = primary_role[0].name -%}
  11 # primary role is: {{primary_role_name}}
  12 {% set deploy_steps_max = 6 -%}
  13 {% set update_steps_max = 6 -%}
  14 {% set upgrade_steps_max = 6 -%}
  15
  16 heat_template_version: pike
  17
  18 description: >
  19   Post-deploy configuration steps via puppet for all roles,
  20   as defined in ../roles_data.yaml
  21
  22 parameters:
  23   servers:
  24     type: json
  25     description: Mapping of Role name e.g Controller to a list of servers
  26   stack_name:
  27     type: string
  28     description: Name of the topmost stack
  29   role_data:
  30     type: json
  31     description: Mapping of Role name e.g Controller to the per-role data
  32   DeployIdentifier:
  33     default: ''
  34     type: string
  35     description: >
  36       Setting this to a unique value will re-run any deployment tasks which
  37       perform configuration on a Heat stack-update.
  38   EndpointMap:
  39     default: {}
  40     description: Mapping of service endpoint -> protocol. Typically set
  41                  via parameter_defaults in the resource registry.
  42     type: json
  43   DockerPuppetDebug:
  44     type: string
  45     default: ''
  46     description: Set to True to enable debug logging with docker-puppet.py
  47   DockerPuppetProcessCount:
  48     type: number
  49     default: 3
  50     description: Number of concurrent processes to use when running docker-puppet to generate config files.
  51   ctlplane_service_ips:
  52     type: json
  53
  54 conditions:
  55 {% for step in range(1, deploy_steps_max) %}
  56   WorkflowTasks_Step{{step}}_Enabled:
  57     or:
  58     {%- for role in roles %}
  59       - not:
  60           equals:
  61             - get_param: [role_data, {{role.name}}, service_workflow_tasks, step{{step}}]
  62             - ''
  63       - False
  64     {%- endfor %}
  65 {% endfor %}
  66
  67 resources:
  68
  69   RoleConfig:
  70     type: OS::Heat::SoftwareConfig
  71     properties:
  72       group: ansible
  73       options:
  74         modulepath: /usr/share/ansible-modules
  75       inputs:
  76         - name: step
  77         - name: role_name
  78         - name: update_identifier
  79         - name: bootstrap_server_id
  80         - name: docker_puppet_debug
  81         - name: docker_puppet_process_count
  82       config:
  83         str_replace:
  84           template: |
  85             - hosts: localhost
  86               connection: local
  87               tasks:
  88               _TASKS
  89           params:
  90             _TASKS: {get_file: deploy-steps-tasks.yaml}
  91
  92 {%- for step in range(1, deploy_steps_max) %}
  93 # BEGIN service_workflow_tasks handling
  94   WorkflowTasks_Step{{step}}:
  95     type: OS::Mistral::Workflow
  96     condition: WorkflowTasks_Step{{step}}_Enabled
  97     depends_on:
  98     {%- if step == 1 %}
  99     {%- for dep in roles %}
 100       - {{dep.name}}PreConfig
 101       - {{dep.name}}ArtifactsDeploy
 102     {%- endfor %}
 103     {%- else %}
 104     {%- for dep in roles %}
 105       - {{dep.name}}Deployment_Step{{step -1}}
 106     {%- endfor %}
 107     {%- endif %}
 108     properties:
 109       name: {list_join: [".", ["tripleo", {get_param: stack_name}, "workflowtasks", "step{{step}}"]]}
 110       type: direct
 111       tasks:
 112         yaql:
 113           expression: $.data.where($ != '').select($.get('step{{step}}')).where($ != null).flatten()
 114           data:
 115           {%- for role in roles %}
 116             - get_param: [role_data, {{role.name}}, service_workflow_tasks]
 117           {%- endfor %}
 118
 119   WorkflowTasks_Step{{step}}_Execution:
 120     type: OS::Mistral::ExternalResource
 121     condition: WorkflowTasks_Step{{step}}_Enabled
 122     depends_on: WorkflowTasks_Step{{step}}
 123     properties:
 124       actions:
 125         CREATE:
 126           workflow: { get_resource: WorkflowTasks_Step{{step}} }
 127           params:
 128             env:
 129               service_ips: { get_param: ctlplane_service_ips }
 130               role_merged_configs:
 131                 {%- for r in roles %}
 132                 {{r.name}}: {get_param: [role_data, {{r.name}}, merged_config_settings]}
 133                 {%- endfor %}
 134             evaluate_env: false
 135         UPDATE:
 136           workflow: { get_resource: WorkflowTasks_Step{{step}} }
 137           params:
 138             env:
 139               service_ips: { get_param: ctlplane_service_ips }
 140               role_merged_configs:
 141                 {%- for r in roles %}
 142                 {{r.name}}: {get_param: [role_data, {{r.name}}, merged_config_settings]}
 143                 {%- endfor %}
 144             evaluate_env: false
 145       always_update: true
 146 # END service_workflow_tasks handling
 147 {% endfor %}
 148
 149 {% for role in roles %}
 150   # Post deployment steps for all roles
 151   # A single config is re-applied with an incrementing step number
 152   # {{role.name}} Role steps
 153   {{role.name}}ArtifactsConfig:
 154     type: ../puppet/deploy-artifacts.yaml
 155
 156   {{role.name}}ArtifactsDeploy:
 157     type: OS::Heat::StructuredDeploymentGroup
 158     properties:
 159       servers:  {get_param: [servers, {{role.name}}]}
 160       config: {get_resource: {{role.name}}ArtifactsConfig}
 161
 162   {{role.name}}HostPrepConfig:
 163     type: OS::Heat::SoftwareConfig
 164     properties:
 165       group: ansible
 166       options:
 167         modulepath: /usr/share/ansible-modules
 168       config:
 169         str_replace:
 170           template: _PLAYBOOK
 171           params:
 172             _PLAYBOOK:
 173               - hosts: localhost
 174                 connection: local
 175                 vars:
 176                   puppet_config: {get_param: [role_data, {{role.name}}, puppet_config]}
 177                   docker_puppet_script: {get_file: ../docker/docker-puppet.py}
 178                   docker_puppet_tasks: {get_param: [role_data, {{role.name}}, docker_puppet_tasks]}
 179                   docker_startup_configs: {get_param: [role_data, {{role.name}}, docker_config]}
 180                   kolla_config: {get_param: [role_data, {{role.name}}, kolla_config]}
 181                   bootstrap_server_id: {get_param: [servers, {{primary_role_name}}, '0']}
 182                   puppet_step_config: {get_param: [role_data, {{role.name}}, step_config]}
 183                 tasks:
 184                   # Join host_prep_tasks with the other per-host configuration
 185                   yaql:
 186                     expression: $.data.host_prep_tasks + $.data.template_tasks
 187                     data:
 188                       host_prep_tasks: {get_param: [role_data, {{role.name}}, host_prep_tasks]}
 189                       template_tasks:
 190 {%- raw %}
 191                         # Write the manifest for baremetal puppet configuration
 192                         - name: Create /var/lib/tripleo-config directory
 193                           file: path=/var/lib/tripleo-config state=directory
 194                         - name: Write the puppet step_config manifest
 195                           copy: content="{{puppet_step_config}}" dest=/var/lib/tripleo-config/puppet_step_config.pp force=yes
 196                         # this creates a JSON config file for our docker-puppet.py script
 197                         - name: Create /var/lib/docker-puppet
 198                           file: path=/var/lib/docker-puppet state=directory
 199                         - name: Write docker-puppet-tasks json files
 200                           copy: content="{{puppet_config | to_json}}" dest=/var/lib/docker-puppet/docker-puppet.json force=yes
 201                         # FIXME: can we move docker-puppet somewhere so it's installed via a package?
 202                         - name: Write docker-puppet.py
 203                           copy: content="{{docker_puppet_script}}" dest=/var/lib/docker-puppet/docker-puppet.py force=yes
 204                         # Here we are dumping all the docker container startup configuration data
 205                         # so that we can have access to how they are started outside of heat
 206                         # and docker-cmd.  This lets us create command line tools to test containers.
 207                         # FIXME do we need the docker-container-startup-configs.json or is the new per-step
 208                         # data consumed by paunch enough?
 209                         - name: Write docker-container-startup-configs
 210                           copy: content="{{docker_startup_configs | to_json}}" dest=/var/lib/docker-container-startup-configs.json force=yes
 211                         - name: Write per-step docker-container-startup-configs
 212                           copy: content="{{item.value|to_json}}" dest="/var/lib/tripleo-config/docker-container-startup-config-{{item.key}}.json" force=yes
 213                           with_dict: "{{docker_startup_configs}}"
 214                         - name: Create /var/lib/kolla/config_files directory
 215                           file: path=/var/lib/kolla/config_files state=directory
 216                         - name: Write kolla config json files
 217                           copy: content="{{item.value|to_json}}" dest="{{item.key}}" force=yes
 218                           with_dict: "{{kolla_config}}"
 219                         ########################################################
 220                         # Bootstrap tasks, only performed on bootstrap_server_id
 221                         ########################################################
 222                         - name: Clean /var/lib/docker-puppet/docker-puppet-tasks*.json files
 223                           file:
 224                             path: "{{item}}"
 225                             state: absent
 226                           with_fileglob:
 227                             - /var/lib/docker-puppet/docker-puppet-tasks*.json
 228                           when: deploy_server_id == bootstrap_server_id
 229                         - name: Write docker-puppet-tasks json files
 230                           copy: content="{{item.value|to_json}}" dest=/var/lib/docker-puppet/docker-puppet-tasks{{item.key.replace("step_", "")}}.json force=yes
 231                           with_dict: "{{docker_puppet_tasks}}"
 232                           when: deploy_server_id == bootstrap_server_id
 233 {%- endraw %}
 234
 235   {{role.name}}HostPrepDeployment:
 236     type: OS::Heat::SoftwareDeploymentGroup
 237     properties:
 238       servers: {get_param: [servers, {{role.name}}]}
 239       config: {get_resource: {{role.name}}HostPrepConfig}
 240
 241   # BEGIN CONFIG STEPS
 242
 243   {{role.name}}PreConfig:
 244     type: OS::TripleO::Tasks::{{role.name}}PreConfig
 245     depends_on: {{role.name}}HostPrepDeployment
 246     properties:
 247       servers: {get_param: [servers, {{role.name}}]}
 248       input_values:
 249         update_identifier: {get_param: DeployIdentifier}
 250
 251   {% for step in range(1, deploy_steps_max) %}
 252   {{role.name}}Deployment_Step{{step}}:
 253     type: OS::TripleO::DeploymentSteps
 254     depends_on:
 255       - WorkflowTasks_Step{{step}}_Execution
 256     # TODO(gfidente): the following if/else condition
 257     # replicates what is already defined for the
 258     # WorkflowTasks_StepX resource and can be remove
 259     # if https://bugs.launchpad.net/heat/+bug/1700569
 260     # is fixed.
 261     {%- if step == 1 %}
 262     {%- for dep in roles %}
 263       - {{dep.name}}PreConfig
 264       - {{dep.name}}ArtifactsDeploy
 265     {%- endfor %}
 266     {%- else %}
 267     {%- for dep in roles %}
 268       - {{dep.name}}Deployment_Step{{step -1}}
 269     {%- endfor %}
 270     {%- endif %}
 271     properties:
 272       name: {{role.name}}Deployment_Step{{step}}
 273       servers: {get_param: [servers, {{role.name}}]}
 274       config: {get_resource: RoleConfig}
 275       input_values:
 276         step: {{step}}
 277         role_name: {{role.name}}
 278         update_identifier: {get_param: DeployIdentifier}
 279         bootstrap_server_id: {get_param: [servers, {{primary_role_name}}, '0']}
 280         docker_puppet_debug: {get_param: DockerPuppetDebug}
 281         docker_puppet_process_count: {get_param: DockerPuppetProcessCount}
 282   {% endfor %}
 283   # END CONFIG STEPS
 284
 285   # Note, this should be the last step to execute configuration changes.
 286   # Ensure that all {{role.name}}ExtraConfigPost steps are executed
 287   # after all the previous deployment steps.
 288   {{role.name}}ExtraConfigPost:
 289     depends_on:
 290   {%- for dep in roles %}
 291       - {{dep.name}}Deployment_Step5
 292   {%- endfor %}
 293     type: OS::TripleO::NodeExtraConfigPost
 294     properties:
 295         servers: {get_param: [servers, {{role.name}}]}
 296
 297   # The {{role.name}}PostConfig steps are in charge of
 298   # quiescing all services, i.e. in the Controller case,
 299   # we should run a full service reload.
 300   {{role.name}}PostConfig:
 301     type: OS::TripleO::Tasks::{{role.name}}PostConfig
 302     depends_on:
 303   {%- for dep in roles %}
 304       - {{dep.name}}ExtraConfigPost
 305   {%- endfor %}
 306     properties:
 307       servers:  {get_param: servers}
 308       input_values:
 309         update_identifier: {get_param: DeployIdentifier}
 310
 311
 312 {% endfor %}
 313
 314 outputs:
 315   RoleConfig:
 316     description: Mapping of config data for all roles
 317     value:
 318       deploy_steps_tasks: {get_file: deploy-steps-tasks.yaml}
 319       deploy_steps_playbook: |
 320         - hosts: overcloud
 321           tasks:
 322 {%- for role in roles %}
 323             - include: {{role.name}}/host_prep_tasks.yaml
 324               when: role_name == '{{role.name}}'
 325 {%- endfor %}
 326             - include: deploy_steps_tasks.yaml
 327               with_sequence: start=0 end={{deploy_steps_max-1}}
 328               loop_control:
 329                 loop_var: step
 330       update_steps_tasks: |
 331 {%- for role in roles %}
 332             - include: {{role.name}}/update_tasks.yaml
 333               when: role_name == '{{role.name}}'
 334 {%- endfor %}
 335       update_steps_playbook: |
 336         - hosts: overcloud
 337           serial: 1
 338           tasks:
 339             - include: update_steps_tasks.yaml
 340               with_sequence: start=0 end={{update_steps_max-1}}
 341               loop_control:
 342                 loop_var: step
 343             - include: deploy_steps_tasks.yaml
 344               with_sequence: start=0 end={{deploy_steps_max-1}}
 345               loop_control:
 346                 loop_var: step
 347       upgrade_steps_tasks: |
 348 {%- for role in roles %}
 349             - include: {{role.name}}/upgrade_tasks.yaml
 350               when: role_name == '{{role.name}}'
 351 {%- endfor %}
 352       upgrade_steps_playbook: |
 353         - hosts: overcloud
 354           tasks:
 355             - include: upgrade_steps_tasks.yaml
 356               with_sequence: start=0 end={{upgrade_steps_max-1}}
 357               loop_control:
 358                 loop_var: step
 359             - include: deploy_steps_tasks.yaml
 360               with_sequence: start=0 end={{deploy_steps_max-1}}
 361               loop_control:
 362                 loop_var: step
 363