1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
.. -*- rst -*-
===================================
Deploy Templates (deploy_templates)
===================================
The Deploy Template resource represents a collection of Deploy Steps that may
be executed during deployment of a node. A deploy template is matched for a
node if at the time of deployment, the template's name matches a trait in the
node's ``instance_info.traits``.
.. versionadded:: 1.55
Deploy Template API was introduced.
Create Deploy Template
======================
.. rest_method:: POST /v1/deploy_templates
Creates a deploy template.
.. versionadded:: 1.55
Deploy Template API was introduced.
Normal response codes: 201
Error response codes: 400, 401, 403, 409
Request
-------
.. rest_parameters:: parameters.yaml
- name: deploy_template_name
- steps: deploy_template_steps
- uuid: req_uuid
- extra: req_extra
Request Step
------------
.. rest_parameters:: parameters.yaml
- interface: deploy_template_step_interface
- step: deploy_template_step_step
- args: deploy_template_step_args
- priority: deploy_template_step_priority
Request Example
---------------
.. literalinclude:: samples/deploy-template-create-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- uuid: uuid
- name: deploy_template_name
- steps: deploy_template_steps
- extra: extra
- created_at: created_at
- updated_at: updated_at
- links: links
Response Example
----------------
.. literalinclude:: samples/deploy-template-create-response.json
:language: javascript
List Deploy Templates
=====================
.. rest_method:: GET /v1/deploy_templates
Lists all deploy templates.
.. versionadded:: 1.55
Deploy Template API was introduced.
Normal response codes: 200
Error response codes: 400, 401, 403, 404
Request
-------
.. rest_parameters:: parameters.yaml
- fields: fields
- limit: limit
- marker: marker
- sort_dir: sort_dir
- sort_key: sort_key
- detail: detail
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- uuid: uuid
- name: deploy_template_name
- steps: deploy_template_steps
- extra: extra
- created_at: created_at
- updated_at: updated_at
- links: links
Response Example
----------------
**Example deploy template list response:**
.. literalinclude:: samples/deploy-template-list-response.json
:language: javascript
**Example detailed deploy template list response:**
.. literalinclude:: samples/deploy-template-detail-response.json
:language: javascript
Show Deploy Template Details
============================
.. rest_method:: GET /v1/deploy_templates/{deploy_template_id}
Shows details for a deploy template.
.. versionadded:: 1.55
Deploy Template API was introduced.
Normal response codes: 200
Error response codes: 400, 401, 403, 404
Request
-------
.. rest_parameters:: parameters.yaml
- fields: fields
- deploy_template_id: deploy_template_ident
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- uuid: uuid
- name: deploy_template_name
- steps: deploy_template_steps
- extra: extra
- created_at: created_at
- updated_at: updated_at
- links: links
Response Example
----------------
.. literalinclude:: samples/deploy-template-show-response.json
:language: javascript
Update a Deploy Template
========================
.. rest_method:: PATCH /v1/deploy_templates/{deploy_template_id}
Update a deploy template.
.. versionadded:: 1.55
Deploy Template API was introduced.
Normal response code: 200
Error response codes: 400, 401, 403, 404, 409
Request
-------
The BODY of the PATCH request must be a JSON PATCH document, adhering to
`RFC 6902 <https://tools.ietf.org/html/rfc6902>`_.
Request
-------
.. rest_parameters:: parameters.yaml
- deploy_template_id: deploy_template_ident
.. literalinclude:: samples/deploy-template-update-request.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- uuid: uuid
- name: deploy_template_name
- steps: deploy_template_steps
- extra: extra
- created_at: created_at
- updated_at: updated_at
- links: links
.. literalinclude:: samples/deploy-template-update-response.json
:language: javascript
Delete Deploy Template
======================
.. rest_method:: DELETE /v1/deploy_template/{deploy_template_id}
Deletes a deploy template.
.. versionadded:: 1.55
Deploy Template API was introduced.
Normal response codes: 204
Error response codes: 400, 401, 403, 404
Request
-------
.. rest_parameters:: parameters.yaml
- deploy_template_id: deploy_template_ident
|