@cloudfleet/sdk 0.0.1-8ec217c → 0.0.1-8fe30fc
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -2
- package/dist/@tanstack/react-query.gen.d.ts +1061 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1234 -0
- package/dist/@tanstack/react-query.gen.js.map +1 -0
- package/dist/client/client.gen.d.ts.map +1 -1
- package/dist/client/client.gen.js +109 -127
- package/dist/client/client.gen.js.map +1 -1
- package/dist/client/types.gen.d.ts +7 -4
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.d.ts +7 -3
- package/dist/client/utils.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.js +4 -4
- package/dist/client/utils.gen.js.map +1 -1
- package/dist/client.gen.d.ts +1 -1
- package/dist/client.gen.d.ts.map +1 -1
- package/dist/core/bodySerializer.gen.d.ts +4 -4
- package/dist/core/bodySerializer.gen.d.ts.map +1 -1
- package/dist/core/bodySerializer.gen.js.map +1 -1
- package/dist/core/params.gen.js +4 -4
- package/dist/core/params.gen.js.map +1 -1
- package/dist/core/serverSentEvents.gen.d.ts +1 -1
- package/dist/core/serverSentEvents.gen.d.ts.map +1 -1
- package/dist/core/serverSentEvents.gen.js +3 -4
- package/dist/core/serverSentEvents.gen.js.map +1 -1
- package/dist/core/types.gen.d.ts +1 -1
- package/dist/core/utils.gen.js +1 -1
- package/dist/core/utils.gen.js.map +1 -1
- package/dist/schemas.gen.d.ts +1068 -147
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +2037 -213
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +270 -187
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +386 -257
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +8 -8
- package/dist/types.gen.d.ts +1572 -723
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3511 -1432
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1330 -498
- package/dist/zod.gen.js.map +1 -1
- package/package.json +28 -12
package/dist/schemas.gen.js
CHANGED
|
@@ -1,7 +1,65 @@
|
|
|
1
1
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
|
+
export const BasicPriceConsentInputSchema = {
|
|
3
|
+
type: 'object',
|
|
4
|
+
properties: {
|
|
5
|
+
decision: {
|
|
6
|
+
type: 'string',
|
|
7
|
+
description: 'The administrator\'s decision on the new Basic price. `accepted` continues to paid billing when the signup credit runs out; `rejected` opts out (clusters are suspended, never charged). A `rejected` org can later be flipped back to `accepted`.',
|
|
8
|
+
example: 'accepted',
|
|
9
|
+
enum: [
|
|
10
|
+
'accepted',
|
|
11
|
+
'rejected'
|
|
12
|
+
]
|
|
13
|
+
}
|
|
14
|
+
},
|
|
15
|
+
required: [
|
|
16
|
+
'decision'
|
|
17
|
+
],
|
|
18
|
+
additionalProperties: false
|
|
19
|
+
};
|
|
20
|
+
export const BasicPriceConsentSchema = {
|
|
21
|
+
type: 'object',
|
|
22
|
+
properties: {
|
|
23
|
+
status: {
|
|
24
|
+
type: 'string',
|
|
25
|
+
description: 'Consent status for the new Basic price. `not_applicable` when the organization is not in scope for the migration. `pending` when the organization must opt in but no admin has decided yet. `accepted` / `rejected` reflect the recorded decision.',
|
|
26
|
+
example: 'pending',
|
|
27
|
+
enum: [
|
|
28
|
+
'not_applicable',
|
|
29
|
+
'pending',
|
|
30
|
+
'accepted',
|
|
31
|
+
'rejected'
|
|
32
|
+
]
|
|
33
|
+
},
|
|
34
|
+
decided_at: {
|
|
35
|
+
type: 'string',
|
|
36
|
+
format: 'date-time',
|
|
37
|
+
description: 'When the current decision was recorded. Absent while `not_applicable` or `pending`.',
|
|
38
|
+
example: '2026-09-05T10:12:00.000Z'
|
|
39
|
+
},
|
|
40
|
+
decided_by: {
|
|
41
|
+
type: 'string',
|
|
42
|
+
description: 'User id of the administrator who recorded the current decision. Absent while `not_applicable` or `pending`.',
|
|
43
|
+
example: '2b7a5c9e-1f4d-4a1b-9c3e-8d2f6a0b1c2d'
|
|
44
|
+
}
|
|
45
|
+
},
|
|
46
|
+
required: [
|
|
47
|
+
'status'
|
|
48
|
+
],
|
|
49
|
+
additionalProperties: false
|
|
50
|
+
};
|
|
2
51
|
export const BillingContactSchema = {
|
|
3
52
|
type: 'object',
|
|
4
53
|
properties: {
|
|
54
|
+
type: {
|
|
55
|
+
type: 'string',
|
|
56
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
57
|
+
example: 'business',
|
|
58
|
+
enum: [
|
|
59
|
+
'business',
|
|
60
|
+
'personal'
|
|
61
|
+
]
|
|
62
|
+
},
|
|
5
63
|
company: {
|
|
6
64
|
type: 'string',
|
|
7
65
|
maxLength: 120,
|
|
@@ -207,6 +265,7 @@ export const BillingContactSchema = {
|
|
|
207
265
|
}
|
|
208
266
|
},
|
|
209
267
|
required: [
|
|
268
|
+
'type',
|
|
210
269
|
'email',
|
|
211
270
|
'individual_name'
|
|
212
271
|
],
|
|
@@ -358,24 +417,8 @@ export const ChartSchema = {
|
|
|
358
417
|
},
|
|
359
418
|
status: {
|
|
360
419
|
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
|
-
]
|
|
420
|
+
description: 'Status of the chart deployment (Flux HelmRelease Ready condition reason, e.g. InstallSucceeded, UpgradeFailed, Progressing).',
|
|
421
|
+
example: 'InstallSucceeded'
|
|
379
422
|
},
|
|
380
423
|
version_current: {
|
|
381
424
|
type: 'string',
|
|
@@ -446,22 +489,12 @@ export const ClusterCreateInputSchema = {
|
|
|
446
489
|
tier: {
|
|
447
490
|
type: 'string',
|
|
448
491
|
description: 'Tier of the cluster.',
|
|
492
|
+
default: 'basic',
|
|
449
493
|
example: 'pro',
|
|
450
494
|
enum: [
|
|
451
495
|
'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'
|
|
496
|
+
'pro',
|
|
497
|
+
'enterprise'
|
|
465
498
|
]
|
|
466
499
|
},
|
|
467
500
|
version_channel: {
|
|
@@ -469,20 +502,105 @@ export const ClusterCreateInputSchema = {
|
|
|
469
502
|
pattern: '^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$',
|
|
470
503
|
description: 'Version of the kubernetes cluster.',
|
|
471
504
|
default: '1.x.x-cfke.x',
|
|
472
|
-
example: '1.x.x-cfke.x'
|
|
505
|
+
example: '1.x.x-cfke.x'
|
|
506
|
+
},
|
|
507
|
+
release_channel: {
|
|
508
|
+
type: 'string',
|
|
509
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
510
|
+
default: 'rapid',
|
|
511
|
+
example: 'rapid',
|
|
473
512
|
enum: [
|
|
474
|
-
'
|
|
475
|
-
'
|
|
476
|
-
'
|
|
477
|
-
'1.33.x-cfke.x'
|
|
513
|
+
'rapid',
|
|
514
|
+
'stable',
|
|
515
|
+
'extended'
|
|
478
516
|
]
|
|
517
|
+
},
|
|
518
|
+
features: {
|
|
519
|
+
type: 'object',
|
|
520
|
+
properties: {
|
|
521
|
+
gpu_sharing_strategy: {
|
|
522
|
+
type: 'string',
|
|
523
|
+
description: 'GPU sharing strategy.',
|
|
524
|
+
default: 'none',
|
|
525
|
+
example: 'none',
|
|
526
|
+
enum: [
|
|
527
|
+
'none',
|
|
528
|
+
'mps',
|
|
529
|
+
'time_slicing'
|
|
530
|
+
]
|
|
531
|
+
},
|
|
532
|
+
gpu_max_shared_clients_per_gpu: {
|
|
533
|
+
type: 'integer',
|
|
534
|
+
minimum: 2,
|
|
535
|
+
maximum: 48,
|
|
536
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
537
|
+
default: 4,
|
|
538
|
+
example: 10
|
|
539
|
+
},
|
|
540
|
+
cilium_socket_lb_host_namespace_only: {
|
|
541
|
+
type: 'boolean',
|
|
542
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
543
|
+
example: false
|
|
544
|
+
}
|
|
545
|
+
},
|
|
546
|
+
additionalProperties: false,
|
|
547
|
+
description: 'Cluster feature toggles.',
|
|
548
|
+
default: {
|
|
549
|
+
gpu_sharing_strategy: 'none',
|
|
550
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
551
|
+
cilium_socket_lb_host_namespace_only: false
|
|
552
|
+
}
|
|
553
|
+
},
|
|
554
|
+
region: {
|
|
555
|
+
type: 'string',
|
|
556
|
+
description: 'Cloudfleet control plane region. This field can not be updated after creation.',
|
|
557
|
+
example: 'europe-central-1a'
|
|
558
|
+
},
|
|
559
|
+
networking: {
|
|
560
|
+
type: 'object',
|
|
561
|
+
properties: {
|
|
562
|
+
pod_cidr: {
|
|
563
|
+
type: 'string',
|
|
564
|
+
description: 'CIDR block for pod IPs.',
|
|
565
|
+
default: '10.244.0.0/16'
|
|
566
|
+
},
|
|
567
|
+
service_cidr: {
|
|
568
|
+
type: 'string',
|
|
569
|
+
description: 'CIDR block for service IPs.',
|
|
570
|
+
default: '10.96.0.0/12'
|
|
571
|
+
},
|
|
572
|
+
dual_stack: {
|
|
573
|
+
type: 'boolean',
|
|
574
|
+
description: 'Enable IPv4+IPv6 dual-stack networking.'
|
|
575
|
+
},
|
|
576
|
+
pod_cidr_v6: {
|
|
577
|
+
type: 'string',
|
|
578
|
+
description: 'IPv6 pod CIDR. Requires dual_stack.',
|
|
579
|
+
default: '2001:db8:1:2::/48'
|
|
580
|
+
},
|
|
581
|
+
service_cidr_v6: {
|
|
582
|
+
type: 'string',
|
|
583
|
+
description: 'IPv6 service CIDR. Requires dual_stack.',
|
|
584
|
+
default: '2001:db8:1:1::/112'
|
|
585
|
+
}
|
|
586
|
+
},
|
|
587
|
+
additionalProperties: false,
|
|
588
|
+
description: 'Cluster networking configuration. Immutable after creation.',
|
|
589
|
+
default: {
|
|
590
|
+
pod_cidr: '10.244.0.0/16',
|
|
591
|
+
service_cidr: '10.96.0.0/12',
|
|
592
|
+
dual_stack: false,
|
|
593
|
+
pod_cidr_v6: '2001:db8:1:2::/48',
|
|
594
|
+
service_cidr_v6: '2001:db8:1:1::/112'
|
|
595
|
+
}
|
|
479
596
|
}
|
|
480
597
|
},
|
|
481
598
|
required: [
|
|
482
599
|
'name',
|
|
483
|
-
'
|
|
600
|
+
'region'
|
|
484
601
|
],
|
|
485
|
-
additionalProperties: false
|
|
602
|
+
additionalProperties: false,
|
|
603
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
486
604
|
};
|
|
487
605
|
export const ClusterJoinInformationSchema = {
|
|
488
606
|
type: 'object',
|
|
@@ -503,11 +621,21 @@ export const ClusterJoinInformationSchema = {
|
|
|
503
621
|
description: 'Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.',
|
|
504
622
|
example: '10.96.0.10'
|
|
505
623
|
},
|
|
624
|
+
pod_cidr: {
|
|
625
|
+
type: 'string',
|
|
626
|
+
description: 'Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.',
|
|
627
|
+
example: '10.244.0.0/16'
|
|
628
|
+
},
|
|
506
629
|
auth_key: {
|
|
507
630
|
type: 'string',
|
|
508
631
|
description: 'Authentication key for the cluster.',
|
|
509
632
|
example: 'tskey-auth-kBV8wr1dk911CNTRL-...'
|
|
510
633
|
},
|
|
634
|
+
login_server: {
|
|
635
|
+
type: 'string',
|
|
636
|
+
description: 'Coordination server the node registers against. Empty on data plane v1 clusters, where the node advertises its own tag instead. A non-empty value requires a client that declares the dataplane-v2 capability.',
|
|
637
|
+
example: 'https://415026b6-f00f-44f8-968d-fc6ef4d0fc6d.fabric.europe-central-1a.cfke.io'
|
|
638
|
+
},
|
|
511
639
|
bootstrap_token: {
|
|
512
640
|
type: 'string',
|
|
513
641
|
description: 'Bootstrap token for the cluster.',
|
|
@@ -578,7 +706,9 @@ export const ClusterJoinInformationSchema = {
|
|
|
578
706
|
'certificate_authority',
|
|
579
707
|
'endpoint',
|
|
580
708
|
'cluster_dns',
|
|
709
|
+
'pod_cidr',
|
|
581
710
|
'auth_key',
|
|
711
|
+
'login_server',
|
|
582
712
|
'bootstrap_token',
|
|
583
713
|
'versions',
|
|
584
714
|
'third_party_api_access_config'
|
|
@@ -599,24 +729,123 @@ export const ClusterSchema = {
|
|
|
599
729
|
tier: {
|
|
600
730
|
type: 'string',
|
|
601
731
|
description: 'Tier of the cluster.',
|
|
732
|
+
default: 'basic',
|
|
602
733
|
example: 'pro',
|
|
603
734
|
enum: [
|
|
604
735
|
'basic',
|
|
605
|
-
'pro'
|
|
736
|
+
'pro',
|
|
737
|
+
'enterprise'
|
|
606
738
|
]
|
|
607
739
|
},
|
|
608
|
-
|
|
740
|
+
version_channel: {
|
|
741
|
+
type: 'string',
|
|
742
|
+
pattern: '^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$',
|
|
743
|
+
description: 'Version of the kubernetes cluster.',
|
|
744
|
+
default: '1.x.x-cfke.x',
|
|
745
|
+
example: '1.x.x-cfke.x'
|
|
746
|
+
},
|
|
747
|
+
release_channel: {
|
|
609
748
|
type: 'string',
|
|
610
|
-
description: '
|
|
611
|
-
default: '
|
|
612
|
-
example: '
|
|
749
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
750
|
+
default: 'rapid',
|
|
751
|
+
example: 'rapid',
|
|
613
752
|
enum: [
|
|
614
|
-
'
|
|
615
|
-
'
|
|
616
|
-
'
|
|
617
|
-
'northamerica-central-1a'
|
|
753
|
+
'rapid',
|
|
754
|
+
'stable',
|
|
755
|
+
'extended'
|
|
618
756
|
]
|
|
619
757
|
},
|
|
758
|
+
features: {
|
|
759
|
+
type: 'object',
|
|
760
|
+
properties: {
|
|
761
|
+
gpu_sharing_strategy: {
|
|
762
|
+
type: 'string',
|
|
763
|
+
description: 'GPU sharing strategy.',
|
|
764
|
+
default: 'none',
|
|
765
|
+
example: 'none',
|
|
766
|
+
enum: [
|
|
767
|
+
'none',
|
|
768
|
+
'mps',
|
|
769
|
+
'time_slicing'
|
|
770
|
+
]
|
|
771
|
+
},
|
|
772
|
+
gpu_max_shared_clients_per_gpu: {
|
|
773
|
+
type: 'integer',
|
|
774
|
+
minimum: 2,
|
|
775
|
+
maximum: 48,
|
|
776
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
777
|
+
default: 4,
|
|
778
|
+
example: 10
|
|
779
|
+
},
|
|
780
|
+
cilium_socket_lb_host_namespace_only: {
|
|
781
|
+
type: 'boolean',
|
|
782
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
783
|
+
example: false
|
|
784
|
+
}
|
|
785
|
+
},
|
|
786
|
+
required: [
|
|
787
|
+
'gpu_sharing_strategy',
|
|
788
|
+
'gpu_max_shared_clients_per_gpu',
|
|
789
|
+
'cilium_socket_lb_host_namespace_only'
|
|
790
|
+
],
|
|
791
|
+
additionalProperties: false,
|
|
792
|
+
description: 'Cluster feature toggles.',
|
|
793
|
+
default: {
|
|
794
|
+
gpu_sharing_strategy: 'none',
|
|
795
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
796
|
+
cilium_socket_lb_host_namespace_only: false
|
|
797
|
+
}
|
|
798
|
+
},
|
|
799
|
+
region: {
|
|
800
|
+
type: 'string',
|
|
801
|
+
description: 'Cloudfleet control plane region. This field can not be updated after creation.',
|
|
802
|
+
example: 'europe-central-1a'
|
|
803
|
+
},
|
|
804
|
+
networking: {
|
|
805
|
+
type: 'object',
|
|
806
|
+
properties: {
|
|
807
|
+
pod_cidr: {
|
|
808
|
+
type: 'string',
|
|
809
|
+
description: 'CIDR block for pod IPs.',
|
|
810
|
+
default: '10.244.0.0/16'
|
|
811
|
+
},
|
|
812
|
+
service_cidr: {
|
|
813
|
+
type: 'string',
|
|
814
|
+
description: 'CIDR block for service IPs.',
|
|
815
|
+
default: '10.96.0.0/12'
|
|
816
|
+
},
|
|
817
|
+
dual_stack: {
|
|
818
|
+
type: 'boolean',
|
|
819
|
+
description: 'Enable IPv4+IPv6 dual-stack networking.'
|
|
820
|
+
},
|
|
821
|
+
pod_cidr_v6: {
|
|
822
|
+
type: 'string',
|
|
823
|
+
description: 'IPv6 pod CIDR. Requires dual_stack.',
|
|
824
|
+
default: '2001:db8:1:2::/48'
|
|
825
|
+
},
|
|
826
|
+
service_cidr_v6: {
|
|
827
|
+
type: 'string',
|
|
828
|
+
description: 'IPv6 service CIDR. Requires dual_stack.',
|
|
829
|
+
default: '2001:db8:1:1::/112'
|
|
830
|
+
}
|
|
831
|
+
},
|
|
832
|
+
required: [
|
|
833
|
+
'pod_cidr',
|
|
834
|
+
'service_cidr',
|
|
835
|
+
'dual_stack',
|
|
836
|
+
'pod_cidr_v6',
|
|
837
|
+
'service_cidr_v6'
|
|
838
|
+
],
|
|
839
|
+
additionalProperties: false,
|
|
840
|
+
description: 'Cluster networking configuration. Immutable after creation.',
|
|
841
|
+
default: {
|
|
842
|
+
pod_cidr: '10.244.0.0/16',
|
|
843
|
+
service_cidr: '10.96.0.0/12',
|
|
844
|
+
dual_stack: false,
|
|
845
|
+
pod_cidr_v6: '2001:db8:1:2::/48',
|
|
846
|
+
service_cidr_v6: '2001:db8:1:1::/112'
|
|
847
|
+
}
|
|
848
|
+
},
|
|
620
849
|
id: {
|
|
621
850
|
type: 'string',
|
|
622
851
|
format: 'uuid',
|
|
@@ -625,16 +854,13 @@ export const ClusterSchema = {
|
|
|
625
854
|
},
|
|
626
855
|
status: {
|
|
627
856
|
type: 'string',
|
|
628
|
-
description: 'Status of the cluster.
|
|
629
|
-
example: '
|
|
857
|
+
description: 'Status of the cluster.',
|
|
858
|
+
example: 'deployed',
|
|
630
859
|
enum: [
|
|
631
|
-
'active',
|
|
632
|
-
'disabled',
|
|
633
|
-
'deleted',
|
|
634
860
|
'creating',
|
|
635
861
|
'deployed',
|
|
636
|
-
'
|
|
637
|
-
'
|
|
862
|
+
'updating',
|
|
863
|
+
'disabled'
|
|
638
864
|
]
|
|
639
865
|
},
|
|
640
866
|
endpoint: {
|
|
@@ -642,8 +868,24 @@ export const ClusterSchema = {
|
|
|
642
868
|
{
|
|
643
869
|
type: 'string',
|
|
644
870
|
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.
|
|
871
|
+
description: 'URL signed by a public CA of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.',
|
|
872
|
+
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
873
|
+
},
|
|
874
|
+
{
|
|
875
|
+
type: 'string',
|
|
876
|
+
enum: [
|
|
877
|
+
''
|
|
878
|
+
]
|
|
879
|
+
}
|
|
880
|
+
]
|
|
881
|
+
},
|
|
882
|
+
endpoint_public: {
|
|
883
|
+
anyOf: [
|
|
884
|
+
{
|
|
885
|
+
type: 'string',
|
|
886
|
+
format: 'uri',
|
|
887
|
+
description: 'Deprecated alias of `endpoint`; retained for backward compatibility.',
|
|
888
|
+
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
647
889
|
},
|
|
648
890
|
{
|
|
649
891
|
type: 'string',
|
|
@@ -677,21 +919,22 @@ export const ClusterSchema = {
|
|
|
677
919
|
type: 'boolean',
|
|
678
920
|
description: 'Indicates if the cluster is ready to be used.',
|
|
679
921
|
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
922
|
}
|
|
687
923
|
},
|
|
688
924
|
required: [
|
|
689
925
|
'name',
|
|
690
926
|
'tier',
|
|
927
|
+
'version_channel',
|
|
928
|
+
'release_channel',
|
|
929
|
+
'features',
|
|
930
|
+
'region',
|
|
931
|
+
'networking',
|
|
691
932
|
'id',
|
|
692
|
-
'status'
|
|
933
|
+
'status',
|
|
934
|
+
'ready'
|
|
693
935
|
],
|
|
694
|
-
additionalProperties: false
|
|
936
|
+
additionalProperties: false,
|
|
937
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
695
938
|
};
|
|
696
939
|
export const ClusterUpdateInputSchema = {
|
|
697
940
|
type: 'object',
|
|
@@ -707,23 +950,74 @@ export const ClusterUpdateInputSchema = {
|
|
|
707
950
|
tier: {
|
|
708
951
|
type: 'string',
|
|
709
952
|
description: 'Tier of the cluster.',
|
|
953
|
+
default: 'basic',
|
|
710
954
|
example: 'pro',
|
|
711
955
|
enum: [
|
|
712
956
|
'basic',
|
|
713
|
-
'pro'
|
|
957
|
+
'pro',
|
|
958
|
+
'enterprise'
|
|
714
959
|
]
|
|
715
960
|
},
|
|
716
961
|
version_channel: {
|
|
717
962
|
type: 'string',
|
|
718
963
|
pattern: '^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$',
|
|
719
964
|
description: 'Version of the kubernetes cluster.',
|
|
965
|
+
default: '1.x.x-cfke.x',
|
|
720
966
|
example: '1.x.x-cfke.x'
|
|
967
|
+
},
|
|
968
|
+
release_channel: {
|
|
969
|
+
type: 'string',
|
|
970
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
971
|
+
default: 'rapid',
|
|
972
|
+
example: 'rapid',
|
|
973
|
+
enum: [
|
|
974
|
+
'rapid',
|
|
975
|
+
'stable',
|
|
976
|
+
'extended'
|
|
977
|
+
]
|
|
978
|
+
},
|
|
979
|
+
features: {
|
|
980
|
+
type: 'object',
|
|
981
|
+
properties: {
|
|
982
|
+
gpu_sharing_strategy: {
|
|
983
|
+
type: 'string',
|
|
984
|
+
description: 'GPU sharing strategy.',
|
|
985
|
+
default: 'none',
|
|
986
|
+
example: 'none',
|
|
987
|
+
enum: [
|
|
988
|
+
'none',
|
|
989
|
+
'mps',
|
|
990
|
+
'time_slicing'
|
|
991
|
+
]
|
|
992
|
+
},
|
|
993
|
+
gpu_max_shared_clients_per_gpu: {
|
|
994
|
+
type: 'integer',
|
|
995
|
+
minimum: 2,
|
|
996
|
+
maximum: 48,
|
|
997
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
998
|
+
default: 4,
|
|
999
|
+
example: 10
|
|
1000
|
+
},
|
|
1001
|
+
cilium_socket_lb_host_namespace_only: {
|
|
1002
|
+
type: 'boolean',
|
|
1003
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
1004
|
+
example: false
|
|
1005
|
+
}
|
|
1006
|
+
},
|
|
1007
|
+
additionalProperties: false,
|
|
1008
|
+
description: 'Cluster feature toggles.',
|
|
1009
|
+
default: {
|
|
1010
|
+
gpu_sharing_strategy: 'none',
|
|
1011
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
1012
|
+
cilium_socket_lb_host_namespace_only: false
|
|
1013
|
+
}
|
|
721
1014
|
}
|
|
722
1015
|
},
|
|
723
1016
|
required: [
|
|
724
|
-
'
|
|
1017
|
+
'name'
|
|
725
1018
|
],
|
|
726
|
-
additionalProperties: false
|
|
1019
|
+
additionalProperties: false,
|
|
1020
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
727
1021
|
};
|
|
728
1022
|
export const FleetCreateInputSchema = {
|
|
729
1023
|
type: 'object',
|
|
@@ -732,15 +1026,12 @@ export const FleetCreateInputSchema = {
|
|
|
732
1026
|
type: 'object',
|
|
733
1027
|
properties: {
|
|
734
1028
|
cpu: {
|
|
735
|
-
type: '
|
|
736
|
-
format: 'float',
|
|
1029
|
+
type: 'integer',
|
|
737
1030
|
minimum: 0,
|
|
738
|
-
|
|
1031
|
+
maximum: 100000,
|
|
1032
|
+
description: 'CPU limit in cores. Maximum 100,000.'
|
|
739
1033
|
}
|
|
740
1034
|
},
|
|
741
|
-
required: [
|
|
742
|
-
'cpu'
|
|
743
|
-
],
|
|
744
1035
|
additionalProperties: false,
|
|
745
1036
|
description: 'Limits define a set of bounds for provisioning capacity.'
|
|
746
1037
|
},
|
|
@@ -748,16 +1039,17 @@ export const FleetCreateInputSchema = {
|
|
|
748
1039
|
type: 'object',
|
|
749
1040
|
properties: {
|
|
750
1041
|
enabled: {
|
|
751
|
-
type: 'boolean'
|
|
752
|
-
default: true
|
|
1042
|
+
type: 'boolean'
|
|
753
1043
|
},
|
|
754
1044
|
project: {
|
|
755
1045
|
type: 'string',
|
|
756
|
-
|
|
1046
|
+
pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
|
|
1047
|
+
description: 'GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.',
|
|
1048
|
+
example: 'my-cloudfleet-project'
|
|
757
1049
|
}
|
|
758
1050
|
},
|
|
759
1051
|
required: [
|
|
760
|
-
'
|
|
1052
|
+
'enabled'
|
|
761
1053
|
],
|
|
762
1054
|
additionalProperties: false
|
|
763
1055
|
},
|
|
@@ -765,16 +1057,18 @@ export const FleetCreateInputSchema = {
|
|
|
765
1057
|
type: 'object',
|
|
766
1058
|
properties: {
|
|
767
1059
|
enabled: {
|
|
768
|
-
type: 'boolean'
|
|
769
|
-
default: true
|
|
1060
|
+
type: 'boolean'
|
|
770
1061
|
},
|
|
771
1062
|
apiKey: {
|
|
772
1063
|
type: 'string',
|
|
773
|
-
|
|
1064
|
+
maxLength: 64,
|
|
1065
|
+
minLength: 64,
|
|
1066
|
+
pattern: '^([A-Za-z0-9]{64}|\\*{64})$',
|
|
1067
|
+
description: 'Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.'
|
|
774
1068
|
}
|
|
775
1069
|
},
|
|
776
1070
|
required: [
|
|
777
|
-
'
|
|
1071
|
+
'enabled'
|
|
778
1072
|
],
|
|
779
1073
|
additionalProperties: false
|
|
780
1074
|
},
|
|
@@ -782,19 +1076,321 @@ export const FleetCreateInputSchema = {
|
|
|
782
1076
|
type: 'object',
|
|
783
1077
|
properties: {
|
|
784
1078
|
enabled: {
|
|
785
|
-
type: 'boolean'
|
|
786
|
-
default: true
|
|
1079
|
+
type: 'boolean'
|
|
787
1080
|
},
|
|
788
1081
|
controllerRoleArn: {
|
|
789
1082
|
type: 'string',
|
|
790
|
-
|
|
1083
|
+
pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
|
|
1084
|
+
description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
|
|
1085
|
+
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
791
1086
|
}
|
|
792
1087
|
},
|
|
793
1088
|
required: [
|
|
794
|
-
'
|
|
1089
|
+
'enabled'
|
|
795
1090
|
],
|
|
796
1091
|
additionalProperties: false
|
|
797
1092
|
},
|
|
1093
|
+
constraints: {
|
|
1094
|
+
type: 'object',
|
|
1095
|
+
properties: {
|
|
1096
|
+
'karpenter.sh/capacity-type': {
|
|
1097
|
+
type: 'array',
|
|
1098
|
+
items: {
|
|
1099
|
+
type: 'string',
|
|
1100
|
+
enum: [
|
|
1101
|
+
'on-demand',
|
|
1102
|
+
'spot'
|
|
1103
|
+
]
|
|
1104
|
+
},
|
|
1105
|
+
minItems: 1,
|
|
1106
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1107
|
+
default: [
|
|
1108
|
+
'on-demand',
|
|
1109
|
+
'spot'
|
|
1110
|
+
]
|
|
1111
|
+
},
|
|
1112
|
+
'kubernetes.io/arch': {
|
|
1113
|
+
type: 'array',
|
|
1114
|
+
items: {
|
|
1115
|
+
type: 'string',
|
|
1116
|
+
enum: [
|
|
1117
|
+
'amd64',
|
|
1118
|
+
'arm64'
|
|
1119
|
+
]
|
|
1120
|
+
},
|
|
1121
|
+
minItems: 1,
|
|
1122
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1123
|
+
default: [
|
|
1124
|
+
'amd64'
|
|
1125
|
+
]
|
|
1126
|
+
},
|
|
1127
|
+
'cfke.io/instance-family': {
|
|
1128
|
+
type: 'array',
|
|
1129
|
+
items: {
|
|
1130
|
+
type: 'string',
|
|
1131
|
+
enum: [
|
|
1132
|
+
'a1',
|
|
1133
|
+
'a2',
|
|
1134
|
+
'a3',
|
|
1135
|
+
'a4',
|
|
1136
|
+
'c1',
|
|
1137
|
+
'c2',
|
|
1138
|
+
'c2d',
|
|
1139
|
+
'c3',
|
|
1140
|
+
'c3d',
|
|
1141
|
+
'c4',
|
|
1142
|
+
'c4a',
|
|
1143
|
+
'c4d',
|
|
1144
|
+
'c5',
|
|
1145
|
+
'c5a',
|
|
1146
|
+
'c5ad',
|
|
1147
|
+
'c5d',
|
|
1148
|
+
'c5n',
|
|
1149
|
+
'c6a',
|
|
1150
|
+
'c6g',
|
|
1151
|
+
'c6gd',
|
|
1152
|
+
'c6gn',
|
|
1153
|
+
'c6i',
|
|
1154
|
+
'c6id',
|
|
1155
|
+
'c6in',
|
|
1156
|
+
'c7a',
|
|
1157
|
+
'c7g',
|
|
1158
|
+
'c7gd',
|
|
1159
|
+
'c7gn',
|
|
1160
|
+
'c7i',
|
|
1161
|
+
'c7i-flex',
|
|
1162
|
+
'c8g',
|
|
1163
|
+
'c8gd',
|
|
1164
|
+
'cax',
|
|
1165
|
+
'ccx',
|
|
1166
|
+
'cpx',
|
|
1167
|
+
'cx',
|
|
1168
|
+
'd2',
|
|
1169
|
+
'd3',
|
|
1170
|
+
'd3en',
|
|
1171
|
+
'dl1',
|
|
1172
|
+
'dl2q',
|
|
1173
|
+
'e2',
|
|
1174
|
+
'f1',
|
|
1175
|
+
'f2',
|
|
1176
|
+
'g1',
|
|
1177
|
+
'g2',
|
|
1178
|
+
'g4ad',
|
|
1179
|
+
'g4dn',
|
|
1180
|
+
'g5',
|
|
1181
|
+
'g5g',
|
|
1182
|
+
'g6',
|
|
1183
|
+
'g6e',
|
|
1184
|
+
'gr6',
|
|
1185
|
+
'h1',
|
|
1186
|
+
'h3',
|
|
1187
|
+
'hpc6a',
|
|
1188
|
+
'hpc6id',
|
|
1189
|
+
'hpc7a',
|
|
1190
|
+
'hpc7g',
|
|
1191
|
+
'i2',
|
|
1192
|
+
'i3',
|
|
1193
|
+
'i3en',
|
|
1194
|
+
'i4g',
|
|
1195
|
+
'i4i',
|
|
1196
|
+
'i7i',
|
|
1197
|
+
'i7ie',
|
|
1198
|
+
'i8g',
|
|
1199
|
+
'im4gn',
|
|
1200
|
+
'inf1',
|
|
1201
|
+
'inf2',
|
|
1202
|
+
'is4gen',
|
|
1203
|
+
'm1',
|
|
1204
|
+
'm2',
|
|
1205
|
+
'm3',
|
|
1206
|
+
'm4',
|
|
1207
|
+
'm5',
|
|
1208
|
+
'm5a',
|
|
1209
|
+
'm5ad',
|
|
1210
|
+
'm5d',
|
|
1211
|
+
'm5dn',
|
|
1212
|
+
'm5n',
|
|
1213
|
+
'm5zn',
|
|
1214
|
+
'm6a',
|
|
1215
|
+
'm6g',
|
|
1216
|
+
'm6gd',
|
|
1217
|
+
'm6i',
|
|
1218
|
+
'm6id',
|
|
1219
|
+
'm6idn',
|
|
1220
|
+
'm6in',
|
|
1221
|
+
'm7a',
|
|
1222
|
+
'm7g',
|
|
1223
|
+
'm7gd',
|
|
1224
|
+
'm7i',
|
|
1225
|
+
'm7i-flex',
|
|
1226
|
+
'm8g',
|
|
1227
|
+
'm8gd',
|
|
1228
|
+
'n1',
|
|
1229
|
+
'n2',
|
|
1230
|
+
'n2d',
|
|
1231
|
+
'n4',
|
|
1232
|
+
'p3',
|
|
1233
|
+
'p3dn',
|
|
1234
|
+
'p4d',
|
|
1235
|
+
'p4de',
|
|
1236
|
+
'p5',
|
|
1237
|
+
'p5e',
|
|
1238
|
+
'p5en',
|
|
1239
|
+
'p6-b200',
|
|
1240
|
+
'r3',
|
|
1241
|
+
'r4',
|
|
1242
|
+
'r5',
|
|
1243
|
+
'r5a',
|
|
1244
|
+
'r5ad',
|
|
1245
|
+
'r5b',
|
|
1246
|
+
'r5d',
|
|
1247
|
+
'r5dn',
|
|
1248
|
+
'r5n',
|
|
1249
|
+
'r6a',
|
|
1250
|
+
'r6g',
|
|
1251
|
+
'r6gd',
|
|
1252
|
+
'r6i',
|
|
1253
|
+
'r6id',
|
|
1254
|
+
'r6idn',
|
|
1255
|
+
'r6in',
|
|
1256
|
+
'r7a',
|
|
1257
|
+
'r7g',
|
|
1258
|
+
'r7gd',
|
|
1259
|
+
'r7i',
|
|
1260
|
+
'r7iz',
|
|
1261
|
+
'r8g',
|
|
1262
|
+
'r8gd',
|
|
1263
|
+
't2',
|
|
1264
|
+
't2a',
|
|
1265
|
+
't2d',
|
|
1266
|
+
't3',
|
|
1267
|
+
't3a',
|
|
1268
|
+
't4g',
|
|
1269
|
+
'trn1',
|
|
1270
|
+
'trn1n',
|
|
1271
|
+
'u-3tb1',
|
|
1272
|
+
'u-6tb1',
|
|
1273
|
+
'u7i-12tb',
|
|
1274
|
+
'u7i-6tb',
|
|
1275
|
+
'u7i-8tb',
|
|
1276
|
+
'u7in-16tb',
|
|
1277
|
+
'u7in-24tb',
|
|
1278
|
+
'u7in-32tb',
|
|
1279
|
+
'vt1',
|
|
1280
|
+
'x1',
|
|
1281
|
+
'x1e',
|
|
1282
|
+
'x2gd',
|
|
1283
|
+
'x2idn',
|
|
1284
|
+
'x2iedn',
|
|
1285
|
+
'x2iezn',
|
|
1286
|
+
'x4',
|
|
1287
|
+
'x8g',
|
|
1288
|
+
'z1d',
|
|
1289
|
+
'z3'
|
|
1290
|
+
]
|
|
1291
|
+
},
|
|
1292
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
1293
|
+
default: []
|
|
1294
|
+
},
|
|
1295
|
+
'topology.kubernetes.io/region': {
|
|
1296
|
+
type: 'array',
|
|
1297
|
+
items: {
|
|
1298
|
+
type: 'string',
|
|
1299
|
+
enum: [
|
|
1300
|
+
'africa-south1',
|
|
1301
|
+
'ap-northeast-1',
|
|
1302
|
+
'ap-northeast-2',
|
|
1303
|
+
'ap-northeast-3',
|
|
1304
|
+
'ap-south-1',
|
|
1305
|
+
'ap-southeast-1',
|
|
1306
|
+
'ap-southeast-2',
|
|
1307
|
+
'ash',
|
|
1308
|
+
'asia-east1',
|
|
1309
|
+
'asia-east2',
|
|
1310
|
+
'asia-northeast1',
|
|
1311
|
+
'asia-northeast2',
|
|
1312
|
+
'asia-northeast3',
|
|
1313
|
+
'asia-south1',
|
|
1314
|
+
'asia-south2',
|
|
1315
|
+
'asia-southeast1',
|
|
1316
|
+
'asia-southeast2',
|
|
1317
|
+
'australia-southeast1',
|
|
1318
|
+
'australia-southeast2',
|
|
1319
|
+
'ca-central-1',
|
|
1320
|
+
'eu-central-1',
|
|
1321
|
+
'eu-central-2',
|
|
1322
|
+
'eu-north-1',
|
|
1323
|
+
'eu-west-1',
|
|
1324
|
+
'eu-west-2',
|
|
1325
|
+
'eu-west-3',
|
|
1326
|
+
'europe-central2',
|
|
1327
|
+
'europe-north1',
|
|
1328
|
+
'europe-southwest1',
|
|
1329
|
+
'europe-west1',
|
|
1330
|
+
'europe-west10',
|
|
1331
|
+
'europe-west12',
|
|
1332
|
+
'europe-west2',
|
|
1333
|
+
'europe-west3',
|
|
1334
|
+
'europe-west4',
|
|
1335
|
+
'europe-west6',
|
|
1336
|
+
'europe-west8',
|
|
1337
|
+
'europe-west9',
|
|
1338
|
+
'fsn1',
|
|
1339
|
+
'hel1',
|
|
1340
|
+
'hil',
|
|
1341
|
+
'me-central1',
|
|
1342
|
+
'me-central2',
|
|
1343
|
+
'me-west1',
|
|
1344
|
+
'nbg1',
|
|
1345
|
+
'northamerica-northeast1',
|
|
1346
|
+
'northamerica-northeast2',
|
|
1347
|
+
'sa-east-1',
|
|
1348
|
+
'sin',
|
|
1349
|
+
'southamerica-east1',
|
|
1350
|
+
'southamerica-west1',
|
|
1351
|
+
'us-central1',
|
|
1352
|
+
'us-east-1',
|
|
1353
|
+
'us-east-2',
|
|
1354
|
+
'us-east1',
|
|
1355
|
+
'us-east4',
|
|
1356
|
+
'us-east5',
|
|
1357
|
+
'us-south1',
|
|
1358
|
+
'us-west-1',
|
|
1359
|
+
'us-west-2',
|
|
1360
|
+
'us-west1',
|
|
1361
|
+
'us-west2',
|
|
1362
|
+
'us-west3',
|
|
1363
|
+
'us-west4'
|
|
1364
|
+
]
|
|
1365
|
+
},
|
|
1366
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
1367
|
+
default: []
|
|
1368
|
+
}
|
|
1369
|
+
},
|
|
1370
|
+
additionalProperties: false,
|
|
1371
|
+
description: 'Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.',
|
|
1372
|
+
default: {
|
|
1373
|
+
'karpenter.sh/capacity-type': [
|
|
1374
|
+
'on-demand',
|
|
1375
|
+
'spot'
|
|
1376
|
+
],
|
|
1377
|
+
'kubernetes.io/arch': [
|
|
1378
|
+
'amd64'
|
|
1379
|
+
],
|
|
1380
|
+
'cfke.io/instance-family': [],
|
|
1381
|
+
'topology.kubernetes.io/region': []
|
|
1382
|
+
}
|
|
1383
|
+
},
|
|
1384
|
+
scalingProfile: {
|
|
1385
|
+
type: 'string',
|
|
1386
|
+
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).',
|
|
1387
|
+
default: 'conservative',
|
|
1388
|
+
example: 'conservative',
|
|
1389
|
+
enum: [
|
|
1390
|
+
'aggressive',
|
|
1391
|
+
'conservative'
|
|
1392
|
+
]
|
|
1393
|
+
},
|
|
798
1394
|
id: {
|
|
799
1395
|
type: 'string',
|
|
800
1396
|
maxLength: 63,
|
|
@@ -807,7 +1403,8 @@ export const FleetCreateInputSchema = {
|
|
|
807
1403
|
required: [
|
|
808
1404
|
'id'
|
|
809
1405
|
],
|
|
810
|
-
additionalProperties: false
|
|
1406
|
+
additionalProperties: false,
|
|
1407
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
811
1408
|
};
|
|
812
1409
|
export const FleetSchema = {
|
|
813
1410
|
type: 'object',
|
|
@@ -816,15 +1413,12 @@ export const FleetSchema = {
|
|
|
816
1413
|
type: 'object',
|
|
817
1414
|
properties: {
|
|
818
1415
|
cpu: {
|
|
819
|
-
type: '
|
|
820
|
-
format: 'float',
|
|
1416
|
+
type: 'integer',
|
|
821
1417
|
minimum: 0,
|
|
822
|
-
|
|
1418
|
+
maximum: 100000,
|
|
1419
|
+
description: 'CPU limit in cores. Maximum 100,000.'
|
|
823
1420
|
}
|
|
824
1421
|
},
|
|
825
|
-
required: [
|
|
826
|
-
'cpu'
|
|
827
|
-
],
|
|
828
1422
|
additionalProperties: false,
|
|
829
1423
|
description: 'Limits define a set of bounds for provisioning capacity.'
|
|
830
1424
|
},
|
|
@@ -832,16 +1426,17 @@ export const FleetSchema = {
|
|
|
832
1426
|
type: 'object',
|
|
833
1427
|
properties: {
|
|
834
1428
|
enabled: {
|
|
835
|
-
type: 'boolean'
|
|
836
|
-
default: true
|
|
1429
|
+
type: 'boolean'
|
|
837
1430
|
},
|
|
838
1431
|
project: {
|
|
839
1432
|
type: 'string',
|
|
840
|
-
|
|
1433
|
+
pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
|
|
1434
|
+
description: 'GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.',
|
|
1435
|
+
example: 'my-cloudfleet-project'
|
|
841
1436
|
}
|
|
842
1437
|
},
|
|
843
1438
|
required: [
|
|
844
|
-
'
|
|
1439
|
+
'enabled'
|
|
845
1440
|
],
|
|
846
1441
|
additionalProperties: false
|
|
847
1442
|
},
|
|
@@ -849,16 +1444,16 @@ export const FleetSchema = {
|
|
|
849
1444
|
type: 'object',
|
|
850
1445
|
properties: {
|
|
851
1446
|
enabled: {
|
|
852
|
-
type: 'boolean'
|
|
853
|
-
default: true
|
|
1447
|
+
type: 'boolean'
|
|
854
1448
|
},
|
|
855
1449
|
apiKey: {
|
|
856
1450
|
type: 'string',
|
|
857
|
-
|
|
1451
|
+
pattern: '^\\*{64}$',
|
|
1452
|
+
description: 'Redacted Hetzner API token. Returned as 64 asterisks when a token is configured; omitted otherwise. The real value is never echoed by the API.'
|
|
858
1453
|
}
|
|
859
1454
|
},
|
|
860
1455
|
required: [
|
|
861
|
-
'
|
|
1456
|
+
'enabled'
|
|
862
1457
|
],
|
|
863
1458
|
additionalProperties: false
|
|
864
1459
|
},
|
|
@@ -866,19 +1461,325 @@ export const FleetSchema = {
|
|
|
866
1461
|
type: 'object',
|
|
867
1462
|
properties: {
|
|
868
1463
|
enabled: {
|
|
869
|
-
type: 'boolean'
|
|
870
|
-
default: true
|
|
1464
|
+
type: 'boolean'
|
|
871
1465
|
},
|
|
872
1466
|
controllerRoleArn: {
|
|
873
1467
|
type: 'string',
|
|
874
|
-
|
|
1468
|
+
pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
|
|
1469
|
+
description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
|
|
1470
|
+
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
875
1471
|
}
|
|
876
1472
|
},
|
|
877
1473
|
required: [
|
|
878
|
-
'
|
|
1474
|
+
'enabled'
|
|
879
1475
|
],
|
|
880
1476
|
additionalProperties: false
|
|
881
1477
|
},
|
|
1478
|
+
constraints: {
|
|
1479
|
+
type: 'object',
|
|
1480
|
+
properties: {
|
|
1481
|
+
'karpenter.sh/capacity-type': {
|
|
1482
|
+
type: 'array',
|
|
1483
|
+
items: {
|
|
1484
|
+
type: 'string',
|
|
1485
|
+
enum: [
|
|
1486
|
+
'on-demand',
|
|
1487
|
+
'spot'
|
|
1488
|
+
]
|
|
1489
|
+
},
|
|
1490
|
+
minItems: 1,
|
|
1491
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1492
|
+
default: [
|
|
1493
|
+
'on-demand',
|
|
1494
|
+
'spot'
|
|
1495
|
+
]
|
|
1496
|
+
},
|
|
1497
|
+
'kubernetes.io/arch': {
|
|
1498
|
+
type: 'array',
|
|
1499
|
+
items: {
|
|
1500
|
+
type: 'string',
|
|
1501
|
+
enum: [
|
|
1502
|
+
'amd64',
|
|
1503
|
+
'arm64'
|
|
1504
|
+
]
|
|
1505
|
+
},
|
|
1506
|
+
minItems: 1,
|
|
1507
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1508
|
+
default: [
|
|
1509
|
+
'amd64'
|
|
1510
|
+
]
|
|
1511
|
+
},
|
|
1512
|
+
'cfke.io/instance-family': {
|
|
1513
|
+
type: 'array',
|
|
1514
|
+
items: {
|
|
1515
|
+
type: 'string',
|
|
1516
|
+
enum: [
|
|
1517
|
+
'a1',
|
|
1518
|
+
'a2',
|
|
1519
|
+
'a3',
|
|
1520
|
+
'a4',
|
|
1521
|
+
'c1',
|
|
1522
|
+
'c2',
|
|
1523
|
+
'c2d',
|
|
1524
|
+
'c3',
|
|
1525
|
+
'c3d',
|
|
1526
|
+
'c4',
|
|
1527
|
+
'c4a',
|
|
1528
|
+
'c4d',
|
|
1529
|
+
'c5',
|
|
1530
|
+
'c5a',
|
|
1531
|
+
'c5ad',
|
|
1532
|
+
'c5d',
|
|
1533
|
+
'c5n',
|
|
1534
|
+
'c6a',
|
|
1535
|
+
'c6g',
|
|
1536
|
+
'c6gd',
|
|
1537
|
+
'c6gn',
|
|
1538
|
+
'c6i',
|
|
1539
|
+
'c6id',
|
|
1540
|
+
'c6in',
|
|
1541
|
+
'c7a',
|
|
1542
|
+
'c7g',
|
|
1543
|
+
'c7gd',
|
|
1544
|
+
'c7gn',
|
|
1545
|
+
'c7i',
|
|
1546
|
+
'c7i-flex',
|
|
1547
|
+
'c8g',
|
|
1548
|
+
'c8gd',
|
|
1549
|
+
'cax',
|
|
1550
|
+
'ccx',
|
|
1551
|
+
'cpx',
|
|
1552
|
+
'cx',
|
|
1553
|
+
'd2',
|
|
1554
|
+
'd3',
|
|
1555
|
+
'd3en',
|
|
1556
|
+
'dl1',
|
|
1557
|
+
'dl2q',
|
|
1558
|
+
'e2',
|
|
1559
|
+
'f1',
|
|
1560
|
+
'f2',
|
|
1561
|
+
'g1',
|
|
1562
|
+
'g2',
|
|
1563
|
+
'g4ad',
|
|
1564
|
+
'g4dn',
|
|
1565
|
+
'g5',
|
|
1566
|
+
'g5g',
|
|
1567
|
+
'g6',
|
|
1568
|
+
'g6e',
|
|
1569
|
+
'gr6',
|
|
1570
|
+
'h1',
|
|
1571
|
+
'h3',
|
|
1572
|
+
'hpc6a',
|
|
1573
|
+
'hpc6id',
|
|
1574
|
+
'hpc7a',
|
|
1575
|
+
'hpc7g',
|
|
1576
|
+
'i2',
|
|
1577
|
+
'i3',
|
|
1578
|
+
'i3en',
|
|
1579
|
+
'i4g',
|
|
1580
|
+
'i4i',
|
|
1581
|
+
'i7i',
|
|
1582
|
+
'i7ie',
|
|
1583
|
+
'i8g',
|
|
1584
|
+
'im4gn',
|
|
1585
|
+
'inf1',
|
|
1586
|
+
'inf2',
|
|
1587
|
+
'is4gen',
|
|
1588
|
+
'm1',
|
|
1589
|
+
'm2',
|
|
1590
|
+
'm3',
|
|
1591
|
+
'm4',
|
|
1592
|
+
'm5',
|
|
1593
|
+
'm5a',
|
|
1594
|
+
'm5ad',
|
|
1595
|
+
'm5d',
|
|
1596
|
+
'm5dn',
|
|
1597
|
+
'm5n',
|
|
1598
|
+
'm5zn',
|
|
1599
|
+
'm6a',
|
|
1600
|
+
'm6g',
|
|
1601
|
+
'm6gd',
|
|
1602
|
+
'm6i',
|
|
1603
|
+
'm6id',
|
|
1604
|
+
'm6idn',
|
|
1605
|
+
'm6in',
|
|
1606
|
+
'm7a',
|
|
1607
|
+
'm7g',
|
|
1608
|
+
'm7gd',
|
|
1609
|
+
'm7i',
|
|
1610
|
+
'm7i-flex',
|
|
1611
|
+
'm8g',
|
|
1612
|
+
'm8gd',
|
|
1613
|
+
'n1',
|
|
1614
|
+
'n2',
|
|
1615
|
+
'n2d',
|
|
1616
|
+
'n4',
|
|
1617
|
+
'p3',
|
|
1618
|
+
'p3dn',
|
|
1619
|
+
'p4d',
|
|
1620
|
+
'p4de',
|
|
1621
|
+
'p5',
|
|
1622
|
+
'p5e',
|
|
1623
|
+
'p5en',
|
|
1624
|
+
'p6-b200',
|
|
1625
|
+
'r3',
|
|
1626
|
+
'r4',
|
|
1627
|
+
'r5',
|
|
1628
|
+
'r5a',
|
|
1629
|
+
'r5ad',
|
|
1630
|
+
'r5b',
|
|
1631
|
+
'r5d',
|
|
1632
|
+
'r5dn',
|
|
1633
|
+
'r5n',
|
|
1634
|
+
'r6a',
|
|
1635
|
+
'r6g',
|
|
1636
|
+
'r6gd',
|
|
1637
|
+
'r6i',
|
|
1638
|
+
'r6id',
|
|
1639
|
+
'r6idn',
|
|
1640
|
+
'r6in',
|
|
1641
|
+
'r7a',
|
|
1642
|
+
'r7g',
|
|
1643
|
+
'r7gd',
|
|
1644
|
+
'r7i',
|
|
1645
|
+
'r7iz',
|
|
1646
|
+
'r8g',
|
|
1647
|
+
'r8gd',
|
|
1648
|
+
't2',
|
|
1649
|
+
't2a',
|
|
1650
|
+
't2d',
|
|
1651
|
+
't3',
|
|
1652
|
+
't3a',
|
|
1653
|
+
't4g',
|
|
1654
|
+
'trn1',
|
|
1655
|
+
'trn1n',
|
|
1656
|
+
'u-3tb1',
|
|
1657
|
+
'u-6tb1',
|
|
1658
|
+
'u7i-12tb',
|
|
1659
|
+
'u7i-6tb',
|
|
1660
|
+
'u7i-8tb',
|
|
1661
|
+
'u7in-16tb',
|
|
1662
|
+
'u7in-24tb',
|
|
1663
|
+
'u7in-32tb',
|
|
1664
|
+
'vt1',
|
|
1665
|
+
'x1',
|
|
1666
|
+
'x1e',
|
|
1667
|
+
'x2gd',
|
|
1668
|
+
'x2idn',
|
|
1669
|
+
'x2iedn',
|
|
1670
|
+
'x2iezn',
|
|
1671
|
+
'x4',
|
|
1672
|
+
'x8g',
|
|
1673
|
+
'z1d',
|
|
1674
|
+
'z3'
|
|
1675
|
+
]
|
|
1676
|
+
},
|
|
1677
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
1678
|
+
default: []
|
|
1679
|
+
},
|
|
1680
|
+
'topology.kubernetes.io/region': {
|
|
1681
|
+
type: 'array',
|
|
1682
|
+
items: {
|
|
1683
|
+
type: 'string',
|
|
1684
|
+
enum: [
|
|
1685
|
+
'africa-south1',
|
|
1686
|
+
'ap-northeast-1',
|
|
1687
|
+
'ap-northeast-2',
|
|
1688
|
+
'ap-northeast-3',
|
|
1689
|
+
'ap-south-1',
|
|
1690
|
+
'ap-southeast-1',
|
|
1691
|
+
'ap-southeast-2',
|
|
1692
|
+
'ash',
|
|
1693
|
+
'asia-east1',
|
|
1694
|
+
'asia-east2',
|
|
1695
|
+
'asia-northeast1',
|
|
1696
|
+
'asia-northeast2',
|
|
1697
|
+
'asia-northeast3',
|
|
1698
|
+
'asia-south1',
|
|
1699
|
+
'asia-south2',
|
|
1700
|
+
'asia-southeast1',
|
|
1701
|
+
'asia-southeast2',
|
|
1702
|
+
'australia-southeast1',
|
|
1703
|
+
'australia-southeast2',
|
|
1704
|
+
'ca-central-1',
|
|
1705
|
+
'eu-central-1',
|
|
1706
|
+
'eu-central-2',
|
|
1707
|
+
'eu-north-1',
|
|
1708
|
+
'eu-west-1',
|
|
1709
|
+
'eu-west-2',
|
|
1710
|
+
'eu-west-3',
|
|
1711
|
+
'europe-central2',
|
|
1712
|
+
'europe-north1',
|
|
1713
|
+
'europe-southwest1',
|
|
1714
|
+
'europe-west1',
|
|
1715
|
+
'europe-west10',
|
|
1716
|
+
'europe-west12',
|
|
1717
|
+
'europe-west2',
|
|
1718
|
+
'europe-west3',
|
|
1719
|
+
'europe-west4',
|
|
1720
|
+
'europe-west6',
|
|
1721
|
+
'europe-west8',
|
|
1722
|
+
'europe-west9',
|
|
1723
|
+
'fsn1',
|
|
1724
|
+
'hel1',
|
|
1725
|
+
'hil',
|
|
1726
|
+
'me-central1',
|
|
1727
|
+
'me-central2',
|
|
1728
|
+
'me-west1',
|
|
1729
|
+
'nbg1',
|
|
1730
|
+
'northamerica-northeast1',
|
|
1731
|
+
'northamerica-northeast2',
|
|
1732
|
+
'sa-east-1',
|
|
1733
|
+
'sin',
|
|
1734
|
+
'southamerica-east1',
|
|
1735
|
+
'southamerica-west1',
|
|
1736
|
+
'us-central1',
|
|
1737
|
+
'us-east-1',
|
|
1738
|
+
'us-east-2',
|
|
1739
|
+
'us-east1',
|
|
1740
|
+
'us-east4',
|
|
1741
|
+
'us-east5',
|
|
1742
|
+
'us-south1',
|
|
1743
|
+
'us-west-1',
|
|
1744
|
+
'us-west-2',
|
|
1745
|
+
'us-west1',
|
|
1746
|
+
'us-west2',
|
|
1747
|
+
'us-west3',
|
|
1748
|
+
'us-west4'
|
|
1749
|
+
]
|
|
1750
|
+
},
|
|
1751
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
1752
|
+
default: []
|
|
1753
|
+
}
|
|
1754
|
+
},
|
|
1755
|
+
required: [
|
|
1756
|
+
'karpenter.sh/capacity-type',
|
|
1757
|
+
'kubernetes.io/arch'
|
|
1758
|
+
],
|
|
1759
|
+
additionalProperties: false,
|
|
1760
|
+
description: 'Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.',
|
|
1761
|
+
default: {
|
|
1762
|
+
'karpenter.sh/capacity-type': [
|
|
1763
|
+
'on-demand',
|
|
1764
|
+
'spot'
|
|
1765
|
+
],
|
|
1766
|
+
'kubernetes.io/arch': [
|
|
1767
|
+
'amd64'
|
|
1768
|
+
],
|
|
1769
|
+
'cfke.io/instance-family': [],
|
|
1770
|
+
'topology.kubernetes.io/region': []
|
|
1771
|
+
}
|
|
1772
|
+
},
|
|
1773
|
+
scalingProfile: {
|
|
1774
|
+
type: 'string',
|
|
1775
|
+
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).',
|
|
1776
|
+
default: 'conservative',
|
|
1777
|
+
example: 'conservative',
|
|
1778
|
+
enum: [
|
|
1779
|
+
'aggressive',
|
|
1780
|
+
'conservative'
|
|
1781
|
+
]
|
|
1782
|
+
},
|
|
882
1783
|
id: {
|
|
883
1784
|
type: 'string',
|
|
884
1785
|
maxLength: 63,
|
|
@@ -886,12 +1787,38 @@ export const FleetSchema = {
|
|
|
886
1787
|
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
887
1788
|
description: 'Unique identifier of the kubernetes fleet.',
|
|
888
1789
|
example: 'new-clouds-fleet'
|
|
1790
|
+
},
|
|
1791
|
+
ready: {
|
|
1792
|
+
type: 'boolean',
|
|
1793
|
+
description: 'Indicates whether the fleet configuration is healthy.',
|
|
1794
|
+
example: true
|
|
1795
|
+
},
|
|
1796
|
+
status_message: {
|
|
1797
|
+
type: 'string',
|
|
1798
|
+
description: 'Human-readable reason the fleet is not ready. Present only when `ready` is false.',
|
|
1799
|
+
example: 'Invalid provider permissions.'
|
|
1800
|
+
},
|
|
1801
|
+
created_at: {
|
|
1802
|
+
type: 'string',
|
|
1803
|
+
description: 'Creation date and time of the fleet.',
|
|
1804
|
+
example: '2024-09-12T09:11:27Z'
|
|
1805
|
+
},
|
|
1806
|
+
updated_at: {
|
|
1807
|
+
type: 'string',
|
|
1808
|
+
description: 'Date and time the fleet was last updated.',
|
|
1809
|
+
example: '2024-09-12T09:11:27Z'
|
|
889
1810
|
}
|
|
890
1811
|
},
|
|
891
1812
|
required: [
|
|
892
|
-
'
|
|
1813
|
+
'constraints',
|
|
1814
|
+
'scalingProfile',
|
|
1815
|
+
'id',
|
|
1816
|
+
'ready',
|
|
1817
|
+
'created_at',
|
|
1818
|
+
'updated_at'
|
|
893
1819
|
],
|
|
894
|
-
additionalProperties: false
|
|
1820
|
+
additionalProperties: false,
|
|
1821
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
895
1822
|
};
|
|
896
1823
|
export const FleetUpdateInputSchema = {
|
|
897
1824
|
type: 'object',
|
|
@@ -900,15 +1827,12 @@ export const FleetUpdateInputSchema = {
|
|
|
900
1827
|
type: 'object',
|
|
901
1828
|
properties: {
|
|
902
1829
|
cpu: {
|
|
903
|
-
type: '
|
|
904
|
-
format: 'float',
|
|
1830
|
+
type: 'integer',
|
|
905
1831
|
minimum: 0,
|
|
906
|
-
|
|
1832
|
+
maximum: 100000,
|
|
1833
|
+
description: 'CPU limit in cores. Maximum 100,000.'
|
|
907
1834
|
}
|
|
908
1835
|
},
|
|
909
|
-
required: [
|
|
910
|
-
'cpu'
|
|
911
|
-
],
|
|
912
1836
|
additionalProperties: false,
|
|
913
1837
|
description: 'Limits define a set of bounds for provisioning capacity.'
|
|
914
1838
|
},
|
|
@@ -916,16 +1840,17 @@ export const FleetUpdateInputSchema = {
|
|
|
916
1840
|
type: 'object',
|
|
917
1841
|
properties: {
|
|
918
1842
|
enabled: {
|
|
919
|
-
type: 'boolean'
|
|
920
|
-
default: true
|
|
1843
|
+
type: 'boolean'
|
|
921
1844
|
},
|
|
922
1845
|
project: {
|
|
923
1846
|
type: 'string',
|
|
924
|
-
|
|
1847
|
+
pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
|
|
1848
|
+
description: 'GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.',
|
|
1849
|
+
example: 'my-cloudfleet-project'
|
|
925
1850
|
}
|
|
926
1851
|
},
|
|
927
1852
|
required: [
|
|
928
|
-
'
|
|
1853
|
+
'enabled'
|
|
929
1854
|
],
|
|
930
1855
|
additionalProperties: false
|
|
931
1856
|
},
|
|
@@ -933,16 +1858,18 @@ export const FleetUpdateInputSchema = {
|
|
|
933
1858
|
type: 'object',
|
|
934
1859
|
properties: {
|
|
935
1860
|
enabled: {
|
|
936
|
-
type: 'boolean'
|
|
937
|
-
default: true
|
|
1861
|
+
type: 'boolean'
|
|
938
1862
|
},
|
|
939
1863
|
apiKey: {
|
|
940
1864
|
type: 'string',
|
|
941
|
-
|
|
1865
|
+
maxLength: 64,
|
|
1866
|
+
minLength: 64,
|
|
1867
|
+
pattern: '^([A-Za-z0-9]{64}|\\*{64})$',
|
|
1868
|
+
description: 'Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.'
|
|
942
1869
|
}
|
|
943
1870
|
},
|
|
944
1871
|
required: [
|
|
945
|
-
'
|
|
1872
|
+
'enabled'
|
|
946
1873
|
],
|
|
947
1874
|
additionalProperties: false
|
|
948
1875
|
},
|
|
@@ -950,20 +1877,348 @@ export const FleetUpdateInputSchema = {
|
|
|
950
1877
|
type: 'object',
|
|
951
1878
|
properties: {
|
|
952
1879
|
enabled: {
|
|
953
|
-
type: 'boolean'
|
|
954
|
-
default: true
|
|
1880
|
+
type: 'boolean'
|
|
955
1881
|
},
|
|
956
1882
|
controllerRoleArn: {
|
|
957
1883
|
type: 'string',
|
|
958
|
-
|
|
1884
|
+
pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
|
|
1885
|
+
description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
|
|
1886
|
+
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
959
1887
|
}
|
|
960
1888
|
},
|
|
961
1889
|
required: [
|
|
962
|
-
'
|
|
1890
|
+
'enabled'
|
|
963
1891
|
],
|
|
964
1892
|
additionalProperties: false
|
|
1893
|
+
},
|
|
1894
|
+
constraints: {
|
|
1895
|
+
type: 'object',
|
|
1896
|
+
properties: {
|
|
1897
|
+
'karpenter.sh/capacity-type': {
|
|
1898
|
+
type: 'array',
|
|
1899
|
+
items: {
|
|
1900
|
+
type: 'string',
|
|
1901
|
+
enum: [
|
|
1902
|
+
'on-demand',
|
|
1903
|
+
'spot'
|
|
1904
|
+
]
|
|
1905
|
+
},
|
|
1906
|
+
minItems: 1,
|
|
1907
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1908
|
+
default: [
|
|
1909
|
+
'on-demand',
|
|
1910
|
+
'spot'
|
|
1911
|
+
]
|
|
1912
|
+
},
|
|
1913
|
+
'kubernetes.io/arch': {
|
|
1914
|
+
type: 'array',
|
|
1915
|
+
items: {
|
|
1916
|
+
type: 'string',
|
|
1917
|
+
enum: [
|
|
1918
|
+
'amd64',
|
|
1919
|
+
'arm64'
|
|
1920
|
+
]
|
|
1921
|
+
},
|
|
1922
|
+
minItems: 1,
|
|
1923
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1924
|
+
default: [
|
|
1925
|
+
'amd64'
|
|
1926
|
+
]
|
|
1927
|
+
},
|
|
1928
|
+
'cfke.io/instance-family': {
|
|
1929
|
+
type: 'array',
|
|
1930
|
+
items: {
|
|
1931
|
+
type: 'string',
|
|
1932
|
+
enum: [
|
|
1933
|
+
'a1',
|
|
1934
|
+
'a2',
|
|
1935
|
+
'a3',
|
|
1936
|
+
'a4',
|
|
1937
|
+
'c1',
|
|
1938
|
+
'c2',
|
|
1939
|
+
'c2d',
|
|
1940
|
+
'c3',
|
|
1941
|
+
'c3d',
|
|
1942
|
+
'c4',
|
|
1943
|
+
'c4a',
|
|
1944
|
+
'c4d',
|
|
1945
|
+
'c5',
|
|
1946
|
+
'c5a',
|
|
1947
|
+
'c5ad',
|
|
1948
|
+
'c5d',
|
|
1949
|
+
'c5n',
|
|
1950
|
+
'c6a',
|
|
1951
|
+
'c6g',
|
|
1952
|
+
'c6gd',
|
|
1953
|
+
'c6gn',
|
|
1954
|
+
'c6i',
|
|
1955
|
+
'c6id',
|
|
1956
|
+
'c6in',
|
|
1957
|
+
'c7a',
|
|
1958
|
+
'c7g',
|
|
1959
|
+
'c7gd',
|
|
1960
|
+
'c7gn',
|
|
1961
|
+
'c7i',
|
|
1962
|
+
'c7i-flex',
|
|
1963
|
+
'c8g',
|
|
1964
|
+
'c8gd',
|
|
1965
|
+
'cax',
|
|
1966
|
+
'ccx',
|
|
1967
|
+
'cpx',
|
|
1968
|
+
'cx',
|
|
1969
|
+
'd2',
|
|
1970
|
+
'd3',
|
|
1971
|
+
'd3en',
|
|
1972
|
+
'dl1',
|
|
1973
|
+
'dl2q',
|
|
1974
|
+
'e2',
|
|
1975
|
+
'f1',
|
|
1976
|
+
'f2',
|
|
1977
|
+
'g1',
|
|
1978
|
+
'g2',
|
|
1979
|
+
'g4ad',
|
|
1980
|
+
'g4dn',
|
|
1981
|
+
'g5',
|
|
1982
|
+
'g5g',
|
|
1983
|
+
'g6',
|
|
1984
|
+
'g6e',
|
|
1985
|
+
'gr6',
|
|
1986
|
+
'h1',
|
|
1987
|
+
'h3',
|
|
1988
|
+
'hpc6a',
|
|
1989
|
+
'hpc6id',
|
|
1990
|
+
'hpc7a',
|
|
1991
|
+
'hpc7g',
|
|
1992
|
+
'i2',
|
|
1993
|
+
'i3',
|
|
1994
|
+
'i3en',
|
|
1995
|
+
'i4g',
|
|
1996
|
+
'i4i',
|
|
1997
|
+
'i7i',
|
|
1998
|
+
'i7ie',
|
|
1999
|
+
'i8g',
|
|
2000
|
+
'im4gn',
|
|
2001
|
+
'inf1',
|
|
2002
|
+
'inf2',
|
|
2003
|
+
'is4gen',
|
|
2004
|
+
'm1',
|
|
2005
|
+
'm2',
|
|
2006
|
+
'm3',
|
|
2007
|
+
'm4',
|
|
2008
|
+
'm5',
|
|
2009
|
+
'm5a',
|
|
2010
|
+
'm5ad',
|
|
2011
|
+
'm5d',
|
|
2012
|
+
'm5dn',
|
|
2013
|
+
'm5n',
|
|
2014
|
+
'm5zn',
|
|
2015
|
+
'm6a',
|
|
2016
|
+
'm6g',
|
|
2017
|
+
'm6gd',
|
|
2018
|
+
'm6i',
|
|
2019
|
+
'm6id',
|
|
2020
|
+
'm6idn',
|
|
2021
|
+
'm6in',
|
|
2022
|
+
'm7a',
|
|
2023
|
+
'm7g',
|
|
2024
|
+
'm7gd',
|
|
2025
|
+
'm7i',
|
|
2026
|
+
'm7i-flex',
|
|
2027
|
+
'm8g',
|
|
2028
|
+
'm8gd',
|
|
2029
|
+
'n1',
|
|
2030
|
+
'n2',
|
|
2031
|
+
'n2d',
|
|
2032
|
+
'n4',
|
|
2033
|
+
'p3',
|
|
2034
|
+
'p3dn',
|
|
2035
|
+
'p4d',
|
|
2036
|
+
'p4de',
|
|
2037
|
+
'p5',
|
|
2038
|
+
'p5e',
|
|
2039
|
+
'p5en',
|
|
2040
|
+
'p6-b200',
|
|
2041
|
+
'r3',
|
|
2042
|
+
'r4',
|
|
2043
|
+
'r5',
|
|
2044
|
+
'r5a',
|
|
2045
|
+
'r5ad',
|
|
2046
|
+
'r5b',
|
|
2047
|
+
'r5d',
|
|
2048
|
+
'r5dn',
|
|
2049
|
+
'r5n',
|
|
2050
|
+
'r6a',
|
|
2051
|
+
'r6g',
|
|
2052
|
+
'r6gd',
|
|
2053
|
+
'r6i',
|
|
2054
|
+
'r6id',
|
|
2055
|
+
'r6idn',
|
|
2056
|
+
'r6in',
|
|
2057
|
+
'r7a',
|
|
2058
|
+
'r7g',
|
|
2059
|
+
'r7gd',
|
|
2060
|
+
'r7i',
|
|
2061
|
+
'r7iz',
|
|
2062
|
+
'r8g',
|
|
2063
|
+
'r8gd',
|
|
2064
|
+
't2',
|
|
2065
|
+
't2a',
|
|
2066
|
+
't2d',
|
|
2067
|
+
't3',
|
|
2068
|
+
't3a',
|
|
2069
|
+
't4g',
|
|
2070
|
+
'trn1',
|
|
2071
|
+
'trn1n',
|
|
2072
|
+
'u-3tb1',
|
|
2073
|
+
'u-6tb1',
|
|
2074
|
+
'u7i-12tb',
|
|
2075
|
+
'u7i-6tb',
|
|
2076
|
+
'u7i-8tb',
|
|
2077
|
+
'u7in-16tb',
|
|
2078
|
+
'u7in-24tb',
|
|
2079
|
+
'u7in-32tb',
|
|
2080
|
+
'vt1',
|
|
2081
|
+
'x1',
|
|
2082
|
+
'x1e',
|
|
2083
|
+
'x2gd',
|
|
2084
|
+
'x2idn',
|
|
2085
|
+
'x2iedn',
|
|
2086
|
+
'x2iezn',
|
|
2087
|
+
'x4',
|
|
2088
|
+
'x8g',
|
|
2089
|
+
'z1d',
|
|
2090
|
+
'z3'
|
|
2091
|
+
]
|
|
2092
|
+
},
|
|
2093
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
2094
|
+
default: []
|
|
2095
|
+
},
|
|
2096
|
+
'topology.kubernetes.io/region': {
|
|
2097
|
+
type: 'array',
|
|
2098
|
+
items: {
|
|
2099
|
+
type: 'string',
|
|
2100
|
+
enum: [
|
|
2101
|
+
'africa-south1',
|
|
2102
|
+
'ap-northeast-1',
|
|
2103
|
+
'ap-northeast-2',
|
|
2104
|
+
'ap-northeast-3',
|
|
2105
|
+
'ap-south-1',
|
|
2106
|
+
'ap-southeast-1',
|
|
2107
|
+
'ap-southeast-2',
|
|
2108
|
+
'ash',
|
|
2109
|
+
'asia-east1',
|
|
2110
|
+
'asia-east2',
|
|
2111
|
+
'asia-northeast1',
|
|
2112
|
+
'asia-northeast2',
|
|
2113
|
+
'asia-northeast3',
|
|
2114
|
+
'asia-south1',
|
|
2115
|
+
'asia-south2',
|
|
2116
|
+
'asia-southeast1',
|
|
2117
|
+
'asia-southeast2',
|
|
2118
|
+
'australia-southeast1',
|
|
2119
|
+
'australia-southeast2',
|
|
2120
|
+
'ca-central-1',
|
|
2121
|
+
'eu-central-1',
|
|
2122
|
+
'eu-central-2',
|
|
2123
|
+
'eu-north-1',
|
|
2124
|
+
'eu-west-1',
|
|
2125
|
+
'eu-west-2',
|
|
2126
|
+
'eu-west-3',
|
|
2127
|
+
'europe-central2',
|
|
2128
|
+
'europe-north1',
|
|
2129
|
+
'europe-southwest1',
|
|
2130
|
+
'europe-west1',
|
|
2131
|
+
'europe-west10',
|
|
2132
|
+
'europe-west12',
|
|
2133
|
+
'europe-west2',
|
|
2134
|
+
'europe-west3',
|
|
2135
|
+
'europe-west4',
|
|
2136
|
+
'europe-west6',
|
|
2137
|
+
'europe-west8',
|
|
2138
|
+
'europe-west9',
|
|
2139
|
+
'fsn1',
|
|
2140
|
+
'hel1',
|
|
2141
|
+
'hil',
|
|
2142
|
+
'me-central1',
|
|
2143
|
+
'me-central2',
|
|
2144
|
+
'me-west1',
|
|
2145
|
+
'nbg1',
|
|
2146
|
+
'northamerica-northeast1',
|
|
2147
|
+
'northamerica-northeast2',
|
|
2148
|
+
'sa-east-1',
|
|
2149
|
+
'sin',
|
|
2150
|
+
'southamerica-east1',
|
|
2151
|
+
'southamerica-west1',
|
|
2152
|
+
'us-central1',
|
|
2153
|
+
'us-east-1',
|
|
2154
|
+
'us-east-2',
|
|
2155
|
+
'us-east1',
|
|
2156
|
+
'us-east4',
|
|
2157
|
+
'us-east5',
|
|
2158
|
+
'us-south1',
|
|
2159
|
+
'us-west-1',
|
|
2160
|
+
'us-west-2',
|
|
2161
|
+
'us-west1',
|
|
2162
|
+
'us-west2',
|
|
2163
|
+
'us-west3',
|
|
2164
|
+
'us-west4'
|
|
2165
|
+
]
|
|
2166
|
+
},
|
|
2167
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
2168
|
+
default: []
|
|
2169
|
+
}
|
|
2170
|
+
},
|
|
2171
|
+
additionalProperties: false,
|
|
2172
|
+
description: 'Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.',
|
|
2173
|
+
default: {
|
|
2174
|
+
'karpenter.sh/capacity-type': [
|
|
2175
|
+
'on-demand',
|
|
2176
|
+
'spot'
|
|
2177
|
+
],
|
|
2178
|
+
'kubernetes.io/arch': [
|
|
2179
|
+
'amd64'
|
|
2180
|
+
],
|
|
2181
|
+
'cfke.io/instance-family': [],
|
|
2182
|
+
'topology.kubernetes.io/region': []
|
|
2183
|
+
}
|
|
2184
|
+
},
|
|
2185
|
+
scalingProfile: {
|
|
2186
|
+
type: 'string',
|
|
2187
|
+
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).',
|
|
2188
|
+
default: 'conservative',
|
|
2189
|
+
example: 'conservative',
|
|
2190
|
+
enum: [
|
|
2191
|
+
'aggressive',
|
|
2192
|
+
'conservative'
|
|
2193
|
+
]
|
|
965
2194
|
}
|
|
966
2195
|
},
|
|
2196
|
+
additionalProperties: false,
|
|
2197
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
2198
|
+
};
|
|
2199
|
+
export const InviteCreateInputSchema = {
|
|
2200
|
+
type: 'object',
|
|
2201
|
+
properties: {
|
|
2202
|
+
email: {
|
|
2203
|
+
type: 'string',
|
|
2204
|
+
format: 'email',
|
|
2205
|
+
description: 'Email address of the user to invite.',
|
|
2206
|
+
example: 'email@example.com'
|
|
2207
|
+
},
|
|
2208
|
+
role: {
|
|
2209
|
+
type: 'string',
|
|
2210
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2211
|
+
default: 'User',
|
|
2212
|
+
example: 'User',
|
|
2213
|
+
enum: [
|
|
2214
|
+
'Administrator',
|
|
2215
|
+
'User'
|
|
2216
|
+
]
|
|
2217
|
+
}
|
|
2218
|
+
},
|
|
2219
|
+
required: [
|
|
2220
|
+
'email'
|
|
2221
|
+
],
|
|
967
2222
|
additionalProperties: false
|
|
968
2223
|
};
|
|
969
2224
|
export const InviteSchema = {
|
|
@@ -996,6 +2251,16 @@ export const InviteSchema = {
|
|
|
996
2251
|
type: 'string',
|
|
997
2252
|
description: 'Generated unique invite code.',
|
|
998
2253
|
example: '7kUZnH7nnKUFfvc4NK2KQF'
|
|
2254
|
+
},
|
|
2255
|
+
role: {
|
|
2256
|
+
type: 'string',
|
|
2257
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2258
|
+
default: 'User',
|
|
2259
|
+
example: 'User',
|
|
2260
|
+
enum: [
|
|
2261
|
+
'Administrator',
|
|
2262
|
+
'User'
|
|
2263
|
+
]
|
|
999
2264
|
}
|
|
1000
2265
|
},
|
|
1001
2266
|
required: [
|
|
@@ -1003,6 +2268,170 @@ export const InviteSchema = {
|
|
|
1003
2268
|
],
|
|
1004
2269
|
additionalProperties: false
|
|
1005
2270
|
};
|
|
2271
|
+
export const InvoicePaymentAttemptSchema = {
|
|
2272
|
+
type: 'object',
|
|
2273
|
+
properties: {
|
|
2274
|
+
invoice_id: {
|
|
2275
|
+
type: 'string',
|
|
2276
|
+
description: 'Identifier of the invoice.',
|
|
2277
|
+
example: 'in_1234567890xCrwxghOTj1234'
|
|
2278
|
+
},
|
|
2279
|
+
number: {
|
|
2280
|
+
type: 'string',
|
|
2281
|
+
nullable: true,
|
|
2282
|
+
description: 'Invoice number. Null if the invoice has no number.',
|
|
2283
|
+
example: 'CF-0042'
|
|
2284
|
+
},
|
|
2285
|
+
amount: {
|
|
2286
|
+
type: 'number',
|
|
2287
|
+
format: 'float',
|
|
2288
|
+
description: 'Amount outstanding when the charge was attempted, in the smallest currency unit.',
|
|
2289
|
+
example: 4200
|
|
2290
|
+
},
|
|
2291
|
+
currency: {
|
|
2292
|
+
type: 'string',
|
|
2293
|
+
description: 'Currency of the invoice.',
|
|
2294
|
+
example: 'eur'
|
|
2295
|
+
},
|
|
2296
|
+
status: {
|
|
2297
|
+
type: 'string',
|
|
2298
|
+
description: 'Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).',
|
|
2299
|
+
example: 'paid',
|
|
2300
|
+
enum: [
|
|
2301
|
+
'paid',
|
|
2302
|
+
'processing',
|
|
2303
|
+
'requires_action',
|
|
2304
|
+
'failed'
|
|
2305
|
+
]
|
|
2306
|
+
},
|
|
2307
|
+
client_secret: {
|
|
2308
|
+
type: 'string',
|
|
2309
|
+
nullable: true,
|
|
2310
|
+
description: 'Client secret used to complete customer authentication. Set only when `status` is `requires_action`.',
|
|
2311
|
+
example: 'pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH'
|
|
2312
|
+
},
|
|
2313
|
+
failure_code: {
|
|
2314
|
+
type: 'string',
|
|
2315
|
+
nullable: true,
|
|
2316
|
+
description: 'Decline code. Set only when `status` is `failed`.',
|
|
2317
|
+
example: 'insufficient_funds'
|
|
2318
|
+
},
|
|
2319
|
+
failure_message: {
|
|
2320
|
+
type: 'string',
|
|
2321
|
+
nullable: true,
|
|
2322
|
+
description: 'Explanation of the decline, suitable for display. Set only when `status` is `failed`.',
|
|
2323
|
+
example: 'Your card has insufficient funds.'
|
|
2324
|
+
}
|
|
2325
|
+
},
|
|
2326
|
+
required: [
|
|
2327
|
+
'invoice_id',
|
|
2328
|
+
'number',
|
|
2329
|
+
'amount',
|
|
2330
|
+
'currency',
|
|
2331
|
+
'status',
|
|
2332
|
+
'client_secret',
|
|
2333
|
+
'failure_code',
|
|
2334
|
+
'failure_message'
|
|
2335
|
+
],
|
|
2336
|
+
additionalProperties: false
|
|
2337
|
+
};
|
|
2338
|
+
export const InvoicePaymentResultSchema = {
|
|
2339
|
+
type: 'object',
|
|
2340
|
+
properties: {
|
|
2341
|
+
code: {
|
|
2342
|
+
type: 'string',
|
|
2343
|
+
description: 'Overall outcome: `paid` (nothing outstanding), `processing` (all accepted, not yet settled), `action_required` (one or more await customer authentication), `partially_paid`, `failed`, `nothing_due`, or `bank_transfer_due` (the organization pays by bank transfer; nothing was charged).',
|
|
2344
|
+
example: 'partially_paid',
|
|
2345
|
+
enum: [
|
|
2346
|
+
'paid',
|
|
2347
|
+
'processing',
|
|
2348
|
+
'action_required',
|
|
2349
|
+
'partially_paid',
|
|
2350
|
+
'failed',
|
|
2351
|
+
'nothing_due',
|
|
2352
|
+
'bank_transfer_due'
|
|
2353
|
+
]
|
|
2354
|
+
},
|
|
2355
|
+
message: {
|
|
2356
|
+
type: 'string',
|
|
2357
|
+
description: 'Summary of the outcome, suitable for display.',
|
|
2358
|
+
example: '1 of 2 open invoices was paid. Invoice CF-0043 was declined: Your card has insufficient funds.'
|
|
2359
|
+
},
|
|
2360
|
+
results: {
|
|
2361
|
+
type: 'array',
|
|
2362
|
+
items: {
|
|
2363
|
+
type: 'object',
|
|
2364
|
+
properties: {
|
|
2365
|
+
invoice_id: {
|
|
2366
|
+
type: 'string',
|
|
2367
|
+
description: 'Identifier of the invoice.',
|
|
2368
|
+
example: 'in_1234567890xCrwxghOTj1234'
|
|
2369
|
+
},
|
|
2370
|
+
number: {
|
|
2371
|
+
type: 'string',
|
|
2372
|
+
description: 'Invoice number. Null if the invoice has no number.',
|
|
2373
|
+
example: 'CF-0042'
|
|
2374
|
+
},
|
|
2375
|
+
amount: {
|
|
2376
|
+
type: 'number',
|
|
2377
|
+
format: 'float',
|
|
2378
|
+
description: 'Amount outstanding when the charge was attempted, in the smallest currency unit.',
|
|
2379
|
+
example: 4200
|
|
2380
|
+
},
|
|
2381
|
+
currency: {
|
|
2382
|
+
type: 'string',
|
|
2383
|
+
description: 'Currency of the invoice.',
|
|
2384
|
+
example: 'eur'
|
|
2385
|
+
},
|
|
2386
|
+
status: {
|
|
2387
|
+
type: 'string',
|
|
2388
|
+
description: 'Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).',
|
|
2389
|
+
example: 'paid',
|
|
2390
|
+
enum: [
|
|
2391
|
+
'paid',
|
|
2392
|
+
'processing',
|
|
2393
|
+
'requires_action',
|
|
2394
|
+
'failed'
|
|
2395
|
+
]
|
|
2396
|
+
},
|
|
2397
|
+
client_secret: {
|
|
2398
|
+
type: 'string',
|
|
2399
|
+
description: 'Client secret used to complete customer authentication. Set only when `status` is `requires_action`.',
|
|
2400
|
+
example: 'pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH'
|
|
2401
|
+
},
|
|
2402
|
+
failure_code: {
|
|
2403
|
+
type: 'string',
|
|
2404
|
+
description: 'Decline code. Set only when `status` is `failed`.',
|
|
2405
|
+
example: 'insufficient_funds'
|
|
2406
|
+
},
|
|
2407
|
+
failure_message: {
|
|
2408
|
+
type: 'string',
|
|
2409
|
+
description: 'Explanation of the decline, suitable for display. Set only when `status` is `failed`.',
|
|
2410
|
+
example: 'Your card has insufficient funds.'
|
|
2411
|
+
}
|
|
2412
|
+
},
|
|
2413
|
+
required: [
|
|
2414
|
+
'invoice_id',
|
|
2415
|
+
'number',
|
|
2416
|
+
'amount',
|
|
2417
|
+
'currency',
|
|
2418
|
+
'status',
|
|
2419
|
+
'client_secret',
|
|
2420
|
+
'failure_code',
|
|
2421
|
+
'failure_message'
|
|
2422
|
+
],
|
|
2423
|
+
additionalProperties: false
|
|
2424
|
+
},
|
|
2425
|
+
description: 'One entry per invoice charged, oldest first.'
|
|
2426
|
+
}
|
|
2427
|
+
},
|
|
2428
|
+
required: [
|
|
2429
|
+
'code',
|
|
2430
|
+
'message',
|
|
2431
|
+
'results'
|
|
2432
|
+
],
|
|
2433
|
+
additionalProperties: false
|
|
2434
|
+
};
|
|
1006
2435
|
export const InvoiceSchema = {
|
|
1007
2436
|
type: 'object',
|
|
1008
2437
|
properties: {
|
|
@@ -1216,6 +2645,15 @@ export const MarketplaceListingSchema = {
|
|
|
1216
2645
|
export const OrganizationCreateInputSchema = {
|
|
1217
2646
|
type: 'object',
|
|
1218
2647
|
properties: {
|
|
2648
|
+
type: {
|
|
2649
|
+
type: 'string',
|
|
2650
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2651
|
+
example: 'business',
|
|
2652
|
+
enum: [
|
|
2653
|
+
'business',
|
|
2654
|
+
'personal'
|
|
2655
|
+
]
|
|
2656
|
+
},
|
|
1219
2657
|
email: {
|
|
1220
2658
|
type: 'string',
|
|
1221
2659
|
format: 'email',
|
|
@@ -1224,11 +2662,13 @@ export const OrganizationCreateInputSchema = {
|
|
|
1224
2662
|
},
|
|
1225
2663
|
first_name: {
|
|
1226
2664
|
type: 'string',
|
|
2665
|
+
minLength: 1,
|
|
1227
2666
|
description: 'First name of the billing contact person.',
|
|
1228
2667
|
example: 'John'
|
|
1229
2668
|
},
|
|
1230
2669
|
last_name: {
|
|
1231
2670
|
type: 'string',
|
|
2671
|
+
minLength: 1,
|
|
1232
2672
|
description: 'Last name of the billing contact person.',
|
|
1233
2673
|
example: 'Doe'
|
|
1234
2674
|
},
|
|
@@ -1247,6 +2687,7 @@ export const OrganizationCreateInputSchema = {
|
|
|
1247
2687
|
}
|
|
1248
2688
|
},
|
|
1249
2689
|
required: [
|
|
2690
|
+
'type',
|
|
1250
2691
|
'email',
|
|
1251
2692
|
'first_name',
|
|
1252
2693
|
'last_name',
|
|
@@ -1255,6 +2696,20 @@ export const OrganizationCreateInputSchema = {
|
|
|
1255
2696
|
],
|
|
1256
2697
|
additionalProperties: false
|
|
1257
2698
|
};
|
|
2699
|
+
export const OrganizationCreateOutputSchema = {
|
|
2700
|
+
type: 'object',
|
|
2701
|
+
properties: {
|
|
2702
|
+
id: {
|
|
2703
|
+
type: 'string',
|
|
2704
|
+
description: 'Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.',
|
|
2705
|
+
example: 'organization-id'
|
|
2706
|
+
}
|
|
2707
|
+
},
|
|
2708
|
+
required: [
|
|
2709
|
+
'id'
|
|
2710
|
+
],
|
|
2711
|
+
additionalProperties: false
|
|
2712
|
+
};
|
|
1258
2713
|
export const OrganizationSchema = {
|
|
1259
2714
|
type: 'object',
|
|
1260
2715
|
properties: {
|
|
@@ -1271,6 +2726,15 @@ export const OrganizationSchema = {
|
|
|
1271
2726
|
description: 'Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.',
|
|
1272
2727
|
example: 'ACME Corp.'
|
|
1273
2728
|
},
|
|
2729
|
+
type: {
|
|
2730
|
+
type: 'string',
|
|
2731
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2732
|
+
example: 'business',
|
|
2733
|
+
enum: [
|
|
2734
|
+
'business',
|
|
2735
|
+
'personal'
|
|
2736
|
+
]
|
|
2737
|
+
},
|
|
1274
2738
|
date_created: {
|
|
1275
2739
|
type: 'string',
|
|
1276
2740
|
format: 'date-time',
|
|
@@ -1302,6 +2766,17 @@ export const OrganizationSchema = {
|
|
|
1302
2766
|
description: 'Available number of Pro clusters that can be created.',
|
|
1303
2767
|
example: 999
|
|
1304
2768
|
},
|
|
2769
|
+
enterprise_clusters_max: {
|
|
2770
|
+
type: 'integer',
|
|
2771
|
+
minimum: 0,
|
|
2772
|
+
description: 'Maximum number of Enterprise clusters that can be created.',
|
|
2773
|
+
example: 999
|
|
2774
|
+
},
|
|
2775
|
+
enterprise_clusters_available: {
|
|
2776
|
+
type: 'integer',
|
|
2777
|
+
description: 'Available number of Enterprise clusters that can be created.',
|
|
2778
|
+
example: 999
|
|
2779
|
+
},
|
|
1305
2780
|
fleets_max: {
|
|
1306
2781
|
type: 'integer',
|
|
1307
2782
|
minimum: 0,
|
|
@@ -1321,7 +2796,7 @@ export const OrganizationSchema = {
|
|
|
1321
2796
|
type: 'array',
|
|
1322
2797
|
items: {
|
|
1323
2798
|
type: 'string',
|
|
1324
|
-
example: 'northamerica-central-
|
|
2799
|
+
example: 'northamerica-central-1a'
|
|
1325
2800
|
},
|
|
1326
2801
|
minItems: 1,
|
|
1327
2802
|
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
@@ -1351,18 +2826,6 @@ export const OrganizationSchema = {
|
|
|
1351
2826
|
minItems: 1,
|
|
1352
2827
|
description: 'List of CFKE control plane versions available for the organization.'
|
|
1353
2828
|
},
|
|
1354
|
-
copilot_user_hourly_tokens: {
|
|
1355
|
-
type: 'integer',
|
|
1356
|
-
minimum: 0,
|
|
1357
|
-
description: 'User-level maximum number of tokens Cloudfleet Copilot can process per hour.',
|
|
1358
|
-
example: 42000
|
|
1359
|
-
},
|
|
1360
|
-
copilot_organization_hourly_tokens: {
|
|
1361
|
-
type: 'integer',
|
|
1362
|
-
minimum: 0,
|
|
1363
|
-
description: 'Organization-level maximum number of tokens Cloudfleet Copilot can process per hour.',
|
|
1364
|
-
example: 242000
|
|
1365
|
-
},
|
|
1366
2829
|
cfcr_storage_gb: {
|
|
1367
2830
|
type: 'integer',
|
|
1368
2831
|
minimum: -1,
|
|
@@ -1375,12 +2838,12 @@ export const OrganizationSchema = {
|
|
|
1375
2838
|
'basic_clusters_available',
|
|
1376
2839
|
'pro_clusters_max',
|
|
1377
2840
|
'pro_clusters_available',
|
|
2841
|
+
'enterprise_clusters_max',
|
|
2842
|
+
'enterprise_clusters_available',
|
|
1378
2843
|
'fleets_max',
|
|
1379
2844
|
'cluster_tiers',
|
|
1380
2845
|
'regions',
|
|
1381
2846
|
'versions',
|
|
1382
|
-
'copilot_user_hourly_tokens',
|
|
1383
|
-
'copilot_organization_hourly_tokens',
|
|
1384
2847
|
'cfcr_storage_gb'
|
|
1385
2848
|
],
|
|
1386
2849
|
additionalProperties: false,
|
|
@@ -1394,13 +2857,25 @@ export const OrganizationSchema = {
|
|
|
1394
2857
|
'closed',
|
|
1395
2858
|
'suspended'
|
|
1396
2859
|
]
|
|
2860
|
+
},
|
|
2861
|
+
verification: {
|
|
2862
|
+
type: 'string',
|
|
2863
|
+
description: 'Verification status of the organization, which determines the assigned quota. `none` when billing information is incomplete, `submitted` when billing information is complete but the organization is not yet verified, `verified` when the organization is verified.',
|
|
2864
|
+
example: 'verified',
|
|
2865
|
+
enum: [
|
|
2866
|
+
'none',
|
|
2867
|
+
'submitted',
|
|
2868
|
+
'verified'
|
|
2869
|
+
]
|
|
1397
2870
|
}
|
|
1398
2871
|
},
|
|
1399
2872
|
required: [
|
|
1400
2873
|
'id',
|
|
2874
|
+
'type',
|
|
1401
2875
|
'date_created',
|
|
1402
2876
|
'quota',
|
|
1403
|
-
'status'
|
|
2877
|
+
'status',
|
|
2878
|
+
'verification'
|
|
1404
2879
|
],
|
|
1405
2880
|
additionalProperties: false
|
|
1406
2881
|
};
|
|
@@ -1409,28 +2884,23 @@ export const PaymentMethodSchema = {
|
|
|
1409
2884
|
properties: {
|
|
1410
2885
|
id: {
|
|
1411
2886
|
type: 'string',
|
|
1412
|
-
|
|
1413
|
-
|
|
1414
|
-
example: 'e94d30ec-a2dd-4dcb-832c-ac2be144ba91'
|
|
1415
|
-
},
|
|
1416
|
-
setup: {
|
|
1417
|
-
type: 'boolean',
|
|
1418
|
-
description: 'Whether organization payment method was set up and ready to use for payments.',
|
|
1419
|
-
example: true
|
|
2887
|
+
description: 'Payment method identifier. Stripe payment method id for cards/SEPA; the constant `bank_transfer` for the invoice/bank-transfer method. Used to set as default or delete the payment method.',
|
|
2888
|
+
example: 'pm_1MtwBwLkdIwHu7ix28a3tqPa'
|
|
1420
2889
|
},
|
|
1421
2890
|
type: {
|
|
1422
2891
|
type: 'string',
|
|
1423
|
-
|
|
1424
|
-
description: 'Payment method type type. Only `card` payments supported at the moment.',
|
|
2892
|
+
description: 'Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.',
|
|
1425
2893
|
example: 'card',
|
|
1426
2894
|
enum: [
|
|
1427
|
-
'card'
|
|
2895
|
+
'card',
|
|
2896
|
+
'sepa_debit',
|
|
2897
|
+
'bank_transfer'
|
|
1428
2898
|
]
|
|
1429
2899
|
},
|
|
1430
2900
|
last4: {
|
|
1431
2901
|
type: 'string',
|
|
1432
2902
|
nullable: true,
|
|
1433
|
-
description: 'Last 4 digits of the payment card number.',
|
|
2903
|
+
description: 'Last 4 digits of the payment card number, of the bank account (IBAN) for SEPA Direct Debit, or of the destination IBAN for bank transfer.',
|
|
1434
2904
|
example: '4242'
|
|
1435
2905
|
},
|
|
1436
2906
|
exp_month: {
|
|
@@ -1438,42 +2908,56 @@ export const PaymentMethodSchema = {
|
|
|
1438
2908
|
minimum: 1,
|
|
1439
2909
|
maximum: 12,
|
|
1440
2910
|
nullable: true,
|
|
1441
|
-
description: 'Two-digit number representing the card\'s expiration month.',
|
|
1442
|
-
example:
|
|
2911
|
+
description: 'Two-digit number representing the card\'s expiration month. Null for SEPA Direct Debit and bank transfer.',
|
|
2912
|
+
example: 12
|
|
1443
2913
|
},
|
|
1444
2914
|
exp_year: {
|
|
1445
2915
|
type: 'integer',
|
|
1446
|
-
minimum: 2024,
|
|
1447
2916
|
nullable: true,
|
|
1448
|
-
description: 'Four-digit number representing the card\'s expiration year.',
|
|
1449
|
-
example:
|
|
2917
|
+
description: 'Four-digit number representing the card\'s expiration year. May be in the past for an expired card still on file. Null for SEPA Direct Debit and bank transfer.',
|
|
2918
|
+
example: 2028
|
|
1450
2919
|
},
|
|
1451
2920
|
brand: {
|
|
1452
2921
|
type: 'string',
|
|
1453
2922
|
nullable: true,
|
|
1454
|
-
description: 'Payment card brand
|
|
1455
|
-
example: 'visa'
|
|
1456
|
-
|
|
1457
|
-
|
|
1458
|
-
|
|
1459
|
-
|
|
1460
|
-
|
|
1461
|
-
|
|
1462
|
-
|
|
1463
|
-
|
|
1464
|
-
|
|
1465
|
-
|
|
1466
|
-
|
|
2923
|
+
description: 'Payment card brand as reported by Stripe, e.g. `visa`, `mastercard`, `amex`, `cartes_bancaires`, or `unknown`. Null for SEPA Direct Debit and bank transfer.',
|
|
2924
|
+
example: 'visa'
|
|
2925
|
+
},
|
|
2926
|
+
iban: {
|
|
2927
|
+
type: 'string',
|
|
2928
|
+
nullable: true,
|
|
2929
|
+
description: 'Full destination IBAN to send bank transfers to. Set only for `bank_transfer`; null otherwise. This is Cloudfleet\'s virtual receiving account, shown in full so the customer can pay into it.',
|
|
2930
|
+
example: 'DE11243015658023127510'
|
|
2931
|
+
},
|
|
2932
|
+
bic: {
|
|
2933
|
+
type: 'string',
|
|
2934
|
+
nullable: true,
|
|
2935
|
+
description: 'BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
2936
|
+
example: 'SOGEDEFFXXX'
|
|
2937
|
+
},
|
|
2938
|
+
account_holder_name: {
|
|
2939
|
+
type: 'string',
|
|
2940
|
+
nullable: true,
|
|
2941
|
+
description: 'Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
2942
|
+
example: 'Cloudfleet GmbH'
|
|
2943
|
+
},
|
|
2944
|
+
is_default: {
|
|
2945
|
+
type: 'boolean',
|
|
2946
|
+
description: 'Whether this payment method is the default used for invoices and active subscriptions. Always false for `bank_transfer` (it cannot be a Stripe default payment method).',
|
|
2947
|
+
example: true
|
|
1467
2948
|
}
|
|
1468
2949
|
},
|
|
1469
2950
|
required: [
|
|
1470
2951
|
'id',
|
|
1471
|
-
'setup',
|
|
1472
2952
|
'type',
|
|
1473
2953
|
'last4',
|
|
1474
2954
|
'exp_month',
|
|
1475
2955
|
'exp_year',
|
|
1476
|
-
'brand'
|
|
2956
|
+
'brand',
|
|
2957
|
+
'iban',
|
|
2958
|
+
'bic',
|
|
2959
|
+
'account_holder_name',
|
|
2960
|
+
'is_default'
|
|
1477
2961
|
],
|
|
1478
2962
|
additionalProperties: false
|
|
1479
2963
|
};
|
|
@@ -1502,6 +2986,17 @@ export const PlatformQuotaSchema = {
|
|
|
1502
2986
|
description: 'Available number of Pro clusters that can be created.',
|
|
1503
2987
|
example: 999
|
|
1504
2988
|
},
|
|
2989
|
+
enterprise_clusters_max: {
|
|
2990
|
+
type: 'integer',
|
|
2991
|
+
minimum: 0,
|
|
2992
|
+
description: 'Maximum number of Enterprise clusters that can be created.',
|
|
2993
|
+
example: 999
|
|
2994
|
+
},
|
|
2995
|
+
enterprise_clusters_available: {
|
|
2996
|
+
type: 'integer',
|
|
2997
|
+
description: 'Available number of Enterprise clusters that can be created.',
|
|
2998
|
+
example: 999
|
|
2999
|
+
},
|
|
1505
3000
|
fleets_max: {
|
|
1506
3001
|
type: 'integer',
|
|
1507
3002
|
minimum: 0,
|
|
@@ -1521,7 +3016,7 @@ export const PlatformQuotaSchema = {
|
|
|
1521
3016
|
type: 'array',
|
|
1522
3017
|
items: {
|
|
1523
3018
|
type: 'string',
|
|
1524
|
-
example: 'northamerica-central-
|
|
3019
|
+
example: 'northamerica-central-1a'
|
|
1525
3020
|
},
|
|
1526
3021
|
minItems: 1,
|
|
1527
3022
|
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
@@ -1551,18 +3046,6 @@ export const PlatformQuotaSchema = {
|
|
|
1551
3046
|
minItems: 1,
|
|
1552
3047
|
description: 'List of CFKE control plane versions available for the organization.'
|
|
1553
3048
|
},
|
|
1554
|
-
copilot_user_hourly_tokens: {
|
|
1555
|
-
type: 'integer',
|
|
1556
|
-
minimum: 0,
|
|
1557
|
-
description: 'User-level maximum number of tokens Cloudfleet Copilot can process per hour.',
|
|
1558
|
-
example: 42000
|
|
1559
|
-
},
|
|
1560
|
-
copilot_organization_hourly_tokens: {
|
|
1561
|
-
type: 'integer',
|
|
1562
|
-
minimum: 0,
|
|
1563
|
-
description: 'Organization-level maximum number of tokens Cloudfleet Copilot can process per hour.',
|
|
1564
|
-
example: 242000
|
|
1565
|
-
},
|
|
1566
3049
|
cfcr_storage_gb: {
|
|
1567
3050
|
type: 'integer',
|
|
1568
3051
|
minimum: -1,
|
|
@@ -1575,12 +3058,12 @@ export const PlatformQuotaSchema = {
|
|
|
1575
3058
|
'basic_clusters_available',
|
|
1576
3059
|
'pro_clusters_max',
|
|
1577
3060
|
'pro_clusters_available',
|
|
3061
|
+
'enterprise_clusters_max',
|
|
3062
|
+
'enterprise_clusters_available',
|
|
1578
3063
|
'fleets_max',
|
|
1579
3064
|
'cluster_tiers',
|
|
1580
3065
|
'regions',
|
|
1581
3066
|
'versions',
|
|
1582
|
-
'copilot_user_hourly_tokens',
|
|
1583
|
-
'copilot_organization_hourly_tokens',
|
|
1584
3067
|
'cfcr_storage_gb'
|
|
1585
3068
|
],
|
|
1586
3069
|
additionalProperties: false
|
|
@@ -1850,6 +3333,329 @@ export const RegistryTagSchema = {
|
|
|
1850
3333
|
],
|
|
1851
3334
|
additionalProperties: false
|
|
1852
3335
|
};
|
|
3336
|
+
export const TicketAttachmentSchema = {
|
|
3337
|
+
type: 'object',
|
|
3338
|
+
properties: {
|
|
3339
|
+
id: {
|
|
3340
|
+
type: 'string',
|
|
3341
|
+
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
3342
|
+
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
3343
|
+
},
|
|
3344
|
+
filename: {
|
|
3345
|
+
type: 'string',
|
|
3346
|
+
description: 'Original filename as uploaded.',
|
|
3347
|
+
example: 'debug.log'
|
|
3348
|
+
},
|
|
3349
|
+
content_type: {
|
|
3350
|
+
type: 'string',
|
|
3351
|
+
description: 'MIME content type of the attachment.',
|
|
3352
|
+
example: 'text/plain'
|
|
3353
|
+
},
|
|
3354
|
+
size: {
|
|
3355
|
+
type: 'integer',
|
|
3356
|
+
description: 'Size of the attachment in bytes.',
|
|
3357
|
+
example: 12345
|
|
3358
|
+
}
|
|
3359
|
+
},
|
|
3360
|
+
required: [
|
|
3361
|
+
'id',
|
|
3362
|
+
'filename',
|
|
3363
|
+
'content_type',
|
|
3364
|
+
'size'
|
|
3365
|
+
],
|
|
3366
|
+
additionalProperties: false
|
|
3367
|
+
};
|
|
3368
|
+
export const TicketCreateInputSchema = {
|
|
3369
|
+
type: 'object',
|
|
3370
|
+
properties: {
|
|
3371
|
+
category: {
|
|
3372
|
+
type: 'string',
|
|
3373
|
+
description: 'Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.',
|
|
3374
|
+
example: 'technical',
|
|
3375
|
+
enum: [
|
|
3376
|
+
'billing',
|
|
3377
|
+
'technical',
|
|
3378
|
+
'general'
|
|
3379
|
+
]
|
|
3380
|
+
},
|
|
3381
|
+
body: {
|
|
3382
|
+
type: 'string',
|
|
3383
|
+
maxLength: 50000,
|
|
3384
|
+
minLength: 1,
|
|
3385
|
+
pattern: '\\S',
|
|
3386
|
+
description: 'Initial message body in markdown. There is no separate subject — the first message body is the description.',
|
|
3387
|
+
example: 'My cluster cannot reach the registry. Logs attached.'
|
|
3388
|
+
},
|
|
3389
|
+
properties: {
|
|
3390
|
+
type: 'object',
|
|
3391
|
+
additionalProperties: true,
|
|
3392
|
+
description: 'Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).',
|
|
3393
|
+
example: {
|
|
3394
|
+
subcategory: 'cluster-question',
|
|
3395
|
+
cluster_id: '60c72b2f9f1b2c001f8e4d3a'
|
|
3396
|
+
}
|
|
3397
|
+
}
|
|
3398
|
+
},
|
|
3399
|
+
required: [
|
|
3400
|
+
'category',
|
|
3401
|
+
'body'
|
|
3402
|
+
],
|
|
3403
|
+
additionalProperties: false
|
|
3404
|
+
};
|
|
3405
|
+
export const TicketMessageInputSchema = {
|
|
3406
|
+
type: 'object',
|
|
3407
|
+
properties: {
|
|
3408
|
+
body: {
|
|
3409
|
+
type: 'string',
|
|
3410
|
+
maxLength: 50000,
|
|
3411
|
+
minLength: 1,
|
|
3412
|
+
pattern: '\\S',
|
|
3413
|
+
description: 'Reply body in markdown.',
|
|
3414
|
+
example: 'Thanks — that resolved it on my side.'
|
|
3415
|
+
}
|
|
3416
|
+
},
|
|
3417
|
+
required: [
|
|
3418
|
+
'body'
|
|
3419
|
+
],
|
|
3420
|
+
additionalProperties: false
|
|
3421
|
+
};
|
|
3422
|
+
export const TicketMessageSchema = {
|
|
3423
|
+
type: 'object',
|
|
3424
|
+
properties: {
|
|
3425
|
+
id: {
|
|
3426
|
+
type: 'string',
|
|
3427
|
+
description: 'Unique identifier of the message (Mongo ObjectId).',
|
|
3428
|
+
example: '60c72b2f9f1b2c001f8e4d3b'
|
|
3429
|
+
},
|
|
3430
|
+
type: {
|
|
3431
|
+
type: 'string',
|
|
3432
|
+
description: 'Message type. Internal notes are filtered out of customer-facing responses.',
|
|
3433
|
+
example: 'customer_reply',
|
|
3434
|
+
enum: [
|
|
3435
|
+
'customer_reply',
|
|
3436
|
+
'agent_reply'
|
|
3437
|
+
]
|
|
3438
|
+
},
|
|
3439
|
+
body: {
|
|
3440
|
+
type: 'string',
|
|
3441
|
+
description: 'Message body in markdown.',
|
|
3442
|
+
example: 'Thanks — that resolved it on my side.'
|
|
3443
|
+
},
|
|
3444
|
+
author_first_name: {
|
|
3445
|
+
type: 'string',
|
|
3446
|
+
nullable: true,
|
|
3447
|
+
description: 'First name of the author. Null when not provided.',
|
|
3448
|
+
example: 'Jane'
|
|
3449
|
+
},
|
|
3450
|
+
author_last_name: {
|
|
3451
|
+
type: 'string',
|
|
3452
|
+
nullable: true,
|
|
3453
|
+
description: 'Last name of the author. Null when not provided.',
|
|
3454
|
+
example: 'Doe'
|
|
3455
|
+
},
|
|
3456
|
+
attachments: {
|
|
3457
|
+
type: 'array',
|
|
3458
|
+
items: {
|
|
3459
|
+
type: 'object',
|
|
3460
|
+
properties: {
|
|
3461
|
+
id: {
|
|
3462
|
+
type: 'string',
|
|
3463
|
+
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
3464
|
+
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
3465
|
+
},
|
|
3466
|
+
filename: {
|
|
3467
|
+
type: 'string',
|
|
3468
|
+
description: 'Original filename as uploaded.',
|
|
3469
|
+
example: 'debug.log'
|
|
3470
|
+
},
|
|
3471
|
+
content_type: {
|
|
3472
|
+
type: 'string',
|
|
3473
|
+
description: 'MIME content type of the attachment.',
|
|
3474
|
+
example: 'text/plain'
|
|
3475
|
+
},
|
|
3476
|
+
size: {
|
|
3477
|
+
type: 'integer',
|
|
3478
|
+
description: 'Size of the attachment in bytes.',
|
|
3479
|
+
example: 12345
|
|
3480
|
+
}
|
|
3481
|
+
},
|
|
3482
|
+
required: [
|
|
3483
|
+
'id',
|
|
3484
|
+
'filename',
|
|
3485
|
+
'content_type',
|
|
3486
|
+
'size'
|
|
3487
|
+
],
|
|
3488
|
+
additionalProperties: false
|
|
3489
|
+
},
|
|
3490
|
+
description: 'Attachments associated with this message.',
|
|
3491
|
+
example: []
|
|
3492
|
+
},
|
|
3493
|
+
date_created: {
|
|
3494
|
+
type: 'string',
|
|
3495
|
+
format: 'date-time',
|
|
3496
|
+
description: 'Creation date of the message. ISO 8601 UTC.',
|
|
3497
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
3498
|
+
}
|
|
3499
|
+
},
|
|
3500
|
+
required: [
|
|
3501
|
+
'id',
|
|
3502
|
+
'type',
|
|
3503
|
+
'body',
|
|
3504
|
+
'date_created'
|
|
3505
|
+
],
|
|
3506
|
+
additionalProperties: false
|
|
3507
|
+
};
|
|
3508
|
+
export const TicketSchema = {
|
|
3509
|
+
type: 'object',
|
|
3510
|
+
properties: {
|
|
3511
|
+
id: {
|
|
3512
|
+
type: 'string',
|
|
3513
|
+
description: 'Unique identifier of the ticket (Mongo ObjectId).',
|
|
3514
|
+
example: '60c72b2f9f1b2c001f8e4d3a'
|
|
3515
|
+
},
|
|
3516
|
+
status: {
|
|
3517
|
+
type: 'string',
|
|
3518
|
+
description: 'Current state of the ticket.',
|
|
3519
|
+
example: 'waiting_on_us',
|
|
3520
|
+
enum: [
|
|
3521
|
+
'waiting_on_us',
|
|
3522
|
+
'waiting_on_user',
|
|
3523
|
+
'closed'
|
|
3524
|
+
]
|
|
3525
|
+
},
|
|
3526
|
+
category: {
|
|
3527
|
+
type: 'string',
|
|
3528
|
+
description: 'Ticket category.',
|
|
3529
|
+
example: 'technical',
|
|
3530
|
+
enum: [
|
|
3531
|
+
'billing',
|
|
3532
|
+
'technical',
|
|
3533
|
+
'general'
|
|
3534
|
+
]
|
|
3535
|
+
},
|
|
3536
|
+
summary: {
|
|
3537
|
+
type: 'string',
|
|
3538
|
+
description: 'First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.',
|
|
3539
|
+
example: 'My cluster cannot reach the registry. Logs attached.'
|
|
3540
|
+
},
|
|
3541
|
+
closed_at: {
|
|
3542
|
+
type: 'string',
|
|
3543
|
+
format: 'date-time',
|
|
3544
|
+
nullable: true,
|
|
3545
|
+
description: 'Closure timestamp. Null while the ticket is open.',
|
|
3546
|
+
example: '2026-05-18T16:08:14.338Z'
|
|
3547
|
+
},
|
|
3548
|
+
date_created: {
|
|
3549
|
+
type: 'string',
|
|
3550
|
+
format: 'date-time',
|
|
3551
|
+
description: 'Creation date of the ticket. ISO 8601 UTC.',
|
|
3552
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
3553
|
+
},
|
|
3554
|
+
date_updated: {
|
|
3555
|
+
type: 'string',
|
|
3556
|
+
format: 'date-time',
|
|
3557
|
+
description: 'Last update date of the ticket. ISO 8601 UTC.',
|
|
3558
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
3559
|
+
},
|
|
3560
|
+
messages: {
|
|
3561
|
+
type: 'array',
|
|
3562
|
+
items: {
|
|
3563
|
+
type: 'object',
|
|
3564
|
+
properties: {
|
|
3565
|
+
id: {
|
|
3566
|
+
type: 'string',
|
|
3567
|
+
description: 'Unique identifier of the message (Mongo ObjectId).',
|
|
3568
|
+
example: '60c72b2f9f1b2c001f8e4d3b'
|
|
3569
|
+
},
|
|
3570
|
+
type: {
|
|
3571
|
+
type: 'string',
|
|
3572
|
+
description: 'Message type. Internal notes are filtered out of customer-facing responses.',
|
|
3573
|
+
example: 'customer_reply',
|
|
3574
|
+
enum: [
|
|
3575
|
+
'customer_reply',
|
|
3576
|
+
'agent_reply'
|
|
3577
|
+
]
|
|
3578
|
+
},
|
|
3579
|
+
body: {
|
|
3580
|
+
type: 'string',
|
|
3581
|
+
description: 'Message body in markdown.',
|
|
3582
|
+
example: 'Thanks — that resolved it on my side.'
|
|
3583
|
+
},
|
|
3584
|
+
author_first_name: {
|
|
3585
|
+
type: 'string',
|
|
3586
|
+
description: 'First name of the author. Null when not provided.',
|
|
3587
|
+
example: 'Jane'
|
|
3588
|
+
},
|
|
3589
|
+
author_last_name: {
|
|
3590
|
+
type: 'string',
|
|
3591
|
+
description: 'Last name of the author. Null when not provided.',
|
|
3592
|
+
example: 'Doe'
|
|
3593
|
+
},
|
|
3594
|
+
attachments: {
|
|
3595
|
+
type: 'array',
|
|
3596
|
+
items: {
|
|
3597
|
+
type: 'object',
|
|
3598
|
+
properties: {
|
|
3599
|
+
id: {
|
|
3600
|
+
type: 'string',
|
|
3601
|
+
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
3602
|
+
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
3603
|
+
},
|
|
3604
|
+
filename: {
|
|
3605
|
+
type: 'string',
|
|
3606
|
+
description: 'Original filename as uploaded.',
|
|
3607
|
+
example: 'debug.log'
|
|
3608
|
+
},
|
|
3609
|
+
content_type: {
|
|
3610
|
+
type: 'string',
|
|
3611
|
+
description: 'MIME content type of the attachment.',
|
|
3612
|
+
example: 'text/plain'
|
|
3613
|
+
},
|
|
3614
|
+
size: {
|
|
3615
|
+
type: 'integer',
|
|
3616
|
+
description: 'Size of the attachment in bytes.',
|
|
3617
|
+
example: 12345
|
|
3618
|
+
}
|
|
3619
|
+
},
|
|
3620
|
+
required: [
|
|
3621
|
+
'id',
|
|
3622
|
+
'filename',
|
|
3623
|
+
'content_type',
|
|
3624
|
+
'size'
|
|
3625
|
+
],
|
|
3626
|
+
additionalProperties: false
|
|
3627
|
+
},
|
|
3628
|
+
description: 'Attachments associated with this message.',
|
|
3629
|
+
example: []
|
|
3630
|
+
},
|
|
3631
|
+
date_created: {
|
|
3632
|
+
type: 'string',
|
|
3633
|
+
format: 'date-time',
|
|
3634
|
+
description: 'Creation date of the message. ISO 8601 UTC.',
|
|
3635
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
3636
|
+
}
|
|
3637
|
+
},
|
|
3638
|
+
required: [
|
|
3639
|
+
'id',
|
|
3640
|
+
'type',
|
|
3641
|
+
'body',
|
|
3642
|
+
'date_created'
|
|
3643
|
+
],
|
|
3644
|
+
additionalProperties: false
|
|
3645
|
+
},
|
|
3646
|
+
description: 'Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.'
|
|
3647
|
+
}
|
|
3648
|
+
},
|
|
3649
|
+
required: [
|
|
3650
|
+
'id',
|
|
3651
|
+
'status',
|
|
3652
|
+
'category',
|
|
3653
|
+
'summary',
|
|
3654
|
+
'date_created',
|
|
3655
|
+
'date_updated'
|
|
3656
|
+
],
|
|
3657
|
+
additionalProperties: false
|
|
3658
|
+
};
|
|
1853
3659
|
export const TokenCreateInputSchema = {
|
|
1854
3660
|
type: 'object',
|
|
1855
3661
|
properties: {
|
|
@@ -1960,12 +3766,21 @@ export const UsageFacetsSchema = {
|
|
|
1960
3766
|
product: {
|
|
1961
3767
|
type: 'array',
|
|
1962
3768
|
items: {
|
|
1963
|
-
type: 'string'
|
|
3769
|
+
type: 'string',
|
|
3770
|
+
enum: [
|
|
3771
|
+
'cfke_controlplane_basic',
|
|
3772
|
+
'cfke_controlplane_pro',
|
|
3773
|
+
'cfke_controlplane_enterprise',
|
|
3774
|
+
'cfke_connected_nodes_basic',
|
|
3775
|
+
'cfke_connected_nodes_pro',
|
|
3776
|
+
'cfke_connected_nodes_enterprise',
|
|
3777
|
+
'cfcr_storage'
|
|
3778
|
+
]
|
|
1964
3779
|
},
|
|
1965
3780
|
description: 'List of unique products',
|
|
1966
3781
|
example: [
|
|
1967
|
-
'
|
|
1968
|
-
'
|
|
3782
|
+
'cfke_controlplane_pro',
|
|
3783
|
+
'cfke_connected_nodes_pro'
|
|
1969
3784
|
]
|
|
1970
3785
|
}
|
|
1971
3786
|
},
|
|
@@ -1992,7 +3807,16 @@ export const UsageResponseSchema = {
|
|
|
1992
3807
|
product: {
|
|
1993
3808
|
type: 'string',
|
|
1994
3809
|
description: 'The product the usage is associated with',
|
|
1995
|
-
example: '
|
|
3810
|
+
example: 'cfke_controlplane_pro',
|
|
3811
|
+
enum: [
|
|
3812
|
+
'cfke_controlplane_basic',
|
|
3813
|
+
'cfke_controlplane_pro',
|
|
3814
|
+
'cfke_controlplane_enterprise',
|
|
3815
|
+
'cfke_connected_nodes_basic',
|
|
3816
|
+
'cfke_connected_nodes_pro',
|
|
3817
|
+
'cfke_connected_nodes_enterprise',
|
|
3818
|
+
'cfcr_storage'
|
|
3819
|
+
]
|
|
1996
3820
|
},
|
|
1997
3821
|
value: {
|
|
1998
3822
|
type: 'number',
|
|
@@ -2040,12 +3864,21 @@ export const UsageResponseSchema = {
|
|
|
2040
3864
|
product: {
|
|
2041
3865
|
type: 'array',
|
|
2042
3866
|
items: {
|
|
2043
|
-
type: 'string'
|
|
3867
|
+
type: 'string',
|
|
3868
|
+
enum: [
|
|
3869
|
+
'cfke_controlplane_basic',
|
|
3870
|
+
'cfke_controlplane_pro',
|
|
3871
|
+
'cfke_controlplane_enterprise',
|
|
3872
|
+
'cfke_connected_nodes_basic',
|
|
3873
|
+
'cfke_connected_nodes_pro',
|
|
3874
|
+
'cfke_connected_nodes_enterprise',
|
|
3875
|
+
'cfcr_storage'
|
|
3876
|
+
]
|
|
2044
3877
|
},
|
|
2045
3878
|
description: 'List of unique products',
|
|
2046
3879
|
example: [
|
|
2047
|
-
'
|
|
2048
|
-
'
|
|
3880
|
+
'cfke_controlplane_pro',
|
|
3881
|
+
'cfke_connected_nodes_pro'
|
|
2049
3882
|
]
|
|
2050
3883
|
}
|
|
2051
3884
|
},
|
|
@@ -2075,7 +3908,16 @@ export const UsageSchema = {
|
|
|
2075
3908
|
product: {
|
|
2076
3909
|
type: 'string',
|
|
2077
3910
|
description: 'The product the usage is associated with',
|
|
2078
|
-
example: '
|
|
3911
|
+
example: 'cfke_controlplane_pro',
|
|
3912
|
+
enum: [
|
|
3913
|
+
'cfke_controlplane_basic',
|
|
3914
|
+
'cfke_controlplane_pro',
|
|
3915
|
+
'cfke_controlplane_enterprise',
|
|
3916
|
+
'cfke_connected_nodes_basic',
|
|
3917
|
+
'cfke_connected_nodes_pro',
|
|
3918
|
+
'cfke_connected_nodes_enterprise',
|
|
3919
|
+
'cfcr_storage'
|
|
3920
|
+
]
|
|
2079
3921
|
},
|
|
2080
3922
|
value: {
|
|
2081
3923
|
type: 'number',
|
|
@@ -2138,24 +3980,6 @@ export const UserCreateInputSchema = {
|
|
|
2138
3980
|
type: 'string',
|
|
2139
3981
|
minLength: 8,
|
|
2140
3982
|
description: 'User password. Must be at least 8 characters long.'
|
|
2141
|
-
},
|
|
2142
|
-
status: {
|
|
2143
|
-
type: 'string',
|
|
2144
|
-
description: 'Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.',
|
|
2145
|
-
example: 'active',
|
|
2146
|
-
enum: [
|
|
2147
|
-
'active',
|
|
2148
|
-
'inactive'
|
|
2149
|
-
]
|
|
2150
|
-
},
|
|
2151
|
-
role: {
|
|
2152
|
-
type: 'string',
|
|
2153
|
-
description: 'User role. Can be \'Administrator\', \'User\'.',
|
|
2154
|
-
example: 'User',
|
|
2155
|
-
enum: [
|
|
2156
|
-
'Administrator',
|
|
2157
|
-
'User'
|
|
2158
|
-
]
|
|
2159
3983
|
}
|
|
2160
3984
|
},
|
|
2161
3985
|
required: [
|