@cloudfleet/sdk 0.0.1-200be61 → 0.0.1-20bd5c1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -2
- package/dist/@tanstack/react-query.gen.d.ts +526 -574
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -1
- package/dist/@tanstack/react-query.gen.js +534 -377
- package/dist/@tanstack/react-query.gen.js.map +1 -1
- package/dist/client/client.gen.d.ts.map +1 -1
- package/dist/client/client.gen.js +1 -4
- package/dist/client/client.gen.js.map +1 -1
- package/dist/client/types.gen.d.ts +1 -1
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.d.ts +2 -2
- package/dist/client/utils.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.js +3 -3
- package/dist/client/utils.gen.js.map +1 -1
- package/dist/core/params.gen.js +4 -4
- package/dist/core/params.gen.js.map +1 -1
- package/dist/schemas.gen.d.ts +913 -256
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +1869 -356
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +271 -208
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +403 -310
- package/dist/sdk.gen.js.map +1 -1
- package/dist/types.gen.d.ts +1433 -805
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3588 -1446
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1310 -348
- package/dist/zod.gen.js.map +1 -1
- package/package.json +10 -13
package/dist/schemas.gen.d.ts
CHANGED
|
@@ -1,6 +1,12 @@
|
|
|
1
1
|
export declare const BillingContactSchema: {
|
|
2
2
|
readonly type: "object";
|
|
3
3
|
readonly properties: {
|
|
4
|
+
readonly type: {
|
|
5
|
+
readonly type: "string";
|
|
6
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
7
|
+
readonly example: "business";
|
|
8
|
+
readonly enum: readonly ["business", "personal"];
|
|
9
|
+
};
|
|
4
10
|
readonly company: {
|
|
5
11
|
readonly type: "string";
|
|
6
12
|
readonly maxLength: 120;
|
|
@@ -73,10 +79,10 @@ export declare const BillingContactSchema: {
|
|
|
73
79
|
readonly nullable: true;
|
|
74
80
|
readonly description: "Type of the tax ID.";
|
|
75
81
|
readonly example: "de_vat";
|
|
76
|
-
readonly enum: readonly ["ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "at_vat", "au_abn", "au_arn", "ba_tin", "bb_tin", "be_vat", "bg_uic", "bg_vat", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", "cy_vat", "cz_vat", "de_stn", "de_vat", "dk_vat", "do_rcn", "ec_ruc", "ee_vat", "eg_tin", "es_cif", "es_vat", "eu_oss_vat", "fi_vat", "fr_vat", "gb_vat", "ge_vat", "gn_nif", "gr_vat", "hk_br", "hr_oib", "hr_vat", "hu_tin", "hu_vat", "id_npwp", "ie_vat", "il_vat", "in_gst", "is_vat", "it_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kh_tin", "kr_brn", "kz_bin", "li_uid", "li_vat", "lt_vat", "lu_vat", "lv_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mt_vat", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "nl_vat", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "pl_vat", "pt_vat", "ro_tin", "ro_vat", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "se_vat", "sg_gst", "sg_uen", "si_tin", "si_vat", "sk_vat", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "xi_vat", "za_vat", "zm_tin", "zw_tin", ""];
|
|
82
|
+
readonly enum: readonly ["ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "at_vat", "au_abn", "au_arn", "aw_tin", "az_tin", "ba_tin", "bb_tin", "bd_bin", "be_vat", "bf_ifu", "bg_uic", "bg_vat", "bh_vat", "bj_ifu", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cm_niu", "cn_tin", "co_nit", "cr_tin", "cv_nif", "cy_vat", "cz_vat", "de_stn", "de_vat", "dk_vat", "do_rcn", "ec_ruc", "ee_vat", "eg_tin", "es_cif", "es_vat", "et_tin", "eu_oss_vat", "fi_vat", "fr_vat", "gb_vat", "ge_vat", "gn_nif", "gr_vat", "hk_br", "hr_oib", "hr_vat", "hu_tin", "hu_vat", "id_npwp", "ie_vat", "il_vat", "in_gst", "is_vat", "it_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kg_tin", "kh_tin", "kr_brn", "kz_bin", "la_tin", "li_uid", "li_vat", "lk_vat", "lt_vat", "lu_vat", "lv_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mt_vat", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "nl_vat", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "pl_vat", "pt_vat", "ro_tin", "ro_vat", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "se_vat", "sg_gst", "sg_uen", "si_tin", "si_vat", "sk_vat", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "xi_vat", "za_vat", "zm_tin", "zw_tin", ""];
|
|
77
83
|
};
|
|
78
84
|
};
|
|
79
|
-
readonly required: readonly ["email", "individual_name"];
|
|
85
|
+
readonly required: readonly ["type", "email", "individual_name"];
|
|
80
86
|
readonly additionalProperties: false;
|
|
81
87
|
};
|
|
82
88
|
export declare const BillingCreditsSchema: {
|
|
@@ -211,9 +217,8 @@ export declare const ChartSchema: {
|
|
|
211
217
|
};
|
|
212
218
|
readonly status: {
|
|
213
219
|
readonly type: "string";
|
|
214
|
-
readonly description: "Status of the chart deployment.";
|
|
215
|
-
readonly example: "
|
|
216
|
-
readonly enum: readonly ["InstallSucceeded", "InstallFailed", "UpgradeSucceeded", "UpgradeFailed", "TestSucceeded", "TestFailed", "RollbackSucceeded", "RollbackFailed", "UninstallSucceeded", "UninstallFailed", "ArtifactFailed", "DependencyNotReady", "Progressing", "SourceNotReady"];
|
|
220
|
+
readonly description: "Status of the chart deployment (Flux HelmRelease Ready condition reason, e.g. InstallSucceeded, UpgradeFailed, Progressing).";
|
|
221
|
+
readonly example: "InstallSucceeded";
|
|
217
222
|
};
|
|
218
223
|
readonly version_current: {
|
|
219
224
|
readonly type: "string";
|
|
@@ -270,15 +275,9 @@ export declare const ClusterCreateInputSchema: {
|
|
|
270
275
|
readonly tier: {
|
|
271
276
|
readonly type: "string";
|
|
272
277
|
readonly description: "Tier of the cluster.";
|
|
278
|
+
readonly default: "basic";
|
|
273
279
|
readonly example: "pro";
|
|
274
|
-
readonly enum: readonly ["basic", "pro"];
|
|
275
|
-
};
|
|
276
|
-
readonly region: {
|
|
277
|
-
readonly type: "string";
|
|
278
|
-
readonly 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.";
|
|
279
|
-
readonly default: "staging-1a";
|
|
280
|
-
readonly example: "northamerica-central-1a";
|
|
281
|
-
readonly enum: readonly ["staging-1a", "northamerica-central-1", "europe-central-1a", "northamerica-central-1a"];
|
|
280
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
282
281
|
};
|
|
283
282
|
readonly version_channel: {
|
|
284
283
|
readonly type: "string";
|
|
@@ -286,11 +285,93 @@ export declare const ClusterCreateInputSchema: {
|
|
|
286
285
|
readonly description: "Version of the kubernetes cluster.";
|
|
287
286
|
readonly default: "1.x.x-cfke.x";
|
|
288
287
|
readonly example: "1.x.x-cfke.x";
|
|
289
|
-
|
|
288
|
+
};
|
|
289
|
+
readonly release_channel: {
|
|
290
|
+
readonly type: "string";
|
|
291
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
292
|
+
readonly default: "rapid";
|
|
293
|
+
readonly example: "rapid";
|
|
294
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
295
|
+
};
|
|
296
|
+
readonly features: {
|
|
297
|
+
readonly type: "object";
|
|
298
|
+
readonly properties: {
|
|
299
|
+
readonly gpu_sharing_strategy: {
|
|
300
|
+
readonly type: "string";
|
|
301
|
+
readonly description: "GPU sharing strategy.";
|
|
302
|
+
readonly default: "none";
|
|
303
|
+
readonly example: "none";
|
|
304
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
305
|
+
};
|
|
306
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
307
|
+
readonly type: "integer";
|
|
308
|
+
readonly minimum: 2;
|
|
309
|
+
readonly maximum: 48;
|
|
310
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
311
|
+
readonly default: 4;
|
|
312
|
+
readonly example: 10;
|
|
313
|
+
};
|
|
314
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
315
|
+
readonly type: "boolean";
|
|
316
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
317
|
+
readonly example: false;
|
|
318
|
+
};
|
|
319
|
+
};
|
|
320
|
+
readonly additionalProperties: false;
|
|
321
|
+
readonly description: "Cluster feature toggles.";
|
|
322
|
+
readonly default: {
|
|
323
|
+
readonly gpu_sharing_strategy: "none";
|
|
324
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
325
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
326
|
+
};
|
|
327
|
+
};
|
|
328
|
+
readonly region: {
|
|
329
|
+
readonly type: "string";
|
|
330
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
331
|
+
readonly example: "europe-central-1a";
|
|
332
|
+
};
|
|
333
|
+
readonly networking: {
|
|
334
|
+
readonly type: "object";
|
|
335
|
+
readonly properties: {
|
|
336
|
+
readonly pod_cidr: {
|
|
337
|
+
readonly type: "string";
|
|
338
|
+
readonly description: "CIDR block for pod IPs.";
|
|
339
|
+
readonly default: "10.244.0.0/16";
|
|
340
|
+
};
|
|
341
|
+
readonly service_cidr: {
|
|
342
|
+
readonly type: "string";
|
|
343
|
+
readonly description: "CIDR block for service IPs.";
|
|
344
|
+
readonly default: "10.96.0.0/12";
|
|
345
|
+
};
|
|
346
|
+
readonly dual_stack: {
|
|
347
|
+
readonly type: "boolean";
|
|
348
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
349
|
+
};
|
|
350
|
+
readonly pod_cidr_v6: {
|
|
351
|
+
readonly type: "string";
|
|
352
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
353
|
+
readonly default: "2001:db8:1:2::/48";
|
|
354
|
+
};
|
|
355
|
+
readonly service_cidr_v6: {
|
|
356
|
+
readonly type: "string";
|
|
357
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
358
|
+
readonly default: "2001:db8:1:1::/112";
|
|
359
|
+
};
|
|
360
|
+
};
|
|
361
|
+
readonly additionalProperties: false;
|
|
362
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
363
|
+
readonly default: {
|
|
364
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
365
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
366
|
+
readonly dual_stack: false;
|
|
367
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
368
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
369
|
+
};
|
|
290
370
|
};
|
|
291
371
|
};
|
|
292
|
-
readonly required: readonly ["name", "
|
|
372
|
+
readonly required: readonly ["name", "region"];
|
|
293
373
|
readonly additionalProperties: false;
|
|
374
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
294
375
|
};
|
|
295
376
|
export declare const ClusterJoinInformationSchema: {
|
|
296
377
|
readonly type: "object";
|
|
@@ -311,11 +392,21 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
311
392
|
readonly description: "Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.";
|
|
312
393
|
readonly example: "10.96.0.10";
|
|
313
394
|
};
|
|
395
|
+
readonly pod_cidr: {
|
|
396
|
+
readonly type: "string";
|
|
397
|
+
readonly description: "Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.";
|
|
398
|
+
readonly example: "10.244.0.0/16";
|
|
399
|
+
};
|
|
314
400
|
readonly auth_key: {
|
|
315
401
|
readonly type: "string";
|
|
316
402
|
readonly description: "Authentication key for the cluster.";
|
|
317
403
|
readonly example: "tskey-auth-kBV8wr1dk911CNTRL-...";
|
|
318
404
|
};
|
|
405
|
+
readonly login_server: {
|
|
406
|
+
readonly type: "string";
|
|
407
|
+
readonly 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.";
|
|
408
|
+
readonly example: "https://415026b6-f00f-44f8-968d-fc6ef4d0fc6d.fabric.europe-central-1a.cfke.io";
|
|
409
|
+
};
|
|
319
410
|
readonly bootstrap_token: {
|
|
320
411
|
readonly type: "string";
|
|
321
412
|
readonly description: "Bootstrap token for the cluster.";
|
|
@@ -373,7 +464,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
373
464
|
readonly description: "OIDC Information for hosts to access to third party API's.";
|
|
374
465
|
};
|
|
375
466
|
};
|
|
376
|
-
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
467
|
+
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "pod_cidr", "auth_key", "login_server", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
377
468
|
readonly additionalProperties: false;
|
|
378
469
|
};
|
|
379
470
|
export declare const ClusterSchema: {
|
|
@@ -390,15 +481,100 @@ export declare const ClusterSchema: {
|
|
|
390
481
|
readonly tier: {
|
|
391
482
|
readonly type: "string";
|
|
392
483
|
readonly description: "Tier of the cluster.";
|
|
484
|
+
readonly default: "basic";
|
|
393
485
|
readonly example: "pro";
|
|
394
|
-
readonly enum: readonly ["basic", "pro"];
|
|
486
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
487
|
+
};
|
|
488
|
+
readonly version_channel: {
|
|
489
|
+
readonly type: "string";
|
|
490
|
+
readonly 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-]+)*))?$";
|
|
491
|
+
readonly description: "Version of the kubernetes cluster.";
|
|
492
|
+
readonly default: "1.x.x-cfke.x";
|
|
493
|
+
readonly example: "1.x.x-cfke.x";
|
|
494
|
+
};
|
|
495
|
+
readonly release_channel: {
|
|
496
|
+
readonly type: "string";
|
|
497
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
498
|
+
readonly default: "rapid";
|
|
499
|
+
readonly example: "rapid";
|
|
500
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
501
|
+
};
|
|
502
|
+
readonly features: {
|
|
503
|
+
readonly type: "object";
|
|
504
|
+
readonly properties: {
|
|
505
|
+
readonly gpu_sharing_strategy: {
|
|
506
|
+
readonly type: "string";
|
|
507
|
+
readonly description: "GPU sharing strategy.";
|
|
508
|
+
readonly default: "none";
|
|
509
|
+
readonly example: "none";
|
|
510
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
511
|
+
};
|
|
512
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
513
|
+
readonly type: "integer";
|
|
514
|
+
readonly minimum: 2;
|
|
515
|
+
readonly maximum: 48;
|
|
516
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
517
|
+
readonly default: 4;
|
|
518
|
+
readonly example: 10;
|
|
519
|
+
};
|
|
520
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
521
|
+
readonly type: "boolean";
|
|
522
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
523
|
+
readonly example: false;
|
|
524
|
+
};
|
|
525
|
+
};
|
|
526
|
+
readonly required: readonly ["gpu_sharing_strategy", "gpu_max_shared_clients_per_gpu", "cilium_socket_lb_host_namespace_only"];
|
|
527
|
+
readonly additionalProperties: false;
|
|
528
|
+
readonly description: "Cluster feature toggles.";
|
|
529
|
+
readonly default: {
|
|
530
|
+
readonly gpu_sharing_strategy: "none";
|
|
531
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
532
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
533
|
+
};
|
|
395
534
|
};
|
|
396
535
|
readonly region: {
|
|
397
536
|
readonly type: "string";
|
|
398
|
-
readonly description: "Cloudfleet control plane region.
|
|
399
|
-
readonly
|
|
400
|
-
|
|
401
|
-
|
|
537
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
538
|
+
readonly example: "europe-central-1a";
|
|
539
|
+
};
|
|
540
|
+
readonly networking: {
|
|
541
|
+
readonly type: "object";
|
|
542
|
+
readonly properties: {
|
|
543
|
+
readonly pod_cidr: {
|
|
544
|
+
readonly type: "string";
|
|
545
|
+
readonly description: "CIDR block for pod IPs.";
|
|
546
|
+
readonly default: "10.244.0.0/16";
|
|
547
|
+
};
|
|
548
|
+
readonly service_cidr: {
|
|
549
|
+
readonly type: "string";
|
|
550
|
+
readonly description: "CIDR block for service IPs.";
|
|
551
|
+
readonly default: "10.96.0.0/12";
|
|
552
|
+
};
|
|
553
|
+
readonly dual_stack: {
|
|
554
|
+
readonly type: "boolean";
|
|
555
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
556
|
+
};
|
|
557
|
+
readonly pod_cidr_v6: {
|
|
558
|
+
readonly type: "string";
|
|
559
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
560
|
+
readonly default: "2001:db8:1:2::/48";
|
|
561
|
+
};
|
|
562
|
+
readonly service_cidr_v6: {
|
|
563
|
+
readonly type: "string";
|
|
564
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
565
|
+
readonly default: "2001:db8:1:1::/112";
|
|
566
|
+
};
|
|
567
|
+
};
|
|
568
|
+
readonly required: readonly ["pod_cidr", "service_cidr", "dual_stack", "pod_cidr_v6", "service_cidr_v6"];
|
|
569
|
+
readonly additionalProperties: false;
|
|
570
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
571
|
+
readonly default: {
|
|
572
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
573
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
574
|
+
readonly dual_stack: false;
|
|
575
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
576
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
577
|
+
};
|
|
402
578
|
};
|
|
403
579
|
readonly id: {
|
|
404
580
|
readonly type: "string";
|
|
@@ -408,16 +584,16 @@ export declare const ClusterSchema: {
|
|
|
408
584
|
};
|
|
409
585
|
readonly status: {
|
|
410
586
|
readonly type: "string";
|
|
411
|
-
readonly description: "Status of the cluster.
|
|
412
|
-
readonly example: "
|
|
413
|
-
readonly enum: readonly ["
|
|
587
|
+
readonly description: "Status of the cluster.";
|
|
588
|
+
readonly example: "deployed";
|
|
589
|
+
readonly enum: readonly ["creating", "deployed", "updating", "disabled"];
|
|
414
590
|
};
|
|
415
591
|
readonly endpoint: {
|
|
416
592
|
readonly anyOf: readonly [{
|
|
417
593
|
readonly type: "string";
|
|
418
594
|
readonly format: "uri";
|
|
419
|
-
readonly description: "URL signed by
|
|
420
|
-
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
595
|
+
readonly 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.";
|
|
596
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
421
597
|
}, {
|
|
422
598
|
readonly type: "string";
|
|
423
599
|
readonly enum: readonly [""];
|
|
@@ -427,7 +603,7 @@ export declare const ClusterSchema: {
|
|
|
427
603
|
readonly anyOf: readonly [{
|
|
428
604
|
readonly type: "string";
|
|
429
605
|
readonly format: "uri";
|
|
430
|
-
readonly description: "
|
|
606
|
+
readonly description: "Deprecated alias of `endpoint`; retained for backward compatibility.";
|
|
431
607
|
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
432
608
|
}, {
|
|
433
609
|
readonly type: "string";
|
|
@@ -459,15 +635,10 @@ export declare const ClusterSchema: {
|
|
|
459
635
|
readonly description: "Indicates if the cluster is ready to be used.";
|
|
460
636
|
readonly example: true;
|
|
461
637
|
};
|
|
462
|
-
readonly version_channel: {
|
|
463
|
-
readonly type: "string";
|
|
464
|
-
readonly 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-]+)*))?$";
|
|
465
|
-
readonly description: "Version of the kubernetes cluster.";
|
|
466
|
-
readonly example: "1.x.x-cfke.x";
|
|
467
|
-
};
|
|
468
638
|
};
|
|
469
|
-
readonly required: readonly ["name", "tier", "id", "status"];
|
|
639
|
+
readonly required: readonly ["name", "tier", "version_channel", "release_channel", "features", "region", "networking", "id", "status", "ready"];
|
|
470
640
|
readonly additionalProperties: false;
|
|
641
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
471
642
|
};
|
|
472
643
|
export declare const ClusterUpdateInputSchema: {
|
|
473
644
|
readonly type: "object";
|
|
@@ -483,18 +654,60 @@ export declare const ClusterUpdateInputSchema: {
|
|
|
483
654
|
readonly tier: {
|
|
484
655
|
readonly type: "string";
|
|
485
656
|
readonly description: "Tier of the cluster.";
|
|
657
|
+
readonly default: "basic";
|
|
486
658
|
readonly example: "pro";
|
|
487
|
-
readonly enum: readonly ["basic", "pro"];
|
|
659
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
488
660
|
};
|
|
489
661
|
readonly version_channel: {
|
|
490
662
|
readonly type: "string";
|
|
491
663
|
readonly 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-]+)*))?$";
|
|
492
664
|
readonly description: "Version of the kubernetes cluster.";
|
|
665
|
+
readonly default: "1.x.x-cfke.x";
|
|
493
666
|
readonly example: "1.x.x-cfke.x";
|
|
494
667
|
};
|
|
668
|
+
readonly release_channel: {
|
|
669
|
+
readonly type: "string";
|
|
670
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
671
|
+
readonly default: "rapid";
|
|
672
|
+
readonly example: "rapid";
|
|
673
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
674
|
+
};
|
|
675
|
+
readonly features: {
|
|
676
|
+
readonly type: "object";
|
|
677
|
+
readonly properties: {
|
|
678
|
+
readonly gpu_sharing_strategy: {
|
|
679
|
+
readonly type: "string";
|
|
680
|
+
readonly description: "GPU sharing strategy.";
|
|
681
|
+
readonly default: "none";
|
|
682
|
+
readonly example: "none";
|
|
683
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
684
|
+
};
|
|
685
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
686
|
+
readonly type: "integer";
|
|
687
|
+
readonly minimum: 2;
|
|
688
|
+
readonly maximum: 48;
|
|
689
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
690
|
+
readonly default: 4;
|
|
691
|
+
readonly example: 10;
|
|
692
|
+
};
|
|
693
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
694
|
+
readonly type: "boolean";
|
|
695
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
696
|
+
readonly example: false;
|
|
697
|
+
};
|
|
698
|
+
};
|
|
699
|
+
readonly additionalProperties: false;
|
|
700
|
+
readonly description: "Cluster feature toggles.";
|
|
701
|
+
readonly default: {
|
|
702
|
+
readonly gpu_sharing_strategy: "none";
|
|
703
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
704
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
705
|
+
};
|
|
706
|
+
};
|
|
495
707
|
};
|
|
496
|
-
readonly required: readonly ["
|
|
708
|
+
readonly required: readonly ["name"];
|
|
497
709
|
readonly additionalProperties: false;
|
|
710
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
498
711
|
};
|
|
499
712
|
export declare const FleetCreateInputSchema: {
|
|
500
713
|
readonly type: "object";
|
|
@@ -503,13 +716,12 @@ export declare const FleetCreateInputSchema: {
|
|
|
503
716
|
readonly type: "object";
|
|
504
717
|
readonly properties: {
|
|
505
718
|
readonly cpu: {
|
|
506
|
-
readonly type: "
|
|
507
|
-
readonly format: "float";
|
|
719
|
+
readonly type: "integer";
|
|
508
720
|
readonly minimum: 0;
|
|
509
|
-
readonly
|
|
721
|
+
readonly maximum: 100000;
|
|
722
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
510
723
|
};
|
|
511
724
|
};
|
|
512
|
-
readonly required: readonly ["cpu"];
|
|
513
725
|
readonly additionalProperties: false;
|
|
514
726
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
515
727
|
};
|
|
@@ -518,14 +730,15 @@ export declare const FleetCreateInputSchema: {
|
|
|
518
730
|
readonly properties: {
|
|
519
731
|
readonly enabled: {
|
|
520
732
|
readonly type: "boolean";
|
|
521
|
-
readonly default: true;
|
|
522
733
|
};
|
|
523
734
|
readonly project: {
|
|
524
735
|
readonly type: "string";
|
|
525
|
-
readonly
|
|
736
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
737
|
+
readonly 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.";
|
|
738
|
+
readonly example: "my-cloudfleet-project";
|
|
526
739
|
};
|
|
527
740
|
};
|
|
528
|
-
readonly required: readonly ["
|
|
741
|
+
readonly required: readonly ["enabled"];
|
|
529
742
|
readonly additionalProperties: false;
|
|
530
743
|
};
|
|
531
744
|
readonly hetzner: {
|
|
@@ -533,14 +746,16 @@ export declare const FleetCreateInputSchema: {
|
|
|
533
746
|
readonly properties: {
|
|
534
747
|
readonly enabled: {
|
|
535
748
|
readonly type: "boolean";
|
|
536
|
-
readonly default: true;
|
|
537
749
|
};
|
|
538
750
|
readonly apiKey: {
|
|
539
751
|
readonly type: "string";
|
|
540
|
-
readonly
|
|
752
|
+
readonly maxLength: 64;
|
|
753
|
+
readonly minLength: 64;
|
|
754
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
755
|
+
readonly 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.";
|
|
541
756
|
};
|
|
542
757
|
};
|
|
543
|
-
readonly required: readonly ["
|
|
758
|
+
readonly required: readonly ["enabled"];
|
|
544
759
|
readonly additionalProperties: false;
|
|
545
760
|
};
|
|
546
761
|
readonly aws: {
|
|
@@ -548,15 +763,105 @@ export declare const FleetCreateInputSchema: {
|
|
|
548
763
|
readonly properties: {
|
|
549
764
|
readonly enabled: {
|
|
550
765
|
readonly type: "boolean";
|
|
551
|
-
readonly default: true;
|
|
552
766
|
};
|
|
553
767
|
readonly controllerRoleArn: {
|
|
554
768
|
readonly type: "string";
|
|
555
|
-
readonly
|
|
769
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
770
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
771
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
772
|
+
};
|
|
773
|
+
};
|
|
774
|
+
readonly required: readonly ["enabled"];
|
|
775
|
+
readonly additionalProperties: false;
|
|
776
|
+
};
|
|
777
|
+
readonly constraints: {
|
|
778
|
+
readonly type: "object";
|
|
779
|
+
readonly properties: {
|
|
780
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
781
|
+
readonly type: "array";
|
|
782
|
+
readonly items: {
|
|
783
|
+
readonly type: "string";
|
|
784
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
785
|
+
};
|
|
786
|
+
readonly minItems: 1;
|
|
787
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
788
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
789
|
+
};
|
|
790
|
+
readonly 'kubernetes.io/arch': {
|
|
791
|
+
readonly type: "array";
|
|
792
|
+
readonly items: {
|
|
793
|
+
readonly type: "string";
|
|
794
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
795
|
+
};
|
|
796
|
+
readonly minItems: 1;
|
|
797
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
798
|
+
readonly default: readonly ["amd64"];
|
|
799
|
+
};
|
|
800
|
+
readonly 'cfke.io/instance-family': {
|
|
801
|
+
readonly type: "array";
|
|
802
|
+
readonly items: {
|
|
803
|
+
readonly type: "string";
|
|
804
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
805
|
+
};
|
|
806
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
807
|
+
readonly default: readonly [];
|
|
808
|
+
};
|
|
809
|
+
readonly 'topology.kubernetes.io/region': {
|
|
810
|
+
readonly type: "array";
|
|
811
|
+
readonly items: {
|
|
812
|
+
readonly type: "string";
|
|
813
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
814
|
+
};
|
|
815
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
816
|
+
readonly default: readonly [];
|
|
556
817
|
};
|
|
557
818
|
};
|
|
558
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
559
819
|
readonly additionalProperties: false;
|
|
820
|
+
readonly 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.";
|
|
821
|
+
readonly default: {
|
|
822
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
823
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
824
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
825
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
826
|
+
};
|
|
827
|
+
};
|
|
828
|
+
readonly scalingProfile: {
|
|
829
|
+
readonly type: "string";
|
|
830
|
+
readonly 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`).";
|
|
831
|
+
readonly default: "conservative";
|
|
832
|
+
readonly example: "conservative";
|
|
833
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
834
|
+
};
|
|
835
|
+
readonly taints: {
|
|
836
|
+
readonly type: "array";
|
|
837
|
+
readonly items: {
|
|
838
|
+
readonly type: "object";
|
|
839
|
+
readonly properties: {
|
|
840
|
+
readonly key: {
|
|
841
|
+
readonly type: "string";
|
|
842
|
+
readonly description: "Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.";
|
|
843
|
+
readonly example: "dedicated";
|
|
844
|
+
};
|
|
845
|
+
readonly value: {
|
|
846
|
+
readonly type: "string";
|
|
847
|
+
readonly maxLength: 63;
|
|
848
|
+
readonly pattern: "^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$";
|
|
849
|
+
readonly description: "Taint value. Optional.";
|
|
850
|
+
readonly example: "ci";
|
|
851
|
+
};
|
|
852
|
+
readonly effect: {
|
|
853
|
+
readonly type: "string";
|
|
854
|
+
readonly description: "Taint effect.";
|
|
855
|
+
readonly example: "NoSchedule";
|
|
856
|
+
readonly enum: readonly ["NoSchedule", "PreferNoSchedule", "NoExecute"];
|
|
857
|
+
};
|
|
858
|
+
};
|
|
859
|
+
readonly required: readonly ["key", "effect"];
|
|
860
|
+
readonly additionalProperties: false;
|
|
861
|
+
};
|
|
862
|
+
readonly maxItems: 50;
|
|
863
|
+
readonly description: "Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.";
|
|
864
|
+
readonly default: readonly [];
|
|
560
865
|
};
|
|
561
866
|
readonly id: {
|
|
562
867
|
readonly type: "string";
|
|
@@ -569,6 +874,7 @@ export declare const FleetCreateInputSchema: {
|
|
|
569
874
|
};
|
|
570
875
|
readonly required: readonly ["id"];
|
|
571
876
|
readonly additionalProperties: false;
|
|
877
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
572
878
|
};
|
|
573
879
|
export declare const FleetSchema: {
|
|
574
880
|
readonly type: "object";
|
|
@@ -577,13 +883,12 @@ export declare const FleetSchema: {
|
|
|
577
883
|
readonly type: "object";
|
|
578
884
|
readonly properties: {
|
|
579
885
|
readonly cpu: {
|
|
580
|
-
readonly type: "
|
|
581
|
-
readonly format: "float";
|
|
886
|
+
readonly type: "integer";
|
|
582
887
|
readonly minimum: 0;
|
|
583
|
-
readonly
|
|
888
|
+
readonly maximum: 100000;
|
|
889
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
584
890
|
};
|
|
585
891
|
};
|
|
586
|
-
readonly required: readonly ["cpu"];
|
|
587
892
|
readonly additionalProperties: false;
|
|
588
893
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
589
894
|
};
|
|
@@ -592,14 +897,15 @@ export declare const FleetSchema: {
|
|
|
592
897
|
readonly properties: {
|
|
593
898
|
readonly enabled: {
|
|
594
899
|
readonly type: "boolean";
|
|
595
|
-
readonly default: true;
|
|
596
900
|
};
|
|
597
901
|
readonly project: {
|
|
598
902
|
readonly type: "string";
|
|
599
|
-
readonly
|
|
903
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
904
|
+
readonly 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.";
|
|
905
|
+
readonly example: "my-cloudfleet-project";
|
|
600
906
|
};
|
|
601
907
|
};
|
|
602
|
-
readonly required: readonly ["
|
|
908
|
+
readonly required: readonly ["enabled"];
|
|
603
909
|
readonly additionalProperties: false;
|
|
604
910
|
};
|
|
605
911
|
readonly hetzner: {
|
|
@@ -607,14 +913,14 @@ export declare const FleetSchema: {
|
|
|
607
913
|
readonly properties: {
|
|
608
914
|
readonly enabled: {
|
|
609
915
|
readonly type: "boolean";
|
|
610
|
-
readonly default: true;
|
|
611
916
|
};
|
|
612
917
|
readonly apiKey: {
|
|
613
918
|
readonly type: "string";
|
|
614
|
-
readonly
|
|
919
|
+
readonly pattern: "^\\*{64}$";
|
|
920
|
+
readonly 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.";
|
|
615
921
|
};
|
|
616
922
|
};
|
|
617
|
-
readonly required: readonly ["
|
|
923
|
+
readonly required: readonly ["enabled"];
|
|
618
924
|
readonly additionalProperties: false;
|
|
619
925
|
};
|
|
620
926
|
readonly aws: {
|
|
@@ -622,15 +928,106 @@ export declare const FleetSchema: {
|
|
|
622
928
|
readonly properties: {
|
|
623
929
|
readonly enabled: {
|
|
624
930
|
readonly type: "boolean";
|
|
625
|
-
readonly default: true;
|
|
626
931
|
};
|
|
627
932
|
readonly controllerRoleArn: {
|
|
628
933
|
readonly type: "string";
|
|
629
|
-
readonly
|
|
934
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
935
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
936
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
937
|
+
};
|
|
938
|
+
};
|
|
939
|
+
readonly required: readonly ["enabled"];
|
|
940
|
+
readonly additionalProperties: false;
|
|
941
|
+
};
|
|
942
|
+
readonly constraints: {
|
|
943
|
+
readonly type: "object";
|
|
944
|
+
readonly properties: {
|
|
945
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
946
|
+
readonly type: "array";
|
|
947
|
+
readonly items: {
|
|
948
|
+
readonly type: "string";
|
|
949
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
950
|
+
};
|
|
951
|
+
readonly minItems: 1;
|
|
952
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
953
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
954
|
+
};
|
|
955
|
+
readonly 'kubernetes.io/arch': {
|
|
956
|
+
readonly type: "array";
|
|
957
|
+
readonly items: {
|
|
958
|
+
readonly type: "string";
|
|
959
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
960
|
+
};
|
|
961
|
+
readonly minItems: 1;
|
|
962
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
963
|
+
readonly default: readonly ["amd64"];
|
|
964
|
+
};
|
|
965
|
+
readonly 'cfke.io/instance-family': {
|
|
966
|
+
readonly type: "array";
|
|
967
|
+
readonly items: {
|
|
968
|
+
readonly type: "string";
|
|
969
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
970
|
+
};
|
|
971
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
972
|
+
readonly default: readonly [];
|
|
973
|
+
};
|
|
974
|
+
readonly 'topology.kubernetes.io/region': {
|
|
975
|
+
readonly type: "array";
|
|
976
|
+
readonly items: {
|
|
977
|
+
readonly type: "string";
|
|
978
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
979
|
+
};
|
|
980
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
981
|
+
readonly default: readonly [];
|
|
630
982
|
};
|
|
631
983
|
};
|
|
632
|
-
readonly required: readonly ["
|
|
984
|
+
readonly required: readonly ["karpenter.sh/capacity-type", "kubernetes.io/arch"];
|
|
633
985
|
readonly additionalProperties: false;
|
|
986
|
+
readonly 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.";
|
|
987
|
+
readonly default: {
|
|
988
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
989
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
990
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
991
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
992
|
+
};
|
|
993
|
+
};
|
|
994
|
+
readonly scalingProfile: {
|
|
995
|
+
readonly type: "string";
|
|
996
|
+
readonly 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`).";
|
|
997
|
+
readonly default: "conservative";
|
|
998
|
+
readonly example: "conservative";
|
|
999
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
1000
|
+
};
|
|
1001
|
+
readonly taints: {
|
|
1002
|
+
readonly type: "array";
|
|
1003
|
+
readonly items: {
|
|
1004
|
+
readonly type: "object";
|
|
1005
|
+
readonly properties: {
|
|
1006
|
+
readonly key: {
|
|
1007
|
+
readonly type: "string";
|
|
1008
|
+
readonly description: "Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.";
|
|
1009
|
+
readonly example: "dedicated";
|
|
1010
|
+
};
|
|
1011
|
+
readonly value: {
|
|
1012
|
+
readonly type: "string";
|
|
1013
|
+
readonly maxLength: 63;
|
|
1014
|
+
readonly pattern: "^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$";
|
|
1015
|
+
readonly description: "Taint value. Optional.";
|
|
1016
|
+
readonly example: "ci";
|
|
1017
|
+
};
|
|
1018
|
+
readonly effect: {
|
|
1019
|
+
readonly type: "string";
|
|
1020
|
+
readonly description: "Taint effect.";
|
|
1021
|
+
readonly example: "NoSchedule";
|
|
1022
|
+
readonly enum: readonly ["NoSchedule", "PreferNoSchedule", "NoExecute"];
|
|
1023
|
+
};
|
|
1024
|
+
};
|
|
1025
|
+
readonly required: readonly ["key", "effect"];
|
|
1026
|
+
readonly additionalProperties: false;
|
|
1027
|
+
};
|
|
1028
|
+
readonly maxItems: 50;
|
|
1029
|
+
readonly description: "Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.";
|
|
1030
|
+
readonly default: readonly [];
|
|
634
1031
|
};
|
|
635
1032
|
readonly id: {
|
|
636
1033
|
readonly type: "string";
|
|
@@ -640,9 +1037,30 @@ export declare const FleetSchema: {
|
|
|
640
1037
|
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
641
1038
|
readonly example: "new-clouds-fleet";
|
|
642
1039
|
};
|
|
1040
|
+
readonly ready: {
|
|
1041
|
+
readonly type: "boolean";
|
|
1042
|
+
readonly description: "Indicates whether the fleet configuration is healthy.";
|
|
1043
|
+
readonly example: true;
|
|
1044
|
+
};
|
|
1045
|
+
readonly status_message: {
|
|
1046
|
+
readonly type: "string";
|
|
1047
|
+
readonly description: "Human-readable reason the fleet is not ready. Present only when `ready` is false.";
|
|
1048
|
+
readonly example: "Invalid provider permissions.";
|
|
1049
|
+
};
|
|
1050
|
+
readonly created_at: {
|
|
1051
|
+
readonly type: "string";
|
|
1052
|
+
readonly description: "Creation date and time of the fleet.";
|
|
1053
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
1054
|
+
};
|
|
1055
|
+
readonly updated_at: {
|
|
1056
|
+
readonly type: "string";
|
|
1057
|
+
readonly description: "Date and time the fleet was last updated.";
|
|
1058
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
1059
|
+
};
|
|
643
1060
|
};
|
|
644
|
-
readonly required: readonly ["id"];
|
|
1061
|
+
readonly required: readonly ["constraints", "scalingProfile", "taints", "id", "ready", "created_at", "updated_at"];
|
|
645
1062
|
readonly additionalProperties: false;
|
|
1063
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
646
1064
|
};
|
|
647
1065
|
export declare const FleetUpdateInputSchema: {
|
|
648
1066
|
readonly type: "object";
|
|
@@ -651,13 +1069,12 @@ export declare const FleetUpdateInputSchema: {
|
|
|
651
1069
|
readonly type: "object";
|
|
652
1070
|
readonly properties: {
|
|
653
1071
|
readonly cpu: {
|
|
654
|
-
readonly type: "
|
|
655
|
-
readonly format: "float";
|
|
1072
|
+
readonly type: "integer";
|
|
656
1073
|
readonly minimum: 0;
|
|
657
|
-
readonly
|
|
1074
|
+
readonly maximum: 100000;
|
|
1075
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
658
1076
|
};
|
|
659
1077
|
};
|
|
660
|
-
readonly required: readonly ["cpu"];
|
|
661
1078
|
readonly additionalProperties: false;
|
|
662
1079
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
663
1080
|
};
|
|
@@ -666,14 +1083,15 @@ export declare const FleetUpdateInputSchema: {
|
|
|
666
1083
|
readonly properties: {
|
|
667
1084
|
readonly enabled: {
|
|
668
1085
|
readonly type: "boolean";
|
|
669
|
-
readonly default: true;
|
|
670
1086
|
};
|
|
671
1087
|
readonly project: {
|
|
672
1088
|
readonly type: "string";
|
|
673
|
-
readonly
|
|
1089
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
1090
|
+
readonly 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.";
|
|
1091
|
+
readonly example: "my-cloudfleet-project";
|
|
674
1092
|
};
|
|
675
1093
|
};
|
|
676
|
-
readonly required: readonly ["
|
|
1094
|
+
readonly required: readonly ["enabled"];
|
|
677
1095
|
readonly additionalProperties: false;
|
|
678
1096
|
};
|
|
679
1097
|
readonly hetzner: {
|
|
@@ -681,14 +1099,16 @@ export declare const FleetUpdateInputSchema: {
|
|
|
681
1099
|
readonly properties: {
|
|
682
1100
|
readonly enabled: {
|
|
683
1101
|
readonly type: "boolean";
|
|
684
|
-
readonly default: true;
|
|
685
1102
|
};
|
|
686
1103
|
readonly apiKey: {
|
|
687
1104
|
readonly type: "string";
|
|
688
|
-
readonly
|
|
1105
|
+
readonly maxLength: 64;
|
|
1106
|
+
readonly minLength: 64;
|
|
1107
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
1108
|
+
readonly 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.";
|
|
689
1109
|
};
|
|
690
1110
|
};
|
|
691
|
-
readonly required: readonly ["
|
|
1111
|
+
readonly required: readonly ["enabled"];
|
|
692
1112
|
readonly additionalProperties: false;
|
|
693
1113
|
};
|
|
694
1114
|
readonly aws: {
|
|
@@ -696,17 +1116,128 @@ export declare const FleetUpdateInputSchema: {
|
|
|
696
1116
|
readonly properties: {
|
|
697
1117
|
readonly enabled: {
|
|
698
1118
|
readonly type: "boolean";
|
|
699
|
-
readonly default: true;
|
|
700
1119
|
};
|
|
701
1120
|
readonly controllerRoleArn: {
|
|
702
1121
|
readonly type: "string";
|
|
703
|
-
readonly
|
|
1122
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
1123
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
1124
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
1125
|
+
};
|
|
1126
|
+
};
|
|
1127
|
+
readonly required: readonly ["enabled"];
|
|
1128
|
+
readonly additionalProperties: false;
|
|
1129
|
+
};
|
|
1130
|
+
readonly constraints: {
|
|
1131
|
+
readonly type: "object";
|
|
1132
|
+
readonly properties: {
|
|
1133
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
1134
|
+
readonly type: "array";
|
|
1135
|
+
readonly items: {
|
|
1136
|
+
readonly type: "string";
|
|
1137
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
1138
|
+
};
|
|
1139
|
+
readonly minItems: 1;
|
|
1140
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
1141
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
1142
|
+
};
|
|
1143
|
+
readonly 'kubernetes.io/arch': {
|
|
1144
|
+
readonly type: "array";
|
|
1145
|
+
readonly items: {
|
|
1146
|
+
readonly type: "string";
|
|
1147
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
1148
|
+
};
|
|
1149
|
+
readonly minItems: 1;
|
|
1150
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
1151
|
+
readonly default: readonly ["amd64"];
|
|
1152
|
+
};
|
|
1153
|
+
readonly 'cfke.io/instance-family': {
|
|
1154
|
+
readonly type: "array";
|
|
1155
|
+
readonly items: {
|
|
1156
|
+
readonly type: "string";
|
|
1157
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
1158
|
+
};
|
|
1159
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
1160
|
+
readonly default: readonly [];
|
|
1161
|
+
};
|
|
1162
|
+
readonly 'topology.kubernetes.io/region': {
|
|
1163
|
+
readonly type: "array";
|
|
1164
|
+
readonly items: {
|
|
1165
|
+
readonly type: "string";
|
|
1166
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
1167
|
+
};
|
|
1168
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
1169
|
+
readonly default: readonly [];
|
|
1170
|
+
};
|
|
1171
|
+
};
|
|
1172
|
+
readonly additionalProperties: false;
|
|
1173
|
+
readonly 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.";
|
|
1174
|
+
readonly default: {
|
|
1175
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
1176
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
1177
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
1178
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
1179
|
+
};
|
|
1180
|
+
};
|
|
1181
|
+
readonly scalingProfile: {
|
|
1182
|
+
readonly type: "string";
|
|
1183
|
+
readonly 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`).";
|
|
1184
|
+
readonly default: "conservative";
|
|
1185
|
+
readonly example: "conservative";
|
|
1186
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
1187
|
+
};
|
|
1188
|
+
readonly taints: {
|
|
1189
|
+
readonly type: "array";
|
|
1190
|
+
readonly items: {
|
|
1191
|
+
readonly type: "object";
|
|
1192
|
+
readonly properties: {
|
|
1193
|
+
readonly key: {
|
|
1194
|
+
readonly type: "string";
|
|
1195
|
+
readonly description: "Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.";
|
|
1196
|
+
readonly example: "dedicated";
|
|
1197
|
+
};
|
|
1198
|
+
readonly value: {
|
|
1199
|
+
readonly type: "string";
|
|
1200
|
+
readonly maxLength: 63;
|
|
1201
|
+
readonly pattern: "^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$";
|
|
1202
|
+
readonly description: "Taint value. Optional.";
|
|
1203
|
+
readonly example: "ci";
|
|
1204
|
+
};
|
|
1205
|
+
readonly effect: {
|
|
1206
|
+
readonly type: "string";
|
|
1207
|
+
readonly description: "Taint effect.";
|
|
1208
|
+
readonly example: "NoSchedule";
|
|
1209
|
+
readonly enum: readonly ["NoSchedule", "PreferNoSchedule", "NoExecute"];
|
|
1210
|
+
};
|
|
704
1211
|
};
|
|
1212
|
+
readonly required: readonly ["key", "effect"];
|
|
1213
|
+
readonly additionalProperties: false;
|
|
705
1214
|
};
|
|
706
|
-
readonly
|
|
707
|
-
readonly
|
|
1215
|
+
readonly maxItems: 50;
|
|
1216
|
+
readonly description: "Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.";
|
|
1217
|
+
readonly default: readonly [];
|
|
1218
|
+
};
|
|
1219
|
+
};
|
|
1220
|
+
readonly additionalProperties: false;
|
|
1221
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
1222
|
+
};
|
|
1223
|
+
export declare const InviteCreateInputSchema: {
|
|
1224
|
+
readonly type: "object";
|
|
1225
|
+
readonly properties: {
|
|
1226
|
+
readonly email: {
|
|
1227
|
+
readonly type: "string";
|
|
1228
|
+
readonly format: "email";
|
|
1229
|
+
readonly description: "Email address of the user to invite.";
|
|
1230
|
+
readonly example: "email@example.com";
|
|
1231
|
+
};
|
|
1232
|
+
readonly role: {
|
|
1233
|
+
readonly type: "string";
|
|
1234
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1235
|
+
readonly default: "User";
|
|
1236
|
+
readonly example: "User";
|
|
1237
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
708
1238
|
};
|
|
709
1239
|
};
|
|
1240
|
+
readonly required: readonly ["email"];
|
|
710
1241
|
readonly additionalProperties: false;
|
|
711
1242
|
};
|
|
712
1243
|
export declare const InviteSchema: {
|
|
@@ -740,10 +1271,141 @@ export declare const InviteSchema: {
|
|
|
740
1271
|
readonly description: "Generated unique invite code.";
|
|
741
1272
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
742
1273
|
};
|
|
1274
|
+
readonly role: {
|
|
1275
|
+
readonly type: "string";
|
|
1276
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1277
|
+
readonly default: "User";
|
|
1278
|
+
readonly example: "User";
|
|
1279
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1280
|
+
};
|
|
743
1281
|
};
|
|
744
1282
|
readonly required: readonly ["date_created"];
|
|
745
1283
|
readonly additionalProperties: false;
|
|
746
1284
|
};
|
|
1285
|
+
export declare const InvoicePaymentAttemptSchema: {
|
|
1286
|
+
readonly type: "object";
|
|
1287
|
+
readonly properties: {
|
|
1288
|
+
readonly invoice_id: {
|
|
1289
|
+
readonly type: "string";
|
|
1290
|
+
readonly description: "Identifier of the invoice.";
|
|
1291
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
1292
|
+
};
|
|
1293
|
+
readonly number: {
|
|
1294
|
+
readonly type: "string";
|
|
1295
|
+
readonly nullable: true;
|
|
1296
|
+
readonly description: "Invoice number. Null if the invoice has no number.";
|
|
1297
|
+
readonly example: "CF-0042";
|
|
1298
|
+
};
|
|
1299
|
+
readonly amount: {
|
|
1300
|
+
readonly type: "number";
|
|
1301
|
+
readonly format: "float";
|
|
1302
|
+
readonly description: "Amount outstanding when the charge was attempted, in the smallest currency unit.";
|
|
1303
|
+
readonly example: 4200;
|
|
1304
|
+
};
|
|
1305
|
+
readonly currency: {
|
|
1306
|
+
readonly type: "string";
|
|
1307
|
+
readonly description: "Currency of the invoice.";
|
|
1308
|
+
readonly example: "eur";
|
|
1309
|
+
};
|
|
1310
|
+
readonly status: {
|
|
1311
|
+
readonly type: "string";
|
|
1312
|
+
readonly description: "Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).";
|
|
1313
|
+
readonly example: "paid";
|
|
1314
|
+
readonly enum: readonly ["paid", "processing", "requires_action", "failed"];
|
|
1315
|
+
};
|
|
1316
|
+
readonly client_secret: {
|
|
1317
|
+
readonly type: "string";
|
|
1318
|
+
readonly nullable: true;
|
|
1319
|
+
readonly description: "Client secret used to complete customer authentication. Set only when `status` is `requires_action`.";
|
|
1320
|
+
readonly example: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH";
|
|
1321
|
+
};
|
|
1322
|
+
readonly failure_code: {
|
|
1323
|
+
readonly type: "string";
|
|
1324
|
+
readonly nullable: true;
|
|
1325
|
+
readonly description: "Decline code. Set only when `status` is `failed`.";
|
|
1326
|
+
readonly example: "insufficient_funds";
|
|
1327
|
+
};
|
|
1328
|
+
readonly failure_message: {
|
|
1329
|
+
readonly type: "string";
|
|
1330
|
+
readonly nullable: true;
|
|
1331
|
+
readonly description: "Explanation of the decline, suitable for display. Set only when `status` is `failed`.";
|
|
1332
|
+
readonly example: "Your card has insufficient funds.";
|
|
1333
|
+
};
|
|
1334
|
+
};
|
|
1335
|
+
readonly required: readonly ["invoice_id", "number", "amount", "currency", "status", "client_secret", "failure_code", "failure_message"];
|
|
1336
|
+
readonly additionalProperties: false;
|
|
1337
|
+
};
|
|
1338
|
+
export declare const InvoicePaymentResultSchema: {
|
|
1339
|
+
readonly type: "object";
|
|
1340
|
+
readonly properties: {
|
|
1341
|
+
readonly code: {
|
|
1342
|
+
readonly type: "string";
|
|
1343
|
+
readonly 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).";
|
|
1344
|
+
readonly example: "partially_paid";
|
|
1345
|
+
readonly enum: readonly ["paid", "processing", "action_required", "partially_paid", "failed", "nothing_due", "bank_transfer_due"];
|
|
1346
|
+
};
|
|
1347
|
+
readonly message: {
|
|
1348
|
+
readonly type: "string";
|
|
1349
|
+
readonly description: "Summary of the outcome, suitable for display.";
|
|
1350
|
+
readonly example: "1 of 2 open invoices was paid. Invoice CF-0043 was declined: Your card has insufficient funds.";
|
|
1351
|
+
};
|
|
1352
|
+
readonly results: {
|
|
1353
|
+
readonly type: "array";
|
|
1354
|
+
readonly items: {
|
|
1355
|
+
readonly type: "object";
|
|
1356
|
+
readonly properties: {
|
|
1357
|
+
readonly invoice_id: {
|
|
1358
|
+
readonly type: "string";
|
|
1359
|
+
readonly description: "Identifier of the invoice.";
|
|
1360
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
1361
|
+
};
|
|
1362
|
+
readonly number: {
|
|
1363
|
+
readonly type: "string";
|
|
1364
|
+
readonly description: "Invoice number. Null if the invoice has no number.";
|
|
1365
|
+
readonly example: "CF-0042";
|
|
1366
|
+
};
|
|
1367
|
+
readonly amount: {
|
|
1368
|
+
readonly type: "number";
|
|
1369
|
+
readonly format: "float";
|
|
1370
|
+
readonly description: "Amount outstanding when the charge was attempted, in the smallest currency unit.";
|
|
1371
|
+
readonly example: 4200;
|
|
1372
|
+
};
|
|
1373
|
+
readonly currency: {
|
|
1374
|
+
readonly type: "string";
|
|
1375
|
+
readonly description: "Currency of the invoice.";
|
|
1376
|
+
readonly example: "eur";
|
|
1377
|
+
};
|
|
1378
|
+
readonly status: {
|
|
1379
|
+
readonly type: "string";
|
|
1380
|
+
readonly description: "Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).";
|
|
1381
|
+
readonly example: "paid";
|
|
1382
|
+
readonly enum: readonly ["paid", "processing", "requires_action", "failed"];
|
|
1383
|
+
};
|
|
1384
|
+
readonly client_secret: {
|
|
1385
|
+
readonly type: "string";
|
|
1386
|
+
readonly description: "Client secret used to complete customer authentication. Set only when `status` is `requires_action`.";
|
|
1387
|
+
readonly example: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH";
|
|
1388
|
+
};
|
|
1389
|
+
readonly failure_code: {
|
|
1390
|
+
readonly type: "string";
|
|
1391
|
+
readonly description: "Decline code. Set only when `status` is `failed`.";
|
|
1392
|
+
readonly example: "insufficient_funds";
|
|
1393
|
+
};
|
|
1394
|
+
readonly failure_message: {
|
|
1395
|
+
readonly type: "string";
|
|
1396
|
+
readonly description: "Explanation of the decline, suitable for display. Set only when `status` is `failed`.";
|
|
1397
|
+
readonly example: "Your card has insufficient funds.";
|
|
1398
|
+
};
|
|
1399
|
+
};
|
|
1400
|
+
readonly required: readonly ["invoice_id", "number", "amount", "currency", "status", "client_secret", "failure_code", "failure_message"];
|
|
1401
|
+
readonly additionalProperties: false;
|
|
1402
|
+
};
|
|
1403
|
+
readonly description: "One entry per invoice charged, oldest first.";
|
|
1404
|
+
};
|
|
1405
|
+
};
|
|
1406
|
+
readonly required: readonly ["code", "message", "results"];
|
|
1407
|
+
readonly additionalProperties: false;
|
|
1408
|
+
};
|
|
747
1409
|
export declare const InvoiceSchema: {
|
|
748
1410
|
readonly type: "object";
|
|
749
1411
|
readonly properties: {
|
|
@@ -937,6 +1599,12 @@ export declare const MarketplaceListingSchema: {
|
|
|
937
1599
|
export declare const OrganizationCreateInputSchema: {
|
|
938
1600
|
readonly type: "object";
|
|
939
1601
|
readonly properties: {
|
|
1602
|
+
readonly type: {
|
|
1603
|
+
readonly type: "string";
|
|
1604
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1605
|
+
readonly example: "business";
|
|
1606
|
+
readonly enum: readonly ["business", "personal"];
|
|
1607
|
+
};
|
|
940
1608
|
readonly email: {
|
|
941
1609
|
readonly type: "string";
|
|
942
1610
|
readonly format: "email";
|
|
@@ -945,11 +1613,13 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
945
1613
|
};
|
|
946
1614
|
readonly first_name: {
|
|
947
1615
|
readonly type: "string";
|
|
1616
|
+
readonly minLength: 1;
|
|
948
1617
|
readonly description: "First name of the billing contact person.";
|
|
949
1618
|
readonly example: "John";
|
|
950
1619
|
};
|
|
951
1620
|
readonly last_name: {
|
|
952
1621
|
readonly type: "string";
|
|
1622
|
+
readonly minLength: 1;
|
|
953
1623
|
readonly description: "Last name of the billing contact person.";
|
|
954
1624
|
readonly example: "Doe";
|
|
955
1625
|
};
|
|
@@ -967,7 +1637,19 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
967
1637
|
readonly description: "Password for the root account. Must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one number and one special character.";
|
|
968
1638
|
};
|
|
969
1639
|
};
|
|
970
|
-
readonly required: readonly ["email", "first_name", "last_name", "company_name", "password"];
|
|
1640
|
+
readonly required: readonly ["type", "email", "first_name", "last_name", "company_name", "password"];
|
|
1641
|
+
readonly additionalProperties: false;
|
|
1642
|
+
};
|
|
1643
|
+
export declare const OrganizationCreateOutputSchema: {
|
|
1644
|
+
readonly type: "object";
|
|
1645
|
+
readonly properties: {
|
|
1646
|
+
readonly id: {
|
|
1647
|
+
readonly type: "string";
|
|
1648
|
+
readonly description: "Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.";
|
|
1649
|
+
readonly example: "organization-id";
|
|
1650
|
+
};
|
|
1651
|
+
};
|
|
1652
|
+
readonly required: readonly ["id"];
|
|
971
1653
|
readonly additionalProperties: false;
|
|
972
1654
|
};
|
|
973
1655
|
export declare const OrganizationSchema: {
|
|
@@ -986,6 +1668,12 @@ export declare const OrganizationSchema: {
|
|
|
986
1668
|
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
987
1669
|
readonly example: "ACME Corp.";
|
|
988
1670
|
};
|
|
1671
|
+
readonly type: {
|
|
1672
|
+
readonly type: "string";
|
|
1673
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1674
|
+
readonly example: "business";
|
|
1675
|
+
readonly enum: readonly ["business", "personal"];
|
|
1676
|
+
};
|
|
989
1677
|
readonly date_created: {
|
|
990
1678
|
readonly type: "string";
|
|
991
1679
|
readonly format: "date-time";
|
|
@@ -1017,6 +1705,17 @@ export declare const OrganizationSchema: {
|
|
|
1017
1705
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1018
1706
|
readonly example: 999;
|
|
1019
1707
|
};
|
|
1708
|
+
readonly enterprise_clusters_max: {
|
|
1709
|
+
readonly type: "integer";
|
|
1710
|
+
readonly minimum: 0;
|
|
1711
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1712
|
+
readonly example: 999;
|
|
1713
|
+
};
|
|
1714
|
+
readonly enterprise_clusters_available: {
|
|
1715
|
+
readonly type: "integer";
|
|
1716
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1717
|
+
readonly example: 999;
|
|
1718
|
+
};
|
|
1020
1719
|
readonly fleets_max: {
|
|
1021
1720
|
readonly type: "integer";
|
|
1022
1721
|
readonly minimum: 0;
|
|
@@ -1036,7 +1735,7 @@ export declare const OrganizationSchema: {
|
|
|
1036
1735
|
readonly type: "array";
|
|
1037
1736
|
readonly items: {
|
|
1038
1737
|
readonly type: "string";
|
|
1039
|
-
readonly example: "northamerica-central-
|
|
1738
|
+
readonly example: "northamerica-central-1a";
|
|
1040
1739
|
};
|
|
1041
1740
|
readonly minItems: 1;
|
|
1042
1741
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1070,7 +1769,7 @@ export declare const OrganizationSchema: {
|
|
|
1070
1769
|
readonly example: 500;
|
|
1071
1770
|
};
|
|
1072
1771
|
};
|
|
1073
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1772
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "enterprise_clusters_max", "enterprise_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1074
1773
|
readonly additionalProperties: false;
|
|
1075
1774
|
readonly description: "For security reasons, platform quota is controlled by Cloudfleet and can be updated only by Cloudfleet administrators. Please open a support ticket if you need to change the platform quota.";
|
|
1076
1775
|
};
|
|
@@ -1079,8 +1778,14 @@ export declare const OrganizationSchema: {
|
|
|
1079
1778
|
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1080
1779
|
readonly enum: readonly ["active", "closed", "suspended"];
|
|
1081
1780
|
};
|
|
1781
|
+
readonly verification: {
|
|
1782
|
+
readonly type: "string";
|
|
1783
|
+
readonly 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.";
|
|
1784
|
+
readonly example: "verified";
|
|
1785
|
+
readonly enum: readonly ["none", "submitted", "verified"];
|
|
1786
|
+
};
|
|
1082
1787
|
};
|
|
1083
|
-
readonly required: readonly ["id", "date_created", "quota", "status"];
|
|
1788
|
+
readonly required: readonly ["id", "type", "date_created", "quota", "status", "verification"];
|
|
1084
1789
|
readonly additionalProperties: false;
|
|
1085
1790
|
};
|
|
1086
1791
|
export declare const PaymentMethodSchema: {
|
|
@@ -1088,26 +1793,19 @@ export declare const PaymentMethodSchema: {
|
|
|
1088
1793
|
readonly properties: {
|
|
1089
1794
|
readonly id: {
|
|
1090
1795
|
readonly type: "string";
|
|
1091
|
-
readonly
|
|
1092
|
-
readonly
|
|
1093
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1094
|
-
};
|
|
1095
|
-
readonly setup: {
|
|
1096
|
-
readonly type: "boolean";
|
|
1097
|
-
readonly description: "Whether organization payment method was set up and ready to use for payments.";
|
|
1098
|
-
readonly example: true;
|
|
1796
|
+
readonly 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.";
|
|
1797
|
+
readonly example: "pm_1MtwBwLkdIwHu7ix28a3tqPa";
|
|
1099
1798
|
};
|
|
1100
1799
|
readonly type: {
|
|
1101
1800
|
readonly type: "string";
|
|
1102
|
-
readonly
|
|
1103
|
-
readonly description: "Payment method type type. Only `card` payments supported at the moment.";
|
|
1801
|
+
readonly description: "Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.";
|
|
1104
1802
|
readonly example: "card";
|
|
1105
|
-
readonly enum: readonly ["card"];
|
|
1803
|
+
readonly enum: readonly ["card", "sepa_debit", "bank_transfer"];
|
|
1106
1804
|
};
|
|
1107
1805
|
readonly last4: {
|
|
1108
1806
|
readonly type: "string";
|
|
1109
1807
|
readonly nullable: true;
|
|
1110
|
-
readonly description: "Last 4 digits of the payment card number.";
|
|
1808
|
+
readonly 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.";
|
|
1111
1809
|
readonly example: "4242";
|
|
1112
1810
|
};
|
|
1113
1811
|
readonly exp_month: {
|
|
@@ -1115,25 +1813,46 @@ export declare const PaymentMethodSchema: {
|
|
|
1115
1813
|
readonly minimum: 1;
|
|
1116
1814
|
readonly maximum: 12;
|
|
1117
1815
|
readonly nullable: true;
|
|
1118
|
-
readonly description: "Two-digit number representing the card's expiration month.";
|
|
1119
|
-
readonly example:
|
|
1816
|
+
readonly description: "Two-digit number representing the card's expiration month. Null for SEPA Direct Debit and bank transfer.";
|
|
1817
|
+
readonly example: 12;
|
|
1120
1818
|
};
|
|
1121
1819
|
readonly exp_year: {
|
|
1122
1820
|
readonly type: "integer";
|
|
1123
|
-
readonly minimum: 2024;
|
|
1124
1821
|
readonly nullable: true;
|
|
1125
|
-
readonly description: "Four-digit number representing the card's expiration year.";
|
|
1126
|
-
readonly example:
|
|
1822
|
+
readonly 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.";
|
|
1823
|
+
readonly example: 2028;
|
|
1127
1824
|
};
|
|
1128
1825
|
readonly brand: {
|
|
1129
1826
|
readonly type: "string";
|
|
1130
1827
|
readonly nullable: true;
|
|
1131
|
-
readonly description: "Payment card brand
|
|
1828
|
+
readonly 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.";
|
|
1132
1829
|
readonly example: "visa";
|
|
1133
|
-
|
|
1830
|
+
};
|
|
1831
|
+
readonly iban: {
|
|
1832
|
+
readonly type: "string";
|
|
1833
|
+
readonly nullable: true;
|
|
1834
|
+
readonly 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.";
|
|
1835
|
+
readonly example: "DE11243015658023127510";
|
|
1836
|
+
};
|
|
1837
|
+
readonly bic: {
|
|
1838
|
+
readonly type: "string";
|
|
1839
|
+
readonly nullable: true;
|
|
1840
|
+
readonly description: "BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1841
|
+
readonly example: "SOGEDEFFXXX";
|
|
1842
|
+
};
|
|
1843
|
+
readonly account_holder_name: {
|
|
1844
|
+
readonly type: "string";
|
|
1845
|
+
readonly nullable: true;
|
|
1846
|
+
readonly description: "Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1847
|
+
readonly example: "Cloudfleet GmbH";
|
|
1848
|
+
};
|
|
1849
|
+
readonly is_default: {
|
|
1850
|
+
readonly type: "boolean";
|
|
1851
|
+
readonly 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).";
|
|
1852
|
+
readonly example: true;
|
|
1134
1853
|
};
|
|
1135
1854
|
};
|
|
1136
|
-
readonly required: readonly ["id", "
|
|
1855
|
+
readonly required: readonly ["id", "type", "last4", "exp_month", "exp_year", "brand", "iban", "bic", "account_holder_name", "is_default"];
|
|
1137
1856
|
readonly additionalProperties: false;
|
|
1138
1857
|
};
|
|
1139
1858
|
export declare const PlatformQuotaSchema: {
|
|
@@ -1161,6 +1880,17 @@ export declare const PlatformQuotaSchema: {
|
|
|
1161
1880
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1162
1881
|
readonly example: 999;
|
|
1163
1882
|
};
|
|
1883
|
+
readonly enterprise_clusters_max: {
|
|
1884
|
+
readonly type: "integer";
|
|
1885
|
+
readonly minimum: 0;
|
|
1886
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1887
|
+
readonly example: 999;
|
|
1888
|
+
};
|
|
1889
|
+
readonly enterprise_clusters_available: {
|
|
1890
|
+
readonly type: "integer";
|
|
1891
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1892
|
+
readonly example: 999;
|
|
1893
|
+
};
|
|
1164
1894
|
readonly fleets_max: {
|
|
1165
1895
|
readonly type: "integer";
|
|
1166
1896
|
readonly minimum: 0;
|
|
@@ -1180,7 +1910,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1180
1910
|
readonly type: "array";
|
|
1181
1911
|
readonly items: {
|
|
1182
1912
|
readonly type: "string";
|
|
1183
|
-
readonly example: "northamerica-central-
|
|
1913
|
+
readonly example: "northamerica-central-1a";
|
|
1184
1914
|
};
|
|
1185
1915
|
readonly minItems: 1;
|
|
1186
1916
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1214,7 +1944,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1214
1944
|
readonly example: 500;
|
|
1215
1945
|
};
|
|
1216
1946
|
};
|
|
1217
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1947
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "enterprise_clusters_max", "enterprise_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1218
1948
|
readonly additionalProperties: false;
|
|
1219
1949
|
};
|
|
1220
1950
|
export declare const RegistryRepositorySchema: {
|
|
@@ -1448,6 +2178,57 @@ export declare const RegistryTagSchema: {
|
|
|
1448
2178
|
readonly required: readonly ["name", "digest", "size", "region", "repository", "uri"];
|
|
1449
2179
|
readonly additionalProperties: false;
|
|
1450
2180
|
};
|
|
2181
|
+
export declare const RoadmapItemCreateInputSchema: {
|
|
2182
|
+
readonly type: "object";
|
|
2183
|
+
readonly properties: {
|
|
2184
|
+
readonly text: {
|
|
2185
|
+
readonly type: "string";
|
|
2186
|
+
readonly maxLength: 500;
|
|
2187
|
+
readonly minLength: 1;
|
|
2188
|
+
readonly description: "Your suggestion in one or two sentences. It is reviewed before it appears on the roadmap.";
|
|
2189
|
+
readonly example: "Support for ARM nodes on Hetzner.";
|
|
2190
|
+
};
|
|
2191
|
+
};
|
|
2192
|
+
readonly required: readonly ["text"];
|
|
2193
|
+
readonly additionalProperties: false;
|
|
2194
|
+
};
|
|
2195
|
+
export declare const RoadmapItemSchema: {
|
|
2196
|
+
readonly type: "object";
|
|
2197
|
+
readonly properties: {
|
|
2198
|
+
readonly id: {
|
|
2199
|
+
readonly type: "string";
|
|
2200
|
+
readonly description: "Unique identifier of the roadmap item (Mongo ObjectId).";
|
|
2201
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
2202
|
+
};
|
|
2203
|
+
readonly text: {
|
|
2204
|
+
readonly type: "string";
|
|
2205
|
+
readonly description: "Short description of the roadmap item.";
|
|
2206
|
+
readonly example: "Support for ARM nodes on Hetzner.";
|
|
2207
|
+
};
|
|
2208
|
+
readonly vote: {
|
|
2209
|
+
readonly type: "integer";
|
|
2210
|
+
readonly nullable: true;
|
|
2211
|
+
readonly description: "The caller's vote on this item: -1 (down), 1 (up), 2 (double up), or null if the caller has not voted.";
|
|
2212
|
+
readonly example: 1;
|
|
2213
|
+
readonly enum: readonly [-1, 1, 2];
|
|
2214
|
+
};
|
|
2215
|
+
};
|
|
2216
|
+
readonly required: readonly ["id", "text", "vote"];
|
|
2217
|
+
readonly additionalProperties: false;
|
|
2218
|
+
};
|
|
2219
|
+
export declare const RoadmapVoteInputSchema: {
|
|
2220
|
+
readonly type: "object";
|
|
2221
|
+
readonly properties: {
|
|
2222
|
+
readonly value: {
|
|
2223
|
+
readonly type: "integer";
|
|
2224
|
+
readonly description: "Vote value: -1 (down), 1 (up), or 2 (double up).";
|
|
2225
|
+
readonly example: 1;
|
|
2226
|
+
readonly enum: readonly [-1, 1, 2];
|
|
2227
|
+
};
|
|
2228
|
+
};
|
|
2229
|
+
readonly required: readonly ["value"];
|
|
2230
|
+
readonly additionalProperties: false;
|
|
2231
|
+
};
|
|
1451
2232
|
export declare const TicketAttachmentSchema: {
|
|
1452
2233
|
readonly type: "object";
|
|
1453
2234
|
readonly properties: {
|
|
@@ -1501,144 +2282,13 @@ export declare const TicketCreateInputSchema: {
|
|
|
1501
2282
|
readonly cluster_id: "60c72b2f9f1b2c001f8e4d3a";
|
|
1502
2283
|
};
|
|
1503
2284
|
};
|
|
1504
|
-
|
|
1505
|
-
|
|
1506
|
-
|
|
1507
|
-
|
|
1508
|
-
export declare const TicketListResponseSchema: {
|
|
1509
|
-
readonly type: "object";
|
|
1510
|
-
readonly properties: {
|
|
1511
|
-
readonly items: {
|
|
1512
|
-
readonly type: "array";
|
|
1513
|
-
readonly items: {
|
|
1514
|
-
readonly type: "object";
|
|
1515
|
-
readonly properties: {
|
|
1516
|
-
readonly id: {
|
|
1517
|
-
readonly type: "string";
|
|
1518
|
-
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
1519
|
-
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
1520
|
-
};
|
|
1521
|
-
readonly status: {
|
|
1522
|
-
readonly type: "string";
|
|
1523
|
-
readonly description: "Current state of the ticket.";
|
|
1524
|
-
readonly example: "waiting_on_us";
|
|
1525
|
-
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
1526
|
-
};
|
|
1527
|
-
readonly category: {
|
|
1528
|
-
readonly type: "string";
|
|
1529
|
-
readonly description: "Ticket category.";
|
|
1530
|
-
readonly example: "technical";
|
|
1531
|
-
readonly enum: readonly ["billing", "technical", "general"];
|
|
1532
|
-
};
|
|
1533
|
-
readonly summary: {
|
|
1534
|
-
readonly type: "string";
|
|
1535
|
-
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
1536
|
-
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
1537
|
-
};
|
|
1538
|
-
readonly closed_at: {
|
|
1539
|
-
readonly type: "string";
|
|
1540
|
-
readonly format: "date-time";
|
|
1541
|
-
readonly nullable: true;
|
|
1542
|
-
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
1543
|
-
readonly example: "2026-05-18T16:08:14.338Z";
|
|
1544
|
-
};
|
|
1545
|
-
readonly date_created: {
|
|
1546
|
-
readonly type: "string";
|
|
1547
|
-
readonly format: "date-time";
|
|
1548
|
-
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
1549
|
-
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1550
|
-
};
|
|
1551
|
-
readonly date_updated: {
|
|
1552
|
-
readonly type: "string";
|
|
1553
|
-
readonly format: "date-time";
|
|
1554
|
-
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
1555
|
-
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1556
|
-
};
|
|
1557
|
-
readonly messages: {
|
|
1558
|
-
readonly type: "array";
|
|
1559
|
-
readonly items: {
|
|
1560
|
-
readonly type: "object";
|
|
1561
|
-
readonly properties: {
|
|
1562
|
-
readonly id: {
|
|
1563
|
-
readonly type: "string";
|
|
1564
|
-
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
1565
|
-
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
1566
|
-
};
|
|
1567
|
-
readonly type: {
|
|
1568
|
-
readonly type: "string";
|
|
1569
|
-
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
1570
|
-
readonly example: "customer_reply";
|
|
1571
|
-
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
1572
|
-
};
|
|
1573
|
-
readonly body: {
|
|
1574
|
-
readonly type: "string";
|
|
1575
|
-
readonly description: "Message body in markdown.";
|
|
1576
|
-
readonly example: "Thanks — that resolved it on my side.";
|
|
1577
|
-
};
|
|
1578
|
-
readonly author_first_name: {
|
|
1579
|
-
readonly type: "string";
|
|
1580
|
-
readonly nullable: true;
|
|
1581
|
-
readonly description: "First name of the author. Null when not provided.";
|
|
1582
|
-
readonly example: "Jane";
|
|
1583
|
-
};
|
|
1584
|
-
readonly author_last_name: {
|
|
1585
|
-
readonly type: "string";
|
|
1586
|
-
readonly nullable: true;
|
|
1587
|
-
readonly description: "Last name of the author. Null when not provided.";
|
|
1588
|
-
readonly example: "Doe";
|
|
1589
|
-
};
|
|
1590
|
-
readonly attachments: {
|
|
1591
|
-
readonly type: "array";
|
|
1592
|
-
readonly items: {
|
|
1593
|
-
readonly type: "object";
|
|
1594
|
-
readonly properties: {
|
|
1595
|
-
readonly id: {
|
|
1596
|
-
readonly type: "string";
|
|
1597
|
-
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
1598
|
-
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1599
|
-
};
|
|
1600
|
-
readonly filename: {
|
|
1601
|
-
readonly type: "string";
|
|
1602
|
-
readonly description: "Original filename as uploaded.";
|
|
1603
|
-
readonly example: "debug.log";
|
|
1604
|
-
};
|
|
1605
|
-
readonly content_type: {
|
|
1606
|
-
readonly type: "string";
|
|
1607
|
-
readonly description: "MIME content type of the attachment.";
|
|
1608
|
-
readonly example: "text/plain";
|
|
1609
|
-
};
|
|
1610
|
-
readonly size: {
|
|
1611
|
-
readonly type: "integer";
|
|
1612
|
-
readonly description: "Size of the attachment in bytes.";
|
|
1613
|
-
readonly example: 12345;
|
|
1614
|
-
};
|
|
1615
|
-
};
|
|
1616
|
-
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
1617
|
-
readonly additionalProperties: false;
|
|
1618
|
-
};
|
|
1619
|
-
readonly description: "Attachments associated with this message.";
|
|
1620
|
-
readonly example: readonly [];
|
|
1621
|
-
};
|
|
1622
|
-
readonly date_created: {
|
|
1623
|
-
readonly type: "string";
|
|
1624
|
-
readonly format: "date-time";
|
|
1625
|
-
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
1626
|
-
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1627
|
-
};
|
|
1628
|
-
};
|
|
1629
|
-
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
1630
|
-
readonly additionalProperties: false;
|
|
1631
|
-
};
|
|
1632
|
-
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
1633
|
-
};
|
|
1634
|
-
};
|
|
1635
|
-
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
1636
|
-
readonly additionalProperties: false;
|
|
1637
|
-
};
|
|
1638
|
-
readonly description: "Tickets for the organization, ordered newest first. Messages are omitted from list responses.";
|
|
2285
|
+
readonly grant_support_access: {
|
|
2286
|
+
readonly type: "boolean";
|
|
2287
|
+
readonly description: "Grant Cloudfleet support staff access to the organization's resources while the ticket is open. Access cannot be revoked; it ends when the ticket is closed.";
|
|
2288
|
+
readonly example: true;
|
|
1639
2289
|
};
|
|
1640
2290
|
};
|
|
1641
|
-
readonly required: readonly ["
|
|
2291
|
+
readonly required: readonly ["category", "body"];
|
|
1642
2292
|
readonly additionalProperties: false;
|
|
1643
2293
|
};
|
|
1644
2294
|
export declare const TicketMessageInputSchema: {
|
|
@@ -1677,11 +2327,13 @@ export declare const TicketMessageSchema: {
|
|
|
1677
2327
|
};
|
|
1678
2328
|
readonly author_first_name: {
|
|
1679
2329
|
readonly type: "string";
|
|
2330
|
+
readonly nullable: true;
|
|
1680
2331
|
readonly description: "First name of the author. Null when not provided.";
|
|
1681
2332
|
readonly example: "Jane";
|
|
1682
2333
|
};
|
|
1683
2334
|
readonly author_last_name: {
|
|
1684
2335
|
readonly type: "string";
|
|
2336
|
+
readonly nullable: true;
|
|
1685
2337
|
readonly description: "Last name of the author. Null when not provided.";
|
|
1686
2338
|
readonly example: "Doe";
|
|
1687
2339
|
};
|
|
@@ -1752,9 +2404,22 @@ export declare const TicketSchema: {
|
|
|
1752
2404
|
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
1753
2405
|
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
1754
2406
|
};
|
|
2407
|
+
readonly support_access_granted: {
|
|
2408
|
+
readonly type: "boolean";
|
|
2409
|
+
readonly description: "Whether Cloudfleet support staff currently have access to the organization's resources. True once access is granted and until the ticket is closed.";
|
|
2410
|
+
readonly example: true;
|
|
2411
|
+
};
|
|
2412
|
+
readonly support_access_granted_at: {
|
|
2413
|
+
readonly type: "string";
|
|
2414
|
+
readonly format: "date-time";
|
|
2415
|
+
readonly nullable: true;
|
|
2416
|
+
readonly description: "When support access was granted. Null if it never was. Kept after the ticket is closed.";
|
|
2417
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2418
|
+
};
|
|
1755
2419
|
readonly closed_at: {
|
|
1756
2420
|
readonly type: "string";
|
|
1757
2421
|
readonly format: "date-time";
|
|
2422
|
+
readonly nullable: true;
|
|
1758
2423
|
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
1759
2424
|
readonly example: "2026-05-18T16:08:14.338Z";
|
|
1760
2425
|
};
|
|
@@ -1846,7 +2511,7 @@ export declare const TicketSchema: {
|
|
|
1846
2511
|
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
1847
2512
|
};
|
|
1848
2513
|
};
|
|
1849
|
-
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
2514
|
+
readonly required: readonly ["id", "status", "category", "summary", "support_access_granted", "support_access_granted_at", "date_created", "date_updated"];
|
|
1850
2515
|
readonly additionalProperties: false;
|
|
1851
2516
|
};
|
|
1852
2517
|
export declare const TokenCreateInputSchema: {
|
|
@@ -1942,9 +2607,10 @@ export declare const UsageFacetsSchema: {
|
|
|
1942
2607
|
readonly type: "array";
|
|
1943
2608
|
readonly items: {
|
|
1944
2609
|
readonly type: "string";
|
|
2610
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
1945
2611
|
};
|
|
1946
2612
|
readonly description: "List of unique products";
|
|
1947
|
-
readonly example: readonly ["
|
|
2613
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
1948
2614
|
};
|
|
1949
2615
|
};
|
|
1950
2616
|
readonly additionalProperties: false;
|
|
@@ -1970,7 +2636,8 @@ export declare const UsageResponseSchema: {
|
|
|
1970
2636
|
readonly product: {
|
|
1971
2637
|
readonly type: "string";
|
|
1972
2638
|
readonly description: "The product the usage is associated with";
|
|
1973
|
-
readonly example: "
|
|
2639
|
+
readonly example: "cfke_controlplane_pro";
|
|
2640
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
1974
2641
|
};
|
|
1975
2642
|
readonly value: {
|
|
1976
2643
|
readonly type: "number";
|
|
@@ -2010,9 +2677,10 @@ export declare const UsageResponseSchema: {
|
|
|
2010
2677
|
readonly type: "array";
|
|
2011
2678
|
readonly items: {
|
|
2012
2679
|
readonly type: "string";
|
|
2680
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
2013
2681
|
};
|
|
2014
2682
|
readonly description: "List of unique products";
|
|
2015
|
-
readonly example: readonly ["
|
|
2683
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
2016
2684
|
};
|
|
2017
2685
|
};
|
|
2018
2686
|
readonly additionalProperties: false;
|
|
@@ -2038,7 +2706,8 @@ export declare const UsageSchema: {
|
|
|
2038
2706
|
readonly product: {
|
|
2039
2707
|
readonly type: "string";
|
|
2040
2708
|
readonly description: "The product the usage is associated with";
|
|
2041
|
-
readonly example: "
|
|
2709
|
+
readonly example: "cfke_controlplane_pro";
|
|
2710
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
2042
2711
|
};
|
|
2043
2712
|
readonly value: {
|
|
2044
2713
|
readonly type: "number";
|
|
@@ -2095,18 +2764,6 @@ export declare const UserCreateInputSchema: {
|
|
|
2095
2764
|
readonly minLength: 8;
|
|
2096
2765
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
2097
2766
|
};
|
|
2098
|
-
readonly status: {
|
|
2099
|
-
readonly type: "string";
|
|
2100
|
-
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
2101
|
-
readonly example: "active";
|
|
2102
|
-
readonly enum: readonly ["active", "inactive"];
|
|
2103
|
-
};
|
|
2104
|
-
readonly role: {
|
|
2105
|
-
readonly type: "string";
|
|
2106
|
-
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
2107
|
-
readonly example: "User";
|
|
2108
|
-
readonly enum: readonly ["Administrator", "User"];
|
|
2109
|
-
};
|
|
2110
2767
|
};
|
|
2111
2768
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
2112
2769
|
readonly additionalProperties: false;
|