@cloudfleet/sdk 0.0.1-3d290f0 → 0.0.1-3dedc4b
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 +1084 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1305 -0
- package/dist/@tanstack/react-query.gen.js.map +1 -0
- package/dist/client/client.gen.d.ts.map +1 -1
- package/dist/client/client.gen.js +114 -102
- package/dist/client/client.gen.js.map +1 -1
- package/dist/client/index.d.ts +1 -1
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js.map +1 -1
- package/dist/client/types.gen.d.ts +9 -13
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.d.ts +8 -4
- package/dist/client/utils.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.js +13 -15
- package/dist/client/utils.gen.js.map +1 -1
- package/dist/client.gen.d.ts.map +1 -1
- package/dist/client.gen.js +1 -3
- package/dist/client.gen.js.map +1 -1
- package/dist/core/auth.gen.d.ts.map +1 -1
- package/dist/core/auth.gen.js.map +1 -1
- package/dist/core/bodySerializer.gen.d.ts +16 -8
- package/dist/core/bodySerializer.gen.d.ts.map +1 -1
- package/dist/core/bodySerializer.gen.js +1 -1
- package/dist/core/bodySerializer.gen.js.map +1 -1
- package/dist/core/params.gen.d.ts +10 -0
- package/dist/core/params.gen.d.ts.map +1 -1
- package/dist/core/params.gen.js +22 -10
- package/dist/core/params.gen.js.map +1 -1
- package/dist/core/pathSerializer.gen.d.ts.map +1 -1
- package/dist/core/pathSerializer.gen.js +3 -11
- package/dist/core/pathSerializer.gen.js.map +1 -1
- package/dist/core/queryKeySerializer.gen.d.ts.map +1 -1
- package/dist/core/queryKeySerializer.gen.js +4 -11
- package/dist/core/queryKeySerializer.gen.js.map +1 -1
- package/dist/core/serverSentEvents.gen.d.ts +1 -1
- package/dist/core/serverSentEvents.gen.d.ts.map +1 -1
- package/dist/core/serverSentEvents.gen.js +6 -9
- package/dist/core/serverSentEvents.gen.js.map +1 -1
- package/dist/core/types.gen.d.ts +1 -1
- package/dist/core/types.gen.d.ts.map +1 -1
- package/dist/core/utils.gen.d.ts.map +1 -1
- package/dist/core/utils.gen.js +1 -1
- package/dist/core/utils.gen.js.map +1 -1
- package/dist/schemas.gen.d.ts +1309 -140
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +2792 -214
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +295 -185
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +446 -373
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +8 -8
- package/dist/types.gen.d.ts +1747 -681
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3733 -1419
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1523 -627
- package/dist/zod.gen.js.map +1 -1
- package/package.json +28 -8
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\", \"northamerica-central-1\", \"europe-central-1a\", \"northamerica-central-1a\". This field can not be updated after creation.";
|
|
279
|
-
readonly default: "staging";
|
|
280
|
-
readonly example: "northamerica-central-1a";
|
|
281
|
-
readonly enum: readonly ["staging", "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";
|
|
@@ -306,11 +387,26 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
306
387
|
readonly description: "Internal URL of the Kubernetes cluster control plane. This is the endpoint that kubelet uses to connect to the cluster.";
|
|
307
388
|
readonly example: "https://10.31.64.7:6443";
|
|
308
389
|
};
|
|
390
|
+
readonly cluster_dns: {
|
|
391
|
+
readonly type: "string";
|
|
392
|
+
readonly description: "Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.";
|
|
393
|
+
readonly example: "10.96.0.10";
|
|
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
|
+
};
|
|
309
400
|
readonly auth_key: {
|
|
310
401
|
readonly type: "string";
|
|
311
402
|
readonly description: "Authentication key for the cluster.";
|
|
312
403
|
readonly example: "tskey-auth-kBV8wr1dk911CNTRL-...";
|
|
313
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
|
+
};
|
|
314
410
|
readonly bootstrap_token: {
|
|
315
411
|
readonly type: "string";
|
|
316
412
|
readonly description: "Bootstrap token for the cluster.";
|
|
@@ -368,7 +464,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
368
464
|
readonly description: "OIDC Information for hosts to access to third party API's.";
|
|
369
465
|
};
|
|
370
466
|
};
|
|
371
|
-
readonly required: readonly ["certificate_authority", "endpoint", "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"];
|
|
372
468
|
readonly additionalProperties: false;
|
|
373
469
|
};
|
|
374
470
|
export declare const ClusterSchema: {
|
|
@@ -385,15 +481,100 @@ export declare const ClusterSchema: {
|
|
|
385
481
|
readonly tier: {
|
|
386
482
|
readonly type: "string";
|
|
387
483
|
readonly description: "Tier of the cluster.";
|
|
484
|
+
readonly default: "basic";
|
|
388
485
|
readonly example: "pro";
|
|
389
|
-
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
|
+
};
|
|
390
534
|
};
|
|
391
535
|
readonly region: {
|
|
392
536
|
readonly type: "string";
|
|
393
|
-
readonly description: "Cloudfleet control plane region.
|
|
394
|
-
readonly
|
|
395
|
-
|
|
396
|
-
|
|
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
|
+
};
|
|
397
578
|
};
|
|
398
579
|
readonly id: {
|
|
399
580
|
readonly type: "string";
|
|
@@ -403,16 +584,27 @@ export declare const ClusterSchema: {
|
|
|
403
584
|
};
|
|
404
585
|
readonly status: {
|
|
405
586
|
readonly type: "string";
|
|
406
|
-
readonly description: "Status of the cluster.
|
|
407
|
-
readonly example: "
|
|
408
|
-
readonly enum: readonly ["
|
|
587
|
+
readonly description: "Status of the cluster.";
|
|
588
|
+
readonly example: "deployed";
|
|
589
|
+
readonly enum: readonly ["creating", "deployed", "updating", "disabled"];
|
|
409
590
|
};
|
|
410
591
|
readonly endpoint: {
|
|
411
592
|
readonly anyOf: readonly [{
|
|
412
593
|
readonly type: "string";
|
|
413
594
|
readonly format: "uri";
|
|
414
|
-
readonly description: "URL of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
415
|
-
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";
|
|
597
|
+
}, {
|
|
598
|
+
readonly type: "string";
|
|
599
|
+
readonly enum: readonly [""];
|
|
600
|
+
}];
|
|
601
|
+
};
|
|
602
|
+
readonly endpoint_public: {
|
|
603
|
+
readonly anyOf: readonly [{
|
|
604
|
+
readonly type: "string";
|
|
605
|
+
readonly format: "uri";
|
|
606
|
+
readonly description: "Deprecated alias of `endpoint`; retained for backward compatibility.";
|
|
607
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
416
608
|
}, {
|
|
417
609
|
readonly type: "string";
|
|
418
610
|
readonly enum: readonly [""];
|
|
@@ -443,15 +635,10 @@ export declare const ClusterSchema: {
|
|
|
443
635
|
readonly description: "Indicates if the cluster is ready to be used.";
|
|
444
636
|
readonly example: true;
|
|
445
637
|
};
|
|
446
|
-
readonly version_channel: {
|
|
447
|
-
readonly type: "string";
|
|
448
|
-
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-]+)*))?$";
|
|
449
|
-
readonly description: "Version of the kubernetes cluster.";
|
|
450
|
-
readonly example: "1.x.x-cfke.x";
|
|
451
|
-
};
|
|
452
638
|
};
|
|
453
|
-
readonly required: readonly ["name", "tier", "id", "status"];
|
|
639
|
+
readonly required: readonly ["name", "tier", "version_channel", "release_channel", "features", "region", "networking", "id", "status", "ready"];
|
|
454
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.";
|
|
455
642
|
};
|
|
456
643
|
export declare const ClusterUpdateInputSchema: {
|
|
457
644
|
readonly type: "object";
|
|
@@ -467,17 +654,110 @@ export declare const ClusterUpdateInputSchema: {
|
|
|
467
654
|
readonly tier: {
|
|
468
655
|
readonly type: "string";
|
|
469
656
|
readonly description: "Tier of the cluster.";
|
|
657
|
+
readonly default: "basic";
|
|
470
658
|
readonly example: "pro";
|
|
471
|
-
readonly enum: readonly ["basic", "pro"];
|
|
659
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
472
660
|
};
|
|
473
661
|
readonly version_channel: {
|
|
474
662
|
readonly type: "string";
|
|
475
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-]+)*))?$";
|
|
476
664
|
readonly description: "Version of the kubernetes cluster.";
|
|
665
|
+
readonly default: "1.x.x-cfke.x";
|
|
477
666
|
readonly example: "1.x.x-cfke.x";
|
|
478
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
|
+
};
|
|
707
|
+
};
|
|
708
|
+
readonly required: readonly ["name"];
|
|
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.";
|
|
711
|
+
};
|
|
712
|
+
export declare const FeedbackCreateInputSchema: {
|
|
713
|
+
readonly type: "object";
|
|
714
|
+
readonly properties: {
|
|
715
|
+
readonly sentiment: {
|
|
716
|
+
readonly type: "string";
|
|
717
|
+
readonly description: "Overall sentiment: positive, neutral or negative.";
|
|
718
|
+
readonly example: "negative";
|
|
719
|
+
readonly enum: readonly ["positive", "neutral", "negative"];
|
|
720
|
+
};
|
|
721
|
+
readonly message: {
|
|
722
|
+
readonly type: "string";
|
|
723
|
+
readonly maxLength: 2000;
|
|
724
|
+
readonly minLength: 1;
|
|
725
|
+
readonly description: "What was useful, confusing, wrong or missing.";
|
|
726
|
+
readonly example: "The error for a missing kubeconfig does not say which path it looked in.";
|
|
727
|
+
};
|
|
728
|
+
readonly context: {
|
|
729
|
+
readonly type: "string";
|
|
730
|
+
readonly maxLength: 2000;
|
|
731
|
+
readonly description: "What you were trying to do when it happened.";
|
|
732
|
+
readonly example: "Connecting kubectl to a new cluster.";
|
|
733
|
+
};
|
|
734
|
+
readonly source: {
|
|
735
|
+
readonly type: "string";
|
|
736
|
+
readonly description: "Where the feedback was sent from: cli, mcp, plugin, console or api. Defaults to api.";
|
|
737
|
+
readonly default: "api";
|
|
738
|
+
readonly example: "cli";
|
|
739
|
+
readonly enum: readonly ["cli", "mcp", "plugin", "console", "api"];
|
|
740
|
+
};
|
|
741
|
+
readonly client: {
|
|
742
|
+
readonly type: "string";
|
|
743
|
+
readonly maxLength: 100;
|
|
744
|
+
readonly description: "Name and version of the sending client.";
|
|
745
|
+
readonly example: "cloudfleet-plugin-claude/0.5.0";
|
|
746
|
+
};
|
|
747
|
+
};
|
|
748
|
+
readonly required: readonly ["sentiment", "message"];
|
|
749
|
+
readonly additionalProperties: false;
|
|
750
|
+
};
|
|
751
|
+
export declare const FeedbackSchema: {
|
|
752
|
+
readonly type: "object";
|
|
753
|
+
readonly properties: {
|
|
754
|
+
readonly id: {
|
|
755
|
+
readonly type: "string";
|
|
756
|
+
readonly description: "Unique identifier of the feedback entry (Mongo ObjectId).";
|
|
757
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
758
|
+
};
|
|
479
759
|
};
|
|
480
|
-
readonly required: readonly ["
|
|
760
|
+
readonly required: readonly ["id"];
|
|
481
761
|
readonly additionalProperties: false;
|
|
482
762
|
};
|
|
483
763
|
export declare const FleetCreateInputSchema: {
|
|
@@ -487,13 +767,12 @@ export declare const FleetCreateInputSchema: {
|
|
|
487
767
|
readonly type: "object";
|
|
488
768
|
readonly properties: {
|
|
489
769
|
readonly cpu: {
|
|
490
|
-
readonly type: "
|
|
491
|
-
readonly format: "float";
|
|
770
|
+
readonly type: "integer";
|
|
492
771
|
readonly minimum: 0;
|
|
493
|
-
readonly
|
|
772
|
+
readonly maximum: 100000;
|
|
773
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
494
774
|
};
|
|
495
775
|
};
|
|
496
|
-
readonly required: readonly ["cpu"];
|
|
497
776
|
readonly additionalProperties: false;
|
|
498
777
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
499
778
|
};
|
|
@@ -502,14 +781,15 @@ export declare const FleetCreateInputSchema: {
|
|
|
502
781
|
readonly properties: {
|
|
503
782
|
readonly enabled: {
|
|
504
783
|
readonly type: "boolean";
|
|
505
|
-
readonly default: true;
|
|
506
784
|
};
|
|
507
785
|
readonly project: {
|
|
508
786
|
readonly type: "string";
|
|
509
|
-
readonly
|
|
787
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
788
|
+
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.";
|
|
789
|
+
readonly example: "my-cloudfleet-project";
|
|
510
790
|
};
|
|
511
791
|
};
|
|
512
|
-
readonly required: readonly ["
|
|
792
|
+
readonly required: readonly ["enabled"];
|
|
513
793
|
readonly additionalProperties: false;
|
|
514
794
|
};
|
|
515
795
|
readonly hetzner: {
|
|
@@ -517,14 +797,16 @@ export declare const FleetCreateInputSchema: {
|
|
|
517
797
|
readonly properties: {
|
|
518
798
|
readonly enabled: {
|
|
519
799
|
readonly type: "boolean";
|
|
520
|
-
readonly default: true;
|
|
521
800
|
};
|
|
522
801
|
readonly apiKey: {
|
|
523
802
|
readonly type: "string";
|
|
524
|
-
readonly
|
|
803
|
+
readonly maxLength: 64;
|
|
804
|
+
readonly minLength: 64;
|
|
805
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
806
|
+
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.";
|
|
525
807
|
};
|
|
526
808
|
};
|
|
527
|
-
readonly required: readonly ["
|
|
809
|
+
readonly required: readonly ["enabled"];
|
|
528
810
|
readonly additionalProperties: false;
|
|
529
811
|
};
|
|
530
812
|
readonly aws: {
|
|
@@ -532,15 +814,105 @@ export declare const FleetCreateInputSchema: {
|
|
|
532
814
|
readonly properties: {
|
|
533
815
|
readonly enabled: {
|
|
534
816
|
readonly type: "boolean";
|
|
535
|
-
readonly default: true;
|
|
536
817
|
};
|
|
537
818
|
readonly controllerRoleArn: {
|
|
538
819
|
readonly type: "string";
|
|
539
|
-
readonly
|
|
820
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
821
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
822
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
823
|
+
};
|
|
824
|
+
};
|
|
825
|
+
readonly required: readonly ["enabled"];
|
|
826
|
+
readonly additionalProperties: false;
|
|
827
|
+
};
|
|
828
|
+
readonly constraints: {
|
|
829
|
+
readonly type: "object";
|
|
830
|
+
readonly properties: {
|
|
831
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
832
|
+
readonly type: "array";
|
|
833
|
+
readonly items: {
|
|
834
|
+
readonly type: "string";
|
|
835
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
836
|
+
};
|
|
837
|
+
readonly minItems: 1;
|
|
838
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
839
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
840
|
+
};
|
|
841
|
+
readonly 'kubernetes.io/arch': {
|
|
842
|
+
readonly type: "array";
|
|
843
|
+
readonly items: {
|
|
844
|
+
readonly type: "string";
|
|
845
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
846
|
+
};
|
|
847
|
+
readonly minItems: 1;
|
|
848
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
849
|
+
readonly default: readonly ["amd64"];
|
|
850
|
+
};
|
|
851
|
+
readonly 'cfke.io/instance-family': {
|
|
852
|
+
readonly type: "array";
|
|
853
|
+
readonly items: {
|
|
854
|
+
readonly type: "string";
|
|
855
|
+
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"];
|
|
856
|
+
};
|
|
857
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
858
|
+
readonly default: readonly [];
|
|
859
|
+
};
|
|
860
|
+
readonly 'topology.kubernetes.io/region': {
|
|
861
|
+
readonly type: "array";
|
|
862
|
+
readonly items: {
|
|
863
|
+
readonly type: "string";
|
|
864
|
+
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"];
|
|
865
|
+
};
|
|
866
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
867
|
+
readonly default: readonly [];
|
|
540
868
|
};
|
|
541
869
|
};
|
|
542
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
543
870
|
readonly additionalProperties: false;
|
|
871
|
+
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.";
|
|
872
|
+
readonly default: {
|
|
873
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
874
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
875
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
876
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
877
|
+
};
|
|
878
|
+
};
|
|
879
|
+
readonly scalingProfile: {
|
|
880
|
+
readonly type: "string";
|
|
881
|
+
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`).";
|
|
882
|
+
readonly default: "conservative";
|
|
883
|
+
readonly example: "conservative";
|
|
884
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
885
|
+
};
|
|
886
|
+
readonly taints: {
|
|
887
|
+
readonly type: "array";
|
|
888
|
+
readonly items: {
|
|
889
|
+
readonly type: "object";
|
|
890
|
+
readonly properties: {
|
|
891
|
+
readonly key: {
|
|
892
|
+
readonly type: "string";
|
|
893
|
+
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.";
|
|
894
|
+
readonly example: "dedicated";
|
|
895
|
+
};
|
|
896
|
+
readonly value: {
|
|
897
|
+
readonly type: "string";
|
|
898
|
+
readonly maxLength: 63;
|
|
899
|
+
readonly pattern: "^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$";
|
|
900
|
+
readonly description: "Taint value. Optional.";
|
|
901
|
+
readonly example: "ci";
|
|
902
|
+
};
|
|
903
|
+
readonly effect: {
|
|
904
|
+
readonly type: "string";
|
|
905
|
+
readonly description: "Taint effect.";
|
|
906
|
+
readonly example: "NoSchedule";
|
|
907
|
+
readonly enum: readonly ["NoSchedule", "PreferNoSchedule", "NoExecute"];
|
|
908
|
+
};
|
|
909
|
+
};
|
|
910
|
+
readonly required: readonly ["key", "effect"];
|
|
911
|
+
readonly additionalProperties: false;
|
|
912
|
+
};
|
|
913
|
+
readonly maxItems: 50;
|
|
914
|
+
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.";
|
|
915
|
+
readonly default: readonly [];
|
|
544
916
|
};
|
|
545
917
|
readonly id: {
|
|
546
918
|
readonly type: "string";
|
|
@@ -553,6 +925,7 @@ export declare const FleetCreateInputSchema: {
|
|
|
553
925
|
};
|
|
554
926
|
readonly required: readonly ["id"];
|
|
555
927
|
readonly additionalProperties: false;
|
|
928
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
556
929
|
};
|
|
557
930
|
export declare const FleetSchema: {
|
|
558
931
|
readonly type: "object";
|
|
@@ -561,13 +934,12 @@ export declare const FleetSchema: {
|
|
|
561
934
|
readonly type: "object";
|
|
562
935
|
readonly properties: {
|
|
563
936
|
readonly cpu: {
|
|
564
|
-
readonly type: "
|
|
565
|
-
readonly format: "float";
|
|
937
|
+
readonly type: "integer";
|
|
566
938
|
readonly minimum: 0;
|
|
567
|
-
readonly
|
|
939
|
+
readonly maximum: 100000;
|
|
940
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
568
941
|
};
|
|
569
942
|
};
|
|
570
|
-
readonly required: readonly ["cpu"];
|
|
571
943
|
readonly additionalProperties: false;
|
|
572
944
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
573
945
|
};
|
|
@@ -576,14 +948,15 @@ export declare const FleetSchema: {
|
|
|
576
948
|
readonly properties: {
|
|
577
949
|
readonly enabled: {
|
|
578
950
|
readonly type: "boolean";
|
|
579
|
-
readonly default: true;
|
|
580
951
|
};
|
|
581
952
|
readonly project: {
|
|
582
953
|
readonly type: "string";
|
|
583
|
-
readonly
|
|
954
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
955
|
+
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.";
|
|
956
|
+
readonly example: "my-cloudfleet-project";
|
|
584
957
|
};
|
|
585
958
|
};
|
|
586
|
-
readonly required: readonly ["
|
|
959
|
+
readonly required: readonly ["enabled"];
|
|
587
960
|
readonly additionalProperties: false;
|
|
588
961
|
};
|
|
589
962
|
readonly hetzner: {
|
|
@@ -591,14 +964,14 @@ export declare const FleetSchema: {
|
|
|
591
964
|
readonly properties: {
|
|
592
965
|
readonly enabled: {
|
|
593
966
|
readonly type: "boolean";
|
|
594
|
-
readonly default: true;
|
|
595
967
|
};
|
|
596
968
|
readonly apiKey: {
|
|
597
969
|
readonly type: "string";
|
|
598
|
-
readonly
|
|
970
|
+
readonly pattern: "^\\*{64}$";
|
|
971
|
+
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.";
|
|
599
972
|
};
|
|
600
973
|
};
|
|
601
|
-
readonly required: readonly ["
|
|
974
|
+
readonly required: readonly ["enabled"];
|
|
602
975
|
readonly additionalProperties: false;
|
|
603
976
|
};
|
|
604
977
|
readonly aws: {
|
|
@@ -606,16 +979,107 @@ export declare const FleetSchema: {
|
|
|
606
979
|
readonly properties: {
|
|
607
980
|
readonly enabled: {
|
|
608
981
|
readonly type: "boolean";
|
|
609
|
-
readonly default: true;
|
|
610
982
|
};
|
|
611
983
|
readonly controllerRoleArn: {
|
|
612
984
|
readonly type: "string";
|
|
613
|
-
readonly
|
|
985
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
986
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
987
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
614
988
|
};
|
|
615
989
|
};
|
|
616
|
-
readonly required: readonly ["
|
|
990
|
+
readonly required: readonly ["enabled"];
|
|
617
991
|
readonly additionalProperties: false;
|
|
618
992
|
};
|
|
993
|
+
readonly constraints: {
|
|
994
|
+
readonly type: "object";
|
|
995
|
+
readonly properties: {
|
|
996
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
997
|
+
readonly type: "array";
|
|
998
|
+
readonly items: {
|
|
999
|
+
readonly type: "string";
|
|
1000
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
1001
|
+
};
|
|
1002
|
+
readonly minItems: 1;
|
|
1003
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
1004
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
1005
|
+
};
|
|
1006
|
+
readonly 'kubernetes.io/arch': {
|
|
1007
|
+
readonly type: "array";
|
|
1008
|
+
readonly items: {
|
|
1009
|
+
readonly type: "string";
|
|
1010
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
1011
|
+
};
|
|
1012
|
+
readonly minItems: 1;
|
|
1013
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
1014
|
+
readonly default: readonly ["amd64"];
|
|
1015
|
+
};
|
|
1016
|
+
readonly 'cfke.io/instance-family': {
|
|
1017
|
+
readonly type: "array";
|
|
1018
|
+
readonly items: {
|
|
1019
|
+
readonly type: "string";
|
|
1020
|
+
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"];
|
|
1021
|
+
};
|
|
1022
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
1023
|
+
readonly default: readonly [];
|
|
1024
|
+
};
|
|
1025
|
+
readonly 'topology.kubernetes.io/region': {
|
|
1026
|
+
readonly type: "array";
|
|
1027
|
+
readonly items: {
|
|
1028
|
+
readonly type: "string";
|
|
1029
|
+
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"];
|
|
1030
|
+
};
|
|
1031
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
1032
|
+
readonly default: readonly [];
|
|
1033
|
+
};
|
|
1034
|
+
};
|
|
1035
|
+
readonly required: readonly ["karpenter.sh/capacity-type", "kubernetes.io/arch"];
|
|
1036
|
+
readonly additionalProperties: false;
|
|
1037
|
+
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.";
|
|
1038
|
+
readonly default: {
|
|
1039
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
1040
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
1041
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
1042
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
1043
|
+
};
|
|
1044
|
+
};
|
|
1045
|
+
readonly scalingProfile: {
|
|
1046
|
+
readonly type: "string";
|
|
1047
|
+
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`).";
|
|
1048
|
+
readonly default: "conservative";
|
|
1049
|
+
readonly example: "conservative";
|
|
1050
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
1051
|
+
};
|
|
1052
|
+
readonly taints: {
|
|
1053
|
+
readonly type: "array";
|
|
1054
|
+
readonly items: {
|
|
1055
|
+
readonly type: "object";
|
|
1056
|
+
readonly properties: {
|
|
1057
|
+
readonly key: {
|
|
1058
|
+
readonly type: "string";
|
|
1059
|
+
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.";
|
|
1060
|
+
readonly example: "dedicated";
|
|
1061
|
+
};
|
|
1062
|
+
readonly value: {
|
|
1063
|
+
readonly type: "string";
|
|
1064
|
+
readonly maxLength: 63;
|
|
1065
|
+
readonly pattern: "^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$";
|
|
1066
|
+
readonly description: "Taint value. Optional.";
|
|
1067
|
+
readonly example: "ci";
|
|
1068
|
+
};
|
|
1069
|
+
readonly effect: {
|
|
1070
|
+
readonly type: "string";
|
|
1071
|
+
readonly description: "Taint effect.";
|
|
1072
|
+
readonly example: "NoSchedule";
|
|
1073
|
+
readonly enum: readonly ["NoSchedule", "PreferNoSchedule", "NoExecute"];
|
|
1074
|
+
};
|
|
1075
|
+
};
|
|
1076
|
+
readonly required: readonly ["key", "effect"];
|
|
1077
|
+
readonly additionalProperties: false;
|
|
1078
|
+
};
|
|
1079
|
+
readonly maxItems: 50;
|
|
1080
|
+
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.";
|
|
1081
|
+
readonly default: readonly [];
|
|
1082
|
+
};
|
|
619
1083
|
readonly id: {
|
|
620
1084
|
readonly type: "string";
|
|
621
1085
|
readonly maxLength: 63;
|
|
@@ -624,9 +1088,30 @@ export declare const FleetSchema: {
|
|
|
624
1088
|
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
625
1089
|
readonly example: "new-clouds-fleet";
|
|
626
1090
|
};
|
|
1091
|
+
readonly ready: {
|
|
1092
|
+
readonly type: "boolean";
|
|
1093
|
+
readonly description: "Indicates whether the fleet configuration is healthy.";
|
|
1094
|
+
readonly example: true;
|
|
1095
|
+
};
|
|
1096
|
+
readonly status_message: {
|
|
1097
|
+
readonly type: "string";
|
|
1098
|
+
readonly description: "Human-readable reason the fleet is not ready. Present only when `ready` is false.";
|
|
1099
|
+
readonly example: "Invalid provider permissions.";
|
|
1100
|
+
};
|
|
1101
|
+
readonly created_at: {
|
|
1102
|
+
readonly type: "string";
|
|
1103
|
+
readonly description: "Creation date and time of the fleet.";
|
|
1104
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
1105
|
+
};
|
|
1106
|
+
readonly updated_at: {
|
|
1107
|
+
readonly type: "string";
|
|
1108
|
+
readonly description: "Date and time the fleet was last updated.";
|
|
1109
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
1110
|
+
};
|
|
627
1111
|
};
|
|
628
|
-
readonly required: readonly ["id"];
|
|
1112
|
+
readonly required: readonly ["constraints", "scalingProfile", "taints", "id", "ready", "created_at", "updated_at"];
|
|
629
1113
|
readonly additionalProperties: false;
|
|
1114
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
630
1115
|
};
|
|
631
1116
|
export declare const FleetUpdateInputSchema: {
|
|
632
1117
|
readonly type: "object";
|
|
@@ -635,13 +1120,12 @@ export declare const FleetUpdateInputSchema: {
|
|
|
635
1120
|
readonly type: "object";
|
|
636
1121
|
readonly properties: {
|
|
637
1122
|
readonly cpu: {
|
|
638
|
-
readonly type: "
|
|
639
|
-
readonly format: "float";
|
|
1123
|
+
readonly type: "integer";
|
|
640
1124
|
readonly minimum: 0;
|
|
641
|
-
readonly
|
|
1125
|
+
readonly maximum: 100000;
|
|
1126
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
642
1127
|
};
|
|
643
1128
|
};
|
|
644
|
-
readonly required: readonly ["cpu"];
|
|
645
1129
|
readonly additionalProperties: false;
|
|
646
1130
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
647
1131
|
};
|
|
@@ -650,14 +1134,15 @@ export declare const FleetUpdateInputSchema: {
|
|
|
650
1134
|
readonly properties: {
|
|
651
1135
|
readonly enabled: {
|
|
652
1136
|
readonly type: "boolean";
|
|
653
|
-
readonly default: true;
|
|
654
1137
|
};
|
|
655
1138
|
readonly project: {
|
|
656
1139
|
readonly type: "string";
|
|
657
|
-
readonly
|
|
1140
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
1141
|
+
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.";
|
|
1142
|
+
readonly example: "my-cloudfleet-project";
|
|
658
1143
|
};
|
|
659
1144
|
};
|
|
660
|
-
readonly required: readonly ["
|
|
1145
|
+
readonly required: readonly ["enabled"];
|
|
661
1146
|
readonly additionalProperties: false;
|
|
662
1147
|
};
|
|
663
1148
|
readonly hetzner: {
|
|
@@ -665,14 +1150,16 @@ export declare const FleetUpdateInputSchema: {
|
|
|
665
1150
|
readonly properties: {
|
|
666
1151
|
readonly enabled: {
|
|
667
1152
|
readonly type: "boolean";
|
|
668
|
-
readonly default: true;
|
|
669
1153
|
};
|
|
670
1154
|
readonly apiKey: {
|
|
671
1155
|
readonly type: "string";
|
|
672
|
-
readonly
|
|
1156
|
+
readonly maxLength: 64;
|
|
1157
|
+
readonly minLength: 64;
|
|
1158
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
1159
|
+
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.";
|
|
673
1160
|
};
|
|
674
1161
|
};
|
|
675
|
-
readonly required: readonly ["
|
|
1162
|
+
readonly required: readonly ["enabled"];
|
|
676
1163
|
readonly additionalProperties: false;
|
|
677
1164
|
};
|
|
678
1165
|
readonly aws: {
|
|
@@ -680,17 +1167,128 @@ export declare const FleetUpdateInputSchema: {
|
|
|
680
1167
|
readonly properties: {
|
|
681
1168
|
readonly enabled: {
|
|
682
1169
|
readonly type: "boolean";
|
|
683
|
-
readonly default: true;
|
|
684
1170
|
};
|
|
685
1171
|
readonly controllerRoleArn: {
|
|
686
1172
|
readonly type: "string";
|
|
687
|
-
readonly
|
|
1173
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
1174
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
1175
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
1176
|
+
};
|
|
1177
|
+
};
|
|
1178
|
+
readonly required: readonly ["enabled"];
|
|
1179
|
+
readonly additionalProperties: false;
|
|
1180
|
+
};
|
|
1181
|
+
readonly constraints: {
|
|
1182
|
+
readonly type: "object";
|
|
1183
|
+
readonly properties: {
|
|
1184
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
1185
|
+
readonly type: "array";
|
|
1186
|
+
readonly items: {
|
|
1187
|
+
readonly type: "string";
|
|
1188
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
1189
|
+
};
|
|
1190
|
+
readonly minItems: 1;
|
|
1191
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
1192
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
1193
|
+
};
|
|
1194
|
+
readonly 'kubernetes.io/arch': {
|
|
1195
|
+
readonly type: "array";
|
|
1196
|
+
readonly items: {
|
|
1197
|
+
readonly type: "string";
|
|
1198
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
1199
|
+
};
|
|
1200
|
+
readonly minItems: 1;
|
|
1201
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
1202
|
+
readonly default: readonly ["amd64"];
|
|
1203
|
+
};
|
|
1204
|
+
readonly 'cfke.io/instance-family': {
|
|
1205
|
+
readonly type: "array";
|
|
1206
|
+
readonly items: {
|
|
1207
|
+
readonly type: "string";
|
|
1208
|
+
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"];
|
|
1209
|
+
};
|
|
1210
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
1211
|
+
readonly default: readonly [];
|
|
1212
|
+
};
|
|
1213
|
+
readonly 'topology.kubernetes.io/region': {
|
|
1214
|
+
readonly type: "array";
|
|
1215
|
+
readonly items: {
|
|
1216
|
+
readonly type: "string";
|
|
1217
|
+
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"];
|
|
1218
|
+
};
|
|
1219
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
1220
|
+
readonly default: readonly [];
|
|
688
1221
|
};
|
|
689
1222
|
};
|
|
690
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
691
1223
|
readonly additionalProperties: false;
|
|
1224
|
+
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.";
|
|
1225
|
+
readonly default: {
|
|
1226
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
1227
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
1228
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
1229
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
1230
|
+
};
|
|
1231
|
+
};
|
|
1232
|
+
readonly scalingProfile: {
|
|
1233
|
+
readonly type: "string";
|
|
1234
|
+
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`).";
|
|
1235
|
+
readonly default: "conservative";
|
|
1236
|
+
readonly example: "conservative";
|
|
1237
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
1238
|
+
};
|
|
1239
|
+
readonly taints: {
|
|
1240
|
+
readonly type: "array";
|
|
1241
|
+
readonly items: {
|
|
1242
|
+
readonly type: "object";
|
|
1243
|
+
readonly properties: {
|
|
1244
|
+
readonly key: {
|
|
1245
|
+
readonly type: "string";
|
|
1246
|
+
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.";
|
|
1247
|
+
readonly example: "dedicated";
|
|
1248
|
+
};
|
|
1249
|
+
readonly value: {
|
|
1250
|
+
readonly type: "string";
|
|
1251
|
+
readonly maxLength: 63;
|
|
1252
|
+
readonly pattern: "^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$";
|
|
1253
|
+
readonly description: "Taint value. Optional.";
|
|
1254
|
+
readonly example: "ci";
|
|
1255
|
+
};
|
|
1256
|
+
readonly effect: {
|
|
1257
|
+
readonly type: "string";
|
|
1258
|
+
readonly description: "Taint effect.";
|
|
1259
|
+
readonly example: "NoSchedule";
|
|
1260
|
+
readonly enum: readonly ["NoSchedule", "PreferNoSchedule", "NoExecute"];
|
|
1261
|
+
};
|
|
1262
|
+
};
|
|
1263
|
+
readonly required: readonly ["key", "effect"];
|
|
1264
|
+
readonly additionalProperties: false;
|
|
1265
|
+
};
|
|
1266
|
+
readonly maxItems: 50;
|
|
1267
|
+
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.";
|
|
1268
|
+
readonly default: readonly [];
|
|
1269
|
+
};
|
|
1270
|
+
};
|
|
1271
|
+
readonly additionalProperties: false;
|
|
1272
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
1273
|
+
};
|
|
1274
|
+
export declare const InviteCreateInputSchema: {
|
|
1275
|
+
readonly type: "object";
|
|
1276
|
+
readonly properties: {
|
|
1277
|
+
readonly email: {
|
|
1278
|
+
readonly type: "string";
|
|
1279
|
+
readonly format: "email";
|
|
1280
|
+
readonly description: "Email address of the user to invite.";
|
|
1281
|
+
readonly example: "email@example.com";
|
|
1282
|
+
};
|
|
1283
|
+
readonly role: {
|
|
1284
|
+
readonly type: "string";
|
|
1285
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1286
|
+
readonly default: "User";
|
|
1287
|
+
readonly example: "User";
|
|
1288
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
692
1289
|
};
|
|
693
1290
|
};
|
|
1291
|
+
readonly required: readonly ["email"];
|
|
694
1292
|
readonly additionalProperties: false;
|
|
695
1293
|
};
|
|
696
1294
|
export declare const InviteSchema: {
|
|
@@ -724,10 +1322,141 @@ export declare const InviteSchema: {
|
|
|
724
1322
|
readonly description: "Generated unique invite code.";
|
|
725
1323
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
726
1324
|
};
|
|
1325
|
+
readonly role: {
|
|
1326
|
+
readonly type: "string";
|
|
1327
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1328
|
+
readonly default: "User";
|
|
1329
|
+
readonly example: "User";
|
|
1330
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1331
|
+
};
|
|
727
1332
|
};
|
|
728
1333
|
readonly required: readonly ["date_created"];
|
|
729
1334
|
readonly additionalProperties: false;
|
|
730
1335
|
};
|
|
1336
|
+
export declare const InvoicePaymentAttemptSchema: {
|
|
1337
|
+
readonly type: "object";
|
|
1338
|
+
readonly properties: {
|
|
1339
|
+
readonly invoice_id: {
|
|
1340
|
+
readonly type: "string";
|
|
1341
|
+
readonly description: "Identifier of the invoice.";
|
|
1342
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
1343
|
+
};
|
|
1344
|
+
readonly number: {
|
|
1345
|
+
readonly type: "string";
|
|
1346
|
+
readonly nullable: true;
|
|
1347
|
+
readonly description: "Invoice number. Null if the invoice has no number.";
|
|
1348
|
+
readonly example: "CF-0042";
|
|
1349
|
+
};
|
|
1350
|
+
readonly amount: {
|
|
1351
|
+
readonly type: "number";
|
|
1352
|
+
readonly format: "float";
|
|
1353
|
+
readonly description: "Amount outstanding when the charge was attempted, in the smallest currency unit.";
|
|
1354
|
+
readonly example: 4200;
|
|
1355
|
+
};
|
|
1356
|
+
readonly currency: {
|
|
1357
|
+
readonly type: "string";
|
|
1358
|
+
readonly description: "Currency of the invoice.";
|
|
1359
|
+
readonly example: "eur";
|
|
1360
|
+
};
|
|
1361
|
+
readonly status: {
|
|
1362
|
+
readonly type: "string";
|
|
1363
|
+
readonly description: "Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).";
|
|
1364
|
+
readonly example: "paid";
|
|
1365
|
+
readonly enum: readonly ["paid", "processing", "requires_action", "failed"];
|
|
1366
|
+
};
|
|
1367
|
+
readonly client_secret: {
|
|
1368
|
+
readonly type: "string";
|
|
1369
|
+
readonly nullable: true;
|
|
1370
|
+
readonly description: "Client secret used to complete customer authentication. Set only when `status` is `requires_action`.";
|
|
1371
|
+
readonly example: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH";
|
|
1372
|
+
};
|
|
1373
|
+
readonly failure_code: {
|
|
1374
|
+
readonly type: "string";
|
|
1375
|
+
readonly nullable: true;
|
|
1376
|
+
readonly description: "Decline code. Set only when `status` is `failed`.";
|
|
1377
|
+
readonly example: "insufficient_funds";
|
|
1378
|
+
};
|
|
1379
|
+
readonly failure_message: {
|
|
1380
|
+
readonly type: "string";
|
|
1381
|
+
readonly nullable: true;
|
|
1382
|
+
readonly description: "Explanation of the decline, suitable for display. Set only when `status` is `failed`.";
|
|
1383
|
+
readonly example: "Your card has insufficient funds.";
|
|
1384
|
+
};
|
|
1385
|
+
};
|
|
1386
|
+
readonly required: readonly ["invoice_id", "number", "amount", "currency", "status", "client_secret", "failure_code", "failure_message"];
|
|
1387
|
+
readonly additionalProperties: false;
|
|
1388
|
+
};
|
|
1389
|
+
export declare const InvoicePaymentResultSchema: {
|
|
1390
|
+
readonly type: "object";
|
|
1391
|
+
readonly properties: {
|
|
1392
|
+
readonly code: {
|
|
1393
|
+
readonly type: "string";
|
|
1394
|
+
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).";
|
|
1395
|
+
readonly example: "partially_paid";
|
|
1396
|
+
readonly enum: readonly ["paid", "processing", "action_required", "partially_paid", "failed", "nothing_due", "bank_transfer_due"];
|
|
1397
|
+
};
|
|
1398
|
+
readonly message: {
|
|
1399
|
+
readonly type: "string";
|
|
1400
|
+
readonly description: "Summary of the outcome, suitable for display.";
|
|
1401
|
+
readonly example: "1 of 2 open invoices was paid. Invoice CF-0043 was declined: Your card has insufficient funds.";
|
|
1402
|
+
};
|
|
1403
|
+
readonly results: {
|
|
1404
|
+
readonly type: "array";
|
|
1405
|
+
readonly items: {
|
|
1406
|
+
readonly type: "object";
|
|
1407
|
+
readonly properties: {
|
|
1408
|
+
readonly invoice_id: {
|
|
1409
|
+
readonly type: "string";
|
|
1410
|
+
readonly description: "Identifier of the invoice.";
|
|
1411
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
1412
|
+
};
|
|
1413
|
+
readonly number: {
|
|
1414
|
+
readonly type: "string";
|
|
1415
|
+
readonly description: "Invoice number. Null if the invoice has no number.";
|
|
1416
|
+
readonly example: "CF-0042";
|
|
1417
|
+
};
|
|
1418
|
+
readonly amount: {
|
|
1419
|
+
readonly type: "number";
|
|
1420
|
+
readonly format: "float";
|
|
1421
|
+
readonly description: "Amount outstanding when the charge was attempted, in the smallest currency unit.";
|
|
1422
|
+
readonly example: 4200;
|
|
1423
|
+
};
|
|
1424
|
+
readonly currency: {
|
|
1425
|
+
readonly type: "string";
|
|
1426
|
+
readonly description: "Currency of the invoice.";
|
|
1427
|
+
readonly example: "eur";
|
|
1428
|
+
};
|
|
1429
|
+
readonly status: {
|
|
1430
|
+
readonly type: "string";
|
|
1431
|
+
readonly description: "Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).";
|
|
1432
|
+
readonly example: "paid";
|
|
1433
|
+
readonly enum: readonly ["paid", "processing", "requires_action", "failed"];
|
|
1434
|
+
};
|
|
1435
|
+
readonly client_secret: {
|
|
1436
|
+
readonly type: "string";
|
|
1437
|
+
readonly description: "Client secret used to complete customer authentication. Set only when `status` is `requires_action`.";
|
|
1438
|
+
readonly example: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH";
|
|
1439
|
+
};
|
|
1440
|
+
readonly failure_code: {
|
|
1441
|
+
readonly type: "string";
|
|
1442
|
+
readonly description: "Decline code. Set only when `status` is `failed`.";
|
|
1443
|
+
readonly example: "insufficient_funds";
|
|
1444
|
+
};
|
|
1445
|
+
readonly failure_message: {
|
|
1446
|
+
readonly type: "string";
|
|
1447
|
+
readonly description: "Explanation of the decline, suitable for display. Set only when `status` is `failed`.";
|
|
1448
|
+
readonly example: "Your card has insufficient funds.";
|
|
1449
|
+
};
|
|
1450
|
+
};
|
|
1451
|
+
readonly required: readonly ["invoice_id", "number", "amount", "currency", "status", "client_secret", "failure_code", "failure_message"];
|
|
1452
|
+
readonly additionalProperties: false;
|
|
1453
|
+
};
|
|
1454
|
+
readonly description: "One entry per invoice charged, oldest first.";
|
|
1455
|
+
};
|
|
1456
|
+
};
|
|
1457
|
+
readonly required: readonly ["code", "message", "results"];
|
|
1458
|
+
readonly additionalProperties: false;
|
|
1459
|
+
};
|
|
731
1460
|
export declare const InvoiceSchema: {
|
|
732
1461
|
readonly type: "object";
|
|
733
1462
|
readonly properties: {
|
|
@@ -875,6 +1604,11 @@ export declare const MarketplaceListingSchema: {
|
|
|
875
1604
|
readonly description: "Chart home URL";
|
|
876
1605
|
readonly example: "https://kubernetes.github.io/ingress-nginx/";
|
|
877
1606
|
};
|
|
1607
|
+
readonly icon: {
|
|
1608
|
+
readonly type: "string";
|
|
1609
|
+
readonly description: "A URL to an SVG or PNG image to be used as an icon";
|
|
1610
|
+
readonly example: "https://cloudfleet.ai/images/marketplace/icons/ingress-nginx.png";
|
|
1611
|
+
};
|
|
878
1612
|
readonly sources: {
|
|
879
1613
|
readonly type: "array";
|
|
880
1614
|
readonly items: {
|
|
@@ -916,6 +1650,12 @@ export declare const MarketplaceListingSchema: {
|
|
|
916
1650
|
export declare const OrganizationCreateInputSchema: {
|
|
917
1651
|
readonly type: "object";
|
|
918
1652
|
readonly properties: {
|
|
1653
|
+
readonly type: {
|
|
1654
|
+
readonly type: "string";
|
|
1655
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1656
|
+
readonly example: "business";
|
|
1657
|
+
readonly enum: readonly ["business", "personal"];
|
|
1658
|
+
};
|
|
919
1659
|
readonly email: {
|
|
920
1660
|
readonly type: "string";
|
|
921
1661
|
readonly format: "email";
|
|
@@ -924,11 +1664,13 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
924
1664
|
};
|
|
925
1665
|
readonly first_name: {
|
|
926
1666
|
readonly type: "string";
|
|
1667
|
+
readonly minLength: 1;
|
|
927
1668
|
readonly description: "First name of the billing contact person.";
|
|
928
1669
|
readonly example: "John";
|
|
929
1670
|
};
|
|
930
1671
|
readonly last_name: {
|
|
931
1672
|
readonly type: "string";
|
|
1673
|
+
readonly minLength: 1;
|
|
932
1674
|
readonly description: "Last name of the billing contact person.";
|
|
933
1675
|
readonly example: "Doe";
|
|
934
1676
|
};
|
|
@@ -946,7 +1688,19 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
946
1688
|
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.";
|
|
947
1689
|
};
|
|
948
1690
|
};
|
|
949
|
-
readonly required: readonly ["email", "first_name", "last_name", "company_name", "password"];
|
|
1691
|
+
readonly required: readonly ["type", "email", "first_name", "last_name", "company_name", "password"];
|
|
1692
|
+
readonly additionalProperties: false;
|
|
1693
|
+
};
|
|
1694
|
+
export declare const OrganizationCreateOutputSchema: {
|
|
1695
|
+
readonly type: "object";
|
|
1696
|
+
readonly properties: {
|
|
1697
|
+
readonly id: {
|
|
1698
|
+
readonly type: "string";
|
|
1699
|
+
readonly description: "Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.";
|
|
1700
|
+
readonly example: "organization-id";
|
|
1701
|
+
};
|
|
1702
|
+
};
|
|
1703
|
+
readonly required: readonly ["id"];
|
|
950
1704
|
readonly additionalProperties: false;
|
|
951
1705
|
};
|
|
952
1706
|
export declare const OrganizationSchema: {
|
|
@@ -965,6 +1719,12 @@ export declare const OrganizationSchema: {
|
|
|
965
1719
|
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
966
1720
|
readonly example: "ACME Corp.";
|
|
967
1721
|
};
|
|
1722
|
+
readonly type: {
|
|
1723
|
+
readonly type: "string";
|
|
1724
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1725
|
+
readonly example: "business";
|
|
1726
|
+
readonly enum: readonly ["business", "personal"];
|
|
1727
|
+
};
|
|
968
1728
|
readonly date_created: {
|
|
969
1729
|
readonly type: "string";
|
|
970
1730
|
readonly format: "date-time";
|
|
@@ -996,6 +1756,17 @@ export declare const OrganizationSchema: {
|
|
|
996
1756
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
997
1757
|
readonly example: 999;
|
|
998
1758
|
};
|
|
1759
|
+
readonly enterprise_clusters_max: {
|
|
1760
|
+
readonly type: "integer";
|
|
1761
|
+
readonly minimum: 0;
|
|
1762
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1763
|
+
readonly example: 999;
|
|
1764
|
+
};
|
|
1765
|
+
readonly enterprise_clusters_available: {
|
|
1766
|
+
readonly type: "integer";
|
|
1767
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1768
|
+
readonly example: 999;
|
|
1769
|
+
};
|
|
999
1770
|
readonly fleets_max: {
|
|
1000
1771
|
readonly type: "integer";
|
|
1001
1772
|
readonly minimum: 0;
|
|
@@ -1015,7 +1786,7 @@ export declare const OrganizationSchema: {
|
|
|
1015
1786
|
readonly type: "array";
|
|
1016
1787
|
readonly items: {
|
|
1017
1788
|
readonly type: "string";
|
|
1018
|
-
readonly example: "northamerica-central-
|
|
1789
|
+
readonly example: "northamerica-central-1a";
|
|
1019
1790
|
};
|
|
1020
1791
|
readonly minItems: 1;
|
|
1021
1792
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1042,20 +1813,14 @@ export declare const OrganizationSchema: {
|
|
|
1042
1813
|
readonly minItems: 1;
|
|
1043
1814
|
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1044
1815
|
};
|
|
1045
|
-
readonly
|
|
1046
|
-
readonly type: "integer";
|
|
1047
|
-
readonly minimum: 0;
|
|
1048
|
-
readonly description: "User-level maximum number of tokens Cloudfleet Copilot can process per hour.";
|
|
1049
|
-
readonly example: 42000;
|
|
1050
|
-
};
|
|
1051
|
-
readonly copilot_organization_hourly_tokens: {
|
|
1816
|
+
readonly cfcr_storage_gb: {
|
|
1052
1817
|
readonly type: "integer";
|
|
1053
|
-
readonly minimum:
|
|
1054
|
-
readonly description: "Organization-level maximum
|
|
1055
|
-
readonly example:
|
|
1818
|
+
readonly minimum: -1;
|
|
1819
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1820
|
+
readonly example: 500;
|
|
1056
1821
|
};
|
|
1057
1822
|
};
|
|
1058
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "
|
|
1823
|
+
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"];
|
|
1059
1824
|
readonly additionalProperties: false;
|
|
1060
1825
|
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.";
|
|
1061
1826
|
};
|
|
@@ -1064,8 +1829,14 @@ export declare const OrganizationSchema: {
|
|
|
1064
1829
|
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1065
1830
|
readonly enum: readonly ["active", "closed", "suspended"];
|
|
1066
1831
|
};
|
|
1832
|
+
readonly verification: {
|
|
1833
|
+
readonly type: "string";
|
|
1834
|
+
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.";
|
|
1835
|
+
readonly example: "verified";
|
|
1836
|
+
readonly enum: readonly ["none", "submitted", "verified"];
|
|
1837
|
+
};
|
|
1067
1838
|
};
|
|
1068
|
-
readonly required: readonly ["id", "date_created", "quota", "status"];
|
|
1839
|
+
readonly required: readonly ["id", "type", "date_created", "quota", "status", "verification"];
|
|
1069
1840
|
readonly additionalProperties: false;
|
|
1070
1841
|
};
|
|
1071
1842
|
export declare const PaymentMethodSchema: {
|
|
@@ -1073,26 +1844,19 @@ export declare const PaymentMethodSchema: {
|
|
|
1073
1844
|
readonly properties: {
|
|
1074
1845
|
readonly id: {
|
|
1075
1846
|
readonly type: "string";
|
|
1076
|
-
readonly
|
|
1077
|
-
readonly
|
|
1078
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1079
|
-
};
|
|
1080
|
-
readonly setup: {
|
|
1081
|
-
readonly type: "boolean";
|
|
1082
|
-
readonly description: "Whether organization payment method was set up and ready to use for payments.";
|
|
1083
|
-
readonly example: true;
|
|
1847
|
+
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.";
|
|
1848
|
+
readonly example: "pm_1MtwBwLkdIwHu7ix28a3tqPa";
|
|
1084
1849
|
};
|
|
1085
1850
|
readonly type: {
|
|
1086
1851
|
readonly type: "string";
|
|
1087
|
-
readonly
|
|
1088
|
-
readonly description: "Payment method type type. Only `card` payments supported at the moment.";
|
|
1852
|
+
readonly description: "Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.";
|
|
1089
1853
|
readonly example: "card";
|
|
1090
|
-
readonly enum: readonly ["card"];
|
|
1854
|
+
readonly enum: readonly ["card", "sepa_debit", "bank_transfer"];
|
|
1091
1855
|
};
|
|
1092
1856
|
readonly last4: {
|
|
1093
1857
|
readonly type: "string";
|
|
1094
1858
|
readonly nullable: true;
|
|
1095
|
-
readonly description: "Last 4 digits of the payment card number.";
|
|
1859
|
+
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.";
|
|
1096
1860
|
readonly example: "4242";
|
|
1097
1861
|
};
|
|
1098
1862
|
readonly exp_month: {
|
|
@@ -1100,25 +1864,46 @@ export declare const PaymentMethodSchema: {
|
|
|
1100
1864
|
readonly minimum: 1;
|
|
1101
1865
|
readonly maximum: 12;
|
|
1102
1866
|
readonly nullable: true;
|
|
1103
|
-
readonly description: "Two-digit number representing the card's expiration month.";
|
|
1104
|
-
readonly example:
|
|
1867
|
+
readonly description: "Two-digit number representing the card's expiration month. Null for SEPA Direct Debit and bank transfer.";
|
|
1868
|
+
readonly example: 12;
|
|
1105
1869
|
};
|
|
1106
1870
|
readonly exp_year: {
|
|
1107
1871
|
readonly type: "integer";
|
|
1108
|
-
readonly minimum: 2024;
|
|
1109
1872
|
readonly nullable: true;
|
|
1110
|
-
readonly description: "Four-digit number representing the card's expiration year.";
|
|
1111
|
-
readonly example:
|
|
1873
|
+
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.";
|
|
1874
|
+
readonly example: 2028;
|
|
1112
1875
|
};
|
|
1113
1876
|
readonly brand: {
|
|
1114
1877
|
readonly type: "string";
|
|
1115
1878
|
readonly nullable: true;
|
|
1116
|
-
readonly description: "Payment card brand
|
|
1879
|
+
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.";
|
|
1117
1880
|
readonly example: "visa";
|
|
1118
|
-
|
|
1881
|
+
};
|
|
1882
|
+
readonly iban: {
|
|
1883
|
+
readonly type: "string";
|
|
1884
|
+
readonly nullable: true;
|
|
1885
|
+
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.";
|
|
1886
|
+
readonly example: "DE11243015658023127510";
|
|
1887
|
+
};
|
|
1888
|
+
readonly bic: {
|
|
1889
|
+
readonly type: "string";
|
|
1890
|
+
readonly nullable: true;
|
|
1891
|
+
readonly description: "BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1892
|
+
readonly example: "SOGEDEFFXXX";
|
|
1893
|
+
};
|
|
1894
|
+
readonly account_holder_name: {
|
|
1895
|
+
readonly type: "string";
|
|
1896
|
+
readonly nullable: true;
|
|
1897
|
+
readonly description: "Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1898
|
+
readonly example: "Cloudfleet GmbH";
|
|
1899
|
+
};
|
|
1900
|
+
readonly is_default: {
|
|
1901
|
+
readonly type: "boolean";
|
|
1902
|
+
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).";
|
|
1903
|
+
readonly example: true;
|
|
1119
1904
|
};
|
|
1120
1905
|
};
|
|
1121
|
-
readonly required: readonly ["id", "
|
|
1906
|
+
readonly required: readonly ["id", "type", "last4", "exp_month", "exp_year", "brand", "iban", "bic", "account_holder_name", "is_default"];
|
|
1122
1907
|
readonly additionalProperties: false;
|
|
1123
1908
|
};
|
|
1124
1909
|
export declare const PlatformQuotaSchema: {
|
|
@@ -1146,6 +1931,17 @@ export declare const PlatformQuotaSchema: {
|
|
|
1146
1931
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1147
1932
|
readonly example: 999;
|
|
1148
1933
|
};
|
|
1934
|
+
readonly enterprise_clusters_max: {
|
|
1935
|
+
readonly type: "integer";
|
|
1936
|
+
readonly minimum: 0;
|
|
1937
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1938
|
+
readonly example: 999;
|
|
1939
|
+
};
|
|
1940
|
+
readonly enterprise_clusters_available: {
|
|
1941
|
+
readonly type: "integer";
|
|
1942
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1943
|
+
readonly example: 999;
|
|
1944
|
+
};
|
|
1149
1945
|
readonly fleets_max: {
|
|
1150
1946
|
readonly type: "integer";
|
|
1151
1947
|
readonly minimum: 0;
|
|
@@ -1165,7 +1961,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1165
1961
|
readonly type: "array";
|
|
1166
1962
|
readonly items: {
|
|
1167
1963
|
readonly type: "string";
|
|
1168
|
-
readonly example: "northamerica-central-
|
|
1964
|
+
readonly example: "northamerica-central-1a";
|
|
1169
1965
|
};
|
|
1170
1966
|
readonly minItems: 1;
|
|
1171
1967
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1192,20 +1988,14 @@ export declare const PlatformQuotaSchema: {
|
|
|
1192
1988
|
readonly minItems: 1;
|
|
1193
1989
|
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1194
1990
|
};
|
|
1195
|
-
readonly
|
|
1196
|
-
readonly type: "integer";
|
|
1197
|
-
readonly minimum: 0;
|
|
1198
|
-
readonly description: "User-level maximum number of tokens Cloudfleet Copilot can process per hour.";
|
|
1199
|
-
readonly example: 42000;
|
|
1200
|
-
};
|
|
1201
|
-
readonly copilot_organization_hourly_tokens: {
|
|
1991
|
+
readonly cfcr_storage_gb: {
|
|
1202
1992
|
readonly type: "integer";
|
|
1203
|
-
readonly minimum:
|
|
1204
|
-
readonly description: "Organization-level maximum
|
|
1205
|
-
readonly example:
|
|
1993
|
+
readonly minimum: -1;
|
|
1994
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1995
|
+
readonly example: 500;
|
|
1206
1996
|
};
|
|
1207
1997
|
};
|
|
1208
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "
|
|
1998
|
+
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"];
|
|
1209
1999
|
readonly additionalProperties: false;
|
|
1210
2000
|
};
|
|
1211
2001
|
export declare const RegistryRepositorySchema: {
|
|
@@ -1224,7 +2014,7 @@ export declare const RegistryRepositorySchema: {
|
|
|
1224
2014
|
readonly uri: {
|
|
1225
2015
|
readonly type: "string";
|
|
1226
2016
|
readonly description: "Full URI of the repository.";
|
|
1227
|
-
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/
|
|
2017
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
1228
2018
|
};
|
|
1229
2019
|
};
|
|
1230
2020
|
readonly required: readonly ["name", "region", "uri"];
|
|
@@ -1246,7 +2036,7 @@ export declare const RegistryRepositoryWithTagsSchema: {
|
|
|
1246
2036
|
readonly uri: {
|
|
1247
2037
|
readonly type: "string";
|
|
1248
2038
|
readonly description: "Full URI of the repository.";
|
|
1249
|
-
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/
|
|
2039
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
1250
2040
|
};
|
|
1251
2041
|
readonly tags: {
|
|
1252
2042
|
readonly type: "array";
|
|
@@ -1269,6 +2059,14 @@ export declare const RegistryRepositoryWithTagsSchema: {
|
|
|
1269
2059
|
readonly description: "Media type of the manifest.";
|
|
1270
2060
|
readonly example: "application/vnd.docker.distribution.manifest.v2+json";
|
|
1271
2061
|
};
|
|
2062
|
+
readonly platforms: {
|
|
2063
|
+
readonly type: "array";
|
|
2064
|
+
readonly items: {
|
|
2065
|
+
readonly type: "string";
|
|
2066
|
+
};
|
|
2067
|
+
readonly description: "Array of platform strings for multi-arch images (e.g., linux/amd64, linux/arm64).";
|
|
2068
|
+
readonly example: readonly ["linux/amd64", "linux/arm64"];
|
|
2069
|
+
};
|
|
1272
2070
|
};
|
|
1273
2071
|
readonly required: readonly ["name", "size"];
|
|
1274
2072
|
readonly additionalProperties: false;
|
|
@@ -1293,6 +2091,11 @@ export declare const RegistryTagSchema: {
|
|
|
1293
2091
|
readonly description: "Tag name.";
|
|
1294
2092
|
readonly example: "latest";
|
|
1295
2093
|
};
|
|
2094
|
+
readonly digest: {
|
|
2095
|
+
readonly type: "string";
|
|
2096
|
+
readonly description: "Manifest digest for pulling by digest.";
|
|
2097
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
2098
|
+
};
|
|
1296
2099
|
readonly mediaType: {
|
|
1297
2100
|
readonly type: "string";
|
|
1298
2101
|
readonly description: "Media type of the manifest.";
|
|
@@ -1317,6 +2120,11 @@ export declare const RegistryTagSchema: {
|
|
|
1317
2120
|
readonly items: {
|
|
1318
2121
|
readonly type: "object";
|
|
1319
2122
|
readonly properties: {
|
|
2123
|
+
readonly digest: {
|
|
2124
|
+
readonly type: "string";
|
|
2125
|
+
readonly description: "Digest of the layer.";
|
|
2126
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
2127
|
+
};
|
|
1320
2128
|
readonly size: {
|
|
1321
2129
|
readonly type: "number";
|
|
1322
2130
|
readonly format: "float";
|
|
@@ -1352,11 +2160,44 @@ export declare const RegistryTagSchema: {
|
|
|
1352
2160
|
readonly description: "Operating system of the platform.";
|
|
1353
2161
|
readonly example: "linux";
|
|
1354
2162
|
};
|
|
2163
|
+
readonly variant: {
|
|
2164
|
+
readonly type: "string";
|
|
2165
|
+
readonly description: "Variant of the platform (e.g., v7, v8 for ARM).";
|
|
2166
|
+
readonly example: "v8";
|
|
2167
|
+
};
|
|
1355
2168
|
};
|
|
1356
2169
|
readonly required: readonly ["architecture", "os"];
|
|
1357
2170
|
readonly additionalProperties: false;
|
|
1358
2171
|
readonly description: "Platform information for the manifest.";
|
|
1359
2172
|
};
|
|
2173
|
+
readonly layers: {
|
|
2174
|
+
readonly type: "array";
|
|
2175
|
+
readonly items: {
|
|
2176
|
+
readonly type: "object";
|
|
2177
|
+
readonly properties: {
|
|
2178
|
+
readonly digest: {
|
|
2179
|
+
readonly type: "string";
|
|
2180
|
+
readonly description: "Digest of the layer.";
|
|
2181
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
2182
|
+
};
|
|
2183
|
+
readonly size: {
|
|
2184
|
+
readonly type: "number";
|
|
2185
|
+
readonly format: "float";
|
|
2186
|
+
readonly description: "Size of the layer in bytes.";
|
|
2187
|
+
readonly example: 5678;
|
|
2188
|
+
};
|
|
2189
|
+
};
|
|
2190
|
+
readonly required: readonly ["size"];
|
|
2191
|
+
readonly additionalProperties: false;
|
|
2192
|
+
};
|
|
2193
|
+
readonly description: "Layers for this platform.";
|
|
2194
|
+
};
|
|
2195
|
+
readonly size: {
|
|
2196
|
+
readonly type: "number";
|
|
2197
|
+
readonly format: "float";
|
|
2198
|
+
readonly description: "Total size of this platform manifest in bytes.";
|
|
2199
|
+
readonly example: 12345678;
|
|
2200
|
+
};
|
|
1360
2201
|
};
|
|
1361
2202
|
readonly required: readonly ["digest"];
|
|
1362
2203
|
readonly additionalProperties: false;
|
|
@@ -1385,7 +2226,343 @@ export declare const RegistryTagSchema: {
|
|
|
1385
2226
|
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app:latest";
|
|
1386
2227
|
};
|
|
1387
2228
|
};
|
|
1388
|
-
readonly required: readonly ["name", "size", "region", "repository", "uri"];
|
|
2229
|
+
readonly required: readonly ["name", "digest", "size", "region", "repository", "uri"];
|
|
2230
|
+
readonly additionalProperties: false;
|
|
2231
|
+
};
|
|
2232
|
+
export declare const RoadmapItemCreateInputSchema: {
|
|
2233
|
+
readonly type: "object";
|
|
2234
|
+
readonly properties: {
|
|
2235
|
+
readonly text: {
|
|
2236
|
+
readonly type: "string";
|
|
2237
|
+
readonly maxLength: 500;
|
|
2238
|
+
readonly minLength: 1;
|
|
2239
|
+
readonly description: "Your suggestion in one or two sentences. It is reviewed before it appears on the roadmap.";
|
|
2240
|
+
readonly example: "Support for ARM nodes on Hetzner.";
|
|
2241
|
+
};
|
|
2242
|
+
};
|
|
2243
|
+
readonly required: readonly ["text"];
|
|
2244
|
+
readonly additionalProperties: false;
|
|
2245
|
+
};
|
|
2246
|
+
export declare const RoadmapItemSchema: {
|
|
2247
|
+
readonly type: "object";
|
|
2248
|
+
readonly properties: {
|
|
2249
|
+
readonly id: {
|
|
2250
|
+
readonly type: "string";
|
|
2251
|
+
readonly description: "Unique identifier of the roadmap item (Mongo ObjectId).";
|
|
2252
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
2253
|
+
};
|
|
2254
|
+
readonly text: {
|
|
2255
|
+
readonly type: "string";
|
|
2256
|
+
readonly description: "Short description of the roadmap item.";
|
|
2257
|
+
readonly example: "Support for ARM nodes on Hetzner.";
|
|
2258
|
+
};
|
|
2259
|
+
readonly vote: {
|
|
2260
|
+
readonly type: "integer";
|
|
2261
|
+
readonly nullable: true;
|
|
2262
|
+
readonly description: "The caller's vote on this item: -1 (down), 1 (up), 2 (double up), or null if the caller has not voted.";
|
|
2263
|
+
readonly example: 1;
|
|
2264
|
+
readonly enum: readonly [-1, 1, 2];
|
|
2265
|
+
};
|
|
2266
|
+
};
|
|
2267
|
+
readonly required: readonly ["id", "text", "vote"];
|
|
2268
|
+
readonly additionalProperties: false;
|
|
2269
|
+
};
|
|
2270
|
+
export declare const RoadmapVoteInputSchema: {
|
|
2271
|
+
readonly type: "object";
|
|
2272
|
+
readonly properties: {
|
|
2273
|
+
readonly value: {
|
|
2274
|
+
readonly type: "integer";
|
|
2275
|
+
readonly description: "Vote value: -1 (down), 1 (up), or 2 (double up).";
|
|
2276
|
+
readonly example: 1;
|
|
2277
|
+
readonly enum: readonly [-1, 1, 2];
|
|
2278
|
+
};
|
|
2279
|
+
};
|
|
2280
|
+
readonly required: readonly ["value"];
|
|
2281
|
+
readonly additionalProperties: false;
|
|
2282
|
+
};
|
|
2283
|
+
export declare const TicketAttachmentSchema: {
|
|
2284
|
+
readonly type: "object";
|
|
2285
|
+
readonly properties: {
|
|
2286
|
+
readonly id: {
|
|
2287
|
+
readonly type: "string";
|
|
2288
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2289
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2290
|
+
};
|
|
2291
|
+
readonly filename: {
|
|
2292
|
+
readonly type: "string";
|
|
2293
|
+
readonly description: "Original filename as uploaded.";
|
|
2294
|
+
readonly example: "debug.log";
|
|
2295
|
+
};
|
|
2296
|
+
readonly content_type: {
|
|
2297
|
+
readonly type: "string";
|
|
2298
|
+
readonly description: "MIME content type of the attachment.";
|
|
2299
|
+
readonly example: "text/plain";
|
|
2300
|
+
};
|
|
2301
|
+
readonly size: {
|
|
2302
|
+
readonly type: "integer";
|
|
2303
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2304
|
+
readonly example: 12345;
|
|
2305
|
+
};
|
|
2306
|
+
};
|
|
2307
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2308
|
+
readonly additionalProperties: false;
|
|
2309
|
+
};
|
|
2310
|
+
export declare const TicketCreateInputSchema: {
|
|
2311
|
+
readonly type: "object";
|
|
2312
|
+
readonly properties: {
|
|
2313
|
+
readonly category: {
|
|
2314
|
+
readonly type: "string";
|
|
2315
|
+
readonly description: "Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.";
|
|
2316
|
+
readonly example: "technical";
|
|
2317
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
2318
|
+
};
|
|
2319
|
+
readonly body: {
|
|
2320
|
+
readonly type: "string";
|
|
2321
|
+
readonly maxLength: 50000;
|
|
2322
|
+
readonly minLength: 1;
|
|
2323
|
+
readonly pattern: "\\S";
|
|
2324
|
+
readonly description: "Initial message body in markdown. There is no separate subject — the first message body is the description.";
|
|
2325
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2326
|
+
};
|
|
2327
|
+
readonly properties: {
|
|
2328
|
+
readonly type: "object";
|
|
2329
|
+
readonly additionalProperties: true;
|
|
2330
|
+
readonly description: "Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).";
|
|
2331
|
+
readonly example: {
|
|
2332
|
+
readonly subcategory: "cluster-question";
|
|
2333
|
+
readonly cluster_id: "60c72b2f9f1b2c001f8e4d3a";
|
|
2334
|
+
};
|
|
2335
|
+
};
|
|
2336
|
+
readonly grant_support_access: {
|
|
2337
|
+
readonly type: "boolean";
|
|
2338
|
+
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.";
|
|
2339
|
+
readonly example: true;
|
|
2340
|
+
};
|
|
2341
|
+
};
|
|
2342
|
+
readonly required: readonly ["category", "body"];
|
|
2343
|
+
readonly additionalProperties: false;
|
|
2344
|
+
};
|
|
2345
|
+
export declare const TicketMessageInputSchema: {
|
|
2346
|
+
readonly type: "object";
|
|
2347
|
+
readonly properties: {
|
|
2348
|
+
readonly body: {
|
|
2349
|
+
readonly type: "string";
|
|
2350
|
+
readonly maxLength: 50000;
|
|
2351
|
+
readonly minLength: 1;
|
|
2352
|
+
readonly pattern: "\\S";
|
|
2353
|
+
readonly description: "Reply body in markdown.";
|
|
2354
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2355
|
+
};
|
|
2356
|
+
};
|
|
2357
|
+
readonly required: readonly ["body"];
|
|
2358
|
+
readonly additionalProperties: false;
|
|
2359
|
+
};
|
|
2360
|
+
export declare const TicketMessageSchema: {
|
|
2361
|
+
readonly type: "object";
|
|
2362
|
+
readonly properties: {
|
|
2363
|
+
readonly id: {
|
|
2364
|
+
readonly type: "string";
|
|
2365
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2366
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2367
|
+
};
|
|
2368
|
+
readonly type: {
|
|
2369
|
+
readonly type: "string";
|
|
2370
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2371
|
+
readonly example: "customer_reply";
|
|
2372
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2373
|
+
};
|
|
2374
|
+
readonly body: {
|
|
2375
|
+
readonly type: "string";
|
|
2376
|
+
readonly description: "Message body in markdown.";
|
|
2377
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2378
|
+
};
|
|
2379
|
+
readonly author_first_name: {
|
|
2380
|
+
readonly type: "string";
|
|
2381
|
+
readonly nullable: true;
|
|
2382
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2383
|
+
readonly example: "Jane";
|
|
2384
|
+
};
|
|
2385
|
+
readonly author_last_name: {
|
|
2386
|
+
readonly type: "string";
|
|
2387
|
+
readonly nullable: true;
|
|
2388
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2389
|
+
readonly example: "Doe";
|
|
2390
|
+
};
|
|
2391
|
+
readonly attachments: {
|
|
2392
|
+
readonly type: "array";
|
|
2393
|
+
readonly items: {
|
|
2394
|
+
readonly type: "object";
|
|
2395
|
+
readonly properties: {
|
|
2396
|
+
readonly id: {
|
|
2397
|
+
readonly type: "string";
|
|
2398
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2399
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2400
|
+
};
|
|
2401
|
+
readonly filename: {
|
|
2402
|
+
readonly type: "string";
|
|
2403
|
+
readonly description: "Original filename as uploaded.";
|
|
2404
|
+
readonly example: "debug.log";
|
|
2405
|
+
};
|
|
2406
|
+
readonly content_type: {
|
|
2407
|
+
readonly type: "string";
|
|
2408
|
+
readonly description: "MIME content type of the attachment.";
|
|
2409
|
+
readonly example: "text/plain";
|
|
2410
|
+
};
|
|
2411
|
+
readonly size: {
|
|
2412
|
+
readonly type: "integer";
|
|
2413
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2414
|
+
readonly example: 12345;
|
|
2415
|
+
};
|
|
2416
|
+
};
|
|
2417
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2418
|
+
readonly additionalProperties: false;
|
|
2419
|
+
};
|
|
2420
|
+
readonly description: "Attachments associated with this message.";
|
|
2421
|
+
readonly example: readonly [];
|
|
2422
|
+
};
|
|
2423
|
+
readonly date_created: {
|
|
2424
|
+
readonly type: "string";
|
|
2425
|
+
readonly format: "date-time";
|
|
2426
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2427
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2428
|
+
};
|
|
2429
|
+
};
|
|
2430
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2431
|
+
readonly additionalProperties: false;
|
|
2432
|
+
};
|
|
2433
|
+
export declare const TicketSchema: {
|
|
2434
|
+
readonly type: "object";
|
|
2435
|
+
readonly properties: {
|
|
2436
|
+
readonly id: {
|
|
2437
|
+
readonly type: "string";
|
|
2438
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
2439
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
2440
|
+
};
|
|
2441
|
+
readonly status: {
|
|
2442
|
+
readonly type: "string";
|
|
2443
|
+
readonly description: "Current state of the ticket.";
|
|
2444
|
+
readonly example: "waiting_on_us";
|
|
2445
|
+
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
2446
|
+
};
|
|
2447
|
+
readonly category: {
|
|
2448
|
+
readonly type: "string";
|
|
2449
|
+
readonly description: "Ticket category.";
|
|
2450
|
+
readonly example: "technical";
|
|
2451
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
2452
|
+
};
|
|
2453
|
+
readonly summary: {
|
|
2454
|
+
readonly type: "string";
|
|
2455
|
+
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
2456
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2457
|
+
};
|
|
2458
|
+
readonly support_access_granted: {
|
|
2459
|
+
readonly type: "boolean";
|
|
2460
|
+
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.";
|
|
2461
|
+
readonly example: true;
|
|
2462
|
+
};
|
|
2463
|
+
readonly support_access_granted_at: {
|
|
2464
|
+
readonly type: "string";
|
|
2465
|
+
readonly format: "date-time";
|
|
2466
|
+
readonly nullable: true;
|
|
2467
|
+
readonly description: "When support access was granted. Null if it never was. Kept after the ticket is closed.";
|
|
2468
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2469
|
+
};
|
|
2470
|
+
readonly closed_at: {
|
|
2471
|
+
readonly type: "string";
|
|
2472
|
+
readonly format: "date-time";
|
|
2473
|
+
readonly nullable: true;
|
|
2474
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
2475
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
2476
|
+
};
|
|
2477
|
+
readonly date_created: {
|
|
2478
|
+
readonly type: "string";
|
|
2479
|
+
readonly format: "date-time";
|
|
2480
|
+
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
2481
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2482
|
+
};
|
|
2483
|
+
readonly date_updated: {
|
|
2484
|
+
readonly type: "string";
|
|
2485
|
+
readonly format: "date-time";
|
|
2486
|
+
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
2487
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2488
|
+
};
|
|
2489
|
+
readonly messages: {
|
|
2490
|
+
readonly type: "array";
|
|
2491
|
+
readonly items: {
|
|
2492
|
+
readonly type: "object";
|
|
2493
|
+
readonly properties: {
|
|
2494
|
+
readonly id: {
|
|
2495
|
+
readonly type: "string";
|
|
2496
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2497
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2498
|
+
};
|
|
2499
|
+
readonly type: {
|
|
2500
|
+
readonly type: "string";
|
|
2501
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2502
|
+
readonly example: "customer_reply";
|
|
2503
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2504
|
+
};
|
|
2505
|
+
readonly body: {
|
|
2506
|
+
readonly type: "string";
|
|
2507
|
+
readonly description: "Message body in markdown.";
|
|
2508
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2509
|
+
};
|
|
2510
|
+
readonly author_first_name: {
|
|
2511
|
+
readonly type: "string";
|
|
2512
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2513
|
+
readonly example: "Jane";
|
|
2514
|
+
};
|
|
2515
|
+
readonly author_last_name: {
|
|
2516
|
+
readonly type: "string";
|
|
2517
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2518
|
+
readonly example: "Doe";
|
|
2519
|
+
};
|
|
2520
|
+
readonly attachments: {
|
|
2521
|
+
readonly type: "array";
|
|
2522
|
+
readonly items: {
|
|
2523
|
+
readonly type: "object";
|
|
2524
|
+
readonly properties: {
|
|
2525
|
+
readonly id: {
|
|
2526
|
+
readonly type: "string";
|
|
2527
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2528
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2529
|
+
};
|
|
2530
|
+
readonly filename: {
|
|
2531
|
+
readonly type: "string";
|
|
2532
|
+
readonly description: "Original filename as uploaded.";
|
|
2533
|
+
readonly example: "debug.log";
|
|
2534
|
+
};
|
|
2535
|
+
readonly content_type: {
|
|
2536
|
+
readonly type: "string";
|
|
2537
|
+
readonly description: "MIME content type of the attachment.";
|
|
2538
|
+
readonly example: "text/plain";
|
|
2539
|
+
};
|
|
2540
|
+
readonly size: {
|
|
2541
|
+
readonly type: "integer";
|
|
2542
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2543
|
+
readonly example: 12345;
|
|
2544
|
+
};
|
|
2545
|
+
};
|
|
2546
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2547
|
+
readonly additionalProperties: false;
|
|
2548
|
+
};
|
|
2549
|
+
readonly description: "Attachments associated with this message.";
|
|
2550
|
+
readonly example: readonly [];
|
|
2551
|
+
};
|
|
2552
|
+
readonly date_created: {
|
|
2553
|
+
readonly type: "string";
|
|
2554
|
+
readonly format: "date-time";
|
|
2555
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2556
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2557
|
+
};
|
|
2558
|
+
};
|
|
2559
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2560
|
+
readonly additionalProperties: false;
|
|
2561
|
+
};
|
|
2562
|
+
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
2563
|
+
};
|
|
2564
|
+
};
|
|
2565
|
+
readonly required: readonly ["id", "status", "category", "summary", "support_access_granted", "support_access_granted_at", "date_created", "date_updated"];
|
|
1389
2566
|
readonly additionalProperties: false;
|
|
1390
2567
|
};
|
|
1391
2568
|
export declare const TokenCreateInputSchema: {
|
|
@@ -1481,9 +2658,10 @@ export declare const UsageFacetsSchema: {
|
|
|
1481
2658
|
readonly type: "array";
|
|
1482
2659
|
readonly items: {
|
|
1483
2660
|
readonly type: "string";
|
|
2661
|
+
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"];
|
|
1484
2662
|
};
|
|
1485
2663
|
readonly description: "List of unique products";
|
|
1486
|
-
readonly example: readonly ["
|
|
2664
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
1487
2665
|
};
|
|
1488
2666
|
};
|
|
1489
2667
|
readonly additionalProperties: false;
|
|
@@ -1509,7 +2687,8 @@ export declare const UsageResponseSchema: {
|
|
|
1509
2687
|
readonly product: {
|
|
1510
2688
|
readonly type: "string";
|
|
1511
2689
|
readonly description: "The product the usage is associated with";
|
|
1512
|
-
readonly example: "
|
|
2690
|
+
readonly example: "cfke_controlplane_pro";
|
|
2691
|
+
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"];
|
|
1513
2692
|
};
|
|
1514
2693
|
readonly value: {
|
|
1515
2694
|
readonly type: "number";
|
|
@@ -1549,9 +2728,10 @@ export declare const UsageResponseSchema: {
|
|
|
1549
2728
|
readonly type: "array";
|
|
1550
2729
|
readonly items: {
|
|
1551
2730
|
readonly type: "string";
|
|
2731
|
+
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"];
|
|
1552
2732
|
};
|
|
1553
2733
|
readonly description: "List of unique products";
|
|
1554
|
-
readonly example: readonly ["
|
|
2734
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
1555
2735
|
};
|
|
1556
2736
|
};
|
|
1557
2737
|
readonly additionalProperties: false;
|
|
@@ -1577,7 +2757,8 @@ export declare const UsageSchema: {
|
|
|
1577
2757
|
readonly product: {
|
|
1578
2758
|
readonly type: "string";
|
|
1579
2759
|
readonly description: "The product the usage is associated with";
|
|
1580
|
-
readonly example: "
|
|
2760
|
+
readonly example: "cfke_controlplane_pro";
|
|
2761
|
+
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"];
|
|
1581
2762
|
};
|
|
1582
2763
|
readonly value: {
|
|
1583
2764
|
readonly type: "number";
|
|
@@ -1634,18 +2815,6 @@ export declare const UserCreateInputSchema: {
|
|
|
1634
2815
|
readonly minLength: 8;
|
|
1635
2816
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
1636
2817
|
};
|
|
1637
|
-
readonly status: {
|
|
1638
|
-
readonly type: "string";
|
|
1639
|
-
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
1640
|
-
readonly example: "active";
|
|
1641
|
-
readonly enum: readonly ["active", "inactive"];
|
|
1642
|
-
};
|
|
1643
|
-
readonly role: {
|
|
1644
|
-
readonly type: "string";
|
|
1645
|
-
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
1646
|
-
readonly example: "User";
|
|
1647
|
-
readonly enum: readonly ["Administrator", "User"];
|
|
1648
|
-
};
|
|
1649
2818
|
};
|
|
1650
2819
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
1651
2820
|
readonly additionalProperties: false;
|