Merge "Replace outdated instruction with link to upstream doc"
[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   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   RoleConfig:
64     type: OS::Heat::SoftwareConfig
65     properties:
66       group: ansible
67       options:
68         modulepath: /usr/share/ansible-modules
69       inputs:
70         - name: step
71         - name: role_name
72         - name: update_identifier
73         - name: bootstrap_server_id
74         - name: docker_puppet_debug
75       config: {get_file: deploy-steps-playbook.yaml}
76
77 {%- for step in range(1, deploy_steps_max) %}
78 # BEGIN service_workflow_tasks handling
79   WorkflowTasks_Step{{step}}:
80     type: OS::Mistral::Workflow
81     condition: WorkflowTasks_Step{{step}}_Enabled
82     depends_on:
83     {%- if step == 1 %}
84     {%- for dep in roles %}
85       - {{dep.name}}PreConfig
86       - {{dep.name}}ArtifactsDeploy
87     {%- endfor %}
88     {%- else %}
89     {%- for dep in roles %}
90       - {{dep.name}}Deployment_Step{{step -1}}
91     {%- endfor %}
92     {%- endif %}
93     properties:
94       name: {list_join: [".", ["tripleo", {get_param: stack_name}, "workflowtasks", "step{{step}}"]]}
95       type: direct
96       tasks:
97         yaql:
98           expression: $.data.where($ != '').select($.get('step{{step}}')).where($ != null).flatten()
99           data:
100           {%- for role in roles %}
101             - get_param: [role_data, {{role.name}}, service_workflow_tasks]
102           {%- endfor %}
103
104   WorkflowTasks_Step{{step}}_Execution:
105     type: OS::Mistral::ExternalResource
106     condition: WorkflowTasks_Step{{step}}_Enabled
107     depends_on: WorkflowTasks_Step{{step}}
108     properties:
109       actions:
110         CREATE:
111           workflow: { get_resource: WorkflowTasks_Step{{step}} }
112           params:
113             env:
114               service_ips: { get_param: ctlplane_service_ips }
115               role_merged_configs:
116                 {%- for r in roles %}
117                 {{r.name}}: {get_param: [role_data, {{r.name}}, merged_config_settings]}
118                 {%- endfor %}
119             evaluate_env: false
120         UPDATE:
121           workflow: { get_resource: WorkflowTasks_Step{{step}} }
122           params:
123             env:
124               service_ips: { get_param: ctlplane_service_ips }
125               role_merged_configs:
126                 {%- for r in roles %}
127                 {{r.name}}: {get_param: [role_data, {{r.name}}, merged_config_settings]}
128                 {%- endfor %}
129             evaluate_env: false
130       always_update: true
131 # END service_workflow_tasks handling
132 {% endfor %}
133
134 {% for role in roles %}
135   # Post deployment steps for all roles
136   # A single config is re-applied with an incrementing step number
137   # {{role.name}} Role steps
138   {{role.name}}ArtifactsConfig:
139     type: ../puppet/deploy-artifacts.yaml
140
141   {{role.name}}ArtifactsDeploy:
142     type: OS::Heat::StructuredDeploymentGroup
143     properties:
144       servers:  {get_param: [servers, {{role.name}}]}
145       config: {get_resource: {{role.name}}ArtifactsConfig}
146
147   {{role.name}}HostPrepConfig:
148     type: OS::Heat::SoftwareConfig
149     properties:
150       group: ansible
151       options:
152         modulepath: /usr/share/ansible-modules
153       config:
154         str_replace:
155           template: _PLAYBOOK
156           params:
157             _PLAYBOOK:
158               - hosts: localhost
159                 connection: local
160                 vars:
161                   puppet_config: {get_param: [role_data, {{role.name}}, puppet_config]}
162                   docker_puppet_script: {get_file: docker-puppet.py}
163                   docker_puppet_tasks: {get_param: [role_data, {{role.name}}, docker_puppet_tasks]}
164                   docker_startup_configs: {get_param: [role_data, {{role.name}}, docker_config]}
165                   kolla_config: {get_param: [role_data, {{role.name}}, kolla_config]}
166                   bootstrap_server_id: {get_param: [servers, {{primary_role_name}}, '0']}
167                   puppet_step_config: {get_param: [role_data, {{role.name}}, step_config]}
168                 tasks:
169                   # Join host_prep_tasks with the other per-host configuration
170                   yaql:
171                     expression: $.data.host_prep_tasks + $.data.template_tasks
172                     data:
173                       host_prep_tasks: {get_param: [role_data, {{role.name}}, host_prep_tasks]}
174                       template_tasks:
175 {%- raw %}
176                         # Write the manifest for baremetal puppet configuration
177                         - name: Create /var/lib/tripleo-config directory
178                           file: path=/var/lib/tripleo-config state=directory
179                         - name: Write the puppet step_config manifest
180                           copy: content="{{puppet_step_config}}" dest=/var/lib/tripleo-config/puppet_step_config.pp force=yes
181                         # this creates a JSON config file for our docker-puppet.py script
182                         - name: Create /var/lib/docker-puppet
183                           file: path=/var/lib/docker-puppet state=directory
184                         - name: Write docker-puppet-tasks json files
185                           copy: content="{{puppet_config | to_json}}" dest=/var/lib/docker-puppet/docker-puppet.json force=yes
186                         # FIXME: can we move docker-puppet somewhere so it's installed via a package?
187                         - name: Write docker-puppet.py
188                           copy: content="{{docker_puppet_script}}" dest=/var/lib/docker-puppet/docker-puppet.py force=yes
189                         # Here we are dumping all the docker container startup configuration data
190                         # so that we can have access to how they are started outside of heat
191                         # and docker-cmd.  This lets us create command line tools to test containers.
192                         # FIXME do we need the docker-container-startup-configs.json or is the new per-step
193                         # data consumed by paunch enough?
194                         - name: Write docker-container-startup-configs
195                           copy: content="{{docker_startup_configs | to_json}}" dest=/var/lib/docker-container-startup-configs.json force=yes
196                         - name: Write per-step docker-container-startup-configs
197                           copy: content="{{item.value|to_json}}" dest="/var/lib/tripleo-config/docker-container-startup-config-{{item.key}}.json" force=yes
198                           with_dict: "{{docker_startup_configs}}"
199                         - name: Create /var/lib/kolla/config_files directory
200                           file: path=/var/lib/kolla/config_files state=directory
201                         - name: Write kolla config json files
202                           copy: content="{{item.value|to_json}}" dest="{{item.key}}" force=yes
203                           with_dict: "{{kolla_config}}"
204                         ########################################################
205                         # Bootstrap tasks, only performed on bootstrap_server_id
206                         ########################################################
207                         - name: Clean /var/lib/docker-puppet/docker-puppet-tasks*.json files
208                           file:
209                             path: "{{item}}"
210                             state: absent
211                           with_fileglob:
212                             - /var/lib/docker-puppet/docker-puppet-tasks*.json
213                           when: deploy_server_id == bootstrap_server_id
214                         - name: Write docker-puppet-tasks json files
215                           copy: content="{{item.value|to_json}}" dest=/var/lib/docker-puppet/docker-puppet-tasks{{item.key.replace("step_", "")}}.json force=yes
216                           with_dict: "{{docker_puppet_tasks}}"
217                           when: deploy_server_id == bootstrap_server_id
218 {%- endraw %}
219
220   {{role.name}}HostPrepDeployment:
221     type: OS::Heat::SoftwareDeploymentGroup
222     properties:
223       servers: {get_param: [servers, {{role.name}}]}
224       config: {get_resource: {{role.name}}HostPrepConfig}
225
226   # BEGIN CONFIG STEPS
227
228   {{role.name}}PreConfig:
229     type: OS::TripleO::Tasks::{{role.name}}PreConfig
230     depends_on: {{role.name}}HostPrepDeployment
231     properties:
232       servers: {get_param: [servers, {{role.name}}]}
233       input_values:
234         update_identifier: {get_param: DeployIdentifier}
235
236   {% for step in range(1, deploy_steps_max) %}
237   {{role.name}}Deployment_Step{{step}}:
238     type: OS::Heat::StructuredDeploymentGroup
239     depends_on:
240       - WorkflowTasks_Step{{step}}_Execution
241     # TODO(gfidente): the following if/else condition
242     # replicates what is already defined for the
243     # WorkflowTasks_StepX resource and can be remove
244     # if https://bugs.launchpad.net/heat/+bug/1700569
245     # is fixed.
246     {%- if step == 1 %}
247     {%- for dep in roles %}
248       - {{dep.name}}PreConfig
249       - {{dep.name}}ArtifactsDeploy
250     {%- endfor %}
251     {%- else %}
252     {%- for dep in roles %}
253       - {{dep.name}}Deployment_Step{{step -1}}
254     {%- endfor %}
255     {%- endif %}
256     properties:
257       name: {{role.name}}Deployment_Step{{step}}
258       servers: {get_param: [servers, {{role.name}}]}
259       config: {get_resource: RoleConfig}
260       input_values:
261         step: {{step}}
262         role_name: {{role.name}}
263         update_identifier: {get_param: DeployIdentifier}
264         bootstrap_server_id: {get_param: [servers, {{primary_role_name}}, '0']}
265         docker_puppet_debug: {get_param: DockerPuppetDebug}
266   {% endfor %}
267   # END CONFIG STEPS
268
269   # Note, this should be the last step to execute configuration changes.
270   # Ensure that all {{role.name}}ExtraConfigPost steps are executed
271   # after all the previous deployment steps.
272   {{role.name}}ExtraConfigPost:
273     depends_on:
274   {%- for dep in roles %}
275       - {{dep.name}}Deployment_Step5
276   {%- endfor %}
277     type: OS::TripleO::NodeExtraConfigPost
278     properties:
279         servers: {get_param: [servers, {{role.name}}]}
280
281   # The {{role.name}}PostConfig steps are in charge of
282   # quiescing all services, i.e. in the Controller case,
283   # we should run a full service reload.
284   {{role.name}}PostConfig:
285     type: OS::TripleO::Tasks::{{role.name}}PostConfig
286     depends_on:
287   {%- for dep in roles %}
288       - {{dep.name}}ExtraConfigPost
289   {%- endfor %}
290     properties:
291       servers:  {get_param: servers}
292       input_values:
293         update_identifier: {get_param: DeployIdentifier}
294
295
296 {% endfor %}