@cloudfleet/sdk 0.0.1-cb875c6 → 0.0.1-cc82d04
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 +1061 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1234 -0
- package/dist/@tanstack/react-query.gen.js.map +1 -0
- package/dist/client/client.gen.d.ts.map +1 -1
- package/dist/client/client.gen.js +114 -102
- package/dist/client/client.gen.js.map +1 -1
- package/dist/client/index.d.ts +1 -1
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js.map +1 -1
- package/dist/client/types.gen.d.ts +9 -13
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.d.ts +8 -4
- package/dist/client/utils.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.js +13 -15
- package/dist/client/utils.gen.js.map +1 -1
- 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.gen.d.ts.map +1 -1
- package/dist/core/auth.gen.js.map +1 -1
- package/dist/core/bodySerializer.gen.d.ts +16 -8
- package/dist/core/bodySerializer.gen.d.ts.map +1 -1
- package/dist/core/bodySerializer.gen.js +1 -1
- package/dist/core/bodySerializer.gen.js.map +1 -1
- package/dist/core/params.gen.d.ts +10 -0
- package/dist/core/params.gen.d.ts.map +1 -1
- package/dist/core/params.gen.js +22 -10
- package/dist/core/params.gen.js.map +1 -1
- package/dist/core/pathSerializer.gen.d.ts.map +1 -1
- package/dist/core/pathSerializer.gen.js +3 -11
- package/dist/core/pathSerializer.gen.js.map +1 -1
- package/dist/core/queryKeySerializer.gen.d.ts.map +1 -1
- package/dist/core/queryKeySerializer.gen.js +4 -11
- package/dist/core/queryKeySerializer.gen.js.map +1 -1
- package/dist/core/serverSentEvents.gen.d.ts +1 -1
- package/dist/core/serverSentEvents.gen.d.ts.map +1 -1
- package/dist/core/serverSentEvents.gen.js +6 -9
- package/dist/core/serverSentEvents.gen.js.map +1 -1
- package/dist/core/types.gen.d.ts +1 -1
- package/dist/core/types.gen.d.ts.map +1 -1
- package/dist/core/utils.gen.d.ts.map +1 -1
- package/dist/core/utils.gen.js +1 -1
- package/dist/core/utils.gen.js.map +1 -1
- package/dist/schemas.gen.d.ts +1238 -170
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +2667 -239
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +271 -186
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +385 -359
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +8 -8
- package/dist/types.gen.d.ts +1661 -700
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3545 -1419
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1442 -620
- package/dist/zod.gen.js.map +1 -1
- package/package.json +28 -8
package/dist/schemas.gen.js
CHANGED
|
@@ -1,7 +1,65 @@
|
|
|
1
1
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
|
+
export const BasicPriceConsentInputSchema = {
|
|
3
|
+
type: 'object',
|
|
4
|
+
properties: {
|
|
5
|
+
decision: {
|
|
6
|
+
type: 'string',
|
|
7
|
+
description: 'The administrator\'s decision on the new Basic price. `accepted` continues to paid billing when the signup credit runs out; `rejected` opts out (clusters are suspended, never charged). A `rejected` org can later be flipped back to `accepted`.',
|
|
8
|
+
example: 'accepted',
|
|
9
|
+
enum: [
|
|
10
|
+
'accepted',
|
|
11
|
+
'rejected'
|
|
12
|
+
]
|
|
13
|
+
}
|
|
14
|
+
},
|
|
15
|
+
required: [
|
|
16
|
+
'decision'
|
|
17
|
+
],
|
|
18
|
+
additionalProperties: false
|
|
19
|
+
};
|
|
20
|
+
export const BasicPriceConsentSchema = {
|
|
21
|
+
type: 'object',
|
|
22
|
+
properties: {
|
|
23
|
+
status: {
|
|
24
|
+
type: 'string',
|
|
25
|
+
description: 'Consent status for the new Basic price. `not_applicable` when the organization is not in scope for the migration. `pending` when the organization must opt in but no admin has decided yet. `accepted` / `rejected` reflect the recorded decision.',
|
|
26
|
+
example: 'pending',
|
|
27
|
+
enum: [
|
|
28
|
+
'not_applicable',
|
|
29
|
+
'pending',
|
|
30
|
+
'accepted',
|
|
31
|
+
'rejected'
|
|
32
|
+
]
|
|
33
|
+
},
|
|
34
|
+
decided_at: {
|
|
35
|
+
type: 'string',
|
|
36
|
+
format: 'date-time',
|
|
37
|
+
description: 'When the current decision was recorded. Absent while `not_applicable` or `pending`.',
|
|
38
|
+
example: '2026-09-05T10:12:00.000Z'
|
|
39
|
+
},
|
|
40
|
+
decided_by: {
|
|
41
|
+
type: 'string',
|
|
42
|
+
description: 'User id of the administrator who recorded the current decision. Absent while `not_applicable` or `pending`.',
|
|
43
|
+
example: '2b7a5c9e-1f4d-4a1b-9c3e-8d2f6a0b1c2d'
|
|
44
|
+
}
|
|
45
|
+
},
|
|
46
|
+
required: [
|
|
47
|
+
'status'
|
|
48
|
+
],
|
|
49
|
+
additionalProperties: false
|
|
50
|
+
};
|
|
2
51
|
export const BillingContactSchema = {
|
|
3
52
|
type: 'object',
|
|
4
53
|
properties: {
|
|
54
|
+
type: {
|
|
55
|
+
type: 'string',
|
|
56
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
57
|
+
example: 'business',
|
|
58
|
+
enum: [
|
|
59
|
+
'business',
|
|
60
|
+
'personal'
|
|
61
|
+
]
|
|
62
|
+
},
|
|
5
63
|
company: {
|
|
6
64
|
type: 'string',
|
|
7
65
|
maxLength: 120,
|
|
@@ -74,10 +132,143 @@ export const BillingContactSchema = {
|
|
|
74
132
|
nullable: true,
|
|
75
133
|
description: 'Type of the tax ID.',
|
|
76
134
|
example: 'de_vat',
|
|
77
|
-
enum: [
|
|
135
|
+
enum: [
|
|
136
|
+
'ad_nrt',
|
|
137
|
+
'ae_trn',
|
|
138
|
+
'al_tin',
|
|
139
|
+
'am_tin',
|
|
140
|
+
'ao_tin',
|
|
141
|
+
'ar_cuit',
|
|
142
|
+
'at_vat',
|
|
143
|
+
'au_abn',
|
|
144
|
+
'au_arn',
|
|
145
|
+
'ba_tin',
|
|
146
|
+
'bb_tin',
|
|
147
|
+
'be_vat',
|
|
148
|
+
'bg_uic',
|
|
149
|
+
'bg_vat',
|
|
150
|
+
'bh_vat',
|
|
151
|
+
'bo_tin',
|
|
152
|
+
'br_cnpj',
|
|
153
|
+
'br_cpf',
|
|
154
|
+
'bs_tin',
|
|
155
|
+
'by_tin',
|
|
156
|
+
'ca_bn',
|
|
157
|
+
'ca_gst_hst',
|
|
158
|
+
'ca_pst_bc',
|
|
159
|
+
'ca_pst_mb',
|
|
160
|
+
'ca_pst_sk',
|
|
161
|
+
'ca_qst',
|
|
162
|
+
'cd_nif',
|
|
163
|
+
'ch_uid',
|
|
164
|
+
'ch_vat',
|
|
165
|
+
'cl_tin',
|
|
166
|
+
'cn_tin',
|
|
167
|
+
'co_nit',
|
|
168
|
+
'cr_tin',
|
|
169
|
+
'cy_vat',
|
|
170
|
+
'cz_vat',
|
|
171
|
+
'de_stn',
|
|
172
|
+
'de_vat',
|
|
173
|
+
'dk_vat',
|
|
174
|
+
'do_rcn',
|
|
175
|
+
'ec_ruc',
|
|
176
|
+
'ee_vat',
|
|
177
|
+
'eg_tin',
|
|
178
|
+
'es_cif',
|
|
179
|
+
'es_vat',
|
|
180
|
+
'eu_oss_vat',
|
|
181
|
+
'fi_vat',
|
|
182
|
+
'fr_vat',
|
|
183
|
+
'gb_vat',
|
|
184
|
+
'ge_vat',
|
|
185
|
+
'gn_nif',
|
|
186
|
+
'gr_vat',
|
|
187
|
+
'hk_br',
|
|
188
|
+
'hr_oib',
|
|
189
|
+
'hr_vat',
|
|
190
|
+
'hu_tin',
|
|
191
|
+
'hu_vat',
|
|
192
|
+
'id_npwp',
|
|
193
|
+
'ie_vat',
|
|
194
|
+
'il_vat',
|
|
195
|
+
'in_gst',
|
|
196
|
+
'is_vat',
|
|
197
|
+
'it_vat',
|
|
198
|
+
'jp_cn',
|
|
199
|
+
'jp_rn',
|
|
200
|
+
'jp_trn',
|
|
201
|
+
'ke_pin',
|
|
202
|
+
'kh_tin',
|
|
203
|
+
'kr_brn',
|
|
204
|
+
'kz_bin',
|
|
205
|
+
'li_uid',
|
|
206
|
+
'li_vat',
|
|
207
|
+
'lt_vat',
|
|
208
|
+
'lu_vat',
|
|
209
|
+
'lv_vat',
|
|
210
|
+
'ma_vat',
|
|
211
|
+
'md_vat',
|
|
212
|
+
'me_pib',
|
|
213
|
+
'mk_vat',
|
|
214
|
+
'mr_nif',
|
|
215
|
+
'mt_vat',
|
|
216
|
+
'mx_rfc',
|
|
217
|
+
'my_frp',
|
|
218
|
+
'my_itn',
|
|
219
|
+
'my_sst',
|
|
220
|
+
'ng_tin',
|
|
221
|
+
'nl_vat',
|
|
222
|
+
'no_vat',
|
|
223
|
+
'no_voec',
|
|
224
|
+
'np_pan',
|
|
225
|
+
'nz_gst',
|
|
226
|
+
'om_vat',
|
|
227
|
+
'pe_ruc',
|
|
228
|
+
'ph_tin',
|
|
229
|
+
'pl_vat',
|
|
230
|
+
'pt_vat',
|
|
231
|
+
'ro_tin',
|
|
232
|
+
'ro_vat',
|
|
233
|
+
'rs_pib',
|
|
234
|
+
'ru_inn',
|
|
235
|
+
'ru_kpp',
|
|
236
|
+
'sa_vat',
|
|
237
|
+
'se_vat',
|
|
238
|
+
'sg_gst',
|
|
239
|
+
'sg_uen',
|
|
240
|
+
'si_tin',
|
|
241
|
+
'si_vat',
|
|
242
|
+
'sk_vat',
|
|
243
|
+
'sn_ninea',
|
|
244
|
+
'sr_fin',
|
|
245
|
+
'sv_nit',
|
|
246
|
+
'th_vat',
|
|
247
|
+
'tj_tin',
|
|
248
|
+
'tr_tin',
|
|
249
|
+
'tw_vat',
|
|
250
|
+
'tz_vat',
|
|
251
|
+
'ua_vat',
|
|
252
|
+
'ug_tin',
|
|
253
|
+
'us_ein',
|
|
254
|
+
'uy_ruc',
|
|
255
|
+
'uz_tin',
|
|
256
|
+
'uz_vat',
|
|
257
|
+
've_rif',
|
|
258
|
+
'vn_tin',
|
|
259
|
+
'xi_vat',
|
|
260
|
+
'za_vat',
|
|
261
|
+
'zm_tin',
|
|
262
|
+
'zw_tin',
|
|
263
|
+
''
|
|
264
|
+
]
|
|
78
265
|
}
|
|
79
266
|
},
|
|
80
|
-
required: [
|
|
267
|
+
required: [
|
|
268
|
+
'type',
|
|
269
|
+
'email',
|
|
270
|
+
'individual_name'
|
|
271
|
+
],
|
|
81
272
|
additionalProperties: false
|
|
82
273
|
};
|
|
83
274
|
export const BillingCreditsSchema = {
|
|
@@ -92,7 +283,10 @@ export const BillingCreditsSchema = {
|
|
|
92
283
|
type: 'string',
|
|
93
284
|
description: 'Type of the promotional code.',
|
|
94
285
|
example: 'credit',
|
|
95
|
-
enum: [
|
|
286
|
+
enum: [
|
|
287
|
+
'credit',
|
|
288
|
+
'discount'
|
|
289
|
+
]
|
|
96
290
|
},
|
|
97
291
|
date_start: {
|
|
98
292
|
type: 'string',
|
|
@@ -129,7 +323,12 @@ export const BillingCreditsSchema = {
|
|
|
129
323
|
example: 8
|
|
130
324
|
}
|
|
131
325
|
},
|
|
132
|
-
required: [
|
|
326
|
+
required: [
|
|
327
|
+
'type',
|
|
328
|
+
'date_start',
|
|
329
|
+
'code',
|
|
330
|
+
'value_total'
|
|
331
|
+
],
|
|
133
332
|
additionalProperties: false
|
|
134
333
|
};
|
|
135
334
|
export const ChartCreateInputSchema = {
|
|
@@ -170,7 +369,13 @@ export const ChartCreateInputSchema = {
|
|
|
170
369
|
example: 'postgresql'
|
|
171
370
|
}
|
|
172
371
|
},
|
|
173
|
-
required: [
|
|
372
|
+
required: [
|
|
373
|
+
'values',
|
|
374
|
+
'version_channel',
|
|
375
|
+
'name',
|
|
376
|
+
'namespace',
|
|
377
|
+
'chart'
|
|
378
|
+
],
|
|
174
379
|
additionalProperties: false
|
|
175
380
|
};
|
|
176
381
|
export const ChartSchema = {
|
|
@@ -212,9 +417,8 @@ export const ChartSchema = {
|
|
|
212
417
|
},
|
|
213
418
|
status: {
|
|
214
419
|
type: 'string',
|
|
215
|
-
description: 'Status of the chart deployment.',
|
|
216
|
-
example: '
|
|
217
|
-
enum: ['InstallSucceeded', 'InstallFailed', 'UpgradeSucceeded', 'UpgradeFailed', 'TestSucceeded', 'TestFailed', 'RollbackSucceeded', 'RollbackFailed', 'UninstallSucceeded', 'UninstallFailed', 'ArtifactFailed', 'DependencyNotReady', 'Progressing', 'SourceNotReady']
|
|
420
|
+
description: 'Status of the chart deployment (Flux HelmRelease Ready condition reason, e.g. InstallSucceeded, UpgradeFailed, Progressing).',
|
|
421
|
+
example: 'InstallSucceeded'
|
|
218
422
|
},
|
|
219
423
|
version_current: {
|
|
220
424
|
type: 'string',
|
|
@@ -237,7 +441,18 @@ export const ChartSchema = {
|
|
|
237
441
|
example: true
|
|
238
442
|
}
|
|
239
443
|
},
|
|
240
|
-
required: [
|
|
444
|
+
required: [
|
|
445
|
+
'values',
|
|
446
|
+
'version_channel',
|
|
447
|
+
'name',
|
|
448
|
+
'namespace',
|
|
449
|
+
'chart',
|
|
450
|
+
'status',
|
|
451
|
+
'version_current',
|
|
452
|
+
'created_at',
|
|
453
|
+
'updated_at',
|
|
454
|
+
'ready'
|
|
455
|
+
],
|
|
241
456
|
additionalProperties: false
|
|
242
457
|
};
|
|
243
458
|
export const ChartUpdateInputSchema = {
|
|
@@ -254,7 +469,10 @@ export const ChartUpdateInputSchema = {
|
|
|
254
469
|
example: '2.x.x-cfke.x'
|
|
255
470
|
}
|
|
256
471
|
},
|
|
257
|
-
required: [
|
|
472
|
+
required: [
|
|
473
|
+
'values',
|
|
474
|
+
'version_channel'
|
|
475
|
+
],
|
|
258
476
|
additionalProperties: false
|
|
259
477
|
};
|
|
260
478
|
export const ClusterCreateInputSchema = {
|
|
@@ -271,26 +489,118 @@ export const ClusterCreateInputSchema = {
|
|
|
271
489
|
tier: {
|
|
272
490
|
type: 'string',
|
|
273
491
|
description: 'Tier of the cluster.',
|
|
492
|
+
default: 'basic',
|
|
274
493
|
example: 'pro',
|
|
275
|
-
enum: [
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
default: 'staging',
|
|
281
|
-
example: 'northamerica-central-1a',
|
|
282
|
-
enum: ['staging', 'northamerica-central-1', 'europe-central-1a', 'northamerica-central-1a']
|
|
494
|
+
enum: [
|
|
495
|
+
'basic',
|
|
496
|
+
'pro',
|
|
497
|
+
'enterprise'
|
|
498
|
+
]
|
|
283
499
|
},
|
|
284
500
|
version_channel: {
|
|
285
501
|
type: 'string',
|
|
286
502
|
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-]+)*))?$',
|
|
287
503
|
description: 'Version of the kubernetes cluster.',
|
|
288
504
|
default: '1.x.x-cfke.x',
|
|
289
|
-
example: '1.
|
|
505
|
+
example: '1.x.x-cfke.x'
|
|
506
|
+
},
|
|
507
|
+
release_channel: {
|
|
508
|
+
type: 'string',
|
|
509
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
510
|
+
default: 'rapid',
|
|
511
|
+
example: 'rapid',
|
|
512
|
+
enum: [
|
|
513
|
+
'rapid',
|
|
514
|
+
'stable',
|
|
515
|
+
'extended'
|
|
516
|
+
]
|
|
517
|
+
},
|
|
518
|
+
features: {
|
|
519
|
+
type: 'object',
|
|
520
|
+
properties: {
|
|
521
|
+
gpu_sharing_strategy: {
|
|
522
|
+
type: 'string',
|
|
523
|
+
description: 'GPU sharing strategy.',
|
|
524
|
+
default: 'none',
|
|
525
|
+
example: 'none',
|
|
526
|
+
enum: [
|
|
527
|
+
'none',
|
|
528
|
+
'mps',
|
|
529
|
+
'time_slicing'
|
|
530
|
+
]
|
|
531
|
+
},
|
|
532
|
+
gpu_max_shared_clients_per_gpu: {
|
|
533
|
+
type: 'integer',
|
|
534
|
+
minimum: 2,
|
|
535
|
+
maximum: 48,
|
|
536
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
537
|
+
default: 4,
|
|
538
|
+
example: 10
|
|
539
|
+
},
|
|
540
|
+
cilium_socket_lb_host_namespace_only: {
|
|
541
|
+
type: 'boolean',
|
|
542
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
543
|
+
example: false
|
|
544
|
+
}
|
|
545
|
+
},
|
|
546
|
+
additionalProperties: false,
|
|
547
|
+
description: 'Cluster feature toggles.',
|
|
548
|
+
default: {
|
|
549
|
+
gpu_sharing_strategy: 'none',
|
|
550
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
551
|
+
cilium_socket_lb_host_namespace_only: false
|
|
552
|
+
}
|
|
553
|
+
},
|
|
554
|
+
region: {
|
|
555
|
+
type: 'string',
|
|
556
|
+
description: 'Cloudfleet control plane region. This field can not be updated after creation.',
|
|
557
|
+
example: 'europe-central-1a'
|
|
558
|
+
},
|
|
559
|
+
networking: {
|
|
560
|
+
type: 'object',
|
|
561
|
+
properties: {
|
|
562
|
+
pod_cidr: {
|
|
563
|
+
type: 'string',
|
|
564
|
+
description: 'CIDR block for pod IPs.',
|
|
565
|
+
default: '10.244.0.0/16'
|
|
566
|
+
},
|
|
567
|
+
service_cidr: {
|
|
568
|
+
type: 'string',
|
|
569
|
+
description: 'CIDR block for service IPs.',
|
|
570
|
+
default: '10.96.0.0/12'
|
|
571
|
+
},
|
|
572
|
+
dual_stack: {
|
|
573
|
+
type: 'boolean',
|
|
574
|
+
description: 'Enable IPv4+IPv6 dual-stack networking.'
|
|
575
|
+
},
|
|
576
|
+
pod_cidr_v6: {
|
|
577
|
+
type: 'string',
|
|
578
|
+
description: 'IPv6 pod CIDR. Requires dual_stack.',
|
|
579
|
+
default: '2001:db8:1:2::/48'
|
|
580
|
+
},
|
|
581
|
+
service_cidr_v6: {
|
|
582
|
+
type: 'string',
|
|
583
|
+
description: 'IPv6 service CIDR. Requires dual_stack.',
|
|
584
|
+
default: '2001:db8:1:1::/112'
|
|
585
|
+
}
|
|
586
|
+
},
|
|
587
|
+
additionalProperties: false,
|
|
588
|
+
description: 'Cluster networking configuration. Immutable after creation.',
|
|
589
|
+
default: {
|
|
590
|
+
pod_cidr: '10.244.0.0/16',
|
|
591
|
+
service_cidr: '10.96.0.0/12',
|
|
592
|
+
dual_stack: false,
|
|
593
|
+
pod_cidr_v6: '2001:db8:1:2::/48',
|
|
594
|
+
service_cidr_v6: '2001:db8:1:1::/112'
|
|
595
|
+
}
|
|
290
596
|
}
|
|
291
597
|
},
|
|
292
|
-
required: [
|
|
293
|
-
|
|
598
|
+
required: [
|
|
599
|
+
'name',
|
|
600
|
+
'region'
|
|
601
|
+
],
|
|
602
|
+
additionalProperties: false,
|
|
603
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
294
604
|
};
|
|
295
605
|
export const ClusterJoinInformationSchema = {
|
|
296
606
|
type: 'object',
|
|
@@ -298,8 +608,7 @@ export const ClusterJoinInformationSchema = {
|
|
|
298
608
|
certificate_authority: {
|
|
299
609
|
type: 'string',
|
|
300
610
|
description: 'Certificate authority data for the kubernetes cluster. This is the root certificate authority for the cluster.',
|
|
301
|
-
example:
|
|
302
|
-
MIIC0DCCAbigAwIBAgI...`
|
|
611
|
+
example: '-----BEGIN CERTIFICATE-----\nMIIC0DCCAbigAwIBAgI...'
|
|
303
612
|
},
|
|
304
613
|
endpoint: {
|
|
305
614
|
type: 'string',
|
|
@@ -307,11 +616,26 @@ MIIC0DCCAbigAwIBAgI...`
|
|
|
307
616
|
description: 'Internal URL of the Kubernetes cluster control plane. This is the endpoint that kubelet uses to connect to the cluster.',
|
|
308
617
|
example: 'https://10.31.64.7:6443'
|
|
309
618
|
},
|
|
619
|
+
cluster_dns: {
|
|
620
|
+
type: 'string',
|
|
621
|
+
description: 'Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.',
|
|
622
|
+
example: '10.96.0.10'
|
|
623
|
+
},
|
|
624
|
+
pod_cidr: {
|
|
625
|
+
type: 'string',
|
|
626
|
+
description: 'Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.',
|
|
627
|
+
example: '10.244.0.0/16'
|
|
628
|
+
},
|
|
310
629
|
auth_key: {
|
|
311
630
|
type: 'string',
|
|
312
631
|
description: 'Authentication key for the cluster.',
|
|
313
632
|
example: 'tskey-auth-kBV8wr1dk911CNTRL-...'
|
|
314
633
|
},
|
|
634
|
+
login_server: {
|
|
635
|
+
type: 'string',
|
|
636
|
+
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.',
|
|
637
|
+
example: 'https://415026b6-f00f-44f8-968d-fc6ef4d0fc6d.fabric.europe-central-1a.cfke.io'
|
|
638
|
+
},
|
|
315
639
|
bootstrap_token: {
|
|
316
640
|
type: 'string',
|
|
317
641
|
description: 'Bootstrap token for the cluster.',
|
|
@@ -341,7 +665,12 @@ MIIC0DCCAbigAwIBAgI...`
|
|
|
341
665
|
example: '565.0.0'
|
|
342
666
|
}
|
|
343
667
|
},
|
|
344
|
-
required: [
|
|
668
|
+
required: [
|
|
669
|
+
'kubernetes',
|
|
670
|
+
'tailscale',
|
|
671
|
+
'containerd',
|
|
672
|
+
'nvidia_driver'
|
|
673
|
+
],
|
|
345
674
|
additionalProperties: false,
|
|
346
675
|
description: 'Versions of the different components of the cluster.'
|
|
347
676
|
},
|
|
@@ -364,12 +693,26 @@ MIIC0DCCAbigAwIBAgI...`
|
|
|
364
693
|
example: '//iam.googleapis.com/projects/89014267864/locations/global/workloadIdentityPools/cfke/providers/oidc'
|
|
365
694
|
}
|
|
366
695
|
},
|
|
367
|
-
required: [
|
|
696
|
+
required: [
|
|
697
|
+
'metadata_url',
|
|
698
|
+
'aws_role_arn',
|
|
699
|
+
'gcp_workload_identity_provider'
|
|
700
|
+
],
|
|
368
701
|
additionalProperties: false,
|
|
369
|
-
description:
|
|
702
|
+
description: 'OIDC Information for hosts to access to third party API\'s.'
|
|
370
703
|
}
|
|
371
704
|
},
|
|
372
|
-
required: [
|
|
705
|
+
required: [
|
|
706
|
+
'certificate_authority',
|
|
707
|
+
'endpoint',
|
|
708
|
+
'cluster_dns',
|
|
709
|
+
'pod_cidr',
|
|
710
|
+
'auth_key',
|
|
711
|
+
'login_server',
|
|
712
|
+
'bootstrap_token',
|
|
713
|
+
'versions',
|
|
714
|
+
'third_party_api_access_config'
|
|
715
|
+
],
|
|
373
716
|
additionalProperties: false
|
|
374
717
|
};
|
|
375
718
|
export const ClusterSchema = {
|
|
@@ -386,22 +729,122 @@ export const ClusterSchema = {
|
|
|
386
729
|
tier: {
|
|
387
730
|
type: 'string',
|
|
388
731
|
description: 'Tier of the cluster.',
|
|
732
|
+
default: 'basic',
|
|
389
733
|
example: 'pro',
|
|
390
|
-
enum: [
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
default: 'staging',
|
|
396
|
-
example: 'northamerica-central-1a',
|
|
397
|
-
enum: ['staging', 'northamerica-central-1', 'europe-central-1a', 'northamerica-central-1a']
|
|
734
|
+
enum: [
|
|
735
|
+
'basic',
|
|
736
|
+
'pro',
|
|
737
|
+
'enterprise'
|
|
738
|
+
]
|
|
398
739
|
},
|
|
399
740
|
version_channel: {
|
|
400
741
|
type: 'string',
|
|
401
742
|
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-]+)*))?$',
|
|
402
743
|
description: 'Version of the kubernetes cluster.',
|
|
403
744
|
default: '1.x.x-cfke.x',
|
|
404
|
-
example: '1.
|
|
745
|
+
example: '1.x.x-cfke.x'
|
|
746
|
+
},
|
|
747
|
+
release_channel: {
|
|
748
|
+
type: 'string',
|
|
749
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
750
|
+
default: 'rapid',
|
|
751
|
+
example: 'rapid',
|
|
752
|
+
enum: [
|
|
753
|
+
'rapid',
|
|
754
|
+
'stable',
|
|
755
|
+
'extended'
|
|
756
|
+
]
|
|
757
|
+
},
|
|
758
|
+
features: {
|
|
759
|
+
type: 'object',
|
|
760
|
+
properties: {
|
|
761
|
+
gpu_sharing_strategy: {
|
|
762
|
+
type: 'string',
|
|
763
|
+
description: 'GPU sharing strategy.',
|
|
764
|
+
default: 'none',
|
|
765
|
+
example: 'none',
|
|
766
|
+
enum: [
|
|
767
|
+
'none',
|
|
768
|
+
'mps',
|
|
769
|
+
'time_slicing'
|
|
770
|
+
]
|
|
771
|
+
},
|
|
772
|
+
gpu_max_shared_clients_per_gpu: {
|
|
773
|
+
type: 'integer',
|
|
774
|
+
minimum: 2,
|
|
775
|
+
maximum: 48,
|
|
776
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
777
|
+
default: 4,
|
|
778
|
+
example: 10
|
|
779
|
+
},
|
|
780
|
+
cilium_socket_lb_host_namespace_only: {
|
|
781
|
+
type: 'boolean',
|
|
782
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
783
|
+
example: false
|
|
784
|
+
}
|
|
785
|
+
},
|
|
786
|
+
required: [
|
|
787
|
+
'gpu_sharing_strategy',
|
|
788
|
+
'gpu_max_shared_clients_per_gpu',
|
|
789
|
+
'cilium_socket_lb_host_namespace_only'
|
|
790
|
+
],
|
|
791
|
+
additionalProperties: false,
|
|
792
|
+
description: 'Cluster feature toggles.',
|
|
793
|
+
default: {
|
|
794
|
+
gpu_sharing_strategy: 'none',
|
|
795
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
796
|
+
cilium_socket_lb_host_namespace_only: false
|
|
797
|
+
}
|
|
798
|
+
},
|
|
799
|
+
region: {
|
|
800
|
+
type: 'string',
|
|
801
|
+
description: 'Cloudfleet control plane region. This field can not be updated after creation.',
|
|
802
|
+
example: 'europe-central-1a'
|
|
803
|
+
},
|
|
804
|
+
networking: {
|
|
805
|
+
type: 'object',
|
|
806
|
+
properties: {
|
|
807
|
+
pod_cidr: {
|
|
808
|
+
type: 'string',
|
|
809
|
+
description: 'CIDR block for pod IPs.',
|
|
810
|
+
default: '10.244.0.0/16'
|
|
811
|
+
},
|
|
812
|
+
service_cidr: {
|
|
813
|
+
type: 'string',
|
|
814
|
+
description: 'CIDR block for service IPs.',
|
|
815
|
+
default: '10.96.0.0/12'
|
|
816
|
+
},
|
|
817
|
+
dual_stack: {
|
|
818
|
+
type: 'boolean',
|
|
819
|
+
description: 'Enable IPv4+IPv6 dual-stack networking.'
|
|
820
|
+
},
|
|
821
|
+
pod_cidr_v6: {
|
|
822
|
+
type: 'string',
|
|
823
|
+
description: 'IPv6 pod CIDR. Requires dual_stack.',
|
|
824
|
+
default: '2001:db8:1:2::/48'
|
|
825
|
+
},
|
|
826
|
+
service_cidr_v6: {
|
|
827
|
+
type: 'string',
|
|
828
|
+
description: 'IPv6 service CIDR. Requires dual_stack.',
|
|
829
|
+
default: '2001:db8:1:1::/112'
|
|
830
|
+
}
|
|
831
|
+
},
|
|
832
|
+
required: [
|
|
833
|
+
'pod_cidr',
|
|
834
|
+
'service_cidr',
|
|
835
|
+
'dual_stack',
|
|
836
|
+
'pod_cidr_v6',
|
|
837
|
+
'service_cidr_v6'
|
|
838
|
+
],
|
|
839
|
+
additionalProperties: false,
|
|
840
|
+
description: 'Cluster networking configuration. Immutable after creation.',
|
|
841
|
+
default: {
|
|
842
|
+
pod_cidr: '10.244.0.0/16',
|
|
843
|
+
service_cidr: '10.96.0.0/12',
|
|
844
|
+
dual_stack: false,
|
|
845
|
+
pod_cidr_v6: '2001:db8:1:2::/48',
|
|
846
|
+
service_cidr_v6: '2001:db8:1:1::/112'
|
|
847
|
+
}
|
|
405
848
|
},
|
|
406
849
|
id: {
|
|
407
850
|
type: 'string',
|
|
@@ -411,29 +854,51 @@ export const ClusterSchema = {
|
|
|
411
854
|
},
|
|
412
855
|
status: {
|
|
413
856
|
type: 'string',
|
|
414
|
-
description: 'Status of the cluster.
|
|
415
|
-
example: '
|
|
416
|
-
enum: [
|
|
857
|
+
description: 'Status of the cluster.',
|
|
858
|
+
example: 'deployed',
|
|
859
|
+
enum: [
|
|
860
|
+
'creating',
|
|
861
|
+
'deployed',
|
|
862
|
+
'updating',
|
|
863
|
+
'disabled'
|
|
864
|
+
]
|
|
417
865
|
},
|
|
418
866
|
endpoint: {
|
|
419
867
|
anyOf: [
|
|
420
868
|
{
|
|
421
869
|
type: 'string',
|
|
422
870
|
format: 'uri',
|
|
423
|
-
description: 'URL of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.',
|
|
424
|
-
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
871
|
+
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.',
|
|
872
|
+
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
425
873
|
},
|
|
426
874
|
{
|
|
427
875
|
type: 'string',
|
|
428
|
-
enum: [
|
|
876
|
+
enum: [
|
|
877
|
+
''
|
|
878
|
+
]
|
|
879
|
+
}
|
|
880
|
+
]
|
|
881
|
+
},
|
|
882
|
+
endpoint_public: {
|
|
883
|
+
anyOf: [
|
|
884
|
+
{
|
|
885
|
+
type: 'string',
|
|
886
|
+
format: 'uri',
|
|
887
|
+
description: 'Deprecated alias of `endpoint`; retained for backward compatibility.',
|
|
888
|
+
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
889
|
+
},
|
|
890
|
+
{
|
|
891
|
+
type: 'string',
|
|
892
|
+
enum: [
|
|
893
|
+
''
|
|
894
|
+
]
|
|
429
895
|
}
|
|
430
896
|
]
|
|
431
897
|
},
|
|
432
898
|
certificate_ca: {
|
|
433
899
|
type: 'string',
|
|
434
900
|
description: 'Certificate authority data for the kubernetes cluster. This is the root certificate authority for the cluster.',
|
|
435
|
-
example:
|
|
436
|
-
MIIC0DCCAbigAwIBAgI...`
|
|
901
|
+
example: '-----BEGIN CERTIFICATE-----\nMIIC0DCCAbigAwIBAgI...'
|
|
437
902
|
},
|
|
438
903
|
version_current: {
|
|
439
904
|
type: 'string',
|
|
@@ -456,8 +921,20 @@ MIIC0DCCAbigAwIBAgI...`
|
|
|
456
921
|
example: true
|
|
457
922
|
}
|
|
458
923
|
},
|
|
459
|
-
required: [
|
|
460
|
-
|
|
924
|
+
required: [
|
|
925
|
+
'name',
|
|
926
|
+
'tier',
|
|
927
|
+
'version_channel',
|
|
928
|
+
'release_channel',
|
|
929
|
+
'features',
|
|
930
|
+
'region',
|
|
931
|
+
'networking',
|
|
932
|
+
'id',
|
|
933
|
+
'status',
|
|
934
|
+
'ready'
|
|
935
|
+
],
|
|
936
|
+
additionalProperties: false,
|
|
937
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
461
938
|
};
|
|
462
939
|
export const ClusterUpdateInputSchema = {
|
|
463
940
|
type: 'object',
|
|
@@ -473,18 +950,74 @@ export const ClusterUpdateInputSchema = {
|
|
|
473
950
|
tier: {
|
|
474
951
|
type: 'string',
|
|
475
952
|
description: 'Tier of the cluster.',
|
|
953
|
+
default: 'basic',
|
|
476
954
|
example: 'pro',
|
|
477
|
-
enum: [
|
|
955
|
+
enum: [
|
|
956
|
+
'basic',
|
|
957
|
+
'pro',
|
|
958
|
+
'enterprise'
|
|
959
|
+
]
|
|
478
960
|
},
|
|
479
961
|
version_channel: {
|
|
480
962
|
type: 'string',
|
|
481
963
|
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-]+)*))?$',
|
|
482
964
|
description: 'Version of the kubernetes cluster.',
|
|
483
|
-
|
|
965
|
+
default: '1.x.x-cfke.x',
|
|
966
|
+
example: '1.x.x-cfke.x'
|
|
967
|
+
},
|
|
968
|
+
release_channel: {
|
|
969
|
+
type: 'string',
|
|
970
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
971
|
+
default: 'rapid',
|
|
972
|
+
example: 'rapid',
|
|
973
|
+
enum: [
|
|
974
|
+
'rapid',
|
|
975
|
+
'stable',
|
|
976
|
+
'extended'
|
|
977
|
+
]
|
|
978
|
+
},
|
|
979
|
+
features: {
|
|
980
|
+
type: 'object',
|
|
981
|
+
properties: {
|
|
982
|
+
gpu_sharing_strategy: {
|
|
983
|
+
type: 'string',
|
|
984
|
+
description: 'GPU sharing strategy.',
|
|
985
|
+
default: 'none',
|
|
986
|
+
example: 'none',
|
|
987
|
+
enum: [
|
|
988
|
+
'none',
|
|
989
|
+
'mps',
|
|
990
|
+
'time_slicing'
|
|
991
|
+
]
|
|
992
|
+
},
|
|
993
|
+
gpu_max_shared_clients_per_gpu: {
|
|
994
|
+
type: 'integer',
|
|
995
|
+
minimum: 2,
|
|
996
|
+
maximum: 48,
|
|
997
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
998
|
+
default: 4,
|
|
999
|
+
example: 10
|
|
1000
|
+
},
|
|
1001
|
+
cilium_socket_lb_host_namespace_only: {
|
|
1002
|
+
type: 'boolean',
|
|
1003
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
1004
|
+
example: false
|
|
1005
|
+
}
|
|
1006
|
+
},
|
|
1007
|
+
additionalProperties: false,
|
|
1008
|
+
description: 'Cluster feature toggles.',
|
|
1009
|
+
default: {
|
|
1010
|
+
gpu_sharing_strategy: 'none',
|
|
1011
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
1012
|
+
cilium_socket_lb_host_namespace_only: false
|
|
1013
|
+
}
|
|
484
1014
|
}
|
|
485
1015
|
},
|
|
486
|
-
required: [
|
|
487
|
-
|
|
1016
|
+
required: [
|
|
1017
|
+
'name'
|
|
1018
|
+
],
|
|
1019
|
+
additionalProperties: false,
|
|
1020
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
488
1021
|
};
|
|
489
1022
|
export const FleetCreateInputSchema = {
|
|
490
1023
|
type: 'object',
|
|
@@ -493,13 +1026,12 @@ export const FleetCreateInputSchema = {
|
|
|
493
1026
|
type: 'object',
|
|
494
1027
|
properties: {
|
|
495
1028
|
cpu: {
|
|
496
|
-
type: '
|
|
497
|
-
format: 'float',
|
|
1029
|
+
type: 'integer',
|
|
498
1030
|
minimum: 0,
|
|
499
|
-
|
|
1031
|
+
maximum: 100000,
|
|
1032
|
+
description: 'CPU limit in cores. Maximum 100,000.'
|
|
500
1033
|
}
|
|
501
1034
|
},
|
|
502
|
-
required: ['cpu'],
|
|
503
1035
|
additionalProperties: false,
|
|
504
1036
|
description: 'Limits define a set of bounds for provisioning capacity.'
|
|
505
1037
|
},
|
|
@@ -507,47 +1039,358 @@ export const FleetCreateInputSchema = {
|
|
|
507
1039
|
type: 'object',
|
|
508
1040
|
properties: {
|
|
509
1041
|
enabled: {
|
|
510
|
-
type: 'boolean'
|
|
511
|
-
default: true
|
|
1042
|
+
type: 'boolean'
|
|
512
1043
|
},
|
|
513
1044
|
project: {
|
|
514
1045
|
type: 'string',
|
|
515
|
-
|
|
1046
|
+
pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
|
|
1047
|
+
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.',
|
|
1048
|
+
example: 'my-cloudfleet-project'
|
|
516
1049
|
}
|
|
517
1050
|
},
|
|
518
|
-
required: [
|
|
1051
|
+
required: [
|
|
1052
|
+
'enabled'
|
|
1053
|
+
],
|
|
519
1054
|
additionalProperties: false
|
|
520
1055
|
},
|
|
521
1056
|
hetzner: {
|
|
522
1057
|
type: 'object',
|
|
523
1058
|
properties: {
|
|
524
1059
|
enabled: {
|
|
525
|
-
type: 'boolean'
|
|
526
|
-
default: true
|
|
1060
|
+
type: 'boolean'
|
|
527
1061
|
},
|
|
528
1062
|
apiKey: {
|
|
529
1063
|
type: 'string',
|
|
530
|
-
|
|
1064
|
+
maxLength: 64,
|
|
1065
|
+
minLength: 64,
|
|
1066
|
+
pattern: '^([A-Za-z0-9]{64}|\\*{64})$',
|
|
1067
|
+
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.'
|
|
531
1068
|
}
|
|
532
1069
|
},
|
|
533
|
-
required: [
|
|
1070
|
+
required: [
|
|
1071
|
+
'enabled'
|
|
1072
|
+
],
|
|
534
1073
|
additionalProperties: false
|
|
535
1074
|
},
|
|
536
1075
|
aws: {
|
|
537
1076
|
type: 'object',
|
|
538
1077
|
properties: {
|
|
539
1078
|
enabled: {
|
|
540
|
-
type: 'boolean'
|
|
541
|
-
default: true
|
|
1079
|
+
type: 'boolean'
|
|
542
1080
|
},
|
|
543
1081
|
controllerRoleArn: {
|
|
544
1082
|
type: 'string',
|
|
545
|
-
|
|
1083
|
+
pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
|
|
1084
|
+
description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
|
|
1085
|
+
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
546
1086
|
}
|
|
547
1087
|
},
|
|
548
|
-
required: [
|
|
1088
|
+
required: [
|
|
1089
|
+
'enabled'
|
|
1090
|
+
],
|
|
549
1091
|
additionalProperties: false
|
|
550
1092
|
},
|
|
1093
|
+
constraints: {
|
|
1094
|
+
type: 'object',
|
|
1095
|
+
properties: {
|
|
1096
|
+
'karpenter.sh/capacity-type': {
|
|
1097
|
+
type: 'array',
|
|
1098
|
+
items: {
|
|
1099
|
+
type: 'string',
|
|
1100
|
+
enum: [
|
|
1101
|
+
'on-demand',
|
|
1102
|
+
'spot'
|
|
1103
|
+
]
|
|
1104
|
+
},
|
|
1105
|
+
minItems: 1,
|
|
1106
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1107
|
+
default: [
|
|
1108
|
+
'on-demand',
|
|
1109
|
+
'spot'
|
|
1110
|
+
]
|
|
1111
|
+
},
|
|
1112
|
+
'kubernetes.io/arch': {
|
|
1113
|
+
type: 'array',
|
|
1114
|
+
items: {
|
|
1115
|
+
type: 'string',
|
|
1116
|
+
enum: [
|
|
1117
|
+
'amd64',
|
|
1118
|
+
'arm64'
|
|
1119
|
+
]
|
|
1120
|
+
},
|
|
1121
|
+
minItems: 1,
|
|
1122
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1123
|
+
default: [
|
|
1124
|
+
'amd64'
|
|
1125
|
+
]
|
|
1126
|
+
},
|
|
1127
|
+
'cfke.io/instance-family': {
|
|
1128
|
+
type: 'array',
|
|
1129
|
+
items: {
|
|
1130
|
+
type: 'string',
|
|
1131
|
+
enum: [
|
|
1132
|
+
'a1',
|
|
1133
|
+
'a2',
|
|
1134
|
+
'a3',
|
|
1135
|
+
'a4',
|
|
1136
|
+
'c1',
|
|
1137
|
+
'c2',
|
|
1138
|
+
'c2d',
|
|
1139
|
+
'c3',
|
|
1140
|
+
'c3d',
|
|
1141
|
+
'c4',
|
|
1142
|
+
'c4a',
|
|
1143
|
+
'c4d',
|
|
1144
|
+
'c5',
|
|
1145
|
+
'c5a',
|
|
1146
|
+
'c5ad',
|
|
1147
|
+
'c5d',
|
|
1148
|
+
'c5n',
|
|
1149
|
+
'c6a',
|
|
1150
|
+
'c6g',
|
|
1151
|
+
'c6gd',
|
|
1152
|
+
'c6gn',
|
|
1153
|
+
'c6i',
|
|
1154
|
+
'c6id',
|
|
1155
|
+
'c6in',
|
|
1156
|
+
'c7a',
|
|
1157
|
+
'c7g',
|
|
1158
|
+
'c7gd',
|
|
1159
|
+
'c7gn',
|
|
1160
|
+
'c7i',
|
|
1161
|
+
'c7i-flex',
|
|
1162
|
+
'c8g',
|
|
1163
|
+
'c8gd',
|
|
1164
|
+
'cax',
|
|
1165
|
+
'ccx',
|
|
1166
|
+
'cpx',
|
|
1167
|
+
'cx',
|
|
1168
|
+
'd2',
|
|
1169
|
+
'd3',
|
|
1170
|
+
'd3en',
|
|
1171
|
+
'dl1',
|
|
1172
|
+
'dl2q',
|
|
1173
|
+
'e2',
|
|
1174
|
+
'f1',
|
|
1175
|
+
'f2',
|
|
1176
|
+
'g1',
|
|
1177
|
+
'g2',
|
|
1178
|
+
'g4ad',
|
|
1179
|
+
'g4dn',
|
|
1180
|
+
'g5',
|
|
1181
|
+
'g5g',
|
|
1182
|
+
'g6',
|
|
1183
|
+
'g6e',
|
|
1184
|
+
'gr6',
|
|
1185
|
+
'h1',
|
|
1186
|
+
'h3',
|
|
1187
|
+
'hpc6a',
|
|
1188
|
+
'hpc6id',
|
|
1189
|
+
'hpc7a',
|
|
1190
|
+
'hpc7g',
|
|
1191
|
+
'i2',
|
|
1192
|
+
'i3',
|
|
1193
|
+
'i3en',
|
|
1194
|
+
'i4g',
|
|
1195
|
+
'i4i',
|
|
1196
|
+
'i7i',
|
|
1197
|
+
'i7ie',
|
|
1198
|
+
'i8g',
|
|
1199
|
+
'im4gn',
|
|
1200
|
+
'inf1',
|
|
1201
|
+
'inf2',
|
|
1202
|
+
'is4gen',
|
|
1203
|
+
'm1',
|
|
1204
|
+
'm2',
|
|
1205
|
+
'm3',
|
|
1206
|
+
'm4',
|
|
1207
|
+
'm5',
|
|
1208
|
+
'm5a',
|
|
1209
|
+
'm5ad',
|
|
1210
|
+
'm5d',
|
|
1211
|
+
'm5dn',
|
|
1212
|
+
'm5n',
|
|
1213
|
+
'm5zn',
|
|
1214
|
+
'm6a',
|
|
1215
|
+
'm6g',
|
|
1216
|
+
'm6gd',
|
|
1217
|
+
'm6i',
|
|
1218
|
+
'm6id',
|
|
1219
|
+
'm6idn',
|
|
1220
|
+
'm6in',
|
|
1221
|
+
'm7a',
|
|
1222
|
+
'm7g',
|
|
1223
|
+
'm7gd',
|
|
1224
|
+
'm7i',
|
|
1225
|
+
'm7i-flex',
|
|
1226
|
+
'm8g',
|
|
1227
|
+
'm8gd',
|
|
1228
|
+
'n1',
|
|
1229
|
+
'n2',
|
|
1230
|
+
'n2d',
|
|
1231
|
+
'n4',
|
|
1232
|
+
'p3',
|
|
1233
|
+
'p3dn',
|
|
1234
|
+
'p4d',
|
|
1235
|
+
'p4de',
|
|
1236
|
+
'p5',
|
|
1237
|
+
'p5e',
|
|
1238
|
+
'p5en',
|
|
1239
|
+
'p6-b200',
|
|
1240
|
+
'r3',
|
|
1241
|
+
'r4',
|
|
1242
|
+
'r5',
|
|
1243
|
+
'r5a',
|
|
1244
|
+
'r5ad',
|
|
1245
|
+
'r5b',
|
|
1246
|
+
'r5d',
|
|
1247
|
+
'r5dn',
|
|
1248
|
+
'r5n',
|
|
1249
|
+
'r6a',
|
|
1250
|
+
'r6g',
|
|
1251
|
+
'r6gd',
|
|
1252
|
+
'r6i',
|
|
1253
|
+
'r6id',
|
|
1254
|
+
'r6idn',
|
|
1255
|
+
'r6in',
|
|
1256
|
+
'r7a',
|
|
1257
|
+
'r7g',
|
|
1258
|
+
'r7gd',
|
|
1259
|
+
'r7i',
|
|
1260
|
+
'r7iz',
|
|
1261
|
+
'r8g',
|
|
1262
|
+
'r8gd',
|
|
1263
|
+
't2',
|
|
1264
|
+
't2a',
|
|
1265
|
+
't2d',
|
|
1266
|
+
't3',
|
|
1267
|
+
't3a',
|
|
1268
|
+
't4g',
|
|
1269
|
+
'trn1',
|
|
1270
|
+
'trn1n',
|
|
1271
|
+
'u-3tb1',
|
|
1272
|
+
'u-6tb1',
|
|
1273
|
+
'u7i-12tb',
|
|
1274
|
+
'u7i-6tb',
|
|
1275
|
+
'u7i-8tb',
|
|
1276
|
+
'u7in-16tb',
|
|
1277
|
+
'u7in-24tb',
|
|
1278
|
+
'u7in-32tb',
|
|
1279
|
+
'vt1',
|
|
1280
|
+
'x1',
|
|
1281
|
+
'x1e',
|
|
1282
|
+
'x2gd',
|
|
1283
|
+
'x2idn',
|
|
1284
|
+
'x2iedn',
|
|
1285
|
+
'x2iezn',
|
|
1286
|
+
'x4',
|
|
1287
|
+
'x8g',
|
|
1288
|
+
'z1d',
|
|
1289
|
+
'z3'
|
|
1290
|
+
]
|
|
1291
|
+
},
|
|
1292
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
1293
|
+
default: []
|
|
1294
|
+
},
|
|
1295
|
+
'topology.kubernetes.io/region': {
|
|
1296
|
+
type: 'array',
|
|
1297
|
+
items: {
|
|
1298
|
+
type: 'string',
|
|
1299
|
+
enum: [
|
|
1300
|
+
'africa-south1',
|
|
1301
|
+
'ap-northeast-1',
|
|
1302
|
+
'ap-northeast-2',
|
|
1303
|
+
'ap-northeast-3',
|
|
1304
|
+
'ap-south-1',
|
|
1305
|
+
'ap-southeast-1',
|
|
1306
|
+
'ap-southeast-2',
|
|
1307
|
+
'ash',
|
|
1308
|
+
'asia-east1',
|
|
1309
|
+
'asia-east2',
|
|
1310
|
+
'asia-northeast1',
|
|
1311
|
+
'asia-northeast2',
|
|
1312
|
+
'asia-northeast3',
|
|
1313
|
+
'asia-south1',
|
|
1314
|
+
'asia-south2',
|
|
1315
|
+
'asia-southeast1',
|
|
1316
|
+
'asia-southeast2',
|
|
1317
|
+
'australia-southeast1',
|
|
1318
|
+
'australia-southeast2',
|
|
1319
|
+
'ca-central-1',
|
|
1320
|
+
'eu-central-1',
|
|
1321
|
+
'eu-central-2',
|
|
1322
|
+
'eu-north-1',
|
|
1323
|
+
'eu-west-1',
|
|
1324
|
+
'eu-west-2',
|
|
1325
|
+
'eu-west-3',
|
|
1326
|
+
'europe-central2',
|
|
1327
|
+
'europe-north1',
|
|
1328
|
+
'europe-southwest1',
|
|
1329
|
+
'europe-west1',
|
|
1330
|
+
'europe-west10',
|
|
1331
|
+
'europe-west12',
|
|
1332
|
+
'europe-west2',
|
|
1333
|
+
'europe-west3',
|
|
1334
|
+
'europe-west4',
|
|
1335
|
+
'europe-west6',
|
|
1336
|
+
'europe-west8',
|
|
1337
|
+
'europe-west9',
|
|
1338
|
+
'fsn1',
|
|
1339
|
+
'hel1',
|
|
1340
|
+
'hil',
|
|
1341
|
+
'me-central1',
|
|
1342
|
+
'me-central2',
|
|
1343
|
+
'me-west1',
|
|
1344
|
+
'nbg1',
|
|
1345
|
+
'northamerica-northeast1',
|
|
1346
|
+
'northamerica-northeast2',
|
|
1347
|
+
'sa-east-1',
|
|
1348
|
+
'sin',
|
|
1349
|
+
'southamerica-east1',
|
|
1350
|
+
'southamerica-west1',
|
|
1351
|
+
'us-central1',
|
|
1352
|
+
'us-east-1',
|
|
1353
|
+
'us-east-2',
|
|
1354
|
+
'us-east1',
|
|
1355
|
+
'us-east4',
|
|
1356
|
+
'us-east5',
|
|
1357
|
+
'us-south1',
|
|
1358
|
+
'us-west-1',
|
|
1359
|
+
'us-west-2',
|
|
1360
|
+
'us-west1',
|
|
1361
|
+
'us-west2',
|
|
1362
|
+
'us-west3',
|
|
1363
|
+
'us-west4'
|
|
1364
|
+
]
|
|
1365
|
+
},
|
|
1366
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
1367
|
+
default: []
|
|
1368
|
+
}
|
|
1369
|
+
},
|
|
1370
|
+
additionalProperties: false,
|
|
1371
|
+
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.',
|
|
1372
|
+
default: {
|
|
1373
|
+
'karpenter.sh/capacity-type': [
|
|
1374
|
+
'on-demand',
|
|
1375
|
+
'spot'
|
|
1376
|
+
],
|
|
1377
|
+
'kubernetes.io/arch': [
|
|
1378
|
+
'amd64'
|
|
1379
|
+
],
|
|
1380
|
+
'cfke.io/instance-family': [],
|
|
1381
|
+
'topology.kubernetes.io/region': []
|
|
1382
|
+
}
|
|
1383
|
+
},
|
|
1384
|
+
scalingProfile: {
|
|
1385
|
+
type: 'string',
|
|
1386
|
+
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`).',
|
|
1387
|
+
default: 'conservative',
|
|
1388
|
+
example: 'conservative',
|
|
1389
|
+
enum: [
|
|
1390
|
+
'aggressive',
|
|
1391
|
+
'conservative'
|
|
1392
|
+
]
|
|
1393
|
+
},
|
|
551
1394
|
id: {
|
|
552
1395
|
type: 'string',
|
|
553
1396
|
maxLength: 63,
|
|
@@ -557,8 +1400,11 @@ export const FleetCreateInputSchema = {
|
|
|
557
1400
|
example: 'new-clouds-fleet'
|
|
558
1401
|
}
|
|
559
1402
|
},
|
|
560
|
-
required: [
|
|
561
|
-
|
|
1403
|
+
required: [
|
|
1404
|
+
'id'
|
|
1405
|
+
],
|
|
1406
|
+
additionalProperties: false,
|
|
1407
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
562
1408
|
};
|
|
563
1409
|
export const FleetSchema = {
|
|
564
1410
|
type: 'object',
|
|
@@ -567,13 +1413,12 @@ export const FleetSchema = {
|
|
|
567
1413
|
type: 'object',
|
|
568
1414
|
properties: {
|
|
569
1415
|
cpu: {
|
|
570
|
-
type: '
|
|
571
|
-
format: 'float',
|
|
1416
|
+
type: 'integer',
|
|
572
1417
|
minimum: 0,
|
|
573
|
-
|
|
1418
|
+
maximum: 100000,
|
|
1419
|
+
description: 'CPU limit in cores. Maximum 100,000.'
|
|
574
1420
|
}
|
|
575
1421
|
},
|
|
576
|
-
required: ['cpu'],
|
|
577
1422
|
additionalProperties: false,
|
|
578
1423
|
description: 'Limits define a set of bounds for provisioning capacity.'
|
|
579
1424
|
},
|
|
@@ -581,47 +1426,360 @@ export const FleetSchema = {
|
|
|
581
1426
|
type: 'object',
|
|
582
1427
|
properties: {
|
|
583
1428
|
enabled: {
|
|
584
|
-
type: 'boolean'
|
|
585
|
-
default: true
|
|
1429
|
+
type: 'boolean'
|
|
586
1430
|
},
|
|
587
1431
|
project: {
|
|
588
1432
|
type: 'string',
|
|
589
|
-
|
|
1433
|
+
pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
|
|
1434
|
+
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.',
|
|
1435
|
+
example: 'my-cloudfleet-project'
|
|
590
1436
|
}
|
|
591
1437
|
},
|
|
592
|
-
required: [
|
|
1438
|
+
required: [
|
|
1439
|
+
'enabled'
|
|
1440
|
+
],
|
|
593
1441
|
additionalProperties: false
|
|
594
1442
|
},
|
|
595
1443
|
hetzner: {
|
|
596
1444
|
type: 'object',
|
|
597
1445
|
properties: {
|
|
598
1446
|
enabled: {
|
|
599
|
-
type: 'boolean'
|
|
600
|
-
default: true
|
|
1447
|
+
type: 'boolean'
|
|
601
1448
|
},
|
|
602
1449
|
apiKey: {
|
|
603
1450
|
type: 'string',
|
|
604
|
-
|
|
1451
|
+
pattern: '^\\*{64}$',
|
|
1452
|
+
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.'
|
|
605
1453
|
}
|
|
606
1454
|
},
|
|
607
|
-
required: [
|
|
1455
|
+
required: [
|
|
1456
|
+
'enabled'
|
|
1457
|
+
],
|
|
608
1458
|
additionalProperties: false
|
|
609
1459
|
},
|
|
610
1460
|
aws: {
|
|
611
1461
|
type: 'object',
|
|
612
1462
|
properties: {
|
|
613
1463
|
enabled: {
|
|
614
|
-
type: 'boolean'
|
|
615
|
-
default: true
|
|
1464
|
+
type: 'boolean'
|
|
616
1465
|
},
|
|
617
1466
|
controllerRoleArn: {
|
|
618
1467
|
type: 'string',
|
|
619
|
-
|
|
1468
|
+
pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
|
|
1469
|
+
description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
|
|
1470
|
+
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
620
1471
|
}
|
|
621
1472
|
},
|
|
622
|
-
required: [
|
|
1473
|
+
required: [
|
|
1474
|
+
'enabled'
|
|
1475
|
+
],
|
|
623
1476
|
additionalProperties: false
|
|
624
1477
|
},
|
|
1478
|
+
constraints: {
|
|
1479
|
+
type: 'object',
|
|
1480
|
+
properties: {
|
|
1481
|
+
'karpenter.sh/capacity-type': {
|
|
1482
|
+
type: 'array',
|
|
1483
|
+
items: {
|
|
1484
|
+
type: 'string',
|
|
1485
|
+
enum: [
|
|
1486
|
+
'on-demand',
|
|
1487
|
+
'spot'
|
|
1488
|
+
]
|
|
1489
|
+
},
|
|
1490
|
+
minItems: 1,
|
|
1491
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1492
|
+
default: [
|
|
1493
|
+
'on-demand',
|
|
1494
|
+
'spot'
|
|
1495
|
+
]
|
|
1496
|
+
},
|
|
1497
|
+
'kubernetes.io/arch': {
|
|
1498
|
+
type: 'array',
|
|
1499
|
+
items: {
|
|
1500
|
+
type: 'string',
|
|
1501
|
+
enum: [
|
|
1502
|
+
'amd64',
|
|
1503
|
+
'arm64'
|
|
1504
|
+
]
|
|
1505
|
+
},
|
|
1506
|
+
minItems: 1,
|
|
1507
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1508
|
+
default: [
|
|
1509
|
+
'amd64'
|
|
1510
|
+
]
|
|
1511
|
+
},
|
|
1512
|
+
'cfke.io/instance-family': {
|
|
1513
|
+
type: 'array',
|
|
1514
|
+
items: {
|
|
1515
|
+
type: 'string',
|
|
1516
|
+
enum: [
|
|
1517
|
+
'a1',
|
|
1518
|
+
'a2',
|
|
1519
|
+
'a3',
|
|
1520
|
+
'a4',
|
|
1521
|
+
'c1',
|
|
1522
|
+
'c2',
|
|
1523
|
+
'c2d',
|
|
1524
|
+
'c3',
|
|
1525
|
+
'c3d',
|
|
1526
|
+
'c4',
|
|
1527
|
+
'c4a',
|
|
1528
|
+
'c4d',
|
|
1529
|
+
'c5',
|
|
1530
|
+
'c5a',
|
|
1531
|
+
'c5ad',
|
|
1532
|
+
'c5d',
|
|
1533
|
+
'c5n',
|
|
1534
|
+
'c6a',
|
|
1535
|
+
'c6g',
|
|
1536
|
+
'c6gd',
|
|
1537
|
+
'c6gn',
|
|
1538
|
+
'c6i',
|
|
1539
|
+
'c6id',
|
|
1540
|
+
'c6in',
|
|
1541
|
+
'c7a',
|
|
1542
|
+
'c7g',
|
|
1543
|
+
'c7gd',
|
|
1544
|
+
'c7gn',
|
|
1545
|
+
'c7i',
|
|
1546
|
+
'c7i-flex',
|
|
1547
|
+
'c8g',
|
|
1548
|
+
'c8gd',
|
|
1549
|
+
'cax',
|
|
1550
|
+
'ccx',
|
|
1551
|
+
'cpx',
|
|
1552
|
+
'cx',
|
|
1553
|
+
'd2',
|
|
1554
|
+
'd3',
|
|
1555
|
+
'd3en',
|
|
1556
|
+
'dl1',
|
|
1557
|
+
'dl2q',
|
|
1558
|
+
'e2',
|
|
1559
|
+
'f1',
|
|
1560
|
+
'f2',
|
|
1561
|
+
'g1',
|
|
1562
|
+
'g2',
|
|
1563
|
+
'g4ad',
|
|
1564
|
+
'g4dn',
|
|
1565
|
+
'g5',
|
|
1566
|
+
'g5g',
|
|
1567
|
+
'g6',
|
|
1568
|
+
'g6e',
|
|
1569
|
+
'gr6',
|
|
1570
|
+
'h1',
|
|
1571
|
+
'h3',
|
|
1572
|
+
'hpc6a',
|
|
1573
|
+
'hpc6id',
|
|
1574
|
+
'hpc7a',
|
|
1575
|
+
'hpc7g',
|
|
1576
|
+
'i2',
|
|
1577
|
+
'i3',
|
|
1578
|
+
'i3en',
|
|
1579
|
+
'i4g',
|
|
1580
|
+
'i4i',
|
|
1581
|
+
'i7i',
|
|
1582
|
+
'i7ie',
|
|
1583
|
+
'i8g',
|
|
1584
|
+
'im4gn',
|
|
1585
|
+
'inf1',
|
|
1586
|
+
'inf2',
|
|
1587
|
+
'is4gen',
|
|
1588
|
+
'm1',
|
|
1589
|
+
'm2',
|
|
1590
|
+
'm3',
|
|
1591
|
+
'm4',
|
|
1592
|
+
'm5',
|
|
1593
|
+
'm5a',
|
|
1594
|
+
'm5ad',
|
|
1595
|
+
'm5d',
|
|
1596
|
+
'm5dn',
|
|
1597
|
+
'm5n',
|
|
1598
|
+
'm5zn',
|
|
1599
|
+
'm6a',
|
|
1600
|
+
'm6g',
|
|
1601
|
+
'm6gd',
|
|
1602
|
+
'm6i',
|
|
1603
|
+
'm6id',
|
|
1604
|
+
'm6idn',
|
|
1605
|
+
'm6in',
|
|
1606
|
+
'm7a',
|
|
1607
|
+
'm7g',
|
|
1608
|
+
'm7gd',
|
|
1609
|
+
'm7i',
|
|
1610
|
+
'm7i-flex',
|
|
1611
|
+
'm8g',
|
|
1612
|
+
'm8gd',
|
|
1613
|
+
'n1',
|
|
1614
|
+
'n2',
|
|
1615
|
+
'n2d',
|
|
1616
|
+
'n4',
|
|
1617
|
+
'p3',
|
|
1618
|
+
'p3dn',
|
|
1619
|
+
'p4d',
|
|
1620
|
+
'p4de',
|
|
1621
|
+
'p5',
|
|
1622
|
+
'p5e',
|
|
1623
|
+
'p5en',
|
|
1624
|
+
'p6-b200',
|
|
1625
|
+
'r3',
|
|
1626
|
+
'r4',
|
|
1627
|
+
'r5',
|
|
1628
|
+
'r5a',
|
|
1629
|
+
'r5ad',
|
|
1630
|
+
'r5b',
|
|
1631
|
+
'r5d',
|
|
1632
|
+
'r5dn',
|
|
1633
|
+
'r5n',
|
|
1634
|
+
'r6a',
|
|
1635
|
+
'r6g',
|
|
1636
|
+
'r6gd',
|
|
1637
|
+
'r6i',
|
|
1638
|
+
'r6id',
|
|
1639
|
+
'r6idn',
|
|
1640
|
+
'r6in',
|
|
1641
|
+
'r7a',
|
|
1642
|
+
'r7g',
|
|
1643
|
+
'r7gd',
|
|
1644
|
+
'r7i',
|
|
1645
|
+
'r7iz',
|
|
1646
|
+
'r8g',
|
|
1647
|
+
'r8gd',
|
|
1648
|
+
't2',
|
|
1649
|
+
't2a',
|
|
1650
|
+
't2d',
|
|
1651
|
+
't3',
|
|
1652
|
+
't3a',
|
|
1653
|
+
't4g',
|
|
1654
|
+
'trn1',
|
|
1655
|
+
'trn1n',
|
|
1656
|
+
'u-3tb1',
|
|
1657
|
+
'u-6tb1',
|
|
1658
|
+
'u7i-12tb',
|
|
1659
|
+
'u7i-6tb',
|
|
1660
|
+
'u7i-8tb',
|
|
1661
|
+
'u7in-16tb',
|
|
1662
|
+
'u7in-24tb',
|
|
1663
|
+
'u7in-32tb',
|
|
1664
|
+
'vt1',
|
|
1665
|
+
'x1',
|
|
1666
|
+
'x1e',
|
|
1667
|
+
'x2gd',
|
|
1668
|
+
'x2idn',
|
|
1669
|
+
'x2iedn',
|
|
1670
|
+
'x2iezn',
|
|
1671
|
+
'x4',
|
|
1672
|
+
'x8g',
|
|
1673
|
+
'z1d',
|
|
1674
|
+
'z3'
|
|
1675
|
+
]
|
|
1676
|
+
},
|
|
1677
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
1678
|
+
default: []
|
|
1679
|
+
},
|
|
1680
|
+
'topology.kubernetes.io/region': {
|
|
1681
|
+
type: 'array',
|
|
1682
|
+
items: {
|
|
1683
|
+
type: 'string',
|
|
1684
|
+
enum: [
|
|
1685
|
+
'africa-south1',
|
|
1686
|
+
'ap-northeast-1',
|
|
1687
|
+
'ap-northeast-2',
|
|
1688
|
+
'ap-northeast-3',
|
|
1689
|
+
'ap-south-1',
|
|
1690
|
+
'ap-southeast-1',
|
|
1691
|
+
'ap-southeast-2',
|
|
1692
|
+
'ash',
|
|
1693
|
+
'asia-east1',
|
|
1694
|
+
'asia-east2',
|
|
1695
|
+
'asia-northeast1',
|
|
1696
|
+
'asia-northeast2',
|
|
1697
|
+
'asia-northeast3',
|
|
1698
|
+
'asia-south1',
|
|
1699
|
+
'asia-south2',
|
|
1700
|
+
'asia-southeast1',
|
|
1701
|
+
'asia-southeast2',
|
|
1702
|
+
'australia-southeast1',
|
|
1703
|
+
'australia-southeast2',
|
|
1704
|
+
'ca-central-1',
|
|
1705
|
+
'eu-central-1',
|
|
1706
|
+
'eu-central-2',
|
|
1707
|
+
'eu-north-1',
|
|
1708
|
+
'eu-west-1',
|
|
1709
|
+
'eu-west-2',
|
|
1710
|
+
'eu-west-3',
|
|
1711
|
+
'europe-central2',
|
|
1712
|
+
'europe-north1',
|
|
1713
|
+
'europe-southwest1',
|
|
1714
|
+
'europe-west1',
|
|
1715
|
+
'europe-west10',
|
|
1716
|
+
'europe-west12',
|
|
1717
|
+
'europe-west2',
|
|
1718
|
+
'europe-west3',
|
|
1719
|
+
'europe-west4',
|
|
1720
|
+
'europe-west6',
|
|
1721
|
+
'europe-west8',
|
|
1722
|
+
'europe-west9',
|
|
1723
|
+
'fsn1',
|
|
1724
|
+
'hel1',
|
|
1725
|
+
'hil',
|
|
1726
|
+
'me-central1',
|
|
1727
|
+
'me-central2',
|
|
1728
|
+
'me-west1',
|
|
1729
|
+
'nbg1',
|
|
1730
|
+
'northamerica-northeast1',
|
|
1731
|
+
'northamerica-northeast2',
|
|
1732
|
+
'sa-east-1',
|
|
1733
|
+
'sin',
|
|
1734
|
+
'southamerica-east1',
|
|
1735
|
+
'southamerica-west1',
|
|
1736
|
+
'us-central1',
|
|
1737
|
+
'us-east-1',
|
|
1738
|
+
'us-east-2',
|
|
1739
|
+
'us-east1',
|
|
1740
|
+
'us-east4',
|
|
1741
|
+
'us-east5',
|
|
1742
|
+
'us-south1',
|
|
1743
|
+
'us-west-1',
|
|
1744
|
+
'us-west-2',
|
|
1745
|
+
'us-west1',
|
|
1746
|
+
'us-west2',
|
|
1747
|
+
'us-west3',
|
|
1748
|
+
'us-west4'
|
|
1749
|
+
]
|
|
1750
|
+
},
|
|
1751
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
1752
|
+
default: []
|
|
1753
|
+
}
|
|
1754
|
+
},
|
|
1755
|
+
required: [
|
|
1756
|
+
'karpenter.sh/capacity-type',
|
|
1757
|
+
'kubernetes.io/arch'
|
|
1758
|
+
],
|
|
1759
|
+
additionalProperties: false,
|
|
1760
|
+
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.',
|
|
1761
|
+
default: {
|
|
1762
|
+
'karpenter.sh/capacity-type': [
|
|
1763
|
+
'on-demand',
|
|
1764
|
+
'spot'
|
|
1765
|
+
],
|
|
1766
|
+
'kubernetes.io/arch': [
|
|
1767
|
+
'amd64'
|
|
1768
|
+
],
|
|
1769
|
+
'cfke.io/instance-family': [],
|
|
1770
|
+
'topology.kubernetes.io/region': []
|
|
1771
|
+
}
|
|
1772
|
+
},
|
|
1773
|
+
scalingProfile: {
|
|
1774
|
+
type: 'string',
|
|
1775
|
+
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`).',
|
|
1776
|
+
default: 'conservative',
|
|
1777
|
+
example: 'conservative',
|
|
1778
|
+
enum: [
|
|
1779
|
+
'aggressive',
|
|
1780
|
+
'conservative'
|
|
1781
|
+
]
|
|
1782
|
+
},
|
|
625
1783
|
id: {
|
|
626
1784
|
type: 'string',
|
|
627
1785
|
maxLength: 63,
|
|
@@ -629,10 +1787,38 @@ export const FleetSchema = {
|
|
|
629
1787
|
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
630
1788
|
description: 'Unique identifier of the kubernetes fleet.',
|
|
631
1789
|
example: 'new-clouds-fleet'
|
|
1790
|
+
},
|
|
1791
|
+
ready: {
|
|
1792
|
+
type: 'boolean',
|
|
1793
|
+
description: 'Indicates whether the fleet configuration is healthy.',
|
|
1794
|
+
example: true
|
|
1795
|
+
},
|
|
1796
|
+
status_message: {
|
|
1797
|
+
type: 'string',
|
|
1798
|
+
description: 'Human-readable reason the fleet is not ready. Present only when `ready` is false.',
|
|
1799
|
+
example: 'Invalid provider permissions.'
|
|
1800
|
+
},
|
|
1801
|
+
created_at: {
|
|
1802
|
+
type: 'string',
|
|
1803
|
+
description: 'Creation date and time of the fleet.',
|
|
1804
|
+
example: '2024-09-12T09:11:27Z'
|
|
1805
|
+
},
|
|
1806
|
+
updated_at: {
|
|
1807
|
+
type: 'string',
|
|
1808
|
+
description: 'Date and time the fleet was last updated.',
|
|
1809
|
+
example: '2024-09-12T09:11:27Z'
|
|
632
1810
|
}
|
|
633
1811
|
},
|
|
634
|
-
required: [
|
|
635
|
-
|
|
1812
|
+
required: [
|
|
1813
|
+
'constraints',
|
|
1814
|
+
'scalingProfile',
|
|
1815
|
+
'id',
|
|
1816
|
+
'ready',
|
|
1817
|
+
'created_at',
|
|
1818
|
+
'updated_at'
|
|
1819
|
+
],
|
|
1820
|
+
additionalProperties: false,
|
|
1821
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
636
1822
|
};
|
|
637
1823
|
export const FleetUpdateInputSchema = {
|
|
638
1824
|
type: 'object',
|
|
@@ -641,13 +1827,12 @@ export const FleetUpdateInputSchema = {
|
|
|
641
1827
|
type: 'object',
|
|
642
1828
|
properties: {
|
|
643
1829
|
cpu: {
|
|
644
|
-
type: '
|
|
645
|
-
format: 'float',
|
|
1830
|
+
type: 'integer',
|
|
646
1831
|
minimum: 0,
|
|
647
|
-
|
|
1832
|
+
maximum: 100000,
|
|
1833
|
+
description: 'CPU limit in cores. Maximum 100,000.'
|
|
648
1834
|
}
|
|
649
1835
|
},
|
|
650
|
-
required: ['cpu'],
|
|
651
1836
|
additionalProperties: false,
|
|
652
1837
|
description: 'Limits define a set of bounds for provisioning capacity.'
|
|
653
1838
|
},
|
|
@@ -655,48 +1840,385 @@ export const FleetUpdateInputSchema = {
|
|
|
655
1840
|
type: 'object',
|
|
656
1841
|
properties: {
|
|
657
1842
|
enabled: {
|
|
658
|
-
type: 'boolean'
|
|
659
|
-
default: true
|
|
1843
|
+
type: 'boolean'
|
|
660
1844
|
},
|
|
661
1845
|
project: {
|
|
662
1846
|
type: 'string',
|
|
663
|
-
|
|
1847
|
+
pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
|
|
1848
|
+
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.',
|
|
1849
|
+
example: 'my-cloudfleet-project'
|
|
664
1850
|
}
|
|
665
1851
|
},
|
|
666
|
-
required: [
|
|
1852
|
+
required: [
|
|
1853
|
+
'enabled'
|
|
1854
|
+
],
|
|
667
1855
|
additionalProperties: false
|
|
668
1856
|
},
|
|
669
1857
|
hetzner: {
|
|
670
1858
|
type: 'object',
|
|
671
1859
|
properties: {
|
|
672
1860
|
enabled: {
|
|
673
|
-
type: 'boolean'
|
|
674
|
-
default: true
|
|
1861
|
+
type: 'boolean'
|
|
675
1862
|
},
|
|
676
1863
|
apiKey: {
|
|
677
1864
|
type: 'string',
|
|
678
|
-
|
|
1865
|
+
maxLength: 64,
|
|
1866
|
+
minLength: 64,
|
|
1867
|
+
pattern: '^([A-Za-z0-9]{64}|\\*{64})$',
|
|
1868
|
+
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.'
|
|
679
1869
|
}
|
|
680
1870
|
},
|
|
681
|
-
required: [
|
|
1871
|
+
required: [
|
|
1872
|
+
'enabled'
|
|
1873
|
+
],
|
|
682
1874
|
additionalProperties: false
|
|
683
1875
|
},
|
|
684
1876
|
aws: {
|
|
685
1877
|
type: 'object',
|
|
686
1878
|
properties: {
|
|
687
1879
|
enabled: {
|
|
688
|
-
type: 'boolean'
|
|
689
|
-
default: true
|
|
1880
|
+
type: 'boolean'
|
|
690
1881
|
},
|
|
691
1882
|
controllerRoleArn: {
|
|
692
1883
|
type: 'string',
|
|
693
|
-
|
|
1884
|
+
pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
|
|
1885
|
+
description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
|
|
1886
|
+
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
694
1887
|
}
|
|
695
1888
|
},
|
|
696
|
-
required: [
|
|
1889
|
+
required: [
|
|
1890
|
+
'enabled'
|
|
1891
|
+
],
|
|
697
1892
|
additionalProperties: false
|
|
1893
|
+
},
|
|
1894
|
+
constraints: {
|
|
1895
|
+
type: 'object',
|
|
1896
|
+
properties: {
|
|
1897
|
+
'karpenter.sh/capacity-type': {
|
|
1898
|
+
type: 'array',
|
|
1899
|
+
items: {
|
|
1900
|
+
type: 'string',
|
|
1901
|
+
enum: [
|
|
1902
|
+
'on-demand',
|
|
1903
|
+
'spot'
|
|
1904
|
+
]
|
|
1905
|
+
},
|
|
1906
|
+
minItems: 1,
|
|
1907
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1908
|
+
default: [
|
|
1909
|
+
'on-demand',
|
|
1910
|
+
'spot'
|
|
1911
|
+
]
|
|
1912
|
+
},
|
|
1913
|
+
'kubernetes.io/arch': {
|
|
1914
|
+
type: 'array',
|
|
1915
|
+
items: {
|
|
1916
|
+
type: 'string',
|
|
1917
|
+
enum: [
|
|
1918
|
+
'amd64',
|
|
1919
|
+
'arm64'
|
|
1920
|
+
]
|
|
1921
|
+
},
|
|
1922
|
+
minItems: 1,
|
|
1923
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1924
|
+
default: [
|
|
1925
|
+
'amd64'
|
|
1926
|
+
]
|
|
1927
|
+
},
|
|
1928
|
+
'cfke.io/instance-family': {
|
|
1929
|
+
type: 'array',
|
|
1930
|
+
items: {
|
|
1931
|
+
type: 'string',
|
|
1932
|
+
enum: [
|
|
1933
|
+
'a1',
|
|
1934
|
+
'a2',
|
|
1935
|
+
'a3',
|
|
1936
|
+
'a4',
|
|
1937
|
+
'c1',
|
|
1938
|
+
'c2',
|
|
1939
|
+
'c2d',
|
|
1940
|
+
'c3',
|
|
1941
|
+
'c3d',
|
|
1942
|
+
'c4',
|
|
1943
|
+
'c4a',
|
|
1944
|
+
'c4d',
|
|
1945
|
+
'c5',
|
|
1946
|
+
'c5a',
|
|
1947
|
+
'c5ad',
|
|
1948
|
+
'c5d',
|
|
1949
|
+
'c5n',
|
|
1950
|
+
'c6a',
|
|
1951
|
+
'c6g',
|
|
1952
|
+
'c6gd',
|
|
1953
|
+
'c6gn',
|
|
1954
|
+
'c6i',
|
|
1955
|
+
'c6id',
|
|
1956
|
+
'c6in',
|
|
1957
|
+
'c7a',
|
|
1958
|
+
'c7g',
|
|
1959
|
+
'c7gd',
|
|
1960
|
+
'c7gn',
|
|
1961
|
+
'c7i',
|
|
1962
|
+
'c7i-flex',
|
|
1963
|
+
'c8g',
|
|
1964
|
+
'c8gd',
|
|
1965
|
+
'cax',
|
|
1966
|
+
'ccx',
|
|
1967
|
+
'cpx',
|
|
1968
|
+
'cx',
|
|
1969
|
+
'd2',
|
|
1970
|
+
'd3',
|
|
1971
|
+
'd3en',
|
|
1972
|
+
'dl1',
|
|
1973
|
+
'dl2q',
|
|
1974
|
+
'e2',
|
|
1975
|
+
'f1',
|
|
1976
|
+
'f2',
|
|
1977
|
+
'g1',
|
|
1978
|
+
'g2',
|
|
1979
|
+
'g4ad',
|
|
1980
|
+
'g4dn',
|
|
1981
|
+
'g5',
|
|
1982
|
+
'g5g',
|
|
1983
|
+
'g6',
|
|
1984
|
+
'g6e',
|
|
1985
|
+
'gr6',
|
|
1986
|
+
'h1',
|
|
1987
|
+
'h3',
|
|
1988
|
+
'hpc6a',
|
|
1989
|
+
'hpc6id',
|
|
1990
|
+
'hpc7a',
|
|
1991
|
+
'hpc7g',
|
|
1992
|
+
'i2',
|
|
1993
|
+
'i3',
|
|
1994
|
+
'i3en',
|
|
1995
|
+
'i4g',
|
|
1996
|
+
'i4i',
|
|
1997
|
+
'i7i',
|
|
1998
|
+
'i7ie',
|
|
1999
|
+
'i8g',
|
|
2000
|
+
'im4gn',
|
|
2001
|
+
'inf1',
|
|
2002
|
+
'inf2',
|
|
2003
|
+
'is4gen',
|
|
2004
|
+
'm1',
|
|
2005
|
+
'm2',
|
|
2006
|
+
'm3',
|
|
2007
|
+
'm4',
|
|
2008
|
+
'm5',
|
|
2009
|
+
'm5a',
|
|
2010
|
+
'm5ad',
|
|
2011
|
+
'm5d',
|
|
2012
|
+
'm5dn',
|
|
2013
|
+
'm5n',
|
|
2014
|
+
'm5zn',
|
|
2015
|
+
'm6a',
|
|
2016
|
+
'm6g',
|
|
2017
|
+
'm6gd',
|
|
2018
|
+
'm6i',
|
|
2019
|
+
'm6id',
|
|
2020
|
+
'm6idn',
|
|
2021
|
+
'm6in',
|
|
2022
|
+
'm7a',
|
|
2023
|
+
'm7g',
|
|
2024
|
+
'm7gd',
|
|
2025
|
+
'm7i',
|
|
2026
|
+
'm7i-flex',
|
|
2027
|
+
'm8g',
|
|
2028
|
+
'm8gd',
|
|
2029
|
+
'n1',
|
|
2030
|
+
'n2',
|
|
2031
|
+
'n2d',
|
|
2032
|
+
'n4',
|
|
2033
|
+
'p3',
|
|
2034
|
+
'p3dn',
|
|
2035
|
+
'p4d',
|
|
2036
|
+
'p4de',
|
|
2037
|
+
'p5',
|
|
2038
|
+
'p5e',
|
|
2039
|
+
'p5en',
|
|
2040
|
+
'p6-b200',
|
|
2041
|
+
'r3',
|
|
2042
|
+
'r4',
|
|
2043
|
+
'r5',
|
|
2044
|
+
'r5a',
|
|
2045
|
+
'r5ad',
|
|
2046
|
+
'r5b',
|
|
2047
|
+
'r5d',
|
|
2048
|
+
'r5dn',
|
|
2049
|
+
'r5n',
|
|
2050
|
+
'r6a',
|
|
2051
|
+
'r6g',
|
|
2052
|
+
'r6gd',
|
|
2053
|
+
'r6i',
|
|
2054
|
+
'r6id',
|
|
2055
|
+
'r6idn',
|
|
2056
|
+
'r6in',
|
|
2057
|
+
'r7a',
|
|
2058
|
+
'r7g',
|
|
2059
|
+
'r7gd',
|
|
2060
|
+
'r7i',
|
|
2061
|
+
'r7iz',
|
|
2062
|
+
'r8g',
|
|
2063
|
+
'r8gd',
|
|
2064
|
+
't2',
|
|
2065
|
+
't2a',
|
|
2066
|
+
't2d',
|
|
2067
|
+
't3',
|
|
2068
|
+
't3a',
|
|
2069
|
+
't4g',
|
|
2070
|
+
'trn1',
|
|
2071
|
+
'trn1n',
|
|
2072
|
+
'u-3tb1',
|
|
2073
|
+
'u-6tb1',
|
|
2074
|
+
'u7i-12tb',
|
|
2075
|
+
'u7i-6tb',
|
|
2076
|
+
'u7i-8tb',
|
|
2077
|
+
'u7in-16tb',
|
|
2078
|
+
'u7in-24tb',
|
|
2079
|
+
'u7in-32tb',
|
|
2080
|
+
'vt1',
|
|
2081
|
+
'x1',
|
|
2082
|
+
'x1e',
|
|
2083
|
+
'x2gd',
|
|
2084
|
+
'x2idn',
|
|
2085
|
+
'x2iedn',
|
|
2086
|
+
'x2iezn',
|
|
2087
|
+
'x4',
|
|
2088
|
+
'x8g',
|
|
2089
|
+
'z1d',
|
|
2090
|
+
'z3'
|
|
2091
|
+
]
|
|
2092
|
+
},
|
|
2093
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
2094
|
+
default: []
|
|
2095
|
+
},
|
|
2096
|
+
'topology.kubernetes.io/region': {
|
|
2097
|
+
type: 'array',
|
|
2098
|
+
items: {
|
|
2099
|
+
type: 'string',
|
|
2100
|
+
enum: [
|
|
2101
|
+
'africa-south1',
|
|
2102
|
+
'ap-northeast-1',
|
|
2103
|
+
'ap-northeast-2',
|
|
2104
|
+
'ap-northeast-3',
|
|
2105
|
+
'ap-south-1',
|
|
2106
|
+
'ap-southeast-1',
|
|
2107
|
+
'ap-southeast-2',
|
|
2108
|
+
'ash',
|
|
2109
|
+
'asia-east1',
|
|
2110
|
+
'asia-east2',
|
|
2111
|
+
'asia-northeast1',
|
|
2112
|
+
'asia-northeast2',
|
|
2113
|
+
'asia-northeast3',
|
|
2114
|
+
'asia-south1',
|
|
2115
|
+
'asia-south2',
|
|
2116
|
+
'asia-southeast1',
|
|
2117
|
+
'asia-southeast2',
|
|
2118
|
+
'australia-southeast1',
|
|
2119
|
+
'australia-southeast2',
|
|
2120
|
+
'ca-central-1',
|
|
2121
|
+
'eu-central-1',
|
|
2122
|
+
'eu-central-2',
|
|
2123
|
+
'eu-north-1',
|
|
2124
|
+
'eu-west-1',
|
|
2125
|
+
'eu-west-2',
|
|
2126
|
+
'eu-west-3',
|
|
2127
|
+
'europe-central2',
|
|
2128
|
+
'europe-north1',
|
|
2129
|
+
'europe-southwest1',
|
|
2130
|
+
'europe-west1',
|
|
2131
|
+
'europe-west10',
|
|
2132
|
+
'europe-west12',
|
|
2133
|
+
'europe-west2',
|
|
2134
|
+
'europe-west3',
|
|
2135
|
+
'europe-west4',
|
|
2136
|
+
'europe-west6',
|
|
2137
|
+
'europe-west8',
|
|
2138
|
+
'europe-west9',
|
|
2139
|
+
'fsn1',
|
|
2140
|
+
'hel1',
|
|
2141
|
+
'hil',
|
|
2142
|
+
'me-central1',
|
|
2143
|
+
'me-central2',
|
|
2144
|
+
'me-west1',
|
|
2145
|
+
'nbg1',
|
|
2146
|
+
'northamerica-northeast1',
|
|
2147
|
+
'northamerica-northeast2',
|
|
2148
|
+
'sa-east-1',
|
|
2149
|
+
'sin',
|
|
2150
|
+
'southamerica-east1',
|
|
2151
|
+
'southamerica-west1',
|
|
2152
|
+
'us-central1',
|
|
2153
|
+
'us-east-1',
|
|
2154
|
+
'us-east-2',
|
|
2155
|
+
'us-east1',
|
|
2156
|
+
'us-east4',
|
|
2157
|
+
'us-east5',
|
|
2158
|
+
'us-south1',
|
|
2159
|
+
'us-west-1',
|
|
2160
|
+
'us-west-2',
|
|
2161
|
+
'us-west1',
|
|
2162
|
+
'us-west2',
|
|
2163
|
+
'us-west3',
|
|
2164
|
+
'us-west4'
|
|
2165
|
+
]
|
|
2166
|
+
},
|
|
2167
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
2168
|
+
default: []
|
|
2169
|
+
}
|
|
2170
|
+
},
|
|
2171
|
+
additionalProperties: false,
|
|
2172
|
+
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.',
|
|
2173
|
+
default: {
|
|
2174
|
+
'karpenter.sh/capacity-type': [
|
|
2175
|
+
'on-demand',
|
|
2176
|
+
'spot'
|
|
2177
|
+
],
|
|
2178
|
+
'kubernetes.io/arch': [
|
|
2179
|
+
'amd64'
|
|
2180
|
+
],
|
|
2181
|
+
'cfke.io/instance-family': [],
|
|
2182
|
+
'topology.kubernetes.io/region': []
|
|
2183
|
+
}
|
|
2184
|
+
},
|
|
2185
|
+
scalingProfile: {
|
|
2186
|
+
type: 'string',
|
|
2187
|
+
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`).',
|
|
2188
|
+
default: 'conservative',
|
|
2189
|
+
example: 'conservative',
|
|
2190
|
+
enum: [
|
|
2191
|
+
'aggressive',
|
|
2192
|
+
'conservative'
|
|
2193
|
+
]
|
|
2194
|
+
}
|
|
2195
|
+
},
|
|
2196
|
+
additionalProperties: false,
|
|
2197
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
2198
|
+
};
|
|
2199
|
+
export const InviteCreateInputSchema = {
|
|
2200
|
+
type: 'object',
|
|
2201
|
+
properties: {
|
|
2202
|
+
email: {
|
|
2203
|
+
type: 'string',
|
|
2204
|
+
format: 'email',
|
|
2205
|
+
description: 'Email address of the user to invite.',
|
|
2206
|
+
example: 'email@example.com'
|
|
2207
|
+
},
|
|
2208
|
+
role: {
|
|
2209
|
+
type: 'string',
|
|
2210
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2211
|
+
default: 'User',
|
|
2212
|
+
example: 'User',
|
|
2213
|
+
enum: [
|
|
2214
|
+
'Administrator',
|
|
2215
|
+
'User'
|
|
2216
|
+
]
|
|
698
2217
|
}
|
|
699
2218
|
},
|
|
2219
|
+
required: [
|
|
2220
|
+
'email'
|
|
2221
|
+
],
|
|
700
2222
|
additionalProperties: false
|
|
701
2223
|
};
|
|
702
2224
|
export const InviteSchema = {
|
|
@@ -729,9 +2251,185 @@ export const InviteSchema = {
|
|
|
729
2251
|
type: 'string',
|
|
730
2252
|
description: 'Generated unique invite code.',
|
|
731
2253
|
example: '7kUZnH7nnKUFfvc4NK2KQF'
|
|
2254
|
+
},
|
|
2255
|
+
role: {
|
|
2256
|
+
type: 'string',
|
|
2257
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2258
|
+
default: 'User',
|
|
2259
|
+
example: 'User',
|
|
2260
|
+
enum: [
|
|
2261
|
+
'Administrator',
|
|
2262
|
+
'User'
|
|
2263
|
+
]
|
|
732
2264
|
}
|
|
733
2265
|
},
|
|
734
|
-
required: [
|
|
2266
|
+
required: [
|
|
2267
|
+
'date_created'
|
|
2268
|
+
],
|
|
2269
|
+
additionalProperties: false
|
|
2270
|
+
};
|
|
2271
|
+
export const InvoicePaymentAttemptSchema = {
|
|
2272
|
+
type: 'object',
|
|
2273
|
+
properties: {
|
|
2274
|
+
invoice_id: {
|
|
2275
|
+
type: 'string',
|
|
2276
|
+
description: 'Identifier of the invoice.',
|
|
2277
|
+
example: 'in_1234567890xCrwxghOTj1234'
|
|
2278
|
+
},
|
|
2279
|
+
number: {
|
|
2280
|
+
type: 'string',
|
|
2281
|
+
nullable: true,
|
|
2282
|
+
description: 'Invoice number. Null if the invoice has no number.',
|
|
2283
|
+
example: 'CF-0042'
|
|
2284
|
+
},
|
|
2285
|
+
amount: {
|
|
2286
|
+
type: 'number',
|
|
2287
|
+
format: 'float',
|
|
2288
|
+
description: 'Amount outstanding when the charge was attempted, in the smallest currency unit.',
|
|
2289
|
+
example: 4200
|
|
2290
|
+
},
|
|
2291
|
+
currency: {
|
|
2292
|
+
type: 'string',
|
|
2293
|
+
description: 'Currency of the invoice.',
|
|
2294
|
+
example: 'eur'
|
|
2295
|
+
},
|
|
2296
|
+
status: {
|
|
2297
|
+
type: 'string',
|
|
2298
|
+
description: 'Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).',
|
|
2299
|
+
example: 'paid',
|
|
2300
|
+
enum: [
|
|
2301
|
+
'paid',
|
|
2302
|
+
'processing',
|
|
2303
|
+
'requires_action',
|
|
2304
|
+
'failed'
|
|
2305
|
+
]
|
|
2306
|
+
},
|
|
2307
|
+
client_secret: {
|
|
2308
|
+
type: 'string',
|
|
2309
|
+
nullable: true,
|
|
2310
|
+
description: 'Client secret used to complete customer authentication. Set only when `status` is `requires_action`.',
|
|
2311
|
+
example: 'pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH'
|
|
2312
|
+
},
|
|
2313
|
+
failure_code: {
|
|
2314
|
+
type: 'string',
|
|
2315
|
+
nullable: true,
|
|
2316
|
+
description: 'Decline code. Set only when `status` is `failed`.',
|
|
2317
|
+
example: 'insufficient_funds'
|
|
2318
|
+
},
|
|
2319
|
+
failure_message: {
|
|
2320
|
+
type: 'string',
|
|
2321
|
+
nullable: true,
|
|
2322
|
+
description: 'Explanation of the decline, suitable for display. Set only when `status` is `failed`.',
|
|
2323
|
+
example: 'Your card has insufficient funds.'
|
|
2324
|
+
}
|
|
2325
|
+
},
|
|
2326
|
+
required: [
|
|
2327
|
+
'invoice_id',
|
|
2328
|
+
'number',
|
|
2329
|
+
'amount',
|
|
2330
|
+
'currency',
|
|
2331
|
+
'status',
|
|
2332
|
+
'client_secret',
|
|
2333
|
+
'failure_code',
|
|
2334
|
+
'failure_message'
|
|
2335
|
+
],
|
|
2336
|
+
additionalProperties: false
|
|
2337
|
+
};
|
|
2338
|
+
export const InvoicePaymentResultSchema = {
|
|
2339
|
+
type: 'object',
|
|
2340
|
+
properties: {
|
|
2341
|
+
code: {
|
|
2342
|
+
type: 'string',
|
|
2343
|
+
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).',
|
|
2344
|
+
example: 'partially_paid',
|
|
2345
|
+
enum: [
|
|
2346
|
+
'paid',
|
|
2347
|
+
'processing',
|
|
2348
|
+
'action_required',
|
|
2349
|
+
'partially_paid',
|
|
2350
|
+
'failed',
|
|
2351
|
+
'nothing_due',
|
|
2352
|
+
'bank_transfer_due'
|
|
2353
|
+
]
|
|
2354
|
+
},
|
|
2355
|
+
message: {
|
|
2356
|
+
type: 'string',
|
|
2357
|
+
description: 'Summary of the outcome, suitable for display.',
|
|
2358
|
+
example: '1 of 2 open invoices was paid. Invoice CF-0043 was declined: Your card has insufficient funds.'
|
|
2359
|
+
},
|
|
2360
|
+
results: {
|
|
2361
|
+
type: 'array',
|
|
2362
|
+
items: {
|
|
2363
|
+
type: 'object',
|
|
2364
|
+
properties: {
|
|
2365
|
+
invoice_id: {
|
|
2366
|
+
type: 'string',
|
|
2367
|
+
description: 'Identifier of the invoice.',
|
|
2368
|
+
example: 'in_1234567890xCrwxghOTj1234'
|
|
2369
|
+
},
|
|
2370
|
+
number: {
|
|
2371
|
+
type: 'string',
|
|
2372
|
+
description: 'Invoice number. Null if the invoice has no number.',
|
|
2373
|
+
example: 'CF-0042'
|
|
2374
|
+
},
|
|
2375
|
+
amount: {
|
|
2376
|
+
type: 'number',
|
|
2377
|
+
format: 'float',
|
|
2378
|
+
description: 'Amount outstanding when the charge was attempted, in the smallest currency unit.',
|
|
2379
|
+
example: 4200
|
|
2380
|
+
},
|
|
2381
|
+
currency: {
|
|
2382
|
+
type: 'string',
|
|
2383
|
+
description: 'Currency of the invoice.',
|
|
2384
|
+
example: 'eur'
|
|
2385
|
+
},
|
|
2386
|
+
status: {
|
|
2387
|
+
type: 'string',
|
|
2388
|
+
description: 'Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).',
|
|
2389
|
+
example: 'paid',
|
|
2390
|
+
enum: [
|
|
2391
|
+
'paid',
|
|
2392
|
+
'processing',
|
|
2393
|
+
'requires_action',
|
|
2394
|
+
'failed'
|
|
2395
|
+
]
|
|
2396
|
+
},
|
|
2397
|
+
client_secret: {
|
|
2398
|
+
type: 'string',
|
|
2399
|
+
description: 'Client secret used to complete customer authentication. Set only when `status` is `requires_action`.',
|
|
2400
|
+
example: 'pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH'
|
|
2401
|
+
},
|
|
2402
|
+
failure_code: {
|
|
2403
|
+
type: 'string',
|
|
2404
|
+
description: 'Decline code. Set only when `status` is `failed`.',
|
|
2405
|
+
example: 'insufficient_funds'
|
|
2406
|
+
},
|
|
2407
|
+
failure_message: {
|
|
2408
|
+
type: 'string',
|
|
2409
|
+
description: 'Explanation of the decline, suitable for display. Set only when `status` is `failed`.',
|
|
2410
|
+
example: 'Your card has insufficient funds.'
|
|
2411
|
+
}
|
|
2412
|
+
},
|
|
2413
|
+
required: [
|
|
2414
|
+
'invoice_id',
|
|
2415
|
+
'number',
|
|
2416
|
+
'amount',
|
|
2417
|
+
'currency',
|
|
2418
|
+
'status',
|
|
2419
|
+
'client_secret',
|
|
2420
|
+
'failure_code',
|
|
2421
|
+
'failure_message'
|
|
2422
|
+
],
|
|
2423
|
+
additionalProperties: false
|
|
2424
|
+
},
|
|
2425
|
+
description: 'One entry per invoice charged, oldest first.'
|
|
2426
|
+
}
|
|
2427
|
+
},
|
|
2428
|
+
required: [
|
|
2429
|
+
'code',
|
|
2430
|
+
'message',
|
|
2431
|
+
'results'
|
|
2432
|
+
],
|
|
735
2433
|
additionalProperties: false
|
|
736
2434
|
};
|
|
737
2435
|
export const InvoiceSchema = {
|
|
@@ -739,9 +2437,8 @@ export const InvoiceSchema = {
|
|
|
739
2437
|
properties: {
|
|
740
2438
|
id: {
|
|
741
2439
|
type: 'string',
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
example: '415026b6-f00f-44f8-968d-fc6ef4d0fc6d'
|
|
2440
|
+
description: 'Unique identifier of the invoice.',
|
|
2441
|
+
example: 'in_1234567890xCrwxghOTj1234'
|
|
745
2442
|
},
|
|
746
2443
|
number: {
|
|
747
2444
|
type: 'string'
|
|
@@ -784,95 +2481,179 @@ export const InvoiceSchema = {
|
|
|
784
2481
|
type: 'string'
|
|
785
2482
|
}
|
|
786
2483
|
},
|
|
787
|
-
required: [
|
|
2484
|
+
required: [
|
|
2485
|
+
'created',
|
|
2486
|
+
'period_start',
|
|
2487
|
+
'period_end'
|
|
2488
|
+
],
|
|
788
2489
|
additionalProperties: false
|
|
789
2490
|
};
|
|
790
|
-
export const
|
|
2491
|
+
export const MarketplaceListingFilesSchema = {
|
|
791
2492
|
type: 'object',
|
|
792
2493
|
properties: {
|
|
793
|
-
|
|
2494
|
+
chartYaml: {
|
|
794
2495
|
type: 'string',
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
798
|
-
description: 'Id of the chart listing',
|
|
799
|
-
example: 'portworx-enterprise-disaster-recovery-baremetal'
|
|
2496
|
+
description: 'Raw Chart.yaml content from the Helm chart',
|
|
2497
|
+
example: 'apiVersion: v2\nname: nginx-ingress\nversion: 1.18.2-cfke.45\nappVersion: 1.9.4'
|
|
800
2498
|
},
|
|
801
|
-
|
|
2499
|
+
valuesYaml: {
|
|
802
2500
|
type: 'string',
|
|
803
|
-
description: '
|
|
804
|
-
example: '
|
|
2501
|
+
description: 'Raw values.yaml content from the Helm chart',
|
|
2502
|
+
example: 'replicaCount: 1\nimage:\n repository: nginx\n tag: latest'
|
|
805
2503
|
},
|
|
806
|
-
|
|
2504
|
+
valuesSchemaJson: {
|
|
807
2505
|
type: 'string',
|
|
808
|
-
description: '
|
|
809
|
-
example: '
|
|
810
|
-
}
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
description: 'Logo of the chart listing',
|
|
819
|
-
example: 'https://portworx.com/wp-content/themes/portworx/assets/images/header/portworx-logo.png'
|
|
820
|
-
},
|
|
821
|
-
longDescription: {
|
|
2506
|
+
description: 'JSON schema for values.yaml as a string',
|
|
2507
|
+
example: '{"type":"object","properties":{"replicaCount":{"type":"number"}}}'
|
|
2508
|
+
}
|
|
2509
|
+
},
|
|
2510
|
+
additionalProperties: false
|
|
2511
|
+
};
|
|
2512
|
+
export const MarketplaceListingSchema = {
|
|
2513
|
+
type: 'object',
|
|
2514
|
+
properties: {
|
|
2515
|
+
name: {
|
|
822
2516
|
type: 'string',
|
|
823
|
-
description: '
|
|
824
|
-
example: '
|
|
2517
|
+
description: 'Name of the chart',
|
|
2518
|
+
example: 'nginx-ingress'
|
|
825
2519
|
},
|
|
826
|
-
|
|
2520
|
+
versions: {
|
|
827
2521
|
type: 'array',
|
|
828
2522
|
items: {
|
|
829
2523
|
type: 'string',
|
|
830
|
-
|
|
2524
|
+
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-]+)*))?$',
|
|
2525
|
+
description: 'Specific version of the chart',
|
|
2526
|
+
example: '1.18.2-cfke.45'
|
|
831
2527
|
},
|
|
832
|
-
description: '
|
|
2528
|
+
description: 'Available versions of the chart'
|
|
833
2529
|
},
|
|
834
2530
|
version_channels: {
|
|
835
2531
|
type: 'array',
|
|
836
2532
|
items: {
|
|
837
2533
|
type: 'string',
|
|
838
2534
|
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-]+)*))?$',
|
|
839
|
-
description: 'Version
|
|
840
|
-
example: '
|
|
841
|
-
}
|
|
2535
|
+
description: 'Version channel pattern',
|
|
2536
|
+
example: '1.18.x-cfke.x'
|
|
2537
|
+
},
|
|
2538
|
+
description: 'Version channels for the chart'
|
|
842
2539
|
},
|
|
843
|
-
|
|
844
|
-
type: '
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
2540
|
+
latestVersion: {
|
|
2541
|
+
type: 'string',
|
|
2542
|
+
description: 'Latest version of the chart',
|
|
2543
|
+
example: '1.18.2-cfke.45'
|
|
2544
|
+
},
|
|
2545
|
+
metadata: {
|
|
2546
|
+
type: 'object',
|
|
2547
|
+
properties: {
|
|
2548
|
+
name: {
|
|
2549
|
+
type: 'string',
|
|
2550
|
+
description: 'Chart name from metadata',
|
|
2551
|
+
example: 'nginx-ingress'
|
|
2552
|
+
},
|
|
2553
|
+
version: {
|
|
2554
|
+
type: 'string',
|
|
2555
|
+
description: 'Chart version from metadata',
|
|
2556
|
+
example: '1.18.2-cfke.45'
|
|
2557
|
+
},
|
|
2558
|
+
description: {
|
|
2559
|
+
type: 'string',
|
|
2560
|
+
description: 'Chart description',
|
|
2561
|
+
example: 'NGINX Ingress Controller for Kubernetes'
|
|
2562
|
+
},
|
|
2563
|
+
appVersion: {
|
|
2564
|
+
type: 'string',
|
|
2565
|
+
description: 'Application version',
|
|
2566
|
+
example: '1.9.4'
|
|
2567
|
+
},
|
|
2568
|
+
apiVersion: {
|
|
2569
|
+
type: 'string',
|
|
2570
|
+
description: 'Helm API version',
|
|
2571
|
+
example: 'v2'
|
|
2572
|
+
},
|
|
2573
|
+
keywords: {
|
|
2574
|
+
type: 'array',
|
|
2575
|
+
items: {
|
|
2576
|
+
type: 'string'
|
|
853
2577
|
},
|
|
854
|
-
|
|
855
|
-
|
|
856
|
-
|
|
2578
|
+
description: 'Chart keywords',
|
|
2579
|
+
example: [
|
|
2580
|
+
'ingress',
|
|
2581
|
+
'nginx',
|
|
2582
|
+
'load-balancer'
|
|
2583
|
+
]
|
|
2584
|
+
},
|
|
2585
|
+
home: {
|
|
2586
|
+
type: 'string',
|
|
2587
|
+
description: 'Chart home URL',
|
|
2588
|
+
example: 'https://kubernetes.github.io/ingress-nginx/'
|
|
2589
|
+
},
|
|
2590
|
+
icon: {
|
|
2591
|
+
type: 'string',
|
|
2592
|
+
description: 'A URL to an SVG or PNG image to be used as an icon',
|
|
2593
|
+
example: 'https://cloudfleet.ai/images/marketplace/icons/ingress-nginx.png'
|
|
2594
|
+
},
|
|
2595
|
+
sources: {
|
|
2596
|
+
type: 'array',
|
|
2597
|
+
items: {
|
|
2598
|
+
type: 'string'
|
|
857
2599
|
},
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
bar: example`
|
|
863
|
-
}
|
|
2600
|
+
description: 'Chart source URLs',
|
|
2601
|
+
example: [
|
|
2602
|
+
'https://github.com/kubernetes/ingress-nginx'
|
|
2603
|
+
]
|
|
864
2604
|
},
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
2605
|
+
maintainers: {
|
|
2606
|
+
type: 'array',
|
|
2607
|
+
items: {
|
|
2608
|
+
type: 'object',
|
|
2609
|
+
properties: {
|
|
2610
|
+
name: {
|
|
2611
|
+
type: 'string',
|
|
2612
|
+
description: 'Maintainer name',
|
|
2613
|
+
example: 'NGINX Team'
|
|
2614
|
+
},
|
|
2615
|
+
email: {
|
|
2616
|
+
type: 'string',
|
|
2617
|
+
description: 'Maintainer email',
|
|
2618
|
+
example: 'support@nginx.org'
|
|
2619
|
+
}
|
|
2620
|
+
},
|
|
2621
|
+
required: [
|
|
2622
|
+
'name'
|
|
2623
|
+
],
|
|
2624
|
+
additionalProperties: false
|
|
2625
|
+
},
|
|
2626
|
+
description: 'Chart maintainers'
|
|
2627
|
+
}
|
|
2628
|
+
},
|
|
2629
|
+
required: [
|
|
2630
|
+
'name',
|
|
2631
|
+
'version'
|
|
2632
|
+
],
|
|
2633
|
+
additionalProperties: false,
|
|
2634
|
+
description: 'Chart metadata'
|
|
868
2635
|
}
|
|
869
2636
|
},
|
|
870
|
-
required: [
|
|
2637
|
+
required: [
|
|
2638
|
+
'name',
|
|
2639
|
+
'versions',
|
|
2640
|
+
'version_channels',
|
|
2641
|
+
'latestVersion'
|
|
2642
|
+
],
|
|
871
2643
|
additionalProperties: false
|
|
872
2644
|
};
|
|
873
2645
|
export const OrganizationCreateInputSchema = {
|
|
874
2646
|
type: 'object',
|
|
875
2647
|
properties: {
|
|
2648
|
+
type: {
|
|
2649
|
+
type: 'string',
|
|
2650
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2651
|
+
example: 'business',
|
|
2652
|
+
enum: [
|
|
2653
|
+
'business',
|
|
2654
|
+
'personal'
|
|
2655
|
+
]
|
|
2656
|
+
},
|
|
876
2657
|
email: {
|
|
877
2658
|
type: 'string',
|
|
878
2659
|
format: 'email',
|
|
@@ -881,11 +2662,13 @@ export const OrganizationCreateInputSchema = {
|
|
|
881
2662
|
},
|
|
882
2663
|
first_name: {
|
|
883
2664
|
type: 'string',
|
|
2665
|
+
minLength: 1,
|
|
884
2666
|
description: 'First name of the billing contact person.',
|
|
885
2667
|
example: 'John'
|
|
886
2668
|
},
|
|
887
2669
|
last_name: {
|
|
888
2670
|
type: 'string',
|
|
2671
|
+
minLength: 1,
|
|
889
2672
|
description: 'Last name of the billing contact person.',
|
|
890
2673
|
example: 'Doe'
|
|
891
2674
|
},
|
|
@@ -903,7 +2686,28 @@ export const OrganizationCreateInputSchema = {
|
|
|
903
2686
|
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.'
|
|
904
2687
|
}
|
|
905
2688
|
},
|
|
906
|
-
required: [
|
|
2689
|
+
required: [
|
|
2690
|
+
'type',
|
|
2691
|
+
'email',
|
|
2692
|
+
'first_name',
|
|
2693
|
+
'last_name',
|
|
2694
|
+
'company_name',
|
|
2695
|
+
'password'
|
|
2696
|
+
],
|
|
2697
|
+
additionalProperties: false
|
|
2698
|
+
};
|
|
2699
|
+
export const OrganizationCreateOutputSchema = {
|
|
2700
|
+
type: 'object',
|
|
2701
|
+
properties: {
|
|
2702
|
+
id: {
|
|
2703
|
+
type: 'string',
|
|
2704
|
+
description: 'Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.',
|
|
2705
|
+
example: 'organization-id'
|
|
2706
|
+
}
|
|
2707
|
+
},
|
|
2708
|
+
required: [
|
|
2709
|
+
'id'
|
|
2710
|
+
],
|
|
907
2711
|
additionalProperties: false
|
|
908
2712
|
};
|
|
909
2713
|
export const OrganizationSchema = {
|
|
@@ -922,6 +2726,15 @@ export const OrganizationSchema = {
|
|
|
922
2726
|
description: 'Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.',
|
|
923
2727
|
example: 'ACME Corp.'
|
|
924
2728
|
},
|
|
2729
|
+
type: {
|
|
2730
|
+
type: 'string',
|
|
2731
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2732
|
+
example: 'business',
|
|
2733
|
+
enum: [
|
|
2734
|
+
'business',
|
|
2735
|
+
'personal'
|
|
2736
|
+
]
|
|
2737
|
+
},
|
|
925
2738
|
date_created: {
|
|
926
2739
|
type: 'string',
|
|
927
2740
|
format: 'date-time',
|
|
@@ -953,6 +2766,17 @@ export const OrganizationSchema = {
|
|
|
953
2766
|
description: 'Available number of Pro clusters that can be created.',
|
|
954
2767
|
example: 999
|
|
955
2768
|
},
|
|
2769
|
+
enterprise_clusters_max: {
|
|
2770
|
+
type: 'integer',
|
|
2771
|
+
minimum: 0,
|
|
2772
|
+
description: 'Maximum number of Enterprise clusters that can be created.',
|
|
2773
|
+
example: 999
|
|
2774
|
+
},
|
|
2775
|
+
enterprise_clusters_available: {
|
|
2776
|
+
type: 'integer',
|
|
2777
|
+
description: 'Available number of Enterprise clusters that can be created.',
|
|
2778
|
+
example: 999
|
|
2779
|
+
},
|
|
956
2780
|
fleets_max: {
|
|
957
2781
|
type: 'integer',
|
|
958
2782
|
minimum: 0,
|
|
@@ -972,7 +2796,7 @@ export const OrganizationSchema = {
|
|
|
972
2796
|
type: 'array',
|
|
973
2797
|
items: {
|
|
974
2798
|
type: 'string',
|
|
975
|
-
example: 'northamerica-central-
|
|
2799
|
+
example: 'northamerica-central-1a'
|
|
976
2800
|
},
|
|
977
2801
|
minItems: 1,
|
|
978
2802
|
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
@@ -993,24 +2817,66 @@ export const OrganizationSchema = {
|
|
|
993
2817
|
example: '1.33.x (Always latest 1.33 patch version)'
|
|
994
2818
|
}
|
|
995
2819
|
},
|
|
996
|
-
required: [
|
|
2820
|
+
required: [
|
|
2821
|
+
'id',
|
|
2822
|
+
'label'
|
|
2823
|
+
],
|
|
997
2824
|
additionalProperties: false
|
|
998
2825
|
},
|
|
999
2826
|
minItems: 1,
|
|
1000
2827
|
description: 'List of CFKE control plane versions available for the organization.'
|
|
2828
|
+
},
|
|
2829
|
+
cfcr_storage_gb: {
|
|
2830
|
+
type: 'integer',
|
|
2831
|
+
minimum: -1,
|
|
2832
|
+
description: 'Organization-level maximum CFCR storage volume in GB. -1 means no limit.',
|
|
2833
|
+
example: 500
|
|
1001
2834
|
}
|
|
1002
2835
|
},
|
|
1003
|
-
required: [
|
|
2836
|
+
required: [
|
|
2837
|
+
'basic_clusters_max',
|
|
2838
|
+
'basic_clusters_available',
|
|
2839
|
+
'pro_clusters_max',
|
|
2840
|
+
'pro_clusters_available',
|
|
2841
|
+
'enterprise_clusters_max',
|
|
2842
|
+
'enterprise_clusters_available',
|
|
2843
|
+
'fleets_max',
|
|
2844
|
+
'cluster_tiers',
|
|
2845
|
+
'regions',
|
|
2846
|
+
'versions',
|
|
2847
|
+
'cfcr_storage_gb'
|
|
2848
|
+
],
|
|
1004
2849
|
additionalProperties: false,
|
|
1005
2850
|
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.'
|
|
1006
2851
|
},
|
|
1007
2852
|
status: {
|
|
1008
2853
|
type: 'string',
|
|
1009
2854
|
description: 'Status of the organization. Can be `active` or `closed`, or `suspended`.',
|
|
1010
|
-
enum: [
|
|
2855
|
+
enum: [
|
|
2856
|
+
'active',
|
|
2857
|
+
'closed',
|
|
2858
|
+
'suspended'
|
|
2859
|
+
]
|
|
2860
|
+
},
|
|
2861
|
+
verification: {
|
|
2862
|
+
type: 'string',
|
|
2863
|
+
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.',
|
|
2864
|
+
example: 'verified',
|
|
2865
|
+
enum: [
|
|
2866
|
+
'none',
|
|
2867
|
+
'submitted',
|
|
2868
|
+
'verified'
|
|
2869
|
+
]
|
|
1011
2870
|
}
|
|
1012
2871
|
},
|
|
1013
|
-
required: [
|
|
2872
|
+
required: [
|
|
2873
|
+
'id',
|
|
2874
|
+
'type',
|
|
2875
|
+
'date_created',
|
|
2876
|
+
'quota',
|
|
2877
|
+
'status',
|
|
2878
|
+
'verification'
|
|
2879
|
+
],
|
|
1014
2880
|
additionalProperties: false
|
|
1015
2881
|
};
|
|
1016
2882
|
export const PaymentMethodSchema = {
|
|
@@ -1018,26 +2884,23 @@ export const PaymentMethodSchema = {
|
|
|
1018
2884
|
properties: {
|
|
1019
2885
|
id: {
|
|
1020
2886
|
type: 'string',
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
example: 'e94d30ec-a2dd-4dcb-832c-ac2be144ba91'
|
|
1024
|
-
},
|
|
1025
|
-
setup: {
|
|
1026
|
-
type: 'boolean',
|
|
1027
|
-
description: 'Whether organization payment method was set up and ready to use for payments.',
|
|
1028
|
-
example: true
|
|
2887
|
+
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.',
|
|
2888
|
+
example: 'pm_1MtwBwLkdIwHu7ix28a3tqPa'
|
|
1029
2889
|
},
|
|
1030
2890
|
type: {
|
|
1031
2891
|
type: 'string',
|
|
1032
|
-
|
|
1033
|
-
description: 'Payment method type type. Only `card` payments supported at the moment.',
|
|
2892
|
+
description: 'Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.',
|
|
1034
2893
|
example: 'card',
|
|
1035
|
-
enum: [
|
|
2894
|
+
enum: [
|
|
2895
|
+
'card',
|
|
2896
|
+
'sepa_debit',
|
|
2897
|
+
'bank_transfer'
|
|
2898
|
+
]
|
|
1036
2899
|
},
|
|
1037
2900
|
last4: {
|
|
1038
2901
|
type: 'string',
|
|
1039
2902
|
nullable: true,
|
|
1040
|
-
description: 'Last 4 digits of the payment card number.',
|
|
2903
|
+
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.',
|
|
1041
2904
|
example: '4242'
|
|
1042
2905
|
},
|
|
1043
2906
|
exp_month: {
|
|
@@ -1045,25 +2908,57 @@ export const PaymentMethodSchema = {
|
|
|
1045
2908
|
minimum: 1,
|
|
1046
2909
|
maximum: 12,
|
|
1047
2910
|
nullable: true,
|
|
1048
|
-
description:
|
|
1049
|
-
example:
|
|
2911
|
+
description: 'Two-digit number representing the card\'s expiration month. Null for SEPA Direct Debit and bank transfer.',
|
|
2912
|
+
example: 12
|
|
1050
2913
|
},
|
|
1051
2914
|
exp_year: {
|
|
1052
2915
|
type: 'integer',
|
|
1053
|
-
minimum: 2024,
|
|
1054
2916
|
nullable: true,
|
|
1055
|
-
description:
|
|
1056
|
-
example:
|
|
2917
|
+
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.',
|
|
2918
|
+
example: 2028
|
|
1057
2919
|
},
|
|
1058
2920
|
brand: {
|
|
1059
2921
|
type: 'string',
|
|
1060
2922
|
nullable: true,
|
|
1061
|
-
description: 'Payment card brand
|
|
1062
|
-
example: 'visa'
|
|
1063
|
-
|
|
2923
|
+
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.',
|
|
2924
|
+
example: 'visa'
|
|
2925
|
+
},
|
|
2926
|
+
iban: {
|
|
2927
|
+
type: 'string',
|
|
2928
|
+
nullable: true,
|
|
2929
|
+
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.',
|
|
2930
|
+
example: 'DE11243015658023127510'
|
|
2931
|
+
},
|
|
2932
|
+
bic: {
|
|
2933
|
+
type: 'string',
|
|
2934
|
+
nullable: true,
|
|
2935
|
+
description: 'BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
2936
|
+
example: 'SOGEDEFFXXX'
|
|
2937
|
+
},
|
|
2938
|
+
account_holder_name: {
|
|
2939
|
+
type: 'string',
|
|
2940
|
+
nullable: true,
|
|
2941
|
+
description: 'Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
2942
|
+
example: 'Cloudfleet GmbH'
|
|
2943
|
+
},
|
|
2944
|
+
is_default: {
|
|
2945
|
+
type: 'boolean',
|
|
2946
|
+
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).',
|
|
2947
|
+
example: true
|
|
1064
2948
|
}
|
|
1065
2949
|
},
|
|
1066
|
-
required: [
|
|
2950
|
+
required: [
|
|
2951
|
+
'id',
|
|
2952
|
+
'type',
|
|
2953
|
+
'last4',
|
|
2954
|
+
'exp_month',
|
|
2955
|
+
'exp_year',
|
|
2956
|
+
'brand',
|
|
2957
|
+
'iban',
|
|
2958
|
+
'bic',
|
|
2959
|
+
'account_holder_name',
|
|
2960
|
+
'is_default'
|
|
2961
|
+
],
|
|
1067
2962
|
additionalProperties: false
|
|
1068
2963
|
};
|
|
1069
2964
|
export const PlatformQuotaSchema = {
|
|
@@ -1091,6 +2986,17 @@ export const PlatformQuotaSchema = {
|
|
|
1091
2986
|
description: 'Available number of Pro clusters that can be created.',
|
|
1092
2987
|
example: 999
|
|
1093
2988
|
},
|
|
2989
|
+
enterprise_clusters_max: {
|
|
2990
|
+
type: 'integer',
|
|
2991
|
+
minimum: 0,
|
|
2992
|
+
description: 'Maximum number of Enterprise clusters that can be created.',
|
|
2993
|
+
example: 999
|
|
2994
|
+
},
|
|
2995
|
+
enterprise_clusters_available: {
|
|
2996
|
+
type: 'integer',
|
|
2997
|
+
description: 'Available number of Enterprise clusters that can be created.',
|
|
2998
|
+
example: 999
|
|
2999
|
+
},
|
|
1094
3000
|
fleets_max: {
|
|
1095
3001
|
type: 'integer',
|
|
1096
3002
|
minimum: 0,
|
|
@@ -1110,7 +3016,7 @@ export const PlatformQuotaSchema = {
|
|
|
1110
3016
|
type: 'array',
|
|
1111
3017
|
items: {
|
|
1112
3018
|
type: 'string',
|
|
1113
|
-
example: 'northamerica-central-
|
|
3019
|
+
example: 'northamerica-central-1a'
|
|
1114
3020
|
},
|
|
1115
3021
|
minItems: 1,
|
|
1116
3022
|
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
@@ -1131,14 +3037,35 @@ export const PlatformQuotaSchema = {
|
|
|
1131
3037
|
example: '1.33.x (Always latest 1.33 patch version)'
|
|
1132
3038
|
}
|
|
1133
3039
|
},
|
|
1134
|
-
required: [
|
|
3040
|
+
required: [
|
|
3041
|
+
'id',
|
|
3042
|
+
'label'
|
|
3043
|
+
],
|
|
1135
3044
|
additionalProperties: false
|
|
1136
3045
|
},
|
|
1137
3046
|
minItems: 1,
|
|
1138
3047
|
description: 'List of CFKE control plane versions available for the organization.'
|
|
3048
|
+
},
|
|
3049
|
+
cfcr_storage_gb: {
|
|
3050
|
+
type: 'integer',
|
|
3051
|
+
minimum: -1,
|
|
3052
|
+
description: 'Organization-level maximum CFCR storage volume in GB. -1 means no limit.',
|
|
3053
|
+
example: 500
|
|
1139
3054
|
}
|
|
1140
3055
|
},
|
|
1141
|
-
required: [
|
|
3056
|
+
required: [
|
|
3057
|
+
'basic_clusters_max',
|
|
3058
|
+
'basic_clusters_available',
|
|
3059
|
+
'pro_clusters_max',
|
|
3060
|
+
'pro_clusters_available',
|
|
3061
|
+
'enterprise_clusters_max',
|
|
3062
|
+
'enterprise_clusters_available',
|
|
3063
|
+
'fleets_max',
|
|
3064
|
+
'cluster_tiers',
|
|
3065
|
+
'regions',
|
|
3066
|
+
'versions',
|
|
3067
|
+
'cfcr_storage_gb'
|
|
3068
|
+
],
|
|
1142
3069
|
additionalProperties: false
|
|
1143
3070
|
};
|
|
1144
3071
|
export const RegistryRepositorySchema = {
|
|
@@ -1157,10 +3084,14 @@ export const RegistryRepositorySchema = {
|
|
|
1157
3084
|
uri: {
|
|
1158
3085
|
type: 'string',
|
|
1159
3086
|
description: 'Full URI of the repository.',
|
|
1160
|
-
example: 'ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/
|
|
3087
|
+
example: 'ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app'
|
|
1161
3088
|
}
|
|
1162
3089
|
},
|
|
1163
|
-
required: [
|
|
3090
|
+
required: [
|
|
3091
|
+
'name',
|
|
3092
|
+
'region',
|
|
3093
|
+
'uri'
|
|
3094
|
+
],
|
|
1164
3095
|
additionalProperties: false
|
|
1165
3096
|
};
|
|
1166
3097
|
export const RegistryRepositoryWithTagsSchema = {
|
|
@@ -1179,7 +3110,7 @@ export const RegistryRepositoryWithTagsSchema = {
|
|
|
1179
3110
|
uri: {
|
|
1180
3111
|
type: 'string',
|
|
1181
3112
|
description: 'Full URI of the repository.',
|
|
1182
|
-
example: 'ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/
|
|
3113
|
+
example: 'ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app'
|
|
1183
3114
|
},
|
|
1184
3115
|
tags: {
|
|
1185
3116
|
type: 'array',
|
|
@@ -1201,9 +3132,23 @@ export const RegistryRepositoryWithTagsSchema = {
|
|
|
1201
3132
|
type: 'string',
|
|
1202
3133
|
description: 'Media type of the manifest.',
|
|
1203
3134
|
example: 'application/vnd.docker.distribution.manifest.v2+json'
|
|
3135
|
+
},
|
|
3136
|
+
platforms: {
|
|
3137
|
+
type: 'array',
|
|
3138
|
+
items: {
|
|
3139
|
+
type: 'string'
|
|
3140
|
+
},
|
|
3141
|
+
description: 'Array of platform strings for multi-arch images (e.g., linux/amd64, linux/arm64).',
|
|
3142
|
+
example: [
|
|
3143
|
+
'linux/amd64',
|
|
3144
|
+
'linux/arm64'
|
|
3145
|
+
]
|
|
1204
3146
|
}
|
|
1205
3147
|
},
|
|
1206
|
-
required: [
|
|
3148
|
+
required: [
|
|
3149
|
+
'name',
|
|
3150
|
+
'size'
|
|
3151
|
+
],
|
|
1207
3152
|
additionalProperties: false
|
|
1208
3153
|
},
|
|
1209
3154
|
description: 'Array of tags in the repository.'
|
|
@@ -1215,7 +3160,13 @@ export const RegistryRepositoryWithTagsSchema = {
|
|
|
1215
3160
|
example: 987654321
|
|
1216
3161
|
}
|
|
1217
3162
|
},
|
|
1218
|
-
required: [
|
|
3163
|
+
required: [
|
|
3164
|
+
'name',
|
|
3165
|
+
'region',
|
|
3166
|
+
'uri',
|
|
3167
|
+
'tags',
|
|
3168
|
+
'totalSize'
|
|
3169
|
+
],
|
|
1219
3170
|
additionalProperties: false
|
|
1220
3171
|
};
|
|
1221
3172
|
export const RegistryTagSchema = {
|
|
@@ -1226,6 +3177,11 @@ export const RegistryTagSchema = {
|
|
|
1226
3177
|
description: 'Tag name.',
|
|
1227
3178
|
example: 'latest'
|
|
1228
3179
|
},
|
|
3180
|
+
digest: {
|
|
3181
|
+
type: 'string',
|
|
3182
|
+
description: 'Manifest digest for pulling by digest.',
|
|
3183
|
+
example: 'sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890'
|
|
3184
|
+
},
|
|
1229
3185
|
mediaType: {
|
|
1230
3186
|
type: 'string',
|
|
1231
3187
|
description: 'Media type of the manifest.',
|
|
@@ -1241,7 +3197,9 @@ export const RegistryTagSchema = {
|
|
|
1241
3197
|
example: 1234
|
|
1242
3198
|
}
|
|
1243
3199
|
},
|
|
1244
|
-
required: [
|
|
3200
|
+
required: [
|
|
3201
|
+
'size'
|
|
3202
|
+
],
|
|
1245
3203
|
additionalProperties: false,
|
|
1246
3204
|
description: 'Manifest config metadata.'
|
|
1247
3205
|
},
|
|
@@ -1250,6 +3208,11 @@ export const RegistryTagSchema = {
|
|
|
1250
3208
|
items: {
|
|
1251
3209
|
type: 'object',
|
|
1252
3210
|
properties: {
|
|
3211
|
+
digest: {
|
|
3212
|
+
type: 'string',
|
|
3213
|
+
description: 'Digest of the layer.',
|
|
3214
|
+
example: 'sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890'
|
|
3215
|
+
},
|
|
1253
3216
|
size: {
|
|
1254
3217
|
type: 'number',
|
|
1255
3218
|
format: 'float',
|
|
@@ -1257,7 +3220,9 @@ export const RegistryTagSchema = {
|
|
|
1257
3220
|
example: 5678
|
|
1258
3221
|
}
|
|
1259
3222
|
},
|
|
1260
|
-
required: [
|
|
3223
|
+
required: [
|
|
3224
|
+
'size'
|
|
3225
|
+
],
|
|
1261
3226
|
additionalProperties: false
|
|
1262
3227
|
},
|
|
1263
3228
|
description: 'Array of layer metadata.'
|
|
@@ -1284,14 +3249,54 @@ export const RegistryTagSchema = {
|
|
|
1284
3249
|
type: 'string',
|
|
1285
3250
|
description: 'Operating system of the platform.',
|
|
1286
3251
|
example: 'linux'
|
|
3252
|
+
},
|
|
3253
|
+
variant: {
|
|
3254
|
+
type: 'string',
|
|
3255
|
+
description: 'Variant of the platform (e.g., v7, v8 for ARM).',
|
|
3256
|
+
example: 'v8'
|
|
1287
3257
|
}
|
|
1288
3258
|
},
|
|
1289
|
-
required: [
|
|
3259
|
+
required: [
|
|
3260
|
+
'architecture',
|
|
3261
|
+
'os'
|
|
3262
|
+
],
|
|
1290
3263
|
additionalProperties: false,
|
|
1291
3264
|
description: 'Platform information for the manifest.'
|
|
3265
|
+
},
|
|
3266
|
+
layers: {
|
|
3267
|
+
type: 'array',
|
|
3268
|
+
items: {
|
|
3269
|
+
type: 'object',
|
|
3270
|
+
properties: {
|
|
3271
|
+
digest: {
|
|
3272
|
+
type: 'string',
|
|
3273
|
+
description: 'Digest of the layer.',
|
|
3274
|
+
example: 'sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890'
|
|
3275
|
+
},
|
|
3276
|
+
size: {
|
|
3277
|
+
type: 'number',
|
|
3278
|
+
format: 'float',
|
|
3279
|
+
description: 'Size of the layer in bytes.',
|
|
3280
|
+
example: 5678
|
|
3281
|
+
}
|
|
3282
|
+
},
|
|
3283
|
+
required: [
|
|
3284
|
+
'size'
|
|
3285
|
+
],
|
|
3286
|
+
additionalProperties: false
|
|
3287
|
+
},
|
|
3288
|
+
description: 'Layers for this platform.'
|
|
3289
|
+
},
|
|
3290
|
+
size: {
|
|
3291
|
+
type: 'number',
|
|
3292
|
+
format: 'float',
|
|
3293
|
+
description: 'Total size of this platform manifest in bytes.',
|
|
3294
|
+
example: 12345678
|
|
1292
3295
|
}
|
|
1293
3296
|
},
|
|
1294
|
-
required: [
|
|
3297
|
+
required: [
|
|
3298
|
+
'digest'
|
|
3299
|
+
],
|
|
1295
3300
|
additionalProperties: false
|
|
1296
3301
|
},
|
|
1297
3302
|
description: 'Array of manifests for multi-arch images.'
|
|
@@ -1318,7 +3323,337 @@ export const RegistryTagSchema = {
|
|
|
1318
3323
|
example: 'ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app:latest'
|
|
1319
3324
|
}
|
|
1320
3325
|
},
|
|
1321
|
-
required: [
|
|
3326
|
+
required: [
|
|
3327
|
+
'name',
|
|
3328
|
+
'digest',
|
|
3329
|
+
'size',
|
|
3330
|
+
'region',
|
|
3331
|
+
'repository',
|
|
3332
|
+
'uri'
|
|
3333
|
+
],
|
|
3334
|
+
additionalProperties: false
|
|
3335
|
+
};
|
|
3336
|
+
export const TicketAttachmentSchema = {
|
|
3337
|
+
type: 'object',
|
|
3338
|
+
properties: {
|
|
3339
|
+
id: {
|
|
3340
|
+
type: 'string',
|
|
3341
|
+
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
3342
|
+
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
3343
|
+
},
|
|
3344
|
+
filename: {
|
|
3345
|
+
type: 'string',
|
|
3346
|
+
description: 'Original filename as uploaded.',
|
|
3347
|
+
example: 'debug.log'
|
|
3348
|
+
},
|
|
3349
|
+
content_type: {
|
|
3350
|
+
type: 'string',
|
|
3351
|
+
description: 'MIME content type of the attachment.',
|
|
3352
|
+
example: 'text/plain'
|
|
3353
|
+
},
|
|
3354
|
+
size: {
|
|
3355
|
+
type: 'integer',
|
|
3356
|
+
description: 'Size of the attachment in bytes.',
|
|
3357
|
+
example: 12345
|
|
3358
|
+
}
|
|
3359
|
+
},
|
|
3360
|
+
required: [
|
|
3361
|
+
'id',
|
|
3362
|
+
'filename',
|
|
3363
|
+
'content_type',
|
|
3364
|
+
'size'
|
|
3365
|
+
],
|
|
3366
|
+
additionalProperties: false
|
|
3367
|
+
};
|
|
3368
|
+
export const TicketCreateInputSchema = {
|
|
3369
|
+
type: 'object',
|
|
3370
|
+
properties: {
|
|
3371
|
+
category: {
|
|
3372
|
+
type: 'string',
|
|
3373
|
+
description: 'Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.',
|
|
3374
|
+
example: 'technical',
|
|
3375
|
+
enum: [
|
|
3376
|
+
'billing',
|
|
3377
|
+
'technical',
|
|
3378
|
+
'general'
|
|
3379
|
+
]
|
|
3380
|
+
},
|
|
3381
|
+
body: {
|
|
3382
|
+
type: 'string',
|
|
3383
|
+
maxLength: 50000,
|
|
3384
|
+
minLength: 1,
|
|
3385
|
+
pattern: '\\S',
|
|
3386
|
+
description: 'Initial message body in markdown. There is no separate subject — the first message body is the description.',
|
|
3387
|
+
example: 'My cluster cannot reach the registry. Logs attached.'
|
|
3388
|
+
},
|
|
3389
|
+
properties: {
|
|
3390
|
+
type: 'object',
|
|
3391
|
+
additionalProperties: true,
|
|
3392
|
+
description: 'Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).',
|
|
3393
|
+
example: {
|
|
3394
|
+
subcategory: 'cluster-question',
|
|
3395
|
+
cluster_id: '60c72b2f9f1b2c001f8e4d3a'
|
|
3396
|
+
}
|
|
3397
|
+
}
|
|
3398
|
+
},
|
|
3399
|
+
required: [
|
|
3400
|
+
'category',
|
|
3401
|
+
'body'
|
|
3402
|
+
],
|
|
3403
|
+
additionalProperties: false
|
|
3404
|
+
};
|
|
3405
|
+
export const TicketMessageInputSchema = {
|
|
3406
|
+
type: 'object',
|
|
3407
|
+
properties: {
|
|
3408
|
+
body: {
|
|
3409
|
+
type: 'string',
|
|
3410
|
+
maxLength: 50000,
|
|
3411
|
+
minLength: 1,
|
|
3412
|
+
pattern: '\\S',
|
|
3413
|
+
description: 'Reply body in markdown.',
|
|
3414
|
+
example: 'Thanks — that resolved it on my side.'
|
|
3415
|
+
}
|
|
3416
|
+
},
|
|
3417
|
+
required: [
|
|
3418
|
+
'body'
|
|
3419
|
+
],
|
|
3420
|
+
additionalProperties: false
|
|
3421
|
+
};
|
|
3422
|
+
export const TicketMessageSchema = {
|
|
3423
|
+
type: 'object',
|
|
3424
|
+
properties: {
|
|
3425
|
+
id: {
|
|
3426
|
+
type: 'string',
|
|
3427
|
+
description: 'Unique identifier of the message (Mongo ObjectId).',
|
|
3428
|
+
example: '60c72b2f9f1b2c001f8e4d3b'
|
|
3429
|
+
},
|
|
3430
|
+
type: {
|
|
3431
|
+
type: 'string',
|
|
3432
|
+
description: 'Message type. Internal notes are filtered out of customer-facing responses.',
|
|
3433
|
+
example: 'customer_reply',
|
|
3434
|
+
enum: [
|
|
3435
|
+
'customer_reply',
|
|
3436
|
+
'agent_reply'
|
|
3437
|
+
]
|
|
3438
|
+
},
|
|
3439
|
+
body: {
|
|
3440
|
+
type: 'string',
|
|
3441
|
+
description: 'Message body in markdown.',
|
|
3442
|
+
example: 'Thanks — that resolved it on my side.'
|
|
3443
|
+
},
|
|
3444
|
+
author_first_name: {
|
|
3445
|
+
type: 'string',
|
|
3446
|
+
nullable: true,
|
|
3447
|
+
description: 'First name of the author. Null when not provided.',
|
|
3448
|
+
example: 'Jane'
|
|
3449
|
+
},
|
|
3450
|
+
author_last_name: {
|
|
3451
|
+
type: 'string',
|
|
3452
|
+
nullable: true,
|
|
3453
|
+
description: 'Last name of the author. Null when not provided.',
|
|
3454
|
+
example: 'Doe'
|
|
3455
|
+
},
|
|
3456
|
+
attachments: {
|
|
3457
|
+
type: 'array',
|
|
3458
|
+
items: {
|
|
3459
|
+
type: 'object',
|
|
3460
|
+
properties: {
|
|
3461
|
+
id: {
|
|
3462
|
+
type: 'string',
|
|
3463
|
+
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
3464
|
+
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
3465
|
+
},
|
|
3466
|
+
filename: {
|
|
3467
|
+
type: 'string',
|
|
3468
|
+
description: 'Original filename as uploaded.',
|
|
3469
|
+
example: 'debug.log'
|
|
3470
|
+
},
|
|
3471
|
+
content_type: {
|
|
3472
|
+
type: 'string',
|
|
3473
|
+
description: 'MIME content type of the attachment.',
|
|
3474
|
+
example: 'text/plain'
|
|
3475
|
+
},
|
|
3476
|
+
size: {
|
|
3477
|
+
type: 'integer',
|
|
3478
|
+
description: 'Size of the attachment in bytes.',
|
|
3479
|
+
example: 12345
|
|
3480
|
+
}
|
|
3481
|
+
},
|
|
3482
|
+
required: [
|
|
3483
|
+
'id',
|
|
3484
|
+
'filename',
|
|
3485
|
+
'content_type',
|
|
3486
|
+
'size'
|
|
3487
|
+
],
|
|
3488
|
+
additionalProperties: false
|
|
3489
|
+
},
|
|
3490
|
+
description: 'Attachments associated with this message.',
|
|
3491
|
+
example: []
|
|
3492
|
+
},
|
|
3493
|
+
date_created: {
|
|
3494
|
+
type: 'string',
|
|
3495
|
+
format: 'date-time',
|
|
3496
|
+
description: 'Creation date of the message. ISO 8601 UTC.',
|
|
3497
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
3498
|
+
}
|
|
3499
|
+
},
|
|
3500
|
+
required: [
|
|
3501
|
+
'id',
|
|
3502
|
+
'type',
|
|
3503
|
+
'body',
|
|
3504
|
+
'date_created'
|
|
3505
|
+
],
|
|
3506
|
+
additionalProperties: false
|
|
3507
|
+
};
|
|
3508
|
+
export const TicketSchema = {
|
|
3509
|
+
type: 'object',
|
|
3510
|
+
properties: {
|
|
3511
|
+
id: {
|
|
3512
|
+
type: 'string',
|
|
3513
|
+
description: 'Unique identifier of the ticket (Mongo ObjectId).',
|
|
3514
|
+
example: '60c72b2f9f1b2c001f8e4d3a'
|
|
3515
|
+
},
|
|
3516
|
+
status: {
|
|
3517
|
+
type: 'string',
|
|
3518
|
+
description: 'Current state of the ticket.',
|
|
3519
|
+
example: 'waiting_on_us',
|
|
3520
|
+
enum: [
|
|
3521
|
+
'waiting_on_us',
|
|
3522
|
+
'waiting_on_user',
|
|
3523
|
+
'closed'
|
|
3524
|
+
]
|
|
3525
|
+
},
|
|
3526
|
+
category: {
|
|
3527
|
+
type: 'string',
|
|
3528
|
+
description: 'Ticket category.',
|
|
3529
|
+
example: 'technical',
|
|
3530
|
+
enum: [
|
|
3531
|
+
'billing',
|
|
3532
|
+
'technical',
|
|
3533
|
+
'general'
|
|
3534
|
+
]
|
|
3535
|
+
},
|
|
3536
|
+
summary: {
|
|
3537
|
+
type: 'string',
|
|
3538
|
+
description: 'First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.',
|
|
3539
|
+
example: 'My cluster cannot reach the registry. Logs attached.'
|
|
3540
|
+
},
|
|
3541
|
+
closed_at: {
|
|
3542
|
+
type: 'string',
|
|
3543
|
+
format: 'date-time',
|
|
3544
|
+
nullable: true,
|
|
3545
|
+
description: 'Closure timestamp. Null while the ticket is open.',
|
|
3546
|
+
example: '2026-05-18T16:08:14.338Z'
|
|
3547
|
+
},
|
|
3548
|
+
date_created: {
|
|
3549
|
+
type: 'string',
|
|
3550
|
+
format: 'date-time',
|
|
3551
|
+
description: 'Creation date of the ticket. ISO 8601 UTC.',
|
|
3552
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
3553
|
+
},
|
|
3554
|
+
date_updated: {
|
|
3555
|
+
type: 'string',
|
|
3556
|
+
format: 'date-time',
|
|
3557
|
+
description: 'Last update date of the ticket. ISO 8601 UTC.',
|
|
3558
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
3559
|
+
},
|
|
3560
|
+
messages: {
|
|
3561
|
+
type: 'array',
|
|
3562
|
+
items: {
|
|
3563
|
+
type: 'object',
|
|
3564
|
+
properties: {
|
|
3565
|
+
id: {
|
|
3566
|
+
type: 'string',
|
|
3567
|
+
description: 'Unique identifier of the message (Mongo ObjectId).',
|
|
3568
|
+
example: '60c72b2f9f1b2c001f8e4d3b'
|
|
3569
|
+
},
|
|
3570
|
+
type: {
|
|
3571
|
+
type: 'string',
|
|
3572
|
+
description: 'Message type. Internal notes are filtered out of customer-facing responses.',
|
|
3573
|
+
example: 'customer_reply',
|
|
3574
|
+
enum: [
|
|
3575
|
+
'customer_reply',
|
|
3576
|
+
'agent_reply'
|
|
3577
|
+
]
|
|
3578
|
+
},
|
|
3579
|
+
body: {
|
|
3580
|
+
type: 'string',
|
|
3581
|
+
description: 'Message body in markdown.',
|
|
3582
|
+
example: 'Thanks — that resolved it on my side.'
|
|
3583
|
+
},
|
|
3584
|
+
author_first_name: {
|
|
3585
|
+
type: 'string',
|
|
3586
|
+
description: 'First name of the author. Null when not provided.',
|
|
3587
|
+
example: 'Jane'
|
|
3588
|
+
},
|
|
3589
|
+
author_last_name: {
|
|
3590
|
+
type: 'string',
|
|
3591
|
+
description: 'Last name of the author. Null when not provided.',
|
|
3592
|
+
example: 'Doe'
|
|
3593
|
+
},
|
|
3594
|
+
attachments: {
|
|
3595
|
+
type: 'array',
|
|
3596
|
+
items: {
|
|
3597
|
+
type: 'object',
|
|
3598
|
+
properties: {
|
|
3599
|
+
id: {
|
|
3600
|
+
type: 'string',
|
|
3601
|
+
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
3602
|
+
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
3603
|
+
},
|
|
3604
|
+
filename: {
|
|
3605
|
+
type: 'string',
|
|
3606
|
+
description: 'Original filename as uploaded.',
|
|
3607
|
+
example: 'debug.log'
|
|
3608
|
+
},
|
|
3609
|
+
content_type: {
|
|
3610
|
+
type: 'string',
|
|
3611
|
+
description: 'MIME content type of the attachment.',
|
|
3612
|
+
example: 'text/plain'
|
|
3613
|
+
},
|
|
3614
|
+
size: {
|
|
3615
|
+
type: 'integer',
|
|
3616
|
+
description: 'Size of the attachment in bytes.',
|
|
3617
|
+
example: 12345
|
|
3618
|
+
}
|
|
3619
|
+
},
|
|
3620
|
+
required: [
|
|
3621
|
+
'id',
|
|
3622
|
+
'filename',
|
|
3623
|
+
'content_type',
|
|
3624
|
+
'size'
|
|
3625
|
+
],
|
|
3626
|
+
additionalProperties: false
|
|
3627
|
+
},
|
|
3628
|
+
description: 'Attachments associated with this message.',
|
|
3629
|
+
example: []
|
|
3630
|
+
},
|
|
3631
|
+
date_created: {
|
|
3632
|
+
type: 'string',
|
|
3633
|
+
format: 'date-time',
|
|
3634
|
+
description: 'Creation date of the message. ISO 8601 UTC.',
|
|
3635
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
3636
|
+
}
|
|
3637
|
+
},
|
|
3638
|
+
required: [
|
|
3639
|
+
'id',
|
|
3640
|
+
'type',
|
|
3641
|
+
'body',
|
|
3642
|
+
'date_created'
|
|
3643
|
+
],
|
|
3644
|
+
additionalProperties: false
|
|
3645
|
+
},
|
|
3646
|
+
description: 'Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.'
|
|
3647
|
+
}
|
|
3648
|
+
},
|
|
3649
|
+
required: [
|
|
3650
|
+
'id',
|
|
3651
|
+
'status',
|
|
3652
|
+
'category',
|
|
3653
|
+
'summary',
|
|
3654
|
+
'date_created',
|
|
3655
|
+
'date_updated'
|
|
3656
|
+
],
|
|
1322
3657
|
additionalProperties: false
|
|
1323
3658
|
};
|
|
1324
3659
|
export const TokenCreateInputSchema = {
|
|
@@ -1336,10 +3671,16 @@ export const TokenCreateInputSchema = {
|
|
|
1336
3671
|
type: 'string',
|
|
1337
3672
|
description: 'Role assumed by the token.',
|
|
1338
3673
|
example: 'User',
|
|
1339
|
-
enum: [
|
|
3674
|
+
enum: [
|
|
3675
|
+
'Administrator',
|
|
3676
|
+
'User'
|
|
3677
|
+
]
|
|
1340
3678
|
}
|
|
1341
3679
|
},
|
|
1342
|
-
required: [
|
|
3680
|
+
required: [
|
|
3681
|
+
'name',
|
|
3682
|
+
'role'
|
|
3683
|
+
],
|
|
1343
3684
|
additionalProperties: false
|
|
1344
3685
|
};
|
|
1345
3686
|
export const TokenSchema = {
|
|
@@ -1357,7 +3698,10 @@ export const TokenSchema = {
|
|
|
1357
3698
|
type: 'string',
|
|
1358
3699
|
description: 'Role assumed by the token.',
|
|
1359
3700
|
example: 'User',
|
|
1360
|
-
enum: [
|
|
3701
|
+
enum: [
|
|
3702
|
+
'Administrator',
|
|
3703
|
+
'User'
|
|
3704
|
+
]
|
|
1361
3705
|
},
|
|
1362
3706
|
id: {
|
|
1363
3707
|
type: 'string',
|
|
@@ -1376,7 +3720,11 @@ export const TokenSchema = {
|
|
|
1376
3720
|
example: '2023-12-20T13:53:32.000Z'
|
|
1377
3721
|
}
|
|
1378
3722
|
},
|
|
1379
|
-
required: [
|
|
3723
|
+
required: [
|
|
3724
|
+
'name',
|
|
3725
|
+
'role',
|
|
3726
|
+
'date_created'
|
|
3727
|
+
],
|
|
1380
3728
|
additionalProperties: false
|
|
1381
3729
|
};
|
|
1382
3730
|
export const TokenUpdateInputSchema = {
|
|
@@ -1394,7 +3742,10 @@ export const TokenUpdateInputSchema = {
|
|
|
1394
3742
|
type: 'string',
|
|
1395
3743
|
description: 'Role assumed by the token.',
|
|
1396
3744
|
example: 'User',
|
|
1397
|
-
enum: [
|
|
3745
|
+
enum: [
|
|
3746
|
+
'Administrator',
|
|
3747
|
+
'User'
|
|
3748
|
+
]
|
|
1398
3749
|
}
|
|
1399
3750
|
},
|
|
1400
3751
|
additionalProperties: false
|
|
@@ -1408,15 +3759,29 @@ export const UsageFacetsSchema = {
|
|
|
1408
3759
|
type: 'string'
|
|
1409
3760
|
},
|
|
1410
3761
|
description: 'List of unique cluster IDs',
|
|
1411
|
-
example: [
|
|
3762
|
+
example: [
|
|
3763
|
+
'6b5439b1-923a-4f2b-a371-d554e5ea23fa'
|
|
3764
|
+
]
|
|
1412
3765
|
},
|
|
1413
3766
|
product: {
|
|
1414
3767
|
type: 'array',
|
|
1415
3768
|
items: {
|
|
1416
|
-
type: 'string'
|
|
3769
|
+
type: 'string',
|
|
3770
|
+
enum: [
|
|
3771
|
+
'cfke_controlplane_basic',
|
|
3772
|
+
'cfke_controlplane_pro',
|
|
3773
|
+
'cfke_controlplane_enterprise',
|
|
3774
|
+
'cfke_connected_nodes_basic',
|
|
3775
|
+
'cfke_connected_nodes_pro',
|
|
3776
|
+
'cfke_connected_nodes_enterprise',
|
|
3777
|
+
'cfcr_storage'
|
|
3778
|
+
]
|
|
1417
3779
|
},
|
|
1418
3780
|
description: 'List of unique products',
|
|
1419
|
-
example: [
|
|
3781
|
+
example: [
|
|
3782
|
+
'cfke_controlplane_pro',
|
|
3783
|
+
'cfke_connected_nodes_pro'
|
|
3784
|
+
]
|
|
1420
3785
|
}
|
|
1421
3786
|
},
|
|
1422
3787
|
additionalProperties: false
|
|
@@ -1442,7 +3807,16 @@ export const UsageResponseSchema = {
|
|
|
1442
3807
|
product: {
|
|
1443
3808
|
type: 'string',
|
|
1444
3809
|
description: 'The product the usage is associated with',
|
|
1445
|
-
example: '
|
|
3810
|
+
example: 'cfke_controlplane_pro',
|
|
3811
|
+
enum: [
|
|
3812
|
+
'cfke_controlplane_basic',
|
|
3813
|
+
'cfke_controlplane_pro',
|
|
3814
|
+
'cfke_controlplane_enterprise',
|
|
3815
|
+
'cfke_connected_nodes_basic',
|
|
3816
|
+
'cfke_connected_nodes_pro',
|
|
3817
|
+
'cfke_connected_nodes_enterprise',
|
|
3818
|
+
'cfcr_storage'
|
|
3819
|
+
]
|
|
1446
3820
|
},
|
|
1447
3821
|
value: {
|
|
1448
3822
|
type: 'number',
|
|
@@ -1462,7 +3836,14 @@ export const UsageResponseSchema = {
|
|
|
1462
3836
|
description: 'Total cost'
|
|
1463
3837
|
}
|
|
1464
3838
|
},
|
|
1465
|
-
required: [
|
|
3839
|
+
required: [
|
|
3840
|
+
'hour',
|
|
3841
|
+
'cluster_id',
|
|
3842
|
+
'product',
|
|
3843
|
+
'value',
|
|
3844
|
+
'price',
|
|
3845
|
+
'total'
|
|
3846
|
+
],
|
|
1466
3847
|
additionalProperties: false
|
|
1467
3848
|
},
|
|
1468
3849
|
description: 'Usage data'
|
|
@@ -1476,22 +3857,39 @@ export const UsageResponseSchema = {
|
|
|
1476
3857
|
type: 'string'
|
|
1477
3858
|
},
|
|
1478
3859
|
description: 'List of unique cluster IDs',
|
|
1479
|
-
example: [
|
|
3860
|
+
example: [
|
|
3861
|
+
'6b5439b1-923a-4f2b-a371-d554e5ea23fa'
|
|
3862
|
+
]
|
|
1480
3863
|
},
|
|
1481
3864
|
product: {
|
|
1482
3865
|
type: 'array',
|
|
1483
3866
|
items: {
|
|
1484
|
-
type: 'string'
|
|
3867
|
+
type: 'string',
|
|
3868
|
+
enum: [
|
|
3869
|
+
'cfke_controlplane_basic',
|
|
3870
|
+
'cfke_controlplane_pro',
|
|
3871
|
+
'cfke_controlplane_enterprise',
|
|
3872
|
+
'cfke_connected_nodes_basic',
|
|
3873
|
+
'cfke_connected_nodes_pro',
|
|
3874
|
+
'cfke_connected_nodes_enterprise',
|
|
3875
|
+
'cfcr_storage'
|
|
3876
|
+
]
|
|
1485
3877
|
},
|
|
1486
3878
|
description: 'List of unique products',
|
|
1487
|
-
example: [
|
|
3879
|
+
example: [
|
|
3880
|
+
'cfke_controlplane_pro',
|
|
3881
|
+
'cfke_connected_nodes_pro'
|
|
3882
|
+
]
|
|
1488
3883
|
}
|
|
1489
3884
|
},
|
|
1490
3885
|
additionalProperties: false,
|
|
1491
3886
|
description: 'Facets for filtering'
|
|
1492
3887
|
}
|
|
1493
3888
|
},
|
|
1494
|
-
required: [
|
|
3889
|
+
required: [
|
|
3890
|
+
'data',
|
|
3891
|
+
'facets'
|
|
3892
|
+
],
|
|
1495
3893
|
additionalProperties: false
|
|
1496
3894
|
};
|
|
1497
3895
|
export const UsageSchema = {
|
|
@@ -1510,7 +3908,16 @@ export const UsageSchema = {
|
|
|
1510
3908
|
product: {
|
|
1511
3909
|
type: 'string',
|
|
1512
3910
|
description: 'The product the usage is associated with',
|
|
1513
|
-
example: '
|
|
3911
|
+
example: 'cfke_controlplane_pro',
|
|
3912
|
+
enum: [
|
|
3913
|
+
'cfke_controlplane_basic',
|
|
3914
|
+
'cfke_controlplane_pro',
|
|
3915
|
+
'cfke_controlplane_enterprise',
|
|
3916
|
+
'cfke_connected_nodes_basic',
|
|
3917
|
+
'cfke_connected_nodes_pro',
|
|
3918
|
+
'cfke_connected_nodes_enterprise',
|
|
3919
|
+
'cfcr_storage'
|
|
3920
|
+
]
|
|
1514
3921
|
},
|
|
1515
3922
|
value: {
|
|
1516
3923
|
type: 'number',
|
|
@@ -1530,7 +3937,14 @@ export const UsageSchema = {
|
|
|
1530
3937
|
description: 'Total cost'
|
|
1531
3938
|
}
|
|
1532
3939
|
},
|
|
1533
|
-
required: [
|
|
3940
|
+
required: [
|
|
3941
|
+
'hour',
|
|
3942
|
+
'cluster_id',
|
|
3943
|
+
'product',
|
|
3944
|
+
'value',
|
|
3945
|
+
'price',
|
|
3946
|
+
'total'
|
|
3947
|
+
],
|
|
1534
3948
|
additionalProperties: false
|
|
1535
3949
|
};
|
|
1536
3950
|
export const UserCreateInputSchema = {
|
|
@@ -1566,21 +3980,15 @@ export const UserCreateInputSchema = {
|
|
|
1566
3980
|
type: 'string',
|
|
1567
3981
|
minLength: 8,
|
|
1568
3982
|
description: 'User password. Must be at least 8 characters long.'
|
|
1569
|
-
},
|
|
1570
|
-
status: {
|
|
1571
|
-
type: 'string',
|
|
1572
|
-
description: 'Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.',
|
|
1573
|
-
example: 'active',
|
|
1574
|
-
enum: ['active', 'inactive']
|
|
1575
|
-
},
|
|
1576
|
-
role: {
|
|
1577
|
-
type: 'string',
|
|
1578
|
-
description: "User role. Can be 'Administrator', 'User'.",
|
|
1579
|
-
example: 'User',
|
|
1580
|
-
enum: ['Administrator', 'User']
|
|
1581
3983
|
}
|
|
1582
3984
|
},
|
|
1583
|
-
required: [
|
|
3985
|
+
required: [
|
|
3986
|
+
'email',
|
|
3987
|
+
'first_name',
|
|
3988
|
+
'last_name',
|
|
3989
|
+
'code',
|
|
3990
|
+
'password'
|
|
3991
|
+
],
|
|
1584
3992
|
additionalProperties: false
|
|
1585
3993
|
};
|
|
1586
3994
|
export const UserSchema = {
|
|
@@ -1608,15 +4016,21 @@ export const UserSchema = {
|
|
|
1608
4016
|
},
|
|
1609
4017
|
role: {
|
|
1610
4018
|
type: 'string',
|
|
1611
|
-
description:
|
|
4019
|
+
description: 'User role. Can be \'Administrator\', \'User\'.',
|
|
1612
4020
|
example: 'User',
|
|
1613
|
-
enum: [
|
|
4021
|
+
enum: [
|
|
4022
|
+
'Administrator',
|
|
4023
|
+
'User'
|
|
4024
|
+
]
|
|
1614
4025
|
},
|
|
1615
4026
|
status: {
|
|
1616
4027
|
type: 'string',
|
|
1617
4028
|
description: 'Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.',
|
|
1618
4029
|
example: 'active',
|
|
1619
|
-
enum: [
|
|
4030
|
+
enum: [
|
|
4031
|
+
'active',
|
|
4032
|
+
'inactive'
|
|
4033
|
+
]
|
|
1620
4034
|
},
|
|
1621
4035
|
id: {
|
|
1622
4036
|
type: 'string',
|
|
@@ -1631,7 +4045,15 @@ export const UserSchema = {
|
|
|
1631
4045
|
example: '2023-11-02T16:08:14.338Z'
|
|
1632
4046
|
}
|
|
1633
4047
|
},
|
|
1634
|
-
required: [
|
|
4048
|
+
required: [
|
|
4049
|
+
'email',
|
|
4050
|
+
'first_name',
|
|
4051
|
+
'last_name',
|
|
4052
|
+
'role',
|
|
4053
|
+
'status',
|
|
4054
|
+
'id',
|
|
4055
|
+
'date_created'
|
|
4056
|
+
],
|
|
1635
4057
|
additionalProperties: false
|
|
1636
4058
|
};
|
|
1637
4059
|
export const UserUpdateInputSchema = {
|
|
@@ -1659,15 +4081,21 @@ export const UserUpdateInputSchema = {
|
|
|
1659
4081
|
},
|
|
1660
4082
|
role: {
|
|
1661
4083
|
type: 'string',
|
|
1662
|
-
description:
|
|
4084
|
+
description: 'User role. Can be \'Administrator\', \'User\'.',
|
|
1663
4085
|
example: 'User',
|
|
1664
|
-
enum: [
|
|
4086
|
+
enum: [
|
|
4087
|
+
'Administrator',
|
|
4088
|
+
'User'
|
|
4089
|
+
]
|
|
1665
4090
|
},
|
|
1666
4091
|
status: {
|
|
1667
4092
|
type: 'string',
|
|
1668
4093
|
description: 'Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.',
|
|
1669
4094
|
example: 'active',
|
|
1670
|
-
enum: [
|
|
4095
|
+
enum: [
|
|
4096
|
+
'active',
|
|
4097
|
+
'inactive'
|
|
4098
|
+
]
|
|
1671
4099
|
}
|
|
1672
4100
|
},
|
|
1673
4101
|
additionalProperties: false
|