@cloudfleet/sdk 0.0.1-9c683a8 → 0.0.1-a04559e
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 +512 -534
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -1
- package/dist/@tanstack/react-query.gen.js +486 -332
- 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 +1134 -133
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +2110 -192
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +256 -196
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +367 -274
- package/dist/sdk.gen.js.map +1 -1
- package/dist/types.gen.d.ts +1545 -710
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3436 -1141
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1330 -294
- 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,
|
|
@@ -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,11 +572,21 @@ 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.',
|
|
509
583
|
example: 'tskey-auth-kBV8wr1dk911CNTRL-...'
|
|
510
584
|
},
|
|
585
|
+
login_server: {
|
|
586
|
+
type: 'string',
|
|
587
|
+
description: 'Coordination server the node registers against. Empty on data plane v1 clusters, where the node advertises its own tag instead. A non-empty value requires a client that declares the dataplane-v2 capability.',
|
|
588
|
+
example: 'https://415026b6-f00f-44f8-968d-fc6ef4d0fc6d.fabric.europe-central-1a.cfke.io'
|
|
589
|
+
},
|
|
511
590
|
bootstrap_token: {
|
|
512
591
|
type: 'string',
|
|
513
592
|
description: 'Bootstrap token for the cluster.',
|
|
@@ -578,7 +657,9 @@ export const ClusterJoinInformationSchema = {
|
|
|
578
657
|
'certificate_authority',
|
|
579
658
|
'endpoint',
|
|
580
659
|
'cluster_dns',
|
|
660
|
+
'pod_cidr',
|
|
581
661
|
'auth_key',
|
|
662
|
+
'login_server',
|
|
582
663
|
'bootstrap_token',
|
|
583
664
|
'versions',
|
|
584
665
|
'third_party_api_access_config'
|
|
@@ -599,24 +680,123 @@ export const ClusterSchema = {
|
|
|
599
680
|
tier: {
|
|
600
681
|
type: 'string',
|
|
601
682
|
description: 'Tier of the cluster.',
|
|
683
|
+
default: 'basic',
|
|
602
684
|
example: 'pro',
|
|
603
685
|
enum: [
|
|
604
686
|
'basic',
|
|
605
|
-
'pro'
|
|
687
|
+
'pro',
|
|
688
|
+
'enterprise'
|
|
606
689
|
]
|
|
607
690
|
},
|
|
608
|
-
|
|
691
|
+
version_channel: {
|
|
692
|
+
type: 'string',
|
|
693
|
+
pattern: '^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$',
|
|
694
|
+
description: 'Version of the kubernetes cluster.',
|
|
695
|
+
default: '1.x.x-cfke.x',
|
|
696
|
+
example: '1.x.x-cfke.x'
|
|
697
|
+
},
|
|
698
|
+
release_channel: {
|
|
609
699
|
type: 'string',
|
|
610
|
-
description: '
|
|
611
|
-
default: '
|
|
612
|
-
example: '
|
|
700
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
701
|
+
default: 'rapid',
|
|
702
|
+
example: 'rapid',
|
|
613
703
|
enum: [
|
|
614
|
-
'
|
|
615
|
-
'
|
|
616
|
-
'
|
|
617
|
-
'northamerica-central-1a'
|
|
704
|
+
'rapid',
|
|
705
|
+
'stable',
|
|
706
|
+
'extended'
|
|
618
707
|
]
|
|
619
708
|
},
|
|
709
|
+
features: {
|
|
710
|
+
type: 'object',
|
|
711
|
+
properties: {
|
|
712
|
+
gpu_sharing_strategy: {
|
|
713
|
+
type: 'string',
|
|
714
|
+
description: 'GPU sharing strategy.',
|
|
715
|
+
default: 'none',
|
|
716
|
+
example: 'none',
|
|
717
|
+
enum: [
|
|
718
|
+
'none',
|
|
719
|
+
'mps',
|
|
720
|
+
'time_slicing'
|
|
721
|
+
]
|
|
722
|
+
},
|
|
723
|
+
gpu_max_shared_clients_per_gpu: {
|
|
724
|
+
type: 'integer',
|
|
725
|
+
minimum: 2,
|
|
726
|
+
maximum: 48,
|
|
727
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
728
|
+
default: 4,
|
|
729
|
+
example: 10
|
|
730
|
+
},
|
|
731
|
+
cilium_socket_lb_host_namespace_only: {
|
|
732
|
+
type: 'boolean',
|
|
733
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
734
|
+
example: false
|
|
735
|
+
}
|
|
736
|
+
},
|
|
737
|
+
required: [
|
|
738
|
+
'gpu_sharing_strategy',
|
|
739
|
+
'gpu_max_shared_clients_per_gpu',
|
|
740
|
+
'cilium_socket_lb_host_namespace_only'
|
|
741
|
+
],
|
|
742
|
+
additionalProperties: false,
|
|
743
|
+
description: 'Cluster feature toggles.',
|
|
744
|
+
default: {
|
|
745
|
+
gpu_sharing_strategy: 'none',
|
|
746
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
747
|
+
cilium_socket_lb_host_namespace_only: false
|
|
748
|
+
}
|
|
749
|
+
},
|
|
750
|
+
region: {
|
|
751
|
+
type: 'string',
|
|
752
|
+
description: 'Cloudfleet control plane region. This field can not be updated after creation.',
|
|
753
|
+
example: 'europe-central-1a'
|
|
754
|
+
},
|
|
755
|
+
networking: {
|
|
756
|
+
type: 'object',
|
|
757
|
+
properties: {
|
|
758
|
+
pod_cidr: {
|
|
759
|
+
type: 'string',
|
|
760
|
+
description: 'CIDR block for pod IPs.',
|
|
761
|
+
default: '10.244.0.0/16'
|
|
762
|
+
},
|
|
763
|
+
service_cidr: {
|
|
764
|
+
type: 'string',
|
|
765
|
+
description: 'CIDR block for service IPs.',
|
|
766
|
+
default: '10.96.0.0/12'
|
|
767
|
+
},
|
|
768
|
+
dual_stack: {
|
|
769
|
+
type: 'boolean',
|
|
770
|
+
description: 'Enable IPv4+IPv6 dual-stack networking.'
|
|
771
|
+
},
|
|
772
|
+
pod_cidr_v6: {
|
|
773
|
+
type: 'string',
|
|
774
|
+
description: 'IPv6 pod CIDR. Requires dual_stack.',
|
|
775
|
+
default: '2001:db8:1:2::/48'
|
|
776
|
+
},
|
|
777
|
+
service_cidr_v6: {
|
|
778
|
+
type: 'string',
|
|
779
|
+
description: 'IPv6 service CIDR. Requires dual_stack.',
|
|
780
|
+
default: '2001:db8:1:1::/112'
|
|
781
|
+
}
|
|
782
|
+
},
|
|
783
|
+
required: [
|
|
784
|
+
'pod_cidr',
|
|
785
|
+
'service_cidr',
|
|
786
|
+
'dual_stack',
|
|
787
|
+
'pod_cidr_v6',
|
|
788
|
+
'service_cidr_v6'
|
|
789
|
+
],
|
|
790
|
+
additionalProperties: false,
|
|
791
|
+
description: 'Cluster networking configuration. Immutable after creation.',
|
|
792
|
+
default: {
|
|
793
|
+
pod_cidr: '10.244.0.0/16',
|
|
794
|
+
service_cidr: '10.96.0.0/12',
|
|
795
|
+
dual_stack: false,
|
|
796
|
+
pod_cidr_v6: '2001:db8:1:2::/48',
|
|
797
|
+
service_cidr_v6: '2001:db8:1:1::/112'
|
|
798
|
+
}
|
|
799
|
+
},
|
|
620
800
|
id: {
|
|
621
801
|
type: 'string',
|
|
622
802
|
format: 'uuid',
|
|
@@ -625,16 +805,13 @@ export const ClusterSchema = {
|
|
|
625
805
|
},
|
|
626
806
|
status: {
|
|
627
807
|
type: 'string',
|
|
628
|
-
description: 'Status of the cluster.
|
|
629
|
-
example: '
|
|
808
|
+
description: 'Status of the cluster.',
|
|
809
|
+
example: 'deployed',
|
|
630
810
|
enum: [
|
|
631
|
-
'active',
|
|
632
|
-
'disabled',
|
|
633
|
-
'deleted',
|
|
634
811
|
'creating',
|
|
635
812
|
'deployed',
|
|
636
|
-
'
|
|
637
|
-
'
|
|
813
|
+
'updating',
|
|
814
|
+
'disabled'
|
|
638
815
|
]
|
|
639
816
|
},
|
|
640
817
|
endpoint: {
|
|
@@ -642,8 +819,24 @@ export const ClusterSchema = {
|
|
|
642
819
|
{
|
|
643
820
|
type: 'string',
|
|
644
821
|
format: 'uri',
|
|
645
|
-
description: 'URL of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.',
|
|
646
|
-
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
822
|
+
description: 'URL signed by a public CA of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.',
|
|
823
|
+
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
824
|
+
},
|
|
825
|
+
{
|
|
826
|
+
type: 'string',
|
|
827
|
+
enum: [
|
|
828
|
+
''
|
|
829
|
+
]
|
|
830
|
+
}
|
|
831
|
+
]
|
|
832
|
+
},
|
|
833
|
+
endpoint_public: {
|
|
834
|
+
anyOf: [
|
|
835
|
+
{
|
|
836
|
+
type: 'string',
|
|
837
|
+
format: 'uri',
|
|
838
|
+
description: 'Deprecated alias of `endpoint`; retained for backward compatibility.',
|
|
839
|
+
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
647
840
|
},
|
|
648
841
|
{
|
|
649
842
|
type: 'string',
|
|
@@ -677,21 +870,22 @@ export const ClusterSchema = {
|
|
|
677
870
|
type: 'boolean',
|
|
678
871
|
description: 'Indicates if the cluster is ready to be used.',
|
|
679
872
|
example: true
|
|
680
|
-
},
|
|
681
|
-
version_channel: {
|
|
682
|
-
type: 'string',
|
|
683
|
-
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-]+)*))?$',
|
|
684
|
-
description: 'Version of the kubernetes cluster.',
|
|
685
|
-
example: '1.x.x-cfke.x'
|
|
686
873
|
}
|
|
687
874
|
},
|
|
688
875
|
required: [
|
|
689
876
|
'name',
|
|
690
877
|
'tier',
|
|
878
|
+
'version_channel',
|
|
879
|
+
'release_channel',
|
|
880
|
+
'features',
|
|
881
|
+
'region',
|
|
882
|
+
'networking',
|
|
691
883
|
'id',
|
|
692
|
-
'status'
|
|
884
|
+
'status',
|
|
885
|
+
'ready'
|
|
693
886
|
],
|
|
694
|
-
additionalProperties: false
|
|
887
|
+
additionalProperties: false,
|
|
888
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
695
889
|
};
|
|
696
890
|
export const ClusterUpdateInputSchema = {
|
|
697
891
|
type: 'object',
|
|
@@ -707,23 +901,74 @@ export const ClusterUpdateInputSchema = {
|
|
|
707
901
|
tier: {
|
|
708
902
|
type: 'string',
|
|
709
903
|
description: 'Tier of the cluster.',
|
|
904
|
+
default: 'basic',
|
|
710
905
|
example: 'pro',
|
|
711
906
|
enum: [
|
|
712
907
|
'basic',
|
|
713
|
-
'pro'
|
|
908
|
+
'pro',
|
|
909
|
+
'enterprise'
|
|
714
910
|
]
|
|
715
911
|
},
|
|
716
912
|
version_channel: {
|
|
717
913
|
type: 'string',
|
|
718
914
|
pattern: '^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$',
|
|
719
915
|
description: 'Version of the kubernetes cluster.',
|
|
916
|
+
default: '1.x.x-cfke.x',
|
|
720
917
|
example: '1.x.x-cfke.x'
|
|
918
|
+
},
|
|
919
|
+
release_channel: {
|
|
920
|
+
type: 'string',
|
|
921
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
922
|
+
default: 'rapid',
|
|
923
|
+
example: 'rapid',
|
|
924
|
+
enum: [
|
|
925
|
+
'rapid',
|
|
926
|
+
'stable',
|
|
927
|
+
'extended'
|
|
928
|
+
]
|
|
929
|
+
},
|
|
930
|
+
features: {
|
|
931
|
+
type: 'object',
|
|
932
|
+
properties: {
|
|
933
|
+
gpu_sharing_strategy: {
|
|
934
|
+
type: 'string',
|
|
935
|
+
description: 'GPU sharing strategy.',
|
|
936
|
+
default: 'none',
|
|
937
|
+
example: 'none',
|
|
938
|
+
enum: [
|
|
939
|
+
'none',
|
|
940
|
+
'mps',
|
|
941
|
+
'time_slicing'
|
|
942
|
+
]
|
|
943
|
+
},
|
|
944
|
+
gpu_max_shared_clients_per_gpu: {
|
|
945
|
+
type: 'integer',
|
|
946
|
+
minimum: 2,
|
|
947
|
+
maximum: 48,
|
|
948
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
949
|
+
default: 4,
|
|
950
|
+
example: 10
|
|
951
|
+
},
|
|
952
|
+
cilium_socket_lb_host_namespace_only: {
|
|
953
|
+
type: 'boolean',
|
|
954
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
955
|
+
example: false
|
|
956
|
+
}
|
|
957
|
+
},
|
|
958
|
+
additionalProperties: false,
|
|
959
|
+
description: 'Cluster feature toggles.',
|
|
960
|
+
default: {
|
|
961
|
+
gpu_sharing_strategy: 'none',
|
|
962
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
963
|
+
cilium_socket_lb_host_namespace_only: false
|
|
964
|
+
}
|
|
721
965
|
}
|
|
722
966
|
},
|
|
723
967
|
required: [
|
|
724
|
-
'
|
|
968
|
+
'name'
|
|
725
969
|
],
|
|
726
|
-
additionalProperties: false
|
|
970
|
+
additionalProperties: false,
|
|
971
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
727
972
|
};
|
|
728
973
|
export const FleetCreateInputSchema = {
|
|
729
974
|
type: 'object',
|
|
@@ -732,15 +977,12 @@ export const FleetCreateInputSchema = {
|
|
|
732
977
|
type: 'object',
|
|
733
978
|
properties: {
|
|
734
979
|
cpu: {
|
|
735
|
-
type: '
|
|
736
|
-
format: 'float',
|
|
980
|
+
type: 'integer',
|
|
737
981
|
minimum: 0,
|
|
738
|
-
|
|
982
|
+
maximum: 100000,
|
|
983
|
+
description: 'CPU limit in cores. Maximum 100,000.'
|
|
739
984
|
}
|
|
740
985
|
},
|
|
741
|
-
required: [
|
|
742
|
-
'cpu'
|
|
743
|
-
],
|
|
744
986
|
additionalProperties: false,
|
|
745
987
|
description: 'Limits define a set of bounds for provisioning capacity.'
|
|
746
988
|
},
|
|
@@ -748,16 +990,17 @@ export const FleetCreateInputSchema = {
|
|
|
748
990
|
type: 'object',
|
|
749
991
|
properties: {
|
|
750
992
|
enabled: {
|
|
751
|
-
type: 'boolean'
|
|
752
|
-
default: true
|
|
993
|
+
type: 'boolean'
|
|
753
994
|
},
|
|
754
995
|
project: {
|
|
755
996
|
type: 'string',
|
|
756
|
-
|
|
997
|
+
pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
|
|
998
|
+
description: 'GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.',
|
|
999
|
+
example: 'my-cloudfleet-project'
|
|
757
1000
|
}
|
|
758
1001
|
},
|
|
759
1002
|
required: [
|
|
760
|
-
'
|
|
1003
|
+
'enabled'
|
|
761
1004
|
],
|
|
762
1005
|
additionalProperties: false
|
|
763
1006
|
},
|
|
@@ -765,16 +1008,18 @@ export const FleetCreateInputSchema = {
|
|
|
765
1008
|
type: 'object',
|
|
766
1009
|
properties: {
|
|
767
1010
|
enabled: {
|
|
768
|
-
type: 'boolean'
|
|
769
|
-
default: true
|
|
1011
|
+
type: 'boolean'
|
|
770
1012
|
},
|
|
771
1013
|
apiKey: {
|
|
772
1014
|
type: 'string',
|
|
773
|
-
|
|
1015
|
+
maxLength: 64,
|
|
1016
|
+
minLength: 64,
|
|
1017
|
+
pattern: '^([A-Za-z0-9]{64}|\\*{64})$',
|
|
1018
|
+
description: 'Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.'
|
|
774
1019
|
}
|
|
775
1020
|
},
|
|
776
1021
|
required: [
|
|
777
|
-
'
|
|
1022
|
+
'enabled'
|
|
778
1023
|
],
|
|
779
1024
|
additionalProperties: false
|
|
780
1025
|
},
|
|
@@ -782,19 +1027,359 @@ export const FleetCreateInputSchema = {
|
|
|
782
1027
|
type: 'object',
|
|
783
1028
|
properties: {
|
|
784
1029
|
enabled: {
|
|
785
|
-
type: 'boolean'
|
|
786
|
-
default: true
|
|
1030
|
+
type: 'boolean'
|
|
787
1031
|
},
|
|
788
1032
|
controllerRoleArn: {
|
|
789
1033
|
type: 'string',
|
|
790
|
-
|
|
1034
|
+
pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
|
|
1035
|
+
description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
|
|
1036
|
+
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
791
1037
|
}
|
|
792
1038
|
},
|
|
793
1039
|
required: [
|
|
794
|
-
'
|
|
1040
|
+
'enabled'
|
|
795
1041
|
],
|
|
796
1042
|
additionalProperties: false
|
|
797
1043
|
},
|
|
1044
|
+
constraints: {
|
|
1045
|
+
type: 'object',
|
|
1046
|
+
properties: {
|
|
1047
|
+
'karpenter.sh/capacity-type': {
|
|
1048
|
+
type: 'array',
|
|
1049
|
+
items: {
|
|
1050
|
+
type: 'string',
|
|
1051
|
+
enum: [
|
|
1052
|
+
'on-demand',
|
|
1053
|
+
'spot'
|
|
1054
|
+
]
|
|
1055
|
+
},
|
|
1056
|
+
minItems: 1,
|
|
1057
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1058
|
+
default: [
|
|
1059
|
+
'on-demand',
|
|
1060
|
+
'spot'
|
|
1061
|
+
]
|
|
1062
|
+
},
|
|
1063
|
+
'kubernetes.io/arch': {
|
|
1064
|
+
type: 'array',
|
|
1065
|
+
items: {
|
|
1066
|
+
type: 'string',
|
|
1067
|
+
enum: [
|
|
1068
|
+
'amd64',
|
|
1069
|
+
'arm64'
|
|
1070
|
+
]
|
|
1071
|
+
},
|
|
1072
|
+
minItems: 1,
|
|
1073
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1074
|
+
default: [
|
|
1075
|
+
'amd64'
|
|
1076
|
+
]
|
|
1077
|
+
},
|
|
1078
|
+
'cfke.io/instance-family': {
|
|
1079
|
+
type: 'array',
|
|
1080
|
+
items: {
|
|
1081
|
+
type: 'string',
|
|
1082
|
+
enum: [
|
|
1083
|
+
'a1',
|
|
1084
|
+
'a2',
|
|
1085
|
+
'a3',
|
|
1086
|
+
'a4',
|
|
1087
|
+
'c1',
|
|
1088
|
+
'c2',
|
|
1089
|
+
'c2d',
|
|
1090
|
+
'c3',
|
|
1091
|
+
'c3d',
|
|
1092
|
+
'c4',
|
|
1093
|
+
'c4a',
|
|
1094
|
+
'c4d',
|
|
1095
|
+
'c5',
|
|
1096
|
+
'c5a',
|
|
1097
|
+
'c5ad',
|
|
1098
|
+
'c5d',
|
|
1099
|
+
'c5n',
|
|
1100
|
+
'c6a',
|
|
1101
|
+
'c6g',
|
|
1102
|
+
'c6gd',
|
|
1103
|
+
'c6gn',
|
|
1104
|
+
'c6i',
|
|
1105
|
+
'c6id',
|
|
1106
|
+
'c6in',
|
|
1107
|
+
'c7a',
|
|
1108
|
+
'c7g',
|
|
1109
|
+
'c7gd',
|
|
1110
|
+
'c7gn',
|
|
1111
|
+
'c7i',
|
|
1112
|
+
'c7i-flex',
|
|
1113
|
+
'c8g',
|
|
1114
|
+
'c8gd',
|
|
1115
|
+
'cax',
|
|
1116
|
+
'ccx',
|
|
1117
|
+
'cpx',
|
|
1118
|
+
'cx',
|
|
1119
|
+
'd2',
|
|
1120
|
+
'd3',
|
|
1121
|
+
'd3en',
|
|
1122
|
+
'dl1',
|
|
1123
|
+
'dl2q',
|
|
1124
|
+
'e2',
|
|
1125
|
+
'f1',
|
|
1126
|
+
'f2',
|
|
1127
|
+
'g1',
|
|
1128
|
+
'g2',
|
|
1129
|
+
'g4ad',
|
|
1130
|
+
'g4dn',
|
|
1131
|
+
'g5',
|
|
1132
|
+
'g5g',
|
|
1133
|
+
'g6',
|
|
1134
|
+
'g6e',
|
|
1135
|
+
'gr6',
|
|
1136
|
+
'h1',
|
|
1137
|
+
'h3',
|
|
1138
|
+
'hpc6a',
|
|
1139
|
+
'hpc6id',
|
|
1140
|
+
'hpc7a',
|
|
1141
|
+
'hpc7g',
|
|
1142
|
+
'i2',
|
|
1143
|
+
'i3',
|
|
1144
|
+
'i3en',
|
|
1145
|
+
'i4g',
|
|
1146
|
+
'i4i',
|
|
1147
|
+
'i7i',
|
|
1148
|
+
'i7ie',
|
|
1149
|
+
'i8g',
|
|
1150
|
+
'im4gn',
|
|
1151
|
+
'inf1',
|
|
1152
|
+
'inf2',
|
|
1153
|
+
'is4gen',
|
|
1154
|
+
'm1',
|
|
1155
|
+
'm2',
|
|
1156
|
+
'm3',
|
|
1157
|
+
'm4',
|
|
1158
|
+
'm5',
|
|
1159
|
+
'm5a',
|
|
1160
|
+
'm5ad',
|
|
1161
|
+
'm5d',
|
|
1162
|
+
'm5dn',
|
|
1163
|
+
'm5n',
|
|
1164
|
+
'm5zn',
|
|
1165
|
+
'm6a',
|
|
1166
|
+
'm6g',
|
|
1167
|
+
'm6gd',
|
|
1168
|
+
'm6i',
|
|
1169
|
+
'm6id',
|
|
1170
|
+
'm6idn',
|
|
1171
|
+
'm6in',
|
|
1172
|
+
'm7a',
|
|
1173
|
+
'm7g',
|
|
1174
|
+
'm7gd',
|
|
1175
|
+
'm7i',
|
|
1176
|
+
'm7i-flex',
|
|
1177
|
+
'm8g',
|
|
1178
|
+
'm8gd',
|
|
1179
|
+
'n1',
|
|
1180
|
+
'n2',
|
|
1181
|
+
'n2d',
|
|
1182
|
+
'n4',
|
|
1183
|
+
'p3',
|
|
1184
|
+
'p3dn',
|
|
1185
|
+
'p4d',
|
|
1186
|
+
'p4de',
|
|
1187
|
+
'p5',
|
|
1188
|
+
'p5e',
|
|
1189
|
+
'p5en',
|
|
1190
|
+
'p6-b200',
|
|
1191
|
+
'r3',
|
|
1192
|
+
'r4',
|
|
1193
|
+
'r5',
|
|
1194
|
+
'r5a',
|
|
1195
|
+
'r5ad',
|
|
1196
|
+
'r5b',
|
|
1197
|
+
'r5d',
|
|
1198
|
+
'r5dn',
|
|
1199
|
+
'r5n',
|
|
1200
|
+
'r6a',
|
|
1201
|
+
'r6g',
|
|
1202
|
+
'r6gd',
|
|
1203
|
+
'r6i',
|
|
1204
|
+
'r6id',
|
|
1205
|
+
'r6idn',
|
|
1206
|
+
'r6in',
|
|
1207
|
+
'r7a',
|
|
1208
|
+
'r7g',
|
|
1209
|
+
'r7gd',
|
|
1210
|
+
'r7i',
|
|
1211
|
+
'r7iz',
|
|
1212
|
+
'r8g',
|
|
1213
|
+
'r8gd',
|
|
1214
|
+
't2',
|
|
1215
|
+
't2a',
|
|
1216
|
+
't2d',
|
|
1217
|
+
't3',
|
|
1218
|
+
't3a',
|
|
1219
|
+
't4g',
|
|
1220
|
+
'trn1',
|
|
1221
|
+
'trn1n',
|
|
1222
|
+
'u-3tb1',
|
|
1223
|
+
'u-6tb1',
|
|
1224
|
+
'u7i-12tb',
|
|
1225
|
+
'u7i-6tb',
|
|
1226
|
+
'u7i-8tb',
|
|
1227
|
+
'u7in-16tb',
|
|
1228
|
+
'u7in-24tb',
|
|
1229
|
+
'u7in-32tb',
|
|
1230
|
+
'vt1',
|
|
1231
|
+
'x1',
|
|
1232
|
+
'x1e',
|
|
1233
|
+
'x2gd',
|
|
1234
|
+
'x2idn',
|
|
1235
|
+
'x2iedn',
|
|
1236
|
+
'x2iezn',
|
|
1237
|
+
'x4',
|
|
1238
|
+
'x8g',
|
|
1239
|
+
'z1d',
|
|
1240
|
+
'z3'
|
|
1241
|
+
]
|
|
1242
|
+
},
|
|
1243
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
1244
|
+
default: []
|
|
1245
|
+
},
|
|
1246
|
+
'topology.kubernetes.io/region': {
|
|
1247
|
+
type: 'array',
|
|
1248
|
+
items: {
|
|
1249
|
+
type: 'string',
|
|
1250
|
+
enum: [
|
|
1251
|
+
'africa-south1',
|
|
1252
|
+
'ap-northeast-1',
|
|
1253
|
+
'ap-northeast-2',
|
|
1254
|
+
'ap-northeast-3',
|
|
1255
|
+
'ap-south-1',
|
|
1256
|
+
'ap-southeast-1',
|
|
1257
|
+
'ap-southeast-2',
|
|
1258
|
+
'ash',
|
|
1259
|
+
'asia-east1',
|
|
1260
|
+
'asia-east2',
|
|
1261
|
+
'asia-northeast1',
|
|
1262
|
+
'asia-northeast2',
|
|
1263
|
+
'asia-northeast3',
|
|
1264
|
+
'asia-south1',
|
|
1265
|
+
'asia-south2',
|
|
1266
|
+
'asia-southeast1',
|
|
1267
|
+
'asia-southeast2',
|
|
1268
|
+
'australia-southeast1',
|
|
1269
|
+
'australia-southeast2',
|
|
1270
|
+
'ca-central-1',
|
|
1271
|
+
'eu-central-1',
|
|
1272
|
+
'eu-central-2',
|
|
1273
|
+
'eu-north-1',
|
|
1274
|
+
'eu-west-1',
|
|
1275
|
+
'eu-west-2',
|
|
1276
|
+
'eu-west-3',
|
|
1277
|
+
'europe-central2',
|
|
1278
|
+
'europe-north1',
|
|
1279
|
+
'europe-southwest1',
|
|
1280
|
+
'europe-west1',
|
|
1281
|
+
'europe-west10',
|
|
1282
|
+
'europe-west12',
|
|
1283
|
+
'europe-west2',
|
|
1284
|
+
'europe-west3',
|
|
1285
|
+
'europe-west4',
|
|
1286
|
+
'europe-west6',
|
|
1287
|
+
'europe-west8',
|
|
1288
|
+
'europe-west9',
|
|
1289
|
+
'fsn1',
|
|
1290
|
+
'hel1',
|
|
1291
|
+
'hil',
|
|
1292
|
+
'me-central1',
|
|
1293
|
+
'me-central2',
|
|
1294
|
+
'me-west1',
|
|
1295
|
+
'nbg1',
|
|
1296
|
+
'northamerica-northeast1',
|
|
1297
|
+
'northamerica-northeast2',
|
|
1298
|
+
'sa-east-1',
|
|
1299
|
+
'sin',
|
|
1300
|
+
'southamerica-east1',
|
|
1301
|
+
'southamerica-west1',
|
|
1302
|
+
'us-central1',
|
|
1303
|
+
'us-east-1',
|
|
1304
|
+
'us-east-2',
|
|
1305
|
+
'us-east1',
|
|
1306
|
+
'us-east4',
|
|
1307
|
+
'us-east5',
|
|
1308
|
+
'us-south1',
|
|
1309
|
+
'us-west-1',
|
|
1310
|
+
'us-west-2',
|
|
1311
|
+
'us-west1',
|
|
1312
|
+
'us-west2',
|
|
1313
|
+
'us-west3',
|
|
1314
|
+
'us-west4'
|
|
1315
|
+
]
|
|
1316
|
+
},
|
|
1317
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
1318
|
+
default: []
|
|
1319
|
+
}
|
|
1320
|
+
},
|
|
1321
|
+
additionalProperties: false,
|
|
1322
|
+
description: 'Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.',
|
|
1323
|
+
default: {
|
|
1324
|
+
'karpenter.sh/capacity-type': [
|
|
1325
|
+
'on-demand',
|
|
1326
|
+
'spot'
|
|
1327
|
+
],
|
|
1328
|
+
'kubernetes.io/arch': [
|
|
1329
|
+
'amd64'
|
|
1330
|
+
],
|
|
1331
|
+
'cfke.io/instance-family': [],
|
|
1332
|
+
'topology.kubernetes.io/region': []
|
|
1333
|
+
}
|
|
1334
|
+
},
|
|
1335
|
+
scalingProfile: {
|
|
1336
|
+
type: 'string',
|
|
1337
|
+
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).',
|
|
1338
|
+
default: 'conservative',
|
|
1339
|
+
example: 'conservative',
|
|
1340
|
+
enum: [
|
|
1341
|
+
'aggressive',
|
|
1342
|
+
'conservative'
|
|
1343
|
+
]
|
|
1344
|
+
},
|
|
1345
|
+
taints: {
|
|
1346
|
+
type: 'array',
|
|
1347
|
+
items: {
|
|
1348
|
+
type: 'object',
|
|
1349
|
+
properties: {
|
|
1350
|
+
key: {
|
|
1351
|
+
type: 'string',
|
|
1352
|
+
description: 'Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.',
|
|
1353
|
+
example: 'dedicated'
|
|
1354
|
+
},
|
|
1355
|
+
value: {
|
|
1356
|
+
type: 'string',
|
|
1357
|
+
maxLength: 63,
|
|
1358
|
+
pattern: '^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$',
|
|
1359
|
+
description: 'Taint value. Optional.',
|
|
1360
|
+
example: 'ci'
|
|
1361
|
+
},
|
|
1362
|
+
effect: {
|
|
1363
|
+
type: 'string',
|
|
1364
|
+
description: 'Taint effect.',
|
|
1365
|
+
example: 'NoSchedule',
|
|
1366
|
+
enum: [
|
|
1367
|
+
'NoSchedule',
|
|
1368
|
+
'PreferNoSchedule',
|
|
1369
|
+
'NoExecute'
|
|
1370
|
+
]
|
|
1371
|
+
}
|
|
1372
|
+
},
|
|
1373
|
+
required: [
|
|
1374
|
+
'key',
|
|
1375
|
+
'effect'
|
|
1376
|
+
],
|
|
1377
|
+
additionalProperties: false
|
|
1378
|
+
},
|
|
1379
|
+
maxItems: 50,
|
|
1380
|
+
description: 'Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.',
|
|
1381
|
+
default: []
|
|
1382
|
+
},
|
|
798
1383
|
id: {
|
|
799
1384
|
type: 'string',
|
|
800
1385
|
maxLength: 63,
|
|
@@ -807,7 +1392,8 @@ export const FleetCreateInputSchema = {
|
|
|
807
1392
|
required: [
|
|
808
1393
|
'id'
|
|
809
1394
|
],
|
|
810
|
-
additionalProperties: false
|
|
1395
|
+
additionalProperties: false,
|
|
1396
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
811
1397
|
};
|
|
812
1398
|
export const FleetSchema = {
|
|
813
1399
|
type: 'object',
|
|
@@ -816,15 +1402,12 @@ export const FleetSchema = {
|
|
|
816
1402
|
type: 'object',
|
|
817
1403
|
properties: {
|
|
818
1404
|
cpu: {
|
|
819
|
-
type: '
|
|
820
|
-
format: 'float',
|
|
1405
|
+
type: 'integer',
|
|
821
1406
|
minimum: 0,
|
|
822
|
-
|
|
1407
|
+
maximum: 100000,
|
|
1408
|
+
description: 'CPU limit in cores. Maximum 100,000.'
|
|
823
1409
|
}
|
|
824
1410
|
},
|
|
825
|
-
required: [
|
|
826
|
-
'cpu'
|
|
827
|
-
],
|
|
828
1411
|
additionalProperties: false,
|
|
829
1412
|
description: 'Limits define a set of bounds for provisioning capacity.'
|
|
830
1413
|
},
|
|
@@ -832,16 +1415,17 @@ export const FleetSchema = {
|
|
|
832
1415
|
type: 'object',
|
|
833
1416
|
properties: {
|
|
834
1417
|
enabled: {
|
|
835
|
-
type: 'boolean'
|
|
836
|
-
default: true
|
|
1418
|
+
type: 'boolean'
|
|
837
1419
|
},
|
|
838
1420
|
project: {
|
|
839
1421
|
type: 'string',
|
|
840
|
-
|
|
1422
|
+
pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
|
|
1423
|
+
description: 'GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.',
|
|
1424
|
+
example: 'my-cloudfleet-project'
|
|
841
1425
|
}
|
|
842
1426
|
},
|
|
843
1427
|
required: [
|
|
844
|
-
'
|
|
1428
|
+
'enabled'
|
|
845
1429
|
],
|
|
846
1430
|
additionalProperties: false
|
|
847
1431
|
},
|
|
@@ -849,16 +1433,16 @@ export const FleetSchema = {
|
|
|
849
1433
|
type: 'object',
|
|
850
1434
|
properties: {
|
|
851
1435
|
enabled: {
|
|
852
|
-
type: 'boolean'
|
|
853
|
-
default: true
|
|
1436
|
+
type: 'boolean'
|
|
854
1437
|
},
|
|
855
1438
|
apiKey: {
|
|
856
1439
|
type: 'string',
|
|
857
|
-
|
|
1440
|
+
pattern: '^\\*{64}$',
|
|
1441
|
+
description: 'Redacted Hetzner API token. Returned as 64 asterisks when a token is configured; omitted otherwise. The real value is never echoed by the API.'
|
|
858
1442
|
}
|
|
859
1443
|
},
|
|
860
1444
|
required: [
|
|
861
|
-
'
|
|
1445
|
+
'enabled'
|
|
862
1446
|
],
|
|
863
1447
|
additionalProperties: false
|
|
864
1448
|
},
|
|
@@ -866,19 +1450,363 @@ export const FleetSchema = {
|
|
|
866
1450
|
type: 'object',
|
|
867
1451
|
properties: {
|
|
868
1452
|
enabled: {
|
|
869
|
-
type: 'boolean'
|
|
870
|
-
default: true
|
|
1453
|
+
type: 'boolean'
|
|
871
1454
|
},
|
|
872
1455
|
controllerRoleArn: {
|
|
873
1456
|
type: 'string',
|
|
874
|
-
|
|
1457
|
+
pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
|
|
1458
|
+
description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
|
|
1459
|
+
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
875
1460
|
}
|
|
876
1461
|
},
|
|
877
1462
|
required: [
|
|
878
|
-
'
|
|
1463
|
+
'enabled'
|
|
879
1464
|
],
|
|
880
1465
|
additionalProperties: false
|
|
881
1466
|
},
|
|
1467
|
+
constraints: {
|
|
1468
|
+
type: 'object',
|
|
1469
|
+
properties: {
|
|
1470
|
+
'karpenter.sh/capacity-type': {
|
|
1471
|
+
type: 'array',
|
|
1472
|
+
items: {
|
|
1473
|
+
type: 'string',
|
|
1474
|
+
enum: [
|
|
1475
|
+
'on-demand',
|
|
1476
|
+
'spot'
|
|
1477
|
+
]
|
|
1478
|
+
},
|
|
1479
|
+
minItems: 1,
|
|
1480
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1481
|
+
default: [
|
|
1482
|
+
'on-demand',
|
|
1483
|
+
'spot'
|
|
1484
|
+
]
|
|
1485
|
+
},
|
|
1486
|
+
'kubernetes.io/arch': {
|
|
1487
|
+
type: 'array',
|
|
1488
|
+
items: {
|
|
1489
|
+
type: 'string',
|
|
1490
|
+
enum: [
|
|
1491
|
+
'amd64',
|
|
1492
|
+
'arm64'
|
|
1493
|
+
]
|
|
1494
|
+
},
|
|
1495
|
+
minItems: 1,
|
|
1496
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1497
|
+
default: [
|
|
1498
|
+
'amd64'
|
|
1499
|
+
]
|
|
1500
|
+
},
|
|
1501
|
+
'cfke.io/instance-family': {
|
|
1502
|
+
type: 'array',
|
|
1503
|
+
items: {
|
|
1504
|
+
type: 'string',
|
|
1505
|
+
enum: [
|
|
1506
|
+
'a1',
|
|
1507
|
+
'a2',
|
|
1508
|
+
'a3',
|
|
1509
|
+
'a4',
|
|
1510
|
+
'c1',
|
|
1511
|
+
'c2',
|
|
1512
|
+
'c2d',
|
|
1513
|
+
'c3',
|
|
1514
|
+
'c3d',
|
|
1515
|
+
'c4',
|
|
1516
|
+
'c4a',
|
|
1517
|
+
'c4d',
|
|
1518
|
+
'c5',
|
|
1519
|
+
'c5a',
|
|
1520
|
+
'c5ad',
|
|
1521
|
+
'c5d',
|
|
1522
|
+
'c5n',
|
|
1523
|
+
'c6a',
|
|
1524
|
+
'c6g',
|
|
1525
|
+
'c6gd',
|
|
1526
|
+
'c6gn',
|
|
1527
|
+
'c6i',
|
|
1528
|
+
'c6id',
|
|
1529
|
+
'c6in',
|
|
1530
|
+
'c7a',
|
|
1531
|
+
'c7g',
|
|
1532
|
+
'c7gd',
|
|
1533
|
+
'c7gn',
|
|
1534
|
+
'c7i',
|
|
1535
|
+
'c7i-flex',
|
|
1536
|
+
'c8g',
|
|
1537
|
+
'c8gd',
|
|
1538
|
+
'cax',
|
|
1539
|
+
'ccx',
|
|
1540
|
+
'cpx',
|
|
1541
|
+
'cx',
|
|
1542
|
+
'd2',
|
|
1543
|
+
'd3',
|
|
1544
|
+
'd3en',
|
|
1545
|
+
'dl1',
|
|
1546
|
+
'dl2q',
|
|
1547
|
+
'e2',
|
|
1548
|
+
'f1',
|
|
1549
|
+
'f2',
|
|
1550
|
+
'g1',
|
|
1551
|
+
'g2',
|
|
1552
|
+
'g4ad',
|
|
1553
|
+
'g4dn',
|
|
1554
|
+
'g5',
|
|
1555
|
+
'g5g',
|
|
1556
|
+
'g6',
|
|
1557
|
+
'g6e',
|
|
1558
|
+
'gr6',
|
|
1559
|
+
'h1',
|
|
1560
|
+
'h3',
|
|
1561
|
+
'hpc6a',
|
|
1562
|
+
'hpc6id',
|
|
1563
|
+
'hpc7a',
|
|
1564
|
+
'hpc7g',
|
|
1565
|
+
'i2',
|
|
1566
|
+
'i3',
|
|
1567
|
+
'i3en',
|
|
1568
|
+
'i4g',
|
|
1569
|
+
'i4i',
|
|
1570
|
+
'i7i',
|
|
1571
|
+
'i7ie',
|
|
1572
|
+
'i8g',
|
|
1573
|
+
'im4gn',
|
|
1574
|
+
'inf1',
|
|
1575
|
+
'inf2',
|
|
1576
|
+
'is4gen',
|
|
1577
|
+
'm1',
|
|
1578
|
+
'm2',
|
|
1579
|
+
'm3',
|
|
1580
|
+
'm4',
|
|
1581
|
+
'm5',
|
|
1582
|
+
'm5a',
|
|
1583
|
+
'm5ad',
|
|
1584
|
+
'm5d',
|
|
1585
|
+
'm5dn',
|
|
1586
|
+
'm5n',
|
|
1587
|
+
'm5zn',
|
|
1588
|
+
'm6a',
|
|
1589
|
+
'm6g',
|
|
1590
|
+
'm6gd',
|
|
1591
|
+
'm6i',
|
|
1592
|
+
'm6id',
|
|
1593
|
+
'm6idn',
|
|
1594
|
+
'm6in',
|
|
1595
|
+
'm7a',
|
|
1596
|
+
'm7g',
|
|
1597
|
+
'm7gd',
|
|
1598
|
+
'm7i',
|
|
1599
|
+
'm7i-flex',
|
|
1600
|
+
'm8g',
|
|
1601
|
+
'm8gd',
|
|
1602
|
+
'n1',
|
|
1603
|
+
'n2',
|
|
1604
|
+
'n2d',
|
|
1605
|
+
'n4',
|
|
1606
|
+
'p3',
|
|
1607
|
+
'p3dn',
|
|
1608
|
+
'p4d',
|
|
1609
|
+
'p4de',
|
|
1610
|
+
'p5',
|
|
1611
|
+
'p5e',
|
|
1612
|
+
'p5en',
|
|
1613
|
+
'p6-b200',
|
|
1614
|
+
'r3',
|
|
1615
|
+
'r4',
|
|
1616
|
+
'r5',
|
|
1617
|
+
'r5a',
|
|
1618
|
+
'r5ad',
|
|
1619
|
+
'r5b',
|
|
1620
|
+
'r5d',
|
|
1621
|
+
'r5dn',
|
|
1622
|
+
'r5n',
|
|
1623
|
+
'r6a',
|
|
1624
|
+
'r6g',
|
|
1625
|
+
'r6gd',
|
|
1626
|
+
'r6i',
|
|
1627
|
+
'r6id',
|
|
1628
|
+
'r6idn',
|
|
1629
|
+
'r6in',
|
|
1630
|
+
'r7a',
|
|
1631
|
+
'r7g',
|
|
1632
|
+
'r7gd',
|
|
1633
|
+
'r7i',
|
|
1634
|
+
'r7iz',
|
|
1635
|
+
'r8g',
|
|
1636
|
+
'r8gd',
|
|
1637
|
+
't2',
|
|
1638
|
+
't2a',
|
|
1639
|
+
't2d',
|
|
1640
|
+
't3',
|
|
1641
|
+
't3a',
|
|
1642
|
+
't4g',
|
|
1643
|
+
'trn1',
|
|
1644
|
+
'trn1n',
|
|
1645
|
+
'u-3tb1',
|
|
1646
|
+
'u-6tb1',
|
|
1647
|
+
'u7i-12tb',
|
|
1648
|
+
'u7i-6tb',
|
|
1649
|
+
'u7i-8tb',
|
|
1650
|
+
'u7in-16tb',
|
|
1651
|
+
'u7in-24tb',
|
|
1652
|
+
'u7in-32tb',
|
|
1653
|
+
'vt1',
|
|
1654
|
+
'x1',
|
|
1655
|
+
'x1e',
|
|
1656
|
+
'x2gd',
|
|
1657
|
+
'x2idn',
|
|
1658
|
+
'x2iedn',
|
|
1659
|
+
'x2iezn',
|
|
1660
|
+
'x4',
|
|
1661
|
+
'x8g',
|
|
1662
|
+
'z1d',
|
|
1663
|
+
'z3'
|
|
1664
|
+
]
|
|
1665
|
+
},
|
|
1666
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
1667
|
+
default: []
|
|
1668
|
+
},
|
|
1669
|
+
'topology.kubernetes.io/region': {
|
|
1670
|
+
type: 'array',
|
|
1671
|
+
items: {
|
|
1672
|
+
type: 'string',
|
|
1673
|
+
enum: [
|
|
1674
|
+
'africa-south1',
|
|
1675
|
+
'ap-northeast-1',
|
|
1676
|
+
'ap-northeast-2',
|
|
1677
|
+
'ap-northeast-3',
|
|
1678
|
+
'ap-south-1',
|
|
1679
|
+
'ap-southeast-1',
|
|
1680
|
+
'ap-southeast-2',
|
|
1681
|
+
'ash',
|
|
1682
|
+
'asia-east1',
|
|
1683
|
+
'asia-east2',
|
|
1684
|
+
'asia-northeast1',
|
|
1685
|
+
'asia-northeast2',
|
|
1686
|
+
'asia-northeast3',
|
|
1687
|
+
'asia-south1',
|
|
1688
|
+
'asia-south2',
|
|
1689
|
+
'asia-southeast1',
|
|
1690
|
+
'asia-southeast2',
|
|
1691
|
+
'australia-southeast1',
|
|
1692
|
+
'australia-southeast2',
|
|
1693
|
+
'ca-central-1',
|
|
1694
|
+
'eu-central-1',
|
|
1695
|
+
'eu-central-2',
|
|
1696
|
+
'eu-north-1',
|
|
1697
|
+
'eu-west-1',
|
|
1698
|
+
'eu-west-2',
|
|
1699
|
+
'eu-west-3',
|
|
1700
|
+
'europe-central2',
|
|
1701
|
+
'europe-north1',
|
|
1702
|
+
'europe-southwest1',
|
|
1703
|
+
'europe-west1',
|
|
1704
|
+
'europe-west10',
|
|
1705
|
+
'europe-west12',
|
|
1706
|
+
'europe-west2',
|
|
1707
|
+
'europe-west3',
|
|
1708
|
+
'europe-west4',
|
|
1709
|
+
'europe-west6',
|
|
1710
|
+
'europe-west8',
|
|
1711
|
+
'europe-west9',
|
|
1712
|
+
'fsn1',
|
|
1713
|
+
'hel1',
|
|
1714
|
+
'hil',
|
|
1715
|
+
'me-central1',
|
|
1716
|
+
'me-central2',
|
|
1717
|
+
'me-west1',
|
|
1718
|
+
'nbg1',
|
|
1719
|
+
'northamerica-northeast1',
|
|
1720
|
+
'northamerica-northeast2',
|
|
1721
|
+
'sa-east-1',
|
|
1722
|
+
'sin',
|
|
1723
|
+
'southamerica-east1',
|
|
1724
|
+
'southamerica-west1',
|
|
1725
|
+
'us-central1',
|
|
1726
|
+
'us-east-1',
|
|
1727
|
+
'us-east-2',
|
|
1728
|
+
'us-east1',
|
|
1729
|
+
'us-east4',
|
|
1730
|
+
'us-east5',
|
|
1731
|
+
'us-south1',
|
|
1732
|
+
'us-west-1',
|
|
1733
|
+
'us-west-2',
|
|
1734
|
+
'us-west1',
|
|
1735
|
+
'us-west2',
|
|
1736
|
+
'us-west3',
|
|
1737
|
+
'us-west4'
|
|
1738
|
+
]
|
|
1739
|
+
},
|
|
1740
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
1741
|
+
default: []
|
|
1742
|
+
}
|
|
1743
|
+
},
|
|
1744
|
+
required: [
|
|
1745
|
+
'karpenter.sh/capacity-type',
|
|
1746
|
+
'kubernetes.io/arch'
|
|
1747
|
+
],
|
|
1748
|
+
additionalProperties: false,
|
|
1749
|
+
description: 'Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.',
|
|
1750
|
+
default: {
|
|
1751
|
+
'karpenter.sh/capacity-type': [
|
|
1752
|
+
'on-demand',
|
|
1753
|
+
'spot'
|
|
1754
|
+
],
|
|
1755
|
+
'kubernetes.io/arch': [
|
|
1756
|
+
'amd64'
|
|
1757
|
+
],
|
|
1758
|
+
'cfke.io/instance-family': [],
|
|
1759
|
+
'topology.kubernetes.io/region': []
|
|
1760
|
+
}
|
|
1761
|
+
},
|
|
1762
|
+
scalingProfile: {
|
|
1763
|
+
type: 'string',
|
|
1764
|
+
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).',
|
|
1765
|
+
default: 'conservative',
|
|
1766
|
+
example: 'conservative',
|
|
1767
|
+
enum: [
|
|
1768
|
+
'aggressive',
|
|
1769
|
+
'conservative'
|
|
1770
|
+
]
|
|
1771
|
+
},
|
|
1772
|
+
taints: {
|
|
1773
|
+
type: 'array',
|
|
1774
|
+
items: {
|
|
1775
|
+
type: 'object',
|
|
1776
|
+
properties: {
|
|
1777
|
+
key: {
|
|
1778
|
+
type: 'string',
|
|
1779
|
+
description: 'Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.',
|
|
1780
|
+
example: 'dedicated'
|
|
1781
|
+
},
|
|
1782
|
+
value: {
|
|
1783
|
+
type: 'string',
|
|
1784
|
+
maxLength: 63,
|
|
1785
|
+
pattern: '^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$',
|
|
1786
|
+
description: 'Taint value. Optional.',
|
|
1787
|
+
example: 'ci'
|
|
1788
|
+
},
|
|
1789
|
+
effect: {
|
|
1790
|
+
type: 'string',
|
|
1791
|
+
description: 'Taint effect.',
|
|
1792
|
+
example: 'NoSchedule',
|
|
1793
|
+
enum: [
|
|
1794
|
+
'NoSchedule',
|
|
1795
|
+
'PreferNoSchedule',
|
|
1796
|
+
'NoExecute'
|
|
1797
|
+
]
|
|
1798
|
+
}
|
|
1799
|
+
},
|
|
1800
|
+
required: [
|
|
1801
|
+
'key',
|
|
1802
|
+
'effect'
|
|
1803
|
+
],
|
|
1804
|
+
additionalProperties: false
|
|
1805
|
+
},
|
|
1806
|
+
maxItems: 50,
|
|
1807
|
+
description: 'Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.',
|
|
1808
|
+
default: []
|
|
1809
|
+
},
|
|
882
1810
|
id: {
|
|
883
1811
|
type: 'string',
|
|
884
1812
|
maxLength: 63,
|
|
@@ -886,12 +1814,39 @@ export const FleetSchema = {
|
|
|
886
1814
|
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
887
1815
|
description: 'Unique identifier of the kubernetes fleet.',
|
|
888
1816
|
example: 'new-clouds-fleet'
|
|
1817
|
+
},
|
|
1818
|
+
ready: {
|
|
1819
|
+
type: 'boolean',
|
|
1820
|
+
description: 'Indicates whether the fleet configuration is healthy.',
|
|
1821
|
+
example: true
|
|
1822
|
+
},
|
|
1823
|
+
status_message: {
|
|
1824
|
+
type: 'string',
|
|
1825
|
+
description: 'Human-readable reason the fleet is not ready. Present only when `ready` is false.',
|
|
1826
|
+
example: 'Invalid provider permissions.'
|
|
1827
|
+
},
|
|
1828
|
+
created_at: {
|
|
1829
|
+
type: 'string',
|
|
1830
|
+
description: 'Creation date and time of the fleet.',
|
|
1831
|
+
example: '2024-09-12T09:11:27Z'
|
|
1832
|
+
},
|
|
1833
|
+
updated_at: {
|
|
1834
|
+
type: 'string',
|
|
1835
|
+
description: 'Date and time the fleet was last updated.',
|
|
1836
|
+
example: '2024-09-12T09:11:27Z'
|
|
889
1837
|
}
|
|
890
1838
|
},
|
|
891
1839
|
required: [
|
|
892
|
-
'
|
|
1840
|
+
'constraints',
|
|
1841
|
+
'scalingProfile',
|
|
1842
|
+
'taints',
|
|
1843
|
+
'id',
|
|
1844
|
+
'ready',
|
|
1845
|
+
'created_at',
|
|
1846
|
+
'updated_at'
|
|
893
1847
|
],
|
|
894
|
-
additionalProperties: false
|
|
1848
|
+
additionalProperties: false,
|
|
1849
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
895
1850
|
};
|
|
896
1851
|
export const FleetUpdateInputSchema = {
|
|
897
1852
|
type: 'object',
|
|
@@ -900,15 +1855,12 @@ export const FleetUpdateInputSchema = {
|
|
|
900
1855
|
type: 'object',
|
|
901
1856
|
properties: {
|
|
902
1857
|
cpu: {
|
|
903
|
-
type: '
|
|
904
|
-
format: 'float',
|
|
1858
|
+
type: 'integer',
|
|
905
1859
|
minimum: 0,
|
|
906
|
-
|
|
1860
|
+
maximum: 100000,
|
|
1861
|
+
description: 'CPU limit in cores. Maximum 100,000.'
|
|
907
1862
|
}
|
|
908
1863
|
},
|
|
909
|
-
required: [
|
|
910
|
-
'cpu'
|
|
911
|
-
],
|
|
912
1864
|
additionalProperties: false,
|
|
913
1865
|
description: 'Limits define a set of bounds for provisioning capacity.'
|
|
914
1866
|
},
|
|
@@ -916,16 +1868,17 @@ export const FleetUpdateInputSchema = {
|
|
|
916
1868
|
type: 'object',
|
|
917
1869
|
properties: {
|
|
918
1870
|
enabled: {
|
|
919
|
-
type: 'boolean'
|
|
920
|
-
default: true
|
|
1871
|
+
type: 'boolean'
|
|
921
1872
|
},
|
|
922
1873
|
project: {
|
|
923
1874
|
type: 'string',
|
|
924
|
-
|
|
1875
|
+
pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
|
|
1876
|
+
description: 'GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.',
|
|
1877
|
+
example: 'my-cloudfleet-project'
|
|
925
1878
|
}
|
|
926
1879
|
},
|
|
927
1880
|
required: [
|
|
928
|
-
'
|
|
1881
|
+
'enabled'
|
|
929
1882
|
],
|
|
930
1883
|
additionalProperties: false
|
|
931
1884
|
},
|
|
@@ -933,16 +1886,18 @@ export const FleetUpdateInputSchema = {
|
|
|
933
1886
|
type: 'object',
|
|
934
1887
|
properties: {
|
|
935
1888
|
enabled: {
|
|
936
|
-
type: 'boolean'
|
|
937
|
-
default: true
|
|
1889
|
+
type: 'boolean'
|
|
938
1890
|
},
|
|
939
1891
|
apiKey: {
|
|
940
1892
|
type: 'string',
|
|
941
|
-
|
|
1893
|
+
maxLength: 64,
|
|
1894
|
+
minLength: 64,
|
|
1895
|
+
pattern: '^([A-Za-z0-9]{64}|\\*{64})$',
|
|
1896
|
+
description: 'Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.'
|
|
942
1897
|
}
|
|
943
1898
|
},
|
|
944
1899
|
required: [
|
|
945
|
-
'
|
|
1900
|
+
'enabled'
|
|
946
1901
|
],
|
|
947
1902
|
additionalProperties: false
|
|
948
1903
|
},
|
|
@@ -950,20 +1905,386 @@ export const FleetUpdateInputSchema = {
|
|
|
950
1905
|
type: 'object',
|
|
951
1906
|
properties: {
|
|
952
1907
|
enabled: {
|
|
953
|
-
type: 'boolean'
|
|
954
|
-
default: true
|
|
1908
|
+
type: 'boolean'
|
|
955
1909
|
},
|
|
956
1910
|
controllerRoleArn: {
|
|
957
1911
|
type: 'string',
|
|
958
|
-
|
|
1912
|
+
pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
|
|
1913
|
+
description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
|
|
1914
|
+
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
959
1915
|
}
|
|
960
1916
|
},
|
|
961
1917
|
required: [
|
|
962
|
-
'
|
|
1918
|
+
'enabled'
|
|
963
1919
|
],
|
|
964
1920
|
additionalProperties: false
|
|
1921
|
+
},
|
|
1922
|
+
constraints: {
|
|
1923
|
+
type: 'object',
|
|
1924
|
+
properties: {
|
|
1925
|
+
'karpenter.sh/capacity-type': {
|
|
1926
|
+
type: 'array',
|
|
1927
|
+
items: {
|
|
1928
|
+
type: 'string',
|
|
1929
|
+
enum: [
|
|
1930
|
+
'on-demand',
|
|
1931
|
+
'spot'
|
|
1932
|
+
]
|
|
1933
|
+
},
|
|
1934
|
+
minItems: 1,
|
|
1935
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1936
|
+
default: [
|
|
1937
|
+
'on-demand',
|
|
1938
|
+
'spot'
|
|
1939
|
+
]
|
|
1940
|
+
},
|
|
1941
|
+
'kubernetes.io/arch': {
|
|
1942
|
+
type: 'array',
|
|
1943
|
+
items: {
|
|
1944
|
+
type: 'string',
|
|
1945
|
+
enum: [
|
|
1946
|
+
'amd64',
|
|
1947
|
+
'arm64'
|
|
1948
|
+
]
|
|
1949
|
+
},
|
|
1950
|
+
minItems: 1,
|
|
1951
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1952
|
+
default: [
|
|
1953
|
+
'amd64'
|
|
1954
|
+
]
|
|
1955
|
+
},
|
|
1956
|
+
'cfke.io/instance-family': {
|
|
1957
|
+
type: 'array',
|
|
1958
|
+
items: {
|
|
1959
|
+
type: 'string',
|
|
1960
|
+
enum: [
|
|
1961
|
+
'a1',
|
|
1962
|
+
'a2',
|
|
1963
|
+
'a3',
|
|
1964
|
+
'a4',
|
|
1965
|
+
'c1',
|
|
1966
|
+
'c2',
|
|
1967
|
+
'c2d',
|
|
1968
|
+
'c3',
|
|
1969
|
+
'c3d',
|
|
1970
|
+
'c4',
|
|
1971
|
+
'c4a',
|
|
1972
|
+
'c4d',
|
|
1973
|
+
'c5',
|
|
1974
|
+
'c5a',
|
|
1975
|
+
'c5ad',
|
|
1976
|
+
'c5d',
|
|
1977
|
+
'c5n',
|
|
1978
|
+
'c6a',
|
|
1979
|
+
'c6g',
|
|
1980
|
+
'c6gd',
|
|
1981
|
+
'c6gn',
|
|
1982
|
+
'c6i',
|
|
1983
|
+
'c6id',
|
|
1984
|
+
'c6in',
|
|
1985
|
+
'c7a',
|
|
1986
|
+
'c7g',
|
|
1987
|
+
'c7gd',
|
|
1988
|
+
'c7gn',
|
|
1989
|
+
'c7i',
|
|
1990
|
+
'c7i-flex',
|
|
1991
|
+
'c8g',
|
|
1992
|
+
'c8gd',
|
|
1993
|
+
'cax',
|
|
1994
|
+
'ccx',
|
|
1995
|
+
'cpx',
|
|
1996
|
+
'cx',
|
|
1997
|
+
'd2',
|
|
1998
|
+
'd3',
|
|
1999
|
+
'd3en',
|
|
2000
|
+
'dl1',
|
|
2001
|
+
'dl2q',
|
|
2002
|
+
'e2',
|
|
2003
|
+
'f1',
|
|
2004
|
+
'f2',
|
|
2005
|
+
'g1',
|
|
2006
|
+
'g2',
|
|
2007
|
+
'g4ad',
|
|
2008
|
+
'g4dn',
|
|
2009
|
+
'g5',
|
|
2010
|
+
'g5g',
|
|
2011
|
+
'g6',
|
|
2012
|
+
'g6e',
|
|
2013
|
+
'gr6',
|
|
2014
|
+
'h1',
|
|
2015
|
+
'h3',
|
|
2016
|
+
'hpc6a',
|
|
2017
|
+
'hpc6id',
|
|
2018
|
+
'hpc7a',
|
|
2019
|
+
'hpc7g',
|
|
2020
|
+
'i2',
|
|
2021
|
+
'i3',
|
|
2022
|
+
'i3en',
|
|
2023
|
+
'i4g',
|
|
2024
|
+
'i4i',
|
|
2025
|
+
'i7i',
|
|
2026
|
+
'i7ie',
|
|
2027
|
+
'i8g',
|
|
2028
|
+
'im4gn',
|
|
2029
|
+
'inf1',
|
|
2030
|
+
'inf2',
|
|
2031
|
+
'is4gen',
|
|
2032
|
+
'm1',
|
|
2033
|
+
'm2',
|
|
2034
|
+
'm3',
|
|
2035
|
+
'm4',
|
|
2036
|
+
'm5',
|
|
2037
|
+
'm5a',
|
|
2038
|
+
'm5ad',
|
|
2039
|
+
'm5d',
|
|
2040
|
+
'm5dn',
|
|
2041
|
+
'm5n',
|
|
2042
|
+
'm5zn',
|
|
2043
|
+
'm6a',
|
|
2044
|
+
'm6g',
|
|
2045
|
+
'm6gd',
|
|
2046
|
+
'm6i',
|
|
2047
|
+
'm6id',
|
|
2048
|
+
'm6idn',
|
|
2049
|
+
'm6in',
|
|
2050
|
+
'm7a',
|
|
2051
|
+
'm7g',
|
|
2052
|
+
'm7gd',
|
|
2053
|
+
'm7i',
|
|
2054
|
+
'm7i-flex',
|
|
2055
|
+
'm8g',
|
|
2056
|
+
'm8gd',
|
|
2057
|
+
'n1',
|
|
2058
|
+
'n2',
|
|
2059
|
+
'n2d',
|
|
2060
|
+
'n4',
|
|
2061
|
+
'p3',
|
|
2062
|
+
'p3dn',
|
|
2063
|
+
'p4d',
|
|
2064
|
+
'p4de',
|
|
2065
|
+
'p5',
|
|
2066
|
+
'p5e',
|
|
2067
|
+
'p5en',
|
|
2068
|
+
'p6-b200',
|
|
2069
|
+
'r3',
|
|
2070
|
+
'r4',
|
|
2071
|
+
'r5',
|
|
2072
|
+
'r5a',
|
|
2073
|
+
'r5ad',
|
|
2074
|
+
'r5b',
|
|
2075
|
+
'r5d',
|
|
2076
|
+
'r5dn',
|
|
2077
|
+
'r5n',
|
|
2078
|
+
'r6a',
|
|
2079
|
+
'r6g',
|
|
2080
|
+
'r6gd',
|
|
2081
|
+
'r6i',
|
|
2082
|
+
'r6id',
|
|
2083
|
+
'r6idn',
|
|
2084
|
+
'r6in',
|
|
2085
|
+
'r7a',
|
|
2086
|
+
'r7g',
|
|
2087
|
+
'r7gd',
|
|
2088
|
+
'r7i',
|
|
2089
|
+
'r7iz',
|
|
2090
|
+
'r8g',
|
|
2091
|
+
'r8gd',
|
|
2092
|
+
't2',
|
|
2093
|
+
't2a',
|
|
2094
|
+
't2d',
|
|
2095
|
+
't3',
|
|
2096
|
+
't3a',
|
|
2097
|
+
't4g',
|
|
2098
|
+
'trn1',
|
|
2099
|
+
'trn1n',
|
|
2100
|
+
'u-3tb1',
|
|
2101
|
+
'u-6tb1',
|
|
2102
|
+
'u7i-12tb',
|
|
2103
|
+
'u7i-6tb',
|
|
2104
|
+
'u7i-8tb',
|
|
2105
|
+
'u7in-16tb',
|
|
2106
|
+
'u7in-24tb',
|
|
2107
|
+
'u7in-32tb',
|
|
2108
|
+
'vt1',
|
|
2109
|
+
'x1',
|
|
2110
|
+
'x1e',
|
|
2111
|
+
'x2gd',
|
|
2112
|
+
'x2idn',
|
|
2113
|
+
'x2iedn',
|
|
2114
|
+
'x2iezn',
|
|
2115
|
+
'x4',
|
|
2116
|
+
'x8g',
|
|
2117
|
+
'z1d',
|
|
2118
|
+
'z3'
|
|
2119
|
+
]
|
|
2120
|
+
},
|
|
2121
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
2122
|
+
default: []
|
|
2123
|
+
},
|
|
2124
|
+
'topology.kubernetes.io/region': {
|
|
2125
|
+
type: 'array',
|
|
2126
|
+
items: {
|
|
2127
|
+
type: 'string',
|
|
2128
|
+
enum: [
|
|
2129
|
+
'africa-south1',
|
|
2130
|
+
'ap-northeast-1',
|
|
2131
|
+
'ap-northeast-2',
|
|
2132
|
+
'ap-northeast-3',
|
|
2133
|
+
'ap-south-1',
|
|
2134
|
+
'ap-southeast-1',
|
|
2135
|
+
'ap-southeast-2',
|
|
2136
|
+
'ash',
|
|
2137
|
+
'asia-east1',
|
|
2138
|
+
'asia-east2',
|
|
2139
|
+
'asia-northeast1',
|
|
2140
|
+
'asia-northeast2',
|
|
2141
|
+
'asia-northeast3',
|
|
2142
|
+
'asia-south1',
|
|
2143
|
+
'asia-south2',
|
|
2144
|
+
'asia-southeast1',
|
|
2145
|
+
'asia-southeast2',
|
|
2146
|
+
'australia-southeast1',
|
|
2147
|
+
'australia-southeast2',
|
|
2148
|
+
'ca-central-1',
|
|
2149
|
+
'eu-central-1',
|
|
2150
|
+
'eu-central-2',
|
|
2151
|
+
'eu-north-1',
|
|
2152
|
+
'eu-west-1',
|
|
2153
|
+
'eu-west-2',
|
|
2154
|
+
'eu-west-3',
|
|
2155
|
+
'europe-central2',
|
|
2156
|
+
'europe-north1',
|
|
2157
|
+
'europe-southwest1',
|
|
2158
|
+
'europe-west1',
|
|
2159
|
+
'europe-west10',
|
|
2160
|
+
'europe-west12',
|
|
2161
|
+
'europe-west2',
|
|
2162
|
+
'europe-west3',
|
|
2163
|
+
'europe-west4',
|
|
2164
|
+
'europe-west6',
|
|
2165
|
+
'europe-west8',
|
|
2166
|
+
'europe-west9',
|
|
2167
|
+
'fsn1',
|
|
2168
|
+
'hel1',
|
|
2169
|
+
'hil',
|
|
2170
|
+
'me-central1',
|
|
2171
|
+
'me-central2',
|
|
2172
|
+
'me-west1',
|
|
2173
|
+
'nbg1',
|
|
2174
|
+
'northamerica-northeast1',
|
|
2175
|
+
'northamerica-northeast2',
|
|
2176
|
+
'sa-east-1',
|
|
2177
|
+
'sin',
|
|
2178
|
+
'southamerica-east1',
|
|
2179
|
+
'southamerica-west1',
|
|
2180
|
+
'us-central1',
|
|
2181
|
+
'us-east-1',
|
|
2182
|
+
'us-east-2',
|
|
2183
|
+
'us-east1',
|
|
2184
|
+
'us-east4',
|
|
2185
|
+
'us-east5',
|
|
2186
|
+
'us-south1',
|
|
2187
|
+
'us-west-1',
|
|
2188
|
+
'us-west-2',
|
|
2189
|
+
'us-west1',
|
|
2190
|
+
'us-west2',
|
|
2191
|
+
'us-west3',
|
|
2192
|
+
'us-west4'
|
|
2193
|
+
]
|
|
2194
|
+
},
|
|
2195
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
2196
|
+
default: []
|
|
2197
|
+
}
|
|
2198
|
+
},
|
|
2199
|
+
additionalProperties: false,
|
|
2200
|
+
description: 'Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.',
|
|
2201
|
+
default: {
|
|
2202
|
+
'karpenter.sh/capacity-type': [
|
|
2203
|
+
'on-demand',
|
|
2204
|
+
'spot'
|
|
2205
|
+
],
|
|
2206
|
+
'kubernetes.io/arch': [
|
|
2207
|
+
'amd64'
|
|
2208
|
+
],
|
|
2209
|
+
'cfke.io/instance-family': [],
|
|
2210
|
+
'topology.kubernetes.io/region': []
|
|
2211
|
+
}
|
|
2212
|
+
},
|
|
2213
|
+
scalingProfile: {
|
|
2214
|
+
type: 'string',
|
|
2215
|
+
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).',
|
|
2216
|
+
default: 'conservative',
|
|
2217
|
+
example: 'conservative',
|
|
2218
|
+
enum: [
|
|
2219
|
+
'aggressive',
|
|
2220
|
+
'conservative'
|
|
2221
|
+
]
|
|
2222
|
+
},
|
|
2223
|
+
taints: {
|
|
2224
|
+
type: 'array',
|
|
2225
|
+
items: {
|
|
2226
|
+
type: 'object',
|
|
2227
|
+
properties: {
|
|
2228
|
+
key: {
|
|
2229
|
+
type: 'string',
|
|
2230
|
+
description: 'Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.',
|
|
2231
|
+
example: 'dedicated'
|
|
2232
|
+
},
|
|
2233
|
+
value: {
|
|
2234
|
+
type: 'string',
|
|
2235
|
+
maxLength: 63,
|
|
2236
|
+
pattern: '^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$',
|
|
2237
|
+
description: 'Taint value. Optional.',
|
|
2238
|
+
example: 'ci'
|
|
2239
|
+
},
|
|
2240
|
+
effect: {
|
|
2241
|
+
type: 'string',
|
|
2242
|
+
description: 'Taint effect.',
|
|
2243
|
+
example: 'NoSchedule',
|
|
2244
|
+
enum: [
|
|
2245
|
+
'NoSchedule',
|
|
2246
|
+
'PreferNoSchedule',
|
|
2247
|
+
'NoExecute'
|
|
2248
|
+
]
|
|
2249
|
+
}
|
|
2250
|
+
},
|
|
2251
|
+
required: [
|
|
2252
|
+
'key',
|
|
2253
|
+
'effect'
|
|
2254
|
+
],
|
|
2255
|
+
additionalProperties: false
|
|
2256
|
+
},
|
|
2257
|
+
maxItems: 50,
|
|
2258
|
+
description: 'Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.',
|
|
2259
|
+
default: []
|
|
965
2260
|
}
|
|
966
2261
|
},
|
|
2262
|
+
additionalProperties: false,
|
|
2263
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
2264
|
+
};
|
|
2265
|
+
export const InviteCreateInputSchema = {
|
|
2266
|
+
type: 'object',
|
|
2267
|
+
properties: {
|
|
2268
|
+
email: {
|
|
2269
|
+
type: 'string',
|
|
2270
|
+
format: 'email',
|
|
2271
|
+
description: 'Email address of the user to invite.',
|
|
2272
|
+
example: 'email@example.com'
|
|
2273
|
+
},
|
|
2274
|
+
role: {
|
|
2275
|
+
type: 'string',
|
|
2276
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2277
|
+
default: 'User',
|
|
2278
|
+
example: 'User',
|
|
2279
|
+
enum: [
|
|
2280
|
+
'Administrator',
|
|
2281
|
+
'User'
|
|
2282
|
+
]
|
|
2283
|
+
}
|
|
2284
|
+
},
|
|
2285
|
+
required: [
|
|
2286
|
+
'email'
|
|
2287
|
+
],
|
|
967
2288
|
additionalProperties: false
|
|
968
2289
|
};
|
|
969
2290
|
export const InviteSchema = {
|
|
@@ -996,6 +2317,16 @@ export const InviteSchema = {
|
|
|
996
2317
|
type: 'string',
|
|
997
2318
|
description: 'Generated unique invite code.',
|
|
998
2319
|
example: '7kUZnH7nnKUFfvc4NK2KQF'
|
|
2320
|
+
},
|
|
2321
|
+
role: {
|
|
2322
|
+
type: 'string',
|
|
2323
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2324
|
+
default: 'User',
|
|
2325
|
+
example: 'User',
|
|
2326
|
+
enum: [
|
|
2327
|
+
'Administrator',
|
|
2328
|
+
'User'
|
|
2329
|
+
]
|
|
999
2330
|
}
|
|
1000
2331
|
},
|
|
1001
2332
|
required: [
|
|
@@ -1003,6 +2334,170 @@ export const InviteSchema = {
|
|
|
1003
2334
|
],
|
|
1004
2335
|
additionalProperties: false
|
|
1005
2336
|
};
|
|
2337
|
+
export const InvoicePaymentAttemptSchema = {
|
|
2338
|
+
type: 'object',
|
|
2339
|
+
properties: {
|
|
2340
|
+
invoice_id: {
|
|
2341
|
+
type: 'string',
|
|
2342
|
+
description: 'Identifier of the invoice.',
|
|
2343
|
+
example: 'in_1234567890xCrwxghOTj1234'
|
|
2344
|
+
},
|
|
2345
|
+
number: {
|
|
2346
|
+
type: 'string',
|
|
2347
|
+
nullable: true,
|
|
2348
|
+
description: 'Invoice number. Null if the invoice has no number.',
|
|
2349
|
+
example: 'CF-0042'
|
|
2350
|
+
},
|
|
2351
|
+
amount: {
|
|
2352
|
+
type: 'number',
|
|
2353
|
+
format: 'float',
|
|
2354
|
+
description: 'Amount outstanding when the charge was attempted, in the smallest currency unit.',
|
|
2355
|
+
example: 4200
|
|
2356
|
+
},
|
|
2357
|
+
currency: {
|
|
2358
|
+
type: 'string',
|
|
2359
|
+
description: 'Currency of the invoice.',
|
|
2360
|
+
example: 'eur'
|
|
2361
|
+
},
|
|
2362
|
+
status: {
|
|
2363
|
+
type: 'string',
|
|
2364
|
+
description: 'Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).',
|
|
2365
|
+
example: 'paid',
|
|
2366
|
+
enum: [
|
|
2367
|
+
'paid',
|
|
2368
|
+
'processing',
|
|
2369
|
+
'requires_action',
|
|
2370
|
+
'failed'
|
|
2371
|
+
]
|
|
2372
|
+
},
|
|
2373
|
+
client_secret: {
|
|
2374
|
+
type: 'string',
|
|
2375
|
+
nullable: true,
|
|
2376
|
+
description: 'Client secret used to complete customer authentication. Set only when `status` is `requires_action`.',
|
|
2377
|
+
example: 'pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH'
|
|
2378
|
+
},
|
|
2379
|
+
failure_code: {
|
|
2380
|
+
type: 'string',
|
|
2381
|
+
nullable: true,
|
|
2382
|
+
description: 'Decline code. Set only when `status` is `failed`.',
|
|
2383
|
+
example: 'insufficient_funds'
|
|
2384
|
+
},
|
|
2385
|
+
failure_message: {
|
|
2386
|
+
type: 'string',
|
|
2387
|
+
nullable: true,
|
|
2388
|
+
description: 'Explanation of the decline, suitable for display. Set only when `status` is `failed`.',
|
|
2389
|
+
example: 'Your card has insufficient funds.'
|
|
2390
|
+
}
|
|
2391
|
+
},
|
|
2392
|
+
required: [
|
|
2393
|
+
'invoice_id',
|
|
2394
|
+
'number',
|
|
2395
|
+
'amount',
|
|
2396
|
+
'currency',
|
|
2397
|
+
'status',
|
|
2398
|
+
'client_secret',
|
|
2399
|
+
'failure_code',
|
|
2400
|
+
'failure_message'
|
|
2401
|
+
],
|
|
2402
|
+
additionalProperties: false
|
|
2403
|
+
};
|
|
2404
|
+
export const InvoicePaymentResultSchema = {
|
|
2405
|
+
type: 'object',
|
|
2406
|
+
properties: {
|
|
2407
|
+
code: {
|
|
2408
|
+
type: 'string',
|
|
2409
|
+
description: 'Overall outcome: `paid` (nothing outstanding), `processing` (all accepted, not yet settled), `action_required` (one or more await customer authentication), `partially_paid`, `failed`, `nothing_due`, or `bank_transfer_due` (the organization pays by bank transfer; nothing was charged).',
|
|
2410
|
+
example: 'partially_paid',
|
|
2411
|
+
enum: [
|
|
2412
|
+
'paid',
|
|
2413
|
+
'processing',
|
|
2414
|
+
'action_required',
|
|
2415
|
+
'partially_paid',
|
|
2416
|
+
'failed',
|
|
2417
|
+
'nothing_due',
|
|
2418
|
+
'bank_transfer_due'
|
|
2419
|
+
]
|
|
2420
|
+
},
|
|
2421
|
+
message: {
|
|
2422
|
+
type: 'string',
|
|
2423
|
+
description: 'Summary of the outcome, suitable for display.',
|
|
2424
|
+
example: '1 of 2 open invoices was paid. Invoice CF-0043 was declined: Your card has insufficient funds.'
|
|
2425
|
+
},
|
|
2426
|
+
results: {
|
|
2427
|
+
type: 'array',
|
|
2428
|
+
items: {
|
|
2429
|
+
type: 'object',
|
|
2430
|
+
properties: {
|
|
2431
|
+
invoice_id: {
|
|
2432
|
+
type: 'string',
|
|
2433
|
+
description: 'Identifier of the invoice.',
|
|
2434
|
+
example: 'in_1234567890xCrwxghOTj1234'
|
|
2435
|
+
},
|
|
2436
|
+
number: {
|
|
2437
|
+
type: 'string',
|
|
2438
|
+
description: 'Invoice number. Null if the invoice has no number.',
|
|
2439
|
+
example: 'CF-0042'
|
|
2440
|
+
},
|
|
2441
|
+
amount: {
|
|
2442
|
+
type: 'number',
|
|
2443
|
+
format: 'float',
|
|
2444
|
+
description: 'Amount outstanding when the charge was attempted, in the smallest currency unit.',
|
|
2445
|
+
example: 4200
|
|
2446
|
+
},
|
|
2447
|
+
currency: {
|
|
2448
|
+
type: 'string',
|
|
2449
|
+
description: 'Currency of the invoice.',
|
|
2450
|
+
example: 'eur'
|
|
2451
|
+
},
|
|
2452
|
+
status: {
|
|
2453
|
+
type: 'string',
|
|
2454
|
+
description: 'Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).',
|
|
2455
|
+
example: 'paid',
|
|
2456
|
+
enum: [
|
|
2457
|
+
'paid',
|
|
2458
|
+
'processing',
|
|
2459
|
+
'requires_action',
|
|
2460
|
+
'failed'
|
|
2461
|
+
]
|
|
2462
|
+
},
|
|
2463
|
+
client_secret: {
|
|
2464
|
+
type: 'string',
|
|
2465
|
+
description: 'Client secret used to complete customer authentication. Set only when `status` is `requires_action`.',
|
|
2466
|
+
example: 'pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH'
|
|
2467
|
+
},
|
|
2468
|
+
failure_code: {
|
|
2469
|
+
type: 'string',
|
|
2470
|
+
description: 'Decline code. Set only when `status` is `failed`.',
|
|
2471
|
+
example: 'insufficient_funds'
|
|
2472
|
+
},
|
|
2473
|
+
failure_message: {
|
|
2474
|
+
type: 'string',
|
|
2475
|
+
description: 'Explanation of the decline, suitable for display. Set only when `status` is `failed`.',
|
|
2476
|
+
example: 'Your card has insufficient funds.'
|
|
2477
|
+
}
|
|
2478
|
+
},
|
|
2479
|
+
required: [
|
|
2480
|
+
'invoice_id',
|
|
2481
|
+
'number',
|
|
2482
|
+
'amount',
|
|
2483
|
+
'currency',
|
|
2484
|
+
'status',
|
|
2485
|
+
'client_secret',
|
|
2486
|
+
'failure_code',
|
|
2487
|
+
'failure_message'
|
|
2488
|
+
],
|
|
2489
|
+
additionalProperties: false
|
|
2490
|
+
},
|
|
2491
|
+
description: 'One entry per invoice charged, oldest first.'
|
|
2492
|
+
}
|
|
2493
|
+
},
|
|
2494
|
+
required: [
|
|
2495
|
+
'code',
|
|
2496
|
+
'message',
|
|
2497
|
+
'results'
|
|
2498
|
+
],
|
|
2499
|
+
additionalProperties: false
|
|
2500
|
+
};
|
|
1006
2501
|
export const InvoiceSchema = {
|
|
1007
2502
|
type: 'object',
|
|
1008
2503
|
properties: {
|
|
@@ -1216,6 +2711,15 @@ export const MarketplaceListingSchema = {
|
|
|
1216
2711
|
export const OrganizationCreateInputSchema = {
|
|
1217
2712
|
type: 'object',
|
|
1218
2713
|
properties: {
|
|
2714
|
+
type: {
|
|
2715
|
+
type: 'string',
|
|
2716
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2717
|
+
example: 'business',
|
|
2718
|
+
enum: [
|
|
2719
|
+
'business',
|
|
2720
|
+
'personal'
|
|
2721
|
+
]
|
|
2722
|
+
},
|
|
1219
2723
|
email: {
|
|
1220
2724
|
type: 'string',
|
|
1221
2725
|
format: 'email',
|
|
@@ -1224,11 +2728,13 @@ export const OrganizationCreateInputSchema = {
|
|
|
1224
2728
|
},
|
|
1225
2729
|
first_name: {
|
|
1226
2730
|
type: 'string',
|
|
2731
|
+
minLength: 1,
|
|
1227
2732
|
description: 'First name of the billing contact person.',
|
|
1228
2733
|
example: 'John'
|
|
1229
2734
|
},
|
|
1230
2735
|
last_name: {
|
|
1231
2736
|
type: 'string',
|
|
2737
|
+
minLength: 1,
|
|
1232
2738
|
description: 'Last name of the billing contact person.',
|
|
1233
2739
|
example: 'Doe'
|
|
1234
2740
|
},
|
|
@@ -1242,16 +2748,31 @@ export const OrganizationCreateInputSchema = {
|
|
|
1242
2748
|
},
|
|
1243
2749
|
password: {
|
|
1244
2750
|
type: 'string',
|
|
1245
|
-
minLength: 8,
|
|
1246
|
-
description: 'Password for the root account. Must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one number and one special character.'
|
|
2751
|
+
minLength: 8,
|
|
2752
|
+
description: 'Password for the root account. Must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one number and one special character.'
|
|
2753
|
+
}
|
|
2754
|
+
},
|
|
2755
|
+
required: [
|
|
2756
|
+
'type',
|
|
2757
|
+
'email',
|
|
2758
|
+
'first_name',
|
|
2759
|
+
'last_name',
|
|
2760
|
+
'company_name',
|
|
2761
|
+
'password'
|
|
2762
|
+
],
|
|
2763
|
+
additionalProperties: false
|
|
2764
|
+
};
|
|
2765
|
+
export const OrganizationCreateOutputSchema = {
|
|
2766
|
+
type: 'object',
|
|
2767
|
+
properties: {
|
|
2768
|
+
id: {
|
|
2769
|
+
type: 'string',
|
|
2770
|
+
description: 'Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.',
|
|
2771
|
+
example: 'organization-id'
|
|
1247
2772
|
}
|
|
1248
2773
|
},
|
|
1249
2774
|
required: [
|
|
1250
|
-
'
|
|
1251
|
-
'first_name',
|
|
1252
|
-
'last_name',
|
|
1253
|
-
'company_name',
|
|
1254
|
-
'password'
|
|
2775
|
+
'id'
|
|
1255
2776
|
],
|
|
1256
2777
|
additionalProperties: false
|
|
1257
2778
|
};
|
|
@@ -1271,6 +2792,15 @@ export const OrganizationSchema = {
|
|
|
1271
2792
|
description: 'Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.',
|
|
1272
2793
|
example: 'ACME Corp.'
|
|
1273
2794
|
},
|
|
2795
|
+
type: {
|
|
2796
|
+
type: 'string',
|
|
2797
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2798
|
+
example: 'business',
|
|
2799
|
+
enum: [
|
|
2800
|
+
'business',
|
|
2801
|
+
'personal'
|
|
2802
|
+
]
|
|
2803
|
+
},
|
|
1274
2804
|
date_created: {
|
|
1275
2805
|
type: 'string',
|
|
1276
2806
|
format: 'date-time',
|
|
@@ -1302,6 +2832,17 @@ export const OrganizationSchema = {
|
|
|
1302
2832
|
description: 'Available number of Pro clusters that can be created.',
|
|
1303
2833
|
example: 999
|
|
1304
2834
|
},
|
|
2835
|
+
enterprise_clusters_max: {
|
|
2836
|
+
type: 'integer',
|
|
2837
|
+
minimum: 0,
|
|
2838
|
+
description: 'Maximum number of Enterprise clusters that can be created.',
|
|
2839
|
+
example: 999
|
|
2840
|
+
},
|
|
2841
|
+
enterprise_clusters_available: {
|
|
2842
|
+
type: 'integer',
|
|
2843
|
+
description: 'Available number of Enterprise clusters that can be created.',
|
|
2844
|
+
example: 999
|
|
2845
|
+
},
|
|
1305
2846
|
fleets_max: {
|
|
1306
2847
|
type: 'integer',
|
|
1307
2848
|
minimum: 0,
|
|
@@ -1321,7 +2862,7 @@ export const OrganizationSchema = {
|
|
|
1321
2862
|
type: 'array',
|
|
1322
2863
|
items: {
|
|
1323
2864
|
type: 'string',
|
|
1324
|
-
example: 'northamerica-central-
|
|
2865
|
+
example: 'northamerica-central-1a'
|
|
1325
2866
|
},
|
|
1326
2867
|
minItems: 1,
|
|
1327
2868
|
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
@@ -1363,6 +2904,8 @@ export const OrganizationSchema = {
|
|
|
1363
2904
|
'basic_clusters_available',
|
|
1364
2905
|
'pro_clusters_max',
|
|
1365
2906
|
'pro_clusters_available',
|
|
2907
|
+
'enterprise_clusters_max',
|
|
2908
|
+
'enterprise_clusters_available',
|
|
1366
2909
|
'fleets_max',
|
|
1367
2910
|
'cluster_tiers',
|
|
1368
2911
|
'regions',
|
|
@@ -1380,13 +2923,25 @@ export const OrganizationSchema = {
|
|
|
1380
2923
|
'closed',
|
|
1381
2924
|
'suspended'
|
|
1382
2925
|
]
|
|
2926
|
+
},
|
|
2927
|
+
verification: {
|
|
2928
|
+
type: 'string',
|
|
2929
|
+
description: 'Verification status of the organization, which determines the assigned quota. `none` when billing information is incomplete, `submitted` when billing information is complete but the organization is not yet verified, `verified` when the organization is verified.',
|
|
2930
|
+
example: 'verified',
|
|
2931
|
+
enum: [
|
|
2932
|
+
'none',
|
|
2933
|
+
'submitted',
|
|
2934
|
+
'verified'
|
|
2935
|
+
]
|
|
1383
2936
|
}
|
|
1384
2937
|
},
|
|
1385
2938
|
required: [
|
|
1386
2939
|
'id',
|
|
2940
|
+
'type',
|
|
1387
2941
|
'date_created',
|
|
1388
2942
|
'quota',
|
|
1389
|
-
'status'
|
|
2943
|
+
'status',
|
|
2944
|
+
'verification'
|
|
1390
2945
|
],
|
|
1391
2946
|
additionalProperties: false
|
|
1392
2947
|
};
|
|
@@ -1395,28 +2950,23 @@ export const PaymentMethodSchema = {
|
|
|
1395
2950
|
properties: {
|
|
1396
2951
|
id: {
|
|
1397
2952
|
type: 'string',
|
|
1398
|
-
|
|
1399
|
-
|
|
1400
|
-
example: 'e94d30ec-a2dd-4dcb-832c-ac2be144ba91'
|
|
1401
|
-
},
|
|
1402
|
-
setup: {
|
|
1403
|
-
type: 'boolean',
|
|
1404
|
-
description: 'Whether organization payment method was set up and ready to use for payments.',
|
|
1405
|
-
example: true
|
|
2953
|
+
description: 'Payment method identifier. Stripe payment method id for cards/SEPA; the constant `bank_transfer` for the invoice/bank-transfer method. Used to set as default or delete the payment method.',
|
|
2954
|
+
example: 'pm_1MtwBwLkdIwHu7ix28a3tqPa'
|
|
1406
2955
|
},
|
|
1407
2956
|
type: {
|
|
1408
2957
|
type: 'string',
|
|
1409
|
-
|
|
1410
|
-
description: 'Payment method type type. Only `card` payments supported at the moment.',
|
|
2958
|
+
description: 'Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.',
|
|
1411
2959
|
example: 'card',
|
|
1412
2960
|
enum: [
|
|
1413
|
-
'card'
|
|
2961
|
+
'card',
|
|
2962
|
+
'sepa_debit',
|
|
2963
|
+
'bank_transfer'
|
|
1414
2964
|
]
|
|
1415
2965
|
},
|
|
1416
2966
|
last4: {
|
|
1417
2967
|
type: 'string',
|
|
1418
2968
|
nullable: true,
|
|
1419
|
-
description: 'Last 4 digits of the payment card number.',
|
|
2969
|
+
description: 'Last 4 digits of the payment card number, of the bank account (IBAN) for SEPA Direct Debit, or of the destination IBAN for bank transfer.',
|
|
1420
2970
|
example: '4242'
|
|
1421
2971
|
},
|
|
1422
2972
|
exp_month: {
|
|
@@ -1424,42 +2974,56 @@ export const PaymentMethodSchema = {
|
|
|
1424
2974
|
minimum: 1,
|
|
1425
2975
|
maximum: 12,
|
|
1426
2976
|
nullable: true,
|
|
1427
|
-
description: 'Two-digit number representing the card\'s expiration month.',
|
|
1428
|
-
example:
|
|
2977
|
+
description: 'Two-digit number representing the card\'s expiration month. Null for SEPA Direct Debit and bank transfer.',
|
|
2978
|
+
example: 12
|
|
1429
2979
|
},
|
|
1430
2980
|
exp_year: {
|
|
1431
2981
|
type: 'integer',
|
|
1432
|
-
minimum: 2024,
|
|
1433
2982
|
nullable: true,
|
|
1434
|
-
description: 'Four-digit number representing the card\'s expiration year.',
|
|
1435
|
-
example:
|
|
2983
|
+
description: 'Four-digit number representing the card\'s expiration year. May be in the past for an expired card still on file. Null for SEPA Direct Debit and bank transfer.',
|
|
2984
|
+
example: 2028
|
|
1436
2985
|
},
|
|
1437
2986
|
brand: {
|
|
1438
2987
|
type: 'string',
|
|
1439
2988
|
nullable: true,
|
|
1440
|
-
description: 'Payment card brand
|
|
1441
|
-
example: 'visa'
|
|
1442
|
-
|
|
1443
|
-
|
|
1444
|
-
|
|
1445
|
-
|
|
1446
|
-
|
|
1447
|
-
|
|
1448
|
-
|
|
1449
|
-
|
|
1450
|
-
|
|
1451
|
-
|
|
1452
|
-
|
|
2989
|
+
description: 'Payment card brand as reported by Stripe, e.g. `visa`, `mastercard`, `amex`, `cartes_bancaires`, or `unknown`. Null for SEPA Direct Debit and bank transfer.',
|
|
2990
|
+
example: 'visa'
|
|
2991
|
+
},
|
|
2992
|
+
iban: {
|
|
2993
|
+
type: 'string',
|
|
2994
|
+
nullable: true,
|
|
2995
|
+
description: 'Full destination IBAN to send bank transfers to. Set only for `bank_transfer`; null otherwise. This is Cloudfleet\'s virtual receiving account, shown in full so the customer can pay into it.',
|
|
2996
|
+
example: 'DE11243015658023127510'
|
|
2997
|
+
},
|
|
2998
|
+
bic: {
|
|
2999
|
+
type: 'string',
|
|
3000
|
+
nullable: true,
|
|
3001
|
+
description: 'BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
3002
|
+
example: 'SOGEDEFFXXX'
|
|
3003
|
+
},
|
|
3004
|
+
account_holder_name: {
|
|
3005
|
+
type: 'string',
|
|
3006
|
+
nullable: true,
|
|
3007
|
+
description: 'Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
3008
|
+
example: 'Cloudfleet GmbH'
|
|
3009
|
+
},
|
|
3010
|
+
is_default: {
|
|
3011
|
+
type: 'boolean',
|
|
3012
|
+
description: 'Whether this payment method is the default used for invoices and active subscriptions. Always false for `bank_transfer` (it cannot be a Stripe default payment method).',
|
|
3013
|
+
example: true
|
|
1453
3014
|
}
|
|
1454
3015
|
},
|
|
1455
3016
|
required: [
|
|
1456
3017
|
'id',
|
|
1457
|
-
'setup',
|
|
1458
3018
|
'type',
|
|
1459
3019
|
'last4',
|
|
1460
3020
|
'exp_month',
|
|
1461
3021
|
'exp_year',
|
|
1462
|
-
'brand'
|
|
3022
|
+
'brand',
|
|
3023
|
+
'iban',
|
|
3024
|
+
'bic',
|
|
3025
|
+
'account_holder_name',
|
|
3026
|
+
'is_default'
|
|
1463
3027
|
],
|
|
1464
3028
|
additionalProperties: false
|
|
1465
3029
|
};
|
|
@@ -1488,6 +3052,17 @@ export const PlatformQuotaSchema = {
|
|
|
1488
3052
|
description: 'Available number of Pro clusters that can be created.',
|
|
1489
3053
|
example: 999
|
|
1490
3054
|
},
|
|
3055
|
+
enterprise_clusters_max: {
|
|
3056
|
+
type: 'integer',
|
|
3057
|
+
minimum: 0,
|
|
3058
|
+
description: 'Maximum number of Enterprise clusters that can be created.',
|
|
3059
|
+
example: 999
|
|
3060
|
+
},
|
|
3061
|
+
enterprise_clusters_available: {
|
|
3062
|
+
type: 'integer',
|
|
3063
|
+
description: 'Available number of Enterprise clusters that can be created.',
|
|
3064
|
+
example: 999
|
|
3065
|
+
},
|
|
1491
3066
|
fleets_max: {
|
|
1492
3067
|
type: 'integer',
|
|
1493
3068
|
minimum: 0,
|
|
@@ -1507,7 +3082,7 @@ export const PlatformQuotaSchema = {
|
|
|
1507
3082
|
type: 'array',
|
|
1508
3083
|
items: {
|
|
1509
3084
|
type: 'string',
|
|
1510
|
-
example: 'northamerica-central-
|
|
3085
|
+
example: 'northamerica-central-1a'
|
|
1511
3086
|
},
|
|
1512
3087
|
minItems: 1,
|
|
1513
3088
|
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
@@ -1549,6 +3124,8 @@ export const PlatformQuotaSchema = {
|
|
|
1549
3124
|
'basic_clusters_available',
|
|
1550
3125
|
'pro_clusters_max',
|
|
1551
3126
|
'pro_clusters_available',
|
|
3127
|
+
'enterprise_clusters_max',
|
|
3128
|
+
'enterprise_clusters_available',
|
|
1552
3129
|
'fleets_max',
|
|
1553
3130
|
'cluster_tiers',
|
|
1554
3131
|
'regions',
|
|
@@ -1822,6 +3399,329 @@ export const RegistryTagSchema = {
|
|
|
1822
3399
|
],
|
|
1823
3400
|
additionalProperties: false
|
|
1824
3401
|
};
|
|
3402
|
+
export const TicketAttachmentSchema = {
|
|
3403
|
+
type: 'object',
|
|
3404
|
+
properties: {
|
|
3405
|
+
id: {
|
|
3406
|
+
type: 'string',
|
|
3407
|
+
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
3408
|
+
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
3409
|
+
},
|
|
3410
|
+
filename: {
|
|
3411
|
+
type: 'string',
|
|
3412
|
+
description: 'Original filename as uploaded.',
|
|
3413
|
+
example: 'debug.log'
|
|
3414
|
+
},
|
|
3415
|
+
content_type: {
|
|
3416
|
+
type: 'string',
|
|
3417
|
+
description: 'MIME content type of the attachment.',
|
|
3418
|
+
example: 'text/plain'
|
|
3419
|
+
},
|
|
3420
|
+
size: {
|
|
3421
|
+
type: 'integer',
|
|
3422
|
+
description: 'Size of the attachment in bytes.',
|
|
3423
|
+
example: 12345
|
|
3424
|
+
}
|
|
3425
|
+
},
|
|
3426
|
+
required: [
|
|
3427
|
+
'id',
|
|
3428
|
+
'filename',
|
|
3429
|
+
'content_type',
|
|
3430
|
+
'size'
|
|
3431
|
+
],
|
|
3432
|
+
additionalProperties: false
|
|
3433
|
+
};
|
|
3434
|
+
export const TicketCreateInputSchema = {
|
|
3435
|
+
type: 'object',
|
|
3436
|
+
properties: {
|
|
3437
|
+
category: {
|
|
3438
|
+
type: 'string',
|
|
3439
|
+
description: 'Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.',
|
|
3440
|
+
example: 'technical',
|
|
3441
|
+
enum: [
|
|
3442
|
+
'billing',
|
|
3443
|
+
'technical',
|
|
3444
|
+
'general'
|
|
3445
|
+
]
|
|
3446
|
+
},
|
|
3447
|
+
body: {
|
|
3448
|
+
type: 'string',
|
|
3449
|
+
maxLength: 50000,
|
|
3450
|
+
minLength: 1,
|
|
3451
|
+
pattern: '\\S',
|
|
3452
|
+
description: 'Initial message body in markdown. There is no separate subject — the first message body is the description.',
|
|
3453
|
+
example: 'My cluster cannot reach the registry. Logs attached.'
|
|
3454
|
+
},
|
|
3455
|
+
properties: {
|
|
3456
|
+
type: 'object',
|
|
3457
|
+
additionalProperties: true,
|
|
3458
|
+
description: 'Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).',
|
|
3459
|
+
example: {
|
|
3460
|
+
subcategory: 'cluster-question',
|
|
3461
|
+
cluster_id: '60c72b2f9f1b2c001f8e4d3a'
|
|
3462
|
+
}
|
|
3463
|
+
}
|
|
3464
|
+
},
|
|
3465
|
+
required: [
|
|
3466
|
+
'category',
|
|
3467
|
+
'body'
|
|
3468
|
+
],
|
|
3469
|
+
additionalProperties: false
|
|
3470
|
+
};
|
|
3471
|
+
export const TicketMessageInputSchema = {
|
|
3472
|
+
type: 'object',
|
|
3473
|
+
properties: {
|
|
3474
|
+
body: {
|
|
3475
|
+
type: 'string',
|
|
3476
|
+
maxLength: 50000,
|
|
3477
|
+
minLength: 1,
|
|
3478
|
+
pattern: '\\S',
|
|
3479
|
+
description: 'Reply body in markdown.',
|
|
3480
|
+
example: 'Thanks — that resolved it on my side.'
|
|
3481
|
+
}
|
|
3482
|
+
},
|
|
3483
|
+
required: [
|
|
3484
|
+
'body'
|
|
3485
|
+
],
|
|
3486
|
+
additionalProperties: false
|
|
3487
|
+
};
|
|
3488
|
+
export const TicketMessageSchema = {
|
|
3489
|
+
type: 'object',
|
|
3490
|
+
properties: {
|
|
3491
|
+
id: {
|
|
3492
|
+
type: 'string',
|
|
3493
|
+
description: 'Unique identifier of the message (Mongo ObjectId).',
|
|
3494
|
+
example: '60c72b2f9f1b2c001f8e4d3b'
|
|
3495
|
+
},
|
|
3496
|
+
type: {
|
|
3497
|
+
type: 'string',
|
|
3498
|
+
description: 'Message type. Internal notes are filtered out of customer-facing responses.',
|
|
3499
|
+
example: 'customer_reply',
|
|
3500
|
+
enum: [
|
|
3501
|
+
'customer_reply',
|
|
3502
|
+
'agent_reply'
|
|
3503
|
+
]
|
|
3504
|
+
},
|
|
3505
|
+
body: {
|
|
3506
|
+
type: 'string',
|
|
3507
|
+
description: 'Message body in markdown.',
|
|
3508
|
+
example: 'Thanks — that resolved it on my side.'
|
|
3509
|
+
},
|
|
3510
|
+
author_first_name: {
|
|
3511
|
+
type: 'string',
|
|
3512
|
+
nullable: true,
|
|
3513
|
+
description: 'First name of the author. Null when not provided.',
|
|
3514
|
+
example: 'Jane'
|
|
3515
|
+
},
|
|
3516
|
+
author_last_name: {
|
|
3517
|
+
type: 'string',
|
|
3518
|
+
nullable: true,
|
|
3519
|
+
description: 'Last name of the author. Null when not provided.',
|
|
3520
|
+
example: 'Doe'
|
|
3521
|
+
},
|
|
3522
|
+
attachments: {
|
|
3523
|
+
type: 'array',
|
|
3524
|
+
items: {
|
|
3525
|
+
type: 'object',
|
|
3526
|
+
properties: {
|
|
3527
|
+
id: {
|
|
3528
|
+
type: 'string',
|
|
3529
|
+
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
3530
|
+
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
3531
|
+
},
|
|
3532
|
+
filename: {
|
|
3533
|
+
type: 'string',
|
|
3534
|
+
description: 'Original filename as uploaded.',
|
|
3535
|
+
example: 'debug.log'
|
|
3536
|
+
},
|
|
3537
|
+
content_type: {
|
|
3538
|
+
type: 'string',
|
|
3539
|
+
description: 'MIME content type of the attachment.',
|
|
3540
|
+
example: 'text/plain'
|
|
3541
|
+
},
|
|
3542
|
+
size: {
|
|
3543
|
+
type: 'integer',
|
|
3544
|
+
description: 'Size of the attachment in bytes.',
|
|
3545
|
+
example: 12345
|
|
3546
|
+
}
|
|
3547
|
+
},
|
|
3548
|
+
required: [
|
|
3549
|
+
'id',
|
|
3550
|
+
'filename',
|
|
3551
|
+
'content_type',
|
|
3552
|
+
'size'
|
|
3553
|
+
],
|
|
3554
|
+
additionalProperties: false
|
|
3555
|
+
},
|
|
3556
|
+
description: 'Attachments associated with this message.',
|
|
3557
|
+
example: []
|
|
3558
|
+
},
|
|
3559
|
+
date_created: {
|
|
3560
|
+
type: 'string',
|
|
3561
|
+
format: 'date-time',
|
|
3562
|
+
description: 'Creation date of the message. ISO 8601 UTC.',
|
|
3563
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
3564
|
+
}
|
|
3565
|
+
},
|
|
3566
|
+
required: [
|
|
3567
|
+
'id',
|
|
3568
|
+
'type',
|
|
3569
|
+
'body',
|
|
3570
|
+
'date_created'
|
|
3571
|
+
],
|
|
3572
|
+
additionalProperties: false
|
|
3573
|
+
};
|
|
3574
|
+
export const TicketSchema = {
|
|
3575
|
+
type: 'object',
|
|
3576
|
+
properties: {
|
|
3577
|
+
id: {
|
|
3578
|
+
type: 'string',
|
|
3579
|
+
description: 'Unique identifier of the ticket (Mongo ObjectId).',
|
|
3580
|
+
example: '60c72b2f9f1b2c001f8e4d3a'
|
|
3581
|
+
},
|
|
3582
|
+
status: {
|
|
3583
|
+
type: 'string',
|
|
3584
|
+
description: 'Current state of the ticket.',
|
|
3585
|
+
example: 'waiting_on_us',
|
|
3586
|
+
enum: [
|
|
3587
|
+
'waiting_on_us',
|
|
3588
|
+
'waiting_on_user',
|
|
3589
|
+
'closed'
|
|
3590
|
+
]
|
|
3591
|
+
},
|
|
3592
|
+
category: {
|
|
3593
|
+
type: 'string',
|
|
3594
|
+
description: 'Ticket category.',
|
|
3595
|
+
example: 'technical',
|
|
3596
|
+
enum: [
|
|
3597
|
+
'billing',
|
|
3598
|
+
'technical',
|
|
3599
|
+
'general'
|
|
3600
|
+
]
|
|
3601
|
+
},
|
|
3602
|
+
summary: {
|
|
3603
|
+
type: 'string',
|
|
3604
|
+
description: 'First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.',
|
|
3605
|
+
example: 'My cluster cannot reach the registry. Logs attached.'
|
|
3606
|
+
},
|
|
3607
|
+
closed_at: {
|
|
3608
|
+
type: 'string',
|
|
3609
|
+
format: 'date-time',
|
|
3610
|
+
nullable: true,
|
|
3611
|
+
description: 'Closure timestamp. Null while the ticket is open.',
|
|
3612
|
+
example: '2026-05-18T16:08:14.338Z'
|
|
3613
|
+
},
|
|
3614
|
+
date_created: {
|
|
3615
|
+
type: 'string',
|
|
3616
|
+
format: 'date-time',
|
|
3617
|
+
description: 'Creation date of the ticket. ISO 8601 UTC.',
|
|
3618
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
3619
|
+
},
|
|
3620
|
+
date_updated: {
|
|
3621
|
+
type: 'string',
|
|
3622
|
+
format: 'date-time',
|
|
3623
|
+
description: 'Last update date of the ticket. ISO 8601 UTC.',
|
|
3624
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
3625
|
+
},
|
|
3626
|
+
messages: {
|
|
3627
|
+
type: 'array',
|
|
3628
|
+
items: {
|
|
3629
|
+
type: 'object',
|
|
3630
|
+
properties: {
|
|
3631
|
+
id: {
|
|
3632
|
+
type: 'string',
|
|
3633
|
+
description: 'Unique identifier of the message (Mongo ObjectId).',
|
|
3634
|
+
example: '60c72b2f9f1b2c001f8e4d3b'
|
|
3635
|
+
},
|
|
3636
|
+
type: {
|
|
3637
|
+
type: 'string',
|
|
3638
|
+
description: 'Message type. Internal notes are filtered out of customer-facing responses.',
|
|
3639
|
+
example: 'customer_reply',
|
|
3640
|
+
enum: [
|
|
3641
|
+
'customer_reply',
|
|
3642
|
+
'agent_reply'
|
|
3643
|
+
]
|
|
3644
|
+
},
|
|
3645
|
+
body: {
|
|
3646
|
+
type: 'string',
|
|
3647
|
+
description: 'Message body in markdown.',
|
|
3648
|
+
example: 'Thanks — that resolved it on my side.'
|
|
3649
|
+
},
|
|
3650
|
+
author_first_name: {
|
|
3651
|
+
type: 'string',
|
|
3652
|
+
description: 'First name of the author. Null when not provided.',
|
|
3653
|
+
example: 'Jane'
|
|
3654
|
+
},
|
|
3655
|
+
author_last_name: {
|
|
3656
|
+
type: 'string',
|
|
3657
|
+
description: 'Last name of the author. Null when not provided.',
|
|
3658
|
+
example: 'Doe'
|
|
3659
|
+
},
|
|
3660
|
+
attachments: {
|
|
3661
|
+
type: 'array',
|
|
3662
|
+
items: {
|
|
3663
|
+
type: 'object',
|
|
3664
|
+
properties: {
|
|
3665
|
+
id: {
|
|
3666
|
+
type: 'string',
|
|
3667
|
+
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
3668
|
+
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
3669
|
+
},
|
|
3670
|
+
filename: {
|
|
3671
|
+
type: 'string',
|
|
3672
|
+
description: 'Original filename as uploaded.',
|
|
3673
|
+
example: 'debug.log'
|
|
3674
|
+
},
|
|
3675
|
+
content_type: {
|
|
3676
|
+
type: 'string',
|
|
3677
|
+
description: 'MIME content type of the attachment.',
|
|
3678
|
+
example: 'text/plain'
|
|
3679
|
+
},
|
|
3680
|
+
size: {
|
|
3681
|
+
type: 'integer',
|
|
3682
|
+
description: 'Size of the attachment in bytes.',
|
|
3683
|
+
example: 12345
|
|
3684
|
+
}
|
|
3685
|
+
},
|
|
3686
|
+
required: [
|
|
3687
|
+
'id',
|
|
3688
|
+
'filename',
|
|
3689
|
+
'content_type',
|
|
3690
|
+
'size'
|
|
3691
|
+
],
|
|
3692
|
+
additionalProperties: false
|
|
3693
|
+
},
|
|
3694
|
+
description: 'Attachments associated with this message.',
|
|
3695
|
+
example: []
|
|
3696
|
+
},
|
|
3697
|
+
date_created: {
|
|
3698
|
+
type: 'string',
|
|
3699
|
+
format: 'date-time',
|
|
3700
|
+
description: 'Creation date of the message. ISO 8601 UTC.',
|
|
3701
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
3702
|
+
}
|
|
3703
|
+
},
|
|
3704
|
+
required: [
|
|
3705
|
+
'id',
|
|
3706
|
+
'type',
|
|
3707
|
+
'body',
|
|
3708
|
+
'date_created'
|
|
3709
|
+
],
|
|
3710
|
+
additionalProperties: false
|
|
3711
|
+
},
|
|
3712
|
+
description: 'Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.'
|
|
3713
|
+
}
|
|
3714
|
+
},
|
|
3715
|
+
required: [
|
|
3716
|
+
'id',
|
|
3717
|
+
'status',
|
|
3718
|
+
'category',
|
|
3719
|
+
'summary',
|
|
3720
|
+
'date_created',
|
|
3721
|
+
'date_updated'
|
|
3722
|
+
],
|
|
3723
|
+
additionalProperties: false
|
|
3724
|
+
};
|
|
1825
3725
|
export const TokenCreateInputSchema = {
|
|
1826
3726
|
type: 'object',
|
|
1827
3727
|
properties: {
|
|
@@ -1932,12 +3832,21 @@ export const UsageFacetsSchema = {
|
|
|
1932
3832
|
product: {
|
|
1933
3833
|
type: 'array',
|
|
1934
3834
|
items: {
|
|
1935
|
-
type: 'string'
|
|
3835
|
+
type: 'string',
|
|
3836
|
+
enum: [
|
|
3837
|
+
'cfke_controlplane_basic',
|
|
3838
|
+
'cfke_controlplane_pro',
|
|
3839
|
+
'cfke_controlplane_enterprise',
|
|
3840
|
+
'cfke_connected_nodes_basic',
|
|
3841
|
+
'cfke_connected_nodes_pro',
|
|
3842
|
+
'cfke_connected_nodes_enterprise',
|
|
3843
|
+
'cfcr_storage'
|
|
3844
|
+
]
|
|
1936
3845
|
},
|
|
1937
3846
|
description: 'List of unique products',
|
|
1938
3847
|
example: [
|
|
1939
|
-
'
|
|
1940
|
-
'
|
|
3848
|
+
'cfke_controlplane_pro',
|
|
3849
|
+
'cfke_connected_nodes_pro'
|
|
1941
3850
|
]
|
|
1942
3851
|
}
|
|
1943
3852
|
},
|
|
@@ -1964,7 +3873,16 @@ export const UsageResponseSchema = {
|
|
|
1964
3873
|
product: {
|
|
1965
3874
|
type: 'string',
|
|
1966
3875
|
description: 'The product the usage is associated with',
|
|
1967
|
-
example: '
|
|
3876
|
+
example: 'cfke_controlplane_pro',
|
|
3877
|
+
enum: [
|
|
3878
|
+
'cfke_controlplane_basic',
|
|
3879
|
+
'cfke_controlplane_pro',
|
|
3880
|
+
'cfke_controlplane_enterprise',
|
|
3881
|
+
'cfke_connected_nodes_basic',
|
|
3882
|
+
'cfke_connected_nodes_pro',
|
|
3883
|
+
'cfke_connected_nodes_enterprise',
|
|
3884
|
+
'cfcr_storage'
|
|
3885
|
+
]
|
|
1968
3886
|
},
|
|
1969
3887
|
value: {
|
|
1970
3888
|
type: 'number',
|
|
@@ -2012,12 +3930,21 @@ export const UsageResponseSchema = {
|
|
|
2012
3930
|
product: {
|
|
2013
3931
|
type: 'array',
|
|
2014
3932
|
items: {
|
|
2015
|
-
type: 'string'
|
|
3933
|
+
type: 'string',
|
|
3934
|
+
enum: [
|
|
3935
|
+
'cfke_controlplane_basic',
|
|
3936
|
+
'cfke_controlplane_pro',
|
|
3937
|
+
'cfke_controlplane_enterprise',
|
|
3938
|
+
'cfke_connected_nodes_basic',
|
|
3939
|
+
'cfke_connected_nodes_pro',
|
|
3940
|
+
'cfke_connected_nodes_enterprise',
|
|
3941
|
+
'cfcr_storage'
|
|
3942
|
+
]
|
|
2016
3943
|
},
|
|
2017
3944
|
description: 'List of unique products',
|
|
2018
3945
|
example: [
|
|
2019
|
-
'
|
|
2020
|
-
'
|
|
3946
|
+
'cfke_controlplane_pro',
|
|
3947
|
+
'cfke_connected_nodes_pro'
|
|
2021
3948
|
]
|
|
2022
3949
|
}
|
|
2023
3950
|
},
|
|
@@ -2047,7 +3974,16 @@ export const UsageSchema = {
|
|
|
2047
3974
|
product: {
|
|
2048
3975
|
type: 'string',
|
|
2049
3976
|
description: 'The product the usage is associated with',
|
|
2050
|
-
example: '
|
|
3977
|
+
example: 'cfke_controlplane_pro',
|
|
3978
|
+
enum: [
|
|
3979
|
+
'cfke_controlplane_basic',
|
|
3980
|
+
'cfke_controlplane_pro',
|
|
3981
|
+
'cfke_controlplane_enterprise',
|
|
3982
|
+
'cfke_connected_nodes_basic',
|
|
3983
|
+
'cfke_connected_nodes_pro',
|
|
3984
|
+
'cfke_connected_nodes_enterprise',
|
|
3985
|
+
'cfcr_storage'
|
|
3986
|
+
]
|
|
2051
3987
|
},
|
|
2052
3988
|
value: {
|
|
2053
3989
|
type: 'number',
|
|
@@ -2110,24 +4046,6 @@ export const UserCreateInputSchema = {
|
|
|
2110
4046
|
type: 'string',
|
|
2111
4047
|
minLength: 8,
|
|
2112
4048
|
description: 'User password. Must be at least 8 characters long.'
|
|
2113
|
-
},
|
|
2114
|
-
status: {
|
|
2115
|
-
type: 'string',
|
|
2116
|
-
description: 'Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.',
|
|
2117
|
-
example: 'active',
|
|
2118
|
-
enum: [
|
|
2119
|
-
'active',
|
|
2120
|
-
'inactive'
|
|
2121
|
-
]
|
|
2122
|
-
},
|
|
2123
|
-
role: {
|
|
2124
|
-
type: 'string',
|
|
2125
|
-
description: 'User role. Can be \'Administrator\', \'User\'.',
|
|
2126
|
-
example: 'User',
|
|
2127
|
-
enum: [
|
|
2128
|
-
'Administrator',
|
|
2129
|
-
'User'
|
|
2130
|
-
]
|
|
2131
4049
|
}
|
|
2132
4050
|
},
|
|
2133
4051
|
required: [
|