@cloudfleet/sdk 0.0.1-830b4e3 → 0.0.1-8608ef2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -2
- package/dist/@tanstack/react-query.gen.d.ts +1026 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1194 -0
- package/dist/@tanstack/react-query.gen.js.map +1 -0
- package/dist/client/client.gen.d.ts +3 -0
- package/dist/client/client.gen.d.ts.map +1 -0
- package/dist/client/client.gen.js +217 -0
- package/dist/client/client.gen.js.map +1 -0
- package/dist/client/index.d.ts +8 -7
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +6 -4
- package/dist/client/index.js.map +1 -1
- package/dist/client/{types.d.ts → types.gen.d.ts} +23 -22
- package/dist/client/types.gen.d.ts.map +1 -0
- package/dist/client/types.gen.js +3 -0
- package/dist/client/types.gen.js.map +1 -0
- package/dist/client/{utils.d.ts → utils.gen.d.ts} +17 -25
- package/dist/client/utils.gen.d.ts.map +1 -0
- package/dist/client/{utils.js → utils.gen.js} +66 -122
- package/dist/client/utils.gen.js.map +1 -0
- package/dist/client.gen.d.ts +3 -3
- package/dist/client.gen.d.ts.map +1 -1
- package/dist/client.gen.js +1 -3
- package/dist/client.gen.js.map +1 -1
- package/dist/core/{auth.d.ts → auth.gen.d.ts} +1 -1
- package/dist/core/auth.gen.d.ts.map +1 -0
- package/dist/core/{auth.js → auth.gen.js} +2 -1
- package/dist/core/auth.gen.js.map +1 -0
- package/dist/core/bodySerializer.gen.d.ts +26 -0
- package/dist/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/core/{bodySerializer.js → bodySerializer.gen.js} +6 -2
- package/dist/core/bodySerializer.gen.js.map +1 -0
- package/dist/core/{params.d.ts → params.gen.d.ts} +21 -1
- package/dist/core/params.gen.d.ts.map +1 -0
- package/dist/core/{params.js → params.gen.js} +24 -11
- package/dist/core/params.gen.js.map +1 -0
- package/dist/core/{pathSerializer.d.ts → pathSerializer.gen.d.ts} +1 -1
- package/dist/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/core/{pathSerializer.js → pathSerializer.gen.js} +5 -12
- package/dist/core/pathSerializer.gen.js.map +1 -0
- package/dist/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/core/queryKeySerializer.gen.js +93 -0
- package/dist/core/queryKeySerializer.gen.js.map +1 -0
- package/dist/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/core/serverSentEvents.gen.js +133 -0
- package/dist/core/serverSentEvents.gen.js.map +1 -0
- package/dist/core/{types.d.ts → types.gen.d.ts} +21 -16
- package/dist/core/types.gen.d.ts.map +1 -0
- package/dist/core/types.gen.js +3 -0
- package/dist/core/types.gen.js.map +1 -0
- package/dist/core/utils.gen.d.ts +20 -0
- package/dist/core/utils.gen.d.ts.map +1 -0
- package/dist/core/utils.gen.js +88 -0
- package/dist/core/utils.gen.js.map +1 -0
- package/dist/schemas.gen.d.ts +1764 -639
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +3159 -688
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +300 -161
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +423 -335
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +20 -20
- package/dist/types.gen.d.ts +1939 -841
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3947 -3751
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1478 -1151
- package/dist/zod.gen.js.map +1 -1
- package/package.json +28 -8
- package/dist/client/client.d.ts +0 -3
- package/dist/client/client.d.ts.map +0 -1
- package/dist/client/client.js +0 -144
- package/dist/client/client.js.map +0 -1
- package/dist/client/types.d.ts.map +0 -1
- package/dist/client/types.js +0 -2
- package/dist/client/types.js.map +0 -1
- package/dist/client/utils.d.ts.map +0 -1
- package/dist/client/utils.js.map +0 -1
- package/dist/core/auth.d.ts.map +0 -1
- package/dist/core/auth.js.map +0 -1
- package/dist/core/bodySerializer.d.ts +0 -18
- package/dist/core/bodySerializer.d.ts.map +0 -1
- package/dist/core/bodySerializer.js.map +0 -1
- package/dist/core/params.d.ts.map +0 -1
- package/dist/core/params.js.map +0 -1
- package/dist/core/pathSerializer.d.ts.map +0 -1
- package/dist/core/pathSerializer.js.map +0 -1
- package/dist/core/types.d.ts.map +0 -1
- package/dist/core/types.js +0 -2
- package/dist/core/types.js.map +0 -1
package/dist/schemas.gen.js
CHANGED
|
@@ -2,6 +2,15 @@
|
|
|
2
2
|
export const BillingContactSchema = {
|
|
3
3
|
type: 'object',
|
|
4
4
|
properties: {
|
|
5
|
+
type: {
|
|
6
|
+
type: 'string',
|
|
7
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
8
|
+
example: 'business',
|
|
9
|
+
enum: [
|
|
10
|
+
'business',
|
|
11
|
+
'personal'
|
|
12
|
+
]
|
|
13
|
+
},
|
|
5
14
|
company: {
|
|
6
15
|
type: 'string',
|
|
7
16
|
maxLength: 120,
|
|
@@ -58,15 +67,10 @@ export const BillingContactSchema = {
|
|
|
58
67
|
description: 'Email address used for billing as a string.',
|
|
59
68
|
example: 'email@example.com'
|
|
60
69
|
},
|
|
61
|
-
|
|
62
|
-
type: 'string',
|
|
63
|
-
description: 'First name of the billing contact person.',
|
|
64
|
-
example: 'John'
|
|
65
|
-
},
|
|
66
|
-
last_name: {
|
|
70
|
+
individual_name: {
|
|
67
71
|
type: 'string',
|
|
68
|
-
description: '
|
|
69
|
-
example: 'Doe'
|
|
72
|
+
description: 'Name of the billing contact person.',
|
|
73
|
+
example: 'John Doe'
|
|
70
74
|
},
|
|
71
75
|
tax_id: {
|
|
72
76
|
type: 'string',
|
|
@@ -79,10 +83,143 @@ export const BillingContactSchema = {
|
|
|
79
83
|
nullable: true,
|
|
80
84
|
description: 'Type of the tax ID.',
|
|
81
85
|
example: 'de_vat',
|
|
82
|
-
enum: [
|
|
86
|
+
enum: [
|
|
87
|
+
'ad_nrt',
|
|
88
|
+
'ae_trn',
|
|
89
|
+
'al_tin',
|
|
90
|
+
'am_tin',
|
|
91
|
+
'ao_tin',
|
|
92
|
+
'ar_cuit',
|
|
93
|
+
'at_vat',
|
|
94
|
+
'au_abn',
|
|
95
|
+
'au_arn',
|
|
96
|
+
'ba_tin',
|
|
97
|
+
'bb_tin',
|
|
98
|
+
'be_vat',
|
|
99
|
+
'bg_uic',
|
|
100
|
+
'bg_vat',
|
|
101
|
+
'bh_vat',
|
|
102
|
+
'bo_tin',
|
|
103
|
+
'br_cnpj',
|
|
104
|
+
'br_cpf',
|
|
105
|
+
'bs_tin',
|
|
106
|
+
'by_tin',
|
|
107
|
+
'ca_bn',
|
|
108
|
+
'ca_gst_hst',
|
|
109
|
+
'ca_pst_bc',
|
|
110
|
+
'ca_pst_mb',
|
|
111
|
+
'ca_pst_sk',
|
|
112
|
+
'ca_qst',
|
|
113
|
+
'cd_nif',
|
|
114
|
+
'ch_uid',
|
|
115
|
+
'ch_vat',
|
|
116
|
+
'cl_tin',
|
|
117
|
+
'cn_tin',
|
|
118
|
+
'co_nit',
|
|
119
|
+
'cr_tin',
|
|
120
|
+
'cy_vat',
|
|
121
|
+
'cz_vat',
|
|
122
|
+
'de_stn',
|
|
123
|
+
'de_vat',
|
|
124
|
+
'dk_vat',
|
|
125
|
+
'do_rcn',
|
|
126
|
+
'ec_ruc',
|
|
127
|
+
'ee_vat',
|
|
128
|
+
'eg_tin',
|
|
129
|
+
'es_cif',
|
|
130
|
+
'es_vat',
|
|
131
|
+
'eu_oss_vat',
|
|
132
|
+
'fi_vat',
|
|
133
|
+
'fr_vat',
|
|
134
|
+
'gb_vat',
|
|
135
|
+
'ge_vat',
|
|
136
|
+
'gn_nif',
|
|
137
|
+
'gr_vat',
|
|
138
|
+
'hk_br',
|
|
139
|
+
'hr_oib',
|
|
140
|
+
'hr_vat',
|
|
141
|
+
'hu_tin',
|
|
142
|
+
'hu_vat',
|
|
143
|
+
'id_npwp',
|
|
144
|
+
'ie_vat',
|
|
145
|
+
'il_vat',
|
|
146
|
+
'in_gst',
|
|
147
|
+
'is_vat',
|
|
148
|
+
'it_vat',
|
|
149
|
+
'jp_cn',
|
|
150
|
+
'jp_rn',
|
|
151
|
+
'jp_trn',
|
|
152
|
+
'ke_pin',
|
|
153
|
+
'kh_tin',
|
|
154
|
+
'kr_brn',
|
|
155
|
+
'kz_bin',
|
|
156
|
+
'li_uid',
|
|
157
|
+
'li_vat',
|
|
158
|
+
'lt_vat',
|
|
159
|
+
'lu_vat',
|
|
160
|
+
'lv_vat',
|
|
161
|
+
'ma_vat',
|
|
162
|
+
'md_vat',
|
|
163
|
+
'me_pib',
|
|
164
|
+
'mk_vat',
|
|
165
|
+
'mr_nif',
|
|
166
|
+
'mt_vat',
|
|
167
|
+
'mx_rfc',
|
|
168
|
+
'my_frp',
|
|
169
|
+
'my_itn',
|
|
170
|
+
'my_sst',
|
|
171
|
+
'ng_tin',
|
|
172
|
+
'nl_vat',
|
|
173
|
+
'no_vat',
|
|
174
|
+
'no_voec',
|
|
175
|
+
'np_pan',
|
|
176
|
+
'nz_gst',
|
|
177
|
+
'om_vat',
|
|
178
|
+
'pe_ruc',
|
|
179
|
+
'ph_tin',
|
|
180
|
+
'pl_vat',
|
|
181
|
+
'pt_vat',
|
|
182
|
+
'ro_tin',
|
|
183
|
+
'ro_vat',
|
|
184
|
+
'rs_pib',
|
|
185
|
+
'ru_inn',
|
|
186
|
+
'ru_kpp',
|
|
187
|
+
'sa_vat',
|
|
188
|
+
'se_vat',
|
|
189
|
+
'sg_gst',
|
|
190
|
+
'sg_uen',
|
|
191
|
+
'si_tin',
|
|
192
|
+
'si_vat',
|
|
193
|
+
'sk_vat',
|
|
194
|
+
'sn_ninea',
|
|
195
|
+
'sr_fin',
|
|
196
|
+
'sv_nit',
|
|
197
|
+
'th_vat',
|
|
198
|
+
'tj_tin',
|
|
199
|
+
'tr_tin',
|
|
200
|
+
'tw_vat',
|
|
201
|
+
'tz_vat',
|
|
202
|
+
'ua_vat',
|
|
203
|
+
'ug_tin',
|
|
204
|
+
'us_ein',
|
|
205
|
+
'uy_ruc',
|
|
206
|
+
'uz_tin',
|
|
207
|
+
'uz_vat',
|
|
208
|
+
've_rif',
|
|
209
|
+
'vn_tin',
|
|
210
|
+
'xi_vat',
|
|
211
|
+
'za_vat',
|
|
212
|
+
'zm_tin',
|
|
213
|
+
'zw_tin',
|
|
214
|
+
''
|
|
215
|
+
]
|
|
83
216
|
}
|
|
84
217
|
},
|
|
85
|
-
required: [
|
|
218
|
+
required: [
|
|
219
|
+
'type',
|
|
220
|
+
'email',
|
|
221
|
+
'individual_name'
|
|
222
|
+
],
|
|
86
223
|
additionalProperties: false
|
|
87
224
|
};
|
|
88
225
|
export const BillingCreditsSchema = {
|
|
@@ -93,10 +230,25 @@ export const BillingCreditsSchema = {
|
|
|
93
230
|
description: 'Generated unique identifier of the promotional code.',
|
|
94
231
|
example: '7kUZnH7nnKUFfvc4NK2KQF'
|
|
95
232
|
},
|
|
96
|
-
|
|
233
|
+
type: {
|
|
234
|
+
type: 'string',
|
|
235
|
+
description: 'Type of the promotional code.',
|
|
236
|
+
example: 'credit',
|
|
237
|
+
enum: [
|
|
238
|
+
'credit',
|
|
239
|
+
'discount'
|
|
240
|
+
]
|
|
241
|
+
},
|
|
242
|
+
date_start: {
|
|
243
|
+
type: 'string',
|
|
244
|
+
format: 'date-time',
|
|
245
|
+
description: 'Timestamp when the credit becomes active. ISO 8601 date string in the UTC timezone.',
|
|
246
|
+
example: '2023-12-20T13:53:32.000Z'
|
|
247
|
+
},
|
|
248
|
+
date_end: {
|
|
97
249
|
type: 'string',
|
|
98
250
|
format: 'date-time',
|
|
99
|
-
description: '
|
|
251
|
+
description: 'Timestamp when the credit expires or becomes inactive. ISO 8601 date string in the UTC timezone.',
|
|
100
252
|
example: '2023-12-20T13:53:32.000Z'
|
|
101
253
|
},
|
|
102
254
|
code: {
|
|
@@ -109,40 +261,25 @@ export const BillingCreditsSchema = {
|
|
|
109
261
|
description: 'Description of the promotional code.',
|
|
110
262
|
example: '10% off on all products'
|
|
111
263
|
},
|
|
112
|
-
|
|
113
|
-
type: 'array',
|
|
114
|
-
items: {
|
|
115
|
-
type: 'string'
|
|
116
|
-
},
|
|
117
|
-
description: 'List of product SKUs that the promotional code can be used on.',
|
|
118
|
-
example: ['cfke_controlplane', 'cfke_connected_nodes', 'infra_compute', 'infra_storage', 'infra_loadbalancing', 'infra_traffic', 'cfcr_storage']
|
|
119
|
-
},
|
|
120
|
-
type: {
|
|
121
|
-
type: 'string',
|
|
122
|
-
description: 'Type of the promotional code.',
|
|
123
|
-
example: 'credit',
|
|
124
|
-
enum: ['credit', 'discount']
|
|
125
|
-
},
|
|
126
|
-
value: {
|
|
264
|
+
value_total: {
|
|
127
265
|
type: 'number',
|
|
128
266
|
format: 'float',
|
|
129
|
-
description: '
|
|
267
|
+
description: 'Total value of the promotional code.',
|
|
130
268
|
example: 10
|
|
131
269
|
},
|
|
132
|
-
billing_period: {
|
|
133
|
-
type: 'string',
|
|
134
|
-
format: 'date-time',
|
|
135
|
-
description: 'Date of the billing cycle. An ISO 8601 date string in the UTC timezone.',
|
|
136
|
-
example: '2023-12-20T13:53:32.000Z'
|
|
137
|
-
},
|
|
138
270
|
value_remaining: {
|
|
139
271
|
type: 'number',
|
|
140
272
|
format: 'float',
|
|
141
|
-
description: '
|
|
142
|
-
example:
|
|
273
|
+
description: 'Remaining value of the promotional code.',
|
|
274
|
+
example: 8
|
|
143
275
|
}
|
|
144
276
|
},
|
|
145
|
-
required: [
|
|
277
|
+
required: [
|
|
278
|
+
'type',
|
|
279
|
+
'date_start',
|
|
280
|
+
'code',
|
|
281
|
+
'value_total'
|
|
282
|
+
],
|
|
146
283
|
additionalProperties: false
|
|
147
284
|
};
|
|
148
285
|
export const ChartCreateInputSchema = {
|
|
@@ -183,7 +320,13 @@ export const ChartCreateInputSchema = {
|
|
|
183
320
|
example: 'postgresql'
|
|
184
321
|
}
|
|
185
322
|
},
|
|
186
|
-
required: [
|
|
323
|
+
required: [
|
|
324
|
+
'values',
|
|
325
|
+
'version_channel',
|
|
326
|
+
'name',
|
|
327
|
+
'namespace',
|
|
328
|
+
'chart'
|
|
329
|
+
],
|
|
187
330
|
additionalProperties: false
|
|
188
331
|
};
|
|
189
332
|
export const ChartSchema = {
|
|
@@ -225,9 +368,8 @@ export const ChartSchema = {
|
|
|
225
368
|
},
|
|
226
369
|
status: {
|
|
227
370
|
type: 'string',
|
|
228
|
-
description: 'Status of the chart deployment.',
|
|
229
|
-
example: '
|
|
230
|
-
enum: ['InstallSucceeded', 'InstallFailed', 'UpgradeSucceeded', 'UpgradeFailed', 'TestSucceeded', 'TestFailed', 'RollbackSucceeded', 'RollbackFailed', 'UninstallSucceeded', 'UninstallFailed', 'ArtifactFailed', 'DependencyNotReady', 'Progressing', 'SourceNotReady']
|
|
371
|
+
description: 'Status of the chart deployment (Flux HelmRelease Ready condition reason, e.g. InstallSucceeded, UpgradeFailed, Progressing).',
|
|
372
|
+
example: 'InstallSucceeded'
|
|
231
373
|
},
|
|
232
374
|
version_current: {
|
|
233
375
|
type: 'string',
|
|
@@ -250,7 +392,18 @@ export const ChartSchema = {
|
|
|
250
392
|
example: true
|
|
251
393
|
}
|
|
252
394
|
},
|
|
253
|
-
required: [
|
|
395
|
+
required: [
|
|
396
|
+
'values',
|
|
397
|
+
'version_channel',
|
|
398
|
+
'name',
|
|
399
|
+
'namespace',
|
|
400
|
+
'chart',
|
|
401
|
+
'status',
|
|
402
|
+
'version_current',
|
|
403
|
+
'created_at',
|
|
404
|
+
'updated_at',
|
|
405
|
+
'ready'
|
|
406
|
+
],
|
|
254
407
|
additionalProperties: false
|
|
255
408
|
};
|
|
256
409
|
export const ChartUpdateInputSchema = {
|
|
@@ -267,7 +420,10 @@ export const ChartUpdateInputSchema = {
|
|
|
267
420
|
example: '2.x.x-cfke.x'
|
|
268
421
|
}
|
|
269
422
|
},
|
|
270
|
-
required: [
|
|
423
|
+
required: [
|
|
424
|
+
'values',
|
|
425
|
+
'version_channel'
|
|
426
|
+
],
|
|
271
427
|
additionalProperties: false
|
|
272
428
|
};
|
|
273
429
|
export const ClusterCreateInputSchema = {
|
|
@@ -284,26 +440,118 @@ export const ClusterCreateInputSchema = {
|
|
|
284
440
|
tier: {
|
|
285
441
|
type: 'string',
|
|
286
442
|
description: 'Tier of the cluster.',
|
|
443
|
+
default: 'basic',
|
|
287
444
|
example: 'pro',
|
|
288
|
-
enum: [
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
default: 'staging',
|
|
294
|
-
example: 'northamerica-central-1',
|
|
295
|
-
enum: ['staging', 'northamerica-central-1', 'europe-central-1a']
|
|
445
|
+
enum: [
|
|
446
|
+
'basic',
|
|
447
|
+
'pro',
|
|
448
|
+
'enterprise'
|
|
449
|
+
]
|
|
296
450
|
},
|
|
297
451
|
version_channel: {
|
|
298
452
|
type: 'string',
|
|
299
453
|
pattern: '^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$',
|
|
300
454
|
description: 'Version of the kubernetes cluster.',
|
|
301
455
|
default: '1.x.x-cfke.x',
|
|
302
|
-
example: '1.
|
|
456
|
+
example: '1.x.x-cfke.x'
|
|
457
|
+
},
|
|
458
|
+
release_channel: {
|
|
459
|
+
type: 'string',
|
|
460
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
461
|
+
default: 'rapid',
|
|
462
|
+
example: 'rapid',
|
|
463
|
+
enum: [
|
|
464
|
+
'rapid',
|
|
465
|
+
'stable',
|
|
466
|
+
'extended'
|
|
467
|
+
]
|
|
468
|
+
},
|
|
469
|
+
features: {
|
|
470
|
+
type: 'object',
|
|
471
|
+
properties: {
|
|
472
|
+
gpu_sharing_strategy: {
|
|
473
|
+
type: 'string',
|
|
474
|
+
description: 'GPU sharing strategy.',
|
|
475
|
+
default: 'none',
|
|
476
|
+
example: 'none',
|
|
477
|
+
enum: [
|
|
478
|
+
'none',
|
|
479
|
+
'mps',
|
|
480
|
+
'time_slicing'
|
|
481
|
+
]
|
|
482
|
+
},
|
|
483
|
+
gpu_max_shared_clients_per_gpu: {
|
|
484
|
+
type: 'integer',
|
|
485
|
+
minimum: 2,
|
|
486
|
+
maximum: 48,
|
|
487
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
488
|
+
default: 4,
|
|
489
|
+
example: 10
|
|
490
|
+
},
|
|
491
|
+
cilium_socket_lb_host_namespace_only: {
|
|
492
|
+
type: 'boolean',
|
|
493
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
494
|
+
example: false
|
|
495
|
+
}
|
|
496
|
+
},
|
|
497
|
+
additionalProperties: false,
|
|
498
|
+
description: 'Cluster feature toggles.',
|
|
499
|
+
default: {
|
|
500
|
+
gpu_sharing_strategy: 'none',
|
|
501
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
502
|
+
cilium_socket_lb_host_namespace_only: false
|
|
503
|
+
}
|
|
504
|
+
},
|
|
505
|
+
region: {
|
|
506
|
+
type: 'string',
|
|
507
|
+
description: 'Cloudfleet control plane region. This field can not be updated after creation.',
|
|
508
|
+
example: 'europe-central-1a'
|
|
509
|
+
},
|
|
510
|
+
networking: {
|
|
511
|
+
type: 'object',
|
|
512
|
+
properties: {
|
|
513
|
+
pod_cidr: {
|
|
514
|
+
type: 'string',
|
|
515
|
+
description: 'CIDR block for pod IPs.',
|
|
516
|
+
default: '10.244.0.0/16'
|
|
517
|
+
},
|
|
518
|
+
service_cidr: {
|
|
519
|
+
type: 'string',
|
|
520
|
+
description: 'CIDR block for service IPs.',
|
|
521
|
+
default: '10.96.0.0/12'
|
|
522
|
+
},
|
|
523
|
+
dual_stack: {
|
|
524
|
+
type: 'boolean',
|
|
525
|
+
description: 'Enable IPv4+IPv6 dual-stack networking.'
|
|
526
|
+
},
|
|
527
|
+
pod_cidr_v6: {
|
|
528
|
+
type: 'string',
|
|
529
|
+
description: 'IPv6 pod CIDR. Requires dual_stack.',
|
|
530
|
+
default: '2001:db8:1:2::/48'
|
|
531
|
+
},
|
|
532
|
+
service_cidr_v6: {
|
|
533
|
+
type: 'string',
|
|
534
|
+
description: 'IPv6 service CIDR. Requires dual_stack.',
|
|
535
|
+
default: '2001:db8:1:1::/112'
|
|
536
|
+
}
|
|
537
|
+
},
|
|
538
|
+
additionalProperties: false,
|
|
539
|
+
description: 'Cluster networking configuration. Immutable after creation.',
|
|
540
|
+
default: {
|
|
541
|
+
pod_cidr: '10.244.0.0/16',
|
|
542
|
+
service_cidr: '10.96.0.0/12',
|
|
543
|
+
dual_stack: false,
|
|
544
|
+
pod_cidr_v6: '2001:db8:1:2::/48',
|
|
545
|
+
service_cidr_v6: '2001:db8:1:1::/112'
|
|
546
|
+
}
|
|
303
547
|
}
|
|
304
548
|
},
|
|
305
|
-
required: [
|
|
306
|
-
|
|
549
|
+
required: [
|
|
550
|
+
'name',
|
|
551
|
+
'region'
|
|
552
|
+
],
|
|
553
|
+
additionalProperties: false,
|
|
554
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
307
555
|
};
|
|
308
556
|
export const ClusterJoinInformationSchema = {
|
|
309
557
|
type: 'object',
|
|
@@ -311,8 +559,7 @@ export const ClusterJoinInformationSchema = {
|
|
|
311
559
|
certificate_authority: {
|
|
312
560
|
type: 'string',
|
|
313
561
|
description: 'Certificate authority data for the kubernetes cluster. This is the root certificate authority for the cluster.',
|
|
314
|
-
example:
|
|
315
|
-
MIIC0DCCAbigAwIBAgI...`
|
|
562
|
+
example: '-----BEGIN CERTIFICATE-----\nMIIC0DCCAbigAwIBAgI...'
|
|
316
563
|
},
|
|
317
564
|
endpoint: {
|
|
318
565
|
type: 'string',
|
|
@@ -320,11 +567,26 @@ MIIC0DCCAbigAwIBAgI...`
|
|
|
320
567
|
description: 'Internal URL of the Kubernetes cluster control plane. This is the endpoint that kubelet uses to connect to the cluster.',
|
|
321
568
|
example: 'https://10.31.64.7:6443'
|
|
322
569
|
},
|
|
570
|
+
cluster_dns: {
|
|
571
|
+
type: 'string',
|
|
572
|
+
description: 'Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.',
|
|
573
|
+
example: '10.96.0.10'
|
|
574
|
+
},
|
|
575
|
+
pod_cidr: {
|
|
576
|
+
type: 'string',
|
|
577
|
+
description: 'Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.',
|
|
578
|
+
example: '10.244.0.0/16'
|
|
579
|
+
},
|
|
323
580
|
auth_key: {
|
|
324
581
|
type: 'string',
|
|
325
582
|
description: 'Authentication key for the cluster.',
|
|
326
583
|
example: 'tskey-auth-kBV8wr1dk911CNTRL-...'
|
|
327
584
|
},
|
|
585
|
+
login_server: {
|
|
586
|
+
type: 'string',
|
|
587
|
+
description: 'Coordination server the node registers against. Empty on data plane v1 clusters, where the node advertises its own tag instead. A non-empty value requires a client that declares the dataplane-v2 capability.',
|
|
588
|
+
example: 'https://415026b6-f00f-44f8-968d-fc6ef4d0fc6d.fabric.europe-central-1a.cfke.io'
|
|
589
|
+
},
|
|
328
590
|
bootstrap_token: {
|
|
329
591
|
type: 'string',
|
|
330
592
|
description: 'Bootstrap token for the cluster.',
|
|
@@ -336,7 +598,7 @@ MIIC0DCCAbigAwIBAgI...`
|
|
|
336
598
|
kubernetes: {
|
|
337
599
|
type: 'string',
|
|
338
600
|
description: 'Kubernetes version of the cluster.',
|
|
339
|
-
example: '1.
|
|
601
|
+
example: '1.33.7'
|
|
340
602
|
},
|
|
341
603
|
tailscale: {
|
|
342
604
|
type: 'string',
|
|
@@ -354,7 +616,12 @@ MIIC0DCCAbigAwIBAgI...`
|
|
|
354
616
|
example: '565.0.0'
|
|
355
617
|
}
|
|
356
618
|
},
|
|
357
|
-
required: [
|
|
619
|
+
required: [
|
|
620
|
+
'kubernetes',
|
|
621
|
+
'tailscale',
|
|
622
|
+
'containerd',
|
|
623
|
+
'nvidia_driver'
|
|
624
|
+
],
|
|
358
625
|
additionalProperties: false,
|
|
359
626
|
description: 'Versions of the different components of the cluster.'
|
|
360
627
|
},
|
|
@@ -377,12 +644,26 @@ MIIC0DCCAbigAwIBAgI...`
|
|
|
377
644
|
example: '//iam.googleapis.com/projects/89014267864/locations/global/workloadIdentityPools/cfke/providers/oidc'
|
|
378
645
|
}
|
|
379
646
|
},
|
|
380
|
-
required: [
|
|
647
|
+
required: [
|
|
648
|
+
'metadata_url',
|
|
649
|
+
'aws_role_arn',
|
|
650
|
+
'gcp_workload_identity_provider'
|
|
651
|
+
],
|
|
381
652
|
additionalProperties: false,
|
|
382
|
-
description:
|
|
653
|
+
description: 'OIDC Information for hosts to access to third party API\'s.'
|
|
383
654
|
}
|
|
384
655
|
},
|
|
385
|
-
required: [
|
|
656
|
+
required: [
|
|
657
|
+
'certificate_authority',
|
|
658
|
+
'endpoint',
|
|
659
|
+
'cluster_dns',
|
|
660
|
+
'pod_cidr',
|
|
661
|
+
'auth_key',
|
|
662
|
+
'login_server',
|
|
663
|
+
'bootstrap_token',
|
|
664
|
+
'versions',
|
|
665
|
+
'third_party_api_access_config'
|
|
666
|
+
],
|
|
386
667
|
additionalProperties: false
|
|
387
668
|
};
|
|
388
669
|
export const ClusterSchema = {
|
|
@@ -399,22 +680,122 @@ export const ClusterSchema = {
|
|
|
399
680
|
tier: {
|
|
400
681
|
type: 'string',
|
|
401
682
|
description: 'Tier of the cluster.',
|
|
683
|
+
default: 'basic',
|
|
402
684
|
example: 'pro',
|
|
403
|
-
enum: [
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
default: 'staging',
|
|
409
|
-
example: 'northamerica-central-1',
|
|
410
|
-
enum: ['staging', 'northamerica-central-1', 'europe-central-1a']
|
|
685
|
+
enum: [
|
|
686
|
+
'basic',
|
|
687
|
+
'pro',
|
|
688
|
+
'enterprise'
|
|
689
|
+
]
|
|
411
690
|
},
|
|
412
691
|
version_channel: {
|
|
413
692
|
type: 'string',
|
|
414
693
|
pattern: '^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$',
|
|
415
694
|
description: 'Version of the kubernetes cluster.',
|
|
416
695
|
default: '1.x.x-cfke.x',
|
|
417
|
-
example: '1.
|
|
696
|
+
example: '1.x.x-cfke.x'
|
|
697
|
+
},
|
|
698
|
+
release_channel: {
|
|
699
|
+
type: 'string',
|
|
700
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
701
|
+
default: 'rapid',
|
|
702
|
+
example: 'rapid',
|
|
703
|
+
enum: [
|
|
704
|
+
'rapid',
|
|
705
|
+
'stable',
|
|
706
|
+
'extended'
|
|
707
|
+
]
|
|
708
|
+
},
|
|
709
|
+
features: {
|
|
710
|
+
type: 'object',
|
|
711
|
+
properties: {
|
|
712
|
+
gpu_sharing_strategy: {
|
|
713
|
+
type: 'string',
|
|
714
|
+
description: 'GPU sharing strategy.',
|
|
715
|
+
default: 'none',
|
|
716
|
+
example: 'none',
|
|
717
|
+
enum: [
|
|
718
|
+
'none',
|
|
719
|
+
'mps',
|
|
720
|
+
'time_slicing'
|
|
721
|
+
]
|
|
722
|
+
},
|
|
723
|
+
gpu_max_shared_clients_per_gpu: {
|
|
724
|
+
type: 'integer',
|
|
725
|
+
minimum: 2,
|
|
726
|
+
maximum: 48,
|
|
727
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
728
|
+
default: 4,
|
|
729
|
+
example: 10
|
|
730
|
+
},
|
|
731
|
+
cilium_socket_lb_host_namespace_only: {
|
|
732
|
+
type: 'boolean',
|
|
733
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
734
|
+
example: false
|
|
735
|
+
}
|
|
736
|
+
},
|
|
737
|
+
required: [
|
|
738
|
+
'gpu_sharing_strategy',
|
|
739
|
+
'gpu_max_shared_clients_per_gpu',
|
|
740
|
+
'cilium_socket_lb_host_namespace_only'
|
|
741
|
+
],
|
|
742
|
+
additionalProperties: false,
|
|
743
|
+
description: 'Cluster feature toggles.',
|
|
744
|
+
default: {
|
|
745
|
+
gpu_sharing_strategy: 'none',
|
|
746
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
747
|
+
cilium_socket_lb_host_namespace_only: false
|
|
748
|
+
}
|
|
749
|
+
},
|
|
750
|
+
region: {
|
|
751
|
+
type: 'string',
|
|
752
|
+
description: 'Cloudfleet control plane region. This field can not be updated after creation.',
|
|
753
|
+
example: 'europe-central-1a'
|
|
754
|
+
},
|
|
755
|
+
networking: {
|
|
756
|
+
type: 'object',
|
|
757
|
+
properties: {
|
|
758
|
+
pod_cidr: {
|
|
759
|
+
type: 'string',
|
|
760
|
+
description: 'CIDR block for pod IPs.',
|
|
761
|
+
default: '10.244.0.0/16'
|
|
762
|
+
},
|
|
763
|
+
service_cidr: {
|
|
764
|
+
type: 'string',
|
|
765
|
+
description: 'CIDR block for service IPs.',
|
|
766
|
+
default: '10.96.0.0/12'
|
|
767
|
+
},
|
|
768
|
+
dual_stack: {
|
|
769
|
+
type: 'boolean',
|
|
770
|
+
description: 'Enable IPv4+IPv6 dual-stack networking.'
|
|
771
|
+
},
|
|
772
|
+
pod_cidr_v6: {
|
|
773
|
+
type: 'string',
|
|
774
|
+
description: 'IPv6 pod CIDR. Requires dual_stack.',
|
|
775
|
+
default: '2001:db8:1:2::/48'
|
|
776
|
+
},
|
|
777
|
+
service_cidr_v6: {
|
|
778
|
+
type: 'string',
|
|
779
|
+
description: 'IPv6 service CIDR. Requires dual_stack.',
|
|
780
|
+
default: '2001:db8:1:1::/112'
|
|
781
|
+
}
|
|
782
|
+
},
|
|
783
|
+
required: [
|
|
784
|
+
'pod_cidr',
|
|
785
|
+
'service_cidr',
|
|
786
|
+
'dual_stack',
|
|
787
|
+
'pod_cidr_v6',
|
|
788
|
+
'service_cidr_v6'
|
|
789
|
+
],
|
|
790
|
+
additionalProperties: false,
|
|
791
|
+
description: 'Cluster networking configuration. Immutable after creation.',
|
|
792
|
+
default: {
|
|
793
|
+
pod_cidr: '10.244.0.0/16',
|
|
794
|
+
service_cidr: '10.96.0.0/12',
|
|
795
|
+
dual_stack: false,
|
|
796
|
+
pod_cidr_v6: '2001:db8:1:2::/48',
|
|
797
|
+
service_cidr_v6: '2001:db8:1:1::/112'
|
|
798
|
+
}
|
|
418
799
|
},
|
|
419
800
|
id: {
|
|
420
801
|
type: 'string',
|
|
@@ -424,34 +805,56 @@ export const ClusterSchema = {
|
|
|
424
805
|
},
|
|
425
806
|
status: {
|
|
426
807
|
type: 'string',
|
|
427
|
-
description: 'Status of the cluster.
|
|
428
|
-
example: '
|
|
429
|
-
enum: [
|
|
808
|
+
description: 'Status of the cluster.',
|
|
809
|
+
example: 'deployed',
|
|
810
|
+
enum: [
|
|
811
|
+
'creating',
|
|
812
|
+
'deployed',
|
|
813
|
+
'updating',
|
|
814
|
+
'disabled'
|
|
815
|
+
]
|
|
430
816
|
},
|
|
431
817
|
endpoint: {
|
|
432
818
|
anyOf: [
|
|
433
819
|
{
|
|
434
820
|
type: 'string',
|
|
435
821
|
format: 'uri',
|
|
436
|
-
description: 'URL of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.',
|
|
437
|
-
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
822
|
+
description: 'URL signed by a public CA of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.',
|
|
823
|
+
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
824
|
+
},
|
|
825
|
+
{
|
|
826
|
+
type: 'string',
|
|
827
|
+
enum: [
|
|
828
|
+
''
|
|
829
|
+
]
|
|
830
|
+
}
|
|
831
|
+
]
|
|
832
|
+
},
|
|
833
|
+
endpoint_public: {
|
|
834
|
+
anyOf: [
|
|
835
|
+
{
|
|
836
|
+
type: 'string',
|
|
837
|
+
format: 'uri',
|
|
838
|
+
description: 'Deprecated alias of `endpoint`; retained for backward compatibility.',
|
|
839
|
+
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
438
840
|
},
|
|
439
841
|
{
|
|
440
842
|
type: 'string',
|
|
441
|
-
enum: [
|
|
843
|
+
enum: [
|
|
844
|
+
''
|
|
845
|
+
]
|
|
442
846
|
}
|
|
443
847
|
]
|
|
444
848
|
},
|
|
445
849
|
certificate_ca: {
|
|
446
850
|
type: 'string',
|
|
447
851
|
description: 'Certificate authority data for the kubernetes cluster. This is the root certificate authority for the cluster.',
|
|
448
|
-
example:
|
|
449
|
-
MIIC0DCCAbigAwIBAgI...`
|
|
852
|
+
example: '-----BEGIN CERTIFICATE-----\nMIIC0DCCAbigAwIBAgI...'
|
|
450
853
|
},
|
|
451
854
|
version_current: {
|
|
452
855
|
type: 'string',
|
|
453
856
|
description: 'Current version of the cluster.',
|
|
454
|
-
example: '1.
|
|
857
|
+
example: '1.33.7-cfke.264'
|
|
455
858
|
},
|
|
456
859
|
created_at: {
|
|
457
860
|
type: 'string',
|
|
@@ -469,8 +872,20 @@ MIIC0DCCAbigAwIBAgI...`
|
|
|
469
872
|
example: true
|
|
470
873
|
}
|
|
471
874
|
},
|
|
472
|
-
required: [
|
|
473
|
-
|
|
875
|
+
required: [
|
|
876
|
+
'name',
|
|
877
|
+
'tier',
|
|
878
|
+
'version_channel',
|
|
879
|
+
'release_channel',
|
|
880
|
+
'features',
|
|
881
|
+
'region',
|
|
882
|
+
'networking',
|
|
883
|
+
'id',
|
|
884
|
+
'status',
|
|
885
|
+
'ready'
|
|
886
|
+
],
|
|
887
|
+
additionalProperties: false,
|
|
888
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
474
889
|
};
|
|
475
890
|
export const ClusterUpdateInputSchema = {
|
|
476
891
|
type: 'object',
|
|
@@ -486,18 +901,74 @@ export const ClusterUpdateInputSchema = {
|
|
|
486
901
|
tier: {
|
|
487
902
|
type: 'string',
|
|
488
903
|
description: 'Tier of the cluster.',
|
|
904
|
+
default: 'basic',
|
|
489
905
|
example: 'pro',
|
|
490
|
-
enum: [
|
|
906
|
+
enum: [
|
|
907
|
+
'basic',
|
|
908
|
+
'pro',
|
|
909
|
+
'enterprise'
|
|
910
|
+
]
|
|
491
911
|
},
|
|
492
912
|
version_channel: {
|
|
493
913
|
type: 'string',
|
|
494
914
|
pattern: '^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$',
|
|
495
915
|
description: 'Version of the kubernetes cluster.',
|
|
496
|
-
|
|
916
|
+
default: '1.x.x-cfke.x',
|
|
917
|
+
example: '1.x.x-cfke.x'
|
|
918
|
+
},
|
|
919
|
+
release_channel: {
|
|
920
|
+
type: 'string',
|
|
921
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
922
|
+
default: 'rapid',
|
|
923
|
+
example: 'rapid',
|
|
924
|
+
enum: [
|
|
925
|
+
'rapid',
|
|
926
|
+
'stable',
|
|
927
|
+
'extended'
|
|
928
|
+
]
|
|
929
|
+
},
|
|
930
|
+
features: {
|
|
931
|
+
type: 'object',
|
|
932
|
+
properties: {
|
|
933
|
+
gpu_sharing_strategy: {
|
|
934
|
+
type: 'string',
|
|
935
|
+
description: 'GPU sharing strategy.',
|
|
936
|
+
default: 'none',
|
|
937
|
+
example: 'none',
|
|
938
|
+
enum: [
|
|
939
|
+
'none',
|
|
940
|
+
'mps',
|
|
941
|
+
'time_slicing'
|
|
942
|
+
]
|
|
943
|
+
},
|
|
944
|
+
gpu_max_shared_clients_per_gpu: {
|
|
945
|
+
type: 'integer',
|
|
946
|
+
minimum: 2,
|
|
947
|
+
maximum: 48,
|
|
948
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
949
|
+
default: 4,
|
|
950
|
+
example: 10
|
|
951
|
+
},
|
|
952
|
+
cilium_socket_lb_host_namespace_only: {
|
|
953
|
+
type: 'boolean',
|
|
954
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
955
|
+
example: false
|
|
956
|
+
}
|
|
957
|
+
},
|
|
958
|
+
additionalProperties: false,
|
|
959
|
+
description: 'Cluster feature toggles.',
|
|
960
|
+
default: {
|
|
961
|
+
gpu_sharing_strategy: 'none',
|
|
962
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
963
|
+
cilium_socket_lb_host_namespace_only: false
|
|
964
|
+
}
|
|
497
965
|
}
|
|
498
966
|
},
|
|
499
|
-
required: [
|
|
500
|
-
|
|
967
|
+
required: [
|
|
968
|
+
'name'
|
|
969
|
+
],
|
|
970
|
+
additionalProperties: false,
|
|
971
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
501
972
|
};
|
|
502
973
|
export const FleetCreateInputSchema = {
|
|
503
974
|
type: 'object',
|
|
@@ -506,13 +977,12 @@ export const FleetCreateInputSchema = {
|
|
|
506
977
|
type: 'object',
|
|
507
978
|
properties: {
|
|
508
979
|
cpu: {
|
|
509
|
-
type: '
|
|
510
|
-
format: 'float',
|
|
980
|
+
type: 'integer',
|
|
511
981
|
minimum: 0,
|
|
512
|
-
|
|
982
|
+
maximum: 100000,
|
|
983
|
+
description: 'CPU limit in cores. Maximum 100,000.'
|
|
513
984
|
}
|
|
514
985
|
},
|
|
515
|
-
required: ['cpu'],
|
|
516
986
|
additionalProperties: false,
|
|
517
987
|
description: 'Limits define a set of bounds for provisioning capacity.'
|
|
518
988
|
},
|
|
@@ -520,47 +990,396 @@ export const FleetCreateInputSchema = {
|
|
|
520
990
|
type: 'object',
|
|
521
991
|
properties: {
|
|
522
992
|
enabled: {
|
|
523
|
-
type: 'boolean'
|
|
524
|
-
default: true
|
|
993
|
+
type: 'boolean'
|
|
525
994
|
},
|
|
526
995
|
project: {
|
|
527
996
|
type: 'string',
|
|
528
|
-
|
|
997
|
+
pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
|
|
998
|
+
description: 'GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.',
|
|
999
|
+
example: 'my-cloudfleet-project'
|
|
529
1000
|
}
|
|
530
1001
|
},
|
|
531
|
-
required: [
|
|
1002
|
+
required: [
|
|
1003
|
+
'enabled'
|
|
1004
|
+
],
|
|
532
1005
|
additionalProperties: false
|
|
533
1006
|
},
|
|
534
1007
|
hetzner: {
|
|
535
1008
|
type: 'object',
|
|
536
1009
|
properties: {
|
|
537
1010
|
enabled: {
|
|
538
|
-
type: 'boolean'
|
|
539
|
-
default: true
|
|
1011
|
+
type: 'boolean'
|
|
540
1012
|
},
|
|
541
1013
|
apiKey: {
|
|
542
1014
|
type: 'string',
|
|
543
|
-
|
|
1015
|
+
maxLength: 64,
|
|
1016
|
+
minLength: 64,
|
|
1017
|
+
pattern: '^([A-Za-z0-9]{64}|\\*{64})$',
|
|
1018
|
+
description: 'Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.'
|
|
544
1019
|
}
|
|
545
1020
|
},
|
|
546
|
-
required: [
|
|
1021
|
+
required: [
|
|
1022
|
+
'enabled'
|
|
1023
|
+
],
|
|
547
1024
|
additionalProperties: false
|
|
548
1025
|
},
|
|
549
1026
|
aws: {
|
|
550
1027
|
type: 'object',
|
|
551
1028
|
properties: {
|
|
552
1029
|
enabled: {
|
|
553
|
-
type: 'boolean'
|
|
554
|
-
default: true
|
|
1030
|
+
type: 'boolean'
|
|
555
1031
|
},
|
|
556
1032
|
controllerRoleArn: {
|
|
557
1033
|
type: 'string',
|
|
558
|
-
|
|
1034
|
+
pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
|
|
1035
|
+
description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
|
|
1036
|
+
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
559
1037
|
}
|
|
560
1038
|
},
|
|
561
|
-
required: [
|
|
1039
|
+
required: [
|
|
1040
|
+
'enabled'
|
|
1041
|
+
],
|
|
562
1042
|
additionalProperties: false
|
|
563
1043
|
},
|
|
1044
|
+
constraints: {
|
|
1045
|
+
type: 'object',
|
|
1046
|
+
properties: {
|
|
1047
|
+
'karpenter.sh/capacity-type': {
|
|
1048
|
+
type: 'array',
|
|
1049
|
+
items: {
|
|
1050
|
+
type: 'string',
|
|
1051
|
+
enum: [
|
|
1052
|
+
'on-demand',
|
|
1053
|
+
'spot'
|
|
1054
|
+
]
|
|
1055
|
+
},
|
|
1056
|
+
minItems: 1,
|
|
1057
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1058
|
+
default: [
|
|
1059
|
+
'on-demand',
|
|
1060
|
+
'spot'
|
|
1061
|
+
]
|
|
1062
|
+
},
|
|
1063
|
+
'kubernetes.io/arch': {
|
|
1064
|
+
type: 'array',
|
|
1065
|
+
items: {
|
|
1066
|
+
type: 'string',
|
|
1067
|
+
enum: [
|
|
1068
|
+
'amd64',
|
|
1069
|
+
'arm64'
|
|
1070
|
+
]
|
|
1071
|
+
},
|
|
1072
|
+
minItems: 1,
|
|
1073
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1074
|
+
default: [
|
|
1075
|
+
'amd64'
|
|
1076
|
+
]
|
|
1077
|
+
},
|
|
1078
|
+
'cfke.io/instance-family': {
|
|
1079
|
+
type: 'array',
|
|
1080
|
+
items: {
|
|
1081
|
+
type: 'string',
|
|
1082
|
+
enum: [
|
|
1083
|
+
'a1',
|
|
1084
|
+
'a2',
|
|
1085
|
+
'a3',
|
|
1086
|
+
'a4',
|
|
1087
|
+
'c1',
|
|
1088
|
+
'c2',
|
|
1089
|
+
'c2d',
|
|
1090
|
+
'c3',
|
|
1091
|
+
'c3d',
|
|
1092
|
+
'c4',
|
|
1093
|
+
'c4a',
|
|
1094
|
+
'c4d',
|
|
1095
|
+
'c5',
|
|
1096
|
+
'c5a',
|
|
1097
|
+
'c5ad',
|
|
1098
|
+
'c5d',
|
|
1099
|
+
'c5n',
|
|
1100
|
+
'c6a',
|
|
1101
|
+
'c6g',
|
|
1102
|
+
'c6gd',
|
|
1103
|
+
'c6gn',
|
|
1104
|
+
'c6i',
|
|
1105
|
+
'c6id',
|
|
1106
|
+
'c6in',
|
|
1107
|
+
'c7a',
|
|
1108
|
+
'c7g',
|
|
1109
|
+
'c7gd',
|
|
1110
|
+
'c7gn',
|
|
1111
|
+
'c7i',
|
|
1112
|
+
'c7i-flex',
|
|
1113
|
+
'c8g',
|
|
1114
|
+
'c8gd',
|
|
1115
|
+
'cax',
|
|
1116
|
+
'ccx',
|
|
1117
|
+
'cpx',
|
|
1118
|
+
'cx',
|
|
1119
|
+
'd2',
|
|
1120
|
+
'd3',
|
|
1121
|
+
'd3en',
|
|
1122
|
+
'dl1',
|
|
1123
|
+
'dl2q',
|
|
1124
|
+
'e2',
|
|
1125
|
+
'f1',
|
|
1126
|
+
'f2',
|
|
1127
|
+
'g1',
|
|
1128
|
+
'g2',
|
|
1129
|
+
'g4ad',
|
|
1130
|
+
'g4dn',
|
|
1131
|
+
'g5',
|
|
1132
|
+
'g5g',
|
|
1133
|
+
'g6',
|
|
1134
|
+
'g6e',
|
|
1135
|
+
'gr6',
|
|
1136
|
+
'h1',
|
|
1137
|
+
'h3',
|
|
1138
|
+
'hpc6a',
|
|
1139
|
+
'hpc6id',
|
|
1140
|
+
'hpc7a',
|
|
1141
|
+
'hpc7g',
|
|
1142
|
+
'i2',
|
|
1143
|
+
'i3',
|
|
1144
|
+
'i3en',
|
|
1145
|
+
'i4g',
|
|
1146
|
+
'i4i',
|
|
1147
|
+
'i7i',
|
|
1148
|
+
'i7ie',
|
|
1149
|
+
'i8g',
|
|
1150
|
+
'im4gn',
|
|
1151
|
+
'inf1',
|
|
1152
|
+
'inf2',
|
|
1153
|
+
'is4gen',
|
|
1154
|
+
'm1',
|
|
1155
|
+
'm2',
|
|
1156
|
+
'm3',
|
|
1157
|
+
'm4',
|
|
1158
|
+
'm5',
|
|
1159
|
+
'm5a',
|
|
1160
|
+
'm5ad',
|
|
1161
|
+
'm5d',
|
|
1162
|
+
'm5dn',
|
|
1163
|
+
'm5n',
|
|
1164
|
+
'm5zn',
|
|
1165
|
+
'm6a',
|
|
1166
|
+
'm6g',
|
|
1167
|
+
'm6gd',
|
|
1168
|
+
'm6i',
|
|
1169
|
+
'm6id',
|
|
1170
|
+
'm6idn',
|
|
1171
|
+
'm6in',
|
|
1172
|
+
'm7a',
|
|
1173
|
+
'm7g',
|
|
1174
|
+
'm7gd',
|
|
1175
|
+
'm7i',
|
|
1176
|
+
'm7i-flex',
|
|
1177
|
+
'm8g',
|
|
1178
|
+
'm8gd',
|
|
1179
|
+
'n1',
|
|
1180
|
+
'n2',
|
|
1181
|
+
'n2d',
|
|
1182
|
+
'n4',
|
|
1183
|
+
'p3',
|
|
1184
|
+
'p3dn',
|
|
1185
|
+
'p4d',
|
|
1186
|
+
'p4de',
|
|
1187
|
+
'p5',
|
|
1188
|
+
'p5e',
|
|
1189
|
+
'p5en',
|
|
1190
|
+
'p6-b200',
|
|
1191
|
+
'r3',
|
|
1192
|
+
'r4',
|
|
1193
|
+
'r5',
|
|
1194
|
+
'r5a',
|
|
1195
|
+
'r5ad',
|
|
1196
|
+
'r5b',
|
|
1197
|
+
'r5d',
|
|
1198
|
+
'r5dn',
|
|
1199
|
+
'r5n',
|
|
1200
|
+
'r6a',
|
|
1201
|
+
'r6g',
|
|
1202
|
+
'r6gd',
|
|
1203
|
+
'r6i',
|
|
1204
|
+
'r6id',
|
|
1205
|
+
'r6idn',
|
|
1206
|
+
'r6in',
|
|
1207
|
+
'r7a',
|
|
1208
|
+
'r7g',
|
|
1209
|
+
'r7gd',
|
|
1210
|
+
'r7i',
|
|
1211
|
+
'r7iz',
|
|
1212
|
+
'r8g',
|
|
1213
|
+
'r8gd',
|
|
1214
|
+
't2',
|
|
1215
|
+
't2a',
|
|
1216
|
+
't2d',
|
|
1217
|
+
't3',
|
|
1218
|
+
't3a',
|
|
1219
|
+
't4g',
|
|
1220
|
+
'trn1',
|
|
1221
|
+
'trn1n',
|
|
1222
|
+
'u-3tb1',
|
|
1223
|
+
'u-6tb1',
|
|
1224
|
+
'u7i-12tb',
|
|
1225
|
+
'u7i-6tb',
|
|
1226
|
+
'u7i-8tb',
|
|
1227
|
+
'u7in-16tb',
|
|
1228
|
+
'u7in-24tb',
|
|
1229
|
+
'u7in-32tb',
|
|
1230
|
+
'vt1',
|
|
1231
|
+
'x1',
|
|
1232
|
+
'x1e',
|
|
1233
|
+
'x2gd',
|
|
1234
|
+
'x2idn',
|
|
1235
|
+
'x2iedn',
|
|
1236
|
+
'x2iezn',
|
|
1237
|
+
'x4',
|
|
1238
|
+
'x8g',
|
|
1239
|
+
'z1d',
|
|
1240
|
+
'z3'
|
|
1241
|
+
]
|
|
1242
|
+
},
|
|
1243
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
1244
|
+
default: []
|
|
1245
|
+
},
|
|
1246
|
+
'topology.kubernetes.io/region': {
|
|
1247
|
+
type: 'array',
|
|
1248
|
+
items: {
|
|
1249
|
+
type: 'string',
|
|
1250
|
+
enum: [
|
|
1251
|
+
'africa-south1',
|
|
1252
|
+
'ap-northeast-1',
|
|
1253
|
+
'ap-northeast-2',
|
|
1254
|
+
'ap-northeast-3',
|
|
1255
|
+
'ap-south-1',
|
|
1256
|
+
'ap-southeast-1',
|
|
1257
|
+
'ap-southeast-2',
|
|
1258
|
+
'ash',
|
|
1259
|
+
'asia-east1',
|
|
1260
|
+
'asia-east2',
|
|
1261
|
+
'asia-northeast1',
|
|
1262
|
+
'asia-northeast2',
|
|
1263
|
+
'asia-northeast3',
|
|
1264
|
+
'asia-south1',
|
|
1265
|
+
'asia-south2',
|
|
1266
|
+
'asia-southeast1',
|
|
1267
|
+
'asia-southeast2',
|
|
1268
|
+
'australia-southeast1',
|
|
1269
|
+
'australia-southeast2',
|
|
1270
|
+
'ca-central-1',
|
|
1271
|
+
'eu-central-1',
|
|
1272
|
+
'eu-central-2',
|
|
1273
|
+
'eu-north-1',
|
|
1274
|
+
'eu-west-1',
|
|
1275
|
+
'eu-west-2',
|
|
1276
|
+
'eu-west-3',
|
|
1277
|
+
'europe-central2',
|
|
1278
|
+
'europe-north1',
|
|
1279
|
+
'europe-southwest1',
|
|
1280
|
+
'europe-west1',
|
|
1281
|
+
'europe-west10',
|
|
1282
|
+
'europe-west12',
|
|
1283
|
+
'europe-west2',
|
|
1284
|
+
'europe-west3',
|
|
1285
|
+
'europe-west4',
|
|
1286
|
+
'europe-west6',
|
|
1287
|
+
'europe-west8',
|
|
1288
|
+
'europe-west9',
|
|
1289
|
+
'fsn1',
|
|
1290
|
+
'hel1',
|
|
1291
|
+
'hil',
|
|
1292
|
+
'me-central1',
|
|
1293
|
+
'me-central2',
|
|
1294
|
+
'me-west1',
|
|
1295
|
+
'nbg1',
|
|
1296
|
+
'northamerica-northeast1',
|
|
1297
|
+
'northamerica-northeast2',
|
|
1298
|
+
'sa-east-1',
|
|
1299
|
+
'sin',
|
|
1300
|
+
'southamerica-east1',
|
|
1301
|
+
'southamerica-west1',
|
|
1302
|
+
'us-central1',
|
|
1303
|
+
'us-east-1',
|
|
1304
|
+
'us-east-2',
|
|
1305
|
+
'us-east1',
|
|
1306
|
+
'us-east4',
|
|
1307
|
+
'us-east5',
|
|
1308
|
+
'us-south1',
|
|
1309
|
+
'us-west-1',
|
|
1310
|
+
'us-west-2',
|
|
1311
|
+
'us-west1',
|
|
1312
|
+
'us-west2',
|
|
1313
|
+
'us-west3',
|
|
1314
|
+
'us-west4'
|
|
1315
|
+
]
|
|
1316
|
+
},
|
|
1317
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
1318
|
+
default: []
|
|
1319
|
+
}
|
|
1320
|
+
},
|
|
1321
|
+
additionalProperties: false,
|
|
1322
|
+
description: 'Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.',
|
|
1323
|
+
default: {
|
|
1324
|
+
'karpenter.sh/capacity-type': [
|
|
1325
|
+
'on-demand',
|
|
1326
|
+
'spot'
|
|
1327
|
+
],
|
|
1328
|
+
'kubernetes.io/arch': [
|
|
1329
|
+
'amd64'
|
|
1330
|
+
],
|
|
1331
|
+
'cfke.io/instance-family': [],
|
|
1332
|
+
'topology.kubernetes.io/region': []
|
|
1333
|
+
}
|
|
1334
|
+
},
|
|
1335
|
+
scalingProfile: {
|
|
1336
|
+
type: 'string',
|
|
1337
|
+
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).',
|
|
1338
|
+
default: 'conservative',
|
|
1339
|
+
example: 'conservative',
|
|
1340
|
+
enum: [
|
|
1341
|
+
'aggressive',
|
|
1342
|
+
'conservative'
|
|
1343
|
+
]
|
|
1344
|
+
},
|
|
1345
|
+
taints: {
|
|
1346
|
+
type: 'array',
|
|
1347
|
+
items: {
|
|
1348
|
+
type: 'object',
|
|
1349
|
+
properties: {
|
|
1350
|
+
key: {
|
|
1351
|
+
type: 'string',
|
|
1352
|
+
description: 'Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.',
|
|
1353
|
+
example: 'dedicated'
|
|
1354
|
+
},
|
|
1355
|
+
value: {
|
|
1356
|
+
type: 'string',
|
|
1357
|
+
maxLength: 63,
|
|
1358
|
+
pattern: '^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$',
|
|
1359
|
+
description: 'Taint value. Optional.',
|
|
1360
|
+
example: 'ci'
|
|
1361
|
+
},
|
|
1362
|
+
effect: {
|
|
1363
|
+
type: 'string',
|
|
1364
|
+
description: 'Taint effect.',
|
|
1365
|
+
example: 'NoSchedule',
|
|
1366
|
+
enum: [
|
|
1367
|
+
'NoSchedule',
|
|
1368
|
+
'PreferNoSchedule',
|
|
1369
|
+
'NoExecute'
|
|
1370
|
+
]
|
|
1371
|
+
}
|
|
1372
|
+
},
|
|
1373
|
+
required: [
|
|
1374
|
+
'key',
|
|
1375
|
+
'effect'
|
|
1376
|
+
],
|
|
1377
|
+
additionalProperties: false
|
|
1378
|
+
},
|
|
1379
|
+
maxItems: 50,
|
|
1380
|
+
description: 'Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.',
|
|
1381
|
+
default: []
|
|
1382
|
+
},
|
|
564
1383
|
id: {
|
|
565
1384
|
type: 'string',
|
|
566
1385
|
maxLength: 63,
|
|
@@ -570,8 +1389,11 @@ export const FleetCreateInputSchema = {
|
|
|
570
1389
|
example: 'new-clouds-fleet'
|
|
571
1390
|
}
|
|
572
1391
|
},
|
|
573
|
-
required: [
|
|
574
|
-
|
|
1392
|
+
required: [
|
|
1393
|
+
'id'
|
|
1394
|
+
],
|
|
1395
|
+
additionalProperties: false,
|
|
1396
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
575
1397
|
};
|
|
576
1398
|
export const FleetSchema = {
|
|
577
1399
|
type: 'object',
|
|
@@ -580,13 +1402,12 @@ export const FleetSchema = {
|
|
|
580
1402
|
type: 'object',
|
|
581
1403
|
properties: {
|
|
582
1404
|
cpu: {
|
|
583
|
-
type: '
|
|
584
|
-
format: 'float',
|
|
1405
|
+
type: 'integer',
|
|
585
1406
|
minimum: 0,
|
|
586
|
-
|
|
1407
|
+
maximum: 100000,
|
|
1408
|
+
description: 'CPU limit in cores. Maximum 100,000.'
|
|
587
1409
|
}
|
|
588
1410
|
},
|
|
589
|
-
required: ['cpu'],
|
|
590
1411
|
additionalProperties: false,
|
|
591
1412
|
description: 'Limits define a set of bounds for provisioning capacity.'
|
|
592
1413
|
},
|
|
@@ -594,122 +1415,876 @@ export const FleetSchema = {
|
|
|
594
1415
|
type: 'object',
|
|
595
1416
|
properties: {
|
|
596
1417
|
enabled: {
|
|
597
|
-
type: 'boolean'
|
|
598
|
-
default: true
|
|
1418
|
+
type: 'boolean'
|
|
599
1419
|
},
|
|
600
1420
|
project: {
|
|
601
1421
|
type: 'string',
|
|
602
|
-
|
|
1422
|
+
pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
|
|
1423
|
+
description: 'GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.',
|
|
1424
|
+
example: 'my-cloudfleet-project'
|
|
603
1425
|
}
|
|
604
1426
|
},
|
|
605
|
-
required: [
|
|
1427
|
+
required: [
|
|
1428
|
+
'enabled'
|
|
1429
|
+
],
|
|
606
1430
|
additionalProperties: false
|
|
607
1431
|
},
|
|
608
1432
|
hetzner: {
|
|
609
1433
|
type: 'object',
|
|
610
1434
|
properties: {
|
|
611
1435
|
enabled: {
|
|
612
|
-
type: 'boolean'
|
|
613
|
-
default: true
|
|
1436
|
+
type: 'boolean'
|
|
614
1437
|
},
|
|
615
1438
|
apiKey: {
|
|
616
1439
|
type: 'string',
|
|
617
|
-
|
|
1440
|
+
pattern: '^\\*{64}$',
|
|
1441
|
+
description: 'Redacted Hetzner API token. Returned as 64 asterisks when a token is configured; omitted otherwise. The real value is never echoed by the API.'
|
|
618
1442
|
}
|
|
619
1443
|
},
|
|
620
|
-
required: [
|
|
1444
|
+
required: [
|
|
1445
|
+
'enabled'
|
|
1446
|
+
],
|
|
621
1447
|
additionalProperties: false
|
|
622
1448
|
},
|
|
623
1449
|
aws: {
|
|
624
1450
|
type: 'object',
|
|
625
1451
|
properties: {
|
|
626
1452
|
enabled: {
|
|
627
|
-
type: 'boolean'
|
|
628
|
-
default: true
|
|
1453
|
+
type: 'boolean'
|
|
629
1454
|
},
|
|
630
1455
|
controllerRoleArn: {
|
|
631
1456
|
type: 'string',
|
|
632
|
-
|
|
1457
|
+
pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
|
|
1458
|
+
description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
|
|
1459
|
+
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
633
1460
|
}
|
|
634
1461
|
},
|
|
635
|
-
required: [
|
|
1462
|
+
required: [
|
|
1463
|
+
'enabled'
|
|
1464
|
+
],
|
|
636
1465
|
additionalProperties: false
|
|
637
1466
|
},
|
|
638
|
-
|
|
639
|
-
type: 'string',
|
|
640
|
-
maxLength: 63,
|
|
641
|
-
minLength: 1,
|
|
642
|
-
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
643
|
-
description: 'Unique identifier of the kubernetes fleet.',
|
|
644
|
-
example: 'new-clouds-fleet'
|
|
645
|
-
}
|
|
646
|
-
},
|
|
647
|
-
required: ['id'],
|
|
648
|
-
additionalProperties: false
|
|
649
|
-
};
|
|
650
|
-
export const FleetUpdateInputSchema = {
|
|
651
|
-
type: 'object',
|
|
652
|
-
properties: {
|
|
653
|
-
limits: {
|
|
1467
|
+
constraints: {
|
|
654
1468
|
type: 'object',
|
|
655
1469
|
properties: {
|
|
656
|
-
|
|
657
|
-
type: '
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
1470
|
+
'karpenter.sh/capacity-type': {
|
|
1471
|
+
type: 'array',
|
|
1472
|
+
items: {
|
|
1473
|
+
type: 'string',
|
|
1474
|
+
enum: [
|
|
1475
|
+
'on-demand',
|
|
1476
|
+
'spot'
|
|
1477
|
+
]
|
|
1478
|
+
},
|
|
1479
|
+
minItems: 1,
|
|
1480
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1481
|
+
default: [
|
|
1482
|
+
'on-demand',
|
|
1483
|
+
'spot'
|
|
1484
|
+
]
|
|
1485
|
+
},
|
|
1486
|
+
'kubernetes.io/arch': {
|
|
1487
|
+
type: 'array',
|
|
1488
|
+
items: {
|
|
1489
|
+
type: 'string',
|
|
1490
|
+
enum: [
|
|
1491
|
+
'amd64',
|
|
1492
|
+
'arm64'
|
|
1493
|
+
]
|
|
1494
|
+
},
|
|
1495
|
+
minItems: 1,
|
|
1496
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1497
|
+
default: [
|
|
1498
|
+
'amd64'
|
|
1499
|
+
]
|
|
1500
|
+
},
|
|
1501
|
+
'cfke.io/instance-family': {
|
|
1502
|
+
type: 'array',
|
|
1503
|
+
items: {
|
|
1504
|
+
type: 'string',
|
|
1505
|
+
enum: [
|
|
1506
|
+
'a1',
|
|
1507
|
+
'a2',
|
|
1508
|
+
'a3',
|
|
1509
|
+
'a4',
|
|
1510
|
+
'c1',
|
|
1511
|
+
'c2',
|
|
1512
|
+
'c2d',
|
|
1513
|
+
'c3',
|
|
1514
|
+
'c3d',
|
|
1515
|
+
'c4',
|
|
1516
|
+
'c4a',
|
|
1517
|
+
'c4d',
|
|
1518
|
+
'c5',
|
|
1519
|
+
'c5a',
|
|
1520
|
+
'c5ad',
|
|
1521
|
+
'c5d',
|
|
1522
|
+
'c5n',
|
|
1523
|
+
'c6a',
|
|
1524
|
+
'c6g',
|
|
1525
|
+
'c6gd',
|
|
1526
|
+
'c6gn',
|
|
1527
|
+
'c6i',
|
|
1528
|
+
'c6id',
|
|
1529
|
+
'c6in',
|
|
1530
|
+
'c7a',
|
|
1531
|
+
'c7g',
|
|
1532
|
+
'c7gd',
|
|
1533
|
+
'c7gn',
|
|
1534
|
+
'c7i',
|
|
1535
|
+
'c7i-flex',
|
|
1536
|
+
'c8g',
|
|
1537
|
+
'c8gd',
|
|
1538
|
+
'cax',
|
|
1539
|
+
'ccx',
|
|
1540
|
+
'cpx',
|
|
1541
|
+
'cx',
|
|
1542
|
+
'd2',
|
|
1543
|
+
'd3',
|
|
1544
|
+
'd3en',
|
|
1545
|
+
'dl1',
|
|
1546
|
+
'dl2q',
|
|
1547
|
+
'e2',
|
|
1548
|
+
'f1',
|
|
1549
|
+
'f2',
|
|
1550
|
+
'g1',
|
|
1551
|
+
'g2',
|
|
1552
|
+
'g4ad',
|
|
1553
|
+
'g4dn',
|
|
1554
|
+
'g5',
|
|
1555
|
+
'g5g',
|
|
1556
|
+
'g6',
|
|
1557
|
+
'g6e',
|
|
1558
|
+
'gr6',
|
|
1559
|
+
'h1',
|
|
1560
|
+
'h3',
|
|
1561
|
+
'hpc6a',
|
|
1562
|
+
'hpc6id',
|
|
1563
|
+
'hpc7a',
|
|
1564
|
+
'hpc7g',
|
|
1565
|
+
'i2',
|
|
1566
|
+
'i3',
|
|
1567
|
+
'i3en',
|
|
1568
|
+
'i4g',
|
|
1569
|
+
'i4i',
|
|
1570
|
+
'i7i',
|
|
1571
|
+
'i7ie',
|
|
1572
|
+
'i8g',
|
|
1573
|
+
'im4gn',
|
|
1574
|
+
'inf1',
|
|
1575
|
+
'inf2',
|
|
1576
|
+
'is4gen',
|
|
1577
|
+
'm1',
|
|
1578
|
+
'm2',
|
|
1579
|
+
'm3',
|
|
1580
|
+
'm4',
|
|
1581
|
+
'm5',
|
|
1582
|
+
'm5a',
|
|
1583
|
+
'm5ad',
|
|
1584
|
+
'm5d',
|
|
1585
|
+
'm5dn',
|
|
1586
|
+
'm5n',
|
|
1587
|
+
'm5zn',
|
|
1588
|
+
'm6a',
|
|
1589
|
+
'm6g',
|
|
1590
|
+
'm6gd',
|
|
1591
|
+
'm6i',
|
|
1592
|
+
'm6id',
|
|
1593
|
+
'm6idn',
|
|
1594
|
+
'm6in',
|
|
1595
|
+
'm7a',
|
|
1596
|
+
'm7g',
|
|
1597
|
+
'm7gd',
|
|
1598
|
+
'm7i',
|
|
1599
|
+
'm7i-flex',
|
|
1600
|
+
'm8g',
|
|
1601
|
+
'm8gd',
|
|
1602
|
+
'n1',
|
|
1603
|
+
'n2',
|
|
1604
|
+
'n2d',
|
|
1605
|
+
'n4',
|
|
1606
|
+
'p3',
|
|
1607
|
+
'p3dn',
|
|
1608
|
+
'p4d',
|
|
1609
|
+
'p4de',
|
|
1610
|
+
'p5',
|
|
1611
|
+
'p5e',
|
|
1612
|
+
'p5en',
|
|
1613
|
+
'p6-b200',
|
|
1614
|
+
'r3',
|
|
1615
|
+
'r4',
|
|
1616
|
+
'r5',
|
|
1617
|
+
'r5a',
|
|
1618
|
+
'r5ad',
|
|
1619
|
+
'r5b',
|
|
1620
|
+
'r5d',
|
|
1621
|
+
'r5dn',
|
|
1622
|
+
'r5n',
|
|
1623
|
+
'r6a',
|
|
1624
|
+
'r6g',
|
|
1625
|
+
'r6gd',
|
|
1626
|
+
'r6i',
|
|
1627
|
+
'r6id',
|
|
1628
|
+
'r6idn',
|
|
1629
|
+
'r6in',
|
|
1630
|
+
'r7a',
|
|
1631
|
+
'r7g',
|
|
1632
|
+
'r7gd',
|
|
1633
|
+
'r7i',
|
|
1634
|
+
'r7iz',
|
|
1635
|
+
'r8g',
|
|
1636
|
+
'r8gd',
|
|
1637
|
+
't2',
|
|
1638
|
+
't2a',
|
|
1639
|
+
't2d',
|
|
1640
|
+
't3',
|
|
1641
|
+
't3a',
|
|
1642
|
+
't4g',
|
|
1643
|
+
'trn1',
|
|
1644
|
+
'trn1n',
|
|
1645
|
+
'u-3tb1',
|
|
1646
|
+
'u-6tb1',
|
|
1647
|
+
'u7i-12tb',
|
|
1648
|
+
'u7i-6tb',
|
|
1649
|
+
'u7i-8tb',
|
|
1650
|
+
'u7in-16tb',
|
|
1651
|
+
'u7in-24tb',
|
|
1652
|
+
'u7in-32tb',
|
|
1653
|
+
'vt1',
|
|
1654
|
+
'x1',
|
|
1655
|
+
'x1e',
|
|
1656
|
+
'x2gd',
|
|
1657
|
+
'x2idn',
|
|
1658
|
+
'x2iedn',
|
|
1659
|
+
'x2iezn',
|
|
1660
|
+
'x4',
|
|
1661
|
+
'x8g',
|
|
1662
|
+
'z1d',
|
|
1663
|
+
'z3'
|
|
1664
|
+
]
|
|
1665
|
+
},
|
|
1666
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
1667
|
+
default: []
|
|
1668
|
+
},
|
|
1669
|
+
'topology.kubernetes.io/region': {
|
|
1670
|
+
type: 'array',
|
|
1671
|
+
items: {
|
|
1672
|
+
type: 'string',
|
|
1673
|
+
enum: [
|
|
1674
|
+
'africa-south1',
|
|
1675
|
+
'ap-northeast-1',
|
|
1676
|
+
'ap-northeast-2',
|
|
1677
|
+
'ap-northeast-3',
|
|
1678
|
+
'ap-south-1',
|
|
1679
|
+
'ap-southeast-1',
|
|
1680
|
+
'ap-southeast-2',
|
|
1681
|
+
'ash',
|
|
1682
|
+
'asia-east1',
|
|
1683
|
+
'asia-east2',
|
|
1684
|
+
'asia-northeast1',
|
|
1685
|
+
'asia-northeast2',
|
|
1686
|
+
'asia-northeast3',
|
|
1687
|
+
'asia-south1',
|
|
1688
|
+
'asia-south2',
|
|
1689
|
+
'asia-southeast1',
|
|
1690
|
+
'asia-southeast2',
|
|
1691
|
+
'australia-southeast1',
|
|
1692
|
+
'australia-southeast2',
|
|
1693
|
+
'ca-central-1',
|
|
1694
|
+
'eu-central-1',
|
|
1695
|
+
'eu-central-2',
|
|
1696
|
+
'eu-north-1',
|
|
1697
|
+
'eu-west-1',
|
|
1698
|
+
'eu-west-2',
|
|
1699
|
+
'eu-west-3',
|
|
1700
|
+
'europe-central2',
|
|
1701
|
+
'europe-north1',
|
|
1702
|
+
'europe-southwest1',
|
|
1703
|
+
'europe-west1',
|
|
1704
|
+
'europe-west10',
|
|
1705
|
+
'europe-west12',
|
|
1706
|
+
'europe-west2',
|
|
1707
|
+
'europe-west3',
|
|
1708
|
+
'europe-west4',
|
|
1709
|
+
'europe-west6',
|
|
1710
|
+
'europe-west8',
|
|
1711
|
+
'europe-west9',
|
|
1712
|
+
'fsn1',
|
|
1713
|
+
'hel1',
|
|
1714
|
+
'hil',
|
|
1715
|
+
'me-central1',
|
|
1716
|
+
'me-central2',
|
|
1717
|
+
'me-west1',
|
|
1718
|
+
'nbg1',
|
|
1719
|
+
'northamerica-northeast1',
|
|
1720
|
+
'northamerica-northeast2',
|
|
1721
|
+
'sa-east-1',
|
|
1722
|
+
'sin',
|
|
1723
|
+
'southamerica-east1',
|
|
1724
|
+
'southamerica-west1',
|
|
1725
|
+
'us-central1',
|
|
1726
|
+
'us-east-1',
|
|
1727
|
+
'us-east-2',
|
|
1728
|
+
'us-east1',
|
|
1729
|
+
'us-east4',
|
|
1730
|
+
'us-east5',
|
|
1731
|
+
'us-south1',
|
|
1732
|
+
'us-west-1',
|
|
1733
|
+
'us-west-2',
|
|
1734
|
+
'us-west1',
|
|
1735
|
+
'us-west2',
|
|
1736
|
+
'us-west3',
|
|
1737
|
+
'us-west4'
|
|
1738
|
+
]
|
|
1739
|
+
},
|
|
1740
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
1741
|
+
default: []
|
|
661
1742
|
}
|
|
662
1743
|
},
|
|
663
|
-
required: [
|
|
1744
|
+
required: [
|
|
1745
|
+
'karpenter.sh/capacity-type',
|
|
1746
|
+
'kubernetes.io/arch'
|
|
1747
|
+
],
|
|
664
1748
|
additionalProperties: false,
|
|
665
|
-
description: '
|
|
1749
|
+
description: 'Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.',
|
|
1750
|
+
default: {
|
|
1751
|
+
'karpenter.sh/capacity-type': [
|
|
1752
|
+
'on-demand',
|
|
1753
|
+
'spot'
|
|
1754
|
+
],
|
|
1755
|
+
'kubernetes.io/arch': [
|
|
1756
|
+
'amd64'
|
|
1757
|
+
],
|
|
1758
|
+
'cfke.io/instance-family': [],
|
|
1759
|
+
'topology.kubernetes.io/region': []
|
|
1760
|
+
}
|
|
666
1761
|
},
|
|
667
|
-
|
|
1762
|
+
scalingProfile: {
|
|
1763
|
+
type: 'string',
|
|
1764
|
+
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).',
|
|
1765
|
+
default: 'conservative',
|
|
1766
|
+
example: 'conservative',
|
|
1767
|
+
enum: [
|
|
1768
|
+
'aggressive',
|
|
1769
|
+
'conservative'
|
|
1770
|
+
]
|
|
1771
|
+
},
|
|
1772
|
+
taints: {
|
|
1773
|
+
type: 'array',
|
|
1774
|
+
items: {
|
|
1775
|
+
type: 'object',
|
|
1776
|
+
properties: {
|
|
1777
|
+
key: {
|
|
1778
|
+
type: 'string',
|
|
1779
|
+
description: 'Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.',
|
|
1780
|
+
example: 'dedicated'
|
|
1781
|
+
},
|
|
1782
|
+
value: {
|
|
1783
|
+
type: 'string',
|
|
1784
|
+
maxLength: 63,
|
|
1785
|
+
pattern: '^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$',
|
|
1786
|
+
description: 'Taint value. Optional.',
|
|
1787
|
+
example: 'ci'
|
|
1788
|
+
},
|
|
1789
|
+
effect: {
|
|
1790
|
+
type: 'string',
|
|
1791
|
+
description: 'Taint effect.',
|
|
1792
|
+
example: 'NoSchedule',
|
|
1793
|
+
enum: [
|
|
1794
|
+
'NoSchedule',
|
|
1795
|
+
'PreferNoSchedule',
|
|
1796
|
+
'NoExecute'
|
|
1797
|
+
]
|
|
1798
|
+
}
|
|
1799
|
+
},
|
|
1800
|
+
required: [
|
|
1801
|
+
'key',
|
|
1802
|
+
'effect'
|
|
1803
|
+
],
|
|
1804
|
+
additionalProperties: false
|
|
1805
|
+
},
|
|
1806
|
+
maxItems: 50,
|
|
1807
|
+
description: 'Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.',
|
|
1808
|
+
default: []
|
|
1809
|
+
},
|
|
1810
|
+
id: {
|
|
1811
|
+
type: 'string',
|
|
1812
|
+
maxLength: 63,
|
|
1813
|
+
minLength: 1,
|
|
1814
|
+
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
1815
|
+
description: 'Unique identifier of the kubernetes fleet.',
|
|
1816
|
+
example: 'new-clouds-fleet'
|
|
1817
|
+
},
|
|
1818
|
+
ready: {
|
|
1819
|
+
type: 'boolean',
|
|
1820
|
+
description: 'Indicates whether the fleet configuration is healthy.',
|
|
1821
|
+
example: true
|
|
1822
|
+
},
|
|
1823
|
+
status_message: {
|
|
1824
|
+
type: 'string',
|
|
1825
|
+
description: 'Human-readable reason the fleet is not ready. Present only when `ready` is false.',
|
|
1826
|
+
example: 'Invalid provider permissions.'
|
|
1827
|
+
},
|
|
1828
|
+
created_at: {
|
|
1829
|
+
type: 'string',
|
|
1830
|
+
description: 'Creation date and time of the fleet.',
|
|
1831
|
+
example: '2024-09-12T09:11:27Z'
|
|
1832
|
+
},
|
|
1833
|
+
updated_at: {
|
|
1834
|
+
type: 'string',
|
|
1835
|
+
description: 'Date and time the fleet was last updated.',
|
|
1836
|
+
example: '2024-09-12T09:11:27Z'
|
|
1837
|
+
}
|
|
1838
|
+
},
|
|
1839
|
+
required: [
|
|
1840
|
+
'constraints',
|
|
1841
|
+
'scalingProfile',
|
|
1842
|
+
'taints',
|
|
1843
|
+
'id',
|
|
1844
|
+
'ready',
|
|
1845
|
+
'created_at',
|
|
1846
|
+
'updated_at'
|
|
1847
|
+
],
|
|
1848
|
+
additionalProperties: false,
|
|
1849
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
1850
|
+
};
|
|
1851
|
+
export const FleetUpdateInputSchema = {
|
|
1852
|
+
type: 'object',
|
|
1853
|
+
properties: {
|
|
1854
|
+
limits: {
|
|
1855
|
+
type: 'object',
|
|
1856
|
+
properties: {
|
|
1857
|
+
cpu: {
|
|
1858
|
+
type: 'integer',
|
|
1859
|
+
minimum: 0,
|
|
1860
|
+
maximum: 100000,
|
|
1861
|
+
description: 'CPU limit in cores. Maximum 100,000.'
|
|
1862
|
+
}
|
|
1863
|
+
},
|
|
1864
|
+
additionalProperties: false,
|
|
1865
|
+
description: 'Limits define a set of bounds for provisioning capacity.'
|
|
1866
|
+
},
|
|
1867
|
+
gcp: {
|
|
668
1868
|
type: 'object',
|
|
669
1869
|
properties: {
|
|
670
1870
|
enabled: {
|
|
671
|
-
type: 'boolean'
|
|
672
|
-
default: true
|
|
1871
|
+
type: 'boolean'
|
|
673
1872
|
},
|
|
674
1873
|
project: {
|
|
675
1874
|
type: 'string',
|
|
676
|
-
|
|
1875
|
+
pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
|
|
1876
|
+
description: 'GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.',
|
|
1877
|
+
example: 'my-cloudfleet-project'
|
|
677
1878
|
}
|
|
678
1879
|
},
|
|
679
|
-
required: [
|
|
1880
|
+
required: [
|
|
1881
|
+
'enabled'
|
|
1882
|
+
],
|
|
680
1883
|
additionalProperties: false
|
|
681
1884
|
},
|
|
682
1885
|
hetzner: {
|
|
683
1886
|
type: 'object',
|
|
684
1887
|
properties: {
|
|
685
1888
|
enabled: {
|
|
686
|
-
type: 'boolean'
|
|
687
|
-
default: true
|
|
1889
|
+
type: 'boolean'
|
|
688
1890
|
},
|
|
689
1891
|
apiKey: {
|
|
690
1892
|
type: 'string',
|
|
691
|
-
|
|
1893
|
+
maxLength: 64,
|
|
1894
|
+
minLength: 64,
|
|
1895
|
+
pattern: '^([A-Za-z0-9]{64}|\\*{64})$',
|
|
1896
|
+
description: 'Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.'
|
|
692
1897
|
}
|
|
693
1898
|
},
|
|
694
|
-
required: [
|
|
1899
|
+
required: [
|
|
1900
|
+
'enabled'
|
|
1901
|
+
],
|
|
695
1902
|
additionalProperties: false
|
|
696
1903
|
},
|
|
697
1904
|
aws: {
|
|
698
1905
|
type: 'object',
|
|
699
1906
|
properties: {
|
|
700
1907
|
enabled: {
|
|
701
|
-
type: 'boolean'
|
|
702
|
-
default: true
|
|
1908
|
+
type: 'boolean'
|
|
703
1909
|
},
|
|
704
1910
|
controllerRoleArn: {
|
|
705
1911
|
type: 'string',
|
|
706
|
-
|
|
1912
|
+
pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
|
|
1913
|
+
description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
|
|
1914
|
+
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
707
1915
|
}
|
|
708
1916
|
},
|
|
709
|
-
required: [
|
|
1917
|
+
required: [
|
|
1918
|
+
'enabled'
|
|
1919
|
+
],
|
|
710
1920
|
additionalProperties: false
|
|
1921
|
+
},
|
|
1922
|
+
constraints: {
|
|
1923
|
+
type: 'object',
|
|
1924
|
+
properties: {
|
|
1925
|
+
'karpenter.sh/capacity-type': {
|
|
1926
|
+
type: 'array',
|
|
1927
|
+
items: {
|
|
1928
|
+
type: 'string',
|
|
1929
|
+
enum: [
|
|
1930
|
+
'on-demand',
|
|
1931
|
+
'spot'
|
|
1932
|
+
]
|
|
1933
|
+
},
|
|
1934
|
+
minItems: 1,
|
|
1935
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1936
|
+
default: [
|
|
1937
|
+
'on-demand',
|
|
1938
|
+
'spot'
|
|
1939
|
+
]
|
|
1940
|
+
},
|
|
1941
|
+
'kubernetes.io/arch': {
|
|
1942
|
+
type: 'array',
|
|
1943
|
+
items: {
|
|
1944
|
+
type: 'string',
|
|
1945
|
+
enum: [
|
|
1946
|
+
'amd64',
|
|
1947
|
+
'arm64'
|
|
1948
|
+
]
|
|
1949
|
+
},
|
|
1950
|
+
minItems: 1,
|
|
1951
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1952
|
+
default: [
|
|
1953
|
+
'amd64'
|
|
1954
|
+
]
|
|
1955
|
+
},
|
|
1956
|
+
'cfke.io/instance-family': {
|
|
1957
|
+
type: 'array',
|
|
1958
|
+
items: {
|
|
1959
|
+
type: 'string',
|
|
1960
|
+
enum: [
|
|
1961
|
+
'a1',
|
|
1962
|
+
'a2',
|
|
1963
|
+
'a3',
|
|
1964
|
+
'a4',
|
|
1965
|
+
'c1',
|
|
1966
|
+
'c2',
|
|
1967
|
+
'c2d',
|
|
1968
|
+
'c3',
|
|
1969
|
+
'c3d',
|
|
1970
|
+
'c4',
|
|
1971
|
+
'c4a',
|
|
1972
|
+
'c4d',
|
|
1973
|
+
'c5',
|
|
1974
|
+
'c5a',
|
|
1975
|
+
'c5ad',
|
|
1976
|
+
'c5d',
|
|
1977
|
+
'c5n',
|
|
1978
|
+
'c6a',
|
|
1979
|
+
'c6g',
|
|
1980
|
+
'c6gd',
|
|
1981
|
+
'c6gn',
|
|
1982
|
+
'c6i',
|
|
1983
|
+
'c6id',
|
|
1984
|
+
'c6in',
|
|
1985
|
+
'c7a',
|
|
1986
|
+
'c7g',
|
|
1987
|
+
'c7gd',
|
|
1988
|
+
'c7gn',
|
|
1989
|
+
'c7i',
|
|
1990
|
+
'c7i-flex',
|
|
1991
|
+
'c8g',
|
|
1992
|
+
'c8gd',
|
|
1993
|
+
'cax',
|
|
1994
|
+
'ccx',
|
|
1995
|
+
'cpx',
|
|
1996
|
+
'cx',
|
|
1997
|
+
'd2',
|
|
1998
|
+
'd3',
|
|
1999
|
+
'd3en',
|
|
2000
|
+
'dl1',
|
|
2001
|
+
'dl2q',
|
|
2002
|
+
'e2',
|
|
2003
|
+
'f1',
|
|
2004
|
+
'f2',
|
|
2005
|
+
'g1',
|
|
2006
|
+
'g2',
|
|
2007
|
+
'g4ad',
|
|
2008
|
+
'g4dn',
|
|
2009
|
+
'g5',
|
|
2010
|
+
'g5g',
|
|
2011
|
+
'g6',
|
|
2012
|
+
'g6e',
|
|
2013
|
+
'gr6',
|
|
2014
|
+
'h1',
|
|
2015
|
+
'h3',
|
|
2016
|
+
'hpc6a',
|
|
2017
|
+
'hpc6id',
|
|
2018
|
+
'hpc7a',
|
|
2019
|
+
'hpc7g',
|
|
2020
|
+
'i2',
|
|
2021
|
+
'i3',
|
|
2022
|
+
'i3en',
|
|
2023
|
+
'i4g',
|
|
2024
|
+
'i4i',
|
|
2025
|
+
'i7i',
|
|
2026
|
+
'i7ie',
|
|
2027
|
+
'i8g',
|
|
2028
|
+
'im4gn',
|
|
2029
|
+
'inf1',
|
|
2030
|
+
'inf2',
|
|
2031
|
+
'is4gen',
|
|
2032
|
+
'm1',
|
|
2033
|
+
'm2',
|
|
2034
|
+
'm3',
|
|
2035
|
+
'm4',
|
|
2036
|
+
'm5',
|
|
2037
|
+
'm5a',
|
|
2038
|
+
'm5ad',
|
|
2039
|
+
'm5d',
|
|
2040
|
+
'm5dn',
|
|
2041
|
+
'm5n',
|
|
2042
|
+
'm5zn',
|
|
2043
|
+
'm6a',
|
|
2044
|
+
'm6g',
|
|
2045
|
+
'm6gd',
|
|
2046
|
+
'm6i',
|
|
2047
|
+
'm6id',
|
|
2048
|
+
'm6idn',
|
|
2049
|
+
'm6in',
|
|
2050
|
+
'm7a',
|
|
2051
|
+
'm7g',
|
|
2052
|
+
'm7gd',
|
|
2053
|
+
'm7i',
|
|
2054
|
+
'm7i-flex',
|
|
2055
|
+
'm8g',
|
|
2056
|
+
'm8gd',
|
|
2057
|
+
'n1',
|
|
2058
|
+
'n2',
|
|
2059
|
+
'n2d',
|
|
2060
|
+
'n4',
|
|
2061
|
+
'p3',
|
|
2062
|
+
'p3dn',
|
|
2063
|
+
'p4d',
|
|
2064
|
+
'p4de',
|
|
2065
|
+
'p5',
|
|
2066
|
+
'p5e',
|
|
2067
|
+
'p5en',
|
|
2068
|
+
'p6-b200',
|
|
2069
|
+
'r3',
|
|
2070
|
+
'r4',
|
|
2071
|
+
'r5',
|
|
2072
|
+
'r5a',
|
|
2073
|
+
'r5ad',
|
|
2074
|
+
'r5b',
|
|
2075
|
+
'r5d',
|
|
2076
|
+
'r5dn',
|
|
2077
|
+
'r5n',
|
|
2078
|
+
'r6a',
|
|
2079
|
+
'r6g',
|
|
2080
|
+
'r6gd',
|
|
2081
|
+
'r6i',
|
|
2082
|
+
'r6id',
|
|
2083
|
+
'r6idn',
|
|
2084
|
+
'r6in',
|
|
2085
|
+
'r7a',
|
|
2086
|
+
'r7g',
|
|
2087
|
+
'r7gd',
|
|
2088
|
+
'r7i',
|
|
2089
|
+
'r7iz',
|
|
2090
|
+
'r8g',
|
|
2091
|
+
'r8gd',
|
|
2092
|
+
't2',
|
|
2093
|
+
't2a',
|
|
2094
|
+
't2d',
|
|
2095
|
+
't3',
|
|
2096
|
+
't3a',
|
|
2097
|
+
't4g',
|
|
2098
|
+
'trn1',
|
|
2099
|
+
'trn1n',
|
|
2100
|
+
'u-3tb1',
|
|
2101
|
+
'u-6tb1',
|
|
2102
|
+
'u7i-12tb',
|
|
2103
|
+
'u7i-6tb',
|
|
2104
|
+
'u7i-8tb',
|
|
2105
|
+
'u7in-16tb',
|
|
2106
|
+
'u7in-24tb',
|
|
2107
|
+
'u7in-32tb',
|
|
2108
|
+
'vt1',
|
|
2109
|
+
'x1',
|
|
2110
|
+
'x1e',
|
|
2111
|
+
'x2gd',
|
|
2112
|
+
'x2idn',
|
|
2113
|
+
'x2iedn',
|
|
2114
|
+
'x2iezn',
|
|
2115
|
+
'x4',
|
|
2116
|
+
'x8g',
|
|
2117
|
+
'z1d',
|
|
2118
|
+
'z3'
|
|
2119
|
+
]
|
|
2120
|
+
},
|
|
2121
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
2122
|
+
default: []
|
|
2123
|
+
},
|
|
2124
|
+
'topology.kubernetes.io/region': {
|
|
2125
|
+
type: 'array',
|
|
2126
|
+
items: {
|
|
2127
|
+
type: 'string',
|
|
2128
|
+
enum: [
|
|
2129
|
+
'africa-south1',
|
|
2130
|
+
'ap-northeast-1',
|
|
2131
|
+
'ap-northeast-2',
|
|
2132
|
+
'ap-northeast-3',
|
|
2133
|
+
'ap-south-1',
|
|
2134
|
+
'ap-southeast-1',
|
|
2135
|
+
'ap-southeast-2',
|
|
2136
|
+
'ash',
|
|
2137
|
+
'asia-east1',
|
|
2138
|
+
'asia-east2',
|
|
2139
|
+
'asia-northeast1',
|
|
2140
|
+
'asia-northeast2',
|
|
2141
|
+
'asia-northeast3',
|
|
2142
|
+
'asia-south1',
|
|
2143
|
+
'asia-south2',
|
|
2144
|
+
'asia-southeast1',
|
|
2145
|
+
'asia-southeast2',
|
|
2146
|
+
'australia-southeast1',
|
|
2147
|
+
'australia-southeast2',
|
|
2148
|
+
'ca-central-1',
|
|
2149
|
+
'eu-central-1',
|
|
2150
|
+
'eu-central-2',
|
|
2151
|
+
'eu-north-1',
|
|
2152
|
+
'eu-west-1',
|
|
2153
|
+
'eu-west-2',
|
|
2154
|
+
'eu-west-3',
|
|
2155
|
+
'europe-central2',
|
|
2156
|
+
'europe-north1',
|
|
2157
|
+
'europe-southwest1',
|
|
2158
|
+
'europe-west1',
|
|
2159
|
+
'europe-west10',
|
|
2160
|
+
'europe-west12',
|
|
2161
|
+
'europe-west2',
|
|
2162
|
+
'europe-west3',
|
|
2163
|
+
'europe-west4',
|
|
2164
|
+
'europe-west6',
|
|
2165
|
+
'europe-west8',
|
|
2166
|
+
'europe-west9',
|
|
2167
|
+
'fsn1',
|
|
2168
|
+
'hel1',
|
|
2169
|
+
'hil',
|
|
2170
|
+
'me-central1',
|
|
2171
|
+
'me-central2',
|
|
2172
|
+
'me-west1',
|
|
2173
|
+
'nbg1',
|
|
2174
|
+
'northamerica-northeast1',
|
|
2175
|
+
'northamerica-northeast2',
|
|
2176
|
+
'sa-east-1',
|
|
2177
|
+
'sin',
|
|
2178
|
+
'southamerica-east1',
|
|
2179
|
+
'southamerica-west1',
|
|
2180
|
+
'us-central1',
|
|
2181
|
+
'us-east-1',
|
|
2182
|
+
'us-east-2',
|
|
2183
|
+
'us-east1',
|
|
2184
|
+
'us-east4',
|
|
2185
|
+
'us-east5',
|
|
2186
|
+
'us-south1',
|
|
2187
|
+
'us-west-1',
|
|
2188
|
+
'us-west-2',
|
|
2189
|
+
'us-west1',
|
|
2190
|
+
'us-west2',
|
|
2191
|
+
'us-west3',
|
|
2192
|
+
'us-west4'
|
|
2193
|
+
]
|
|
2194
|
+
},
|
|
2195
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
2196
|
+
default: []
|
|
2197
|
+
}
|
|
2198
|
+
},
|
|
2199
|
+
additionalProperties: false,
|
|
2200
|
+
description: 'Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.',
|
|
2201
|
+
default: {
|
|
2202
|
+
'karpenter.sh/capacity-type': [
|
|
2203
|
+
'on-demand',
|
|
2204
|
+
'spot'
|
|
2205
|
+
],
|
|
2206
|
+
'kubernetes.io/arch': [
|
|
2207
|
+
'amd64'
|
|
2208
|
+
],
|
|
2209
|
+
'cfke.io/instance-family': [],
|
|
2210
|
+
'topology.kubernetes.io/region': []
|
|
2211
|
+
}
|
|
2212
|
+
},
|
|
2213
|
+
scalingProfile: {
|
|
2214
|
+
type: 'string',
|
|
2215
|
+
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).',
|
|
2216
|
+
default: 'conservative',
|
|
2217
|
+
example: 'conservative',
|
|
2218
|
+
enum: [
|
|
2219
|
+
'aggressive',
|
|
2220
|
+
'conservative'
|
|
2221
|
+
]
|
|
2222
|
+
},
|
|
2223
|
+
taints: {
|
|
2224
|
+
type: 'array',
|
|
2225
|
+
items: {
|
|
2226
|
+
type: 'object',
|
|
2227
|
+
properties: {
|
|
2228
|
+
key: {
|
|
2229
|
+
type: 'string',
|
|
2230
|
+
description: 'Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.',
|
|
2231
|
+
example: 'dedicated'
|
|
2232
|
+
},
|
|
2233
|
+
value: {
|
|
2234
|
+
type: 'string',
|
|
2235
|
+
maxLength: 63,
|
|
2236
|
+
pattern: '^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$',
|
|
2237
|
+
description: 'Taint value. Optional.',
|
|
2238
|
+
example: 'ci'
|
|
2239
|
+
},
|
|
2240
|
+
effect: {
|
|
2241
|
+
type: 'string',
|
|
2242
|
+
description: 'Taint effect.',
|
|
2243
|
+
example: 'NoSchedule',
|
|
2244
|
+
enum: [
|
|
2245
|
+
'NoSchedule',
|
|
2246
|
+
'PreferNoSchedule',
|
|
2247
|
+
'NoExecute'
|
|
2248
|
+
]
|
|
2249
|
+
}
|
|
2250
|
+
},
|
|
2251
|
+
required: [
|
|
2252
|
+
'key',
|
|
2253
|
+
'effect'
|
|
2254
|
+
],
|
|
2255
|
+
additionalProperties: false
|
|
2256
|
+
},
|
|
2257
|
+
maxItems: 50,
|
|
2258
|
+
description: 'Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.',
|
|
2259
|
+
default: []
|
|
2260
|
+
}
|
|
2261
|
+
},
|
|
2262
|
+
additionalProperties: false,
|
|
2263
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
2264
|
+
};
|
|
2265
|
+
export const InviteCreateInputSchema = {
|
|
2266
|
+
type: 'object',
|
|
2267
|
+
properties: {
|
|
2268
|
+
email: {
|
|
2269
|
+
type: 'string',
|
|
2270
|
+
format: 'email',
|
|
2271
|
+
description: 'Email address of the user to invite.',
|
|
2272
|
+
example: 'email@example.com'
|
|
2273
|
+
},
|
|
2274
|
+
role: {
|
|
2275
|
+
type: 'string',
|
|
2276
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2277
|
+
default: 'User',
|
|
2278
|
+
example: 'User',
|
|
2279
|
+
enum: [
|
|
2280
|
+
'Administrator',
|
|
2281
|
+
'User'
|
|
2282
|
+
]
|
|
711
2283
|
}
|
|
712
2284
|
},
|
|
2285
|
+
required: [
|
|
2286
|
+
'email'
|
|
2287
|
+
],
|
|
713
2288
|
additionalProperties: false
|
|
714
2289
|
};
|
|
715
2290
|
export const InviteSchema = {
|
|
@@ -742,453 +2317,409 @@ export const InviteSchema = {
|
|
|
742
2317
|
type: 'string',
|
|
743
2318
|
description: 'Generated unique invite code.',
|
|
744
2319
|
example: '7kUZnH7nnKUFfvc4NK2KQF'
|
|
2320
|
+
},
|
|
2321
|
+
role: {
|
|
2322
|
+
type: 'string',
|
|
2323
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2324
|
+
default: 'User',
|
|
2325
|
+
example: 'User',
|
|
2326
|
+
enum: [
|
|
2327
|
+
'Administrator',
|
|
2328
|
+
'User'
|
|
2329
|
+
]
|
|
745
2330
|
}
|
|
746
2331
|
},
|
|
747
|
-
required: [
|
|
2332
|
+
required: [
|
|
2333
|
+
'date_created'
|
|
2334
|
+
],
|
|
748
2335
|
additionalProperties: false
|
|
749
2336
|
};
|
|
750
|
-
export const
|
|
2337
|
+
export const InvoicePaymentAttemptSchema = {
|
|
751
2338
|
type: 'object',
|
|
752
2339
|
properties: {
|
|
753
|
-
|
|
754
|
-
type: 'string',
|
|
755
|
-
format: 'uuid',
|
|
756
|
-
description: 'Unique identifier of the invoice. UUID v4 string in canonical form',
|
|
757
|
-
example: '415026b6-f00f-44f8-968d-fc6ef4d0fc6d'
|
|
758
|
-
},
|
|
759
|
-
organizationId: {
|
|
2340
|
+
invoice_id: {
|
|
760
2341
|
type: 'string',
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
example: '415026b6-f00f-44f8-968d-fc6ef4d0fc6d'
|
|
2342
|
+
description: 'Identifier of the invoice.',
|
|
2343
|
+
example: 'in_1234567890xCrwxghOTj1234'
|
|
764
2344
|
},
|
|
765
|
-
|
|
2345
|
+
number: {
|
|
766
2346
|
type: 'string',
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
2347
|
+
nullable: true,
|
|
2348
|
+
description: 'Invoice number. Null if the invoice has no number.',
|
|
2349
|
+
example: 'CF-0042'
|
|
770
2350
|
},
|
|
771
2351
|
amount: {
|
|
772
2352
|
type: 'number',
|
|
773
2353
|
format: 'float',
|
|
774
|
-
description: '
|
|
775
|
-
example:
|
|
2354
|
+
description: 'Amount outstanding when the charge was attempted, in the smallest currency unit.',
|
|
2355
|
+
example: 4200
|
|
776
2356
|
},
|
|
777
2357
|
currency: {
|
|
778
2358
|
type: 'string',
|
|
779
|
-
description: 'Currency of the invoice',
|
|
780
|
-
example: '
|
|
781
|
-
enum: ['AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BRL', 'BSD', 'BTN', 'BWP', 'BYR', 'BZD', 'CAD', 'CDF', 'CHF', 'CLP', 'CNY', 'COP', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GGP', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'IMP', 'INR', 'IQD', 'IRR', 'ISK', 'JEP', 'JMD', 'JOD', 'JPY', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KRW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LTL', 'LVL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRO', 'MUR', 'MVR', 'MWK', 'MXN', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLL', 'SOS', 'SPL', 'SRD', 'STD', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TVD', 'TWD', 'TZS', 'UAH', 'UGX', 'USD', 'UYU', 'UZS', 'VEF', 'VND', 'VUV', 'WST', 'XAF', 'XCD', 'XDR', 'XOF', 'XPF', 'YER', 'ZAR', 'ZMW', 'ZWD', 'BTC']
|
|
2359
|
+
description: 'Currency of the invoice.',
|
|
2360
|
+
example: 'eur'
|
|
782
2361
|
},
|
|
783
|
-
|
|
784
|
-
type: 'number',
|
|
785
|
-
format: 'float',
|
|
786
|
-
description: 'Total amount of credit adjustments',
|
|
787
|
-
example: 0
|
|
788
|
-
},
|
|
789
|
-
refundAdj: {
|
|
790
|
-
type: 'number',
|
|
791
|
-
format: 'float',
|
|
792
|
-
description: 'Total amount of refund adjustments',
|
|
793
|
-
example: 0
|
|
794
|
-
},
|
|
795
|
-
invoiceDate: {
|
|
2362
|
+
status: {
|
|
796
2363
|
type: 'string',
|
|
797
|
-
description: '
|
|
798
|
-
example: '
|
|
2364
|
+
description: 'Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).',
|
|
2365
|
+
example: 'paid',
|
|
2366
|
+
enum: [
|
|
2367
|
+
'paid',
|
|
2368
|
+
'processing',
|
|
2369
|
+
'requires_action',
|
|
2370
|
+
'failed'
|
|
2371
|
+
]
|
|
799
2372
|
},
|
|
800
|
-
|
|
2373
|
+
client_secret: {
|
|
801
2374
|
type: 'string',
|
|
802
|
-
|
|
803
|
-
|
|
2375
|
+
nullable: true,
|
|
2376
|
+
description: 'Client secret used to complete customer authentication. Set only when `status` is `requires_action`.',
|
|
2377
|
+
example: 'pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH'
|
|
804
2378
|
},
|
|
805
|
-
|
|
2379
|
+
failure_code: {
|
|
806
2380
|
type: 'string',
|
|
807
|
-
|
|
808
|
-
|
|
2381
|
+
nullable: true,
|
|
2382
|
+
description: 'Decline code. Set only when `status` is `failed`.',
|
|
2383
|
+
example: 'insufficient_funds'
|
|
809
2384
|
},
|
|
810
|
-
|
|
811
|
-
type: '
|
|
812
|
-
|
|
813
|
-
description: '
|
|
814
|
-
example:
|
|
2385
|
+
failure_message: {
|
|
2386
|
+
type: 'string',
|
|
2387
|
+
nullable: true,
|
|
2388
|
+
description: 'Explanation of the decline, suitable for display. Set only when `status` is `failed`.',
|
|
2389
|
+
example: 'Your card has insufficient funds.'
|
|
2390
|
+
}
|
|
2391
|
+
},
|
|
2392
|
+
required: [
|
|
2393
|
+
'invoice_id',
|
|
2394
|
+
'number',
|
|
2395
|
+
'amount',
|
|
2396
|
+
'currency',
|
|
2397
|
+
'status',
|
|
2398
|
+
'client_secret',
|
|
2399
|
+
'failure_code',
|
|
2400
|
+
'failure_message'
|
|
2401
|
+
],
|
|
2402
|
+
additionalProperties: false
|
|
2403
|
+
};
|
|
2404
|
+
export const InvoicePaymentResultSchema = {
|
|
2405
|
+
type: 'object',
|
|
2406
|
+
properties: {
|
|
2407
|
+
code: {
|
|
2408
|
+
type: 'string',
|
|
2409
|
+
description: 'Overall outcome: `paid` (nothing outstanding), `processing` (all accepted, not yet settled), `action_required` (one or more await customer authentication), `partially_paid`, `failed`, `nothing_due`, or `bank_transfer_due` (the organization pays by bank transfer; nothing was charged).',
|
|
2410
|
+
example: 'partially_paid',
|
|
2411
|
+
enum: [
|
|
2412
|
+
'paid',
|
|
2413
|
+
'processing',
|
|
2414
|
+
'action_required',
|
|
2415
|
+
'partially_paid',
|
|
2416
|
+
'failed',
|
|
2417
|
+
'nothing_due',
|
|
2418
|
+
'bank_transfer_due'
|
|
2419
|
+
]
|
|
815
2420
|
},
|
|
816
|
-
|
|
2421
|
+
message: {
|
|
817
2422
|
type: 'string',
|
|
818
|
-
description: '
|
|
819
|
-
example: '
|
|
2423
|
+
description: 'Summary of the outcome, suitable for display.',
|
|
2424
|
+
example: '1 of 2 open invoices was paid. Invoice CF-0043 was declined: Your card has insufficient funds.'
|
|
820
2425
|
},
|
|
821
|
-
|
|
2426
|
+
results: {
|
|
822
2427
|
type: 'array',
|
|
823
2428
|
items: {
|
|
824
2429
|
type: 'object',
|
|
825
2430
|
properties: {
|
|
826
|
-
|
|
827
|
-
type: 'string',
|
|
828
|
-
format: 'uuid',
|
|
829
|
-
description: 'Unique identifier of the invoice item. UUID v4 string in canonical form',
|
|
830
|
-
example: '415026b6-f00f-44f8-968d-fc6ef4d0fc6d'
|
|
831
|
-
},
|
|
832
|
-
linkedInvoiceItemId: {
|
|
833
|
-
type: 'string',
|
|
834
|
-
format: 'uuid',
|
|
835
|
-
description: 'Unique identifier of the linked invoice item. UUID v4 string in canonical form',
|
|
836
|
-
example: '415026b6-f00f-44f8-968d-fc6ef4d0fc6d'
|
|
837
|
-
},
|
|
838
|
-
productName: {
|
|
839
|
-
type: 'string',
|
|
840
|
-
description: 'Name of the product',
|
|
841
|
-
example: 'Research team'
|
|
842
|
-
},
|
|
843
|
-
planName: {
|
|
844
|
-
type: 'string',
|
|
845
|
-
description: 'Name of the plan',
|
|
846
|
-
example: 'Plan A'
|
|
847
|
-
},
|
|
848
|
-
phaseName: {
|
|
849
|
-
type: 'string',
|
|
850
|
-
description: 'Name of the phase',
|
|
851
|
-
example: 'Phase A'
|
|
852
|
-
},
|
|
853
|
-
usageName: {
|
|
854
|
-
type: 'string',
|
|
855
|
-
description: 'Name of the usage',
|
|
856
|
-
example: 'Usage A'
|
|
857
|
-
},
|
|
858
|
-
prettyProductName: {
|
|
859
|
-
type: 'string',
|
|
860
|
-
description: 'Pretty name of the product',
|
|
861
|
-
example: 'Research team'
|
|
862
|
-
},
|
|
863
|
-
prettyPlanName: {
|
|
864
|
-
type: 'string',
|
|
865
|
-
description: 'Pretty name of the plan',
|
|
866
|
-
example: 'Plan A'
|
|
867
|
-
},
|
|
868
|
-
prettyPhaseName: {
|
|
869
|
-
type: 'string',
|
|
870
|
-
description: 'Pretty name of the phase',
|
|
871
|
-
example: 'Phase A'
|
|
872
|
-
},
|
|
873
|
-
prettyUsageName: {
|
|
874
|
-
type: 'string',
|
|
875
|
-
description: 'Pretty name of the usage',
|
|
876
|
-
example: 'Usage A'
|
|
877
|
-
},
|
|
878
|
-
itemType: {
|
|
879
|
-
type: 'string',
|
|
880
|
-
description: 'Type of the invoice item',
|
|
881
|
-
example: 'EXTERNAL_CHARGE',
|
|
882
|
-
enum: ['EXTERNAL_CHARGE', 'FIXED', 'RECURRING', 'REPAIR_ADJ', 'CBA_ADJ', 'CREDIT_ADJ', 'ITEM_ADJ', 'USAGE', 'TAX', 'PARENT_SUMMARY']
|
|
883
|
-
},
|
|
884
|
-
description: {
|
|
885
|
-
type: 'string',
|
|
886
|
-
description: 'Description of the invoice item',
|
|
887
|
-
example: 'Description of the invoice item'
|
|
888
|
-
},
|
|
889
|
-
startDate: {
|
|
2431
|
+
invoice_id: {
|
|
890
2432
|
type: 'string',
|
|
891
|
-
description: '
|
|
892
|
-
example: '
|
|
2433
|
+
description: 'Identifier of the invoice.',
|
|
2434
|
+
example: 'in_1234567890xCrwxghOTj1234'
|
|
893
2435
|
},
|
|
894
|
-
|
|
2436
|
+
number: {
|
|
895
2437
|
type: 'string',
|
|
896
|
-
description: '
|
|
897
|
-
example: '
|
|
2438
|
+
description: 'Invoice number. Null if the invoice has no number.',
|
|
2439
|
+
example: 'CF-0042'
|
|
898
2440
|
},
|
|
899
2441
|
amount: {
|
|
900
2442
|
type: 'number',
|
|
901
2443
|
format: 'float',
|
|
902
|
-
description: 'Amount
|
|
903
|
-
example:
|
|
904
|
-
},
|
|
905
|
-
rate: {
|
|
906
|
-
type: 'number',
|
|
907
|
-
format: 'float',
|
|
908
|
-
description: 'Rate of the invoice item',
|
|
909
|
-
example: 100
|
|
2444
|
+
description: 'Amount outstanding when the charge was attempted, in the smallest currency unit.',
|
|
2445
|
+
example: 4200
|
|
910
2446
|
},
|
|
911
2447
|
currency: {
|
|
912
2448
|
type: 'string',
|
|
913
|
-
description: 'Currency of the invoice
|
|
914
|
-
example: '
|
|
915
|
-
enum: ['AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BRL', 'BSD', 'BTN', 'BWP', 'BYR', 'BZD', 'CAD', 'CDF', 'CHF', 'CLP', 'CNY', 'COP', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GGP', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'IMP', 'INR', 'IQD', 'IRR', 'ISK', 'JEP', 'JMD', 'JOD', 'JPY', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KRW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LTL', 'LVL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRO', 'MUR', 'MVR', 'MWK', 'MXN', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLL', 'SOS', 'SPL', 'SRD', 'STD', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TVD', 'TWD', 'TZS', 'UAH', 'UGX', 'USD', 'UYU', 'UZS', 'VEF', 'VND', 'VUV', 'WST', 'XAF', 'XCD', 'XDR', 'XOF', 'XPF', 'YER', 'ZAR', 'ZMW', 'ZWD', 'BTC']
|
|
2449
|
+
description: 'Currency of the invoice.',
|
|
2450
|
+
example: 'eur'
|
|
916
2451
|
},
|
|
917
|
-
|
|
918
|
-
type: '
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
|
|
2452
|
+
status: {
|
|
2453
|
+
type: 'string',
|
|
2454
|
+
description: 'Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).',
|
|
2455
|
+
example: 'paid',
|
|
2456
|
+
enum: [
|
|
2457
|
+
'paid',
|
|
2458
|
+
'processing',
|
|
2459
|
+
'requires_action',
|
|
2460
|
+
'failed'
|
|
2461
|
+
]
|
|
922
2462
|
},
|
|
923
|
-
|
|
2463
|
+
client_secret: {
|
|
924
2464
|
type: 'string',
|
|
925
|
-
description: '
|
|
926
|
-
example: '
|
|
2465
|
+
description: 'Client secret used to complete customer authentication. Set only when `status` is `requires_action`.',
|
|
2466
|
+
example: 'pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH'
|
|
927
2467
|
},
|
|
928
|
-
|
|
2468
|
+
failure_code: {
|
|
929
2469
|
type: 'string',
|
|
930
|
-
description: '
|
|
931
|
-
example: '
|
|
2470
|
+
description: 'Decline code. Set only when `status` is `failed`.',
|
|
2471
|
+
example: 'insufficient_funds'
|
|
932
2472
|
},
|
|
933
|
-
|
|
934
|
-
type: '
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
{
|
|
938
|
-
type: 'array'
|
|
939
|
-
},
|
|
940
|
-
{
|
|
941
|
-
type: 'boolean'
|
|
942
|
-
},
|
|
943
|
-
{
|
|
944
|
-
type: 'number'
|
|
945
|
-
},
|
|
946
|
-
{
|
|
947
|
-
type: 'object',
|
|
948
|
-
additionalProperties: true
|
|
949
|
-
},
|
|
950
|
-
{
|
|
951
|
-
type: 'string'
|
|
952
|
-
}
|
|
953
|
-
]
|
|
954
|
-
},
|
|
955
|
-
description: 'Child items of the invoice item'
|
|
2473
|
+
failure_message: {
|
|
2474
|
+
type: 'string',
|
|
2475
|
+
description: 'Explanation of the decline, suitable for display. Set only when `status` is `failed`.',
|
|
2476
|
+
example: 'Your card has insufficient funds.'
|
|
956
2477
|
}
|
|
957
2478
|
},
|
|
2479
|
+
required: [
|
|
2480
|
+
'invoice_id',
|
|
2481
|
+
'number',
|
|
2482
|
+
'amount',
|
|
2483
|
+
'currency',
|
|
2484
|
+
'status',
|
|
2485
|
+
'client_secret',
|
|
2486
|
+
'failure_code',
|
|
2487
|
+
'failure_message'
|
|
2488
|
+
],
|
|
958
2489
|
additionalProperties: false
|
|
959
2490
|
},
|
|
960
|
-
description: '
|
|
2491
|
+
description: 'One entry per invoice charged, oldest first.'
|
|
2492
|
+
}
|
|
2493
|
+
},
|
|
2494
|
+
required: [
|
|
2495
|
+
'code',
|
|
2496
|
+
'message',
|
|
2497
|
+
'results'
|
|
2498
|
+
],
|
|
2499
|
+
additionalProperties: false
|
|
2500
|
+
};
|
|
2501
|
+
export const InvoiceSchema = {
|
|
2502
|
+
type: 'object',
|
|
2503
|
+
properties: {
|
|
2504
|
+
id: {
|
|
2505
|
+
type: 'string',
|
|
2506
|
+
description: 'Unique identifier of the invoice.',
|
|
2507
|
+
example: 'in_1234567890xCrwxghOTj1234'
|
|
961
2508
|
},
|
|
962
|
-
|
|
963
|
-
type: '
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
|
|
985
|
-
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
description: 'Pretty name of the product',
|
|
1002
|
-
example: 'Research team'
|
|
1003
|
-
},
|
|
1004
|
-
prettyPlanName: {
|
|
1005
|
-
type: 'string',
|
|
1006
|
-
description: 'Pretty name of the plan',
|
|
1007
|
-
example: 'Plan A'
|
|
1008
|
-
},
|
|
1009
|
-
prettyPhaseName: {
|
|
1010
|
-
type: 'string',
|
|
1011
|
-
description: 'Pretty name of the phase',
|
|
1012
|
-
example: 'Phase A'
|
|
1013
|
-
},
|
|
1014
|
-
prettyUsageName: {
|
|
1015
|
-
type: 'string',
|
|
1016
|
-
description: 'Pretty name of the usage',
|
|
1017
|
-
example: 'Usage A'
|
|
1018
|
-
},
|
|
1019
|
-
itemType: {
|
|
1020
|
-
type: 'string',
|
|
1021
|
-
description: 'Type of the invoice item',
|
|
1022
|
-
example: 'EXTERNAL_CHARGE',
|
|
1023
|
-
enum: ['EXTERNAL_CHARGE', 'FIXED', 'RECURRING', 'REPAIR_ADJ', 'CBA_ADJ', 'CREDIT_ADJ', 'ITEM_ADJ', 'USAGE', 'TAX', 'PARENT_SUMMARY']
|
|
1024
|
-
},
|
|
1025
|
-
description: {
|
|
1026
|
-
type: 'string',
|
|
1027
|
-
description: 'Description of the invoice item',
|
|
1028
|
-
example: 'Description of the invoice item'
|
|
1029
|
-
},
|
|
1030
|
-
startDate: {
|
|
1031
|
-
type: 'string',
|
|
1032
|
-
description: 'Start date of the invoice item',
|
|
1033
|
-
example: '2019-01-01T00:00:00.000Z'
|
|
1034
|
-
},
|
|
1035
|
-
endDate: {
|
|
1036
|
-
type: 'string',
|
|
1037
|
-
description: 'End date of the invoice item',
|
|
1038
|
-
example: '2019-01-01T00:00:00.000Z'
|
|
1039
|
-
},
|
|
1040
|
-
amount: {
|
|
1041
|
-
type: 'number',
|
|
1042
|
-
format: 'float',
|
|
1043
|
-
description: 'Amount of the invoice item',
|
|
1044
|
-
example: 100
|
|
1045
|
-
},
|
|
1046
|
-
rate: {
|
|
1047
|
-
type: 'number',
|
|
1048
|
-
format: 'float',
|
|
1049
|
-
description: 'Rate of the invoice item',
|
|
1050
|
-
example: 100
|
|
1051
|
-
},
|
|
1052
|
-
currency: {
|
|
1053
|
-
type: 'string',
|
|
1054
|
-
description: 'Currency of the invoice item',
|
|
1055
|
-
example: 'USD',
|
|
1056
|
-
enum: ['AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BRL', 'BSD', 'BTN', 'BWP', 'BYR', 'BZD', 'CAD', 'CDF', 'CHF', 'CLP', 'CNY', 'COP', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GGP', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'IMP', 'INR', 'IQD', 'IRR', 'ISK', 'JEP', 'JMD', 'JOD', 'JPY', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KRW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LTL', 'LVL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRO', 'MUR', 'MVR', 'MWK', 'MXN', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLL', 'SOS', 'SPL', 'SRD', 'STD', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TVD', 'TWD', 'TZS', 'UAH', 'UGX', 'USD', 'UYU', 'UZS', 'VEF', 'VND', 'VUV', 'WST', 'XAF', 'XCD', 'XDR', 'XOF', 'XPF', 'YER', 'ZAR', 'ZMW', 'ZWD', 'BTC']
|
|
1057
|
-
},
|
|
1058
|
-
quantity: {
|
|
1059
|
-
type: 'number',
|
|
1060
|
-
format: 'float',
|
|
1061
|
-
description: 'Quantity of the invoice item',
|
|
1062
|
-
example: 1
|
|
1063
|
-
},
|
|
1064
|
-
itemDetails: {
|
|
1065
|
-
type: 'string',
|
|
1066
|
-
description: 'Details of the invoice item',
|
|
1067
|
-
example: 'Details of the invoice item'
|
|
1068
|
-
},
|
|
1069
|
-
catalogEffectiveDate: {
|
|
1070
|
-
type: 'string',
|
|
1071
|
-
description: 'Effective date of the catalog',
|
|
1072
|
-
example: '2019-01-01T00:00:00.000Z'
|
|
1073
|
-
},
|
|
1074
|
-
childItems: {
|
|
1075
|
-
type: 'array',
|
|
1076
|
-
items: {
|
|
1077
|
-
oneOf: [
|
|
1078
|
-
{
|
|
1079
|
-
type: 'array'
|
|
1080
|
-
},
|
|
1081
|
-
{
|
|
1082
|
-
type: 'boolean'
|
|
1083
|
-
},
|
|
1084
|
-
{
|
|
1085
|
-
type: 'number'
|
|
1086
|
-
},
|
|
1087
|
-
{
|
|
1088
|
-
type: 'object',
|
|
1089
|
-
additionalProperties: true
|
|
1090
|
-
},
|
|
1091
|
-
{
|
|
1092
|
-
type: 'string'
|
|
1093
|
-
}
|
|
1094
|
-
]
|
|
1095
|
-
},
|
|
1096
|
-
description: 'Child items of the invoice item'
|
|
1097
|
-
}
|
|
1098
|
-
},
|
|
1099
|
-
additionalProperties: false
|
|
1100
|
-
},
|
|
1101
|
-
description: 'Items of the invoice'
|
|
2509
|
+
number: {
|
|
2510
|
+
type: 'string'
|
|
2511
|
+
},
|
|
2512
|
+
status: {
|
|
2513
|
+
type: 'string',
|
|
2514
|
+
description: 'Status of the invoice',
|
|
2515
|
+
example: 'paid'
|
|
2516
|
+
},
|
|
2517
|
+
total: {
|
|
2518
|
+
type: 'number',
|
|
2519
|
+
format: 'float',
|
|
2520
|
+
description: 'Total amount of the invoice',
|
|
2521
|
+
example: 100
|
|
2522
|
+
},
|
|
2523
|
+
currency: {
|
|
2524
|
+
type: 'string',
|
|
2525
|
+
description: 'Currency of the invoice',
|
|
2526
|
+
example: 'usd'
|
|
2527
|
+
},
|
|
2528
|
+
created: {
|
|
2529
|
+
type: 'string',
|
|
2530
|
+
format: 'date-time',
|
|
2531
|
+
description: 'Timestamp when the invoice was issued. ISO 8601 date string in the UTC timezone.',
|
|
2532
|
+
example: '2023-12-20T13:53:32.000Z'
|
|
2533
|
+
},
|
|
2534
|
+
period_start: {
|
|
2535
|
+
type: 'string',
|
|
2536
|
+
format: 'date-time',
|
|
2537
|
+
description: 'Billing period start timestamp. ISO 8601 date string in the UTC timezone.',
|
|
2538
|
+
example: '2023-12-20T13:53:32.000Z'
|
|
2539
|
+
},
|
|
2540
|
+
period_end: {
|
|
2541
|
+
type: 'string',
|
|
2542
|
+
format: 'date-time',
|
|
2543
|
+
description: 'Billing period end timestamp. ISO 8601 date string in the UTC timezone.',
|
|
2544
|
+
example: '2023-12-20T13:53:32.000Z'
|
|
2545
|
+
},
|
|
2546
|
+
invoice_pdf: {
|
|
2547
|
+
type: 'string'
|
|
1102
2548
|
}
|
|
1103
2549
|
},
|
|
2550
|
+
required: [
|
|
2551
|
+
'created',
|
|
2552
|
+
'period_start',
|
|
2553
|
+
'period_end'
|
|
2554
|
+
],
|
|
1104
2555
|
additionalProperties: false
|
|
1105
2556
|
};
|
|
1106
|
-
export const
|
|
2557
|
+
export const MarketplaceListingFilesSchema = {
|
|
1107
2558
|
type: 'object',
|
|
1108
2559
|
properties: {
|
|
1109
|
-
|
|
2560
|
+
chartYaml: {
|
|
1110
2561
|
type: 'string',
|
|
1111
|
-
|
|
1112
|
-
|
|
1113
|
-
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
1114
|
-
description: 'Id of the chart listing',
|
|
1115
|
-
example: 'portworx-enterprise-disaster-recovery-baremetal'
|
|
2562
|
+
description: 'Raw Chart.yaml content from the Helm chart',
|
|
2563
|
+
example: 'apiVersion: v2\nname: nginx-ingress\nversion: 1.18.2-cfke.45\nappVersion: 1.9.4'
|
|
1116
2564
|
},
|
|
1117
|
-
|
|
2565
|
+
valuesYaml: {
|
|
1118
2566
|
type: 'string',
|
|
1119
|
-
description: '
|
|
1120
|
-
example: '
|
|
1121
|
-
},
|
|
1122
|
-
developer: {
|
|
1123
|
-
type: 'string',
|
|
1124
|
-
description: 'Author of the chart listing',
|
|
1125
|
-
example: 'Portworx'
|
|
2567
|
+
description: 'Raw values.yaml content from the Helm chart',
|
|
2568
|
+
example: 'replicaCount: 1\nimage:\n repository: nginx\n tag: latest'
|
|
1126
2569
|
},
|
|
1127
|
-
|
|
2570
|
+
valuesSchemaJson: {
|
|
1128
2571
|
type: 'string',
|
|
1129
|
-
description: '
|
|
1130
|
-
example: '
|
|
1131
|
-
}
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
|
|
2572
|
+
description: 'JSON schema for values.yaml as a string',
|
|
2573
|
+
example: '{"type":"object","properties":{"replicaCount":{"type":"number"}}}'
|
|
2574
|
+
}
|
|
2575
|
+
},
|
|
2576
|
+
additionalProperties: false
|
|
2577
|
+
};
|
|
2578
|
+
export const MarketplaceListingSchema = {
|
|
2579
|
+
type: 'object',
|
|
2580
|
+
properties: {
|
|
2581
|
+
name: {
|
|
1138
2582
|
type: 'string',
|
|
1139
|
-
description: '
|
|
1140
|
-
example: '
|
|
2583
|
+
description: 'Name of the chart',
|
|
2584
|
+
example: 'nginx-ingress'
|
|
1141
2585
|
},
|
|
1142
|
-
|
|
2586
|
+
versions: {
|
|
1143
2587
|
type: 'array',
|
|
1144
2588
|
items: {
|
|
1145
2589
|
type: 'string',
|
|
1146
|
-
|
|
2590
|
+
pattern: '^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$',
|
|
2591
|
+
description: 'Specific version of the chart',
|
|
2592
|
+
example: '1.18.2-cfke.45'
|
|
1147
2593
|
},
|
|
1148
|
-
description: '
|
|
2594
|
+
description: 'Available versions of the chart'
|
|
1149
2595
|
},
|
|
1150
2596
|
version_channels: {
|
|
1151
2597
|
type: 'array',
|
|
1152
2598
|
items: {
|
|
1153
2599
|
type: 'string',
|
|
1154
2600
|
pattern: '^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$',
|
|
1155
|
-
description: 'Version
|
|
1156
|
-
example: '
|
|
1157
|
-
}
|
|
2601
|
+
description: 'Version channel pattern',
|
|
2602
|
+
example: '1.18.x-cfke.x'
|
|
2603
|
+
},
|
|
2604
|
+
description: 'Version channels for the chart'
|
|
1158
2605
|
},
|
|
1159
|
-
|
|
1160
|
-
type: '
|
|
1161
|
-
|
|
1162
|
-
|
|
1163
|
-
|
|
1164
|
-
|
|
1165
|
-
|
|
1166
|
-
|
|
1167
|
-
|
|
1168
|
-
|
|
2606
|
+
latestVersion: {
|
|
2607
|
+
type: 'string',
|
|
2608
|
+
description: 'Latest version of the chart',
|
|
2609
|
+
example: '1.18.2-cfke.45'
|
|
2610
|
+
},
|
|
2611
|
+
metadata: {
|
|
2612
|
+
type: 'object',
|
|
2613
|
+
properties: {
|
|
2614
|
+
name: {
|
|
2615
|
+
type: 'string',
|
|
2616
|
+
description: 'Chart name from metadata',
|
|
2617
|
+
example: 'nginx-ingress'
|
|
2618
|
+
},
|
|
2619
|
+
version: {
|
|
2620
|
+
type: 'string',
|
|
2621
|
+
description: 'Chart version from metadata',
|
|
2622
|
+
example: '1.18.2-cfke.45'
|
|
2623
|
+
},
|
|
2624
|
+
description: {
|
|
2625
|
+
type: 'string',
|
|
2626
|
+
description: 'Chart description',
|
|
2627
|
+
example: 'NGINX Ingress Controller for Kubernetes'
|
|
2628
|
+
},
|
|
2629
|
+
appVersion: {
|
|
2630
|
+
type: 'string',
|
|
2631
|
+
description: 'Application version',
|
|
2632
|
+
example: '1.9.4'
|
|
2633
|
+
},
|
|
2634
|
+
apiVersion: {
|
|
2635
|
+
type: 'string',
|
|
2636
|
+
description: 'Helm API version',
|
|
2637
|
+
example: 'v2'
|
|
2638
|
+
},
|
|
2639
|
+
keywords: {
|
|
2640
|
+
type: 'array',
|
|
2641
|
+
items: {
|
|
2642
|
+
type: 'string'
|
|
1169
2643
|
},
|
|
1170
|
-
|
|
1171
|
-
|
|
1172
|
-
|
|
2644
|
+
description: 'Chart keywords',
|
|
2645
|
+
example: [
|
|
2646
|
+
'ingress',
|
|
2647
|
+
'nginx',
|
|
2648
|
+
'load-balancer'
|
|
2649
|
+
]
|
|
2650
|
+
},
|
|
2651
|
+
home: {
|
|
2652
|
+
type: 'string',
|
|
2653
|
+
description: 'Chart home URL',
|
|
2654
|
+
example: 'https://kubernetes.github.io/ingress-nginx/'
|
|
2655
|
+
},
|
|
2656
|
+
icon: {
|
|
2657
|
+
type: 'string',
|
|
2658
|
+
description: 'A URL to an SVG or PNG image to be used as an icon',
|
|
2659
|
+
example: 'https://cloudfleet.ai/images/marketplace/icons/ingress-nginx.png'
|
|
2660
|
+
},
|
|
2661
|
+
sources: {
|
|
2662
|
+
type: 'array',
|
|
2663
|
+
items: {
|
|
2664
|
+
type: 'string'
|
|
1173
2665
|
},
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
|
|
1177
|
-
|
|
1178
|
-
bar: example`
|
|
1179
|
-
}
|
|
2666
|
+
description: 'Chart source URLs',
|
|
2667
|
+
example: [
|
|
2668
|
+
'https://github.com/kubernetes/ingress-nginx'
|
|
2669
|
+
]
|
|
1180
2670
|
},
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
|
|
2671
|
+
maintainers: {
|
|
2672
|
+
type: 'array',
|
|
2673
|
+
items: {
|
|
2674
|
+
type: 'object',
|
|
2675
|
+
properties: {
|
|
2676
|
+
name: {
|
|
2677
|
+
type: 'string',
|
|
2678
|
+
description: 'Maintainer name',
|
|
2679
|
+
example: 'NGINX Team'
|
|
2680
|
+
},
|
|
2681
|
+
email: {
|
|
2682
|
+
type: 'string',
|
|
2683
|
+
description: 'Maintainer email',
|
|
2684
|
+
example: 'support@nginx.org'
|
|
2685
|
+
}
|
|
2686
|
+
},
|
|
2687
|
+
required: [
|
|
2688
|
+
'name'
|
|
2689
|
+
],
|
|
2690
|
+
additionalProperties: false
|
|
2691
|
+
},
|
|
2692
|
+
description: 'Chart maintainers'
|
|
2693
|
+
}
|
|
2694
|
+
},
|
|
2695
|
+
required: [
|
|
2696
|
+
'name',
|
|
2697
|
+
'version'
|
|
2698
|
+
],
|
|
2699
|
+
additionalProperties: false,
|
|
2700
|
+
description: 'Chart metadata'
|
|
1184
2701
|
}
|
|
1185
2702
|
},
|
|
1186
|
-
required: [
|
|
2703
|
+
required: [
|
|
2704
|
+
'name',
|
|
2705
|
+
'versions',
|
|
2706
|
+
'version_channels',
|
|
2707
|
+
'latestVersion'
|
|
2708
|
+
],
|
|
1187
2709
|
additionalProperties: false
|
|
1188
2710
|
};
|
|
1189
2711
|
export const OrganizationCreateInputSchema = {
|
|
1190
2712
|
type: 'object',
|
|
1191
2713
|
properties: {
|
|
2714
|
+
type: {
|
|
2715
|
+
type: 'string',
|
|
2716
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2717
|
+
example: 'business',
|
|
2718
|
+
enum: [
|
|
2719
|
+
'business',
|
|
2720
|
+
'personal'
|
|
2721
|
+
]
|
|
2722
|
+
},
|
|
1192
2723
|
email: {
|
|
1193
2724
|
type: 'string',
|
|
1194
2725
|
format: 'email',
|
|
@@ -1197,11 +2728,13 @@ export const OrganizationCreateInputSchema = {
|
|
|
1197
2728
|
},
|
|
1198
2729
|
first_name: {
|
|
1199
2730
|
type: 'string',
|
|
2731
|
+
minLength: 1,
|
|
1200
2732
|
description: 'First name of the billing contact person.',
|
|
1201
2733
|
example: 'John'
|
|
1202
2734
|
},
|
|
1203
2735
|
last_name: {
|
|
1204
2736
|
type: 'string',
|
|
2737
|
+
minLength: 1,
|
|
1205
2738
|
description: 'Last name of the billing contact person.',
|
|
1206
2739
|
example: 'Doe'
|
|
1207
2740
|
},
|
|
@@ -1219,7 +2752,28 @@ export const OrganizationCreateInputSchema = {
|
|
|
1219
2752
|
description: 'Password for the root account. Must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one number and one special character.'
|
|
1220
2753
|
}
|
|
1221
2754
|
},
|
|
1222
|
-
required: [
|
|
2755
|
+
required: [
|
|
2756
|
+
'type',
|
|
2757
|
+
'email',
|
|
2758
|
+
'first_name',
|
|
2759
|
+
'last_name',
|
|
2760
|
+
'company_name',
|
|
2761
|
+
'password'
|
|
2762
|
+
],
|
|
2763
|
+
additionalProperties: false
|
|
2764
|
+
};
|
|
2765
|
+
export const OrganizationCreateOutputSchema = {
|
|
2766
|
+
type: 'object',
|
|
2767
|
+
properties: {
|
|
2768
|
+
id: {
|
|
2769
|
+
type: 'string',
|
|
2770
|
+
description: 'Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.',
|
|
2771
|
+
example: 'organization-id'
|
|
2772
|
+
}
|
|
2773
|
+
},
|
|
2774
|
+
required: [
|
|
2775
|
+
'id'
|
|
2776
|
+
],
|
|
1223
2777
|
additionalProperties: false
|
|
1224
2778
|
};
|
|
1225
2779
|
export const OrganizationSchema = {
|
|
@@ -1238,6 +2792,15 @@ export const OrganizationSchema = {
|
|
|
1238
2792
|
description: 'Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.',
|
|
1239
2793
|
example: 'ACME Corp.'
|
|
1240
2794
|
},
|
|
2795
|
+
type: {
|
|
2796
|
+
type: 'string',
|
|
2797
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2798
|
+
example: 'business',
|
|
2799
|
+
enum: [
|
|
2800
|
+
'business',
|
|
2801
|
+
'personal'
|
|
2802
|
+
]
|
|
2803
|
+
},
|
|
1241
2804
|
date_created: {
|
|
1242
2805
|
type: 'string',
|
|
1243
2806
|
format: 'date-time',
|
|
@@ -1269,6 +2832,17 @@ export const OrganizationSchema = {
|
|
|
1269
2832
|
description: 'Available number of Pro clusters that can be created.',
|
|
1270
2833
|
example: 999
|
|
1271
2834
|
},
|
|
2835
|
+
enterprise_clusters_max: {
|
|
2836
|
+
type: 'integer',
|
|
2837
|
+
minimum: 0,
|
|
2838
|
+
description: 'Maximum number of Enterprise clusters that can be created.',
|
|
2839
|
+
example: 999
|
|
2840
|
+
},
|
|
2841
|
+
enterprise_clusters_available: {
|
|
2842
|
+
type: 'integer',
|
|
2843
|
+
description: 'Available number of Enterprise clusters that can be created.',
|
|
2844
|
+
example: 999
|
|
2845
|
+
},
|
|
1272
2846
|
fleets_max: {
|
|
1273
2847
|
type: 'integer',
|
|
1274
2848
|
minimum: 0,
|
|
@@ -1279,107 +2853,873 @@ export const OrganizationSchema = {
|
|
|
1279
2853
|
type: 'array',
|
|
1280
2854
|
items: {
|
|
1281
2855
|
type: 'string',
|
|
1282
|
-
example: 'basic'
|
|
2856
|
+
example: 'basic'
|
|
2857
|
+
},
|
|
2858
|
+
minItems: 0,
|
|
2859
|
+
description: 'List of Cloudfleet cluster tiers available for the organization.'
|
|
2860
|
+
},
|
|
2861
|
+
regions: {
|
|
2862
|
+
type: 'array',
|
|
2863
|
+
items: {
|
|
2864
|
+
type: 'string',
|
|
2865
|
+
example: 'northamerica-central-1a'
|
|
2866
|
+
},
|
|
2867
|
+
minItems: 1,
|
|
2868
|
+
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
2869
|
+
},
|
|
2870
|
+
versions: {
|
|
2871
|
+
type: 'array',
|
|
2872
|
+
items: {
|
|
2873
|
+
type: 'object',
|
|
2874
|
+
properties: {
|
|
2875
|
+
id: {
|
|
2876
|
+
type: 'string',
|
|
2877
|
+
description: 'Id of the control plane version. Used in API calls.',
|
|
2878
|
+
example: '1.33.x-cfke.x'
|
|
2879
|
+
},
|
|
2880
|
+
label: {
|
|
2881
|
+
type: 'string',
|
|
2882
|
+
description: 'Label of the control plane version. Used in frontent UI.',
|
|
2883
|
+
example: '1.33.x (Always latest 1.33 patch version)'
|
|
2884
|
+
}
|
|
2885
|
+
},
|
|
2886
|
+
required: [
|
|
2887
|
+
'id',
|
|
2888
|
+
'label'
|
|
2889
|
+
],
|
|
2890
|
+
additionalProperties: false
|
|
2891
|
+
},
|
|
2892
|
+
minItems: 1,
|
|
2893
|
+
description: 'List of CFKE control plane versions available for the organization.'
|
|
2894
|
+
},
|
|
2895
|
+
cfcr_storage_gb: {
|
|
2896
|
+
type: 'integer',
|
|
2897
|
+
minimum: -1,
|
|
2898
|
+
description: 'Organization-level maximum CFCR storage volume in GB. -1 means no limit.',
|
|
2899
|
+
example: 500
|
|
2900
|
+
}
|
|
2901
|
+
},
|
|
2902
|
+
required: [
|
|
2903
|
+
'basic_clusters_max',
|
|
2904
|
+
'basic_clusters_available',
|
|
2905
|
+
'pro_clusters_max',
|
|
2906
|
+
'pro_clusters_available',
|
|
2907
|
+
'enterprise_clusters_max',
|
|
2908
|
+
'enterprise_clusters_available',
|
|
2909
|
+
'fleets_max',
|
|
2910
|
+
'cluster_tiers',
|
|
2911
|
+
'regions',
|
|
2912
|
+
'versions',
|
|
2913
|
+
'cfcr_storage_gb'
|
|
2914
|
+
],
|
|
2915
|
+
additionalProperties: false,
|
|
2916
|
+
description: 'For security reasons, platform quota is controlled by Cloudfleet and can be updated only by Cloudfleet administrators. Please open a support ticket if you need to change the platform quota.'
|
|
2917
|
+
},
|
|
2918
|
+
status: {
|
|
2919
|
+
type: 'string',
|
|
2920
|
+
description: 'Status of the organization. Can be `active` or `closed`, or `suspended`.',
|
|
2921
|
+
enum: [
|
|
2922
|
+
'active',
|
|
2923
|
+
'closed',
|
|
2924
|
+
'suspended'
|
|
2925
|
+
]
|
|
2926
|
+
},
|
|
2927
|
+
verification: {
|
|
2928
|
+
type: 'string',
|
|
2929
|
+
description: 'Verification status of the organization, which determines the assigned quota. `none` when billing information is incomplete, `submitted` when billing information is complete but the organization is not yet verified, `verified` when the organization is verified.',
|
|
2930
|
+
example: 'verified',
|
|
2931
|
+
enum: [
|
|
2932
|
+
'none',
|
|
2933
|
+
'submitted',
|
|
2934
|
+
'verified'
|
|
2935
|
+
]
|
|
2936
|
+
}
|
|
2937
|
+
},
|
|
2938
|
+
required: [
|
|
2939
|
+
'id',
|
|
2940
|
+
'type',
|
|
2941
|
+
'date_created',
|
|
2942
|
+
'quota',
|
|
2943
|
+
'status',
|
|
2944
|
+
'verification'
|
|
2945
|
+
],
|
|
2946
|
+
additionalProperties: false
|
|
2947
|
+
};
|
|
2948
|
+
export const PaymentMethodSchema = {
|
|
2949
|
+
type: 'object',
|
|
2950
|
+
properties: {
|
|
2951
|
+
id: {
|
|
2952
|
+
type: 'string',
|
|
2953
|
+
description: 'Payment method identifier. Stripe payment method id for cards/SEPA; the constant `bank_transfer` for the invoice/bank-transfer method. Used to set as default or delete the payment method.',
|
|
2954
|
+
example: 'pm_1MtwBwLkdIwHu7ix28a3tqPa'
|
|
2955
|
+
},
|
|
2956
|
+
type: {
|
|
2957
|
+
type: 'string',
|
|
2958
|
+
description: 'Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.',
|
|
2959
|
+
example: 'card',
|
|
2960
|
+
enum: [
|
|
2961
|
+
'card',
|
|
2962
|
+
'sepa_debit',
|
|
2963
|
+
'bank_transfer'
|
|
2964
|
+
]
|
|
2965
|
+
},
|
|
2966
|
+
last4: {
|
|
2967
|
+
type: 'string',
|
|
2968
|
+
nullable: true,
|
|
2969
|
+
description: 'Last 4 digits of the payment card number, of the bank account (IBAN) for SEPA Direct Debit, or of the destination IBAN for bank transfer.',
|
|
2970
|
+
example: '4242'
|
|
2971
|
+
},
|
|
2972
|
+
exp_month: {
|
|
2973
|
+
type: 'integer',
|
|
2974
|
+
minimum: 1,
|
|
2975
|
+
maximum: 12,
|
|
2976
|
+
nullable: true,
|
|
2977
|
+
description: 'Two-digit number representing the card\'s expiration month. Null for SEPA Direct Debit and bank transfer.',
|
|
2978
|
+
example: 12
|
|
2979
|
+
},
|
|
2980
|
+
exp_year: {
|
|
2981
|
+
type: 'integer',
|
|
2982
|
+
nullable: true,
|
|
2983
|
+
description: 'Four-digit number representing the card\'s expiration year. May be in the past for an expired card still on file. Null for SEPA Direct Debit and bank transfer.',
|
|
2984
|
+
example: 2028
|
|
2985
|
+
},
|
|
2986
|
+
brand: {
|
|
2987
|
+
type: 'string',
|
|
2988
|
+
nullable: true,
|
|
2989
|
+
description: 'Payment card brand as reported by Stripe, e.g. `visa`, `mastercard`, `amex`, `cartes_bancaires`, or `unknown`. Null for SEPA Direct Debit and bank transfer.',
|
|
2990
|
+
example: 'visa'
|
|
2991
|
+
},
|
|
2992
|
+
iban: {
|
|
2993
|
+
type: 'string',
|
|
2994
|
+
nullable: true,
|
|
2995
|
+
description: 'Full destination IBAN to send bank transfers to. Set only for `bank_transfer`; null otherwise. This is Cloudfleet\'s virtual receiving account, shown in full so the customer can pay into it.',
|
|
2996
|
+
example: 'DE11243015658023127510'
|
|
2997
|
+
},
|
|
2998
|
+
bic: {
|
|
2999
|
+
type: 'string',
|
|
3000
|
+
nullable: true,
|
|
3001
|
+
description: 'BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
3002
|
+
example: 'SOGEDEFFXXX'
|
|
3003
|
+
},
|
|
3004
|
+
account_holder_name: {
|
|
3005
|
+
type: 'string',
|
|
3006
|
+
nullable: true,
|
|
3007
|
+
description: 'Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
3008
|
+
example: 'Cloudfleet GmbH'
|
|
3009
|
+
},
|
|
3010
|
+
is_default: {
|
|
3011
|
+
type: 'boolean',
|
|
3012
|
+
description: 'Whether this payment method is the default used for invoices and active subscriptions. Always false for `bank_transfer` (it cannot be a Stripe default payment method).',
|
|
3013
|
+
example: true
|
|
3014
|
+
}
|
|
3015
|
+
},
|
|
3016
|
+
required: [
|
|
3017
|
+
'id',
|
|
3018
|
+
'type',
|
|
3019
|
+
'last4',
|
|
3020
|
+
'exp_month',
|
|
3021
|
+
'exp_year',
|
|
3022
|
+
'brand',
|
|
3023
|
+
'iban',
|
|
3024
|
+
'bic',
|
|
3025
|
+
'account_holder_name',
|
|
3026
|
+
'is_default'
|
|
3027
|
+
],
|
|
3028
|
+
additionalProperties: false
|
|
3029
|
+
};
|
|
3030
|
+
export const PlatformQuotaSchema = {
|
|
3031
|
+
type: 'object',
|
|
3032
|
+
properties: {
|
|
3033
|
+
basic_clusters_max: {
|
|
3034
|
+
type: 'integer',
|
|
3035
|
+
minimum: 0,
|
|
3036
|
+
description: 'Maximum number of Basic clusters that can be created.',
|
|
3037
|
+
example: 999
|
|
3038
|
+
},
|
|
3039
|
+
basic_clusters_available: {
|
|
3040
|
+
type: 'integer',
|
|
3041
|
+
description: 'Available number of Basic clusters that can be created.',
|
|
3042
|
+
example: 999
|
|
3043
|
+
},
|
|
3044
|
+
pro_clusters_max: {
|
|
3045
|
+
type: 'integer',
|
|
3046
|
+
minimum: 0,
|
|
3047
|
+
description: 'Maximum number of Pro clusters that can be created.',
|
|
3048
|
+
example: 999
|
|
3049
|
+
},
|
|
3050
|
+
pro_clusters_available: {
|
|
3051
|
+
type: 'integer',
|
|
3052
|
+
description: 'Available number of Pro clusters that can be created.',
|
|
3053
|
+
example: 999
|
|
3054
|
+
},
|
|
3055
|
+
enterprise_clusters_max: {
|
|
3056
|
+
type: 'integer',
|
|
3057
|
+
minimum: 0,
|
|
3058
|
+
description: 'Maximum number of Enterprise clusters that can be created.',
|
|
3059
|
+
example: 999
|
|
3060
|
+
},
|
|
3061
|
+
enterprise_clusters_available: {
|
|
3062
|
+
type: 'integer',
|
|
3063
|
+
description: 'Available number of Enterprise clusters that can be created.',
|
|
3064
|
+
example: 999
|
|
3065
|
+
},
|
|
3066
|
+
fleets_max: {
|
|
3067
|
+
type: 'integer',
|
|
3068
|
+
minimum: 0,
|
|
3069
|
+
description: 'Maximum number of fleets that can be created per cluster.',
|
|
3070
|
+
example: 999
|
|
3071
|
+
},
|
|
3072
|
+
cluster_tiers: {
|
|
3073
|
+
type: 'array',
|
|
3074
|
+
items: {
|
|
3075
|
+
type: 'string',
|
|
3076
|
+
example: 'basic'
|
|
3077
|
+
},
|
|
3078
|
+
minItems: 0,
|
|
3079
|
+
description: 'List of Cloudfleet cluster tiers available for the organization.'
|
|
3080
|
+
},
|
|
3081
|
+
regions: {
|
|
3082
|
+
type: 'array',
|
|
3083
|
+
items: {
|
|
3084
|
+
type: 'string',
|
|
3085
|
+
example: 'northamerica-central-1a'
|
|
3086
|
+
},
|
|
3087
|
+
minItems: 1,
|
|
3088
|
+
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
3089
|
+
},
|
|
3090
|
+
versions: {
|
|
3091
|
+
type: 'array',
|
|
3092
|
+
items: {
|
|
3093
|
+
type: 'object',
|
|
3094
|
+
properties: {
|
|
3095
|
+
id: {
|
|
3096
|
+
type: 'string',
|
|
3097
|
+
description: 'Id of the control plane version. Used in API calls.',
|
|
3098
|
+
example: '1.33.x-cfke.x'
|
|
3099
|
+
},
|
|
3100
|
+
label: {
|
|
3101
|
+
type: 'string',
|
|
3102
|
+
description: 'Label of the control plane version. Used in frontent UI.',
|
|
3103
|
+
example: '1.33.x (Always latest 1.33 patch version)'
|
|
3104
|
+
}
|
|
3105
|
+
},
|
|
3106
|
+
required: [
|
|
3107
|
+
'id',
|
|
3108
|
+
'label'
|
|
3109
|
+
],
|
|
3110
|
+
additionalProperties: false
|
|
3111
|
+
},
|
|
3112
|
+
minItems: 1,
|
|
3113
|
+
description: 'List of CFKE control plane versions available for the organization.'
|
|
3114
|
+
},
|
|
3115
|
+
cfcr_storage_gb: {
|
|
3116
|
+
type: 'integer',
|
|
3117
|
+
minimum: -1,
|
|
3118
|
+
description: 'Organization-level maximum CFCR storage volume in GB. -1 means no limit.',
|
|
3119
|
+
example: 500
|
|
3120
|
+
}
|
|
3121
|
+
},
|
|
3122
|
+
required: [
|
|
3123
|
+
'basic_clusters_max',
|
|
3124
|
+
'basic_clusters_available',
|
|
3125
|
+
'pro_clusters_max',
|
|
3126
|
+
'pro_clusters_available',
|
|
3127
|
+
'enterprise_clusters_max',
|
|
3128
|
+
'enterprise_clusters_available',
|
|
3129
|
+
'fleets_max',
|
|
3130
|
+
'cluster_tiers',
|
|
3131
|
+
'regions',
|
|
3132
|
+
'versions',
|
|
3133
|
+
'cfcr_storage_gb'
|
|
3134
|
+
],
|
|
3135
|
+
additionalProperties: false
|
|
3136
|
+
};
|
|
3137
|
+
export const RegistryRepositorySchema = {
|
|
3138
|
+
type: 'object',
|
|
3139
|
+
properties: {
|
|
3140
|
+
name: {
|
|
3141
|
+
type: 'string',
|
|
3142
|
+
description: 'Repository name.',
|
|
3143
|
+
example: 'my-app'
|
|
3144
|
+
},
|
|
3145
|
+
region: {
|
|
3146
|
+
type: 'string',
|
|
3147
|
+
description: 'Registry region.',
|
|
3148
|
+
example: 'northamerica'
|
|
3149
|
+
},
|
|
3150
|
+
uri: {
|
|
3151
|
+
type: 'string',
|
|
3152
|
+
description: 'Full URI of the repository.',
|
|
3153
|
+
example: 'ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app'
|
|
3154
|
+
}
|
|
3155
|
+
},
|
|
3156
|
+
required: [
|
|
3157
|
+
'name',
|
|
3158
|
+
'region',
|
|
3159
|
+
'uri'
|
|
3160
|
+
],
|
|
3161
|
+
additionalProperties: false
|
|
3162
|
+
};
|
|
3163
|
+
export const RegistryRepositoryWithTagsSchema = {
|
|
3164
|
+
type: 'object',
|
|
3165
|
+
properties: {
|
|
3166
|
+
name: {
|
|
3167
|
+
type: 'string',
|
|
3168
|
+
description: 'Repository name.',
|
|
3169
|
+
example: 'my-app'
|
|
3170
|
+
},
|
|
3171
|
+
region: {
|
|
3172
|
+
type: 'string',
|
|
3173
|
+
description: 'Registry region.',
|
|
3174
|
+
example: 'northamerica'
|
|
3175
|
+
},
|
|
3176
|
+
uri: {
|
|
3177
|
+
type: 'string',
|
|
3178
|
+
description: 'Full URI of the repository.',
|
|
3179
|
+
example: 'ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app'
|
|
3180
|
+
},
|
|
3181
|
+
tags: {
|
|
3182
|
+
type: 'array',
|
|
3183
|
+
items: {
|
|
3184
|
+
type: 'object',
|
|
3185
|
+
properties: {
|
|
3186
|
+
name: {
|
|
3187
|
+
type: 'string',
|
|
3188
|
+
description: 'Tag name.',
|
|
3189
|
+
example: 'latest'
|
|
3190
|
+
},
|
|
3191
|
+
size: {
|
|
3192
|
+
type: 'number',
|
|
3193
|
+
format: 'float',
|
|
3194
|
+
description: 'Size of the tag in bytes.',
|
|
3195
|
+
example: 123456789
|
|
3196
|
+
},
|
|
3197
|
+
mediaType: {
|
|
3198
|
+
type: 'string',
|
|
3199
|
+
description: 'Media type of the manifest.',
|
|
3200
|
+
example: 'application/vnd.docker.distribution.manifest.v2+json'
|
|
3201
|
+
},
|
|
3202
|
+
platforms: {
|
|
3203
|
+
type: 'array',
|
|
3204
|
+
items: {
|
|
3205
|
+
type: 'string'
|
|
3206
|
+
},
|
|
3207
|
+
description: 'Array of platform strings for multi-arch images (e.g., linux/amd64, linux/arm64).',
|
|
3208
|
+
example: [
|
|
3209
|
+
'linux/amd64',
|
|
3210
|
+
'linux/arm64'
|
|
3211
|
+
]
|
|
3212
|
+
}
|
|
3213
|
+
},
|
|
3214
|
+
required: [
|
|
3215
|
+
'name',
|
|
3216
|
+
'size'
|
|
3217
|
+
],
|
|
3218
|
+
additionalProperties: false
|
|
3219
|
+
},
|
|
3220
|
+
description: 'Array of tags in the repository.'
|
|
3221
|
+
},
|
|
3222
|
+
totalSize: {
|
|
3223
|
+
type: 'number',
|
|
3224
|
+
format: 'float',
|
|
3225
|
+
description: 'Total size of all tags in the repository in bytes.',
|
|
3226
|
+
example: 987654321
|
|
3227
|
+
}
|
|
3228
|
+
},
|
|
3229
|
+
required: [
|
|
3230
|
+
'name',
|
|
3231
|
+
'region',
|
|
3232
|
+
'uri',
|
|
3233
|
+
'tags',
|
|
3234
|
+
'totalSize'
|
|
3235
|
+
],
|
|
3236
|
+
additionalProperties: false
|
|
3237
|
+
};
|
|
3238
|
+
export const RegistryTagSchema = {
|
|
3239
|
+
type: 'object',
|
|
3240
|
+
properties: {
|
|
3241
|
+
name: {
|
|
3242
|
+
type: 'string',
|
|
3243
|
+
description: 'Tag name.',
|
|
3244
|
+
example: 'latest'
|
|
3245
|
+
},
|
|
3246
|
+
digest: {
|
|
3247
|
+
type: 'string',
|
|
3248
|
+
description: 'Manifest digest for pulling by digest.',
|
|
3249
|
+
example: 'sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890'
|
|
3250
|
+
},
|
|
3251
|
+
mediaType: {
|
|
3252
|
+
type: 'string',
|
|
3253
|
+
description: 'Media type of the manifest.',
|
|
3254
|
+
example: 'application/vnd.docker.distribution.manifest.v2+json'
|
|
3255
|
+
},
|
|
3256
|
+
config: {
|
|
3257
|
+
type: 'object',
|
|
3258
|
+
properties: {
|
|
3259
|
+
size: {
|
|
3260
|
+
type: 'number',
|
|
3261
|
+
format: 'float',
|
|
3262
|
+
description: 'Size of the config in bytes.',
|
|
3263
|
+
example: 1234
|
|
3264
|
+
}
|
|
3265
|
+
},
|
|
3266
|
+
required: [
|
|
3267
|
+
'size'
|
|
3268
|
+
],
|
|
3269
|
+
additionalProperties: false,
|
|
3270
|
+
description: 'Manifest config metadata.'
|
|
3271
|
+
},
|
|
3272
|
+
layers: {
|
|
3273
|
+
type: 'array',
|
|
3274
|
+
items: {
|
|
3275
|
+
type: 'object',
|
|
3276
|
+
properties: {
|
|
3277
|
+
digest: {
|
|
3278
|
+
type: 'string',
|
|
3279
|
+
description: 'Digest of the layer.',
|
|
3280
|
+
example: 'sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890'
|
|
3281
|
+
},
|
|
3282
|
+
size: {
|
|
3283
|
+
type: 'number',
|
|
3284
|
+
format: 'float',
|
|
3285
|
+
description: 'Size of the layer in bytes.',
|
|
3286
|
+
example: 5678
|
|
3287
|
+
}
|
|
3288
|
+
},
|
|
3289
|
+
required: [
|
|
3290
|
+
'size'
|
|
3291
|
+
],
|
|
3292
|
+
additionalProperties: false
|
|
3293
|
+
},
|
|
3294
|
+
description: 'Array of layer metadata.'
|
|
3295
|
+
},
|
|
3296
|
+
manifests: {
|
|
3297
|
+
type: 'array',
|
|
3298
|
+
items: {
|
|
3299
|
+
type: 'object',
|
|
3300
|
+
properties: {
|
|
3301
|
+
digest: {
|
|
3302
|
+
type: 'string',
|
|
3303
|
+
description: 'Digest of the manifest.',
|
|
3304
|
+
example: 'sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890'
|
|
3305
|
+
},
|
|
3306
|
+
platform: {
|
|
3307
|
+
type: 'object',
|
|
3308
|
+
properties: {
|
|
3309
|
+
architecture: {
|
|
3310
|
+
type: 'string',
|
|
3311
|
+
description: 'Architecture of the platform.',
|
|
3312
|
+
example: 'amd64'
|
|
3313
|
+
},
|
|
3314
|
+
os: {
|
|
3315
|
+
type: 'string',
|
|
3316
|
+
description: 'Operating system of the platform.',
|
|
3317
|
+
example: 'linux'
|
|
3318
|
+
},
|
|
3319
|
+
variant: {
|
|
3320
|
+
type: 'string',
|
|
3321
|
+
description: 'Variant of the platform (e.g., v7, v8 for ARM).',
|
|
3322
|
+
example: 'v8'
|
|
3323
|
+
}
|
|
3324
|
+
},
|
|
3325
|
+
required: [
|
|
3326
|
+
'architecture',
|
|
3327
|
+
'os'
|
|
3328
|
+
],
|
|
3329
|
+
additionalProperties: false,
|
|
3330
|
+
description: 'Platform information for the manifest.'
|
|
3331
|
+
},
|
|
3332
|
+
layers: {
|
|
3333
|
+
type: 'array',
|
|
3334
|
+
items: {
|
|
3335
|
+
type: 'object',
|
|
3336
|
+
properties: {
|
|
3337
|
+
digest: {
|
|
3338
|
+
type: 'string',
|
|
3339
|
+
description: 'Digest of the layer.',
|
|
3340
|
+
example: 'sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890'
|
|
3341
|
+
},
|
|
3342
|
+
size: {
|
|
3343
|
+
type: 'number',
|
|
3344
|
+
format: 'float',
|
|
3345
|
+
description: 'Size of the layer in bytes.',
|
|
3346
|
+
example: 5678
|
|
3347
|
+
}
|
|
3348
|
+
},
|
|
3349
|
+
required: [
|
|
3350
|
+
'size'
|
|
3351
|
+
],
|
|
3352
|
+
additionalProperties: false
|
|
3353
|
+
},
|
|
3354
|
+
description: 'Layers for this platform.'
|
|
3355
|
+
},
|
|
3356
|
+
size: {
|
|
3357
|
+
type: 'number',
|
|
3358
|
+
format: 'float',
|
|
3359
|
+
description: 'Total size of this platform manifest in bytes.',
|
|
3360
|
+
example: 12345678
|
|
3361
|
+
}
|
|
3362
|
+
},
|
|
3363
|
+
required: [
|
|
3364
|
+
'digest'
|
|
3365
|
+
],
|
|
3366
|
+
additionalProperties: false
|
|
3367
|
+
},
|
|
3368
|
+
description: 'Array of manifests for multi-arch images.'
|
|
3369
|
+
},
|
|
3370
|
+
size: {
|
|
3371
|
+
type: 'number',
|
|
3372
|
+
format: 'float',
|
|
3373
|
+
description: 'Total size of the tag in bytes.',
|
|
3374
|
+
example: 123456789
|
|
3375
|
+
},
|
|
3376
|
+
region: {
|
|
3377
|
+
type: 'string',
|
|
3378
|
+
description: 'Registry region.',
|
|
3379
|
+
example: 'northamerica'
|
|
3380
|
+
},
|
|
3381
|
+
repository: {
|
|
3382
|
+
type: 'string',
|
|
3383
|
+
description: 'Repository name.',
|
|
3384
|
+
example: 'my-app'
|
|
3385
|
+
},
|
|
3386
|
+
uri: {
|
|
3387
|
+
type: 'string',
|
|
3388
|
+
description: 'Full URI of the tag.',
|
|
3389
|
+
example: 'ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app:latest'
|
|
3390
|
+
}
|
|
3391
|
+
},
|
|
3392
|
+
required: [
|
|
3393
|
+
'name',
|
|
3394
|
+
'digest',
|
|
3395
|
+
'size',
|
|
3396
|
+
'region',
|
|
3397
|
+
'repository',
|
|
3398
|
+
'uri'
|
|
3399
|
+
],
|
|
3400
|
+
additionalProperties: false
|
|
3401
|
+
};
|
|
3402
|
+
export const TicketAttachmentSchema = {
|
|
3403
|
+
type: 'object',
|
|
3404
|
+
properties: {
|
|
3405
|
+
id: {
|
|
3406
|
+
type: 'string',
|
|
3407
|
+
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
3408
|
+
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
3409
|
+
},
|
|
3410
|
+
filename: {
|
|
3411
|
+
type: 'string',
|
|
3412
|
+
description: 'Original filename as uploaded.',
|
|
3413
|
+
example: 'debug.log'
|
|
3414
|
+
},
|
|
3415
|
+
content_type: {
|
|
3416
|
+
type: 'string',
|
|
3417
|
+
description: 'MIME content type of the attachment.',
|
|
3418
|
+
example: 'text/plain'
|
|
3419
|
+
},
|
|
3420
|
+
size: {
|
|
3421
|
+
type: 'integer',
|
|
3422
|
+
description: 'Size of the attachment in bytes.',
|
|
3423
|
+
example: 12345
|
|
3424
|
+
}
|
|
3425
|
+
},
|
|
3426
|
+
required: [
|
|
3427
|
+
'id',
|
|
3428
|
+
'filename',
|
|
3429
|
+
'content_type',
|
|
3430
|
+
'size'
|
|
3431
|
+
],
|
|
3432
|
+
additionalProperties: false
|
|
3433
|
+
};
|
|
3434
|
+
export const TicketCreateInputSchema = {
|
|
3435
|
+
type: 'object',
|
|
3436
|
+
properties: {
|
|
3437
|
+
category: {
|
|
3438
|
+
type: 'string',
|
|
3439
|
+
description: 'Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.',
|
|
3440
|
+
example: 'technical',
|
|
3441
|
+
enum: [
|
|
3442
|
+
'billing',
|
|
3443
|
+
'technical',
|
|
3444
|
+
'general'
|
|
3445
|
+
]
|
|
3446
|
+
},
|
|
3447
|
+
body: {
|
|
3448
|
+
type: 'string',
|
|
3449
|
+
maxLength: 50000,
|
|
3450
|
+
minLength: 1,
|
|
3451
|
+
pattern: '\\S',
|
|
3452
|
+
description: 'Initial message body in markdown. There is no separate subject — the first message body is the description.',
|
|
3453
|
+
example: 'My cluster cannot reach the registry. Logs attached.'
|
|
3454
|
+
},
|
|
3455
|
+
properties: {
|
|
3456
|
+
type: 'object',
|
|
3457
|
+
additionalProperties: true,
|
|
3458
|
+
description: 'Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).',
|
|
3459
|
+
example: {
|
|
3460
|
+
subcategory: 'cluster-question',
|
|
3461
|
+
cluster_id: '60c72b2f9f1b2c001f8e4d3a'
|
|
3462
|
+
}
|
|
3463
|
+
}
|
|
3464
|
+
},
|
|
3465
|
+
required: [
|
|
3466
|
+
'category',
|
|
3467
|
+
'body'
|
|
3468
|
+
],
|
|
3469
|
+
additionalProperties: false
|
|
3470
|
+
};
|
|
3471
|
+
export const TicketMessageInputSchema = {
|
|
3472
|
+
type: 'object',
|
|
3473
|
+
properties: {
|
|
3474
|
+
body: {
|
|
3475
|
+
type: 'string',
|
|
3476
|
+
maxLength: 50000,
|
|
3477
|
+
minLength: 1,
|
|
3478
|
+
pattern: '\\S',
|
|
3479
|
+
description: 'Reply body in markdown.',
|
|
3480
|
+
example: 'Thanks — that resolved it on my side.'
|
|
3481
|
+
}
|
|
3482
|
+
},
|
|
3483
|
+
required: [
|
|
3484
|
+
'body'
|
|
3485
|
+
],
|
|
3486
|
+
additionalProperties: false
|
|
3487
|
+
};
|
|
3488
|
+
export const TicketMessageSchema = {
|
|
3489
|
+
type: 'object',
|
|
3490
|
+
properties: {
|
|
3491
|
+
id: {
|
|
3492
|
+
type: 'string',
|
|
3493
|
+
description: 'Unique identifier of the message (Mongo ObjectId).',
|
|
3494
|
+
example: '60c72b2f9f1b2c001f8e4d3b'
|
|
3495
|
+
},
|
|
3496
|
+
type: {
|
|
3497
|
+
type: 'string',
|
|
3498
|
+
description: 'Message type. Internal notes are filtered out of customer-facing responses.',
|
|
3499
|
+
example: 'customer_reply',
|
|
3500
|
+
enum: [
|
|
3501
|
+
'customer_reply',
|
|
3502
|
+
'agent_reply'
|
|
3503
|
+
]
|
|
3504
|
+
},
|
|
3505
|
+
body: {
|
|
3506
|
+
type: 'string',
|
|
3507
|
+
description: 'Message body in markdown.',
|
|
3508
|
+
example: 'Thanks — that resolved it on my side.'
|
|
3509
|
+
},
|
|
3510
|
+
author_first_name: {
|
|
3511
|
+
type: 'string',
|
|
3512
|
+
nullable: true,
|
|
3513
|
+
description: 'First name of the author. Null when not provided.',
|
|
3514
|
+
example: 'Jane'
|
|
3515
|
+
},
|
|
3516
|
+
author_last_name: {
|
|
3517
|
+
type: 'string',
|
|
3518
|
+
nullable: true,
|
|
3519
|
+
description: 'Last name of the author. Null when not provided.',
|
|
3520
|
+
example: 'Doe'
|
|
3521
|
+
},
|
|
3522
|
+
attachments: {
|
|
3523
|
+
type: 'array',
|
|
3524
|
+
items: {
|
|
3525
|
+
type: 'object',
|
|
3526
|
+
properties: {
|
|
3527
|
+
id: {
|
|
3528
|
+
type: 'string',
|
|
3529
|
+
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
3530
|
+
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
1283
3531
|
},
|
|
1284
|
-
|
|
1285
|
-
description: 'List of Cloudfleet cluster tiers available for the organization.'
|
|
1286
|
-
},
|
|
1287
|
-
regions: {
|
|
1288
|
-
type: 'array',
|
|
1289
|
-
items: {
|
|
3532
|
+
filename: {
|
|
1290
3533
|
type: 'string',
|
|
1291
|
-
|
|
3534
|
+
description: 'Original filename as uploaded.',
|
|
3535
|
+
example: 'debug.log'
|
|
1292
3536
|
},
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
type: 'array',
|
|
1298
|
-
items: {
|
|
1299
|
-
type: 'object',
|
|
1300
|
-
properties: {
|
|
1301
|
-
id: {
|
|
1302
|
-
type: 'string',
|
|
1303
|
-
description: 'Id of the control plane version. Used in API calls.',
|
|
1304
|
-
example: '1.29.x-cfke.x'
|
|
1305
|
-
},
|
|
1306
|
-
label: {
|
|
1307
|
-
type: 'string',
|
|
1308
|
-
description: 'Label of the control plane version. Used in frontent UI.',
|
|
1309
|
-
example: '1.29.x (Always latest 1.29 patch version)'
|
|
1310
|
-
}
|
|
1311
|
-
},
|
|
1312
|
-
required: ['id', 'label'],
|
|
1313
|
-
additionalProperties: false
|
|
3537
|
+
content_type: {
|
|
3538
|
+
type: 'string',
|
|
3539
|
+
description: 'MIME content type of the attachment.',
|
|
3540
|
+
example: 'text/plain'
|
|
1314
3541
|
},
|
|
1315
|
-
|
|
1316
|
-
|
|
1317
|
-
|
|
3542
|
+
size: {
|
|
3543
|
+
type: 'integer',
|
|
3544
|
+
description: 'Size of the attachment in bytes.',
|
|
3545
|
+
example: 12345
|
|
3546
|
+
}
|
|
3547
|
+
},
|
|
3548
|
+
required: [
|
|
3549
|
+
'id',
|
|
3550
|
+
'filename',
|
|
3551
|
+
'content_type',
|
|
3552
|
+
'size'
|
|
3553
|
+
],
|
|
3554
|
+
additionalProperties: false
|
|
1318
3555
|
},
|
|
1319
|
-
|
|
1320
|
-
|
|
1321
|
-
description: 'For security reasons, platform quota is controlled by Cloudfleet and can be updated only by Cloudfleet administrators. Please open a support ticket if you need to change the platform quota.'
|
|
3556
|
+
description: 'Attachments associated with this message.',
|
|
3557
|
+
example: []
|
|
1322
3558
|
},
|
|
1323
|
-
|
|
3559
|
+
date_created: {
|
|
1324
3560
|
type: 'string',
|
|
1325
|
-
|
|
1326
|
-
|
|
3561
|
+
format: 'date-time',
|
|
3562
|
+
description: 'Creation date of the message. ISO 8601 UTC.',
|
|
3563
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
1327
3564
|
}
|
|
1328
3565
|
},
|
|
1329
|
-
required: [
|
|
3566
|
+
required: [
|
|
3567
|
+
'id',
|
|
3568
|
+
'type',
|
|
3569
|
+
'body',
|
|
3570
|
+
'date_created'
|
|
3571
|
+
],
|
|
1330
3572
|
additionalProperties: false
|
|
1331
3573
|
};
|
|
1332
|
-
export const
|
|
3574
|
+
export const TicketSchema = {
|
|
1333
3575
|
type: 'object',
|
|
1334
3576
|
properties: {
|
|
1335
3577
|
id: {
|
|
1336
3578
|
type: 'string',
|
|
1337
|
-
|
|
1338
|
-
|
|
1339
|
-
example: 'e94d30ec-a2dd-4dcb-832c-ac2be144ba91'
|
|
3579
|
+
description: 'Unique identifier of the ticket (Mongo ObjectId).',
|
|
3580
|
+
example: '60c72b2f9f1b2c001f8e4d3a'
|
|
1340
3581
|
},
|
|
1341
|
-
|
|
1342
|
-
type: '
|
|
1343
|
-
description: '
|
|
1344
|
-
example:
|
|
3582
|
+
status: {
|
|
3583
|
+
type: 'string',
|
|
3584
|
+
description: 'Current state of the ticket.',
|
|
3585
|
+
example: 'waiting_on_us',
|
|
3586
|
+
enum: [
|
|
3587
|
+
'waiting_on_us',
|
|
3588
|
+
'waiting_on_user',
|
|
3589
|
+
'closed'
|
|
3590
|
+
]
|
|
1345
3591
|
},
|
|
1346
|
-
|
|
3592
|
+
category: {
|
|
1347
3593
|
type: 'string',
|
|
1348
|
-
|
|
1349
|
-
|
|
1350
|
-
|
|
1351
|
-
|
|
3594
|
+
description: 'Ticket category.',
|
|
3595
|
+
example: 'technical',
|
|
3596
|
+
enum: [
|
|
3597
|
+
'billing',
|
|
3598
|
+
'technical',
|
|
3599
|
+
'general'
|
|
3600
|
+
]
|
|
1352
3601
|
},
|
|
1353
|
-
|
|
3602
|
+
summary: {
|
|
1354
3603
|
type: 'string',
|
|
1355
|
-
|
|
1356
|
-
|
|
1357
|
-
example: '4242'
|
|
3604
|
+
description: 'First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.',
|
|
3605
|
+
example: 'My cluster cannot reach the registry. Logs attached.'
|
|
1358
3606
|
},
|
|
1359
|
-
|
|
1360
|
-
type: '
|
|
1361
|
-
|
|
1362
|
-
maximum: 12,
|
|
3607
|
+
closed_at: {
|
|
3608
|
+
type: 'string',
|
|
3609
|
+
format: 'date-time',
|
|
1363
3610
|
nullable: true,
|
|
1364
|
-
description:
|
|
1365
|
-
example: '
|
|
3611
|
+
description: 'Closure timestamp. Null while the ticket is open.',
|
|
3612
|
+
example: '2026-05-18T16:08:14.338Z'
|
|
1366
3613
|
},
|
|
1367
|
-
|
|
1368
|
-
type: '
|
|
1369
|
-
|
|
1370
|
-
|
|
1371
|
-
|
|
1372
|
-
example: '2028'
|
|
3614
|
+
date_created: {
|
|
3615
|
+
type: 'string',
|
|
3616
|
+
format: 'date-time',
|
|
3617
|
+
description: 'Creation date of the ticket. ISO 8601 UTC.',
|
|
3618
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
1373
3619
|
},
|
|
1374
|
-
|
|
3620
|
+
date_updated: {
|
|
1375
3621
|
type: 'string',
|
|
1376
|
-
|
|
1377
|
-
description: '
|
|
1378
|
-
example: '
|
|
1379
|
-
|
|
3622
|
+
format: 'date-time',
|
|
3623
|
+
description: 'Last update date of the ticket. ISO 8601 UTC.',
|
|
3624
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
3625
|
+
},
|
|
3626
|
+
messages: {
|
|
3627
|
+
type: 'array',
|
|
3628
|
+
items: {
|
|
3629
|
+
type: 'object',
|
|
3630
|
+
properties: {
|
|
3631
|
+
id: {
|
|
3632
|
+
type: 'string',
|
|
3633
|
+
description: 'Unique identifier of the message (Mongo ObjectId).',
|
|
3634
|
+
example: '60c72b2f9f1b2c001f8e4d3b'
|
|
3635
|
+
},
|
|
3636
|
+
type: {
|
|
3637
|
+
type: 'string',
|
|
3638
|
+
description: 'Message type. Internal notes are filtered out of customer-facing responses.',
|
|
3639
|
+
example: 'customer_reply',
|
|
3640
|
+
enum: [
|
|
3641
|
+
'customer_reply',
|
|
3642
|
+
'agent_reply'
|
|
3643
|
+
]
|
|
3644
|
+
},
|
|
3645
|
+
body: {
|
|
3646
|
+
type: 'string',
|
|
3647
|
+
description: 'Message body in markdown.',
|
|
3648
|
+
example: 'Thanks — that resolved it on my side.'
|
|
3649
|
+
},
|
|
3650
|
+
author_first_name: {
|
|
3651
|
+
type: 'string',
|
|
3652
|
+
description: 'First name of the author. Null when not provided.',
|
|
3653
|
+
example: 'Jane'
|
|
3654
|
+
},
|
|
3655
|
+
author_last_name: {
|
|
3656
|
+
type: 'string',
|
|
3657
|
+
description: 'Last name of the author. Null when not provided.',
|
|
3658
|
+
example: 'Doe'
|
|
3659
|
+
},
|
|
3660
|
+
attachments: {
|
|
3661
|
+
type: 'array',
|
|
3662
|
+
items: {
|
|
3663
|
+
type: 'object',
|
|
3664
|
+
properties: {
|
|
3665
|
+
id: {
|
|
3666
|
+
type: 'string',
|
|
3667
|
+
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
3668
|
+
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
3669
|
+
},
|
|
3670
|
+
filename: {
|
|
3671
|
+
type: 'string',
|
|
3672
|
+
description: 'Original filename as uploaded.',
|
|
3673
|
+
example: 'debug.log'
|
|
3674
|
+
},
|
|
3675
|
+
content_type: {
|
|
3676
|
+
type: 'string',
|
|
3677
|
+
description: 'MIME content type of the attachment.',
|
|
3678
|
+
example: 'text/plain'
|
|
3679
|
+
},
|
|
3680
|
+
size: {
|
|
3681
|
+
type: 'integer',
|
|
3682
|
+
description: 'Size of the attachment in bytes.',
|
|
3683
|
+
example: 12345
|
|
3684
|
+
}
|
|
3685
|
+
},
|
|
3686
|
+
required: [
|
|
3687
|
+
'id',
|
|
3688
|
+
'filename',
|
|
3689
|
+
'content_type',
|
|
3690
|
+
'size'
|
|
3691
|
+
],
|
|
3692
|
+
additionalProperties: false
|
|
3693
|
+
},
|
|
3694
|
+
description: 'Attachments associated with this message.',
|
|
3695
|
+
example: []
|
|
3696
|
+
},
|
|
3697
|
+
date_created: {
|
|
3698
|
+
type: 'string',
|
|
3699
|
+
format: 'date-time',
|
|
3700
|
+
description: 'Creation date of the message. ISO 8601 UTC.',
|
|
3701
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
3702
|
+
}
|
|
3703
|
+
},
|
|
3704
|
+
required: [
|
|
3705
|
+
'id',
|
|
3706
|
+
'type',
|
|
3707
|
+
'body',
|
|
3708
|
+
'date_created'
|
|
3709
|
+
],
|
|
3710
|
+
additionalProperties: false
|
|
3711
|
+
},
|
|
3712
|
+
description: 'Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.'
|
|
1380
3713
|
}
|
|
1381
3714
|
},
|
|
1382
|
-
required: [
|
|
3715
|
+
required: [
|
|
3716
|
+
'id',
|
|
3717
|
+
'status',
|
|
3718
|
+
'category',
|
|
3719
|
+
'summary',
|
|
3720
|
+
'date_created',
|
|
3721
|
+
'date_updated'
|
|
3722
|
+
],
|
|
1383
3723
|
additionalProperties: false
|
|
1384
3724
|
};
|
|
1385
3725
|
export const TokenCreateInputSchema = {
|
|
@@ -1397,10 +3737,16 @@ export const TokenCreateInputSchema = {
|
|
|
1397
3737
|
type: 'string',
|
|
1398
3738
|
description: 'Role assumed by the token.',
|
|
1399
3739
|
example: 'User',
|
|
1400
|
-
enum: [
|
|
3740
|
+
enum: [
|
|
3741
|
+
'Administrator',
|
|
3742
|
+
'User'
|
|
3743
|
+
]
|
|
1401
3744
|
}
|
|
1402
3745
|
},
|
|
1403
|
-
required: [
|
|
3746
|
+
required: [
|
|
3747
|
+
'name',
|
|
3748
|
+
'role'
|
|
3749
|
+
],
|
|
1404
3750
|
additionalProperties: false
|
|
1405
3751
|
};
|
|
1406
3752
|
export const TokenSchema = {
|
|
@@ -1418,7 +3764,10 @@ export const TokenSchema = {
|
|
|
1418
3764
|
type: 'string',
|
|
1419
3765
|
description: 'Role assumed by the token.',
|
|
1420
3766
|
example: 'User',
|
|
1421
|
-
enum: [
|
|
3767
|
+
enum: [
|
|
3768
|
+
'Administrator',
|
|
3769
|
+
'User'
|
|
3770
|
+
]
|
|
1422
3771
|
},
|
|
1423
3772
|
id: {
|
|
1424
3773
|
type: 'string',
|
|
@@ -1437,7 +3786,11 @@ export const TokenSchema = {
|
|
|
1437
3786
|
example: '2023-12-20T13:53:32.000Z'
|
|
1438
3787
|
}
|
|
1439
3788
|
},
|
|
1440
|
-
required: [
|
|
3789
|
+
required: [
|
|
3790
|
+
'name',
|
|
3791
|
+
'role',
|
|
3792
|
+
'date_created'
|
|
3793
|
+
],
|
|
1441
3794
|
additionalProperties: false
|
|
1442
3795
|
};
|
|
1443
3796
|
export const TokenUpdateInputSchema = {
|
|
@@ -1455,9 +3808,154 @@ export const TokenUpdateInputSchema = {
|
|
|
1455
3808
|
type: 'string',
|
|
1456
3809
|
description: 'Role assumed by the token.',
|
|
1457
3810
|
example: 'User',
|
|
1458
|
-
enum: [
|
|
3811
|
+
enum: [
|
|
3812
|
+
'Administrator',
|
|
3813
|
+
'User'
|
|
3814
|
+
]
|
|
3815
|
+
}
|
|
3816
|
+
},
|
|
3817
|
+
additionalProperties: false
|
|
3818
|
+
};
|
|
3819
|
+
export const UsageFacetsSchema = {
|
|
3820
|
+
type: 'object',
|
|
3821
|
+
properties: {
|
|
3822
|
+
cluster_id: {
|
|
3823
|
+
type: 'array',
|
|
3824
|
+
items: {
|
|
3825
|
+
type: 'string'
|
|
3826
|
+
},
|
|
3827
|
+
description: 'List of unique cluster IDs',
|
|
3828
|
+
example: [
|
|
3829
|
+
'6b5439b1-923a-4f2b-a371-d554e5ea23fa'
|
|
3830
|
+
]
|
|
3831
|
+
},
|
|
3832
|
+
product: {
|
|
3833
|
+
type: 'array',
|
|
3834
|
+
items: {
|
|
3835
|
+
type: 'string',
|
|
3836
|
+
enum: [
|
|
3837
|
+
'cfke_controlplane_basic',
|
|
3838
|
+
'cfke_controlplane_pro',
|
|
3839
|
+
'cfke_controlplane_enterprise',
|
|
3840
|
+
'cfke_connected_nodes_basic',
|
|
3841
|
+
'cfke_connected_nodes_pro',
|
|
3842
|
+
'cfke_connected_nodes_enterprise',
|
|
3843
|
+
'cfcr_storage'
|
|
3844
|
+
]
|
|
3845
|
+
},
|
|
3846
|
+
description: 'List of unique products',
|
|
3847
|
+
example: [
|
|
3848
|
+
'cfke_controlplane_pro',
|
|
3849
|
+
'cfke_connected_nodes_pro'
|
|
3850
|
+
]
|
|
3851
|
+
}
|
|
3852
|
+
},
|
|
3853
|
+
additionalProperties: false
|
|
3854
|
+
};
|
|
3855
|
+
export const UsageResponseSchema = {
|
|
3856
|
+
type: 'object',
|
|
3857
|
+
properties: {
|
|
3858
|
+
data: {
|
|
3859
|
+
type: 'array',
|
|
3860
|
+
items: {
|
|
3861
|
+
type: 'object',
|
|
3862
|
+
properties: {
|
|
3863
|
+
hour: {
|
|
3864
|
+
type: 'string',
|
|
3865
|
+
description: 'Hour of the usage',
|
|
3866
|
+
example: '2019-01-01T00:00:00.000Z'
|
|
3867
|
+
},
|
|
3868
|
+
cluster_id: {
|
|
3869
|
+
type: 'string',
|
|
3870
|
+
description: 'Unique identifier of the kubernetes cluster. UUID v4 string in canonical form',
|
|
3871
|
+
example: '6b5439b1-923a-4f2b-a371-d554e5ea23fa'
|
|
3872
|
+
},
|
|
3873
|
+
product: {
|
|
3874
|
+
type: 'string',
|
|
3875
|
+
description: 'The product the usage is associated with',
|
|
3876
|
+
example: 'cfke_controlplane_pro',
|
|
3877
|
+
enum: [
|
|
3878
|
+
'cfke_controlplane_basic',
|
|
3879
|
+
'cfke_controlplane_pro',
|
|
3880
|
+
'cfke_controlplane_enterprise',
|
|
3881
|
+
'cfke_connected_nodes_basic',
|
|
3882
|
+
'cfke_connected_nodes_pro',
|
|
3883
|
+
'cfke_connected_nodes_enterprise',
|
|
3884
|
+
'cfcr_storage'
|
|
3885
|
+
]
|
|
3886
|
+
},
|
|
3887
|
+
value: {
|
|
3888
|
+
type: 'number',
|
|
3889
|
+
format: 'float',
|
|
3890
|
+
description: 'Consumption',
|
|
3891
|
+
example: 4
|
|
3892
|
+
},
|
|
3893
|
+
price: {
|
|
3894
|
+
type: 'number',
|
|
3895
|
+
format: 'float',
|
|
3896
|
+
description: 'Price per unit',
|
|
3897
|
+
example: 0.01
|
|
3898
|
+
},
|
|
3899
|
+
total: {
|
|
3900
|
+
type: 'number',
|
|
3901
|
+
format: 'float',
|
|
3902
|
+
description: 'Total cost'
|
|
3903
|
+
}
|
|
3904
|
+
},
|
|
3905
|
+
required: [
|
|
3906
|
+
'hour',
|
|
3907
|
+
'cluster_id',
|
|
3908
|
+
'product',
|
|
3909
|
+
'value',
|
|
3910
|
+
'price',
|
|
3911
|
+
'total'
|
|
3912
|
+
],
|
|
3913
|
+
additionalProperties: false
|
|
3914
|
+
},
|
|
3915
|
+
description: 'Usage data'
|
|
3916
|
+
},
|
|
3917
|
+
facets: {
|
|
3918
|
+
type: 'object',
|
|
3919
|
+
properties: {
|
|
3920
|
+
cluster_id: {
|
|
3921
|
+
type: 'array',
|
|
3922
|
+
items: {
|
|
3923
|
+
type: 'string'
|
|
3924
|
+
},
|
|
3925
|
+
description: 'List of unique cluster IDs',
|
|
3926
|
+
example: [
|
|
3927
|
+
'6b5439b1-923a-4f2b-a371-d554e5ea23fa'
|
|
3928
|
+
]
|
|
3929
|
+
},
|
|
3930
|
+
product: {
|
|
3931
|
+
type: 'array',
|
|
3932
|
+
items: {
|
|
3933
|
+
type: 'string',
|
|
3934
|
+
enum: [
|
|
3935
|
+
'cfke_controlplane_basic',
|
|
3936
|
+
'cfke_controlplane_pro',
|
|
3937
|
+
'cfke_controlplane_enterprise',
|
|
3938
|
+
'cfke_connected_nodes_basic',
|
|
3939
|
+
'cfke_connected_nodes_pro',
|
|
3940
|
+
'cfke_connected_nodes_enterprise',
|
|
3941
|
+
'cfcr_storage'
|
|
3942
|
+
]
|
|
3943
|
+
},
|
|
3944
|
+
description: 'List of unique products',
|
|
3945
|
+
example: [
|
|
3946
|
+
'cfke_controlplane_pro',
|
|
3947
|
+
'cfke_connected_nodes_pro'
|
|
3948
|
+
]
|
|
3949
|
+
}
|
|
3950
|
+
},
|
|
3951
|
+
additionalProperties: false,
|
|
3952
|
+
description: 'Facets for filtering'
|
|
1459
3953
|
}
|
|
1460
3954
|
},
|
|
3955
|
+
required: [
|
|
3956
|
+
'data',
|
|
3957
|
+
'facets'
|
|
3958
|
+
],
|
|
1461
3959
|
additionalProperties: false
|
|
1462
3960
|
};
|
|
1463
3961
|
export const UsageSchema = {
|
|
@@ -1470,90 +3968,49 @@ export const UsageSchema = {
|
|
|
1470
3968
|
},
|
|
1471
3969
|
cluster_id: {
|
|
1472
3970
|
type: 'string',
|
|
1473
|
-
format: 'uuid',
|
|
1474
3971
|
description: 'Unique identifier of the kubernetes cluster. UUID v4 string in canonical form',
|
|
1475
3972
|
example: '6b5439b1-923a-4f2b-a371-d554e5ea23fa'
|
|
1476
3973
|
},
|
|
1477
|
-
cluster_tier: {
|
|
1478
|
-
type: 'string',
|
|
1479
|
-
description: 'Tier of the cluster.',
|
|
1480
|
-
example: 'pro',
|
|
1481
|
-
enum: ['basic', 'pro', '']
|
|
1482
|
-
},
|
|
1483
3974
|
product: {
|
|
1484
3975
|
type: 'string',
|
|
1485
3976
|
description: 'The product the usage is associated with',
|
|
1486
|
-
example: '
|
|
1487
|
-
enum: [
|
|
1488
|
-
|
|
1489
|
-
|
|
1490
|
-
|
|
1491
|
-
|
|
1492
|
-
|
|
1493
|
-
|
|
1494
|
-
|
|
1495
|
-
type: 'string',
|
|
1496
|
-
description: 'SKU of the Kubernetes node',
|
|
1497
|
-
example: 'GCP-NORTHAMERICA-NORTHEAST1-A-G1-SMALL-SPOT'
|
|
1498
|
-
},
|
|
1499
|
-
cpu: {
|
|
1500
|
-
anyOf: [
|
|
1501
|
-
{
|
|
1502
|
-
type: 'number',
|
|
1503
|
-
format: 'float',
|
|
1504
|
-
description: 'CPU core count of the node',
|
|
1505
|
-
example: 4
|
|
1506
|
-
},
|
|
1507
|
-
{
|
|
1508
|
-
type: 'string',
|
|
1509
|
-
enum: ['']
|
|
1510
|
-
}
|
|
1511
|
-
]
|
|
1512
|
-
},
|
|
1513
|
-
price: {
|
|
1514
|
-
anyOf: [
|
|
1515
|
-
{
|
|
1516
|
-
type: 'number',
|
|
1517
|
-
format: 'float',
|
|
1518
|
-
description: 'Price',
|
|
1519
|
-
example: 4
|
|
1520
|
-
},
|
|
1521
|
-
{
|
|
1522
|
-
type: 'string',
|
|
1523
|
-
enum: ['']
|
|
1524
|
-
}
|
|
3977
|
+
example: 'cfke_controlplane_pro',
|
|
3978
|
+
enum: [
|
|
3979
|
+
'cfke_controlplane_basic',
|
|
3980
|
+
'cfke_controlplane_pro',
|
|
3981
|
+
'cfke_controlplane_enterprise',
|
|
3982
|
+
'cfke_connected_nodes_basic',
|
|
3983
|
+
'cfke_connected_nodes_pro',
|
|
3984
|
+
'cfke_connected_nodes_enterprise',
|
|
3985
|
+
'cfcr_storage'
|
|
1525
3986
|
]
|
|
1526
3987
|
},
|
|
1527
3988
|
value: {
|
|
1528
|
-
|
|
1529
|
-
|
|
1530
|
-
|
|
1531
|
-
|
|
1532
|
-
|
|
1533
|
-
|
|
1534
|
-
|
|
1535
|
-
|
|
1536
|
-
|
|
1537
|
-
|
|
1538
|
-
}
|
|
1539
|
-
]
|
|
3989
|
+
type: 'number',
|
|
3990
|
+
format: 'float',
|
|
3991
|
+
description: 'Consumption',
|
|
3992
|
+
example: 4
|
|
3993
|
+
},
|
|
3994
|
+
price: {
|
|
3995
|
+
type: 'number',
|
|
3996
|
+
format: 'float',
|
|
3997
|
+
description: 'Price per unit',
|
|
3998
|
+
example: 0.01
|
|
1540
3999
|
},
|
|
1541
4000
|
total: {
|
|
1542
|
-
|
|
1543
|
-
|
|
1544
|
-
|
|
1545
|
-
format: 'float',
|
|
1546
|
-
description: 'Total',
|
|
1547
|
-
example: 4
|
|
1548
|
-
},
|
|
1549
|
-
{
|
|
1550
|
-
type: 'string',
|
|
1551
|
-
enum: ['']
|
|
1552
|
-
}
|
|
1553
|
-
]
|
|
4001
|
+
type: 'number',
|
|
4002
|
+
format: 'float',
|
|
4003
|
+
description: 'Total cost'
|
|
1554
4004
|
}
|
|
1555
4005
|
},
|
|
1556
|
-
required: [
|
|
4006
|
+
required: [
|
|
4007
|
+
'hour',
|
|
4008
|
+
'cluster_id',
|
|
4009
|
+
'product',
|
|
4010
|
+
'value',
|
|
4011
|
+
'price',
|
|
4012
|
+
'total'
|
|
4013
|
+
],
|
|
1557
4014
|
additionalProperties: false
|
|
1558
4015
|
};
|
|
1559
4016
|
export const UserCreateInputSchema = {
|
|
@@ -1589,21 +4046,15 @@ export const UserCreateInputSchema = {
|
|
|
1589
4046
|
type: 'string',
|
|
1590
4047
|
minLength: 8,
|
|
1591
4048
|
description: 'User password. Must be at least 8 characters long.'
|
|
1592
|
-
},
|
|
1593
|
-
status: {
|
|
1594
|
-
type: 'string',
|
|
1595
|
-
description: 'Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.',
|
|
1596
|
-
example: 'active',
|
|
1597
|
-
enum: ['active', 'inactive']
|
|
1598
|
-
},
|
|
1599
|
-
role: {
|
|
1600
|
-
type: 'string',
|
|
1601
|
-
description: "User role. Can be 'Administrator', 'User'.",
|
|
1602
|
-
example: 'User',
|
|
1603
|
-
enum: ['Administrator', 'User']
|
|
1604
4049
|
}
|
|
1605
4050
|
},
|
|
1606
|
-
required: [
|
|
4051
|
+
required: [
|
|
4052
|
+
'email',
|
|
4053
|
+
'first_name',
|
|
4054
|
+
'last_name',
|
|
4055
|
+
'code',
|
|
4056
|
+
'password'
|
|
4057
|
+
],
|
|
1607
4058
|
additionalProperties: false
|
|
1608
4059
|
};
|
|
1609
4060
|
export const UserSchema = {
|
|
@@ -1631,15 +4082,21 @@ export const UserSchema = {
|
|
|
1631
4082
|
},
|
|
1632
4083
|
role: {
|
|
1633
4084
|
type: 'string',
|
|
1634
|
-
description:
|
|
4085
|
+
description: 'User role. Can be \'Administrator\', \'User\'.',
|
|
1635
4086
|
example: 'User',
|
|
1636
|
-
enum: [
|
|
4087
|
+
enum: [
|
|
4088
|
+
'Administrator',
|
|
4089
|
+
'User'
|
|
4090
|
+
]
|
|
1637
4091
|
},
|
|
1638
4092
|
status: {
|
|
1639
4093
|
type: 'string',
|
|
1640
4094
|
description: 'Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.',
|
|
1641
4095
|
example: 'active',
|
|
1642
|
-
enum: [
|
|
4096
|
+
enum: [
|
|
4097
|
+
'active',
|
|
4098
|
+
'inactive'
|
|
4099
|
+
]
|
|
1643
4100
|
},
|
|
1644
4101
|
id: {
|
|
1645
4102
|
type: 'string',
|
|
@@ -1654,7 +4111,15 @@ export const UserSchema = {
|
|
|
1654
4111
|
example: '2023-11-02T16:08:14.338Z'
|
|
1655
4112
|
}
|
|
1656
4113
|
},
|
|
1657
|
-
required: [
|
|
4114
|
+
required: [
|
|
4115
|
+
'email',
|
|
4116
|
+
'first_name',
|
|
4117
|
+
'last_name',
|
|
4118
|
+
'role',
|
|
4119
|
+
'status',
|
|
4120
|
+
'id',
|
|
4121
|
+
'date_created'
|
|
4122
|
+
],
|
|
1658
4123
|
additionalProperties: false
|
|
1659
4124
|
};
|
|
1660
4125
|
export const UserUpdateInputSchema = {
|
|
@@ -1682,15 +4147,21 @@ export const UserUpdateInputSchema = {
|
|
|
1682
4147
|
},
|
|
1683
4148
|
role: {
|
|
1684
4149
|
type: 'string',
|
|
1685
|
-
description:
|
|
4150
|
+
description: 'User role. Can be \'Administrator\', \'User\'.',
|
|
1686
4151
|
example: 'User',
|
|
1687
|
-
enum: [
|
|
4152
|
+
enum: [
|
|
4153
|
+
'Administrator',
|
|
4154
|
+
'User'
|
|
4155
|
+
]
|
|
1688
4156
|
},
|
|
1689
4157
|
status: {
|
|
1690
4158
|
type: 'string',
|
|
1691
4159
|
description: 'Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.',
|
|
1692
4160
|
example: 'active',
|
|
1693
|
-
enum: [
|
|
4161
|
+
enum: [
|
|
4162
|
+
'active',
|
|
4163
|
+
'inactive'
|
|
4164
|
+
]
|
|
1694
4165
|
}
|
|
1695
4166
|
},
|
|
1696
4167
|
additionalProperties: false
|