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