Allows use of Mistral workflows during deployment steps
[apex-tripleo-heat-templates.git] / 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
42 conditions:
43 {% for step in range(1, deploy_steps_max) %}
44   WorkflowTasks_Step{{step}}_Enabled:
45     or:
46     {% for role in roles %}
47       - not:
48           equals:
49             - get_param: [role_data, {{role.name}}, service_workflow_tasks, step{{step}}]
50             - ''
51       - False
52     {% endfor %}
53 {% endfor %}
54
55 resources:
56
57   # These utility tasks use docker-puppet.py to execute tasks via puppet
58   # We only execute these on the first node in the primary role
59   {{primary_role_name}}DockerPuppetTasks:
60     type: OS::Heat::Value
61     properties:
62       type: json
63       value:
64         yaql:
65           expression:
66             $.data.default_tasks + dict($.data.docker_puppet_tasks.where($1 != null).selectMany($.items()).groupBy($[0], $[1]))
67           data:
68             docker_puppet_tasks: {get_param: [role_data, {{primary_role_name}}, docker_puppet_tasks]}
69             default_tasks:
70 {%- for step in range(1, deploy_steps_max) %}
71               step_{{step}}: {}
72 {%- endfor %}
73
74   RoleConfig:
75     type: OS::Heat::SoftwareConfig
76     properties:
77       group: ansible
78       options:
79         modulepath: /usr/share/ansible-modules
80       inputs:
81         - name: step
82         - name: role_name
83         - name: update_identifier
84         - name: bootstrap_server_id
85       config: {get_file: deploy-steps-playbook.yaml}
86
87 {%- for step in range(1, deploy_steps_max) %}
88 # BEGIN service_workflow_tasks handling
89   WorkflowTasks_Step{{step}}:
90     type: OS::Mistral::Workflow
91     condition: WorkflowTasks_Step{{step}}_Enabled
92     depends_on:
93     {% if step == 1 %}
94     {% for dep in roles %}
95       - {{dep.name}}PreConfig
96       - {{dep.name}}ArtifactsDeploy
97     {% endfor %}
98     {% else %}
99     {% for dep in roles %}
100       - {{dep.name}}Deployment_Step{{step -1}}
101     {% endfor %}
102     {% endif %}
103     properties:
104       name: {list_join: [".", ["tripleo", {get_param: stack_name}, "workflowtasks", "step{{step}}"]]}
105       type: direct
106       tasks:
107         yaql:
108           expression: $.data.where($ != '').select($.get('step{{step}}')).where($ != null).flatten()
109           data:
110           {% for role in roles %}
111             - get_param: [role_data, {{role.name}}, service_workflow_tasks]
112           {% endfor %}
113
114   WorkflowTasks_Step{{step}}_Execution:
115     type: OS::Mistral::ExternalResource
116     condition: WorkflowTasks_Step{{step}}_Enabled
117     depends_on: WorkflowTasks_Step{{step}}
118     properties:
119       actions:
120         CREATE:
121           workflow: { get_resource: WorkflowTasks_Step{{step}} }
122         UPDATE:
123           workflow: { get_resource: WorkflowTasks_Step{{step}} }
124       always_update: true
125 # END service_workflow_tasks handling
126 {% endfor %}
127
128 {% for role in roles %}
129   # Post deployment steps for all roles
130   # A single config is re-applied with an incrementing step number
131   # {{role.name}} Role steps
132   {{role.name}}ArtifactsConfig:
133     type: ../puppet/deploy-artifacts.yaml
134
135   {{role.name}}ArtifactsDeploy:
136     type: OS::Heat::StructuredDeploymentGroup
137     properties:
138       servers:  {get_param: [servers, {{role.name}}]}
139       config: {get_resource: {{role.name}}ArtifactsConfig}
140
141   {{role.name}}HostPrepConfig:
142     type: OS::Heat::SoftwareConfig
143     properties:
144       group: ansible
145       options:
146         modulepath: /usr/share/ansible-modules
147       config:
148         str_replace:
149           template: _PLAYBOOK
150           params:
151             _PLAYBOOK:
152               - hosts: localhost
153                 connection: local
154                 vars:
155                   puppet_config: {get_param: [role_data, {{role.name}}, puppet_config]}
156                   docker_puppet_script: {get_file: docker-puppet.py}
157                   docker_puppet_tasks: {get_attr: [{{primary_role_name}}DockerPuppetTasks, value]}
158                   docker_startup_configs: {get_attr: [{{role.name}}DockerConfig, value]}
159                   kolla_config: {get_param: [role_data, {{role.name}}, kolla_config]}
160                   bootstrap_server_id: {get_param: [servers, {{primary_role_name}}, '0']}
161                   puppet_step_config: {get_attr: [{{role.name}}PuppetStepConfig, value]}
162                 tasks:
163                   # Join host_prep_tasks with the other per-host configuration
164                   yaql:
165                     expression: $.data.host_prep_tasks + $.data.template_tasks
166                     data:
167                       host_prep_tasks: {get_param: [role_data, {{role.name}}, host_prep_tasks]}
168                       template_tasks:
169 {%- raw %}
170                         # Write the manifest for baremetal puppet configuration
171                         - name: Create /var/lib/tripleo-config directory
172                           file: path=/var/lib/tripleo-config state=directory
173                         - name: Write the puppet step_config manifest
174                           copy: content="{{puppet_step_config}}" dest=/var/lib/tripleo-config/puppet_step_config.pp force=yes
175                         # This is the docker-puppet configs end in
176                         - name: Create /var/lib/docker-puppet
177                           file: path=/var/lib/docker-puppet state=directory
178                         # this creates a JSON config file for our docker-puppet.py script
179                         - name: Write docker-puppet-tasks json files
180                           copy: content="{{puppet_config | to_json}}" dest=/var/lib/docker-puppet/docker-puppet.json force=yes
181                         # FIXME: can we move docker-puppet somewhere so it's installed via a package?
182                         - name: Write docker-puppet.py
183                           copy: content="{{docker_puppet_script}}" dest=/var/lib/docker-puppet/docker-puppet.py force=yes
184                         # Here we are dumping all the docker container startup configuration data
185                         # so that we can have access to how they are started outside of heat
186                         # and docker-cmd.  This lets us create command line tools to test containers.
187                         # FIXME do we need the docker-container-startup-configs.json or is the new per-step
188                         # data consumed by paunch enough?
189                         - name: Write docker-container-startup-configs
190                           copy: content="{{docker_startup_configs | to_json}}" dest=/var/lib/docker-container-startup-configs.json force=yes
191                         - name: Write per-step docker-container-startup-configs
192                           copy: content="{{item.value|to_json}}" dest="/var/lib/tripleo-config/docker-container-startup-config-{{item.key}}.json" force=yes
193                           with_dict: "{{docker_startup_configs}}"
194                         - name: Create /var/lib/kolla/config_files directory
195                           file: path=/var/lib/kolla/config_files state=directory
196                         - name: Write kolla config json files
197                           copy: content="{{item.value|to_json}}" dest="{{item.key}}" force=yes
198                           with_dict: "{{kolla_config}}"
199                         ########################################################
200                         # Bootstrap tasks, only performed on bootstrap_server_id
201                         ########################################################
202                         - name: Write docker-puppet-tasks json files
203                           copy: content="{{item.value|to_json}}" dest=/var/lib/docker-puppet/docker-puppet-tasks{{item.key.replace("step_", "")}}.json force=yes
204                           with_dict: "{{docker_puppet_tasks}}"
205                           when: deploy_server_id == bootstrap_server_id
206 {%- endraw %}
207
208   {{role.name}}HostPrepDeployment:
209     type: OS::Heat::SoftwareDeploymentGroup
210     properties:
211       servers: {get_param: [servers, {{role.name}}]}
212       config: {get_resource: {{role.name}}HostPrepConfig}
213
214   {{role.name}}PuppetStepConfig:
215     type: OS::Heat::Value
216     properties:
217       type: string
218       value:
219         yaql:
220           expression:
221             # select 'step_config' only from services that do not have a docker_config
222             $.data.service_names.zip($.data.step_config, $.data.docker_config).where($[2] = null).where($[1] != null).select($[1]).join("\n")
223           data:
224             service_names: {get_param: [role_data, {{role.name}}, service_names]}
225             step_config: {get_param: [role_data, {{role.name}}, step_config]}
226             docker_config: {get_param: [role_data, {{role.name}}, docker_config]}
227
228   {{role.name}}DockerConfig:
229     type: OS::Heat::Value
230     properties:
231       type: json
232       value:
233         yaql:
234           expression:
235             # select 'docker_config' only from services that have it
236             $.data.service_names.zip($.data.docker_config).where($[1] != null).select($[1]).reduce($1.mergeWith($2), {})
237           data:
238             service_names: {get_param: [role_data, {{role.name}}, service_names]}
239             docker_config: {get_param: [role_data, {{role.name}}, docker_config]}
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
253   {{role.name}}Deployment_Step{{step}}:
254     type: OS::Heat::StructuredDeploymentGroup
255     depends_on:
256       - WorkflowTasks_Step{{step}}_Execution
257     # TODO(gfidente): the following if/else condition
258     # replicates what is already defined for the
259     # WorkflowTasks_StepX resource and can be remove
260     # if https://bugs.launchpad.net/heat/+bug/1700569
261     # is fixed.
262     {% if step == 1 %}
263     {% for dep in roles %}
264       - {{dep.name}}PreConfig
265       - {{dep.name}}ArtifactsDeploy
266     {% endfor %}
267     {% else %}
268     {% for dep in roles %}
269       - {{dep.name}}Deployment_Step{{step -1}}
270     {% endfor %}
271     {% endif %}
272     properties:
273       name: {{role.name}}Deployment_Step{{step}}
274       servers: {get_param: [servers, {{role.name}}]}
275       config: {get_resource: RoleConfig}
276       input_values:
277         step: {{step}}
278         role_name: {{role.name}}
279         update_identifier: {get_param: DeployIdentifier}
280         bootstrap_server_id: {get_param: [servers, {{primary_role_name}}, '0']}
281
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 %}