@cloudfleet/sdk 0.0.1-cfddf24 → 0.0.1-d3aa845
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 +420 -386
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -1
- package/dist/@tanstack/react-query.gen.js +428 -382
- 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 +437 -225
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +587 -317
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +237 -215
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +338 -312
- package/dist/sdk.gen.js.map +1 -1
- package/dist/types.gen.d.ts +1049 -790
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +1650 -1477
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +481 -350
- package/dist/zod.gen.js.map +1 -1
- package/package.json +8 -11
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,
|
|
@@ -207,6 +216,7 @@ export const BillingContactSchema = {
|
|
|
207
216
|
}
|
|
208
217
|
},
|
|
209
218
|
required: [
|
|
219
|
+
'type',
|
|
210
220
|
'email',
|
|
211
221
|
'individual_name'
|
|
212
222
|
],
|
|
@@ -358,24 +368,8 @@ export const ChartSchema = {
|
|
|
358
368
|
},
|
|
359
369
|
status: {
|
|
360
370
|
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
|
-
]
|
|
371
|
+
description: 'Status of the chart deployment (Flux HelmRelease Ready condition reason, e.g. InstallSucceeded, UpgradeFailed, Progressing).',
|
|
372
|
+
example: 'InstallSucceeded'
|
|
379
373
|
},
|
|
380
374
|
version_current: {
|
|
381
375
|
type: 'string',
|
|
@@ -446,22 +440,12 @@ export const ClusterCreateInputSchema = {
|
|
|
446
440
|
tier: {
|
|
447
441
|
type: 'string',
|
|
448
442
|
description: 'Tier of the cluster.',
|
|
443
|
+
default: 'basic',
|
|
449
444
|
example: 'pro',
|
|
450
445
|
enum: [
|
|
451
446
|
'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'
|
|
447
|
+
'pro',
|
|
448
|
+
'enterprise'
|
|
465
449
|
]
|
|
466
450
|
},
|
|
467
451
|
version_channel: {
|
|
@@ -469,20 +453,105 @@ export const ClusterCreateInputSchema = {
|
|
|
469
453
|
pattern: '^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$',
|
|
470
454
|
description: 'Version of the kubernetes cluster.',
|
|
471
455
|
default: '1.x.x-cfke.x',
|
|
472
|
-
example: '1.x.x-cfke.x'
|
|
456
|
+
example: '1.x.x-cfke.x'
|
|
457
|
+
},
|
|
458
|
+
release_channel: {
|
|
459
|
+
type: 'string',
|
|
460
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
461
|
+
default: 'rapid',
|
|
462
|
+
example: 'rapid',
|
|
473
463
|
enum: [
|
|
474
|
-
'
|
|
475
|
-
'
|
|
476
|
-
'
|
|
477
|
-
'1.33.x-cfke.x'
|
|
464
|
+
'rapid',
|
|
465
|
+
'stable',
|
|
466
|
+
'extended'
|
|
478
467
|
]
|
|
468
|
+
},
|
|
469
|
+
features: {
|
|
470
|
+
type: 'object',
|
|
471
|
+
properties: {
|
|
472
|
+
gpu_sharing_strategy: {
|
|
473
|
+
type: 'string',
|
|
474
|
+
description: 'GPU sharing strategy.',
|
|
475
|
+
default: 'none',
|
|
476
|
+
example: 'none',
|
|
477
|
+
enum: [
|
|
478
|
+
'none',
|
|
479
|
+
'mps',
|
|
480
|
+
'time_slicing'
|
|
481
|
+
]
|
|
482
|
+
},
|
|
483
|
+
gpu_max_shared_clients_per_gpu: {
|
|
484
|
+
type: 'integer',
|
|
485
|
+
minimum: 2,
|
|
486
|
+
maximum: 48,
|
|
487
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
488
|
+
default: 4,
|
|
489
|
+
example: 10
|
|
490
|
+
},
|
|
491
|
+
cilium_socket_lb_host_namespace_only: {
|
|
492
|
+
type: 'boolean',
|
|
493
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
494
|
+
example: false
|
|
495
|
+
}
|
|
496
|
+
},
|
|
497
|
+
additionalProperties: false,
|
|
498
|
+
description: 'Cluster feature toggles.',
|
|
499
|
+
default: {
|
|
500
|
+
gpu_sharing_strategy: 'none',
|
|
501
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
502
|
+
cilium_socket_lb_host_namespace_only: false
|
|
503
|
+
}
|
|
504
|
+
},
|
|
505
|
+
region: {
|
|
506
|
+
type: 'string',
|
|
507
|
+
description: 'Cloudfleet control plane region. This field can not be updated after creation.',
|
|
508
|
+
example: 'europe-central-1a'
|
|
509
|
+
},
|
|
510
|
+
networking: {
|
|
511
|
+
type: 'object',
|
|
512
|
+
properties: {
|
|
513
|
+
pod_cidr: {
|
|
514
|
+
type: 'string',
|
|
515
|
+
description: 'CIDR block for pod IPs.',
|
|
516
|
+
default: '10.244.0.0/16'
|
|
517
|
+
},
|
|
518
|
+
service_cidr: {
|
|
519
|
+
type: 'string',
|
|
520
|
+
description: 'CIDR block for service IPs.',
|
|
521
|
+
default: '10.96.0.0/12'
|
|
522
|
+
},
|
|
523
|
+
dual_stack: {
|
|
524
|
+
type: 'boolean',
|
|
525
|
+
description: 'Enable IPv4+IPv6 dual-stack networking.'
|
|
526
|
+
},
|
|
527
|
+
pod_cidr_v6: {
|
|
528
|
+
type: 'string',
|
|
529
|
+
description: 'IPv6 pod CIDR. Requires dual_stack.',
|
|
530
|
+
default: '2001:db8:1:2::/48'
|
|
531
|
+
},
|
|
532
|
+
service_cidr_v6: {
|
|
533
|
+
type: 'string',
|
|
534
|
+
description: 'IPv6 service CIDR. Requires dual_stack.',
|
|
535
|
+
default: '2001:db8:1:1::/112'
|
|
536
|
+
}
|
|
537
|
+
},
|
|
538
|
+
additionalProperties: false,
|
|
539
|
+
description: 'Cluster networking configuration. Immutable after creation.',
|
|
540
|
+
default: {
|
|
541
|
+
pod_cidr: '10.244.0.0/16',
|
|
542
|
+
service_cidr: '10.96.0.0/12',
|
|
543
|
+
dual_stack: false,
|
|
544
|
+
pod_cidr_v6: '2001:db8:1:2::/48',
|
|
545
|
+
service_cidr_v6: '2001:db8:1:1::/112'
|
|
546
|
+
}
|
|
479
547
|
}
|
|
480
548
|
},
|
|
481
549
|
required: [
|
|
482
550
|
'name',
|
|
483
|
-
'
|
|
551
|
+
'region'
|
|
484
552
|
],
|
|
485
|
-
additionalProperties: false
|
|
553
|
+
additionalProperties: false,
|
|
554
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
486
555
|
};
|
|
487
556
|
export const ClusterJoinInformationSchema = {
|
|
488
557
|
type: 'object',
|
|
@@ -503,6 +572,11 @@ export const ClusterJoinInformationSchema = {
|
|
|
503
572
|
description: 'Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.',
|
|
504
573
|
example: '10.96.0.10'
|
|
505
574
|
},
|
|
575
|
+
pod_cidr: {
|
|
576
|
+
type: 'string',
|
|
577
|
+
description: 'Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.',
|
|
578
|
+
example: '10.244.0.0/16'
|
|
579
|
+
},
|
|
506
580
|
auth_key: {
|
|
507
581
|
type: 'string',
|
|
508
582
|
description: 'Authentication key for the cluster.',
|
|
@@ -578,6 +652,7 @@ export const ClusterJoinInformationSchema = {
|
|
|
578
652
|
'certificate_authority',
|
|
579
653
|
'endpoint',
|
|
580
654
|
'cluster_dns',
|
|
655
|
+
'pod_cidr',
|
|
581
656
|
'auth_key',
|
|
582
657
|
'bootstrap_token',
|
|
583
658
|
'versions',
|
|
@@ -599,24 +674,123 @@ export const ClusterSchema = {
|
|
|
599
674
|
tier: {
|
|
600
675
|
type: 'string',
|
|
601
676
|
description: 'Tier of the cluster.',
|
|
677
|
+
default: 'basic',
|
|
602
678
|
example: 'pro',
|
|
603
679
|
enum: [
|
|
604
680
|
'basic',
|
|
605
|
-
'pro'
|
|
681
|
+
'pro',
|
|
682
|
+
'enterprise'
|
|
606
683
|
]
|
|
607
684
|
},
|
|
608
|
-
|
|
685
|
+
version_channel: {
|
|
609
686
|
type: 'string',
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
687
|
+
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-]+)*))?$',
|
|
688
|
+
description: 'Version of the kubernetes cluster.',
|
|
689
|
+
default: '1.x.x-cfke.x',
|
|
690
|
+
example: '1.x.x-cfke.x'
|
|
691
|
+
},
|
|
692
|
+
release_channel: {
|
|
693
|
+
type: 'string',
|
|
694
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
695
|
+
default: 'rapid',
|
|
696
|
+
example: 'rapid',
|
|
613
697
|
enum: [
|
|
614
|
-
'
|
|
615
|
-
'
|
|
616
|
-
'
|
|
617
|
-
'northamerica-central-1a'
|
|
698
|
+
'rapid',
|
|
699
|
+
'stable',
|
|
700
|
+
'extended'
|
|
618
701
|
]
|
|
619
702
|
},
|
|
703
|
+
features: {
|
|
704
|
+
type: 'object',
|
|
705
|
+
properties: {
|
|
706
|
+
gpu_sharing_strategy: {
|
|
707
|
+
type: 'string',
|
|
708
|
+
description: 'GPU sharing strategy.',
|
|
709
|
+
default: 'none',
|
|
710
|
+
example: 'none',
|
|
711
|
+
enum: [
|
|
712
|
+
'none',
|
|
713
|
+
'mps',
|
|
714
|
+
'time_slicing'
|
|
715
|
+
]
|
|
716
|
+
},
|
|
717
|
+
gpu_max_shared_clients_per_gpu: {
|
|
718
|
+
type: 'integer',
|
|
719
|
+
minimum: 2,
|
|
720
|
+
maximum: 48,
|
|
721
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
722
|
+
default: 4,
|
|
723
|
+
example: 10
|
|
724
|
+
},
|
|
725
|
+
cilium_socket_lb_host_namespace_only: {
|
|
726
|
+
type: 'boolean',
|
|
727
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
728
|
+
example: false
|
|
729
|
+
}
|
|
730
|
+
},
|
|
731
|
+
required: [
|
|
732
|
+
'gpu_sharing_strategy',
|
|
733
|
+
'gpu_max_shared_clients_per_gpu',
|
|
734
|
+
'cilium_socket_lb_host_namespace_only'
|
|
735
|
+
],
|
|
736
|
+
additionalProperties: false,
|
|
737
|
+
description: 'Cluster feature toggles.',
|
|
738
|
+
default: {
|
|
739
|
+
gpu_sharing_strategy: 'none',
|
|
740
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
741
|
+
cilium_socket_lb_host_namespace_only: false
|
|
742
|
+
}
|
|
743
|
+
},
|
|
744
|
+
region: {
|
|
745
|
+
type: 'string',
|
|
746
|
+
description: 'Cloudfleet control plane region. This field can not be updated after creation.',
|
|
747
|
+
example: 'europe-central-1a'
|
|
748
|
+
},
|
|
749
|
+
networking: {
|
|
750
|
+
type: 'object',
|
|
751
|
+
properties: {
|
|
752
|
+
pod_cidr: {
|
|
753
|
+
type: 'string',
|
|
754
|
+
description: 'CIDR block for pod IPs.',
|
|
755
|
+
default: '10.244.0.0/16'
|
|
756
|
+
},
|
|
757
|
+
service_cidr: {
|
|
758
|
+
type: 'string',
|
|
759
|
+
description: 'CIDR block for service IPs.',
|
|
760
|
+
default: '10.96.0.0/12'
|
|
761
|
+
},
|
|
762
|
+
dual_stack: {
|
|
763
|
+
type: 'boolean',
|
|
764
|
+
description: 'Enable IPv4+IPv6 dual-stack networking.'
|
|
765
|
+
},
|
|
766
|
+
pod_cidr_v6: {
|
|
767
|
+
type: 'string',
|
|
768
|
+
description: 'IPv6 pod CIDR. Requires dual_stack.',
|
|
769
|
+
default: '2001:db8:1:2::/48'
|
|
770
|
+
},
|
|
771
|
+
service_cidr_v6: {
|
|
772
|
+
type: 'string',
|
|
773
|
+
description: 'IPv6 service CIDR. Requires dual_stack.',
|
|
774
|
+
default: '2001:db8:1:1::/112'
|
|
775
|
+
}
|
|
776
|
+
},
|
|
777
|
+
required: [
|
|
778
|
+
'pod_cidr',
|
|
779
|
+
'service_cidr',
|
|
780
|
+
'dual_stack',
|
|
781
|
+
'pod_cidr_v6',
|
|
782
|
+
'service_cidr_v6'
|
|
783
|
+
],
|
|
784
|
+
additionalProperties: false,
|
|
785
|
+
description: 'Cluster networking configuration. Immutable after creation.',
|
|
786
|
+
default: {
|
|
787
|
+
pod_cidr: '10.244.0.0/16',
|
|
788
|
+
service_cidr: '10.96.0.0/12',
|
|
789
|
+
dual_stack: false,
|
|
790
|
+
pod_cidr_v6: '2001:db8:1:2::/48',
|
|
791
|
+
service_cidr_v6: '2001:db8:1:1::/112'
|
|
792
|
+
}
|
|
793
|
+
},
|
|
620
794
|
id: {
|
|
621
795
|
type: 'string',
|
|
622
796
|
format: 'uuid',
|
|
@@ -625,16 +799,13 @@ export const ClusterSchema = {
|
|
|
625
799
|
},
|
|
626
800
|
status: {
|
|
627
801
|
type: 'string',
|
|
628
|
-
description: 'Status of the cluster.
|
|
629
|
-
example: '
|
|
802
|
+
description: 'Status of the cluster.',
|
|
803
|
+
example: 'deployed',
|
|
630
804
|
enum: [
|
|
631
|
-
'active',
|
|
632
|
-
'disabled',
|
|
633
|
-
'deleted',
|
|
634
805
|
'creating',
|
|
635
806
|
'deployed',
|
|
636
|
-
'
|
|
637
|
-
'
|
|
807
|
+
'updating',
|
|
808
|
+
'disabled'
|
|
638
809
|
]
|
|
639
810
|
},
|
|
640
811
|
endpoint: {
|
|
@@ -642,8 +813,8 @@ export const ClusterSchema = {
|
|
|
642
813
|
{
|
|
643
814
|
type: 'string',
|
|
644
815
|
format: 'uri',
|
|
645
|
-
description: 'URL signed by
|
|
646
|
-
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
816
|
+
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.',
|
|
817
|
+
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
647
818
|
},
|
|
648
819
|
{
|
|
649
820
|
type: 'string',
|
|
@@ -658,7 +829,7 @@ export const ClusterSchema = {
|
|
|
658
829
|
{
|
|
659
830
|
type: 'string',
|
|
660
831
|
format: 'uri',
|
|
661
|
-
description: '
|
|
832
|
+
description: 'Deprecated alias of `endpoint`; retained for backward compatibility.',
|
|
662
833
|
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
663
834
|
},
|
|
664
835
|
{
|
|
@@ -693,21 +864,22 @@ export const ClusterSchema = {
|
|
|
693
864
|
type: 'boolean',
|
|
694
865
|
description: 'Indicates if the cluster is ready to be used.',
|
|
695
866
|
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
867
|
}
|
|
703
868
|
},
|
|
704
869
|
required: [
|
|
705
870
|
'name',
|
|
706
871
|
'tier',
|
|
872
|
+
'version_channel',
|
|
873
|
+
'release_channel',
|
|
874
|
+
'features',
|
|
875
|
+
'region',
|
|
876
|
+
'networking',
|
|
707
877
|
'id',
|
|
708
|
-
'status'
|
|
878
|
+
'status',
|
|
879
|
+
'ready'
|
|
709
880
|
],
|
|
710
|
-
additionalProperties: false
|
|
881
|
+
additionalProperties: false,
|
|
882
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
711
883
|
};
|
|
712
884
|
export const ClusterUpdateInputSchema = {
|
|
713
885
|
type: 'object',
|
|
@@ -723,23 +895,74 @@ export const ClusterUpdateInputSchema = {
|
|
|
723
895
|
tier: {
|
|
724
896
|
type: 'string',
|
|
725
897
|
description: 'Tier of the cluster.',
|
|
898
|
+
default: 'basic',
|
|
726
899
|
example: 'pro',
|
|
727
900
|
enum: [
|
|
728
901
|
'basic',
|
|
729
|
-
'pro'
|
|
902
|
+
'pro',
|
|
903
|
+
'enterprise'
|
|
730
904
|
]
|
|
731
905
|
},
|
|
732
906
|
version_channel: {
|
|
733
907
|
type: 'string',
|
|
734
908
|
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
909
|
description: 'Version of the kubernetes cluster.',
|
|
910
|
+
default: '1.x.x-cfke.x',
|
|
736
911
|
example: '1.x.x-cfke.x'
|
|
912
|
+
},
|
|
913
|
+
release_channel: {
|
|
914
|
+
type: 'string',
|
|
915
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
916
|
+
default: 'rapid',
|
|
917
|
+
example: 'rapid',
|
|
918
|
+
enum: [
|
|
919
|
+
'rapid',
|
|
920
|
+
'stable',
|
|
921
|
+
'extended'
|
|
922
|
+
]
|
|
923
|
+
},
|
|
924
|
+
features: {
|
|
925
|
+
type: 'object',
|
|
926
|
+
properties: {
|
|
927
|
+
gpu_sharing_strategy: {
|
|
928
|
+
type: 'string',
|
|
929
|
+
description: 'GPU sharing strategy.',
|
|
930
|
+
default: 'none',
|
|
931
|
+
example: 'none',
|
|
932
|
+
enum: [
|
|
933
|
+
'none',
|
|
934
|
+
'mps',
|
|
935
|
+
'time_slicing'
|
|
936
|
+
]
|
|
937
|
+
},
|
|
938
|
+
gpu_max_shared_clients_per_gpu: {
|
|
939
|
+
type: 'integer',
|
|
940
|
+
minimum: 2,
|
|
941
|
+
maximum: 48,
|
|
942
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
943
|
+
default: 4,
|
|
944
|
+
example: 10
|
|
945
|
+
},
|
|
946
|
+
cilium_socket_lb_host_namespace_only: {
|
|
947
|
+
type: 'boolean',
|
|
948
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
949
|
+
example: false
|
|
950
|
+
}
|
|
951
|
+
},
|
|
952
|
+
additionalProperties: false,
|
|
953
|
+
description: 'Cluster feature toggles.',
|
|
954
|
+
default: {
|
|
955
|
+
gpu_sharing_strategy: 'none',
|
|
956
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
957
|
+
cilium_socket_lb_host_namespace_only: false
|
|
958
|
+
}
|
|
737
959
|
}
|
|
738
960
|
},
|
|
739
961
|
required: [
|
|
740
|
-
'
|
|
962
|
+
'name'
|
|
741
963
|
],
|
|
742
|
-
additionalProperties: false
|
|
964
|
+
additionalProperties: false,
|
|
965
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
743
966
|
};
|
|
744
967
|
export const FleetCreateInputSchema = {
|
|
745
968
|
type: 'object',
|
|
@@ -785,8 +1008,8 @@ export const FleetCreateInputSchema = {
|
|
|
785
1008
|
type: 'string',
|
|
786
1009
|
maxLength: 64,
|
|
787
1010
|
minLength: 64,
|
|
788
|
-
pattern: '^[A-Za-z0-9]
|
|
789
|
-
description: 'Hetzner Cloud API token with read
|
|
1011
|
+
pattern: '^([A-Za-z0-9]{64}|\\*{64})$',
|
|
1012
|
+
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
1013
|
}
|
|
791
1014
|
},
|
|
792
1015
|
required: [
|
|
@@ -1011,7 +1234,8 @@ export const FleetCreateInputSchema = {
|
|
|
1011
1234
|
'z3'
|
|
1012
1235
|
]
|
|
1013
1236
|
},
|
|
1014
|
-
description: 'Allowed values for `cfke.io/instance-family`.'
|
|
1237
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
1238
|
+
default: []
|
|
1015
1239
|
},
|
|
1016
1240
|
'topology.kubernetes.io/region': {
|
|
1017
1241
|
type: 'array',
|
|
@@ -1084,15 +1308,27 @@ export const FleetCreateInputSchema = {
|
|
|
1084
1308
|
'us-west4'
|
|
1085
1309
|
]
|
|
1086
1310
|
},
|
|
1087
|
-
description: 'Allowed values for `topology.kubernetes.io/region`.'
|
|
1311
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
1312
|
+
default: []
|
|
1088
1313
|
}
|
|
1089
1314
|
},
|
|
1090
1315
|
additionalProperties: false,
|
|
1091
|
-
description: 'Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.
|
|
1316
|
+
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.',
|
|
1317
|
+
default: {
|
|
1318
|
+
'karpenter.sh/capacity-type': [
|
|
1319
|
+
'on-demand',
|
|
1320
|
+
'spot'
|
|
1321
|
+
],
|
|
1322
|
+
'kubernetes.io/arch': [
|
|
1323
|
+
'amd64'
|
|
1324
|
+
],
|
|
1325
|
+
'cfke.io/instance-family': [],
|
|
1326
|
+
'topology.kubernetes.io/region': []
|
|
1327
|
+
}
|
|
1092
1328
|
},
|
|
1093
1329
|
scalingProfile: {
|
|
1094
1330
|
type: 'string',
|
|
1095
|
-
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.',
|
|
1331
|
+
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`).',
|
|
1096
1332
|
default: 'conservative',
|
|
1097
1333
|
example: 'conservative',
|
|
1098
1334
|
enum: [
|
|
@@ -1112,7 +1348,8 @@ export const FleetCreateInputSchema = {
|
|
|
1112
1348
|
required: [
|
|
1113
1349
|
'id'
|
|
1114
1350
|
],
|
|
1115
|
-
additionalProperties: false
|
|
1351
|
+
additionalProperties: false,
|
|
1352
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
1116
1353
|
};
|
|
1117
1354
|
export const FleetSchema = {
|
|
1118
1355
|
type: 'object',
|
|
@@ -1382,7 +1619,8 @@ export const FleetSchema = {
|
|
|
1382
1619
|
'z3'
|
|
1383
1620
|
]
|
|
1384
1621
|
},
|
|
1385
|
-
description: 'Allowed values for `cfke.io/instance-family`.'
|
|
1622
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
1623
|
+
default: []
|
|
1386
1624
|
},
|
|
1387
1625
|
'topology.kubernetes.io/region': {
|
|
1388
1626
|
type: 'array',
|
|
@@ -1455,15 +1693,31 @@ export const FleetSchema = {
|
|
|
1455
1693
|
'us-west4'
|
|
1456
1694
|
]
|
|
1457
1695
|
},
|
|
1458
|
-
description: 'Allowed values for `topology.kubernetes.io/region`.'
|
|
1696
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
1697
|
+
default: []
|
|
1459
1698
|
}
|
|
1460
1699
|
},
|
|
1700
|
+
required: [
|
|
1701
|
+
'karpenter.sh/capacity-type',
|
|
1702
|
+
'kubernetes.io/arch'
|
|
1703
|
+
],
|
|
1461
1704
|
additionalProperties: false,
|
|
1462
|
-
description: 'Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.
|
|
1705
|
+
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.',
|
|
1706
|
+
default: {
|
|
1707
|
+
'karpenter.sh/capacity-type': [
|
|
1708
|
+
'on-demand',
|
|
1709
|
+
'spot'
|
|
1710
|
+
],
|
|
1711
|
+
'kubernetes.io/arch': [
|
|
1712
|
+
'amd64'
|
|
1713
|
+
],
|
|
1714
|
+
'cfke.io/instance-family': [],
|
|
1715
|
+
'topology.kubernetes.io/region': []
|
|
1716
|
+
}
|
|
1463
1717
|
},
|
|
1464
1718
|
scalingProfile: {
|
|
1465
1719
|
type: 'string',
|
|
1466
|
-
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.',
|
|
1720
|
+
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).',
|
|
1467
1721
|
default: 'conservative',
|
|
1468
1722
|
example: 'conservative',
|
|
1469
1723
|
enum: [
|
|
@@ -1478,13 +1732,38 @@ export const FleetSchema = {
|
|
|
1478
1732
|
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
1479
1733
|
description: 'Unique identifier of the kubernetes fleet.',
|
|
1480
1734
|
example: 'new-clouds-fleet'
|
|
1735
|
+
},
|
|
1736
|
+
ready: {
|
|
1737
|
+
type: 'boolean',
|
|
1738
|
+
description: 'Indicates whether the fleet configuration is healthy.',
|
|
1739
|
+
example: true
|
|
1740
|
+
},
|
|
1741
|
+
status_message: {
|
|
1742
|
+
type: 'string',
|
|
1743
|
+
description: 'Human-readable reason the fleet is not ready. Present only when `ready` is false.',
|
|
1744
|
+
example: 'Invalid provider permissions.'
|
|
1745
|
+
},
|
|
1746
|
+
created_at: {
|
|
1747
|
+
type: 'string',
|
|
1748
|
+
description: 'Creation date and time of the fleet.',
|
|
1749
|
+
example: '2024-09-12T09:11:27Z'
|
|
1750
|
+
},
|
|
1751
|
+
updated_at: {
|
|
1752
|
+
type: 'string',
|
|
1753
|
+
description: 'Date and time the fleet was last updated.',
|
|
1754
|
+
example: '2024-09-12T09:11:27Z'
|
|
1481
1755
|
}
|
|
1482
1756
|
},
|
|
1483
1757
|
required: [
|
|
1758
|
+
'constraints',
|
|
1484
1759
|
'scalingProfile',
|
|
1485
|
-
'id'
|
|
1760
|
+
'id',
|
|
1761
|
+
'ready',
|
|
1762
|
+
'created_at',
|
|
1763
|
+
'updated_at'
|
|
1486
1764
|
],
|
|
1487
|
-
additionalProperties: false
|
|
1765
|
+
additionalProperties: false,
|
|
1766
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
1488
1767
|
};
|
|
1489
1768
|
export const FleetUpdateInputSchema = {
|
|
1490
1769
|
type: 'object',
|
|
@@ -1530,8 +1809,8 @@ export const FleetUpdateInputSchema = {
|
|
|
1530
1809
|
type: 'string',
|
|
1531
1810
|
maxLength: 64,
|
|
1532
1811
|
minLength: 64,
|
|
1533
|
-
pattern: '^[A-Za-z0-9]
|
|
1534
|
-
description: 'Hetzner Cloud API token with read
|
|
1812
|
+
pattern: '^([A-Za-z0-9]{64}|\\*{64})$',
|
|
1813
|
+
description: 'Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.'
|
|
1535
1814
|
}
|
|
1536
1815
|
},
|
|
1537
1816
|
required: [
|
|
@@ -1570,7 +1849,11 @@ export const FleetUpdateInputSchema = {
|
|
|
1570
1849
|
]
|
|
1571
1850
|
},
|
|
1572
1851
|
minItems: 1,
|
|
1573
|
-
description: 'Allowed values for `karpenter.sh/capacity-type`.'
|
|
1852
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1853
|
+
default: [
|
|
1854
|
+
'on-demand',
|
|
1855
|
+
'spot'
|
|
1856
|
+
]
|
|
1574
1857
|
},
|
|
1575
1858
|
'kubernetes.io/arch': {
|
|
1576
1859
|
type: 'array',
|
|
@@ -1582,7 +1865,10 @@ export const FleetUpdateInputSchema = {
|
|
|
1582
1865
|
]
|
|
1583
1866
|
},
|
|
1584
1867
|
minItems: 1,
|
|
1585
|
-
description: 'Allowed values for `kubernetes.io/arch`.'
|
|
1868
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1869
|
+
default: [
|
|
1870
|
+
'amd64'
|
|
1871
|
+
]
|
|
1586
1872
|
},
|
|
1587
1873
|
'cfke.io/instance-family': {
|
|
1588
1874
|
type: 'array',
|
|
@@ -1749,7 +2035,8 @@ export const FleetUpdateInputSchema = {
|
|
|
1749
2035
|
'z3'
|
|
1750
2036
|
]
|
|
1751
2037
|
},
|
|
1752
|
-
description: 'Allowed values for `cfke.io/instance-family`.'
|
|
2038
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
2039
|
+
default: []
|
|
1753
2040
|
},
|
|
1754
2041
|
'topology.kubernetes.io/region': {
|
|
1755
2042
|
type: 'array',
|
|
@@ -1822,15 +2109,28 @@ export const FleetUpdateInputSchema = {
|
|
|
1822
2109
|
'us-west4'
|
|
1823
2110
|
]
|
|
1824
2111
|
},
|
|
1825
|
-
description: 'Allowed values for `topology.kubernetes.io/region`.'
|
|
2112
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
2113
|
+
default: []
|
|
1826
2114
|
}
|
|
1827
2115
|
},
|
|
1828
2116
|
additionalProperties: false,
|
|
1829
|
-
description: 'Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.
|
|
2117
|
+
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.',
|
|
2118
|
+
default: {
|
|
2119
|
+
'karpenter.sh/capacity-type': [
|
|
2120
|
+
'on-demand',
|
|
2121
|
+
'spot'
|
|
2122
|
+
],
|
|
2123
|
+
'kubernetes.io/arch': [
|
|
2124
|
+
'amd64'
|
|
2125
|
+
],
|
|
2126
|
+
'cfke.io/instance-family': [],
|
|
2127
|
+
'topology.kubernetes.io/region': []
|
|
2128
|
+
}
|
|
1830
2129
|
},
|
|
1831
2130
|
scalingProfile: {
|
|
1832
2131
|
type: 'string',
|
|
1833
|
-
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.',
|
|
2132
|
+
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`).',
|
|
2133
|
+
default: 'conservative',
|
|
1834
2134
|
example: 'conservative',
|
|
1835
2135
|
enum: [
|
|
1836
2136
|
'aggressive',
|
|
@@ -1838,8 +2138,31 @@ export const FleetUpdateInputSchema = {
|
|
|
1838
2138
|
]
|
|
1839
2139
|
}
|
|
1840
2140
|
},
|
|
2141
|
+
additionalProperties: false,
|
|
2142
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
2143
|
+
};
|
|
2144
|
+
export const InviteCreateInputSchema = {
|
|
2145
|
+
type: 'object',
|
|
2146
|
+
properties: {
|
|
2147
|
+
email: {
|
|
2148
|
+
type: 'string',
|
|
2149
|
+
format: 'email',
|
|
2150
|
+
description: 'Email address of the user to invite.',
|
|
2151
|
+
example: 'email@example.com'
|
|
2152
|
+
},
|
|
2153
|
+
role: {
|
|
2154
|
+
type: 'string',
|
|
2155
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2156
|
+
default: 'User',
|
|
2157
|
+
example: 'User',
|
|
2158
|
+
enum: [
|
|
2159
|
+
'Administrator',
|
|
2160
|
+
'User'
|
|
2161
|
+
]
|
|
2162
|
+
}
|
|
2163
|
+
},
|
|
1841
2164
|
required: [
|
|
1842
|
-
'
|
|
2165
|
+
'email'
|
|
1843
2166
|
],
|
|
1844
2167
|
additionalProperties: false
|
|
1845
2168
|
};
|
|
@@ -1873,6 +2196,16 @@ export const InviteSchema = {
|
|
|
1873
2196
|
type: 'string',
|
|
1874
2197
|
description: 'Generated unique invite code.',
|
|
1875
2198
|
example: '7kUZnH7nnKUFfvc4NK2KQF'
|
|
2199
|
+
},
|
|
2200
|
+
role: {
|
|
2201
|
+
type: 'string',
|
|
2202
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2203
|
+
default: 'User',
|
|
2204
|
+
example: 'User',
|
|
2205
|
+
enum: [
|
|
2206
|
+
'Administrator',
|
|
2207
|
+
'User'
|
|
2208
|
+
]
|
|
1876
2209
|
}
|
|
1877
2210
|
},
|
|
1878
2211
|
required: [
|
|
@@ -2093,6 +2426,15 @@ export const MarketplaceListingSchema = {
|
|
|
2093
2426
|
export const OrganizationCreateInputSchema = {
|
|
2094
2427
|
type: 'object',
|
|
2095
2428
|
properties: {
|
|
2429
|
+
type: {
|
|
2430
|
+
type: 'string',
|
|
2431
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2432
|
+
example: 'business',
|
|
2433
|
+
enum: [
|
|
2434
|
+
'business',
|
|
2435
|
+
'personal'
|
|
2436
|
+
]
|
|
2437
|
+
},
|
|
2096
2438
|
email: {
|
|
2097
2439
|
type: 'string',
|
|
2098
2440
|
format: 'email',
|
|
@@ -2101,11 +2443,13 @@ export const OrganizationCreateInputSchema = {
|
|
|
2101
2443
|
},
|
|
2102
2444
|
first_name: {
|
|
2103
2445
|
type: 'string',
|
|
2446
|
+
minLength: 1,
|
|
2104
2447
|
description: 'First name of the billing contact person.',
|
|
2105
2448
|
example: 'John'
|
|
2106
2449
|
},
|
|
2107
2450
|
last_name: {
|
|
2108
2451
|
type: 'string',
|
|
2452
|
+
minLength: 1,
|
|
2109
2453
|
description: 'Last name of the billing contact person.',
|
|
2110
2454
|
example: 'Doe'
|
|
2111
2455
|
},
|
|
@@ -2124,6 +2468,7 @@ export const OrganizationCreateInputSchema = {
|
|
|
2124
2468
|
}
|
|
2125
2469
|
},
|
|
2126
2470
|
required: [
|
|
2471
|
+
'type',
|
|
2127
2472
|
'email',
|
|
2128
2473
|
'first_name',
|
|
2129
2474
|
'last_name',
|
|
@@ -2132,6 +2477,20 @@ export const OrganizationCreateInputSchema = {
|
|
|
2132
2477
|
],
|
|
2133
2478
|
additionalProperties: false
|
|
2134
2479
|
};
|
|
2480
|
+
export const OrganizationCreateOutputSchema = {
|
|
2481
|
+
type: 'object',
|
|
2482
|
+
properties: {
|
|
2483
|
+
id: {
|
|
2484
|
+
type: 'string',
|
|
2485
|
+
description: 'Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.',
|
|
2486
|
+
example: 'organization-id'
|
|
2487
|
+
}
|
|
2488
|
+
},
|
|
2489
|
+
required: [
|
|
2490
|
+
'id'
|
|
2491
|
+
],
|
|
2492
|
+
additionalProperties: false
|
|
2493
|
+
};
|
|
2135
2494
|
export const OrganizationSchema = {
|
|
2136
2495
|
type: 'object',
|
|
2137
2496
|
properties: {
|
|
@@ -2148,6 +2507,15 @@ export const OrganizationSchema = {
|
|
|
2148
2507
|
description: 'Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.',
|
|
2149
2508
|
example: 'ACME Corp.'
|
|
2150
2509
|
},
|
|
2510
|
+
type: {
|
|
2511
|
+
type: 'string',
|
|
2512
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2513
|
+
example: 'business',
|
|
2514
|
+
enum: [
|
|
2515
|
+
'business',
|
|
2516
|
+
'personal'
|
|
2517
|
+
]
|
|
2518
|
+
},
|
|
2151
2519
|
date_created: {
|
|
2152
2520
|
type: 'string',
|
|
2153
2521
|
format: 'date-time',
|
|
@@ -2179,6 +2547,17 @@ export const OrganizationSchema = {
|
|
|
2179
2547
|
description: 'Available number of Pro clusters that can be created.',
|
|
2180
2548
|
example: 999
|
|
2181
2549
|
},
|
|
2550
|
+
enterprise_clusters_max: {
|
|
2551
|
+
type: 'integer',
|
|
2552
|
+
minimum: 0,
|
|
2553
|
+
description: 'Maximum number of Enterprise clusters that can be created.',
|
|
2554
|
+
example: 999
|
|
2555
|
+
},
|
|
2556
|
+
enterprise_clusters_available: {
|
|
2557
|
+
type: 'integer',
|
|
2558
|
+
description: 'Available number of Enterprise clusters that can be created.',
|
|
2559
|
+
example: 999
|
|
2560
|
+
},
|
|
2182
2561
|
fleets_max: {
|
|
2183
2562
|
type: 'integer',
|
|
2184
2563
|
minimum: 0,
|
|
@@ -2198,7 +2577,7 @@ export const OrganizationSchema = {
|
|
|
2198
2577
|
type: 'array',
|
|
2199
2578
|
items: {
|
|
2200
2579
|
type: 'string',
|
|
2201
|
-
example: 'northamerica-central-
|
|
2580
|
+
example: 'northamerica-central-1a'
|
|
2202
2581
|
},
|
|
2203
2582
|
minItems: 1,
|
|
2204
2583
|
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
@@ -2240,6 +2619,8 @@ export const OrganizationSchema = {
|
|
|
2240
2619
|
'basic_clusters_available',
|
|
2241
2620
|
'pro_clusters_max',
|
|
2242
2621
|
'pro_clusters_available',
|
|
2622
|
+
'enterprise_clusters_max',
|
|
2623
|
+
'enterprise_clusters_available',
|
|
2243
2624
|
'fleets_max',
|
|
2244
2625
|
'cluster_tiers',
|
|
2245
2626
|
'regions',
|
|
@@ -2257,13 +2638,25 @@ export const OrganizationSchema = {
|
|
|
2257
2638
|
'closed',
|
|
2258
2639
|
'suspended'
|
|
2259
2640
|
]
|
|
2641
|
+
},
|
|
2642
|
+
verification: {
|
|
2643
|
+
type: 'string',
|
|
2644
|
+
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.',
|
|
2645
|
+
example: 'verified',
|
|
2646
|
+
enum: [
|
|
2647
|
+
'none',
|
|
2648
|
+
'submitted',
|
|
2649
|
+
'verified'
|
|
2650
|
+
]
|
|
2260
2651
|
}
|
|
2261
2652
|
},
|
|
2262
2653
|
required: [
|
|
2263
2654
|
'id',
|
|
2655
|
+
'type',
|
|
2264
2656
|
'date_created',
|
|
2265
2657
|
'quota',
|
|
2266
|
-
'status'
|
|
2658
|
+
'status',
|
|
2659
|
+
'verification'
|
|
2267
2660
|
],
|
|
2268
2661
|
additionalProperties: false
|
|
2269
2662
|
};
|
|
@@ -2272,28 +2665,23 @@ export const PaymentMethodSchema = {
|
|
|
2272
2665
|
properties: {
|
|
2273
2666
|
id: {
|
|
2274
2667
|
type: 'string',
|
|
2275
|
-
|
|
2276
|
-
|
|
2277
|
-
example: 'e94d30ec-a2dd-4dcb-832c-ac2be144ba91'
|
|
2278
|
-
},
|
|
2279
|
-
setup: {
|
|
2280
|
-
type: 'boolean',
|
|
2281
|
-
description: 'Whether organization payment method was set up and ready to use for payments.',
|
|
2282
|
-
example: true
|
|
2668
|
+
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.',
|
|
2669
|
+
example: 'pm_1MtwBwLkdIwHu7ix28a3tqPa'
|
|
2283
2670
|
},
|
|
2284
2671
|
type: {
|
|
2285
2672
|
type: 'string',
|
|
2286
|
-
|
|
2287
|
-
description: 'Payment method type type. Only `card` payments supported at the moment.',
|
|
2673
|
+
description: 'Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.',
|
|
2288
2674
|
example: 'card',
|
|
2289
2675
|
enum: [
|
|
2290
|
-
'card'
|
|
2676
|
+
'card',
|
|
2677
|
+
'sepa_debit',
|
|
2678
|
+
'bank_transfer'
|
|
2291
2679
|
]
|
|
2292
2680
|
},
|
|
2293
2681
|
last4: {
|
|
2294
2682
|
type: 'string',
|
|
2295
2683
|
nullable: true,
|
|
2296
|
-
description: 'Last 4 digits of the payment card number.',
|
|
2684
|
+
description: 'Last 4 digits of the payment card number, of the bank account (IBAN) for SEPA Direct Debit, or of the destination IBAN for bank transfer.',
|
|
2297
2685
|
example: '4242'
|
|
2298
2686
|
},
|
|
2299
2687
|
exp_month: {
|
|
@@ -2301,42 +2689,56 @@ export const PaymentMethodSchema = {
|
|
|
2301
2689
|
minimum: 1,
|
|
2302
2690
|
maximum: 12,
|
|
2303
2691
|
nullable: true,
|
|
2304
|
-
description: 'Two-digit number representing the card\'s expiration month.',
|
|
2305
|
-
example:
|
|
2692
|
+
description: 'Two-digit number representing the card\'s expiration month. Null for SEPA Direct Debit and bank transfer.',
|
|
2693
|
+
example: 12
|
|
2306
2694
|
},
|
|
2307
2695
|
exp_year: {
|
|
2308
2696
|
type: 'integer',
|
|
2309
|
-
minimum: 2024,
|
|
2310
2697
|
nullable: true,
|
|
2311
|
-
description: 'Four-digit number representing the card\'s expiration year.',
|
|
2312
|
-
example:
|
|
2698
|
+
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.',
|
|
2699
|
+
example: 2028
|
|
2313
2700
|
},
|
|
2314
2701
|
brand: {
|
|
2315
2702
|
type: 'string',
|
|
2316
2703
|
nullable: true,
|
|
2317
|
-
description: 'Payment card brand
|
|
2318
|
-
example: 'visa'
|
|
2319
|
-
|
|
2320
|
-
|
|
2321
|
-
|
|
2322
|
-
|
|
2323
|
-
|
|
2324
|
-
|
|
2325
|
-
|
|
2326
|
-
|
|
2327
|
-
|
|
2328
|
-
|
|
2329
|
-
|
|
2704
|
+
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.',
|
|
2705
|
+
example: 'visa'
|
|
2706
|
+
},
|
|
2707
|
+
iban: {
|
|
2708
|
+
type: 'string',
|
|
2709
|
+
nullable: true,
|
|
2710
|
+
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.',
|
|
2711
|
+
example: 'DE11243015658023127510'
|
|
2712
|
+
},
|
|
2713
|
+
bic: {
|
|
2714
|
+
type: 'string',
|
|
2715
|
+
nullable: true,
|
|
2716
|
+
description: 'BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
2717
|
+
example: 'SOGEDEFFXXX'
|
|
2718
|
+
},
|
|
2719
|
+
account_holder_name: {
|
|
2720
|
+
type: 'string',
|
|
2721
|
+
nullable: true,
|
|
2722
|
+
description: 'Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
2723
|
+
example: 'Cloudfleet GmbH'
|
|
2724
|
+
},
|
|
2725
|
+
is_default: {
|
|
2726
|
+
type: 'boolean',
|
|
2727
|
+
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).',
|
|
2728
|
+
example: true
|
|
2330
2729
|
}
|
|
2331
2730
|
},
|
|
2332
2731
|
required: [
|
|
2333
2732
|
'id',
|
|
2334
|
-
'setup',
|
|
2335
2733
|
'type',
|
|
2336
2734
|
'last4',
|
|
2337
2735
|
'exp_month',
|
|
2338
2736
|
'exp_year',
|
|
2339
|
-
'brand'
|
|
2737
|
+
'brand',
|
|
2738
|
+
'iban',
|
|
2739
|
+
'bic',
|
|
2740
|
+
'account_holder_name',
|
|
2741
|
+
'is_default'
|
|
2340
2742
|
],
|
|
2341
2743
|
additionalProperties: false
|
|
2342
2744
|
};
|
|
@@ -2365,6 +2767,17 @@ export const PlatformQuotaSchema = {
|
|
|
2365
2767
|
description: 'Available number of Pro clusters that can be created.',
|
|
2366
2768
|
example: 999
|
|
2367
2769
|
},
|
|
2770
|
+
enterprise_clusters_max: {
|
|
2771
|
+
type: 'integer',
|
|
2772
|
+
minimum: 0,
|
|
2773
|
+
description: 'Maximum number of Enterprise clusters that can be created.',
|
|
2774
|
+
example: 999
|
|
2775
|
+
},
|
|
2776
|
+
enterprise_clusters_available: {
|
|
2777
|
+
type: 'integer',
|
|
2778
|
+
description: 'Available number of Enterprise clusters that can be created.',
|
|
2779
|
+
example: 999
|
|
2780
|
+
},
|
|
2368
2781
|
fleets_max: {
|
|
2369
2782
|
type: 'integer',
|
|
2370
2783
|
minimum: 0,
|
|
@@ -2384,7 +2797,7 @@ export const PlatformQuotaSchema = {
|
|
|
2384
2797
|
type: 'array',
|
|
2385
2798
|
items: {
|
|
2386
2799
|
type: 'string',
|
|
2387
|
-
example: 'northamerica-central-
|
|
2800
|
+
example: 'northamerica-central-1a'
|
|
2388
2801
|
},
|
|
2389
2802
|
minItems: 1,
|
|
2390
2803
|
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
@@ -2426,6 +2839,8 @@ export const PlatformQuotaSchema = {
|
|
|
2426
2839
|
'basic_clusters_available',
|
|
2427
2840
|
'pro_clusters_max',
|
|
2428
2841
|
'pro_clusters_available',
|
|
2842
|
+
'enterprise_clusters_max',
|
|
2843
|
+
'enterprise_clusters_available',
|
|
2429
2844
|
'fleets_max',
|
|
2430
2845
|
'cluster_tiers',
|
|
2431
2846
|
'regions',
|
|
@@ -2768,172 +3183,6 @@ export const TicketCreateInputSchema = {
|
|
|
2768
3183
|
],
|
|
2769
3184
|
additionalProperties: false
|
|
2770
3185
|
};
|
|
2771
|
-
export const TicketListResponseSchema = {
|
|
2772
|
-
type: 'object',
|
|
2773
|
-
properties: {
|
|
2774
|
-
items: {
|
|
2775
|
-
type: 'array',
|
|
2776
|
-
items: {
|
|
2777
|
-
type: 'object',
|
|
2778
|
-
properties: {
|
|
2779
|
-
id: {
|
|
2780
|
-
type: 'string',
|
|
2781
|
-
description: 'Unique identifier of the ticket (Mongo ObjectId).',
|
|
2782
|
-
example: '60c72b2f9f1b2c001f8e4d3a'
|
|
2783
|
-
},
|
|
2784
|
-
status: {
|
|
2785
|
-
type: 'string',
|
|
2786
|
-
description: 'Current state of the ticket.',
|
|
2787
|
-
example: 'waiting_on_us',
|
|
2788
|
-
enum: [
|
|
2789
|
-
'waiting_on_us',
|
|
2790
|
-
'waiting_on_user',
|
|
2791
|
-
'closed'
|
|
2792
|
-
]
|
|
2793
|
-
},
|
|
2794
|
-
category: {
|
|
2795
|
-
type: 'string',
|
|
2796
|
-
description: 'Ticket category.',
|
|
2797
|
-
example: 'technical',
|
|
2798
|
-
enum: [
|
|
2799
|
-
'billing',
|
|
2800
|
-
'technical',
|
|
2801
|
-
'general'
|
|
2802
|
-
]
|
|
2803
|
-
},
|
|
2804
|
-
summary: {
|
|
2805
|
-
type: 'string',
|
|
2806
|
-
description: 'First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.',
|
|
2807
|
-
example: 'My cluster cannot reach the registry. Logs attached.'
|
|
2808
|
-
},
|
|
2809
|
-
closed_at: {
|
|
2810
|
-
type: 'string',
|
|
2811
|
-
format: 'date-time',
|
|
2812
|
-
nullable: true,
|
|
2813
|
-
description: 'Closure timestamp. Null while the ticket is open.',
|
|
2814
|
-
example: '2026-05-18T16:08:14.338Z'
|
|
2815
|
-
},
|
|
2816
|
-
date_created: {
|
|
2817
|
-
type: 'string',
|
|
2818
|
-
format: 'date-time',
|
|
2819
|
-
description: 'Creation date of the ticket. ISO 8601 UTC.',
|
|
2820
|
-
example: '2026-05-11T16:08:14.338Z'
|
|
2821
|
-
},
|
|
2822
|
-
date_updated: {
|
|
2823
|
-
type: 'string',
|
|
2824
|
-
format: 'date-time',
|
|
2825
|
-
description: 'Last update date of the ticket. ISO 8601 UTC.',
|
|
2826
|
-
example: '2026-05-11T16:08:14.338Z'
|
|
2827
|
-
},
|
|
2828
|
-
messages: {
|
|
2829
|
-
type: 'array',
|
|
2830
|
-
items: {
|
|
2831
|
-
type: 'object',
|
|
2832
|
-
properties: {
|
|
2833
|
-
id: {
|
|
2834
|
-
type: 'string',
|
|
2835
|
-
description: 'Unique identifier of the message (Mongo ObjectId).',
|
|
2836
|
-
example: '60c72b2f9f1b2c001f8e4d3b'
|
|
2837
|
-
},
|
|
2838
|
-
type: {
|
|
2839
|
-
type: 'string',
|
|
2840
|
-
description: 'Message type. Internal notes are filtered out of customer-facing responses.',
|
|
2841
|
-
example: 'customer_reply',
|
|
2842
|
-
enum: [
|
|
2843
|
-
'customer_reply',
|
|
2844
|
-
'agent_reply'
|
|
2845
|
-
]
|
|
2846
|
-
},
|
|
2847
|
-
body: {
|
|
2848
|
-
type: 'string',
|
|
2849
|
-
description: 'Message body in markdown.',
|
|
2850
|
-
example: 'Thanks — that resolved it on my side.'
|
|
2851
|
-
},
|
|
2852
|
-
author_first_name: {
|
|
2853
|
-
type: 'string',
|
|
2854
|
-
nullable: true,
|
|
2855
|
-
description: 'First name of the author. Null when not provided.',
|
|
2856
|
-
example: 'Jane'
|
|
2857
|
-
},
|
|
2858
|
-
author_last_name: {
|
|
2859
|
-
type: 'string',
|
|
2860
|
-
nullable: true,
|
|
2861
|
-
description: 'Last name of the author. Null when not provided.',
|
|
2862
|
-
example: 'Doe'
|
|
2863
|
-
},
|
|
2864
|
-
attachments: {
|
|
2865
|
-
type: 'array',
|
|
2866
|
-
items: {
|
|
2867
|
-
type: 'object',
|
|
2868
|
-
properties: {
|
|
2869
|
-
id: {
|
|
2870
|
-
type: 'string',
|
|
2871
|
-
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
2872
|
-
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
2873
|
-
},
|
|
2874
|
-
filename: {
|
|
2875
|
-
type: 'string',
|
|
2876
|
-
description: 'Original filename as uploaded.',
|
|
2877
|
-
example: 'debug.log'
|
|
2878
|
-
},
|
|
2879
|
-
content_type: {
|
|
2880
|
-
type: 'string',
|
|
2881
|
-
description: 'MIME content type of the attachment.',
|
|
2882
|
-
example: 'text/plain'
|
|
2883
|
-
},
|
|
2884
|
-
size: {
|
|
2885
|
-
type: 'integer',
|
|
2886
|
-
description: 'Size of the attachment in bytes.',
|
|
2887
|
-
example: 12345
|
|
2888
|
-
}
|
|
2889
|
-
},
|
|
2890
|
-
required: [
|
|
2891
|
-
'id',
|
|
2892
|
-
'filename',
|
|
2893
|
-
'content_type',
|
|
2894
|
-
'size'
|
|
2895
|
-
],
|
|
2896
|
-
additionalProperties: false
|
|
2897
|
-
},
|
|
2898
|
-
description: 'Attachments associated with this message.',
|
|
2899
|
-
example: []
|
|
2900
|
-
},
|
|
2901
|
-
date_created: {
|
|
2902
|
-
type: 'string',
|
|
2903
|
-
format: 'date-time',
|
|
2904
|
-
description: 'Creation date of the message. ISO 8601 UTC.',
|
|
2905
|
-
example: '2026-05-11T16:08:14.338Z'
|
|
2906
|
-
}
|
|
2907
|
-
},
|
|
2908
|
-
required: [
|
|
2909
|
-
'id',
|
|
2910
|
-
'type',
|
|
2911
|
-
'body',
|
|
2912
|
-
'date_created'
|
|
2913
|
-
],
|
|
2914
|
-
additionalProperties: false
|
|
2915
|
-
},
|
|
2916
|
-
description: 'Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.'
|
|
2917
|
-
}
|
|
2918
|
-
},
|
|
2919
|
-
required: [
|
|
2920
|
-
'id',
|
|
2921
|
-
'status',
|
|
2922
|
-
'category',
|
|
2923
|
-
'summary',
|
|
2924
|
-
'date_created',
|
|
2925
|
-
'date_updated'
|
|
2926
|
-
],
|
|
2927
|
-
additionalProperties: false
|
|
2928
|
-
},
|
|
2929
|
-
description: 'Tickets for the organization, ordered newest first. Messages are omitted from list responses.'
|
|
2930
|
-
}
|
|
2931
|
-
},
|
|
2932
|
-
required: [
|
|
2933
|
-
'items'
|
|
2934
|
-
],
|
|
2935
|
-
additionalProperties: false
|
|
2936
|
-
};
|
|
2937
3186
|
export const TicketMessageInputSchema = {
|
|
2938
3187
|
type: 'object',
|
|
2939
3188
|
properties: {
|
|
@@ -2975,11 +3224,13 @@ export const TicketMessageSchema = {
|
|
|
2975
3224
|
},
|
|
2976
3225
|
author_first_name: {
|
|
2977
3226
|
type: 'string',
|
|
3227
|
+
nullable: true,
|
|
2978
3228
|
description: 'First name of the author. Null when not provided.',
|
|
2979
3229
|
example: 'Jane'
|
|
2980
3230
|
},
|
|
2981
3231
|
author_last_name: {
|
|
2982
3232
|
type: 'string',
|
|
3233
|
+
nullable: true,
|
|
2983
3234
|
description: 'Last name of the author. Null when not provided.',
|
|
2984
3235
|
example: 'Doe'
|
|
2985
3236
|
},
|
|
@@ -3071,6 +3322,7 @@ export const TicketSchema = {
|
|
|
3071
3322
|
closed_at: {
|
|
3072
3323
|
type: 'string',
|
|
3073
3324
|
format: 'date-time',
|
|
3325
|
+
nullable: true,
|
|
3074
3326
|
description: 'Closure timestamp. Null while the ticket is open.',
|
|
3075
3327
|
example: '2026-05-18T16:08:14.338Z'
|
|
3076
3328
|
},
|
|
@@ -3295,12 +3547,21 @@ export const UsageFacetsSchema = {
|
|
|
3295
3547
|
product: {
|
|
3296
3548
|
type: 'array',
|
|
3297
3549
|
items: {
|
|
3298
|
-
type: 'string'
|
|
3550
|
+
type: 'string',
|
|
3551
|
+
enum: [
|
|
3552
|
+
'cfke_controlplane_basic',
|
|
3553
|
+
'cfke_controlplane_pro',
|
|
3554
|
+
'cfke_controlplane_enterprise',
|
|
3555
|
+
'cfke_connected_nodes_basic',
|
|
3556
|
+
'cfke_connected_nodes_pro',
|
|
3557
|
+
'cfke_connected_nodes_enterprise',
|
|
3558
|
+
'cfcr_storage'
|
|
3559
|
+
]
|
|
3299
3560
|
},
|
|
3300
3561
|
description: 'List of unique products',
|
|
3301
3562
|
example: [
|
|
3302
|
-
'
|
|
3303
|
-
'
|
|
3563
|
+
'cfke_controlplane_pro',
|
|
3564
|
+
'cfke_connected_nodes_pro'
|
|
3304
3565
|
]
|
|
3305
3566
|
}
|
|
3306
3567
|
},
|
|
@@ -3327,7 +3588,16 @@ export const UsageResponseSchema = {
|
|
|
3327
3588
|
product: {
|
|
3328
3589
|
type: 'string',
|
|
3329
3590
|
description: 'The product the usage is associated with',
|
|
3330
|
-
example: '
|
|
3591
|
+
example: 'cfke_controlplane_pro',
|
|
3592
|
+
enum: [
|
|
3593
|
+
'cfke_controlplane_basic',
|
|
3594
|
+
'cfke_controlplane_pro',
|
|
3595
|
+
'cfke_controlplane_enterprise',
|
|
3596
|
+
'cfke_connected_nodes_basic',
|
|
3597
|
+
'cfke_connected_nodes_pro',
|
|
3598
|
+
'cfke_connected_nodes_enterprise',
|
|
3599
|
+
'cfcr_storage'
|
|
3600
|
+
]
|
|
3331
3601
|
},
|
|
3332
3602
|
value: {
|
|
3333
3603
|
type: 'number',
|
|
@@ -3375,12 +3645,21 @@ export const UsageResponseSchema = {
|
|
|
3375
3645
|
product: {
|
|
3376
3646
|
type: 'array',
|
|
3377
3647
|
items: {
|
|
3378
|
-
type: 'string'
|
|
3648
|
+
type: 'string',
|
|
3649
|
+
enum: [
|
|
3650
|
+
'cfke_controlplane_basic',
|
|
3651
|
+
'cfke_controlplane_pro',
|
|
3652
|
+
'cfke_controlplane_enterprise',
|
|
3653
|
+
'cfke_connected_nodes_basic',
|
|
3654
|
+
'cfke_connected_nodes_pro',
|
|
3655
|
+
'cfke_connected_nodes_enterprise',
|
|
3656
|
+
'cfcr_storage'
|
|
3657
|
+
]
|
|
3379
3658
|
},
|
|
3380
3659
|
description: 'List of unique products',
|
|
3381
3660
|
example: [
|
|
3382
|
-
'
|
|
3383
|
-
'
|
|
3661
|
+
'cfke_controlplane_pro',
|
|
3662
|
+
'cfke_connected_nodes_pro'
|
|
3384
3663
|
]
|
|
3385
3664
|
}
|
|
3386
3665
|
},
|
|
@@ -3410,7 +3689,16 @@ export const UsageSchema = {
|
|
|
3410
3689
|
product: {
|
|
3411
3690
|
type: 'string',
|
|
3412
3691
|
description: 'The product the usage is associated with',
|
|
3413
|
-
example: '
|
|
3692
|
+
example: 'cfke_controlplane_pro',
|
|
3693
|
+
enum: [
|
|
3694
|
+
'cfke_controlplane_basic',
|
|
3695
|
+
'cfke_controlplane_pro',
|
|
3696
|
+
'cfke_controlplane_enterprise',
|
|
3697
|
+
'cfke_connected_nodes_basic',
|
|
3698
|
+
'cfke_connected_nodes_pro',
|
|
3699
|
+
'cfke_connected_nodes_enterprise',
|
|
3700
|
+
'cfcr_storage'
|
|
3701
|
+
]
|
|
3414
3702
|
},
|
|
3415
3703
|
value: {
|
|
3416
3704
|
type: 'number',
|
|
@@ -3473,24 +3761,6 @@ export const UserCreateInputSchema = {
|
|
|
3473
3761
|
type: 'string',
|
|
3474
3762
|
minLength: 8,
|
|
3475
3763
|
description: 'User password. Must be at least 8 characters long.'
|
|
3476
|
-
},
|
|
3477
|
-
status: {
|
|
3478
|
-
type: 'string',
|
|
3479
|
-
description: 'Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.',
|
|
3480
|
-
example: 'active',
|
|
3481
|
-
enum: [
|
|
3482
|
-
'active',
|
|
3483
|
-
'inactive'
|
|
3484
|
-
]
|
|
3485
|
-
},
|
|
3486
|
-
role: {
|
|
3487
|
-
type: 'string',
|
|
3488
|
-
description: 'User role. Can be \'Administrator\', \'User\'.',
|
|
3489
|
-
example: 'User',
|
|
3490
|
-
enum: [
|
|
3491
|
-
'Administrator',
|
|
3492
|
-
'User'
|
|
3493
|
-
]
|
|
3494
3764
|
}
|
|
3495
3765
|
},
|
|
3496
3766
|
required: [
|