@cloudfleet/sdk 0.0.1-200be61 → 0.0.1-20bd5c1
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 +526 -574
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -1
- package/dist/@tanstack/react-query.gen.js +534 -377
- 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/schemas.gen.d.ts +913 -256
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +1869 -356
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +271 -208
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +403 -310
- package/dist/sdk.gen.js.map +1 -1
- package/dist/types.gen.d.ts +1433 -805
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3588 -1446
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1310 -348
- package/dist/zod.gen.js.map +1 -1
- package/package.json +10 -13
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
|
],
|
|
@@ -358,24 +379,8 @@ export const ChartSchema = {
|
|
|
358
379
|
},
|
|
359
380
|
status: {
|
|
360
381
|
type: 'string',
|
|
361
|
-
description: 'Status of the chart deployment.',
|
|
362
|
-
example: '
|
|
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
|
-
]
|
|
382
|
+
description: 'Status of the chart deployment (Flux HelmRelease Ready condition reason, e.g. InstallSucceeded, UpgradeFailed, Progressing).',
|
|
383
|
+
example: 'InstallSucceeded'
|
|
379
384
|
},
|
|
380
385
|
version_current: {
|
|
381
386
|
type: 'string',
|
|
@@ -446,22 +451,12 @@ export const ClusterCreateInputSchema = {
|
|
|
446
451
|
tier: {
|
|
447
452
|
type: 'string',
|
|
448
453
|
description: 'Tier of the cluster.',
|
|
454
|
+
default: 'basic',
|
|
449
455
|
example: 'pro',
|
|
450
456
|
enum: [
|
|
451
457
|
'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'
|
|
458
|
+
'pro',
|
|
459
|
+
'enterprise'
|
|
465
460
|
]
|
|
466
461
|
},
|
|
467
462
|
version_channel: {
|
|
@@ -469,20 +464,105 @@ export const ClusterCreateInputSchema = {
|
|
|
469
464
|
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
465
|
description: 'Version of the kubernetes cluster.',
|
|
471
466
|
default: '1.x.x-cfke.x',
|
|
472
|
-
example: '1.x.x-cfke.x'
|
|
467
|
+
example: '1.x.x-cfke.x'
|
|
468
|
+
},
|
|
469
|
+
release_channel: {
|
|
470
|
+
type: 'string',
|
|
471
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
472
|
+
default: 'rapid',
|
|
473
|
+
example: 'rapid',
|
|
473
474
|
enum: [
|
|
474
|
-
'
|
|
475
|
-
'
|
|
476
|
-
'
|
|
477
|
-
'1.33.x-cfke.x'
|
|
475
|
+
'rapid',
|
|
476
|
+
'stable',
|
|
477
|
+
'extended'
|
|
478
478
|
]
|
|
479
|
+
},
|
|
480
|
+
features: {
|
|
481
|
+
type: 'object',
|
|
482
|
+
properties: {
|
|
483
|
+
gpu_sharing_strategy: {
|
|
484
|
+
type: 'string',
|
|
485
|
+
description: 'GPU sharing strategy.',
|
|
486
|
+
default: 'none',
|
|
487
|
+
example: 'none',
|
|
488
|
+
enum: [
|
|
489
|
+
'none',
|
|
490
|
+
'mps',
|
|
491
|
+
'time_slicing'
|
|
492
|
+
]
|
|
493
|
+
},
|
|
494
|
+
gpu_max_shared_clients_per_gpu: {
|
|
495
|
+
type: 'integer',
|
|
496
|
+
minimum: 2,
|
|
497
|
+
maximum: 48,
|
|
498
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
499
|
+
default: 4,
|
|
500
|
+
example: 10
|
|
501
|
+
},
|
|
502
|
+
cilium_socket_lb_host_namespace_only: {
|
|
503
|
+
type: 'boolean',
|
|
504
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
505
|
+
example: false
|
|
506
|
+
}
|
|
507
|
+
},
|
|
508
|
+
additionalProperties: false,
|
|
509
|
+
description: 'Cluster feature toggles.',
|
|
510
|
+
default: {
|
|
511
|
+
gpu_sharing_strategy: 'none',
|
|
512
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
513
|
+
cilium_socket_lb_host_namespace_only: false
|
|
514
|
+
}
|
|
515
|
+
},
|
|
516
|
+
region: {
|
|
517
|
+
type: 'string',
|
|
518
|
+
description: 'Cloudfleet control plane region. This field can not be updated after creation.',
|
|
519
|
+
example: 'europe-central-1a'
|
|
520
|
+
},
|
|
521
|
+
networking: {
|
|
522
|
+
type: 'object',
|
|
523
|
+
properties: {
|
|
524
|
+
pod_cidr: {
|
|
525
|
+
type: 'string',
|
|
526
|
+
description: 'CIDR block for pod IPs.',
|
|
527
|
+
default: '10.244.0.0/16'
|
|
528
|
+
},
|
|
529
|
+
service_cidr: {
|
|
530
|
+
type: 'string',
|
|
531
|
+
description: 'CIDR block for service IPs.',
|
|
532
|
+
default: '10.96.0.0/12'
|
|
533
|
+
},
|
|
534
|
+
dual_stack: {
|
|
535
|
+
type: 'boolean',
|
|
536
|
+
description: 'Enable IPv4+IPv6 dual-stack networking.'
|
|
537
|
+
},
|
|
538
|
+
pod_cidr_v6: {
|
|
539
|
+
type: 'string',
|
|
540
|
+
description: 'IPv6 pod CIDR. Requires dual_stack.',
|
|
541
|
+
default: '2001:db8:1:2::/48'
|
|
542
|
+
},
|
|
543
|
+
service_cidr_v6: {
|
|
544
|
+
type: 'string',
|
|
545
|
+
description: 'IPv6 service CIDR. Requires dual_stack.',
|
|
546
|
+
default: '2001:db8:1:1::/112'
|
|
547
|
+
}
|
|
548
|
+
},
|
|
549
|
+
additionalProperties: false,
|
|
550
|
+
description: 'Cluster networking configuration. Immutable after creation.',
|
|
551
|
+
default: {
|
|
552
|
+
pod_cidr: '10.244.0.0/16',
|
|
553
|
+
service_cidr: '10.96.0.0/12',
|
|
554
|
+
dual_stack: false,
|
|
555
|
+
pod_cidr_v6: '2001:db8:1:2::/48',
|
|
556
|
+
service_cidr_v6: '2001:db8:1:1::/112'
|
|
557
|
+
}
|
|
479
558
|
}
|
|
480
559
|
},
|
|
481
560
|
required: [
|
|
482
561
|
'name',
|
|
483
|
-
'
|
|
562
|
+
'region'
|
|
484
563
|
],
|
|
485
|
-
additionalProperties: false
|
|
564
|
+
additionalProperties: false,
|
|
565
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
486
566
|
};
|
|
487
567
|
export const ClusterJoinInformationSchema = {
|
|
488
568
|
type: 'object',
|
|
@@ -503,11 +583,21 @@ export const ClusterJoinInformationSchema = {
|
|
|
503
583
|
description: 'Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.',
|
|
504
584
|
example: '10.96.0.10'
|
|
505
585
|
},
|
|
586
|
+
pod_cidr: {
|
|
587
|
+
type: 'string',
|
|
588
|
+
description: 'Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.',
|
|
589
|
+
example: '10.244.0.0/16'
|
|
590
|
+
},
|
|
506
591
|
auth_key: {
|
|
507
592
|
type: 'string',
|
|
508
593
|
description: 'Authentication key for the cluster.',
|
|
509
594
|
example: 'tskey-auth-kBV8wr1dk911CNTRL-...'
|
|
510
595
|
},
|
|
596
|
+
login_server: {
|
|
597
|
+
type: 'string',
|
|
598
|
+
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.',
|
|
599
|
+
example: 'https://415026b6-f00f-44f8-968d-fc6ef4d0fc6d.fabric.europe-central-1a.cfke.io'
|
|
600
|
+
},
|
|
511
601
|
bootstrap_token: {
|
|
512
602
|
type: 'string',
|
|
513
603
|
description: 'Bootstrap token for the cluster.',
|
|
@@ -578,7 +668,9 @@ export const ClusterJoinInformationSchema = {
|
|
|
578
668
|
'certificate_authority',
|
|
579
669
|
'endpoint',
|
|
580
670
|
'cluster_dns',
|
|
671
|
+
'pod_cidr',
|
|
581
672
|
'auth_key',
|
|
673
|
+
'login_server',
|
|
582
674
|
'bootstrap_token',
|
|
583
675
|
'versions',
|
|
584
676
|
'third_party_api_access_config'
|
|
@@ -599,24 +691,123 @@ export const ClusterSchema = {
|
|
|
599
691
|
tier: {
|
|
600
692
|
type: 'string',
|
|
601
693
|
description: 'Tier of the cluster.',
|
|
694
|
+
default: 'basic',
|
|
602
695
|
example: 'pro',
|
|
603
696
|
enum: [
|
|
604
697
|
'basic',
|
|
605
|
-
'pro'
|
|
698
|
+
'pro',
|
|
699
|
+
'enterprise'
|
|
606
700
|
]
|
|
607
701
|
},
|
|
608
|
-
|
|
702
|
+
version_channel: {
|
|
609
703
|
type: 'string',
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
704
|
+
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-]+)*))?$',
|
|
705
|
+
description: 'Version of the kubernetes cluster.',
|
|
706
|
+
default: '1.x.x-cfke.x',
|
|
707
|
+
example: '1.x.x-cfke.x'
|
|
708
|
+
},
|
|
709
|
+
release_channel: {
|
|
710
|
+
type: 'string',
|
|
711
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
712
|
+
default: 'rapid',
|
|
713
|
+
example: 'rapid',
|
|
613
714
|
enum: [
|
|
614
|
-
'
|
|
615
|
-
'
|
|
616
|
-
'
|
|
617
|
-
'northamerica-central-1a'
|
|
715
|
+
'rapid',
|
|
716
|
+
'stable',
|
|
717
|
+
'extended'
|
|
618
718
|
]
|
|
619
719
|
},
|
|
720
|
+
features: {
|
|
721
|
+
type: 'object',
|
|
722
|
+
properties: {
|
|
723
|
+
gpu_sharing_strategy: {
|
|
724
|
+
type: 'string',
|
|
725
|
+
description: 'GPU sharing strategy.',
|
|
726
|
+
default: 'none',
|
|
727
|
+
example: 'none',
|
|
728
|
+
enum: [
|
|
729
|
+
'none',
|
|
730
|
+
'mps',
|
|
731
|
+
'time_slicing'
|
|
732
|
+
]
|
|
733
|
+
},
|
|
734
|
+
gpu_max_shared_clients_per_gpu: {
|
|
735
|
+
type: 'integer',
|
|
736
|
+
minimum: 2,
|
|
737
|
+
maximum: 48,
|
|
738
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
739
|
+
default: 4,
|
|
740
|
+
example: 10
|
|
741
|
+
},
|
|
742
|
+
cilium_socket_lb_host_namespace_only: {
|
|
743
|
+
type: 'boolean',
|
|
744
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
745
|
+
example: false
|
|
746
|
+
}
|
|
747
|
+
},
|
|
748
|
+
required: [
|
|
749
|
+
'gpu_sharing_strategy',
|
|
750
|
+
'gpu_max_shared_clients_per_gpu',
|
|
751
|
+
'cilium_socket_lb_host_namespace_only'
|
|
752
|
+
],
|
|
753
|
+
additionalProperties: false,
|
|
754
|
+
description: 'Cluster feature toggles.',
|
|
755
|
+
default: {
|
|
756
|
+
gpu_sharing_strategy: 'none',
|
|
757
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
758
|
+
cilium_socket_lb_host_namespace_only: false
|
|
759
|
+
}
|
|
760
|
+
},
|
|
761
|
+
region: {
|
|
762
|
+
type: 'string',
|
|
763
|
+
description: 'Cloudfleet control plane region. This field can not be updated after creation.',
|
|
764
|
+
example: 'europe-central-1a'
|
|
765
|
+
},
|
|
766
|
+
networking: {
|
|
767
|
+
type: 'object',
|
|
768
|
+
properties: {
|
|
769
|
+
pod_cidr: {
|
|
770
|
+
type: 'string',
|
|
771
|
+
description: 'CIDR block for pod IPs.',
|
|
772
|
+
default: '10.244.0.0/16'
|
|
773
|
+
},
|
|
774
|
+
service_cidr: {
|
|
775
|
+
type: 'string',
|
|
776
|
+
description: 'CIDR block for service IPs.',
|
|
777
|
+
default: '10.96.0.0/12'
|
|
778
|
+
},
|
|
779
|
+
dual_stack: {
|
|
780
|
+
type: 'boolean',
|
|
781
|
+
description: 'Enable IPv4+IPv6 dual-stack networking.'
|
|
782
|
+
},
|
|
783
|
+
pod_cidr_v6: {
|
|
784
|
+
type: 'string',
|
|
785
|
+
description: 'IPv6 pod CIDR. Requires dual_stack.',
|
|
786
|
+
default: '2001:db8:1:2::/48'
|
|
787
|
+
},
|
|
788
|
+
service_cidr_v6: {
|
|
789
|
+
type: 'string',
|
|
790
|
+
description: 'IPv6 service CIDR. Requires dual_stack.',
|
|
791
|
+
default: '2001:db8:1:1::/112'
|
|
792
|
+
}
|
|
793
|
+
},
|
|
794
|
+
required: [
|
|
795
|
+
'pod_cidr',
|
|
796
|
+
'service_cidr',
|
|
797
|
+
'dual_stack',
|
|
798
|
+
'pod_cidr_v6',
|
|
799
|
+
'service_cidr_v6'
|
|
800
|
+
],
|
|
801
|
+
additionalProperties: false,
|
|
802
|
+
description: 'Cluster networking configuration. Immutable after creation.',
|
|
803
|
+
default: {
|
|
804
|
+
pod_cidr: '10.244.0.0/16',
|
|
805
|
+
service_cidr: '10.96.0.0/12',
|
|
806
|
+
dual_stack: false,
|
|
807
|
+
pod_cidr_v6: '2001:db8:1:2::/48',
|
|
808
|
+
service_cidr_v6: '2001:db8:1:1::/112'
|
|
809
|
+
}
|
|
810
|
+
},
|
|
620
811
|
id: {
|
|
621
812
|
type: 'string',
|
|
622
813
|
format: 'uuid',
|
|
@@ -625,16 +816,13 @@ export const ClusterSchema = {
|
|
|
625
816
|
},
|
|
626
817
|
status: {
|
|
627
818
|
type: 'string',
|
|
628
|
-
description: 'Status of the cluster.
|
|
629
|
-
example: '
|
|
819
|
+
description: 'Status of the cluster.',
|
|
820
|
+
example: 'deployed',
|
|
630
821
|
enum: [
|
|
631
|
-
'active',
|
|
632
|
-
'disabled',
|
|
633
|
-
'deleted',
|
|
634
822
|
'creating',
|
|
635
823
|
'deployed',
|
|
636
|
-
'
|
|
637
|
-
'
|
|
824
|
+
'updating',
|
|
825
|
+
'disabled'
|
|
638
826
|
]
|
|
639
827
|
},
|
|
640
828
|
endpoint: {
|
|
@@ -642,8 +830,8 @@ export const ClusterSchema = {
|
|
|
642
830
|
{
|
|
643
831
|
type: 'string',
|
|
644
832
|
format: 'uri',
|
|
645
|
-
description: 'URL signed by
|
|
646
|
-
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
833
|
+
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.',
|
|
834
|
+
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
647
835
|
},
|
|
648
836
|
{
|
|
649
837
|
type: 'string',
|
|
@@ -658,7 +846,7 @@ export const ClusterSchema = {
|
|
|
658
846
|
{
|
|
659
847
|
type: 'string',
|
|
660
848
|
format: 'uri',
|
|
661
|
-
description: '
|
|
849
|
+
description: 'Deprecated alias of `endpoint`; retained for backward compatibility.',
|
|
662
850
|
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
663
851
|
},
|
|
664
852
|
{
|
|
@@ -693,21 +881,22 @@ export const ClusterSchema = {
|
|
|
693
881
|
type: 'boolean',
|
|
694
882
|
description: 'Indicates if the cluster is ready to be used.',
|
|
695
883
|
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
884
|
}
|
|
703
885
|
},
|
|
704
886
|
required: [
|
|
705
887
|
'name',
|
|
706
888
|
'tier',
|
|
889
|
+
'version_channel',
|
|
890
|
+
'release_channel',
|
|
891
|
+
'features',
|
|
892
|
+
'region',
|
|
893
|
+
'networking',
|
|
707
894
|
'id',
|
|
708
|
-
'status'
|
|
895
|
+
'status',
|
|
896
|
+
'ready'
|
|
709
897
|
],
|
|
710
|
-
additionalProperties: false
|
|
898
|
+
additionalProperties: false,
|
|
899
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
711
900
|
};
|
|
712
901
|
export const ClusterUpdateInputSchema = {
|
|
713
902
|
type: 'object',
|
|
@@ -723,23 +912,74 @@ export const ClusterUpdateInputSchema = {
|
|
|
723
912
|
tier: {
|
|
724
913
|
type: 'string',
|
|
725
914
|
description: 'Tier of the cluster.',
|
|
915
|
+
default: 'basic',
|
|
726
916
|
example: 'pro',
|
|
727
917
|
enum: [
|
|
728
918
|
'basic',
|
|
729
|
-
'pro'
|
|
919
|
+
'pro',
|
|
920
|
+
'enterprise'
|
|
730
921
|
]
|
|
731
922
|
},
|
|
732
923
|
version_channel: {
|
|
733
924
|
type: 'string',
|
|
734
925
|
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
926
|
description: 'Version of the kubernetes cluster.',
|
|
927
|
+
default: '1.x.x-cfke.x',
|
|
736
928
|
example: '1.x.x-cfke.x'
|
|
929
|
+
},
|
|
930
|
+
release_channel: {
|
|
931
|
+
type: 'string',
|
|
932
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
933
|
+
default: 'rapid',
|
|
934
|
+
example: 'rapid',
|
|
935
|
+
enum: [
|
|
936
|
+
'rapid',
|
|
937
|
+
'stable',
|
|
938
|
+
'extended'
|
|
939
|
+
]
|
|
940
|
+
},
|
|
941
|
+
features: {
|
|
942
|
+
type: 'object',
|
|
943
|
+
properties: {
|
|
944
|
+
gpu_sharing_strategy: {
|
|
945
|
+
type: 'string',
|
|
946
|
+
description: 'GPU sharing strategy.',
|
|
947
|
+
default: 'none',
|
|
948
|
+
example: 'none',
|
|
949
|
+
enum: [
|
|
950
|
+
'none',
|
|
951
|
+
'mps',
|
|
952
|
+
'time_slicing'
|
|
953
|
+
]
|
|
954
|
+
},
|
|
955
|
+
gpu_max_shared_clients_per_gpu: {
|
|
956
|
+
type: 'integer',
|
|
957
|
+
minimum: 2,
|
|
958
|
+
maximum: 48,
|
|
959
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
960
|
+
default: 4,
|
|
961
|
+
example: 10
|
|
962
|
+
},
|
|
963
|
+
cilium_socket_lb_host_namespace_only: {
|
|
964
|
+
type: 'boolean',
|
|
965
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
966
|
+
example: false
|
|
967
|
+
}
|
|
968
|
+
},
|
|
969
|
+
additionalProperties: false,
|
|
970
|
+
description: 'Cluster feature toggles.',
|
|
971
|
+
default: {
|
|
972
|
+
gpu_sharing_strategy: 'none',
|
|
973
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
974
|
+
cilium_socket_lb_host_namespace_only: false
|
|
975
|
+
}
|
|
737
976
|
}
|
|
738
977
|
},
|
|
739
978
|
required: [
|
|
740
|
-
'
|
|
979
|
+
'name'
|
|
741
980
|
],
|
|
742
|
-
additionalProperties: false
|
|
981
|
+
additionalProperties: false,
|
|
982
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
743
983
|
};
|
|
744
984
|
export const FleetCreateInputSchema = {
|
|
745
985
|
type: 'object',
|
|
@@ -748,15 +988,12 @@ export const FleetCreateInputSchema = {
|
|
|
748
988
|
type: 'object',
|
|
749
989
|
properties: {
|
|
750
990
|
cpu: {
|
|
751
|
-
type: '
|
|
752
|
-
format: 'float',
|
|
991
|
+
type: 'integer',
|
|
753
992
|
minimum: 0,
|
|
754
|
-
|
|
993
|
+
maximum: 100000,
|
|
994
|
+
description: 'CPU limit in cores. Maximum 100,000.'
|
|
755
995
|
}
|
|
756
996
|
},
|
|
757
|
-
required: [
|
|
758
|
-
'cpu'
|
|
759
|
-
],
|
|
760
997
|
additionalProperties: false,
|
|
761
998
|
description: 'Limits define a set of bounds for provisioning capacity.'
|
|
762
999
|
},
|
|
@@ -764,16 +1001,17 @@ export const FleetCreateInputSchema = {
|
|
|
764
1001
|
type: 'object',
|
|
765
1002
|
properties: {
|
|
766
1003
|
enabled: {
|
|
767
|
-
type: 'boolean'
|
|
768
|
-
default: true
|
|
1004
|
+
type: 'boolean'
|
|
769
1005
|
},
|
|
770
1006
|
project: {
|
|
771
1007
|
type: 'string',
|
|
772
|
-
|
|
1008
|
+
pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
|
|
1009
|
+
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.',
|
|
1010
|
+
example: 'my-cloudfleet-project'
|
|
773
1011
|
}
|
|
774
1012
|
},
|
|
775
1013
|
required: [
|
|
776
|
-
'
|
|
1014
|
+
'enabled'
|
|
777
1015
|
],
|
|
778
1016
|
additionalProperties: false
|
|
779
1017
|
},
|
|
@@ -781,16 +1019,18 @@ export const FleetCreateInputSchema = {
|
|
|
781
1019
|
type: 'object',
|
|
782
1020
|
properties: {
|
|
783
1021
|
enabled: {
|
|
784
|
-
type: 'boolean'
|
|
785
|
-
default: true
|
|
1022
|
+
type: 'boolean'
|
|
786
1023
|
},
|
|
787
1024
|
apiKey: {
|
|
788
1025
|
type: 'string',
|
|
789
|
-
|
|
1026
|
+
maxLength: 64,
|
|
1027
|
+
minLength: 64,
|
|
1028
|
+
pattern: '^([A-Za-z0-9]{64}|\\*{64})$',
|
|
1029
|
+
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
1030
|
}
|
|
791
1031
|
},
|
|
792
1032
|
required: [
|
|
793
|
-
'
|
|
1033
|
+
'enabled'
|
|
794
1034
|
],
|
|
795
1035
|
additionalProperties: false
|
|
796
1036
|
},
|
|
@@ -798,19 +1038,359 @@ export const FleetCreateInputSchema = {
|
|
|
798
1038
|
type: 'object',
|
|
799
1039
|
properties: {
|
|
800
1040
|
enabled: {
|
|
801
|
-
type: 'boolean'
|
|
802
|
-
default: true
|
|
1041
|
+
type: 'boolean'
|
|
803
1042
|
},
|
|
804
1043
|
controllerRoleArn: {
|
|
805
1044
|
type: 'string',
|
|
806
|
-
|
|
1045
|
+
pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
|
|
1046
|
+
description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
|
|
1047
|
+
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
807
1048
|
}
|
|
808
1049
|
},
|
|
809
1050
|
required: [
|
|
810
|
-
'
|
|
1051
|
+
'enabled'
|
|
811
1052
|
],
|
|
812
1053
|
additionalProperties: false
|
|
813
1054
|
},
|
|
1055
|
+
constraints: {
|
|
1056
|
+
type: 'object',
|
|
1057
|
+
properties: {
|
|
1058
|
+
'karpenter.sh/capacity-type': {
|
|
1059
|
+
type: 'array',
|
|
1060
|
+
items: {
|
|
1061
|
+
type: 'string',
|
|
1062
|
+
enum: [
|
|
1063
|
+
'on-demand',
|
|
1064
|
+
'spot'
|
|
1065
|
+
]
|
|
1066
|
+
},
|
|
1067
|
+
minItems: 1,
|
|
1068
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1069
|
+
default: [
|
|
1070
|
+
'on-demand',
|
|
1071
|
+
'spot'
|
|
1072
|
+
]
|
|
1073
|
+
},
|
|
1074
|
+
'kubernetes.io/arch': {
|
|
1075
|
+
type: 'array',
|
|
1076
|
+
items: {
|
|
1077
|
+
type: 'string',
|
|
1078
|
+
enum: [
|
|
1079
|
+
'amd64',
|
|
1080
|
+
'arm64'
|
|
1081
|
+
]
|
|
1082
|
+
},
|
|
1083
|
+
minItems: 1,
|
|
1084
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1085
|
+
default: [
|
|
1086
|
+
'amd64'
|
|
1087
|
+
]
|
|
1088
|
+
},
|
|
1089
|
+
'cfke.io/instance-family': {
|
|
1090
|
+
type: 'array',
|
|
1091
|
+
items: {
|
|
1092
|
+
type: 'string',
|
|
1093
|
+
enum: [
|
|
1094
|
+
'a1',
|
|
1095
|
+
'a2',
|
|
1096
|
+
'a3',
|
|
1097
|
+
'a4',
|
|
1098
|
+
'c1',
|
|
1099
|
+
'c2',
|
|
1100
|
+
'c2d',
|
|
1101
|
+
'c3',
|
|
1102
|
+
'c3d',
|
|
1103
|
+
'c4',
|
|
1104
|
+
'c4a',
|
|
1105
|
+
'c4d',
|
|
1106
|
+
'c5',
|
|
1107
|
+
'c5a',
|
|
1108
|
+
'c5ad',
|
|
1109
|
+
'c5d',
|
|
1110
|
+
'c5n',
|
|
1111
|
+
'c6a',
|
|
1112
|
+
'c6g',
|
|
1113
|
+
'c6gd',
|
|
1114
|
+
'c6gn',
|
|
1115
|
+
'c6i',
|
|
1116
|
+
'c6id',
|
|
1117
|
+
'c6in',
|
|
1118
|
+
'c7a',
|
|
1119
|
+
'c7g',
|
|
1120
|
+
'c7gd',
|
|
1121
|
+
'c7gn',
|
|
1122
|
+
'c7i',
|
|
1123
|
+
'c7i-flex',
|
|
1124
|
+
'c8g',
|
|
1125
|
+
'c8gd',
|
|
1126
|
+
'cax',
|
|
1127
|
+
'ccx',
|
|
1128
|
+
'cpx',
|
|
1129
|
+
'cx',
|
|
1130
|
+
'd2',
|
|
1131
|
+
'd3',
|
|
1132
|
+
'd3en',
|
|
1133
|
+
'dl1',
|
|
1134
|
+
'dl2q',
|
|
1135
|
+
'e2',
|
|
1136
|
+
'f1',
|
|
1137
|
+
'f2',
|
|
1138
|
+
'g1',
|
|
1139
|
+
'g2',
|
|
1140
|
+
'g4ad',
|
|
1141
|
+
'g4dn',
|
|
1142
|
+
'g5',
|
|
1143
|
+
'g5g',
|
|
1144
|
+
'g6',
|
|
1145
|
+
'g6e',
|
|
1146
|
+
'gr6',
|
|
1147
|
+
'h1',
|
|
1148
|
+
'h3',
|
|
1149
|
+
'hpc6a',
|
|
1150
|
+
'hpc6id',
|
|
1151
|
+
'hpc7a',
|
|
1152
|
+
'hpc7g',
|
|
1153
|
+
'i2',
|
|
1154
|
+
'i3',
|
|
1155
|
+
'i3en',
|
|
1156
|
+
'i4g',
|
|
1157
|
+
'i4i',
|
|
1158
|
+
'i7i',
|
|
1159
|
+
'i7ie',
|
|
1160
|
+
'i8g',
|
|
1161
|
+
'im4gn',
|
|
1162
|
+
'inf1',
|
|
1163
|
+
'inf2',
|
|
1164
|
+
'is4gen',
|
|
1165
|
+
'm1',
|
|
1166
|
+
'm2',
|
|
1167
|
+
'm3',
|
|
1168
|
+
'm4',
|
|
1169
|
+
'm5',
|
|
1170
|
+
'm5a',
|
|
1171
|
+
'm5ad',
|
|
1172
|
+
'm5d',
|
|
1173
|
+
'm5dn',
|
|
1174
|
+
'm5n',
|
|
1175
|
+
'm5zn',
|
|
1176
|
+
'm6a',
|
|
1177
|
+
'm6g',
|
|
1178
|
+
'm6gd',
|
|
1179
|
+
'm6i',
|
|
1180
|
+
'm6id',
|
|
1181
|
+
'm6idn',
|
|
1182
|
+
'm6in',
|
|
1183
|
+
'm7a',
|
|
1184
|
+
'm7g',
|
|
1185
|
+
'm7gd',
|
|
1186
|
+
'm7i',
|
|
1187
|
+
'm7i-flex',
|
|
1188
|
+
'm8g',
|
|
1189
|
+
'm8gd',
|
|
1190
|
+
'n1',
|
|
1191
|
+
'n2',
|
|
1192
|
+
'n2d',
|
|
1193
|
+
'n4',
|
|
1194
|
+
'p3',
|
|
1195
|
+
'p3dn',
|
|
1196
|
+
'p4d',
|
|
1197
|
+
'p4de',
|
|
1198
|
+
'p5',
|
|
1199
|
+
'p5e',
|
|
1200
|
+
'p5en',
|
|
1201
|
+
'p6-b200',
|
|
1202
|
+
'r3',
|
|
1203
|
+
'r4',
|
|
1204
|
+
'r5',
|
|
1205
|
+
'r5a',
|
|
1206
|
+
'r5ad',
|
|
1207
|
+
'r5b',
|
|
1208
|
+
'r5d',
|
|
1209
|
+
'r5dn',
|
|
1210
|
+
'r5n',
|
|
1211
|
+
'r6a',
|
|
1212
|
+
'r6g',
|
|
1213
|
+
'r6gd',
|
|
1214
|
+
'r6i',
|
|
1215
|
+
'r6id',
|
|
1216
|
+
'r6idn',
|
|
1217
|
+
'r6in',
|
|
1218
|
+
'r7a',
|
|
1219
|
+
'r7g',
|
|
1220
|
+
'r7gd',
|
|
1221
|
+
'r7i',
|
|
1222
|
+
'r7iz',
|
|
1223
|
+
'r8g',
|
|
1224
|
+
'r8gd',
|
|
1225
|
+
't2',
|
|
1226
|
+
't2a',
|
|
1227
|
+
't2d',
|
|
1228
|
+
't3',
|
|
1229
|
+
't3a',
|
|
1230
|
+
't4g',
|
|
1231
|
+
'trn1',
|
|
1232
|
+
'trn1n',
|
|
1233
|
+
'u-3tb1',
|
|
1234
|
+
'u-6tb1',
|
|
1235
|
+
'u7i-12tb',
|
|
1236
|
+
'u7i-6tb',
|
|
1237
|
+
'u7i-8tb',
|
|
1238
|
+
'u7in-16tb',
|
|
1239
|
+
'u7in-24tb',
|
|
1240
|
+
'u7in-32tb',
|
|
1241
|
+
'vt1',
|
|
1242
|
+
'x1',
|
|
1243
|
+
'x1e',
|
|
1244
|
+
'x2gd',
|
|
1245
|
+
'x2idn',
|
|
1246
|
+
'x2iedn',
|
|
1247
|
+
'x2iezn',
|
|
1248
|
+
'x4',
|
|
1249
|
+
'x8g',
|
|
1250
|
+
'z1d',
|
|
1251
|
+
'z3'
|
|
1252
|
+
]
|
|
1253
|
+
},
|
|
1254
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
1255
|
+
default: []
|
|
1256
|
+
},
|
|
1257
|
+
'topology.kubernetes.io/region': {
|
|
1258
|
+
type: 'array',
|
|
1259
|
+
items: {
|
|
1260
|
+
type: 'string',
|
|
1261
|
+
enum: [
|
|
1262
|
+
'africa-south1',
|
|
1263
|
+
'ap-northeast-1',
|
|
1264
|
+
'ap-northeast-2',
|
|
1265
|
+
'ap-northeast-3',
|
|
1266
|
+
'ap-south-1',
|
|
1267
|
+
'ap-southeast-1',
|
|
1268
|
+
'ap-southeast-2',
|
|
1269
|
+
'ash',
|
|
1270
|
+
'asia-east1',
|
|
1271
|
+
'asia-east2',
|
|
1272
|
+
'asia-northeast1',
|
|
1273
|
+
'asia-northeast2',
|
|
1274
|
+
'asia-northeast3',
|
|
1275
|
+
'asia-south1',
|
|
1276
|
+
'asia-south2',
|
|
1277
|
+
'asia-southeast1',
|
|
1278
|
+
'asia-southeast2',
|
|
1279
|
+
'australia-southeast1',
|
|
1280
|
+
'australia-southeast2',
|
|
1281
|
+
'ca-central-1',
|
|
1282
|
+
'eu-central-1',
|
|
1283
|
+
'eu-central-2',
|
|
1284
|
+
'eu-north-1',
|
|
1285
|
+
'eu-west-1',
|
|
1286
|
+
'eu-west-2',
|
|
1287
|
+
'eu-west-3',
|
|
1288
|
+
'europe-central2',
|
|
1289
|
+
'europe-north1',
|
|
1290
|
+
'europe-southwest1',
|
|
1291
|
+
'europe-west1',
|
|
1292
|
+
'europe-west10',
|
|
1293
|
+
'europe-west12',
|
|
1294
|
+
'europe-west2',
|
|
1295
|
+
'europe-west3',
|
|
1296
|
+
'europe-west4',
|
|
1297
|
+
'europe-west6',
|
|
1298
|
+
'europe-west8',
|
|
1299
|
+
'europe-west9',
|
|
1300
|
+
'fsn1',
|
|
1301
|
+
'hel1',
|
|
1302
|
+
'hil',
|
|
1303
|
+
'me-central1',
|
|
1304
|
+
'me-central2',
|
|
1305
|
+
'me-west1',
|
|
1306
|
+
'nbg1',
|
|
1307
|
+
'northamerica-northeast1',
|
|
1308
|
+
'northamerica-northeast2',
|
|
1309
|
+
'sa-east-1',
|
|
1310
|
+
'sin',
|
|
1311
|
+
'southamerica-east1',
|
|
1312
|
+
'southamerica-west1',
|
|
1313
|
+
'us-central1',
|
|
1314
|
+
'us-east-1',
|
|
1315
|
+
'us-east-2',
|
|
1316
|
+
'us-east1',
|
|
1317
|
+
'us-east4',
|
|
1318
|
+
'us-east5',
|
|
1319
|
+
'us-south1',
|
|
1320
|
+
'us-west-1',
|
|
1321
|
+
'us-west-2',
|
|
1322
|
+
'us-west1',
|
|
1323
|
+
'us-west2',
|
|
1324
|
+
'us-west3',
|
|
1325
|
+
'us-west4'
|
|
1326
|
+
]
|
|
1327
|
+
},
|
|
1328
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
1329
|
+
default: []
|
|
1330
|
+
}
|
|
1331
|
+
},
|
|
1332
|
+
additionalProperties: false,
|
|
1333
|
+
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.',
|
|
1334
|
+
default: {
|
|
1335
|
+
'karpenter.sh/capacity-type': [
|
|
1336
|
+
'on-demand',
|
|
1337
|
+
'spot'
|
|
1338
|
+
],
|
|
1339
|
+
'kubernetes.io/arch': [
|
|
1340
|
+
'amd64'
|
|
1341
|
+
],
|
|
1342
|
+
'cfke.io/instance-family': [],
|
|
1343
|
+
'topology.kubernetes.io/region': []
|
|
1344
|
+
}
|
|
1345
|
+
},
|
|
1346
|
+
scalingProfile: {
|
|
1347
|
+
type: 'string',
|
|
1348
|
+
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`).',
|
|
1349
|
+
default: 'conservative',
|
|
1350
|
+
example: 'conservative',
|
|
1351
|
+
enum: [
|
|
1352
|
+
'aggressive',
|
|
1353
|
+
'conservative'
|
|
1354
|
+
]
|
|
1355
|
+
},
|
|
1356
|
+
taints: {
|
|
1357
|
+
type: 'array',
|
|
1358
|
+
items: {
|
|
1359
|
+
type: 'object',
|
|
1360
|
+
properties: {
|
|
1361
|
+
key: {
|
|
1362
|
+
type: 'string',
|
|
1363
|
+
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.',
|
|
1364
|
+
example: 'dedicated'
|
|
1365
|
+
},
|
|
1366
|
+
value: {
|
|
1367
|
+
type: 'string',
|
|
1368
|
+
maxLength: 63,
|
|
1369
|
+
pattern: '^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$',
|
|
1370
|
+
description: 'Taint value. Optional.',
|
|
1371
|
+
example: 'ci'
|
|
1372
|
+
},
|
|
1373
|
+
effect: {
|
|
1374
|
+
type: 'string',
|
|
1375
|
+
description: 'Taint effect.',
|
|
1376
|
+
example: 'NoSchedule',
|
|
1377
|
+
enum: [
|
|
1378
|
+
'NoSchedule',
|
|
1379
|
+
'PreferNoSchedule',
|
|
1380
|
+
'NoExecute'
|
|
1381
|
+
]
|
|
1382
|
+
}
|
|
1383
|
+
},
|
|
1384
|
+
required: [
|
|
1385
|
+
'key',
|
|
1386
|
+
'effect'
|
|
1387
|
+
],
|
|
1388
|
+
additionalProperties: false
|
|
1389
|
+
},
|
|
1390
|
+
maxItems: 50,
|
|
1391
|
+
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.',
|
|
1392
|
+
default: []
|
|
1393
|
+
},
|
|
814
1394
|
id: {
|
|
815
1395
|
type: 'string',
|
|
816
1396
|
maxLength: 63,
|
|
@@ -823,7 +1403,8 @@ export const FleetCreateInputSchema = {
|
|
|
823
1403
|
required: [
|
|
824
1404
|
'id'
|
|
825
1405
|
],
|
|
826
|
-
additionalProperties: false
|
|
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.'
|
|
827
1408
|
};
|
|
828
1409
|
export const FleetSchema = {
|
|
829
1410
|
type: 'object',
|
|
@@ -832,15 +1413,12 @@ export const FleetSchema = {
|
|
|
832
1413
|
type: 'object',
|
|
833
1414
|
properties: {
|
|
834
1415
|
cpu: {
|
|
835
|
-
type: '
|
|
836
|
-
format: 'float',
|
|
1416
|
+
type: 'integer',
|
|
837
1417
|
minimum: 0,
|
|
838
|
-
|
|
1418
|
+
maximum: 100000,
|
|
1419
|
+
description: 'CPU limit in cores. Maximum 100,000.'
|
|
839
1420
|
}
|
|
840
1421
|
},
|
|
841
|
-
required: [
|
|
842
|
-
'cpu'
|
|
843
|
-
],
|
|
844
1422
|
additionalProperties: false,
|
|
845
1423
|
description: 'Limits define a set of bounds for provisioning capacity.'
|
|
846
1424
|
},
|
|
@@ -848,16 +1426,17 @@ export const FleetSchema = {
|
|
|
848
1426
|
type: 'object',
|
|
849
1427
|
properties: {
|
|
850
1428
|
enabled: {
|
|
851
|
-
type: 'boolean'
|
|
852
|
-
default: true
|
|
1429
|
+
type: 'boolean'
|
|
853
1430
|
},
|
|
854
1431
|
project: {
|
|
855
1432
|
type: 'string',
|
|
856
|
-
|
|
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'
|
|
857
1436
|
}
|
|
858
1437
|
},
|
|
859
1438
|
required: [
|
|
860
|
-
'
|
|
1439
|
+
'enabled'
|
|
861
1440
|
],
|
|
862
1441
|
additionalProperties: false
|
|
863
1442
|
},
|
|
@@ -865,16 +1444,16 @@ export const FleetSchema = {
|
|
|
865
1444
|
type: 'object',
|
|
866
1445
|
properties: {
|
|
867
1446
|
enabled: {
|
|
868
|
-
type: 'boolean'
|
|
869
|
-
default: true
|
|
1447
|
+
type: 'boolean'
|
|
870
1448
|
},
|
|
871
1449
|
apiKey: {
|
|
872
1450
|
type: 'string',
|
|
873
|
-
|
|
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.'
|
|
874
1453
|
}
|
|
875
1454
|
},
|
|
876
1455
|
required: [
|
|
877
|
-
'
|
|
1456
|
+
'enabled'
|
|
878
1457
|
],
|
|
879
1458
|
additionalProperties: false
|
|
880
1459
|
},
|
|
@@ -882,19 +1461,363 @@ export const FleetSchema = {
|
|
|
882
1461
|
type: 'object',
|
|
883
1462
|
properties: {
|
|
884
1463
|
enabled: {
|
|
885
|
-
type: 'boolean'
|
|
886
|
-
default: true
|
|
1464
|
+
type: 'boolean'
|
|
887
1465
|
},
|
|
888
1466
|
controllerRoleArn: {
|
|
889
1467
|
type: 'string',
|
|
890
|
-
|
|
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'
|
|
891
1471
|
}
|
|
892
1472
|
},
|
|
893
1473
|
required: [
|
|
894
|
-
'
|
|
1474
|
+
'enabled'
|
|
895
1475
|
],
|
|
896
1476
|
additionalProperties: false
|
|
897
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
|
+
},
|
|
1783
|
+
taints: {
|
|
1784
|
+
type: 'array',
|
|
1785
|
+
items: {
|
|
1786
|
+
type: 'object',
|
|
1787
|
+
properties: {
|
|
1788
|
+
key: {
|
|
1789
|
+
type: 'string',
|
|
1790
|
+
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.',
|
|
1791
|
+
example: 'dedicated'
|
|
1792
|
+
},
|
|
1793
|
+
value: {
|
|
1794
|
+
type: 'string',
|
|
1795
|
+
maxLength: 63,
|
|
1796
|
+
pattern: '^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$',
|
|
1797
|
+
description: 'Taint value. Optional.',
|
|
1798
|
+
example: 'ci'
|
|
1799
|
+
},
|
|
1800
|
+
effect: {
|
|
1801
|
+
type: 'string',
|
|
1802
|
+
description: 'Taint effect.',
|
|
1803
|
+
example: 'NoSchedule',
|
|
1804
|
+
enum: [
|
|
1805
|
+
'NoSchedule',
|
|
1806
|
+
'PreferNoSchedule',
|
|
1807
|
+
'NoExecute'
|
|
1808
|
+
]
|
|
1809
|
+
}
|
|
1810
|
+
},
|
|
1811
|
+
required: [
|
|
1812
|
+
'key',
|
|
1813
|
+
'effect'
|
|
1814
|
+
],
|
|
1815
|
+
additionalProperties: false
|
|
1816
|
+
},
|
|
1817
|
+
maxItems: 50,
|
|
1818
|
+
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.',
|
|
1819
|
+
default: []
|
|
1820
|
+
},
|
|
898
1821
|
id: {
|
|
899
1822
|
type: 'string',
|
|
900
1823
|
maxLength: 63,
|
|
@@ -902,12 +1825,39 @@ export const FleetSchema = {
|
|
|
902
1825
|
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
903
1826
|
description: 'Unique identifier of the kubernetes fleet.',
|
|
904
1827
|
example: 'new-clouds-fleet'
|
|
1828
|
+
},
|
|
1829
|
+
ready: {
|
|
1830
|
+
type: 'boolean',
|
|
1831
|
+
description: 'Indicates whether the fleet configuration is healthy.',
|
|
1832
|
+
example: true
|
|
1833
|
+
},
|
|
1834
|
+
status_message: {
|
|
1835
|
+
type: 'string',
|
|
1836
|
+
description: 'Human-readable reason the fleet is not ready. Present only when `ready` is false.',
|
|
1837
|
+
example: 'Invalid provider permissions.'
|
|
1838
|
+
},
|
|
1839
|
+
created_at: {
|
|
1840
|
+
type: 'string',
|
|
1841
|
+
description: 'Creation date and time of the fleet.',
|
|
1842
|
+
example: '2024-09-12T09:11:27Z'
|
|
1843
|
+
},
|
|
1844
|
+
updated_at: {
|
|
1845
|
+
type: 'string',
|
|
1846
|
+
description: 'Date and time the fleet was last updated.',
|
|
1847
|
+
example: '2024-09-12T09:11:27Z'
|
|
905
1848
|
}
|
|
906
1849
|
},
|
|
907
1850
|
required: [
|
|
908
|
-
'
|
|
1851
|
+
'constraints',
|
|
1852
|
+
'scalingProfile',
|
|
1853
|
+
'taints',
|
|
1854
|
+
'id',
|
|
1855
|
+
'ready',
|
|
1856
|
+
'created_at',
|
|
1857
|
+
'updated_at'
|
|
909
1858
|
],
|
|
910
|
-
additionalProperties: false
|
|
1859
|
+
additionalProperties: false,
|
|
1860
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
911
1861
|
};
|
|
912
1862
|
export const FleetUpdateInputSchema = {
|
|
913
1863
|
type: 'object',
|
|
@@ -916,15 +1866,12 @@ export const FleetUpdateInputSchema = {
|
|
|
916
1866
|
type: 'object',
|
|
917
1867
|
properties: {
|
|
918
1868
|
cpu: {
|
|
919
|
-
type: '
|
|
920
|
-
format: 'float',
|
|
1869
|
+
type: 'integer',
|
|
921
1870
|
minimum: 0,
|
|
922
|
-
|
|
1871
|
+
maximum: 100000,
|
|
1872
|
+
description: 'CPU limit in cores. Maximum 100,000.'
|
|
923
1873
|
}
|
|
924
1874
|
},
|
|
925
|
-
required: [
|
|
926
|
-
'cpu'
|
|
927
|
-
],
|
|
928
1875
|
additionalProperties: false,
|
|
929
1876
|
description: 'Limits define a set of bounds for provisioning capacity.'
|
|
930
1877
|
},
|
|
@@ -932,16 +1879,17 @@ export const FleetUpdateInputSchema = {
|
|
|
932
1879
|
type: 'object',
|
|
933
1880
|
properties: {
|
|
934
1881
|
enabled: {
|
|
935
|
-
type: 'boolean'
|
|
936
|
-
default: true
|
|
1882
|
+
type: 'boolean'
|
|
937
1883
|
},
|
|
938
1884
|
project: {
|
|
939
1885
|
type: 'string',
|
|
940
|
-
|
|
1886
|
+
pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
|
|
1887
|
+
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.',
|
|
1888
|
+
example: 'my-cloudfleet-project'
|
|
941
1889
|
}
|
|
942
1890
|
},
|
|
943
1891
|
required: [
|
|
944
|
-
'
|
|
1892
|
+
'enabled'
|
|
945
1893
|
],
|
|
946
1894
|
additionalProperties: false
|
|
947
1895
|
},
|
|
@@ -949,16 +1897,18 @@ export const FleetUpdateInputSchema = {
|
|
|
949
1897
|
type: 'object',
|
|
950
1898
|
properties: {
|
|
951
1899
|
enabled: {
|
|
952
|
-
type: 'boolean'
|
|
953
|
-
default: true
|
|
1900
|
+
type: 'boolean'
|
|
954
1901
|
},
|
|
955
1902
|
apiKey: {
|
|
956
1903
|
type: 'string',
|
|
957
|
-
|
|
1904
|
+
maxLength: 64,
|
|
1905
|
+
minLength: 64,
|
|
1906
|
+
pattern: '^([A-Za-z0-9]{64}|\\*{64})$',
|
|
1907
|
+
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.'
|
|
958
1908
|
}
|
|
959
1909
|
},
|
|
960
1910
|
required: [
|
|
961
|
-
'
|
|
1911
|
+
'enabled'
|
|
962
1912
|
],
|
|
963
1913
|
additionalProperties: false
|
|
964
1914
|
},
|
|
@@ -966,20 +1916,386 @@ export const FleetUpdateInputSchema = {
|
|
|
966
1916
|
type: 'object',
|
|
967
1917
|
properties: {
|
|
968
1918
|
enabled: {
|
|
969
|
-
type: 'boolean'
|
|
970
|
-
default: true
|
|
1919
|
+
type: 'boolean'
|
|
971
1920
|
},
|
|
972
1921
|
controllerRoleArn: {
|
|
973
1922
|
type: 'string',
|
|
974
|
-
|
|
1923
|
+
pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
|
|
1924
|
+
description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
|
|
1925
|
+
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
975
1926
|
}
|
|
976
1927
|
},
|
|
977
1928
|
required: [
|
|
978
|
-
'
|
|
1929
|
+
'enabled'
|
|
979
1930
|
],
|
|
980
1931
|
additionalProperties: false
|
|
1932
|
+
},
|
|
1933
|
+
constraints: {
|
|
1934
|
+
type: 'object',
|
|
1935
|
+
properties: {
|
|
1936
|
+
'karpenter.sh/capacity-type': {
|
|
1937
|
+
type: 'array',
|
|
1938
|
+
items: {
|
|
1939
|
+
type: 'string',
|
|
1940
|
+
enum: [
|
|
1941
|
+
'on-demand',
|
|
1942
|
+
'spot'
|
|
1943
|
+
]
|
|
1944
|
+
},
|
|
1945
|
+
minItems: 1,
|
|
1946
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1947
|
+
default: [
|
|
1948
|
+
'on-demand',
|
|
1949
|
+
'spot'
|
|
1950
|
+
]
|
|
1951
|
+
},
|
|
1952
|
+
'kubernetes.io/arch': {
|
|
1953
|
+
type: 'array',
|
|
1954
|
+
items: {
|
|
1955
|
+
type: 'string',
|
|
1956
|
+
enum: [
|
|
1957
|
+
'amd64',
|
|
1958
|
+
'arm64'
|
|
1959
|
+
]
|
|
1960
|
+
},
|
|
1961
|
+
minItems: 1,
|
|
1962
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1963
|
+
default: [
|
|
1964
|
+
'amd64'
|
|
1965
|
+
]
|
|
1966
|
+
},
|
|
1967
|
+
'cfke.io/instance-family': {
|
|
1968
|
+
type: 'array',
|
|
1969
|
+
items: {
|
|
1970
|
+
type: 'string',
|
|
1971
|
+
enum: [
|
|
1972
|
+
'a1',
|
|
1973
|
+
'a2',
|
|
1974
|
+
'a3',
|
|
1975
|
+
'a4',
|
|
1976
|
+
'c1',
|
|
1977
|
+
'c2',
|
|
1978
|
+
'c2d',
|
|
1979
|
+
'c3',
|
|
1980
|
+
'c3d',
|
|
1981
|
+
'c4',
|
|
1982
|
+
'c4a',
|
|
1983
|
+
'c4d',
|
|
1984
|
+
'c5',
|
|
1985
|
+
'c5a',
|
|
1986
|
+
'c5ad',
|
|
1987
|
+
'c5d',
|
|
1988
|
+
'c5n',
|
|
1989
|
+
'c6a',
|
|
1990
|
+
'c6g',
|
|
1991
|
+
'c6gd',
|
|
1992
|
+
'c6gn',
|
|
1993
|
+
'c6i',
|
|
1994
|
+
'c6id',
|
|
1995
|
+
'c6in',
|
|
1996
|
+
'c7a',
|
|
1997
|
+
'c7g',
|
|
1998
|
+
'c7gd',
|
|
1999
|
+
'c7gn',
|
|
2000
|
+
'c7i',
|
|
2001
|
+
'c7i-flex',
|
|
2002
|
+
'c8g',
|
|
2003
|
+
'c8gd',
|
|
2004
|
+
'cax',
|
|
2005
|
+
'ccx',
|
|
2006
|
+
'cpx',
|
|
2007
|
+
'cx',
|
|
2008
|
+
'd2',
|
|
2009
|
+
'd3',
|
|
2010
|
+
'd3en',
|
|
2011
|
+
'dl1',
|
|
2012
|
+
'dl2q',
|
|
2013
|
+
'e2',
|
|
2014
|
+
'f1',
|
|
2015
|
+
'f2',
|
|
2016
|
+
'g1',
|
|
2017
|
+
'g2',
|
|
2018
|
+
'g4ad',
|
|
2019
|
+
'g4dn',
|
|
2020
|
+
'g5',
|
|
2021
|
+
'g5g',
|
|
2022
|
+
'g6',
|
|
2023
|
+
'g6e',
|
|
2024
|
+
'gr6',
|
|
2025
|
+
'h1',
|
|
2026
|
+
'h3',
|
|
2027
|
+
'hpc6a',
|
|
2028
|
+
'hpc6id',
|
|
2029
|
+
'hpc7a',
|
|
2030
|
+
'hpc7g',
|
|
2031
|
+
'i2',
|
|
2032
|
+
'i3',
|
|
2033
|
+
'i3en',
|
|
2034
|
+
'i4g',
|
|
2035
|
+
'i4i',
|
|
2036
|
+
'i7i',
|
|
2037
|
+
'i7ie',
|
|
2038
|
+
'i8g',
|
|
2039
|
+
'im4gn',
|
|
2040
|
+
'inf1',
|
|
2041
|
+
'inf2',
|
|
2042
|
+
'is4gen',
|
|
2043
|
+
'm1',
|
|
2044
|
+
'm2',
|
|
2045
|
+
'm3',
|
|
2046
|
+
'm4',
|
|
2047
|
+
'm5',
|
|
2048
|
+
'm5a',
|
|
2049
|
+
'm5ad',
|
|
2050
|
+
'm5d',
|
|
2051
|
+
'm5dn',
|
|
2052
|
+
'm5n',
|
|
2053
|
+
'm5zn',
|
|
2054
|
+
'm6a',
|
|
2055
|
+
'm6g',
|
|
2056
|
+
'm6gd',
|
|
2057
|
+
'm6i',
|
|
2058
|
+
'm6id',
|
|
2059
|
+
'm6idn',
|
|
2060
|
+
'm6in',
|
|
2061
|
+
'm7a',
|
|
2062
|
+
'm7g',
|
|
2063
|
+
'm7gd',
|
|
2064
|
+
'm7i',
|
|
2065
|
+
'm7i-flex',
|
|
2066
|
+
'm8g',
|
|
2067
|
+
'm8gd',
|
|
2068
|
+
'n1',
|
|
2069
|
+
'n2',
|
|
2070
|
+
'n2d',
|
|
2071
|
+
'n4',
|
|
2072
|
+
'p3',
|
|
2073
|
+
'p3dn',
|
|
2074
|
+
'p4d',
|
|
2075
|
+
'p4de',
|
|
2076
|
+
'p5',
|
|
2077
|
+
'p5e',
|
|
2078
|
+
'p5en',
|
|
2079
|
+
'p6-b200',
|
|
2080
|
+
'r3',
|
|
2081
|
+
'r4',
|
|
2082
|
+
'r5',
|
|
2083
|
+
'r5a',
|
|
2084
|
+
'r5ad',
|
|
2085
|
+
'r5b',
|
|
2086
|
+
'r5d',
|
|
2087
|
+
'r5dn',
|
|
2088
|
+
'r5n',
|
|
2089
|
+
'r6a',
|
|
2090
|
+
'r6g',
|
|
2091
|
+
'r6gd',
|
|
2092
|
+
'r6i',
|
|
2093
|
+
'r6id',
|
|
2094
|
+
'r6idn',
|
|
2095
|
+
'r6in',
|
|
2096
|
+
'r7a',
|
|
2097
|
+
'r7g',
|
|
2098
|
+
'r7gd',
|
|
2099
|
+
'r7i',
|
|
2100
|
+
'r7iz',
|
|
2101
|
+
'r8g',
|
|
2102
|
+
'r8gd',
|
|
2103
|
+
't2',
|
|
2104
|
+
't2a',
|
|
2105
|
+
't2d',
|
|
2106
|
+
't3',
|
|
2107
|
+
't3a',
|
|
2108
|
+
't4g',
|
|
2109
|
+
'trn1',
|
|
2110
|
+
'trn1n',
|
|
2111
|
+
'u-3tb1',
|
|
2112
|
+
'u-6tb1',
|
|
2113
|
+
'u7i-12tb',
|
|
2114
|
+
'u7i-6tb',
|
|
2115
|
+
'u7i-8tb',
|
|
2116
|
+
'u7in-16tb',
|
|
2117
|
+
'u7in-24tb',
|
|
2118
|
+
'u7in-32tb',
|
|
2119
|
+
'vt1',
|
|
2120
|
+
'x1',
|
|
2121
|
+
'x1e',
|
|
2122
|
+
'x2gd',
|
|
2123
|
+
'x2idn',
|
|
2124
|
+
'x2iedn',
|
|
2125
|
+
'x2iezn',
|
|
2126
|
+
'x4',
|
|
2127
|
+
'x8g',
|
|
2128
|
+
'z1d',
|
|
2129
|
+
'z3'
|
|
2130
|
+
]
|
|
2131
|
+
},
|
|
2132
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
2133
|
+
default: []
|
|
2134
|
+
},
|
|
2135
|
+
'topology.kubernetes.io/region': {
|
|
2136
|
+
type: 'array',
|
|
2137
|
+
items: {
|
|
2138
|
+
type: 'string',
|
|
2139
|
+
enum: [
|
|
2140
|
+
'africa-south1',
|
|
2141
|
+
'ap-northeast-1',
|
|
2142
|
+
'ap-northeast-2',
|
|
2143
|
+
'ap-northeast-3',
|
|
2144
|
+
'ap-south-1',
|
|
2145
|
+
'ap-southeast-1',
|
|
2146
|
+
'ap-southeast-2',
|
|
2147
|
+
'ash',
|
|
2148
|
+
'asia-east1',
|
|
2149
|
+
'asia-east2',
|
|
2150
|
+
'asia-northeast1',
|
|
2151
|
+
'asia-northeast2',
|
|
2152
|
+
'asia-northeast3',
|
|
2153
|
+
'asia-south1',
|
|
2154
|
+
'asia-south2',
|
|
2155
|
+
'asia-southeast1',
|
|
2156
|
+
'asia-southeast2',
|
|
2157
|
+
'australia-southeast1',
|
|
2158
|
+
'australia-southeast2',
|
|
2159
|
+
'ca-central-1',
|
|
2160
|
+
'eu-central-1',
|
|
2161
|
+
'eu-central-2',
|
|
2162
|
+
'eu-north-1',
|
|
2163
|
+
'eu-west-1',
|
|
2164
|
+
'eu-west-2',
|
|
2165
|
+
'eu-west-3',
|
|
2166
|
+
'europe-central2',
|
|
2167
|
+
'europe-north1',
|
|
2168
|
+
'europe-southwest1',
|
|
2169
|
+
'europe-west1',
|
|
2170
|
+
'europe-west10',
|
|
2171
|
+
'europe-west12',
|
|
2172
|
+
'europe-west2',
|
|
2173
|
+
'europe-west3',
|
|
2174
|
+
'europe-west4',
|
|
2175
|
+
'europe-west6',
|
|
2176
|
+
'europe-west8',
|
|
2177
|
+
'europe-west9',
|
|
2178
|
+
'fsn1',
|
|
2179
|
+
'hel1',
|
|
2180
|
+
'hil',
|
|
2181
|
+
'me-central1',
|
|
2182
|
+
'me-central2',
|
|
2183
|
+
'me-west1',
|
|
2184
|
+
'nbg1',
|
|
2185
|
+
'northamerica-northeast1',
|
|
2186
|
+
'northamerica-northeast2',
|
|
2187
|
+
'sa-east-1',
|
|
2188
|
+
'sin',
|
|
2189
|
+
'southamerica-east1',
|
|
2190
|
+
'southamerica-west1',
|
|
2191
|
+
'us-central1',
|
|
2192
|
+
'us-east-1',
|
|
2193
|
+
'us-east-2',
|
|
2194
|
+
'us-east1',
|
|
2195
|
+
'us-east4',
|
|
2196
|
+
'us-east5',
|
|
2197
|
+
'us-south1',
|
|
2198
|
+
'us-west-1',
|
|
2199
|
+
'us-west-2',
|
|
2200
|
+
'us-west1',
|
|
2201
|
+
'us-west2',
|
|
2202
|
+
'us-west3',
|
|
2203
|
+
'us-west4'
|
|
2204
|
+
]
|
|
2205
|
+
},
|
|
2206
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
2207
|
+
default: []
|
|
2208
|
+
}
|
|
2209
|
+
},
|
|
2210
|
+
additionalProperties: false,
|
|
2211
|
+
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.',
|
|
2212
|
+
default: {
|
|
2213
|
+
'karpenter.sh/capacity-type': [
|
|
2214
|
+
'on-demand',
|
|
2215
|
+
'spot'
|
|
2216
|
+
],
|
|
2217
|
+
'kubernetes.io/arch': [
|
|
2218
|
+
'amd64'
|
|
2219
|
+
],
|
|
2220
|
+
'cfke.io/instance-family': [],
|
|
2221
|
+
'topology.kubernetes.io/region': []
|
|
2222
|
+
}
|
|
2223
|
+
},
|
|
2224
|
+
scalingProfile: {
|
|
2225
|
+
type: 'string',
|
|
2226
|
+
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`).',
|
|
2227
|
+
default: 'conservative',
|
|
2228
|
+
example: 'conservative',
|
|
2229
|
+
enum: [
|
|
2230
|
+
'aggressive',
|
|
2231
|
+
'conservative'
|
|
2232
|
+
]
|
|
2233
|
+
},
|
|
2234
|
+
taints: {
|
|
2235
|
+
type: 'array',
|
|
2236
|
+
items: {
|
|
2237
|
+
type: 'object',
|
|
2238
|
+
properties: {
|
|
2239
|
+
key: {
|
|
2240
|
+
type: 'string',
|
|
2241
|
+
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.',
|
|
2242
|
+
example: 'dedicated'
|
|
2243
|
+
},
|
|
2244
|
+
value: {
|
|
2245
|
+
type: 'string',
|
|
2246
|
+
maxLength: 63,
|
|
2247
|
+
pattern: '^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$',
|
|
2248
|
+
description: 'Taint value. Optional.',
|
|
2249
|
+
example: 'ci'
|
|
2250
|
+
},
|
|
2251
|
+
effect: {
|
|
2252
|
+
type: 'string',
|
|
2253
|
+
description: 'Taint effect.',
|
|
2254
|
+
example: 'NoSchedule',
|
|
2255
|
+
enum: [
|
|
2256
|
+
'NoSchedule',
|
|
2257
|
+
'PreferNoSchedule',
|
|
2258
|
+
'NoExecute'
|
|
2259
|
+
]
|
|
2260
|
+
}
|
|
2261
|
+
},
|
|
2262
|
+
required: [
|
|
2263
|
+
'key',
|
|
2264
|
+
'effect'
|
|
2265
|
+
],
|
|
2266
|
+
additionalProperties: false
|
|
2267
|
+
},
|
|
2268
|
+
maxItems: 50,
|
|
2269
|
+
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.',
|
|
2270
|
+
default: []
|
|
2271
|
+
}
|
|
2272
|
+
},
|
|
2273
|
+
additionalProperties: false,
|
|
2274
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
2275
|
+
};
|
|
2276
|
+
export const InviteCreateInputSchema = {
|
|
2277
|
+
type: 'object',
|
|
2278
|
+
properties: {
|
|
2279
|
+
email: {
|
|
2280
|
+
type: 'string',
|
|
2281
|
+
format: 'email',
|
|
2282
|
+
description: 'Email address of the user to invite.',
|
|
2283
|
+
example: 'email@example.com'
|
|
2284
|
+
},
|
|
2285
|
+
role: {
|
|
2286
|
+
type: 'string',
|
|
2287
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2288
|
+
default: 'User',
|
|
2289
|
+
example: 'User',
|
|
2290
|
+
enum: [
|
|
2291
|
+
'Administrator',
|
|
2292
|
+
'User'
|
|
2293
|
+
]
|
|
981
2294
|
}
|
|
982
2295
|
},
|
|
2296
|
+
required: [
|
|
2297
|
+
'email'
|
|
2298
|
+
],
|
|
983
2299
|
additionalProperties: false
|
|
984
2300
|
};
|
|
985
2301
|
export const InviteSchema = {
|
|
@@ -1008,14 +2324,188 @@ export const InviteSchema = {
|
|
|
1008
2324
|
description: 'User email address.',
|
|
1009
2325
|
example: 'email@example.com'
|
|
1010
2326
|
},
|
|
1011
|
-
code: {
|
|
2327
|
+
code: {
|
|
2328
|
+
type: 'string',
|
|
2329
|
+
description: 'Generated unique invite code.',
|
|
2330
|
+
example: '7kUZnH7nnKUFfvc4NK2KQF'
|
|
2331
|
+
},
|
|
2332
|
+
role: {
|
|
2333
|
+
type: 'string',
|
|
2334
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2335
|
+
default: 'User',
|
|
2336
|
+
example: 'User',
|
|
2337
|
+
enum: [
|
|
2338
|
+
'Administrator',
|
|
2339
|
+
'User'
|
|
2340
|
+
]
|
|
2341
|
+
}
|
|
2342
|
+
},
|
|
2343
|
+
required: [
|
|
2344
|
+
'date_created'
|
|
2345
|
+
],
|
|
2346
|
+
additionalProperties: false
|
|
2347
|
+
};
|
|
2348
|
+
export const InvoicePaymentAttemptSchema = {
|
|
2349
|
+
type: 'object',
|
|
2350
|
+
properties: {
|
|
2351
|
+
invoice_id: {
|
|
2352
|
+
type: 'string',
|
|
2353
|
+
description: 'Identifier of the invoice.',
|
|
2354
|
+
example: 'in_1234567890xCrwxghOTj1234'
|
|
2355
|
+
},
|
|
2356
|
+
number: {
|
|
2357
|
+
type: 'string',
|
|
2358
|
+
nullable: true,
|
|
2359
|
+
description: 'Invoice number. Null if the invoice has no number.',
|
|
2360
|
+
example: 'CF-0042'
|
|
2361
|
+
},
|
|
2362
|
+
amount: {
|
|
2363
|
+
type: 'number',
|
|
2364
|
+
format: 'float',
|
|
2365
|
+
description: 'Amount outstanding when the charge was attempted, in the smallest currency unit.',
|
|
2366
|
+
example: 4200
|
|
2367
|
+
},
|
|
2368
|
+
currency: {
|
|
2369
|
+
type: 'string',
|
|
2370
|
+
description: 'Currency of the invoice.',
|
|
2371
|
+
example: 'eur'
|
|
2372
|
+
},
|
|
2373
|
+
status: {
|
|
2374
|
+
type: 'string',
|
|
2375
|
+
description: 'Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).',
|
|
2376
|
+
example: 'paid',
|
|
2377
|
+
enum: [
|
|
2378
|
+
'paid',
|
|
2379
|
+
'processing',
|
|
2380
|
+
'requires_action',
|
|
2381
|
+
'failed'
|
|
2382
|
+
]
|
|
2383
|
+
},
|
|
2384
|
+
client_secret: {
|
|
2385
|
+
type: 'string',
|
|
2386
|
+
nullable: true,
|
|
2387
|
+
description: 'Client secret used to complete customer authentication. Set only when `status` is `requires_action`.',
|
|
2388
|
+
example: 'pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH'
|
|
2389
|
+
},
|
|
2390
|
+
failure_code: {
|
|
2391
|
+
type: 'string',
|
|
2392
|
+
nullable: true,
|
|
2393
|
+
description: 'Decline code. Set only when `status` is `failed`.',
|
|
2394
|
+
example: 'insufficient_funds'
|
|
2395
|
+
},
|
|
2396
|
+
failure_message: {
|
|
2397
|
+
type: 'string',
|
|
2398
|
+
nullable: true,
|
|
2399
|
+
description: 'Explanation of the decline, suitable for display. Set only when `status` is `failed`.',
|
|
2400
|
+
example: 'Your card has insufficient funds.'
|
|
2401
|
+
}
|
|
2402
|
+
},
|
|
2403
|
+
required: [
|
|
2404
|
+
'invoice_id',
|
|
2405
|
+
'number',
|
|
2406
|
+
'amount',
|
|
2407
|
+
'currency',
|
|
2408
|
+
'status',
|
|
2409
|
+
'client_secret',
|
|
2410
|
+
'failure_code',
|
|
2411
|
+
'failure_message'
|
|
2412
|
+
],
|
|
2413
|
+
additionalProperties: false
|
|
2414
|
+
};
|
|
2415
|
+
export const InvoicePaymentResultSchema = {
|
|
2416
|
+
type: 'object',
|
|
2417
|
+
properties: {
|
|
2418
|
+
code: {
|
|
2419
|
+
type: 'string',
|
|
2420
|
+
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).',
|
|
2421
|
+
example: 'partially_paid',
|
|
2422
|
+
enum: [
|
|
2423
|
+
'paid',
|
|
2424
|
+
'processing',
|
|
2425
|
+
'action_required',
|
|
2426
|
+
'partially_paid',
|
|
2427
|
+
'failed',
|
|
2428
|
+
'nothing_due',
|
|
2429
|
+
'bank_transfer_due'
|
|
2430
|
+
]
|
|
2431
|
+
},
|
|
2432
|
+
message: {
|
|
1012
2433
|
type: 'string',
|
|
1013
|
-
description: '
|
|
1014
|
-
example: '
|
|
2434
|
+
description: 'Summary of the outcome, suitable for display.',
|
|
2435
|
+
example: '1 of 2 open invoices was paid. Invoice CF-0043 was declined: Your card has insufficient funds.'
|
|
2436
|
+
},
|
|
2437
|
+
results: {
|
|
2438
|
+
type: 'array',
|
|
2439
|
+
items: {
|
|
2440
|
+
type: 'object',
|
|
2441
|
+
properties: {
|
|
2442
|
+
invoice_id: {
|
|
2443
|
+
type: 'string',
|
|
2444
|
+
description: 'Identifier of the invoice.',
|
|
2445
|
+
example: 'in_1234567890xCrwxghOTj1234'
|
|
2446
|
+
},
|
|
2447
|
+
number: {
|
|
2448
|
+
type: 'string',
|
|
2449
|
+
description: 'Invoice number. Null if the invoice has no number.',
|
|
2450
|
+
example: 'CF-0042'
|
|
2451
|
+
},
|
|
2452
|
+
amount: {
|
|
2453
|
+
type: 'number',
|
|
2454
|
+
format: 'float',
|
|
2455
|
+
description: 'Amount outstanding when the charge was attempted, in the smallest currency unit.',
|
|
2456
|
+
example: 4200
|
|
2457
|
+
},
|
|
2458
|
+
currency: {
|
|
2459
|
+
type: 'string',
|
|
2460
|
+
description: 'Currency of the invoice.',
|
|
2461
|
+
example: 'eur'
|
|
2462
|
+
},
|
|
2463
|
+
status: {
|
|
2464
|
+
type: 'string',
|
|
2465
|
+
description: 'Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).',
|
|
2466
|
+
example: 'paid',
|
|
2467
|
+
enum: [
|
|
2468
|
+
'paid',
|
|
2469
|
+
'processing',
|
|
2470
|
+
'requires_action',
|
|
2471
|
+
'failed'
|
|
2472
|
+
]
|
|
2473
|
+
},
|
|
2474
|
+
client_secret: {
|
|
2475
|
+
type: 'string',
|
|
2476
|
+
description: 'Client secret used to complete customer authentication. Set only when `status` is `requires_action`.',
|
|
2477
|
+
example: 'pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH'
|
|
2478
|
+
},
|
|
2479
|
+
failure_code: {
|
|
2480
|
+
type: 'string',
|
|
2481
|
+
description: 'Decline code. Set only when `status` is `failed`.',
|
|
2482
|
+
example: 'insufficient_funds'
|
|
2483
|
+
},
|
|
2484
|
+
failure_message: {
|
|
2485
|
+
type: 'string',
|
|
2486
|
+
description: 'Explanation of the decline, suitable for display. Set only when `status` is `failed`.',
|
|
2487
|
+
example: 'Your card has insufficient funds.'
|
|
2488
|
+
}
|
|
2489
|
+
},
|
|
2490
|
+
required: [
|
|
2491
|
+
'invoice_id',
|
|
2492
|
+
'number',
|
|
2493
|
+
'amount',
|
|
2494
|
+
'currency',
|
|
2495
|
+
'status',
|
|
2496
|
+
'client_secret',
|
|
2497
|
+
'failure_code',
|
|
2498
|
+
'failure_message'
|
|
2499
|
+
],
|
|
2500
|
+
additionalProperties: false
|
|
2501
|
+
},
|
|
2502
|
+
description: 'One entry per invoice charged, oldest first.'
|
|
1015
2503
|
}
|
|
1016
2504
|
},
|
|
1017
2505
|
required: [
|
|
1018
|
-
'
|
|
2506
|
+
'code',
|
|
2507
|
+
'message',
|
|
2508
|
+
'results'
|
|
1019
2509
|
],
|
|
1020
2510
|
additionalProperties: false
|
|
1021
2511
|
};
|
|
@@ -1232,6 +2722,15 @@ export const MarketplaceListingSchema = {
|
|
|
1232
2722
|
export const OrganizationCreateInputSchema = {
|
|
1233
2723
|
type: 'object',
|
|
1234
2724
|
properties: {
|
|
2725
|
+
type: {
|
|
2726
|
+
type: 'string',
|
|
2727
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2728
|
+
example: 'business',
|
|
2729
|
+
enum: [
|
|
2730
|
+
'business',
|
|
2731
|
+
'personal'
|
|
2732
|
+
]
|
|
2733
|
+
},
|
|
1235
2734
|
email: {
|
|
1236
2735
|
type: 'string',
|
|
1237
2736
|
format: 'email',
|
|
@@ -1240,11 +2739,13 @@ export const OrganizationCreateInputSchema = {
|
|
|
1240
2739
|
},
|
|
1241
2740
|
first_name: {
|
|
1242
2741
|
type: 'string',
|
|
2742
|
+
minLength: 1,
|
|
1243
2743
|
description: 'First name of the billing contact person.',
|
|
1244
2744
|
example: 'John'
|
|
1245
2745
|
},
|
|
1246
2746
|
last_name: {
|
|
1247
2747
|
type: 'string',
|
|
2748
|
+
minLength: 1,
|
|
1248
2749
|
description: 'Last name of the billing contact person.',
|
|
1249
2750
|
example: 'Doe'
|
|
1250
2751
|
},
|
|
@@ -1263,6 +2764,7 @@ export const OrganizationCreateInputSchema = {
|
|
|
1263
2764
|
}
|
|
1264
2765
|
},
|
|
1265
2766
|
required: [
|
|
2767
|
+
'type',
|
|
1266
2768
|
'email',
|
|
1267
2769
|
'first_name',
|
|
1268
2770
|
'last_name',
|
|
@@ -1271,6 +2773,20 @@ export const OrganizationCreateInputSchema = {
|
|
|
1271
2773
|
],
|
|
1272
2774
|
additionalProperties: false
|
|
1273
2775
|
};
|
|
2776
|
+
export const OrganizationCreateOutputSchema = {
|
|
2777
|
+
type: 'object',
|
|
2778
|
+
properties: {
|
|
2779
|
+
id: {
|
|
2780
|
+
type: 'string',
|
|
2781
|
+
description: 'Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.',
|
|
2782
|
+
example: 'organization-id'
|
|
2783
|
+
}
|
|
2784
|
+
},
|
|
2785
|
+
required: [
|
|
2786
|
+
'id'
|
|
2787
|
+
],
|
|
2788
|
+
additionalProperties: false
|
|
2789
|
+
};
|
|
1274
2790
|
export const OrganizationSchema = {
|
|
1275
2791
|
type: 'object',
|
|
1276
2792
|
properties: {
|
|
@@ -1287,6 +2803,15 @@ export const OrganizationSchema = {
|
|
|
1287
2803
|
description: 'Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.',
|
|
1288
2804
|
example: 'ACME Corp.'
|
|
1289
2805
|
},
|
|
2806
|
+
type: {
|
|
2807
|
+
type: 'string',
|
|
2808
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2809
|
+
example: 'business',
|
|
2810
|
+
enum: [
|
|
2811
|
+
'business',
|
|
2812
|
+
'personal'
|
|
2813
|
+
]
|
|
2814
|
+
},
|
|
1290
2815
|
date_created: {
|
|
1291
2816
|
type: 'string',
|
|
1292
2817
|
format: 'date-time',
|
|
@@ -1318,6 +2843,17 @@ export const OrganizationSchema = {
|
|
|
1318
2843
|
description: 'Available number of Pro clusters that can be created.',
|
|
1319
2844
|
example: 999
|
|
1320
2845
|
},
|
|
2846
|
+
enterprise_clusters_max: {
|
|
2847
|
+
type: 'integer',
|
|
2848
|
+
minimum: 0,
|
|
2849
|
+
description: 'Maximum number of Enterprise clusters that can be created.',
|
|
2850
|
+
example: 999
|
|
2851
|
+
},
|
|
2852
|
+
enterprise_clusters_available: {
|
|
2853
|
+
type: 'integer',
|
|
2854
|
+
description: 'Available number of Enterprise clusters that can be created.',
|
|
2855
|
+
example: 999
|
|
2856
|
+
},
|
|
1321
2857
|
fleets_max: {
|
|
1322
2858
|
type: 'integer',
|
|
1323
2859
|
minimum: 0,
|
|
@@ -1337,7 +2873,7 @@ export const OrganizationSchema = {
|
|
|
1337
2873
|
type: 'array',
|
|
1338
2874
|
items: {
|
|
1339
2875
|
type: 'string',
|
|
1340
|
-
example: 'northamerica-central-
|
|
2876
|
+
example: 'northamerica-central-1a'
|
|
1341
2877
|
},
|
|
1342
2878
|
minItems: 1,
|
|
1343
2879
|
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
@@ -1379,6 +2915,8 @@ export const OrganizationSchema = {
|
|
|
1379
2915
|
'basic_clusters_available',
|
|
1380
2916
|
'pro_clusters_max',
|
|
1381
2917
|
'pro_clusters_available',
|
|
2918
|
+
'enterprise_clusters_max',
|
|
2919
|
+
'enterprise_clusters_available',
|
|
1382
2920
|
'fleets_max',
|
|
1383
2921
|
'cluster_tiers',
|
|
1384
2922
|
'regions',
|
|
@@ -1396,13 +2934,25 @@ export const OrganizationSchema = {
|
|
|
1396
2934
|
'closed',
|
|
1397
2935
|
'suspended'
|
|
1398
2936
|
]
|
|
2937
|
+
},
|
|
2938
|
+
verification: {
|
|
2939
|
+
type: 'string',
|
|
2940
|
+
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.',
|
|
2941
|
+
example: 'verified',
|
|
2942
|
+
enum: [
|
|
2943
|
+
'none',
|
|
2944
|
+
'submitted',
|
|
2945
|
+
'verified'
|
|
2946
|
+
]
|
|
1399
2947
|
}
|
|
1400
2948
|
},
|
|
1401
2949
|
required: [
|
|
1402
2950
|
'id',
|
|
2951
|
+
'type',
|
|
1403
2952
|
'date_created',
|
|
1404
2953
|
'quota',
|
|
1405
|
-
'status'
|
|
2954
|
+
'status',
|
|
2955
|
+
'verification'
|
|
1406
2956
|
],
|
|
1407
2957
|
additionalProperties: false
|
|
1408
2958
|
};
|
|
@@ -1411,28 +2961,23 @@ export const PaymentMethodSchema = {
|
|
|
1411
2961
|
properties: {
|
|
1412
2962
|
id: {
|
|
1413
2963
|
type: 'string',
|
|
1414
|
-
|
|
1415
|
-
|
|
1416
|
-
example: 'e94d30ec-a2dd-4dcb-832c-ac2be144ba91'
|
|
1417
|
-
},
|
|
1418
|
-
setup: {
|
|
1419
|
-
type: 'boolean',
|
|
1420
|
-
description: 'Whether organization payment method was set up and ready to use for payments.',
|
|
1421
|
-
example: true
|
|
2964
|
+
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.',
|
|
2965
|
+
example: 'pm_1MtwBwLkdIwHu7ix28a3tqPa'
|
|
1422
2966
|
},
|
|
1423
2967
|
type: {
|
|
1424
2968
|
type: 'string',
|
|
1425
|
-
|
|
1426
|
-
description: 'Payment method type type. Only `card` payments supported at the moment.',
|
|
2969
|
+
description: 'Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.',
|
|
1427
2970
|
example: 'card',
|
|
1428
2971
|
enum: [
|
|
1429
|
-
'card'
|
|
2972
|
+
'card',
|
|
2973
|
+
'sepa_debit',
|
|
2974
|
+
'bank_transfer'
|
|
1430
2975
|
]
|
|
1431
2976
|
},
|
|
1432
2977
|
last4: {
|
|
1433
2978
|
type: 'string',
|
|
1434
2979
|
nullable: true,
|
|
1435
|
-
description: 'Last 4 digits of the payment card number.',
|
|
2980
|
+
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.',
|
|
1436
2981
|
example: '4242'
|
|
1437
2982
|
},
|
|
1438
2983
|
exp_month: {
|
|
@@ -1440,42 +2985,56 @@ export const PaymentMethodSchema = {
|
|
|
1440
2985
|
minimum: 1,
|
|
1441
2986
|
maximum: 12,
|
|
1442
2987
|
nullable: true,
|
|
1443
|
-
description: 'Two-digit number representing the card\'s expiration month.',
|
|
1444
|
-
example:
|
|
2988
|
+
description: 'Two-digit number representing the card\'s expiration month. Null for SEPA Direct Debit and bank transfer.',
|
|
2989
|
+
example: 12
|
|
1445
2990
|
},
|
|
1446
2991
|
exp_year: {
|
|
1447
2992
|
type: 'integer',
|
|
1448
|
-
minimum: 2024,
|
|
1449
2993
|
nullable: true,
|
|
1450
|
-
description: 'Four-digit number representing the card\'s expiration year.',
|
|
1451
|
-
example:
|
|
2994
|
+
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.',
|
|
2995
|
+
example: 2028
|
|
1452
2996
|
},
|
|
1453
2997
|
brand: {
|
|
1454
2998
|
type: 'string',
|
|
1455
2999
|
nullable: true,
|
|
1456
|
-
description: 'Payment card brand
|
|
1457
|
-
example: 'visa'
|
|
1458
|
-
|
|
1459
|
-
|
|
1460
|
-
|
|
1461
|
-
|
|
1462
|
-
|
|
1463
|
-
|
|
1464
|
-
|
|
1465
|
-
|
|
1466
|
-
|
|
1467
|
-
|
|
1468
|
-
|
|
3000
|
+
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.',
|
|
3001
|
+
example: 'visa'
|
|
3002
|
+
},
|
|
3003
|
+
iban: {
|
|
3004
|
+
type: 'string',
|
|
3005
|
+
nullable: true,
|
|
3006
|
+
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.',
|
|
3007
|
+
example: 'DE11243015658023127510'
|
|
3008
|
+
},
|
|
3009
|
+
bic: {
|
|
3010
|
+
type: 'string',
|
|
3011
|
+
nullable: true,
|
|
3012
|
+
description: 'BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
3013
|
+
example: 'SOGEDEFFXXX'
|
|
3014
|
+
},
|
|
3015
|
+
account_holder_name: {
|
|
3016
|
+
type: 'string',
|
|
3017
|
+
nullable: true,
|
|
3018
|
+
description: 'Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
3019
|
+
example: 'Cloudfleet GmbH'
|
|
3020
|
+
},
|
|
3021
|
+
is_default: {
|
|
3022
|
+
type: 'boolean',
|
|
3023
|
+
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).',
|
|
3024
|
+
example: true
|
|
1469
3025
|
}
|
|
1470
3026
|
},
|
|
1471
3027
|
required: [
|
|
1472
3028
|
'id',
|
|
1473
|
-
'setup',
|
|
1474
3029
|
'type',
|
|
1475
3030
|
'last4',
|
|
1476
3031
|
'exp_month',
|
|
1477
3032
|
'exp_year',
|
|
1478
|
-
'brand'
|
|
3033
|
+
'brand',
|
|
3034
|
+
'iban',
|
|
3035
|
+
'bic',
|
|
3036
|
+
'account_holder_name',
|
|
3037
|
+
'is_default'
|
|
1479
3038
|
],
|
|
1480
3039
|
additionalProperties: false
|
|
1481
3040
|
};
|
|
@@ -1504,6 +3063,17 @@ export const PlatformQuotaSchema = {
|
|
|
1504
3063
|
description: 'Available number of Pro clusters that can be created.',
|
|
1505
3064
|
example: 999
|
|
1506
3065
|
},
|
|
3066
|
+
enterprise_clusters_max: {
|
|
3067
|
+
type: 'integer',
|
|
3068
|
+
minimum: 0,
|
|
3069
|
+
description: 'Maximum number of Enterprise clusters that can be created.',
|
|
3070
|
+
example: 999
|
|
3071
|
+
},
|
|
3072
|
+
enterprise_clusters_available: {
|
|
3073
|
+
type: 'integer',
|
|
3074
|
+
description: 'Available number of Enterprise clusters that can be created.',
|
|
3075
|
+
example: 999
|
|
3076
|
+
},
|
|
1507
3077
|
fleets_max: {
|
|
1508
3078
|
type: 'integer',
|
|
1509
3079
|
minimum: 0,
|
|
@@ -1523,7 +3093,7 @@ export const PlatformQuotaSchema = {
|
|
|
1523
3093
|
type: 'array',
|
|
1524
3094
|
items: {
|
|
1525
3095
|
type: 'string',
|
|
1526
|
-
example: 'northamerica-central-
|
|
3096
|
+
example: 'northamerica-central-1a'
|
|
1527
3097
|
},
|
|
1528
3098
|
minItems: 1,
|
|
1529
3099
|
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
@@ -1565,6 +3135,8 @@ export const PlatformQuotaSchema = {
|
|
|
1565
3135
|
'basic_clusters_available',
|
|
1566
3136
|
'pro_clusters_max',
|
|
1567
3137
|
'pro_clusters_available',
|
|
3138
|
+
'enterprise_clusters_max',
|
|
3139
|
+
'enterprise_clusters_available',
|
|
1568
3140
|
'fleets_max',
|
|
1569
3141
|
'cluster_tiers',
|
|
1570
3142
|
'regions',
|
|
@@ -1838,6 +3410,73 @@ export const RegistryTagSchema = {
|
|
|
1838
3410
|
],
|
|
1839
3411
|
additionalProperties: false
|
|
1840
3412
|
};
|
|
3413
|
+
export const RoadmapItemCreateInputSchema = {
|
|
3414
|
+
type: 'object',
|
|
3415
|
+
properties: {
|
|
3416
|
+
text: {
|
|
3417
|
+
type: 'string',
|
|
3418
|
+
maxLength: 500,
|
|
3419
|
+
minLength: 1,
|
|
3420
|
+
description: 'Your suggestion in one or two sentences. It is reviewed before it appears on the roadmap.',
|
|
3421
|
+
example: 'Support for ARM nodes on Hetzner.'
|
|
3422
|
+
}
|
|
3423
|
+
},
|
|
3424
|
+
required: [
|
|
3425
|
+
'text'
|
|
3426
|
+
],
|
|
3427
|
+
additionalProperties: false
|
|
3428
|
+
};
|
|
3429
|
+
export const RoadmapItemSchema = {
|
|
3430
|
+
type: 'object',
|
|
3431
|
+
properties: {
|
|
3432
|
+
id: {
|
|
3433
|
+
type: 'string',
|
|
3434
|
+
description: 'Unique identifier of the roadmap item (Mongo ObjectId).',
|
|
3435
|
+
example: '60c72b2f9f1b2c001f8e4d3a'
|
|
3436
|
+
},
|
|
3437
|
+
text: {
|
|
3438
|
+
type: 'string',
|
|
3439
|
+
description: 'Short description of the roadmap item.',
|
|
3440
|
+
example: 'Support for ARM nodes on Hetzner.'
|
|
3441
|
+
},
|
|
3442
|
+
vote: {
|
|
3443
|
+
type: 'integer',
|
|
3444
|
+
nullable: true,
|
|
3445
|
+
description: 'The caller\'s vote on this item: -1 (down), 1 (up), 2 (double up), or null if the caller has not voted.',
|
|
3446
|
+
example: 1,
|
|
3447
|
+
enum: [
|
|
3448
|
+
-1,
|
|
3449
|
+
1,
|
|
3450
|
+
2
|
|
3451
|
+
]
|
|
3452
|
+
}
|
|
3453
|
+
},
|
|
3454
|
+
required: [
|
|
3455
|
+
'id',
|
|
3456
|
+
'text',
|
|
3457
|
+
'vote'
|
|
3458
|
+
],
|
|
3459
|
+
additionalProperties: false
|
|
3460
|
+
};
|
|
3461
|
+
export const RoadmapVoteInputSchema = {
|
|
3462
|
+
type: 'object',
|
|
3463
|
+
properties: {
|
|
3464
|
+
value: {
|
|
3465
|
+
type: 'integer',
|
|
3466
|
+
description: 'Vote value: -1 (down), 1 (up), or 2 (double up).',
|
|
3467
|
+
example: 1,
|
|
3468
|
+
enum: [
|
|
3469
|
+
-1,
|
|
3470
|
+
1,
|
|
3471
|
+
2
|
|
3472
|
+
]
|
|
3473
|
+
}
|
|
3474
|
+
},
|
|
3475
|
+
required: [
|
|
3476
|
+
'value'
|
|
3477
|
+
],
|
|
3478
|
+
additionalProperties: false
|
|
3479
|
+
};
|
|
1841
3480
|
export const TicketAttachmentSchema = {
|
|
1842
3481
|
type: 'object',
|
|
1843
3482
|
properties: {
|
|
@@ -1899,6 +3538,11 @@ export const TicketCreateInputSchema = {
|
|
|
1899
3538
|
subcategory: 'cluster-question',
|
|
1900
3539
|
cluster_id: '60c72b2f9f1b2c001f8e4d3a'
|
|
1901
3540
|
}
|
|
3541
|
+
},
|
|
3542
|
+
grant_support_access: {
|
|
3543
|
+
type: 'boolean',
|
|
3544
|
+
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.',
|
|
3545
|
+
example: true
|
|
1902
3546
|
}
|
|
1903
3547
|
},
|
|
1904
3548
|
required: [
|
|
@@ -1907,172 +3551,6 @@ export const TicketCreateInputSchema = {
|
|
|
1907
3551
|
],
|
|
1908
3552
|
additionalProperties: false
|
|
1909
3553
|
};
|
|
1910
|
-
export const TicketListResponseSchema = {
|
|
1911
|
-
type: 'object',
|
|
1912
|
-
properties: {
|
|
1913
|
-
items: {
|
|
1914
|
-
type: 'array',
|
|
1915
|
-
items: {
|
|
1916
|
-
type: 'object',
|
|
1917
|
-
properties: {
|
|
1918
|
-
id: {
|
|
1919
|
-
type: 'string',
|
|
1920
|
-
description: 'Unique identifier of the ticket (Mongo ObjectId).',
|
|
1921
|
-
example: '60c72b2f9f1b2c001f8e4d3a'
|
|
1922
|
-
},
|
|
1923
|
-
status: {
|
|
1924
|
-
type: 'string',
|
|
1925
|
-
description: 'Current state of the ticket.',
|
|
1926
|
-
example: 'waiting_on_us',
|
|
1927
|
-
enum: [
|
|
1928
|
-
'waiting_on_us',
|
|
1929
|
-
'waiting_on_user',
|
|
1930
|
-
'closed'
|
|
1931
|
-
]
|
|
1932
|
-
},
|
|
1933
|
-
category: {
|
|
1934
|
-
type: 'string',
|
|
1935
|
-
description: 'Ticket category.',
|
|
1936
|
-
example: 'technical',
|
|
1937
|
-
enum: [
|
|
1938
|
-
'billing',
|
|
1939
|
-
'technical',
|
|
1940
|
-
'general'
|
|
1941
|
-
]
|
|
1942
|
-
},
|
|
1943
|
-
summary: {
|
|
1944
|
-
type: 'string',
|
|
1945
|
-
description: 'First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.',
|
|
1946
|
-
example: 'My cluster cannot reach the registry. Logs attached.'
|
|
1947
|
-
},
|
|
1948
|
-
closed_at: {
|
|
1949
|
-
type: 'string',
|
|
1950
|
-
format: 'date-time',
|
|
1951
|
-
nullable: true,
|
|
1952
|
-
description: 'Closure timestamp. Null while the ticket is open.',
|
|
1953
|
-
example: '2026-05-18T16:08:14.338Z'
|
|
1954
|
-
},
|
|
1955
|
-
date_created: {
|
|
1956
|
-
type: 'string',
|
|
1957
|
-
format: 'date-time',
|
|
1958
|
-
description: 'Creation date of the ticket. ISO 8601 UTC.',
|
|
1959
|
-
example: '2026-05-11T16:08:14.338Z'
|
|
1960
|
-
},
|
|
1961
|
-
date_updated: {
|
|
1962
|
-
type: 'string',
|
|
1963
|
-
format: 'date-time',
|
|
1964
|
-
description: 'Last update date of the ticket. ISO 8601 UTC.',
|
|
1965
|
-
example: '2026-05-11T16:08:14.338Z'
|
|
1966
|
-
},
|
|
1967
|
-
messages: {
|
|
1968
|
-
type: 'array',
|
|
1969
|
-
items: {
|
|
1970
|
-
type: 'object',
|
|
1971
|
-
properties: {
|
|
1972
|
-
id: {
|
|
1973
|
-
type: 'string',
|
|
1974
|
-
description: 'Unique identifier of the message (Mongo ObjectId).',
|
|
1975
|
-
example: '60c72b2f9f1b2c001f8e4d3b'
|
|
1976
|
-
},
|
|
1977
|
-
type: {
|
|
1978
|
-
type: 'string',
|
|
1979
|
-
description: 'Message type. Internal notes are filtered out of customer-facing responses.',
|
|
1980
|
-
example: 'customer_reply',
|
|
1981
|
-
enum: [
|
|
1982
|
-
'customer_reply',
|
|
1983
|
-
'agent_reply'
|
|
1984
|
-
]
|
|
1985
|
-
},
|
|
1986
|
-
body: {
|
|
1987
|
-
type: 'string',
|
|
1988
|
-
description: 'Message body in markdown.',
|
|
1989
|
-
example: 'Thanks — that resolved it on my side.'
|
|
1990
|
-
},
|
|
1991
|
-
author_first_name: {
|
|
1992
|
-
type: 'string',
|
|
1993
|
-
nullable: true,
|
|
1994
|
-
description: 'First name of the author. Null when not provided.',
|
|
1995
|
-
example: 'Jane'
|
|
1996
|
-
},
|
|
1997
|
-
author_last_name: {
|
|
1998
|
-
type: 'string',
|
|
1999
|
-
nullable: true,
|
|
2000
|
-
description: 'Last name of the author. Null when not provided.',
|
|
2001
|
-
example: 'Doe'
|
|
2002
|
-
},
|
|
2003
|
-
attachments: {
|
|
2004
|
-
type: 'array',
|
|
2005
|
-
items: {
|
|
2006
|
-
type: 'object',
|
|
2007
|
-
properties: {
|
|
2008
|
-
id: {
|
|
2009
|
-
type: 'string',
|
|
2010
|
-
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
2011
|
-
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
2012
|
-
},
|
|
2013
|
-
filename: {
|
|
2014
|
-
type: 'string',
|
|
2015
|
-
description: 'Original filename as uploaded.',
|
|
2016
|
-
example: 'debug.log'
|
|
2017
|
-
},
|
|
2018
|
-
content_type: {
|
|
2019
|
-
type: 'string',
|
|
2020
|
-
description: 'MIME content type of the attachment.',
|
|
2021
|
-
example: 'text/plain'
|
|
2022
|
-
},
|
|
2023
|
-
size: {
|
|
2024
|
-
type: 'integer',
|
|
2025
|
-
description: 'Size of the attachment in bytes.',
|
|
2026
|
-
example: 12345
|
|
2027
|
-
}
|
|
2028
|
-
},
|
|
2029
|
-
required: [
|
|
2030
|
-
'id',
|
|
2031
|
-
'filename',
|
|
2032
|
-
'content_type',
|
|
2033
|
-
'size'
|
|
2034
|
-
],
|
|
2035
|
-
additionalProperties: false
|
|
2036
|
-
},
|
|
2037
|
-
description: 'Attachments associated with this message.',
|
|
2038
|
-
example: []
|
|
2039
|
-
},
|
|
2040
|
-
date_created: {
|
|
2041
|
-
type: 'string',
|
|
2042
|
-
format: 'date-time',
|
|
2043
|
-
description: 'Creation date of the message. ISO 8601 UTC.',
|
|
2044
|
-
example: '2026-05-11T16:08:14.338Z'
|
|
2045
|
-
}
|
|
2046
|
-
},
|
|
2047
|
-
required: [
|
|
2048
|
-
'id',
|
|
2049
|
-
'type',
|
|
2050
|
-
'body',
|
|
2051
|
-
'date_created'
|
|
2052
|
-
],
|
|
2053
|
-
additionalProperties: false
|
|
2054
|
-
},
|
|
2055
|
-
description: 'Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.'
|
|
2056
|
-
}
|
|
2057
|
-
},
|
|
2058
|
-
required: [
|
|
2059
|
-
'id',
|
|
2060
|
-
'status',
|
|
2061
|
-
'category',
|
|
2062
|
-
'summary',
|
|
2063
|
-
'date_created',
|
|
2064
|
-
'date_updated'
|
|
2065
|
-
],
|
|
2066
|
-
additionalProperties: false
|
|
2067
|
-
},
|
|
2068
|
-
description: 'Tickets for the organization, ordered newest first. Messages are omitted from list responses.'
|
|
2069
|
-
}
|
|
2070
|
-
},
|
|
2071
|
-
required: [
|
|
2072
|
-
'items'
|
|
2073
|
-
],
|
|
2074
|
-
additionalProperties: false
|
|
2075
|
-
};
|
|
2076
3554
|
export const TicketMessageInputSchema = {
|
|
2077
3555
|
type: 'object',
|
|
2078
3556
|
properties: {
|
|
@@ -2114,11 +3592,13 @@ export const TicketMessageSchema = {
|
|
|
2114
3592
|
},
|
|
2115
3593
|
author_first_name: {
|
|
2116
3594
|
type: 'string',
|
|
3595
|
+
nullable: true,
|
|
2117
3596
|
description: 'First name of the author. Null when not provided.',
|
|
2118
3597
|
example: 'Jane'
|
|
2119
3598
|
},
|
|
2120
3599
|
author_last_name: {
|
|
2121
3600
|
type: 'string',
|
|
3601
|
+
nullable: true,
|
|
2122
3602
|
description: 'Last name of the author. Null when not provided.',
|
|
2123
3603
|
example: 'Doe'
|
|
2124
3604
|
},
|
|
@@ -2207,9 +3687,22 @@ export const TicketSchema = {
|
|
|
2207
3687
|
description: 'First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.',
|
|
2208
3688
|
example: 'My cluster cannot reach the registry. Logs attached.'
|
|
2209
3689
|
},
|
|
3690
|
+
support_access_granted: {
|
|
3691
|
+
type: 'boolean',
|
|
3692
|
+
description: 'Whether Cloudfleet support staff currently have access to the organization\'s resources. True once access is granted and until the ticket is closed.',
|
|
3693
|
+
example: true
|
|
3694
|
+
},
|
|
3695
|
+
support_access_granted_at: {
|
|
3696
|
+
type: 'string',
|
|
3697
|
+
format: 'date-time',
|
|
3698
|
+
nullable: true,
|
|
3699
|
+
description: 'When support access was granted. Null if it never was. Kept after the ticket is closed.',
|
|
3700
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
3701
|
+
},
|
|
2210
3702
|
closed_at: {
|
|
2211
3703
|
type: 'string',
|
|
2212
3704
|
format: 'date-time',
|
|
3705
|
+
nullable: true,
|
|
2213
3706
|
description: 'Closure timestamp. Null while the ticket is open.',
|
|
2214
3707
|
example: '2026-05-18T16:08:14.338Z'
|
|
2215
3708
|
},
|
|
@@ -2319,6 +3812,8 @@ export const TicketSchema = {
|
|
|
2319
3812
|
'status',
|
|
2320
3813
|
'category',
|
|
2321
3814
|
'summary',
|
|
3815
|
+
'support_access_granted',
|
|
3816
|
+
'support_access_granted_at',
|
|
2322
3817
|
'date_created',
|
|
2323
3818
|
'date_updated'
|
|
2324
3819
|
],
|
|
@@ -2434,12 +3929,21 @@ export const UsageFacetsSchema = {
|
|
|
2434
3929
|
product: {
|
|
2435
3930
|
type: 'array',
|
|
2436
3931
|
items: {
|
|
2437
|
-
type: 'string'
|
|
3932
|
+
type: 'string',
|
|
3933
|
+
enum: [
|
|
3934
|
+
'cfke_controlplane_basic',
|
|
3935
|
+
'cfke_controlplane_pro',
|
|
3936
|
+
'cfke_controlplane_enterprise',
|
|
3937
|
+
'cfke_connected_nodes_basic',
|
|
3938
|
+
'cfke_connected_nodes_pro',
|
|
3939
|
+
'cfke_connected_nodes_enterprise',
|
|
3940
|
+
'cfcr_storage'
|
|
3941
|
+
]
|
|
2438
3942
|
},
|
|
2439
3943
|
description: 'List of unique products',
|
|
2440
3944
|
example: [
|
|
2441
|
-
'
|
|
2442
|
-
'
|
|
3945
|
+
'cfke_controlplane_pro',
|
|
3946
|
+
'cfke_connected_nodes_pro'
|
|
2443
3947
|
]
|
|
2444
3948
|
}
|
|
2445
3949
|
},
|
|
@@ -2466,7 +3970,16 @@ export const UsageResponseSchema = {
|
|
|
2466
3970
|
product: {
|
|
2467
3971
|
type: 'string',
|
|
2468
3972
|
description: 'The product the usage is associated with',
|
|
2469
|
-
example: '
|
|
3973
|
+
example: 'cfke_controlplane_pro',
|
|
3974
|
+
enum: [
|
|
3975
|
+
'cfke_controlplane_basic',
|
|
3976
|
+
'cfke_controlplane_pro',
|
|
3977
|
+
'cfke_controlplane_enterprise',
|
|
3978
|
+
'cfke_connected_nodes_basic',
|
|
3979
|
+
'cfke_connected_nodes_pro',
|
|
3980
|
+
'cfke_connected_nodes_enterprise',
|
|
3981
|
+
'cfcr_storage'
|
|
3982
|
+
]
|
|
2470
3983
|
},
|
|
2471
3984
|
value: {
|
|
2472
3985
|
type: 'number',
|
|
@@ -2514,12 +4027,21 @@ export const UsageResponseSchema = {
|
|
|
2514
4027
|
product: {
|
|
2515
4028
|
type: 'array',
|
|
2516
4029
|
items: {
|
|
2517
|
-
type: 'string'
|
|
4030
|
+
type: 'string',
|
|
4031
|
+
enum: [
|
|
4032
|
+
'cfke_controlplane_basic',
|
|
4033
|
+
'cfke_controlplane_pro',
|
|
4034
|
+
'cfke_controlplane_enterprise',
|
|
4035
|
+
'cfke_connected_nodes_basic',
|
|
4036
|
+
'cfke_connected_nodes_pro',
|
|
4037
|
+
'cfke_connected_nodes_enterprise',
|
|
4038
|
+
'cfcr_storage'
|
|
4039
|
+
]
|
|
2518
4040
|
},
|
|
2519
4041
|
description: 'List of unique products',
|
|
2520
4042
|
example: [
|
|
2521
|
-
'
|
|
2522
|
-
'
|
|
4043
|
+
'cfke_controlplane_pro',
|
|
4044
|
+
'cfke_connected_nodes_pro'
|
|
2523
4045
|
]
|
|
2524
4046
|
}
|
|
2525
4047
|
},
|
|
@@ -2549,7 +4071,16 @@ export const UsageSchema = {
|
|
|
2549
4071
|
product: {
|
|
2550
4072
|
type: 'string',
|
|
2551
4073
|
description: 'The product the usage is associated with',
|
|
2552
|
-
example: '
|
|
4074
|
+
example: 'cfke_controlplane_pro',
|
|
4075
|
+
enum: [
|
|
4076
|
+
'cfke_controlplane_basic',
|
|
4077
|
+
'cfke_controlplane_pro',
|
|
4078
|
+
'cfke_controlplane_enterprise',
|
|
4079
|
+
'cfke_connected_nodes_basic',
|
|
4080
|
+
'cfke_connected_nodes_pro',
|
|
4081
|
+
'cfke_connected_nodes_enterprise',
|
|
4082
|
+
'cfcr_storage'
|
|
4083
|
+
]
|
|
2553
4084
|
},
|
|
2554
4085
|
value: {
|
|
2555
4086
|
type: 'number',
|
|
@@ -2612,24 +4143,6 @@ export const UserCreateInputSchema = {
|
|
|
2612
4143
|
type: 'string',
|
|
2613
4144
|
minLength: 8,
|
|
2614
4145
|
description: 'User password. Must be at least 8 characters long.'
|
|
2615
|
-
},
|
|
2616
|
-
status: {
|
|
2617
|
-
type: 'string',
|
|
2618
|
-
description: 'Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.',
|
|
2619
|
-
example: 'active',
|
|
2620
|
-
enum: [
|
|
2621
|
-
'active',
|
|
2622
|
-
'inactive'
|
|
2623
|
-
]
|
|
2624
|
-
},
|
|
2625
|
-
role: {
|
|
2626
|
-
type: 'string',
|
|
2627
|
-
description: 'User role. Can be \'Administrator\', \'User\'.',
|
|
2628
|
-
example: 'User',
|
|
2629
|
-
enum: [
|
|
2630
|
-
'Administrator',
|
|
2631
|
-
'User'
|
|
2632
|
-
]
|
|
2633
4146
|
}
|
|
2634
4147
|
},
|
|
2635
4148
|
required: [
|