forked from kubepack/swift
/
tiller.schema.json
469 lines (469 loc) · 16.4 KB
/
tiller.schema.json
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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
{
"definitions": {
"ListSortSortBy": {
"default": "UNKNOWN",
"description": "SortBy defines sort operations.",
"enum": [
"UNKNOWN",
"NAME",
"LAST_RELEASED"
],
"type": "string"
},
"ListSortSortOrder": {
"default": "ASC",
"description": "SortOrder defines sort orders to augment sorting operations.",
"enum": [
"ASC",
"DESC"
],
"type": "string"
},
"chartChart": {
"description": "Chart is a helm package that contains metadata, a default config, zero or more\n\toptionally parameterizable templates, and zero or more charts (dependencies).",
"properties": {
"dependencies": {
"description": "Charts that this chart depends on.",
"items": {
"$ref": "#/definitions/chartChart"
},
"type": "array"
},
"files": {
"description": "Miscellaneous files in a chart archive,\ne.g. README, LICENSE, etc.",
"items": {
"$ref": "#/definitions/hapichartAny"
},
"type": "array"
},
"metadata": {
"$ref": "#/definitions/chartMetadata",
"description": "Contents of the Chartfile."
},
"templates": {
"description": "Templates for this chart.",
"items": {
"$ref": "#/definitions/chartTemplate"
},
"type": "array"
},
"values": {
"$ref": "#/definitions/chartConfig",
"description": "Default config for this template."
}
},
"type": "object"
},
"chartConfig": {
"description": "Config supplies values to the parametrizable templates of a chart.",
"properties": {
"raw": {
"type": "string"
},
"values": {
"additionalProperties": {
"$ref": "#/definitions/chartValue"
},
"type": "object"
}
},
"type": "object"
},
"chartMaintainer": {
"description": "Maintainer describes a Chart maintainer.",
"properties": {
"email": {
"title": "Email is an optional email address to contact the named maintainer",
"type": "string"
},
"name": {
"title": "Name is a user name or organization name",
"type": "string"
}
},
"type": "object"
},
"chartMetadata": {
"description": "Metadata for a Chart file. This models the structure of a Chart.yaml file.\n\n\tSpec: https://k8s.io/helm/blob/master/docs/design/chart_format.md#the-chart-file",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations are additional mappings uninterpreted by Tiller,\nmade available for inspection by other applications.",
"type": "object"
},
"apiVersion": {
"description": "The API Version of this chart.",
"type": "string"
},
"appVersion": {
"description": "The version of the application enclosed inside of this chart.",
"type": "string"
},
"condition": {
"title": "The condition to check to enable chart",
"type": "string"
},
"deprecated": {
"title": "Whether or not this chart is deprecated",
"type": "boolean"
},
"description": {
"title": "A one-sentence description of the chart",
"type": "string"
},
"engine": {
"description": "The name of the template engine to use. Defaults to 'gotpl'.",
"type": "string"
},
"home": {
"title": "The URL to a relevant project page, git repo, or contact person",
"type": "string"
},
"icon": {
"description": "The URL to an icon file.",
"type": "string"
},
"keywords": {
"items": {
"type": "string"
},
"title": "A list of string keywords",
"type": "array"
},
"maintainers": {
"items": {
"$ref": "#/definitions/chartMaintainer"
},
"title": "A list of name and URL/email address combinations for the maintainer(s)",
"type": "array"
},
"name": {
"title": "The name of the chart",
"type": "string"
},
"sources": {
"items": {
"type": "string"
},
"title": "Source is the URL to the source code of this chart",
"type": "array"
},
"tags": {
"title": "The tags to check to enable chart",
"type": "string"
},
"tillerVersion": {
"title": "TillerVersion is a SemVer constraints on what version of Tiller is required.\nSee SemVer ranges here: https://github.com/Masterminds/semver#basic-comparisons",
"type": "string"
},
"version": {
"title": "A SemVer 2 conformant version string of the chart",
"type": "string"
}
},
"type": "object"
},
"chartTemplate": {
"description": "Template represents a template as a name/value pair.\n\nBy convention, name is a relative path within the scope of the chart's\nbase directory.",
"properties": {
"data": {
"description": "Data is the template as byte data.",
"type": "string"
},
"name": {
"description": "Name is the path-like name of the template.",
"type": "string"
}
},
"type": "object"
},
"chartValue": {
"description": "Value describes a configuration value as a string.",
"properties": {
"value": {
"type": "string"
}
},
"type": "object"
},
"hapichartAny": {
"properties": {
"type_url": {
"description": "A resource name whose content describes the type of the\nserialized data.",
"type": "string"
},
"value": {
"description": "Data for file.",
"type": "string"
}
},
"title": "Copied from https://github.com/golang/protobuf/blob/master/ptypes/any/any.proto",
"type": "object"
},
"v2GetHistoryRequest": {
"description": "GetHistoryRequest requests a release's history.",
"properties": {
"max": {
"description": "The maximum number of releases to include.",
"type": "integer"
},
"name": {
"description": "The name of the release.",
"maxLength": 63,
"pattern": "^[a-z0-9](?:[a-z0-9\\-]{0,61}[a-z0-9])?$",
"type": "string"
}
},
"type": "object"
},
"v2GetReleaseContentRequest": {
"description": "GetReleaseContentRequest is a request to get the contents of a release.",
"properties": {
"format_values_as_json": {
"title": "Format release config and values to JSON string",
"type": "boolean"
},
"name": {
"maxLength": 63,
"pattern": "^[a-z0-9](?:[a-z0-9\\-]{0,61}[a-z0-9])?$",
"title": "The name of the release",
"type": "string"
},
"version": {
"title": "Version is the version of the release",
"type": "integer"
}
},
"type": "object"
},
"v2GetReleaseStatusRequest": {
"description": "GetReleaseStatusRequest is a request to get the status of a release.",
"properties": {
"name": {
"maxLength": 63,
"pattern": "^[a-z0-9](?:[a-z0-9\\-]{0,61}[a-z0-9])?$",
"title": "Name is the name of the release",
"type": "string"
},
"version": {
"title": "Version is the version of the release",
"type": "integer"
}
},
"type": "object"
},
"v2GetVersionRequest": {
"description": "GetVersionRequest requests for version information.",
"type": "object"
},
"v2InstallReleaseRequest": {
"description": "InstallReleaseRequest is the request for an installation of a chart.",
"properties": {
"chart": {
"$ref": "#/definitions/chartChart",
"description": "Chart is the protobuf representation of a chart."
},
"chart_url": {
"title": "url to download char tar file @appscode",
"type": "string"
},
"disable_hooks": {
"description": "DisableHooks causes the server to skip running any hooks for the install.",
"type": "boolean"
},
"dry_run": {
"description": "DryRun, if true, will run through the release logic, but neither create\na release object nor deploy to Kubernetes. The release object returned\nin the response will be fake.",
"type": "boolean"
},
"name": {
"description": "Name is the candidate release name. This must be unique to the\nnamespace, otherwise the server will return an error. If it is not\nsupplied, the server will autogenerate one.",
"maxLength": 63,
"pattern": "^[a-z0-9](?:[a-z0-9\\-]{0,61}[a-z0-9])?$",
"type": "string"
},
"namespace": {
"description": "Namepace is the kubernetes namespace of the release.",
"maxLength": 63,
"pattern": "^[a-z0-9](?:[a-z0-9\\-]{0,61}[a-z0-9])?$",
"type": "string"
},
"reuse_name": {
"description": "ReuseName requests that Tiller re-uses a name, instead of erroring out.",
"type": "boolean"
},
"timeout": {
"description": "timeout specifies the max amount of time any kubernetes client command can run.",
"type": "integer"
},
"values": {
"$ref": "#/definitions/chartConfig",
"description": "Values is a string containing (unparsed) YAML values."
},
"wait": {
"title": "wait, if true, will wait until all Pods, PVCs, and Services are in a ready state\nbefore marking the release as successful. It will wait for as long as timeout",
"type": "boolean"
}
},
"type": "object"
},
"v2RollbackReleaseRequest": {
"properties": {
"disable_hooks": {
"title": "DisableHooks causes the server to skip running any hooks for the rollback",
"type": "boolean"
},
"dry_run": {
"title": "dry_run, if true, will run through the release logic but no create",
"type": "boolean"
},
"force": {
"description": "Force resource update through delete/recreate if needed.",
"type": "boolean"
},
"name": {
"maxLength": 63,
"pattern": "^[a-z0-9](?:[a-z0-9\\-]{0,61}[a-z0-9])?$",
"title": "The name of the release",
"type": "string"
},
"recreate": {
"title": "Performs pods restart for resources if applicable",
"type": "boolean"
},
"timeout": {
"description": "timeout specifies the max amount of time any kubernetes client command can run.",
"type": "integer"
},
"version": {
"description": "Version is the version of the release to deploy.",
"type": "integer"
},
"wait": {
"title": "wait, if true, will wait until all Pods, PVCs, and Services are in a ready state\nbefore marking the release as successful. It will wait for as long as timeout",
"type": "boolean"
}
},
"type": "object"
},
"v2SummarizeReleasesRequest": {
"description": "SummarizeReleasesRequest requests a list of releases.\n\nReleases can be retrieved in chunks by setting limit and offset.\n\nReleases can be sorted according to a few pre-determined sort stategies.",
"properties": {
"filter": {
"description": "Filter is a regular expression used to filter which releases should be listed.\n\nAnything that matches the regexp will be included in the results.",
"type": "string"
},
"limit": {
"description": "Limit is the maximum number of releases to be returned.",
"type": "integer"
},
"namespace": {
"description": "Namespace is the filter to select releases only from a specific namespace.",
"maxLength": 63,
"pattern": "^[a-z0-9](?:[a-z0-9\\-]{0,61}[a-z0-9])?$",
"type": "string"
},
"offset": {
"description": "Offset is the last release name that was seen. The next listing\noperation will start with the name after this one.\nExample: If list one returns albert, bernie, carl, and sets 'next: dennis'.\ndennis is the offset. Supplying 'dennis' for the next request should\ncause the next batch to return a set of results starting with 'dennis'.",
"type": "string"
},
"sort_by": {
"$ref": "#/definitions/ListSortSortBy",
"description": "SortBy is the sort field that the ListReleases server should sort data before returning."
},
"sort_order": {
"$ref": "#/definitions/ListSortSortOrder",
"description": "SortOrder is the ordering directive used for sorting."
},
"status_codes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"v2UninstallReleaseRequest": {
"description": "UninstallReleaseRequest represents a request to uninstall a named release.",
"properties": {
"disable_hooks": {
"description": "DisableHooks causes the server to skip running any hooks for the uninstall.",
"type": "boolean"
},
"name": {
"description": "Name is the name of the release to delete.",
"maxLength": 63,
"pattern": "^[a-z0-9](?:[a-z0-9\\-]{0,61}[a-z0-9])?$",
"type": "string"
},
"purge": {
"description": "Purge removes the release from the store and make its name free for later use.",
"type": "boolean"
},
"timeout": {
"description": "timeout specifies the max amount of time any kubernetes client command can run.",
"type": "integer"
}
},
"type": "object"
},
"v2UpdateReleaseRequest": {
"description": "UpdateReleaseRequest updates a release.",
"properties": {
"chart": {
"$ref": "#/definitions/chartChart",
"description": "Chart is the protobuf representation of a chart."
},
"chart_url": {
"title": "url to download char tar file @appscode",
"type": "string"
},
"disable_hooks": {
"description": "DisableHooks causes the server to skip running any hooks for the upgrade.",
"type": "boolean"
},
"dry_run": {
"title": "dry_run, if true, will run through the release logic, but neither create",
"type": "boolean"
},
"force": {
"description": "Force resource update through delete/recreate if needed.",
"type": "boolean"
},
"name": {
"maxLength": 63,
"pattern": "^[a-z0-9](?:[a-z0-9\\-]{0,61}[a-z0-9])?$",
"title": "The name of the release",
"type": "string"
},
"recreate": {
"title": "Performs pods restart for resources if applicable",
"type": "boolean"
},
"reset_values": {
"description": "ResetValues will cause Tiller to ignore stored values, resetting to default values.",
"type": "boolean"
},
"reuse_values": {
"description": "ReuseValues will cause Tiller to reuse the values from the last release.\nThis is ignored if reset_values is set.",
"type": "boolean"
},
"timeout": {
"description": "timeout specifies the max amount of time any kubernetes client command can run.",
"type": "integer"
},
"values": {
"$ref": "#/definitions/chartConfig",
"description": "Values is a string containing (unparsed) YAML values."
},
"wait": {
"title": "wait, if true, will wait until all Pods, PVCs, and Services are in a ready state\nbefore marking the release as successful. It will wait for as long as timeout",
"type": "boolean"
}
},
"type": "object"
}
}
}