forked from devtron-labs/devtron
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbulk_update.yaml
339 lines (336 loc) · 10.1 KB
/
bulk_update.yaml
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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
openapi: "3.0.0"
info:
version: 1.0.0
title: Bulk Update - Deployment Template, ConfigMaps, Secrets
servers:
- url: http://localhost:3000/orchestrator/batch
paths:
/{apiVersion}/{kind}/readme:
get:
description: Returns Readme for bulk update for different resource in the url
operationId: FindBulkUpdateReadme
parameters:
- name: apiVersion
in: path
required: true
schema:
type: string
- name: kind
in: path
required: true
schema:
type: string
responses:
'200':
description: Successful GET operation
content:
application/json:
schema:
$ref: '#/components/schemas/BulkUpdateSeeExampleResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/v1beta1/application/dryrun:
post:
description: Returns details(id, name, envId) of all apps to be impacted with bulk update
operationId: GetBulkAppName
requestBody:
description: A JSON object containing information by which apps will be filtered
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BulkUpdateScript'
responses:
'200':
description: Successfully return all impacted app details.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ImpactedObjectsResponse'
'400':
description: Bad Request. Validation error/wrong request body.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Unauthorized User
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/v1beta1/application:
post:
description: Bulk Updates all impacted apps
operationId: BulkUpdate
requestBody:
description: A JSON object containing information about update changes and by which apps will be filtered
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BulkUpdateScript'
responses:
'200':
description: Successfully updated all impacted apps.
content:
application/json:
schema:
$ref: '#/components/schemas/BulkUpdateResponse'
'400':
description: Bad Request. Validation error/wrong request body.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Unauthorized User
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
BulkUpdateSeeExampleResponse:
type: object
required:
- Script
properties:
resource:
type: string
description: Resource from url path, i.e. {apiVersion} & {kind}
script:
$ref: '#/components/schemas/BulkUpdateScript'
description: Input Script for bulk update
readMe:
type: string
description: Readme for bulk update
BulkUpdateScript:
type: object
required:
- ApiVersion
- Kind
- Spec
properties:
apiVersion:
type: string
description: Api version from url
example:
- v1beta1
kind:
type: string
description: Kind
example:
- application
spec:
$ref: '#/components/schemas/BulkUpdatePayload'
BulkUpdatePayload:
type: object
properties:
includes:
$ref: '#/components/schemas/NameIncludesExcludes'
excludes:
$ref: '#/components/schemas/NameIncludesExcludes'
envIds:
type: array
items:
type: integer
description: All Env Id's for updating dependent apps
global:
type: boolean
description: Global flag for updating dependent apps
DeploymentTemplate:
$ref: '#/components/schemas/Tasks'
ConfigMaps:
type: object
properties:
names:
type: array
items:
type: string
description : Name of All ConfigMaps to be updated
tasks:
$ref: '#/components/schemas/Spec'
Secrets:
type: object
properties:
names:
type: array
items:
type: string
description : Name of All Secrets to be updated
tasks:
$ref: '#/components/schemas/Spec'
Tasks:
type: object
properties:
spec:
$ref: '#/components/schemas/Spec'
description: Spec of the Task
Spec:
type: object
properties:
patchData:
type: string
description: string with details of the patch to be used for updating
NameIncludesExcludes:
type: object
properties:
names:
type: array
items:
type: string
description: All strings of app names to be included/excluded
ImpactedObjectsResponse:
type: object
properties:
deploymentTemplate:
type: array
items:
$ref: '#/components/schemas/DeploymentTemplateImpactedObjectsResponseForOneApp'
configMap:
type: array
items:
$ref: '#/components/schemas/CmAndSecretImpactedObjectsResponseForOneApp'
secret:
type: array
items:
$ref: '#/components/schemas/CmAndSecretImpactedObjectsResponseForOneApp'
DeploymentTemplateImpactedObjectsResponseForOneApp:
type: object
properties:
appId:
type: integer
description: Id of the impacted app
appName:
type: string
description: Name of the impacted app
envId:
type: string
description: Env Id of the impacted app
CmAndSecretImpactedObjectsResponseForOneApp:
type: object
properties:
appId:
type: integer
description: Id of the impacted app
appName:
type: string
description: Name of the impacted app
envId:
type: string
description: Env Id of the impacted app
names:
type: array
items:
type: string
description: Names of all configmaps/secrets impacted
BulkUpdateResponse:
type: object
properties:
deploymentTemplate:
$ref: '#/components/schemas/DeploymentTemplateBulkUpdateResponse'
configMap:
$ref: '#/components/schemas/CmAndSecretBulkUpdateResponse'
secret:
$ref: '#/components/schemas/CmAndSecretBulkUpdateResponse'
DeploymentTemplateBulkUpdateResponse:
type: object
properties:
message:
type: array
items:
type: string
description: All top-level messages in response of bulk update action
failure:
type: array
items:
$ref: '#/components/schemas/DeploymentTemplateBulkUpdateResponseForOneApp'
description: Details of all apps on which bulk update failed
successful:
type: array
items:
$ref: '#/components/schemas/DeploymentTemplateBulkUpdateResponseForOneApp'
description: Details of all apps on which bulk update applied successfully
CmAndSecretBulkUpdateResponse:
type: object
properties:
message:
type: array
items:
type: string
description: All top-level messages in response of bulk update action
failure:
type: array
items:
$ref: '#/components/schemas/CmAndSecretBulkUpdateResponseForOneApp'
description: Details of all apps on which bulk update failed
successful:
type: array
items:
$ref: '#/components/schemas/CmAndSecretBulkUpdateResponseForOneApp'
description: Details of all apps on which bulk update applied successfully
DeploymentTemplateBulkUpdateResponseForOneApp:
type: object
properties:
appId:
type: integer
description: Id of the concerned app
appName:
type: string
description: Name of the concerned app
envId:
type: integer
description: Env ID of the concerned app
message:
type: string
description: App-level message for the concerned app
CmAndSecretBulkUpdateResponseForOneApp:
type: object
properties:
appId:
type: integer
description: Id of the concerned app
appName:
type: string
description: Name of the concerned app
envId:
type: integer
description: Env ID of the concerned app
names:
type: array
items:
type: string
description: Names of all configmaps/secrets
message:
type: string
description: App-level message for the concerned app
Error:
required:
- code
- message
properties:
code:
type: integer
description: Error code
message:
type: string
description: Error message