@cloudfleet/sdk 0.0.1-cfddf24 → 0.0.1-d06768f
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 +56 -2
- package/dist/@tanstack/react-query.gen.d.ts +432 -614
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -1
- package/dist/@tanstack/react-query.gen.js +431 -404
- package/dist/@tanstack/react-query.gen.js.map +1 -1
- package/dist/client/client.gen.d.ts.map +1 -1
- package/dist/client/client.gen.js +1 -4
- package/dist/client/client.gen.js.map +1 -1
- package/dist/client/types.gen.d.ts +1 -1
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.d.ts +2 -2
- package/dist/client/utils.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.js +3 -3
- package/dist/client/utils.gen.js.map +1 -1
- package/dist/core/params.gen.js +4 -4
- package/dist/core/params.gen.js.map +1 -1
- package/dist/errors.d.ts +42 -0
- package/dist/errors.d.ts.map +1 -0
- package/dist/errors.js +83 -0
- package/dist/errors.js.map +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +4 -0
- package/dist/index.js.map +1 -1
- package/dist/schemas.gen.d.ts +778 -487
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +1050 -630
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +226 -221
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +340 -324
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +18 -55
- package/dist/services/kubernetes/api.d.ts.map +1 -1
- package/dist/services/kubernetes/api.js +36 -75
- package/dist/services/kubernetes/api.js.map +1 -1
- package/dist/services/kubernetes/index.d.ts.map +1 -1
- package/dist/services/kubernetes/index.js +36 -37
- package/dist/services/kubernetes/index.js.map +1 -1
- package/dist/types.gen.d.ts +1253 -989
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +1886 -1537
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +586 -393
- package/dist/zod.gen.js.map +1 -1
- package/package.json +10 -15
package/dist/schemas.gen.js
CHANGED
|
@@ -2,6 +2,15 @@
|
|
|
2
2
|
export const BillingContactSchema = {
|
|
3
3
|
type: 'object',
|
|
4
4
|
properties: {
|
|
5
|
+
type: {
|
|
6
|
+
type: 'string',
|
|
7
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
8
|
+
example: 'business',
|
|
9
|
+
enum: [
|
|
10
|
+
'business',
|
|
11
|
+
'personal'
|
|
12
|
+
]
|
|
13
|
+
},
|
|
5
14
|
company: {
|
|
6
15
|
type: 'string',
|
|
7
16
|
maxLength: 120,
|
|
@@ -84,12 +93,17 @@ export const BillingContactSchema = {
|
|
|
84
93
|
'at_vat',
|
|
85
94
|
'au_abn',
|
|
86
95
|
'au_arn',
|
|
96
|
+
'aw_tin',
|
|
97
|
+
'az_tin',
|
|
87
98
|
'ba_tin',
|
|
88
99
|
'bb_tin',
|
|
100
|
+
'bd_bin',
|
|
89
101
|
'be_vat',
|
|
102
|
+
'bf_ifu',
|
|
90
103
|
'bg_uic',
|
|
91
104
|
'bg_vat',
|
|
92
105
|
'bh_vat',
|
|
106
|
+
'bj_ifu',
|
|
93
107
|
'bo_tin',
|
|
94
108
|
'br_cnpj',
|
|
95
109
|
'br_cpf',
|
|
@@ -105,9 +119,11 @@ export const BillingContactSchema = {
|
|
|
105
119
|
'ch_uid',
|
|
106
120
|
'ch_vat',
|
|
107
121
|
'cl_tin',
|
|
122
|
+
'cm_niu',
|
|
108
123
|
'cn_tin',
|
|
109
124
|
'co_nit',
|
|
110
125
|
'cr_tin',
|
|
126
|
+
'cv_nif',
|
|
111
127
|
'cy_vat',
|
|
112
128
|
'cz_vat',
|
|
113
129
|
'de_stn',
|
|
@@ -119,6 +135,7 @@ export const BillingContactSchema = {
|
|
|
119
135
|
'eg_tin',
|
|
120
136
|
'es_cif',
|
|
121
137
|
'es_vat',
|
|
138
|
+
'et_tin',
|
|
122
139
|
'eu_oss_vat',
|
|
123
140
|
'fi_vat',
|
|
124
141
|
'fr_vat',
|
|
@@ -141,11 +158,14 @@ export const BillingContactSchema = {
|
|
|
141
158
|
'jp_rn',
|
|
142
159
|
'jp_trn',
|
|
143
160
|
'ke_pin',
|
|
161
|
+
'kg_tin',
|
|
144
162
|
'kh_tin',
|
|
145
163
|
'kr_brn',
|
|
146
164
|
'kz_bin',
|
|
165
|
+
'la_tin',
|
|
147
166
|
'li_uid',
|
|
148
167
|
'li_vat',
|
|
168
|
+
'lk_vat',
|
|
149
169
|
'lt_vat',
|
|
150
170
|
'lu_vat',
|
|
151
171
|
'lv_vat',
|
|
@@ -207,6 +227,7 @@ export const BillingContactSchema = {
|
|
|
207
227
|
}
|
|
208
228
|
},
|
|
209
229
|
required: [
|
|
230
|
+
'type',
|
|
210
231
|
'email',
|
|
211
232
|
'individual_name'
|
|
212
233
|
],
|
|
@@ -272,166 +293,6 @@ export const BillingCreditsSchema = {
|
|
|
272
293
|
],
|
|
273
294
|
additionalProperties: false
|
|
274
295
|
};
|
|
275
|
-
export const ChartCreateInputSchema = {
|
|
276
|
-
type: 'object',
|
|
277
|
-
properties: {
|
|
278
|
-
values: {
|
|
279
|
-
type: 'string',
|
|
280
|
-
description: 'Values to be used in the chart encoded as a JSON string.'
|
|
281
|
-
},
|
|
282
|
-
version_channel: {
|
|
283
|
-
type: 'string',
|
|
284
|
-
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-]+)*))?$',
|
|
285
|
-
description: 'Desired version range or channel for the chart.',
|
|
286
|
-
example: '2.x.x-cfke.x'
|
|
287
|
-
},
|
|
288
|
-
name: {
|
|
289
|
-
type: 'string',
|
|
290
|
-
maxLength: 63,
|
|
291
|
-
minLength: 1,
|
|
292
|
-
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
293
|
-
description: 'Unique identifier of the chart deployment aka name of the helm release.',
|
|
294
|
-
example: 'postgresql-0'
|
|
295
|
-
},
|
|
296
|
-
namespace: {
|
|
297
|
-
type: 'string',
|
|
298
|
-
maxLength: 63,
|
|
299
|
-
minLength: 1,
|
|
300
|
-
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
301
|
-
description: 'Namespace of the chart deployment',
|
|
302
|
-
example: 'default'
|
|
303
|
-
},
|
|
304
|
-
chart: {
|
|
305
|
-
type: 'string',
|
|
306
|
-
maxLength: 63,
|
|
307
|
-
minLength: 1,
|
|
308
|
-
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
309
|
-
description: 'Name of the chart listing',
|
|
310
|
-
example: 'postgresql'
|
|
311
|
-
}
|
|
312
|
-
},
|
|
313
|
-
required: [
|
|
314
|
-
'values',
|
|
315
|
-
'version_channel',
|
|
316
|
-
'name',
|
|
317
|
-
'namespace',
|
|
318
|
-
'chart'
|
|
319
|
-
],
|
|
320
|
-
additionalProperties: false
|
|
321
|
-
};
|
|
322
|
-
export const ChartSchema = {
|
|
323
|
-
type: 'object',
|
|
324
|
-
properties: {
|
|
325
|
-
values: {
|
|
326
|
-
type: 'string',
|
|
327
|
-
description: 'Values to be used in the chart encoded as a JSON string.'
|
|
328
|
-
},
|
|
329
|
-
version_channel: {
|
|
330
|
-
type: 'string',
|
|
331
|
-
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-]+)*))?$',
|
|
332
|
-
description: 'Desired version range or channel for the chart.',
|
|
333
|
-
example: '2.x.x-cfke.x'
|
|
334
|
-
},
|
|
335
|
-
name: {
|
|
336
|
-
type: 'string',
|
|
337
|
-
maxLength: 63,
|
|
338
|
-
minLength: 1,
|
|
339
|
-
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
340
|
-
description: 'Unique identifier of the chart deployment aka name of the helm release.',
|
|
341
|
-
example: 'postgresql-0'
|
|
342
|
-
},
|
|
343
|
-
namespace: {
|
|
344
|
-
type: 'string',
|
|
345
|
-
maxLength: 63,
|
|
346
|
-
minLength: 1,
|
|
347
|
-
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
348
|
-
description: 'Namespace of the chart deployment',
|
|
349
|
-
example: 'default'
|
|
350
|
-
},
|
|
351
|
-
chart: {
|
|
352
|
-
type: 'string',
|
|
353
|
-
maxLength: 63,
|
|
354
|
-
minLength: 1,
|
|
355
|
-
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
356
|
-
description: 'Name of the chart listing',
|
|
357
|
-
example: 'postgresql'
|
|
358
|
-
},
|
|
359
|
-
status: {
|
|
360
|
-
type: 'string',
|
|
361
|
-
description: 'Status of the chart deployment.',
|
|
362
|
-
example: 'active',
|
|
363
|
-
enum: [
|
|
364
|
-
'InstallSucceeded',
|
|
365
|
-
'InstallFailed',
|
|
366
|
-
'UpgradeSucceeded',
|
|
367
|
-
'UpgradeFailed',
|
|
368
|
-
'TestSucceeded',
|
|
369
|
-
'TestFailed',
|
|
370
|
-
'RollbackSucceeded',
|
|
371
|
-
'RollbackFailed',
|
|
372
|
-
'UninstallSucceeded',
|
|
373
|
-
'UninstallFailed',
|
|
374
|
-
'ArtifactFailed',
|
|
375
|
-
'DependencyNotReady',
|
|
376
|
-
'Progressing',
|
|
377
|
-
'SourceNotReady'
|
|
378
|
-
]
|
|
379
|
-
},
|
|
380
|
-
version_current: {
|
|
381
|
-
type: 'string',
|
|
382
|
-
description: 'Current version of the chart deployment.',
|
|
383
|
-
example: '2.1.33-cfke.11'
|
|
384
|
-
},
|
|
385
|
-
created_at: {
|
|
386
|
-
type: 'string',
|
|
387
|
-
description: 'Creation date and time of the chart deployment.',
|
|
388
|
-
example: '2024-09-12T09:11:27Z'
|
|
389
|
-
},
|
|
390
|
-
updated_at: {
|
|
391
|
-
type: 'string',
|
|
392
|
-
description: 'Last update date and time of the chart deployment.',
|
|
393
|
-
example: '2024-09-12T09:11:27Z'
|
|
394
|
-
},
|
|
395
|
-
ready: {
|
|
396
|
-
type: 'boolean',
|
|
397
|
-
description: 'Indicates if the chart deployment is ready to be used.',
|
|
398
|
-
example: true
|
|
399
|
-
}
|
|
400
|
-
},
|
|
401
|
-
required: [
|
|
402
|
-
'values',
|
|
403
|
-
'version_channel',
|
|
404
|
-
'name',
|
|
405
|
-
'namespace',
|
|
406
|
-
'chart',
|
|
407
|
-
'status',
|
|
408
|
-
'version_current',
|
|
409
|
-
'created_at',
|
|
410
|
-
'updated_at',
|
|
411
|
-
'ready'
|
|
412
|
-
],
|
|
413
|
-
additionalProperties: false
|
|
414
|
-
};
|
|
415
|
-
export const ChartUpdateInputSchema = {
|
|
416
|
-
type: 'object',
|
|
417
|
-
properties: {
|
|
418
|
-
values: {
|
|
419
|
-
type: 'string',
|
|
420
|
-
description: 'Values to be used in the chart encoded as a JSON string.'
|
|
421
|
-
},
|
|
422
|
-
version_channel: {
|
|
423
|
-
type: 'string',
|
|
424
|
-
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-]+)*))?$',
|
|
425
|
-
description: 'Desired version range or channel for the chart.',
|
|
426
|
-
example: '2.x.x-cfke.x'
|
|
427
|
-
}
|
|
428
|
-
},
|
|
429
|
-
required: [
|
|
430
|
-
'values',
|
|
431
|
-
'version_channel'
|
|
432
|
-
],
|
|
433
|
-
additionalProperties: false
|
|
434
|
-
};
|
|
435
296
|
export const ClusterCreateInputSchema = {
|
|
436
297
|
type: 'object',
|
|
437
298
|
properties: {
|
|
@@ -446,22 +307,12 @@ export const ClusterCreateInputSchema = {
|
|
|
446
307
|
tier: {
|
|
447
308
|
type: 'string',
|
|
448
309
|
description: 'Tier of the cluster.',
|
|
310
|
+
default: 'basic',
|
|
449
311
|
example: 'pro',
|
|
450
312
|
enum: [
|
|
451
313
|
'basic',
|
|
452
|
-
'pro'
|
|
453
|
-
|
|
454
|
-
},
|
|
455
|
-
region: {
|
|
456
|
-
type: 'string',
|
|
457
|
-
description: 'Cloudfleet control plane region. One of "staging-1a", "northamerica-central-1", "europe-central-1a", "northamerica-central-1a". This field can not be updated after creation.',
|
|
458
|
-
default: 'staging-1a',
|
|
459
|
-
example: 'northamerica-central-1a',
|
|
460
|
-
enum: [
|
|
461
|
-
'staging-1a',
|
|
462
|
-
'northamerica-central-1',
|
|
463
|
-
'europe-central-1a',
|
|
464
|
-
'northamerica-central-1a'
|
|
314
|
+
'pro',
|
|
315
|
+
'enterprise'
|
|
465
316
|
]
|
|
466
317
|
},
|
|
467
318
|
version_channel: {
|
|
@@ -469,20 +320,105 @@ export const ClusterCreateInputSchema = {
|
|
|
469
320
|
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-]+)*))?$',
|
|
470
321
|
description: 'Version of the kubernetes cluster.',
|
|
471
322
|
default: '1.x.x-cfke.x',
|
|
472
|
-
example: '1.x.x-cfke.x'
|
|
323
|
+
example: '1.x.x-cfke.x'
|
|
324
|
+
},
|
|
325
|
+
release_channel: {
|
|
326
|
+
type: 'string',
|
|
327
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
328
|
+
default: 'rapid',
|
|
329
|
+
example: 'rapid',
|
|
473
330
|
enum: [
|
|
474
|
-
'
|
|
475
|
-
'
|
|
476
|
-
'
|
|
477
|
-
'1.33.x-cfke.x'
|
|
331
|
+
'rapid',
|
|
332
|
+
'stable',
|
|
333
|
+
'extended'
|
|
478
334
|
]
|
|
335
|
+
},
|
|
336
|
+
features: {
|
|
337
|
+
type: 'object',
|
|
338
|
+
properties: {
|
|
339
|
+
gpu_sharing_strategy: {
|
|
340
|
+
type: 'string',
|
|
341
|
+
description: 'GPU sharing strategy.',
|
|
342
|
+
default: 'none',
|
|
343
|
+
example: 'none',
|
|
344
|
+
enum: [
|
|
345
|
+
'none',
|
|
346
|
+
'mps',
|
|
347
|
+
'time_slicing'
|
|
348
|
+
]
|
|
349
|
+
},
|
|
350
|
+
gpu_max_shared_clients_per_gpu: {
|
|
351
|
+
type: 'integer',
|
|
352
|
+
minimum: 2,
|
|
353
|
+
maximum: 48,
|
|
354
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
355
|
+
default: 4,
|
|
356
|
+
example: 10
|
|
357
|
+
},
|
|
358
|
+
cilium_socket_lb_host_namespace_only: {
|
|
359
|
+
type: 'boolean',
|
|
360
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
361
|
+
example: false
|
|
362
|
+
}
|
|
363
|
+
},
|
|
364
|
+
additionalProperties: false,
|
|
365
|
+
description: 'Cluster feature toggles.',
|
|
366
|
+
default: {
|
|
367
|
+
gpu_sharing_strategy: 'none',
|
|
368
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
369
|
+
cilium_socket_lb_host_namespace_only: false
|
|
370
|
+
}
|
|
371
|
+
},
|
|
372
|
+
region: {
|
|
373
|
+
type: 'string',
|
|
374
|
+
description: 'Cloudfleet control plane region. This field can not be updated after creation.',
|
|
375
|
+
example: 'europe-central-1a'
|
|
376
|
+
},
|
|
377
|
+
networking: {
|
|
378
|
+
type: 'object',
|
|
379
|
+
properties: {
|
|
380
|
+
pod_cidr: {
|
|
381
|
+
type: 'string',
|
|
382
|
+
description: 'CIDR block for pod IPs.',
|
|
383
|
+
default: '10.244.0.0/16'
|
|
384
|
+
},
|
|
385
|
+
service_cidr: {
|
|
386
|
+
type: 'string',
|
|
387
|
+
description: 'CIDR block for service IPs.',
|
|
388
|
+
default: '10.96.0.0/12'
|
|
389
|
+
},
|
|
390
|
+
dual_stack: {
|
|
391
|
+
type: 'boolean',
|
|
392
|
+
description: 'Enable IPv4+IPv6 dual-stack networking.'
|
|
393
|
+
},
|
|
394
|
+
pod_cidr_v6: {
|
|
395
|
+
type: 'string',
|
|
396
|
+
description: 'IPv6 pod CIDR. Requires dual_stack.',
|
|
397
|
+
default: '2001:db8:1:2::/48'
|
|
398
|
+
},
|
|
399
|
+
service_cidr_v6: {
|
|
400
|
+
type: 'string',
|
|
401
|
+
description: 'IPv6 service CIDR. Requires dual_stack.',
|
|
402
|
+
default: '2001:db8:1:1::/112'
|
|
403
|
+
}
|
|
404
|
+
},
|
|
405
|
+
additionalProperties: false,
|
|
406
|
+
description: 'Cluster networking configuration. Immutable after creation.',
|
|
407
|
+
default: {
|
|
408
|
+
pod_cidr: '10.244.0.0/16',
|
|
409
|
+
service_cidr: '10.96.0.0/12',
|
|
410
|
+
dual_stack: false,
|
|
411
|
+
pod_cidr_v6: '2001:db8:1:2::/48',
|
|
412
|
+
service_cidr_v6: '2001:db8:1:1::/112'
|
|
413
|
+
}
|
|
479
414
|
}
|
|
480
415
|
},
|
|
481
416
|
required: [
|
|
482
417
|
'name',
|
|
483
|
-
'
|
|
418
|
+
'region'
|
|
484
419
|
],
|
|
485
|
-
additionalProperties: false
|
|
420
|
+
additionalProperties: false,
|
|
421
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
486
422
|
};
|
|
487
423
|
export const ClusterJoinInformationSchema = {
|
|
488
424
|
type: 'object',
|
|
@@ -503,11 +439,21 @@ export const ClusterJoinInformationSchema = {
|
|
|
503
439
|
description: 'Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.',
|
|
504
440
|
example: '10.96.0.10'
|
|
505
441
|
},
|
|
442
|
+
pod_cidr: {
|
|
443
|
+
type: 'string',
|
|
444
|
+
description: 'Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.',
|
|
445
|
+
example: '10.244.0.0/16'
|
|
446
|
+
},
|
|
506
447
|
auth_key: {
|
|
507
448
|
type: 'string',
|
|
508
449
|
description: 'Authentication key for the cluster.',
|
|
509
450
|
example: 'tskey-auth-kBV8wr1dk911CNTRL-...'
|
|
510
451
|
},
|
|
452
|
+
login_server: {
|
|
453
|
+
type: 'string',
|
|
454
|
+
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.',
|
|
455
|
+
example: 'https://415026b6-f00f-44f8-968d-fc6ef4d0fc6d.fabric.europe-central-1a.cfke.io'
|
|
456
|
+
},
|
|
511
457
|
bootstrap_token: {
|
|
512
458
|
type: 'string',
|
|
513
459
|
description: 'Bootstrap token for the cluster.',
|
|
@@ -578,7 +524,9 @@ export const ClusterJoinInformationSchema = {
|
|
|
578
524
|
'certificate_authority',
|
|
579
525
|
'endpoint',
|
|
580
526
|
'cluster_dns',
|
|
527
|
+
'pod_cidr',
|
|
581
528
|
'auth_key',
|
|
529
|
+
'login_server',
|
|
582
530
|
'bootstrap_token',
|
|
583
531
|
'versions',
|
|
584
532
|
'third_party_api_access_config'
|
|
@@ -599,24 +547,123 @@ export const ClusterSchema = {
|
|
|
599
547
|
tier: {
|
|
600
548
|
type: 'string',
|
|
601
549
|
description: 'Tier of the cluster.',
|
|
550
|
+
default: 'basic',
|
|
602
551
|
example: 'pro',
|
|
603
552
|
enum: [
|
|
604
553
|
'basic',
|
|
605
|
-
'pro'
|
|
554
|
+
'pro',
|
|
555
|
+
'enterprise'
|
|
606
556
|
]
|
|
607
557
|
},
|
|
608
|
-
|
|
558
|
+
version_channel: {
|
|
609
559
|
type: 'string',
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
560
|
+
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-]+)*))?$',
|
|
561
|
+
description: 'Version of the kubernetes cluster.',
|
|
562
|
+
default: '1.x.x-cfke.x',
|
|
563
|
+
example: '1.x.x-cfke.x'
|
|
564
|
+
},
|
|
565
|
+
release_channel: {
|
|
566
|
+
type: 'string',
|
|
567
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
568
|
+
default: 'rapid',
|
|
569
|
+
example: 'rapid',
|
|
613
570
|
enum: [
|
|
614
|
-
'
|
|
615
|
-
'
|
|
616
|
-
'
|
|
617
|
-
'northamerica-central-1a'
|
|
571
|
+
'rapid',
|
|
572
|
+
'stable',
|
|
573
|
+
'extended'
|
|
618
574
|
]
|
|
619
575
|
},
|
|
576
|
+
features: {
|
|
577
|
+
type: 'object',
|
|
578
|
+
properties: {
|
|
579
|
+
gpu_sharing_strategy: {
|
|
580
|
+
type: 'string',
|
|
581
|
+
description: 'GPU sharing strategy.',
|
|
582
|
+
default: 'none',
|
|
583
|
+
example: 'none',
|
|
584
|
+
enum: [
|
|
585
|
+
'none',
|
|
586
|
+
'mps',
|
|
587
|
+
'time_slicing'
|
|
588
|
+
]
|
|
589
|
+
},
|
|
590
|
+
gpu_max_shared_clients_per_gpu: {
|
|
591
|
+
type: 'integer',
|
|
592
|
+
minimum: 2,
|
|
593
|
+
maximum: 48,
|
|
594
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
595
|
+
default: 4,
|
|
596
|
+
example: 10
|
|
597
|
+
},
|
|
598
|
+
cilium_socket_lb_host_namespace_only: {
|
|
599
|
+
type: 'boolean',
|
|
600
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
601
|
+
example: false
|
|
602
|
+
}
|
|
603
|
+
},
|
|
604
|
+
required: [
|
|
605
|
+
'gpu_sharing_strategy',
|
|
606
|
+
'gpu_max_shared_clients_per_gpu',
|
|
607
|
+
'cilium_socket_lb_host_namespace_only'
|
|
608
|
+
],
|
|
609
|
+
additionalProperties: false,
|
|
610
|
+
description: 'Cluster feature toggles.',
|
|
611
|
+
default: {
|
|
612
|
+
gpu_sharing_strategy: 'none',
|
|
613
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
614
|
+
cilium_socket_lb_host_namespace_only: false
|
|
615
|
+
}
|
|
616
|
+
},
|
|
617
|
+
region: {
|
|
618
|
+
type: 'string',
|
|
619
|
+
description: 'Cloudfleet control plane region. This field can not be updated after creation.',
|
|
620
|
+
example: 'europe-central-1a'
|
|
621
|
+
},
|
|
622
|
+
networking: {
|
|
623
|
+
type: 'object',
|
|
624
|
+
properties: {
|
|
625
|
+
pod_cidr: {
|
|
626
|
+
type: 'string',
|
|
627
|
+
description: 'CIDR block for pod IPs.',
|
|
628
|
+
default: '10.244.0.0/16'
|
|
629
|
+
},
|
|
630
|
+
service_cidr: {
|
|
631
|
+
type: 'string',
|
|
632
|
+
description: 'CIDR block for service IPs.',
|
|
633
|
+
default: '10.96.0.0/12'
|
|
634
|
+
},
|
|
635
|
+
dual_stack: {
|
|
636
|
+
type: 'boolean',
|
|
637
|
+
description: 'Enable IPv4+IPv6 dual-stack networking.'
|
|
638
|
+
},
|
|
639
|
+
pod_cidr_v6: {
|
|
640
|
+
type: 'string',
|
|
641
|
+
description: 'IPv6 pod CIDR. Requires dual_stack.',
|
|
642
|
+
default: '2001:db8:1:2::/48'
|
|
643
|
+
},
|
|
644
|
+
service_cidr_v6: {
|
|
645
|
+
type: 'string',
|
|
646
|
+
description: 'IPv6 service CIDR. Requires dual_stack.',
|
|
647
|
+
default: '2001:db8:1:1::/112'
|
|
648
|
+
}
|
|
649
|
+
},
|
|
650
|
+
required: [
|
|
651
|
+
'pod_cidr',
|
|
652
|
+
'service_cidr',
|
|
653
|
+
'dual_stack',
|
|
654
|
+
'pod_cidr_v6',
|
|
655
|
+
'service_cidr_v6'
|
|
656
|
+
],
|
|
657
|
+
additionalProperties: false,
|
|
658
|
+
description: 'Cluster networking configuration. Immutable after creation.',
|
|
659
|
+
default: {
|
|
660
|
+
pod_cidr: '10.244.0.0/16',
|
|
661
|
+
service_cidr: '10.96.0.0/12',
|
|
662
|
+
dual_stack: false,
|
|
663
|
+
pod_cidr_v6: '2001:db8:1:2::/48',
|
|
664
|
+
service_cidr_v6: '2001:db8:1:1::/112'
|
|
665
|
+
}
|
|
666
|
+
},
|
|
620
667
|
id: {
|
|
621
668
|
type: 'string',
|
|
622
669
|
format: 'uuid',
|
|
@@ -625,16 +672,13 @@ export const ClusterSchema = {
|
|
|
625
672
|
},
|
|
626
673
|
status: {
|
|
627
674
|
type: 'string',
|
|
628
|
-
description: 'Status of the cluster.
|
|
629
|
-
example: '
|
|
675
|
+
description: 'Status of the cluster.',
|
|
676
|
+
example: 'deployed',
|
|
630
677
|
enum: [
|
|
631
|
-
'active',
|
|
632
|
-
'disabled',
|
|
633
|
-
'deleted',
|
|
634
678
|
'creating',
|
|
635
679
|
'deployed',
|
|
636
|
-
'
|
|
637
|
-
'
|
|
680
|
+
'updating',
|
|
681
|
+
'disabled'
|
|
638
682
|
]
|
|
639
683
|
},
|
|
640
684
|
endpoint: {
|
|
@@ -642,8 +686,8 @@ export const ClusterSchema = {
|
|
|
642
686
|
{
|
|
643
687
|
type: 'string',
|
|
644
688
|
format: 'uri',
|
|
645
|
-
description: 'URL signed by
|
|
646
|
-
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
689
|
+
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.',
|
|
690
|
+
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
647
691
|
},
|
|
648
692
|
{
|
|
649
693
|
type: 'string',
|
|
@@ -658,7 +702,7 @@ export const ClusterSchema = {
|
|
|
658
702
|
{
|
|
659
703
|
type: 'string',
|
|
660
704
|
format: 'uri',
|
|
661
|
-
description: '
|
|
705
|
+
description: 'Deprecated alias of `endpoint`; retained for backward compatibility.',
|
|
662
706
|
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
663
707
|
},
|
|
664
708
|
{
|
|
@@ -693,21 +737,22 @@ export const ClusterSchema = {
|
|
|
693
737
|
type: 'boolean',
|
|
694
738
|
description: 'Indicates if the cluster is ready to be used.',
|
|
695
739
|
example: true
|
|
696
|
-
},
|
|
697
|
-
version_channel: {
|
|
698
|
-
type: 'string',
|
|
699
|
-
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-]+)*))?$',
|
|
700
|
-
description: 'Version of the kubernetes cluster.',
|
|
701
|
-
example: '1.x.x-cfke.x'
|
|
702
740
|
}
|
|
703
741
|
},
|
|
704
742
|
required: [
|
|
705
743
|
'name',
|
|
706
744
|
'tier',
|
|
745
|
+
'version_channel',
|
|
746
|
+
'release_channel',
|
|
747
|
+
'features',
|
|
748
|
+
'region',
|
|
749
|
+
'networking',
|
|
707
750
|
'id',
|
|
708
|
-
'status'
|
|
751
|
+
'status',
|
|
752
|
+
'ready'
|
|
709
753
|
],
|
|
710
|
-
additionalProperties: false
|
|
754
|
+
additionalProperties: false,
|
|
755
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
711
756
|
};
|
|
712
757
|
export const ClusterUpdateInputSchema = {
|
|
713
758
|
type: 'object',
|
|
@@ -723,21 +768,138 @@ export const ClusterUpdateInputSchema = {
|
|
|
723
768
|
tier: {
|
|
724
769
|
type: 'string',
|
|
725
770
|
description: 'Tier of the cluster.',
|
|
771
|
+
default: 'basic',
|
|
726
772
|
example: 'pro',
|
|
727
773
|
enum: [
|
|
728
774
|
'basic',
|
|
729
|
-
'pro'
|
|
775
|
+
'pro',
|
|
776
|
+
'enterprise'
|
|
730
777
|
]
|
|
731
778
|
},
|
|
732
779
|
version_channel: {
|
|
733
780
|
type: 'string',
|
|
734
781
|
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-]+)*))?$',
|
|
735
782
|
description: 'Version of the kubernetes cluster.',
|
|
783
|
+
default: '1.x.x-cfke.x',
|
|
736
784
|
example: '1.x.x-cfke.x'
|
|
785
|
+
},
|
|
786
|
+
release_channel: {
|
|
787
|
+
type: 'string',
|
|
788
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
789
|
+
default: 'rapid',
|
|
790
|
+
example: 'rapid',
|
|
791
|
+
enum: [
|
|
792
|
+
'rapid',
|
|
793
|
+
'stable',
|
|
794
|
+
'extended'
|
|
795
|
+
]
|
|
796
|
+
},
|
|
797
|
+
features: {
|
|
798
|
+
type: 'object',
|
|
799
|
+
properties: {
|
|
800
|
+
gpu_sharing_strategy: {
|
|
801
|
+
type: 'string',
|
|
802
|
+
description: 'GPU sharing strategy.',
|
|
803
|
+
default: 'none',
|
|
804
|
+
example: 'none',
|
|
805
|
+
enum: [
|
|
806
|
+
'none',
|
|
807
|
+
'mps',
|
|
808
|
+
'time_slicing'
|
|
809
|
+
]
|
|
810
|
+
},
|
|
811
|
+
gpu_max_shared_clients_per_gpu: {
|
|
812
|
+
type: 'integer',
|
|
813
|
+
minimum: 2,
|
|
814
|
+
maximum: 48,
|
|
815
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
816
|
+
default: 4,
|
|
817
|
+
example: 10
|
|
818
|
+
},
|
|
819
|
+
cilium_socket_lb_host_namespace_only: {
|
|
820
|
+
type: 'boolean',
|
|
821
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
822
|
+
example: false
|
|
823
|
+
}
|
|
824
|
+
},
|
|
825
|
+
additionalProperties: false,
|
|
826
|
+
description: 'Cluster feature toggles.',
|
|
827
|
+
default: {
|
|
828
|
+
gpu_sharing_strategy: 'none',
|
|
829
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
830
|
+
cilium_socket_lb_host_namespace_only: false
|
|
831
|
+
}
|
|
832
|
+
}
|
|
833
|
+
},
|
|
834
|
+
required: [
|
|
835
|
+
'name'
|
|
836
|
+
],
|
|
837
|
+
additionalProperties: false,
|
|
838
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
839
|
+
};
|
|
840
|
+
export const FeedbackCreateInputSchema = {
|
|
841
|
+
type: 'object',
|
|
842
|
+
properties: {
|
|
843
|
+
sentiment: {
|
|
844
|
+
type: 'string',
|
|
845
|
+
description: 'Overall sentiment: positive, neutral or negative.',
|
|
846
|
+
example: 'negative',
|
|
847
|
+
enum: [
|
|
848
|
+
'positive',
|
|
849
|
+
'neutral',
|
|
850
|
+
'negative'
|
|
851
|
+
]
|
|
852
|
+
},
|
|
853
|
+
message: {
|
|
854
|
+
type: 'string',
|
|
855
|
+
maxLength: 2000,
|
|
856
|
+
minLength: 1,
|
|
857
|
+
description: 'What was useful, confusing, wrong or missing.',
|
|
858
|
+
example: 'The error for a missing kubeconfig does not say which path it looked in.'
|
|
859
|
+
},
|
|
860
|
+
context: {
|
|
861
|
+
type: 'string',
|
|
862
|
+
maxLength: 2000,
|
|
863
|
+
description: 'What you were trying to do when it happened.',
|
|
864
|
+
example: 'Connecting kubectl to a new cluster.'
|
|
865
|
+
},
|
|
866
|
+
source: {
|
|
867
|
+
type: 'string',
|
|
868
|
+
description: 'Where the feedback was sent from: cli, mcp, plugin, console or api. Defaults to api.',
|
|
869
|
+
default: 'api',
|
|
870
|
+
example: 'cli',
|
|
871
|
+
enum: [
|
|
872
|
+
'cli',
|
|
873
|
+
'mcp',
|
|
874
|
+
'plugin',
|
|
875
|
+
'console',
|
|
876
|
+
'api'
|
|
877
|
+
]
|
|
878
|
+
},
|
|
879
|
+
client: {
|
|
880
|
+
type: 'string',
|
|
881
|
+
maxLength: 100,
|
|
882
|
+
description: 'Name and version of the sending client.',
|
|
883
|
+
example: 'cloudfleet-plugin-claude/0.5.0'
|
|
884
|
+
}
|
|
885
|
+
},
|
|
886
|
+
required: [
|
|
887
|
+
'sentiment',
|
|
888
|
+
'message'
|
|
889
|
+
],
|
|
890
|
+
additionalProperties: false
|
|
891
|
+
};
|
|
892
|
+
export const FeedbackSchema = {
|
|
893
|
+
type: 'object',
|
|
894
|
+
properties: {
|
|
895
|
+
id: {
|
|
896
|
+
type: 'string',
|
|
897
|
+
description: 'Unique identifier of the feedback entry (Mongo ObjectId).',
|
|
898
|
+
example: '60c72b2f9f1b2c001f8e4d3a'
|
|
737
899
|
}
|
|
738
900
|
},
|
|
739
901
|
required: [
|
|
740
|
-
'
|
|
902
|
+
'id'
|
|
741
903
|
],
|
|
742
904
|
additionalProperties: false
|
|
743
905
|
};
|
|
@@ -785,8 +947,8 @@ export const FleetCreateInputSchema = {
|
|
|
785
947
|
type: 'string',
|
|
786
948
|
maxLength: 64,
|
|
787
949
|
minLength: 64,
|
|
788
|
-
pattern: '^[A-Za-z0-9]
|
|
789
|
-
description: 'Hetzner Cloud API token with read
|
|
950
|
+
pattern: '^([A-Za-z0-9]{64}|\\*{64})$',
|
|
951
|
+
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.'
|
|
790
952
|
}
|
|
791
953
|
},
|
|
792
954
|
required: [
|
|
@@ -1011,7 +1173,8 @@ export const FleetCreateInputSchema = {
|
|
|
1011
1173
|
'z3'
|
|
1012
1174
|
]
|
|
1013
1175
|
},
|
|
1014
|
-
description: 'Allowed values for `cfke.io/instance-family`.'
|
|
1176
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
1177
|
+
default: []
|
|
1015
1178
|
},
|
|
1016
1179
|
'topology.kubernetes.io/region': {
|
|
1017
1180
|
type: 'array',
|
|
@@ -1084,21 +1247,71 @@ export const FleetCreateInputSchema = {
|
|
|
1084
1247
|
'us-west4'
|
|
1085
1248
|
]
|
|
1086
1249
|
},
|
|
1087
|
-
description: 'Allowed values for `topology.kubernetes.io/region`.'
|
|
1250
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
1251
|
+
default: []
|
|
1088
1252
|
}
|
|
1089
1253
|
},
|
|
1090
|
-
additionalProperties: false,
|
|
1091
|
-
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.
|
|
1092
|
-
|
|
1093
|
-
|
|
1094
|
-
|
|
1095
|
-
|
|
1096
|
-
|
|
1097
|
-
|
|
1098
|
-
|
|
1099
|
-
|
|
1100
|
-
'
|
|
1101
|
-
|
|
1254
|
+
additionalProperties: false,
|
|
1255
|
+
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.',
|
|
1256
|
+
default: {
|
|
1257
|
+
'karpenter.sh/capacity-type': [
|
|
1258
|
+
'on-demand',
|
|
1259
|
+
'spot'
|
|
1260
|
+
],
|
|
1261
|
+
'kubernetes.io/arch': [
|
|
1262
|
+
'amd64'
|
|
1263
|
+
],
|
|
1264
|
+
'cfke.io/instance-family': [],
|
|
1265
|
+
'topology.kubernetes.io/region': []
|
|
1266
|
+
}
|
|
1267
|
+
},
|
|
1268
|
+
scalingProfile: {
|
|
1269
|
+
type: 'string',
|
|
1270
|
+
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`).',
|
|
1271
|
+
default: 'conservative',
|
|
1272
|
+
example: 'conservative',
|
|
1273
|
+
enum: [
|
|
1274
|
+
'aggressive',
|
|
1275
|
+
'conservative'
|
|
1276
|
+
]
|
|
1277
|
+
},
|
|
1278
|
+
taints: {
|
|
1279
|
+
type: 'array',
|
|
1280
|
+
items: {
|
|
1281
|
+
type: 'object',
|
|
1282
|
+
properties: {
|
|
1283
|
+
key: {
|
|
1284
|
+
type: 'string',
|
|
1285
|
+
description: 'Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.',
|
|
1286
|
+
example: 'dedicated'
|
|
1287
|
+
},
|
|
1288
|
+
value: {
|
|
1289
|
+
type: 'string',
|
|
1290
|
+
maxLength: 63,
|
|
1291
|
+
pattern: '^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$',
|
|
1292
|
+
description: 'Taint value. Optional.',
|
|
1293
|
+
example: 'ci'
|
|
1294
|
+
},
|
|
1295
|
+
effect: {
|
|
1296
|
+
type: 'string',
|
|
1297
|
+
description: 'Taint effect.',
|
|
1298
|
+
example: 'NoSchedule',
|
|
1299
|
+
enum: [
|
|
1300
|
+
'NoSchedule',
|
|
1301
|
+
'PreferNoSchedule',
|
|
1302
|
+
'NoExecute'
|
|
1303
|
+
]
|
|
1304
|
+
}
|
|
1305
|
+
},
|
|
1306
|
+
required: [
|
|
1307
|
+
'key',
|
|
1308
|
+
'effect'
|
|
1309
|
+
],
|
|
1310
|
+
additionalProperties: false
|
|
1311
|
+
},
|
|
1312
|
+
maxItems: 50,
|
|
1313
|
+
description: 'Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.',
|
|
1314
|
+
default: []
|
|
1102
1315
|
},
|
|
1103
1316
|
id: {
|
|
1104
1317
|
type: 'string',
|
|
@@ -1112,7 +1325,8 @@ export const FleetCreateInputSchema = {
|
|
|
1112
1325
|
required: [
|
|
1113
1326
|
'id'
|
|
1114
1327
|
],
|
|
1115
|
-
additionalProperties: false
|
|
1328
|
+
additionalProperties: false,
|
|
1329
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
1116
1330
|
};
|
|
1117
1331
|
export const FleetSchema = {
|
|
1118
1332
|
type: 'object',
|
|
@@ -1382,7 +1596,8 @@ export const FleetSchema = {
|
|
|
1382
1596
|
'z3'
|
|
1383
1597
|
]
|
|
1384
1598
|
},
|
|
1385
|
-
description: 'Allowed values for `cfke.io/instance-family`.'
|
|
1599
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
1600
|
+
default: []
|
|
1386
1601
|
},
|
|
1387
1602
|
'topology.kubernetes.io/region': {
|
|
1388
1603
|
type: 'array',
|
|
@@ -1455,15 +1670,31 @@ export const FleetSchema = {
|
|
|
1455
1670
|
'us-west4'
|
|
1456
1671
|
]
|
|
1457
1672
|
},
|
|
1458
|
-
description: 'Allowed values for `topology.kubernetes.io/region`.'
|
|
1673
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
1674
|
+
default: []
|
|
1459
1675
|
}
|
|
1460
1676
|
},
|
|
1677
|
+
required: [
|
|
1678
|
+
'karpenter.sh/capacity-type',
|
|
1679
|
+
'kubernetes.io/arch'
|
|
1680
|
+
],
|
|
1461
1681
|
additionalProperties: false,
|
|
1462
|
-
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.
|
|
1682
|
+
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.',
|
|
1683
|
+
default: {
|
|
1684
|
+
'karpenter.sh/capacity-type': [
|
|
1685
|
+
'on-demand',
|
|
1686
|
+
'spot'
|
|
1687
|
+
],
|
|
1688
|
+
'kubernetes.io/arch': [
|
|
1689
|
+
'amd64'
|
|
1690
|
+
],
|
|
1691
|
+
'cfke.io/instance-family': [],
|
|
1692
|
+
'topology.kubernetes.io/region': []
|
|
1693
|
+
}
|
|
1463
1694
|
},
|
|
1464
1695
|
scalingProfile: {
|
|
1465
1696
|
type: 'string',
|
|
1466
|
-
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.',
|
|
1697
|
+
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`).',
|
|
1467
1698
|
default: 'conservative',
|
|
1468
1699
|
example: 'conservative',
|
|
1469
1700
|
enum: [
|
|
@@ -1471,6 +1702,44 @@ export const FleetSchema = {
|
|
|
1471
1702
|
'conservative'
|
|
1472
1703
|
]
|
|
1473
1704
|
},
|
|
1705
|
+
taints: {
|
|
1706
|
+
type: 'array',
|
|
1707
|
+
items: {
|
|
1708
|
+
type: 'object',
|
|
1709
|
+
properties: {
|
|
1710
|
+
key: {
|
|
1711
|
+
type: 'string',
|
|
1712
|
+
description: 'Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.',
|
|
1713
|
+
example: 'dedicated'
|
|
1714
|
+
},
|
|
1715
|
+
value: {
|
|
1716
|
+
type: 'string',
|
|
1717
|
+
maxLength: 63,
|
|
1718
|
+
pattern: '^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$',
|
|
1719
|
+
description: 'Taint value. Optional.',
|
|
1720
|
+
example: 'ci'
|
|
1721
|
+
},
|
|
1722
|
+
effect: {
|
|
1723
|
+
type: 'string',
|
|
1724
|
+
description: 'Taint effect.',
|
|
1725
|
+
example: 'NoSchedule',
|
|
1726
|
+
enum: [
|
|
1727
|
+
'NoSchedule',
|
|
1728
|
+
'PreferNoSchedule',
|
|
1729
|
+
'NoExecute'
|
|
1730
|
+
]
|
|
1731
|
+
}
|
|
1732
|
+
},
|
|
1733
|
+
required: [
|
|
1734
|
+
'key',
|
|
1735
|
+
'effect'
|
|
1736
|
+
],
|
|
1737
|
+
additionalProperties: false
|
|
1738
|
+
},
|
|
1739
|
+
maxItems: 50,
|
|
1740
|
+
description: 'Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.',
|
|
1741
|
+
default: []
|
|
1742
|
+
},
|
|
1474
1743
|
id: {
|
|
1475
1744
|
type: 'string',
|
|
1476
1745
|
maxLength: 63,
|
|
@@ -1478,13 +1747,39 @@ export const FleetSchema = {
|
|
|
1478
1747
|
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
1479
1748
|
description: 'Unique identifier of the kubernetes fleet.',
|
|
1480
1749
|
example: 'new-clouds-fleet'
|
|
1750
|
+
},
|
|
1751
|
+
ready: {
|
|
1752
|
+
type: 'boolean',
|
|
1753
|
+
description: 'Indicates whether the fleet configuration is healthy.',
|
|
1754
|
+
example: true
|
|
1755
|
+
},
|
|
1756
|
+
status_message: {
|
|
1757
|
+
type: 'string',
|
|
1758
|
+
description: 'Human-readable reason the fleet is not ready. Present only when `ready` is false.',
|
|
1759
|
+
example: 'Invalid provider permissions.'
|
|
1760
|
+
},
|
|
1761
|
+
created_at: {
|
|
1762
|
+
type: 'string',
|
|
1763
|
+
description: 'Creation date and time of the fleet.',
|
|
1764
|
+
example: '2024-09-12T09:11:27Z'
|
|
1765
|
+
},
|
|
1766
|
+
updated_at: {
|
|
1767
|
+
type: 'string',
|
|
1768
|
+
description: 'Date and time the fleet was last updated.',
|
|
1769
|
+
example: '2024-09-12T09:11:27Z'
|
|
1481
1770
|
}
|
|
1482
1771
|
},
|
|
1483
1772
|
required: [
|
|
1773
|
+
'constraints',
|
|
1484
1774
|
'scalingProfile',
|
|
1485
|
-
'
|
|
1775
|
+
'taints',
|
|
1776
|
+
'id',
|
|
1777
|
+
'ready',
|
|
1778
|
+
'created_at',
|
|
1779
|
+
'updated_at'
|
|
1486
1780
|
],
|
|
1487
|
-
additionalProperties: false
|
|
1781
|
+
additionalProperties: false,
|
|
1782
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
1488
1783
|
};
|
|
1489
1784
|
export const FleetUpdateInputSchema = {
|
|
1490
1785
|
type: 'object',
|
|
@@ -1530,8 +1825,8 @@ export const FleetUpdateInputSchema = {
|
|
|
1530
1825
|
type: 'string',
|
|
1531
1826
|
maxLength: 64,
|
|
1532
1827
|
minLength: 64,
|
|
1533
|
-
pattern: '^[A-Za-z0-9]
|
|
1534
|
-
description: 'Hetzner Cloud API token with read
|
|
1828
|
+
pattern: '^([A-Za-z0-9]{64}|\\*{64})$',
|
|
1829
|
+
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.'
|
|
1535
1830
|
}
|
|
1536
1831
|
},
|
|
1537
1832
|
required: [
|
|
@@ -1570,7 +1865,11 @@ export const FleetUpdateInputSchema = {
|
|
|
1570
1865
|
]
|
|
1571
1866
|
},
|
|
1572
1867
|
minItems: 1,
|
|
1573
|
-
description: 'Allowed values for `karpenter.sh/capacity-type`.'
|
|
1868
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1869
|
+
default: [
|
|
1870
|
+
'on-demand',
|
|
1871
|
+
'spot'
|
|
1872
|
+
]
|
|
1574
1873
|
},
|
|
1575
1874
|
'kubernetes.io/arch': {
|
|
1576
1875
|
type: 'array',
|
|
@@ -1582,7 +1881,10 @@ export const FleetUpdateInputSchema = {
|
|
|
1582
1881
|
]
|
|
1583
1882
|
},
|
|
1584
1883
|
minItems: 1,
|
|
1585
|
-
description: 'Allowed values for `kubernetes.io/arch`.'
|
|
1884
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1885
|
+
default: [
|
|
1886
|
+
'amd64'
|
|
1887
|
+
]
|
|
1586
1888
|
},
|
|
1587
1889
|
'cfke.io/instance-family': {
|
|
1588
1890
|
type: 'array',
|
|
@@ -1749,7 +2051,8 @@ export const FleetUpdateInputSchema = {
|
|
|
1749
2051
|
'z3'
|
|
1750
2052
|
]
|
|
1751
2053
|
},
|
|
1752
|
-
description: 'Allowed values for `cfke.io/instance-family`.'
|
|
2054
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
2055
|
+
default: []
|
|
1753
2056
|
},
|
|
1754
2057
|
'topology.kubernetes.io/region': {
|
|
1755
2058
|
type: 'array',
|
|
@@ -1822,24 +2125,98 @@ export const FleetUpdateInputSchema = {
|
|
|
1822
2125
|
'us-west4'
|
|
1823
2126
|
]
|
|
1824
2127
|
},
|
|
1825
|
-
description: 'Allowed values for `topology.kubernetes.io/region`.'
|
|
2128
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
2129
|
+
default: []
|
|
1826
2130
|
}
|
|
1827
2131
|
},
|
|
1828
2132
|
additionalProperties: false,
|
|
1829
|
-
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.
|
|
2133
|
+
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.',
|
|
2134
|
+
default: {
|
|
2135
|
+
'karpenter.sh/capacity-type': [
|
|
2136
|
+
'on-demand',
|
|
2137
|
+
'spot'
|
|
2138
|
+
],
|
|
2139
|
+
'kubernetes.io/arch': [
|
|
2140
|
+
'amd64'
|
|
2141
|
+
],
|
|
2142
|
+
'cfke.io/instance-family': [],
|
|
2143
|
+
'topology.kubernetes.io/region': []
|
|
2144
|
+
}
|
|
1830
2145
|
},
|
|
1831
2146
|
scalingProfile: {
|
|
1832
2147
|
type: 'string',
|
|
1833
|
-
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.',
|
|
2148
|
+
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`).',
|
|
2149
|
+
default: 'conservative',
|
|
1834
2150
|
example: 'conservative',
|
|
1835
2151
|
enum: [
|
|
1836
2152
|
'aggressive',
|
|
1837
2153
|
'conservative'
|
|
1838
2154
|
]
|
|
2155
|
+
},
|
|
2156
|
+
taints: {
|
|
2157
|
+
type: 'array',
|
|
2158
|
+
items: {
|
|
2159
|
+
type: 'object',
|
|
2160
|
+
properties: {
|
|
2161
|
+
key: {
|
|
2162
|
+
type: 'string',
|
|
2163
|
+
description: 'Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.',
|
|
2164
|
+
example: 'dedicated'
|
|
2165
|
+
},
|
|
2166
|
+
value: {
|
|
2167
|
+
type: 'string',
|
|
2168
|
+
maxLength: 63,
|
|
2169
|
+
pattern: '^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$',
|
|
2170
|
+
description: 'Taint value. Optional.',
|
|
2171
|
+
example: 'ci'
|
|
2172
|
+
},
|
|
2173
|
+
effect: {
|
|
2174
|
+
type: 'string',
|
|
2175
|
+
description: 'Taint effect.',
|
|
2176
|
+
example: 'NoSchedule',
|
|
2177
|
+
enum: [
|
|
2178
|
+
'NoSchedule',
|
|
2179
|
+
'PreferNoSchedule',
|
|
2180
|
+
'NoExecute'
|
|
2181
|
+
]
|
|
2182
|
+
}
|
|
2183
|
+
},
|
|
2184
|
+
required: [
|
|
2185
|
+
'key',
|
|
2186
|
+
'effect'
|
|
2187
|
+
],
|
|
2188
|
+
additionalProperties: false
|
|
2189
|
+
},
|
|
2190
|
+
maxItems: 50,
|
|
2191
|
+
description: 'Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.',
|
|
2192
|
+
default: []
|
|
2193
|
+
}
|
|
2194
|
+
},
|
|
2195
|
+
additionalProperties: false,
|
|
2196
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
2197
|
+
};
|
|
2198
|
+
export const InviteCreateInputSchema = {
|
|
2199
|
+
type: 'object',
|
|
2200
|
+
properties: {
|
|
2201
|
+
email: {
|
|
2202
|
+
type: 'string',
|
|
2203
|
+
format: 'email',
|
|
2204
|
+
description: 'Email address of the user to invite.',
|
|
2205
|
+
example: 'email@example.com'
|
|
2206
|
+
},
|
|
2207
|
+
role: {
|
|
2208
|
+
type: 'string',
|
|
2209
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2210
|
+
default: 'User',
|
|
2211
|
+
example: 'User',
|
|
2212
|
+
enum: [
|
|
2213
|
+
'Administrator',
|
|
2214
|
+
'User'
|
|
2215
|
+
]
|
|
1839
2216
|
}
|
|
1840
2217
|
},
|
|
1841
2218
|
required: [
|
|
1842
|
-
'
|
|
2219
|
+
'email'
|
|
1843
2220
|
],
|
|
1844
2221
|
additionalProperties: false
|
|
1845
2222
|
};
|
|
@@ -1873,6 +2250,16 @@ export const InviteSchema = {
|
|
|
1873
2250
|
type: 'string',
|
|
1874
2251
|
description: 'Generated unique invite code.',
|
|
1875
2252
|
example: '7kUZnH7nnKUFfvc4NK2KQF'
|
|
2253
|
+
},
|
|
2254
|
+
role: {
|
|
2255
|
+
type: 'string',
|
|
2256
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2257
|
+
default: 'User',
|
|
2258
|
+
example: 'User',
|
|
2259
|
+
enum: [
|
|
2260
|
+
'Administrator',
|
|
2261
|
+
'User'
|
|
2262
|
+
]
|
|
1876
2263
|
}
|
|
1877
2264
|
},
|
|
1878
2265
|
required: [
|
|
@@ -1880,219 +2267,238 @@ export const InviteSchema = {
|
|
|
1880
2267
|
],
|
|
1881
2268
|
additionalProperties: false
|
|
1882
2269
|
};
|
|
1883
|
-
export const
|
|
2270
|
+
export const InvoicePaymentAttemptSchema = {
|
|
1884
2271
|
type: 'object',
|
|
1885
2272
|
properties: {
|
|
1886
|
-
|
|
2273
|
+
invoice_id: {
|
|
1887
2274
|
type: 'string',
|
|
1888
|
-
description: '
|
|
2275
|
+
description: 'Identifier of the invoice.',
|
|
1889
2276
|
example: 'in_1234567890xCrwxghOTj1234'
|
|
1890
2277
|
},
|
|
1891
2278
|
number: {
|
|
1892
|
-
type: 'string'
|
|
1893
|
-
},
|
|
1894
|
-
status: {
|
|
1895
2279
|
type: 'string',
|
|
1896
|
-
|
|
1897
|
-
|
|
2280
|
+
nullable: true,
|
|
2281
|
+
description: 'Invoice number. Null if the invoice has no number.',
|
|
2282
|
+
example: 'CF-0042'
|
|
1898
2283
|
},
|
|
1899
|
-
|
|
2284
|
+
amount: {
|
|
1900
2285
|
type: 'number',
|
|
1901
2286
|
format: 'float',
|
|
1902
|
-
description: '
|
|
1903
|
-
example:
|
|
2287
|
+
description: 'Amount outstanding when the charge was attempted, in the smallest currency unit.',
|
|
2288
|
+
example: 4200
|
|
1904
2289
|
},
|
|
1905
2290
|
currency: {
|
|
1906
2291
|
type: 'string',
|
|
1907
|
-
description: 'Currency of the invoice',
|
|
1908
|
-
example: '
|
|
2292
|
+
description: 'Currency of the invoice.',
|
|
2293
|
+
example: 'eur'
|
|
1909
2294
|
},
|
|
1910
|
-
|
|
2295
|
+
status: {
|
|
1911
2296
|
type: 'string',
|
|
1912
|
-
|
|
1913
|
-
|
|
1914
|
-
|
|
2297
|
+
description: 'Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).',
|
|
2298
|
+
example: 'paid',
|
|
2299
|
+
enum: [
|
|
2300
|
+
'paid',
|
|
2301
|
+
'processing',
|
|
2302
|
+
'requires_action',
|
|
2303
|
+
'failed'
|
|
2304
|
+
]
|
|
1915
2305
|
},
|
|
1916
|
-
|
|
2306
|
+
client_secret: {
|
|
1917
2307
|
type: 'string',
|
|
1918
|
-
|
|
1919
|
-
description: '
|
|
1920
|
-
example: '
|
|
2308
|
+
nullable: true,
|
|
2309
|
+
description: 'Client secret used to complete customer authentication. Set only when `status` is `requires_action`.',
|
|
2310
|
+
example: 'pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH'
|
|
1921
2311
|
},
|
|
1922
|
-
|
|
2312
|
+
failure_code: {
|
|
1923
2313
|
type: 'string',
|
|
1924
|
-
|
|
1925
|
-
description: '
|
|
1926
|
-
example: '
|
|
2314
|
+
nullable: true,
|
|
2315
|
+
description: 'Decline code. Set only when `status` is `failed`.',
|
|
2316
|
+
example: 'insufficient_funds'
|
|
1927
2317
|
},
|
|
1928
|
-
|
|
1929
|
-
type: 'string'
|
|
2318
|
+
failure_message: {
|
|
2319
|
+
type: 'string',
|
|
2320
|
+
nullable: true,
|
|
2321
|
+
description: 'Explanation of the decline, suitable for display. Set only when `status` is `failed`.',
|
|
2322
|
+
example: 'Your card has insufficient funds.'
|
|
1930
2323
|
}
|
|
1931
2324
|
},
|
|
1932
2325
|
required: [
|
|
1933
|
-
'
|
|
1934
|
-
'
|
|
1935
|
-
'
|
|
2326
|
+
'invoice_id',
|
|
2327
|
+
'number',
|
|
2328
|
+
'amount',
|
|
2329
|
+
'currency',
|
|
2330
|
+
'status',
|
|
2331
|
+
'client_secret',
|
|
2332
|
+
'failure_code',
|
|
2333
|
+
'failure_message'
|
|
1936
2334
|
],
|
|
1937
2335
|
additionalProperties: false
|
|
1938
2336
|
};
|
|
1939
|
-
export const
|
|
2337
|
+
export const InvoicePaymentResultSchema = {
|
|
1940
2338
|
type: 'object',
|
|
1941
2339
|
properties: {
|
|
1942
|
-
|
|
2340
|
+
code: {
|
|
1943
2341
|
type: 'string',
|
|
1944
|
-
description: '
|
|
1945
|
-
example: '
|
|
2342
|
+
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).',
|
|
2343
|
+
example: 'partially_paid',
|
|
2344
|
+
enum: [
|
|
2345
|
+
'paid',
|
|
2346
|
+
'processing',
|
|
2347
|
+
'action_required',
|
|
2348
|
+
'partially_paid',
|
|
2349
|
+
'failed',
|
|
2350
|
+
'nothing_due',
|
|
2351
|
+
'bank_transfer_due'
|
|
2352
|
+
]
|
|
1946
2353
|
},
|
|
1947
|
-
|
|
2354
|
+
message: {
|
|
1948
2355
|
type: 'string',
|
|
1949
|
-
description: '
|
|
1950
|
-
example: '
|
|
2356
|
+
description: 'Summary of the outcome, suitable for display.',
|
|
2357
|
+
example: '1 of 2 open invoices was paid. Invoice CF-0043 was declined: Your card has insufficient funds.'
|
|
1951
2358
|
},
|
|
1952
|
-
|
|
1953
|
-
type: '
|
|
1954
|
-
|
|
1955
|
-
|
|
2359
|
+
results: {
|
|
2360
|
+
type: 'array',
|
|
2361
|
+
items: {
|
|
2362
|
+
type: 'object',
|
|
2363
|
+
properties: {
|
|
2364
|
+
invoice_id: {
|
|
2365
|
+
type: 'string',
|
|
2366
|
+
description: 'Identifier of the invoice.',
|
|
2367
|
+
example: 'in_1234567890xCrwxghOTj1234'
|
|
2368
|
+
},
|
|
2369
|
+
number: {
|
|
2370
|
+
type: 'string',
|
|
2371
|
+
description: 'Invoice number. Null if the invoice has no number.',
|
|
2372
|
+
example: 'CF-0042'
|
|
2373
|
+
},
|
|
2374
|
+
amount: {
|
|
2375
|
+
type: 'number',
|
|
2376
|
+
format: 'float',
|
|
2377
|
+
description: 'Amount outstanding when the charge was attempted, in the smallest currency unit.',
|
|
2378
|
+
example: 4200
|
|
2379
|
+
},
|
|
2380
|
+
currency: {
|
|
2381
|
+
type: 'string',
|
|
2382
|
+
description: 'Currency of the invoice.',
|
|
2383
|
+
example: 'eur'
|
|
2384
|
+
},
|
|
2385
|
+
status: {
|
|
2386
|
+
type: 'string',
|
|
2387
|
+
description: 'Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).',
|
|
2388
|
+
example: 'paid',
|
|
2389
|
+
enum: [
|
|
2390
|
+
'paid',
|
|
2391
|
+
'processing',
|
|
2392
|
+
'requires_action',
|
|
2393
|
+
'failed'
|
|
2394
|
+
]
|
|
2395
|
+
},
|
|
2396
|
+
client_secret: {
|
|
2397
|
+
type: 'string',
|
|
2398
|
+
description: 'Client secret used to complete customer authentication. Set only when `status` is `requires_action`.',
|
|
2399
|
+
example: 'pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH'
|
|
2400
|
+
},
|
|
2401
|
+
failure_code: {
|
|
2402
|
+
type: 'string',
|
|
2403
|
+
description: 'Decline code. Set only when `status` is `failed`.',
|
|
2404
|
+
example: 'insufficient_funds'
|
|
2405
|
+
},
|
|
2406
|
+
failure_message: {
|
|
2407
|
+
type: 'string',
|
|
2408
|
+
description: 'Explanation of the decline, suitable for display. Set only when `status` is `failed`.',
|
|
2409
|
+
example: 'Your card has insufficient funds.'
|
|
2410
|
+
}
|
|
2411
|
+
},
|
|
2412
|
+
required: [
|
|
2413
|
+
'invoice_id',
|
|
2414
|
+
'number',
|
|
2415
|
+
'amount',
|
|
2416
|
+
'currency',
|
|
2417
|
+
'status',
|
|
2418
|
+
'client_secret',
|
|
2419
|
+
'failure_code',
|
|
2420
|
+
'failure_message'
|
|
2421
|
+
],
|
|
2422
|
+
additionalProperties: false
|
|
2423
|
+
},
|
|
2424
|
+
description: 'One entry per invoice charged, oldest first.'
|
|
1956
2425
|
}
|
|
1957
2426
|
},
|
|
2427
|
+
required: [
|
|
2428
|
+
'code',
|
|
2429
|
+
'message',
|
|
2430
|
+
'results'
|
|
2431
|
+
],
|
|
1958
2432
|
additionalProperties: false
|
|
1959
2433
|
};
|
|
1960
|
-
export const
|
|
2434
|
+
export const InvoiceSchema = {
|
|
1961
2435
|
type: 'object',
|
|
1962
2436
|
properties: {
|
|
1963
|
-
|
|
2437
|
+
id: {
|
|
1964
2438
|
type: 'string',
|
|
1965
|
-
description: '
|
|
1966
|
-
example: '
|
|
1967
|
-
},
|
|
1968
|
-
versions: {
|
|
1969
|
-
type: 'array',
|
|
1970
|
-
items: {
|
|
1971
|
-
type: 'string',
|
|
1972
|
-
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-]+)*))?$',
|
|
1973
|
-
description: 'Specific version of the chart',
|
|
1974
|
-
example: '1.18.2-cfke.45'
|
|
1975
|
-
},
|
|
1976
|
-
description: 'Available versions of the chart'
|
|
2439
|
+
description: 'Unique identifier of the invoice.',
|
|
2440
|
+
example: 'in_1234567890xCrwxghOTj1234'
|
|
1977
2441
|
},
|
|
1978
|
-
|
|
1979
|
-
type: '
|
|
1980
|
-
items: {
|
|
1981
|
-
type: 'string',
|
|
1982
|
-
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-]+)*))?$',
|
|
1983
|
-
description: 'Version channel pattern',
|
|
1984
|
-
example: '1.18.x-cfke.x'
|
|
1985
|
-
},
|
|
1986
|
-
description: 'Version channels for the chart'
|
|
2442
|
+
number: {
|
|
2443
|
+
type: 'string'
|
|
1987
2444
|
},
|
|
1988
|
-
|
|
2445
|
+
status: {
|
|
1989
2446
|
type: 'string',
|
|
1990
|
-
description: '
|
|
1991
|
-
example: '
|
|
1992
|
-
},
|
|
1993
|
-
|
|
1994
|
-
type: '
|
|
1995
|
-
|
|
1996
|
-
|
|
1997
|
-
|
|
1998
|
-
|
|
1999
|
-
|
|
2000
|
-
|
|
2001
|
-
|
|
2002
|
-
|
|
2003
|
-
|
|
2004
|
-
|
|
2005
|
-
|
|
2006
|
-
|
|
2007
|
-
|
|
2008
|
-
|
|
2009
|
-
|
|
2010
|
-
|
|
2011
|
-
|
|
2012
|
-
|
|
2013
|
-
|
|
2014
|
-
|
|
2015
|
-
|
|
2016
|
-
|
|
2017
|
-
|
|
2018
|
-
|
|
2019
|
-
|
|
2020
|
-
|
|
2021
|
-
|
|
2022
|
-
|
|
2023
|
-
|
|
2024
|
-
type: 'string'
|
|
2025
|
-
},
|
|
2026
|
-
description: 'Chart keywords',
|
|
2027
|
-
example: [
|
|
2028
|
-
'ingress',
|
|
2029
|
-
'nginx',
|
|
2030
|
-
'load-balancer'
|
|
2031
|
-
]
|
|
2032
|
-
},
|
|
2033
|
-
home: {
|
|
2034
|
-
type: 'string',
|
|
2035
|
-
description: 'Chart home URL',
|
|
2036
|
-
example: 'https://kubernetes.github.io/ingress-nginx/'
|
|
2037
|
-
},
|
|
2038
|
-
icon: {
|
|
2039
|
-
type: 'string',
|
|
2040
|
-
description: 'A URL to an SVG or PNG image to be used as an icon',
|
|
2041
|
-
example: 'https://cloudfleet.ai/images/marketplace/icons/ingress-nginx.png'
|
|
2042
|
-
},
|
|
2043
|
-
sources: {
|
|
2044
|
-
type: 'array',
|
|
2045
|
-
items: {
|
|
2046
|
-
type: 'string'
|
|
2047
|
-
},
|
|
2048
|
-
description: 'Chart source URLs',
|
|
2049
|
-
example: [
|
|
2050
|
-
'https://github.com/kubernetes/ingress-nginx'
|
|
2051
|
-
]
|
|
2052
|
-
},
|
|
2053
|
-
maintainers: {
|
|
2054
|
-
type: 'array',
|
|
2055
|
-
items: {
|
|
2056
|
-
type: 'object',
|
|
2057
|
-
properties: {
|
|
2058
|
-
name: {
|
|
2059
|
-
type: 'string',
|
|
2060
|
-
description: 'Maintainer name',
|
|
2061
|
-
example: 'NGINX Team'
|
|
2062
|
-
},
|
|
2063
|
-
email: {
|
|
2064
|
-
type: 'string',
|
|
2065
|
-
description: 'Maintainer email',
|
|
2066
|
-
example: 'support@nginx.org'
|
|
2067
|
-
}
|
|
2068
|
-
},
|
|
2069
|
-
required: [
|
|
2070
|
-
'name'
|
|
2071
|
-
],
|
|
2072
|
-
additionalProperties: false
|
|
2073
|
-
},
|
|
2074
|
-
description: 'Chart maintainers'
|
|
2075
|
-
}
|
|
2076
|
-
},
|
|
2077
|
-
required: [
|
|
2078
|
-
'name',
|
|
2079
|
-
'version'
|
|
2080
|
-
],
|
|
2081
|
-
additionalProperties: false,
|
|
2082
|
-
description: 'Chart metadata'
|
|
2447
|
+
description: 'Status of the invoice',
|
|
2448
|
+
example: 'paid'
|
|
2449
|
+
},
|
|
2450
|
+
total: {
|
|
2451
|
+
type: 'number',
|
|
2452
|
+
format: 'float',
|
|
2453
|
+
description: 'Total amount of the invoice',
|
|
2454
|
+
example: 100
|
|
2455
|
+
},
|
|
2456
|
+
currency: {
|
|
2457
|
+
type: 'string',
|
|
2458
|
+
description: 'Currency of the invoice',
|
|
2459
|
+
example: 'usd'
|
|
2460
|
+
},
|
|
2461
|
+
created: {
|
|
2462
|
+
type: 'string',
|
|
2463
|
+
format: 'date-time',
|
|
2464
|
+
description: 'Timestamp when the invoice was issued. ISO 8601 date string in the UTC timezone.',
|
|
2465
|
+
example: '2023-12-20T13:53:32.000Z'
|
|
2466
|
+
},
|
|
2467
|
+
period_start: {
|
|
2468
|
+
type: 'string',
|
|
2469
|
+
format: 'date-time',
|
|
2470
|
+
description: 'Billing period start timestamp. ISO 8601 date string in the UTC timezone.',
|
|
2471
|
+
example: '2023-12-20T13:53:32.000Z'
|
|
2472
|
+
},
|
|
2473
|
+
period_end: {
|
|
2474
|
+
type: 'string',
|
|
2475
|
+
format: 'date-time',
|
|
2476
|
+
description: 'Billing period end timestamp. ISO 8601 date string in the UTC timezone.',
|
|
2477
|
+
example: '2023-12-20T13:53:32.000Z'
|
|
2478
|
+
},
|
|
2479
|
+
invoice_pdf: {
|
|
2480
|
+
type: 'string'
|
|
2083
2481
|
}
|
|
2084
2482
|
},
|
|
2085
2483
|
required: [
|
|
2086
|
-
'
|
|
2087
|
-
'
|
|
2088
|
-
'
|
|
2089
|
-
'latestVersion'
|
|
2484
|
+
'created',
|
|
2485
|
+
'period_start',
|
|
2486
|
+
'period_end'
|
|
2090
2487
|
],
|
|
2091
2488
|
additionalProperties: false
|
|
2092
2489
|
};
|
|
2093
2490
|
export const OrganizationCreateInputSchema = {
|
|
2094
2491
|
type: 'object',
|
|
2095
2492
|
properties: {
|
|
2493
|
+
type: {
|
|
2494
|
+
type: 'string',
|
|
2495
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2496
|
+
example: 'business',
|
|
2497
|
+
enum: [
|
|
2498
|
+
'business',
|
|
2499
|
+
'personal'
|
|
2500
|
+
]
|
|
2501
|
+
},
|
|
2096
2502
|
email: {
|
|
2097
2503
|
type: 'string',
|
|
2098
2504
|
format: 'email',
|
|
@@ -2101,11 +2507,13 @@ export const OrganizationCreateInputSchema = {
|
|
|
2101
2507
|
},
|
|
2102
2508
|
first_name: {
|
|
2103
2509
|
type: 'string',
|
|
2510
|
+
minLength: 1,
|
|
2104
2511
|
description: 'First name of the billing contact person.',
|
|
2105
2512
|
example: 'John'
|
|
2106
2513
|
},
|
|
2107
2514
|
last_name: {
|
|
2108
2515
|
type: 'string',
|
|
2516
|
+
minLength: 1,
|
|
2109
2517
|
description: 'Last name of the billing contact person.',
|
|
2110
2518
|
example: 'Doe'
|
|
2111
2519
|
},
|
|
@@ -2124,6 +2532,7 @@ export const OrganizationCreateInputSchema = {
|
|
|
2124
2532
|
}
|
|
2125
2533
|
},
|
|
2126
2534
|
required: [
|
|
2535
|
+
'type',
|
|
2127
2536
|
'email',
|
|
2128
2537
|
'first_name',
|
|
2129
2538
|
'last_name',
|
|
@@ -2132,6 +2541,20 @@ export const OrganizationCreateInputSchema = {
|
|
|
2132
2541
|
],
|
|
2133
2542
|
additionalProperties: false
|
|
2134
2543
|
};
|
|
2544
|
+
export const OrganizationCreateOutputSchema = {
|
|
2545
|
+
type: 'object',
|
|
2546
|
+
properties: {
|
|
2547
|
+
id: {
|
|
2548
|
+
type: 'string',
|
|
2549
|
+
description: 'Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.',
|
|
2550
|
+
example: 'organization-id'
|
|
2551
|
+
}
|
|
2552
|
+
},
|
|
2553
|
+
required: [
|
|
2554
|
+
'id'
|
|
2555
|
+
],
|
|
2556
|
+
additionalProperties: false
|
|
2557
|
+
};
|
|
2135
2558
|
export const OrganizationSchema = {
|
|
2136
2559
|
type: 'object',
|
|
2137
2560
|
properties: {
|
|
@@ -2148,6 +2571,15 @@ export const OrganizationSchema = {
|
|
|
2148
2571
|
description: 'Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.',
|
|
2149
2572
|
example: 'ACME Corp.'
|
|
2150
2573
|
},
|
|
2574
|
+
type: {
|
|
2575
|
+
type: 'string',
|
|
2576
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2577
|
+
example: 'business',
|
|
2578
|
+
enum: [
|
|
2579
|
+
'business',
|
|
2580
|
+
'personal'
|
|
2581
|
+
]
|
|
2582
|
+
},
|
|
2151
2583
|
date_created: {
|
|
2152
2584
|
type: 'string',
|
|
2153
2585
|
format: 'date-time',
|
|
@@ -2179,6 +2611,17 @@ export const OrganizationSchema = {
|
|
|
2179
2611
|
description: 'Available number of Pro clusters that can be created.',
|
|
2180
2612
|
example: 999
|
|
2181
2613
|
},
|
|
2614
|
+
enterprise_clusters_max: {
|
|
2615
|
+
type: 'integer',
|
|
2616
|
+
minimum: 0,
|
|
2617
|
+
description: 'Maximum number of Enterprise clusters that can be created.',
|
|
2618
|
+
example: 999
|
|
2619
|
+
},
|
|
2620
|
+
enterprise_clusters_available: {
|
|
2621
|
+
type: 'integer',
|
|
2622
|
+
description: 'Available number of Enterprise clusters that can be created.',
|
|
2623
|
+
example: 999
|
|
2624
|
+
},
|
|
2182
2625
|
fleets_max: {
|
|
2183
2626
|
type: 'integer',
|
|
2184
2627
|
minimum: 0,
|
|
@@ -2198,7 +2641,7 @@ export const OrganizationSchema = {
|
|
|
2198
2641
|
type: 'array',
|
|
2199
2642
|
items: {
|
|
2200
2643
|
type: 'string',
|
|
2201
|
-
example: 'northamerica-central-
|
|
2644
|
+
example: 'northamerica-central-1a'
|
|
2202
2645
|
},
|
|
2203
2646
|
minItems: 1,
|
|
2204
2647
|
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
@@ -2240,6 +2683,8 @@ export const OrganizationSchema = {
|
|
|
2240
2683
|
'basic_clusters_available',
|
|
2241
2684
|
'pro_clusters_max',
|
|
2242
2685
|
'pro_clusters_available',
|
|
2686
|
+
'enterprise_clusters_max',
|
|
2687
|
+
'enterprise_clusters_available',
|
|
2243
2688
|
'fleets_max',
|
|
2244
2689
|
'cluster_tiers',
|
|
2245
2690
|
'regions',
|
|
@@ -2257,13 +2702,25 @@ export const OrganizationSchema = {
|
|
|
2257
2702
|
'closed',
|
|
2258
2703
|
'suspended'
|
|
2259
2704
|
]
|
|
2705
|
+
},
|
|
2706
|
+
verification: {
|
|
2707
|
+
type: 'string',
|
|
2708
|
+
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.',
|
|
2709
|
+
example: 'verified',
|
|
2710
|
+
enum: [
|
|
2711
|
+
'none',
|
|
2712
|
+
'submitted',
|
|
2713
|
+
'verified'
|
|
2714
|
+
]
|
|
2260
2715
|
}
|
|
2261
2716
|
},
|
|
2262
2717
|
required: [
|
|
2263
2718
|
'id',
|
|
2719
|
+
'type',
|
|
2264
2720
|
'date_created',
|
|
2265
2721
|
'quota',
|
|
2266
|
-
'status'
|
|
2722
|
+
'status',
|
|
2723
|
+
'verification'
|
|
2267
2724
|
],
|
|
2268
2725
|
additionalProperties: false
|
|
2269
2726
|
};
|
|
@@ -2272,28 +2729,23 @@ export const PaymentMethodSchema = {
|
|
|
2272
2729
|
properties: {
|
|
2273
2730
|
id: {
|
|
2274
2731
|
type: 'string',
|
|
2275
|
-
|
|
2276
|
-
|
|
2277
|
-
example: 'e94d30ec-a2dd-4dcb-832c-ac2be144ba91'
|
|
2278
|
-
},
|
|
2279
|
-
setup: {
|
|
2280
|
-
type: 'boolean',
|
|
2281
|
-
description: 'Whether organization payment method was set up and ready to use for payments.',
|
|
2282
|
-
example: true
|
|
2732
|
+
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.',
|
|
2733
|
+
example: 'pm_1MtwBwLkdIwHu7ix28a3tqPa'
|
|
2283
2734
|
},
|
|
2284
2735
|
type: {
|
|
2285
2736
|
type: 'string',
|
|
2286
|
-
|
|
2287
|
-
description: 'Payment method type type. Only `card` payments supported at the moment.',
|
|
2737
|
+
description: 'Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.',
|
|
2288
2738
|
example: 'card',
|
|
2289
2739
|
enum: [
|
|
2290
|
-
'card'
|
|
2740
|
+
'card',
|
|
2741
|
+
'sepa_debit',
|
|
2742
|
+
'bank_transfer'
|
|
2291
2743
|
]
|
|
2292
2744
|
},
|
|
2293
2745
|
last4: {
|
|
2294
2746
|
type: 'string',
|
|
2295
2747
|
nullable: true,
|
|
2296
|
-
description: 'Last 4 digits of the payment card number.',
|
|
2748
|
+
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.',
|
|
2297
2749
|
example: '4242'
|
|
2298
2750
|
},
|
|
2299
2751
|
exp_month: {
|
|
@@ -2301,42 +2753,56 @@ export const PaymentMethodSchema = {
|
|
|
2301
2753
|
minimum: 1,
|
|
2302
2754
|
maximum: 12,
|
|
2303
2755
|
nullable: true,
|
|
2304
|
-
description: 'Two-digit number representing the card\'s expiration month.',
|
|
2305
|
-
example:
|
|
2756
|
+
description: 'Two-digit number representing the card\'s expiration month. Null for SEPA Direct Debit and bank transfer.',
|
|
2757
|
+
example: 12
|
|
2306
2758
|
},
|
|
2307
2759
|
exp_year: {
|
|
2308
2760
|
type: 'integer',
|
|
2309
|
-
minimum: 2024,
|
|
2310
2761
|
nullable: true,
|
|
2311
|
-
description: 'Four-digit number representing the card\'s expiration year.',
|
|
2312
|
-
example:
|
|
2762
|
+
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.',
|
|
2763
|
+
example: 2028
|
|
2313
2764
|
},
|
|
2314
2765
|
brand: {
|
|
2315
2766
|
type: 'string',
|
|
2316
2767
|
nullable: true,
|
|
2317
|
-
description: 'Payment card brand
|
|
2318
|
-
example: 'visa'
|
|
2319
|
-
|
|
2320
|
-
|
|
2321
|
-
|
|
2322
|
-
|
|
2323
|
-
|
|
2324
|
-
|
|
2325
|
-
|
|
2326
|
-
|
|
2327
|
-
|
|
2328
|
-
|
|
2329
|
-
|
|
2768
|
+
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.',
|
|
2769
|
+
example: 'visa'
|
|
2770
|
+
},
|
|
2771
|
+
iban: {
|
|
2772
|
+
type: 'string',
|
|
2773
|
+
nullable: true,
|
|
2774
|
+
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.',
|
|
2775
|
+
example: 'DE11243015658023127510'
|
|
2776
|
+
},
|
|
2777
|
+
bic: {
|
|
2778
|
+
type: 'string',
|
|
2779
|
+
nullable: true,
|
|
2780
|
+
description: 'BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
2781
|
+
example: 'SOGEDEFFXXX'
|
|
2782
|
+
},
|
|
2783
|
+
account_holder_name: {
|
|
2784
|
+
type: 'string',
|
|
2785
|
+
nullable: true,
|
|
2786
|
+
description: 'Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
2787
|
+
example: 'Cloudfleet GmbH'
|
|
2788
|
+
},
|
|
2789
|
+
is_default: {
|
|
2790
|
+
type: 'boolean',
|
|
2791
|
+
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).',
|
|
2792
|
+
example: true
|
|
2330
2793
|
}
|
|
2331
2794
|
},
|
|
2332
2795
|
required: [
|
|
2333
2796
|
'id',
|
|
2334
|
-
'setup',
|
|
2335
2797
|
'type',
|
|
2336
2798
|
'last4',
|
|
2337
2799
|
'exp_month',
|
|
2338
2800
|
'exp_year',
|
|
2339
|
-
'brand'
|
|
2801
|
+
'brand',
|
|
2802
|
+
'iban',
|
|
2803
|
+
'bic',
|
|
2804
|
+
'account_holder_name',
|
|
2805
|
+
'is_default'
|
|
2340
2806
|
],
|
|
2341
2807
|
additionalProperties: false
|
|
2342
2808
|
};
|
|
@@ -2365,6 +2831,17 @@ export const PlatformQuotaSchema = {
|
|
|
2365
2831
|
description: 'Available number of Pro clusters that can be created.',
|
|
2366
2832
|
example: 999
|
|
2367
2833
|
},
|
|
2834
|
+
enterprise_clusters_max: {
|
|
2835
|
+
type: 'integer',
|
|
2836
|
+
minimum: 0,
|
|
2837
|
+
description: 'Maximum number of Enterprise clusters that can be created.',
|
|
2838
|
+
example: 999
|
|
2839
|
+
},
|
|
2840
|
+
enterprise_clusters_available: {
|
|
2841
|
+
type: 'integer',
|
|
2842
|
+
description: 'Available number of Enterprise clusters that can be created.',
|
|
2843
|
+
example: 999
|
|
2844
|
+
},
|
|
2368
2845
|
fleets_max: {
|
|
2369
2846
|
type: 'integer',
|
|
2370
2847
|
minimum: 0,
|
|
@@ -2384,7 +2861,7 @@ export const PlatformQuotaSchema = {
|
|
|
2384
2861
|
type: 'array',
|
|
2385
2862
|
items: {
|
|
2386
2863
|
type: 'string',
|
|
2387
|
-
example: 'northamerica-central-
|
|
2864
|
+
example: 'northamerica-central-1a'
|
|
2388
2865
|
},
|
|
2389
2866
|
minItems: 1,
|
|
2390
2867
|
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
@@ -2426,6 +2903,8 @@ export const PlatformQuotaSchema = {
|
|
|
2426
2903
|
'basic_clusters_available',
|
|
2427
2904
|
'pro_clusters_max',
|
|
2428
2905
|
'pro_clusters_available',
|
|
2906
|
+
'enterprise_clusters_max',
|
|
2907
|
+
'enterprise_clusters_available',
|
|
2429
2908
|
'fleets_max',
|
|
2430
2909
|
'cluster_tiers',
|
|
2431
2910
|
'regions',
|
|
@@ -2699,6 +3178,73 @@ export const RegistryTagSchema = {
|
|
|
2699
3178
|
],
|
|
2700
3179
|
additionalProperties: false
|
|
2701
3180
|
};
|
|
3181
|
+
export const RoadmapItemCreateInputSchema = {
|
|
3182
|
+
type: 'object',
|
|
3183
|
+
properties: {
|
|
3184
|
+
text: {
|
|
3185
|
+
type: 'string',
|
|
3186
|
+
maxLength: 500,
|
|
3187
|
+
minLength: 1,
|
|
3188
|
+
description: 'Your suggestion in one or two sentences. It is reviewed before it appears on the roadmap.',
|
|
3189
|
+
example: 'Support for ARM nodes on Hetzner.'
|
|
3190
|
+
}
|
|
3191
|
+
},
|
|
3192
|
+
required: [
|
|
3193
|
+
'text'
|
|
3194
|
+
],
|
|
3195
|
+
additionalProperties: false
|
|
3196
|
+
};
|
|
3197
|
+
export const RoadmapItemSchema = {
|
|
3198
|
+
type: 'object',
|
|
3199
|
+
properties: {
|
|
3200
|
+
id: {
|
|
3201
|
+
type: 'string',
|
|
3202
|
+
description: 'Unique identifier of the roadmap item (Mongo ObjectId).',
|
|
3203
|
+
example: '60c72b2f9f1b2c001f8e4d3a'
|
|
3204
|
+
},
|
|
3205
|
+
text: {
|
|
3206
|
+
type: 'string',
|
|
3207
|
+
description: 'Short description of the roadmap item.',
|
|
3208
|
+
example: 'Support for ARM nodes on Hetzner.'
|
|
3209
|
+
},
|
|
3210
|
+
vote: {
|
|
3211
|
+
type: 'integer',
|
|
3212
|
+
nullable: true,
|
|
3213
|
+
description: 'The caller\'s vote on this item: -1 (down), 1 (up), 2 (double up), or null if the caller has not voted.',
|
|
3214
|
+
example: 1,
|
|
3215
|
+
enum: [
|
|
3216
|
+
-1,
|
|
3217
|
+
1,
|
|
3218
|
+
2
|
|
3219
|
+
]
|
|
3220
|
+
}
|
|
3221
|
+
},
|
|
3222
|
+
required: [
|
|
3223
|
+
'id',
|
|
3224
|
+
'text',
|
|
3225
|
+
'vote'
|
|
3226
|
+
],
|
|
3227
|
+
additionalProperties: false
|
|
3228
|
+
};
|
|
3229
|
+
export const RoadmapVoteInputSchema = {
|
|
3230
|
+
type: 'object',
|
|
3231
|
+
properties: {
|
|
3232
|
+
value: {
|
|
3233
|
+
type: 'integer',
|
|
3234
|
+
description: 'Vote value: -1 (down), 1 (up), or 2 (double up).',
|
|
3235
|
+
example: 1,
|
|
3236
|
+
enum: [
|
|
3237
|
+
-1,
|
|
3238
|
+
1,
|
|
3239
|
+
2
|
|
3240
|
+
]
|
|
3241
|
+
}
|
|
3242
|
+
},
|
|
3243
|
+
required: [
|
|
3244
|
+
'value'
|
|
3245
|
+
],
|
|
3246
|
+
additionalProperties: false
|
|
3247
|
+
};
|
|
2702
3248
|
export const TicketAttachmentSchema = {
|
|
2703
3249
|
type: 'object',
|
|
2704
3250
|
properties: {
|
|
@@ -2760,6 +3306,11 @@ export const TicketCreateInputSchema = {
|
|
|
2760
3306
|
subcategory: 'cluster-question',
|
|
2761
3307
|
cluster_id: '60c72b2f9f1b2c001f8e4d3a'
|
|
2762
3308
|
}
|
|
3309
|
+
},
|
|
3310
|
+
grant_support_access: {
|
|
3311
|
+
type: 'boolean',
|
|
3312
|
+
description: 'Grant Cloudfleet support staff access to the organization\'s resources while the ticket is open. Access cannot be revoked; it ends when the ticket is closed.',
|
|
3313
|
+
example: true
|
|
2763
3314
|
}
|
|
2764
3315
|
},
|
|
2765
3316
|
required: [
|
|
@@ -2768,172 +3319,6 @@ export const TicketCreateInputSchema = {
|
|
|
2768
3319
|
],
|
|
2769
3320
|
additionalProperties: false
|
|
2770
3321
|
};
|
|
2771
|
-
export const TicketListResponseSchema = {
|
|
2772
|
-
type: 'object',
|
|
2773
|
-
properties: {
|
|
2774
|
-
items: {
|
|
2775
|
-
type: 'array',
|
|
2776
|
-
items: {
|
|
2777
|
-
type: 'object',
|
|
2778
|
-
properties: {
|
|
2779
|
-
id: {
|
|
2780
|
-
type: 'string',
|
|
2781
|
-
description: 'Unique identifier of the ticket (Mongo ObjectId).',
|
|
2782
|
-
example: '60c72b2f9f1b2c001f8e4d3a'
|
|
2783
|
-
},
|
|
2784
|
-
status: {
|
|
2785
|
-
type: 'string',
|
|
2786
|
-
description: 'Current state of the ticket.',
|
|
2787
|
-
example: 'waiting_on_us',
|
|
2788
|
-
enum: [
|
|
2789
|
-
'waiting_on_us',
|
|
2790
|
-
'waiting_on_user',
|
|
2791
|
-
'closed'
|
|
2792
|
-
]
|
|
2793
|
-
},
|
|
2794
|
-
category: {
|
|
2795
|
-
type: 'string',
|
|
2796
|
-
description: 'Ticket category.',
|
|
2797
|
-
example: 'technical',
|
|
2798
|
-
enum: [
|
|
2799
|
-
'billing',
|
|
2800
|
-
'technical',
|
|
2801
|
-
'general'
|
|
2802
|
-
]
|
|
2803
|
-
},
|
|
2804
|
-
summary: {
|
|
2805
|
-
type: 'string',
|
|
2806
|
-
description: 'First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.',
|
|
2807
|
-
example: 'My cluster cannot reach the registry. Logs attached.'
|
|
2808
|
-
},
|
|
2809
|
-
closed_at: {
|
|
2810
|
-
type: 'string',
|
|
2811
|
-
format: 'date-time',
|
|
2812
|
-
nullable: true,
|
|
2813
|
-
description: 'Closure timestamp. Null while the ticket is open.',
|
|
2814
|
-
example: '2026-05-18T16:08:14.338Z'
|
|
2815
|
-
},
|
|
2816
|
-
date_created: {
|
|
2817
|
-
type: 'string',
|
|
2818
|
-
format: 'date-time',
|
|
2819
|
-
description: 'Creation date of the ticket. ISO 8601 UTC.',
|
|
2820
|
-
example: '2026-05-11T16:08:14.338Z'
|
|
2821
|
-
},
|
|
2822
|
-
date_updated: {
|
|
2823
|
-
type: 'string',
|
|
2824
|
-
format: 'date-time',
|
|
2825
|
-
description: 'Last update date of the ticket. ISO 8601 UTC.',
|
|
2826
|
-
example: '2026-05-11T16:08:14.338Z'
|
|
2827
|
-
},
|
|
2828
|
-
messages: {
|
|
2829
|
-
type: 'array',
|
|
2830
|
-
items: {
|
|
2831
|
-
type: 'object',
|
|
2832
|
-
properties: {
|
|
2833
|
-
id: {
|
|
2834
|
-
type: 'string',
|
|
2835
|
-
description: 'Unique identifier of the message (Mongo ObjectId).',
|
|
2836
|
-
example: '60c72b2f9f1b2c001f8e4d3b'
|
|
2837
|
-
},
|
|
2838
|
-
type: {
|
|
2839
|
-
type: 'string',
|
|
2840
|
-
description: 'Message type. Internal notes are filtered out of customer-facing responses.',
|
|
2841
|
-
example: 'customer_reply',
|
|
2842
|
-
enum: [
|
|
2843
|
-
'customer_reply',
|
|
2844
|
-
'agent_reply'
|
|
2845
|
-
]
|
|
2846
|
-
},
|
|
2847
|
-
body: {
|
|
2848
|
-
type: 'string',
|
|
2849
|
-
description: 'Message body in markdown.',
|
|
2850
|
-
example: 'Thanks — that resolved it on my side.'
|
|
2851
|
-
},
|
|
2852
|
-
author_first_name: {
|
|
2853
|
-
type: 'string',
|
|
2854
|
-
nullable: true,
|
|
2855
|
-
description: 'First name of the author. Null when not provided.',
|
|
2856
|
-
example: 'Jane'
|
|
2857
|
-
},
|
|
2858
|
-
author_last_name: {
|
|
2859
|
-
type: 'string',
|
|
2860
|
-
nullable: true,
|
|
2861
|
-
description: 'Last name of the author. Null when not provided.',
|
|
2862
|
-
example: 'Doe'
|
|
2863
|
-
},
|
|
2864
|
-
attachments: {
|
|
2865
|
-
type: 'array',
|
|
2866
|
-
items: {
|
|
2867
|
-
type: 'object',
|
|
2868
|
-
properties: {
|
|
2869
|
-
id: {
|
|
2870
|
-
type: 'string',
|
|
2871
|
-
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
2872
|
-
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
2873
|
-
},
|
|
2874
|
-
filename: {
|
|
2875
|
-
type: 'string',
|
|
2876
|
-
description: 'Original filename as uploaded.',
|
|
2877
|
-
example: 'debug.log'
|
|
2878
|
-
},
|
|
2879
|
-
content_type: {
|
|
2880
|
-
type: 'string',
|
|
2881
|
-
description: 'MIME content type of the attachment.',
|
|
2882
|
-
example: 'text/plain'
|
|
2883
|
-
},
|
|
2884
|
-
size: {
|
|
2885
|
-
type: 'integer',
|
|
2886
|
-
description: 'Size of the attachment in bytes.',
|
|
2887
|
-
example: 12345
|
|
2888
|
-
}
|
|
2889
|
-
},
|
|
2890
|
-
required: [
|
|
2891
|
-
'id',
|
|
2892
|
-
'filename',
|
|
2893
|
-
'content_type',
|
|
2894
|
-
'size'
|
|
2895
|
-
],
|
|
2896
|
-
additionalProperties: false
|
|
2897
|
-
},
|
|
2898
|
-
description: 'Attachments associated with this message.',
|
|
2899
|
-
example: []
|
|
2900
|
-
},
|
|
2901
|
-
date_created: {
|
|
2902
|
-
type: 'string',
|
|
2903
|
-
format: 'date-time',
|
|
2904
|
-
description: 'Creation date of the message. ISO 8601 UTC.',
|
|
2905
|
-
example: '2026-05-11T16:08:14.338Z'
|
|
2906
|
-
}
|
|
2907
|
-
},
|
|
2908
|
-
required: [
|
|
2909
|
-
'id',
|
|
2910
|
-
'type',
|
|
2911
|
-
'body',
|
|
2912
|
-
'date_created'
|
|
2913
|
-
],
|
|
2914
|
-
additionalProperties: false
|
|
2915
|
-
},
|
|
2916
|
-
description: 'Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.'
|
|
2917
|
-
}
|
|
2918
|
-
},
|
|
2919
|
-
required: [
|
|
2920
|
-
'id',
|
|
2921
|
-
'status',
|
|
2922
|
-
'category',
|
|
2923
|
-
'summary',
|
|
2924
|
-
'date_created',
|
|
2925
|
-
'date_updated'
|
|
2926
|
-
],
|
|
2927
|
-
additionalProperties: false
|
|
2928
|
-
},
|
|
2929
|
-
description: 'Tickets for the organization, ordered newest first. Messages are omitted from list responses.'
|
|
2930
|
-
}
|
|
2931
|
-
},
|
|
2932
|
-
required: [
|
|
2933
|
-
'items'
|
|
2934
|
-
],
|
|
2935
|
-
additionalProperties: false
|
|
2936
|
-
};
|
|
2937
3322
|
export const TicketMessageInputSchema = {
|
|
2938
3323
|
type: 'object',
|
|
2939
3324
|
properties: {
|
|
@@ -2975,11 +3360,13 @@ export const TicketMessageSchema = {
|
|
|
2975
3360
|
},
|
|
2976
3361
|
author_first_name: {
|
|
2977
3362
|
type: 'string',
|
|
3363
|
+
nullable: true,
|
|
2978
3364
|
description: 'First name of the author. Null when not provided.',
|
|
2979
3365
|
example: 'Jane'
|
|
2980
3366
|
},
|
|
2981
3367
|
author_last_name: {
|
|
2982
3368
|
type: 'string',
|
|
3369
|
+
nullable: true,
|
|
2983
3370
|
description: 'Last name of the author. Null when not provided.',
|
|
2984
3371
|
example: 'Doe'
|
|
2985
3372
|
},
|
|
@@ -3068,9 +3455,22 @@ export const TicketSchema = {
|
|
|
3068
3455
|
description: 'First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.',
|
|
3069
3456
|
example: 'My cluster cannot reach the registry. Logs attached.'
|
|
3070
3457
|
},
|
|
3458
|
+
support_access_granted: {
|
|
3459
|
+
type: 'boolean',
|
|
3460
|
+
description: 'Whether Cloudfleet support staff currently have access to the organization\'s resources. True once access is granted and until the ticket is closed.',
|
|
3461
|
+
example: true
|
|
3462
|
+
},
|
|
3463
|
+
support_access_granted_at: {
|
|
3464
|
+
type: 'string',
|
|
3465
|
+
format: 'date-time',
|
|
3466
|
+
nullable: true,
|
|
3467
|
+
description: 'When support access was granted. Null if it never was. Kept after the ticket is closed.',
|
|
3468
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
3469
|
+
},
|
|
3071
3470
|
closed_at: {
|
|
3072
3471
|
type: 'string',
|
|
3073
3472
|
format: 'date-time',
|
|
3473
|
+
nullable: true,
|
|
3074
3474
|
description: 'Closure timestamp. Null while the ticket is open.',
|
|
3075
3475
|
example: '2026-05-18T16:08:14.338Z'
|
|
3076
3476
|
},
|
|
@@ -3180,6 +3580,8 @@ export const TicketSchema = {
|
|
|
3180
3580
|
'status',
|
|
3181
3581
|
'category',
|
|
3182
3582
|
'summary',
|
|
3583
|
+
'support_access_granted',
|
|
3584
|
+
'support_access_granted_at',
|
|
3183
3585
|
'date_created',
|
|
3184
3586
|
'date_updated'
|
|
3185
3587
|
],
|
|
@@ -3295,12 +3697,21 @@ export const UsageFacetsSchema = {
|
|
|
3295
3697
|
product: {
|
|
3296
3698
|
type: 'array',
|
|
3297
3699
|
items: {
|
|
3298
|
-
type: 'string'
|
|
3700
|
+
type: 'string',
|
|
3701
|
+
enum: [
|
|
3702
|
+
'cfke_controlplane_basic',
|
|
3703
|
+
'cfke_controlplane_pro',
|
|
3704
|
+
'cfke_controlplane_enterprise',
|
|
3705
|
+
'cfke_connected_nodes_basic',
|
|
3706
|
+
'cfke_connected_nodes_pro',
|
|
3707
|
+
'cfke_connected_nodes_enterprise',
|
|
3708
|
+
'cfcr_storage'
|
|
3709
|
+
]
|
|
3299
3710
|
},
|
|
3300
3711
|
description: 'List of unique products',
|
|
3301
3712
|
example: [
|
|
3302
|
-
'
|
|
3303
|
-
'
|
|
3713
|
+
'cfke_controlplane_pro',
|
|
3714
|
+
'cfke_connected_nodes_pro'
|
|
3304
3715
|
]
|
|
3305
3716
|
}
|
|
3306
3717
|
},
|
|
@@ -3327,7 +3738,16 @@ export const UsageResponseSchema = {
|
|
|
3327
3738
|
product: {
|
|
3328
3739
|
type: 'string',
|
|
3329
3740
|
description: 'The product the usage is associated with',
|
|
3330
|
-
example: '
|
|
3741
|
+
example: 'cfke_controlplane_pro',
|
|
3742
|
+
enum: [
|
|
3743
|
+
'cfke_controlplane_basic',
|
|
3744
|
+
'cfke_controlplane_pro',
|
|
3745
|
+
'cfke_controlplane_enterprise',
|
|
3746
|
+
'cfke_connected_nodes_basic',
|
|
3747
|
+
'cfke_connected_nodes_pro',
|
|
3748
|
+
'cfke_connected_nodes_enterprise',
|
|
3749
|
+
'cfcr_storage'
|
|
3750
|
+
]
|
|
3331
3751
|
},
|
|
3332
3752
|
value: {
|
|
3333
3753
|
type: 'number',
|
|
@@ -3375,12 +3795,21 @@ export const UsageResponseSchema = {
|
|
|
3375
3795
|
product: {
|
|
3376
3796
|
type: 'array',
|
|
3377
3797
|
items: {
|
|
3378
|
-
type: 'string'
|
|
3798
|
+
type: 'string',
|
|
3799
|
+
enum: [
|
|
3800
|
+
'cfke_controlplane_basic',
|
|
3801
|
+
'cfke_controlplane_pro',
|
|
3802
|
+
'cfke_controlplane_enterprise',
|
|
3803
|
+
'cfke_connected_nodes_basic',
|
|
3804
|
+
'cfke_connected_nodes_pro',
|
|
3805
|
+
'cfke_connected_nodes_enterprise',
|
|
3806
|
+
'cfcr_storage'
|
|
3807
|
+
]
|
|
3379
3808
|
},
|
|
3380
3809
|
description: 'List of unique products',
|
|
3381
3810
|
example: [
|
|
3382
|
-
'
|
|
3383
|
-
'
|
|
3811
|
+
'cfke_controlplane_pro',
|
|
3812
|
+
'cfke_connected_nodes_pro'
|
|
3384
3813
|
]
|
|
3385
3814
|
}
|
|
3386
3815
|
},
|
|
@@ -3410,7 +3839,16 @@ export const UsageSchema = {
|
|
|
3410
3839
|
product: {
|
|
3411
3840
|
type: 'string',
|
|
3412
3841
|
description: 'The product the usage is associated with',
|
|
3413
|
-
example: '
|
|
3842
|
+
example: 'cfke_controlplane_pro',
|
|
3843
|
+
enum: [
|
|
3844
|
+
'cfke_controlplane_basic',
|
|
3845
|
+
'cfke_controlplane_pro',
|
|
3846
|
+
'cfke_controlplane_enterprise',
|
|
3847
|
+
'cfke_connected_nodes_basic',
|
|
3848
|
+
'cfke_connected_nodes_pro',
|
|
3849
|
+
'cfke_connected_nodes_enterprise',
|
|
3850
|
+
'cfcr_storage'
|
|
3851
|
+
]
|
|
3414
3852
|
},
|
|
3415
3853
|
value: {
|
|
3416
3854
|
type: 'number',
|
|
@@ -3473,24 +3911,6 @@ export const UserCreateInputSchema = {
|
|
|
3473
3911
|
type: 'string',
|
|
3474
3912
|
minLength: 8,
|
|
3475
3913
|
description: 'User password. Must be at least 8 characters long.'
|
|
3476
|
-
},
|
|
3477
|
-
status: {
|
|
3478
|
-
type: 'string',
|
|
3479
|
-
description: 'Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.',
|
|
3480
|
-
example: 'active',
|
|
3481
|
-
enum: [
|
|
3482
|
-
'active',
|
|
3483
|
-
'inactive'
|
|
3484
|
-
]
|
|
3485
|
-
},
|
|
3486
|
-
role: {
|
|
3487
|
-
type: 'string',
|
|
3488
|
-
description: 'User role. Can be \'Administrator\', \'User\'.',
|
|
3489
|
-
example: 'User',
|
|
3490
|
-
enum: [
|
|
3491
|
-
'Administrator',
|
|
3492
|
-
'User'
|
|
3493
|
-
]
|
|
3494
3914
|
}
|
|
3495
3915
|
},
|
|
3496
3916
|
required: [
|