@cloudfleet/sdk 0.0.1-cb875c6 → 0.0.1-cc8badf
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 +1077 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1286 -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 +1363 -171
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +2830 -239
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +287 -184
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +436 -379
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +8 -8
- package/dist/types.gen.d.ts +1775 -693
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3707 -1414
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1509 -618
- 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,26 +275,103 @@ 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";
|
|
285
284
|
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-]+)*))?$";
|
|
286
285
|
readonly description: "Version of the kubernetes cluster.";
|
|
287
286
|
readonly default: "1.x.x-cfke.x";
|
|
288
|
-
readonly example: "1.
|
|
287
|
+
readonly example: "1.x.x-cfke.x";
|
|
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
|
+
};
|
|
289
370
|
};
|
|
290
371
|
};
|
|
291
|
-
readonly required: readonly ["name", "
|
|
372
|
+
readonly required: readonly ["name", "region"];
|
|
292
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.";
|
|
293
375
|
};
|
|
294
376
|
export declare const ClusterJoinInformationSchema: {
|
|
295
377
|
readonly type: "object";
|
|
@@ -305,11 +387,26 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
305
387
|
readonly description: "Internal URL of the Kubernetes cluster control plane. This is the endpoint that kubelet uses to connect to the cluster.";
|
|
306
388
|
readonly example: "https://10.31.64.7:6443";
|
|
307
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
|
+
};
|
|
308
400
|
readonly auth_key: {
|
|
309
401
|
readonly type: "string";
|
|
310
402
|
readonly description: "Authentication key for the cluster.";
|
|
311
403
|
readonly example: "tskey-auth-kBV8wr1dk911CNTRL-...";
|
|
312
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
|
+
};
|
|
313
410
|
readonly bootstrap_token: {
|
|
314
411
|
readonly type: "string";
|
|
315
412
|
readonly description: "Bootstrap token for the cluster.";
|
|
@@ -367,7 +464,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
367
464
|
readonly description: "OIDC Information for hosts to access to third party API's.";
|
|
368
465
|
};
|
|
369
466
|
};
|
|
370
|
-
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"];
|
|
371
468
|
readonly additionalProperties: false;
|
|
372
469
|
};
|
|
373
470
|
export declare const ClusterSchema: {
|
|
@@ -384,22 +481,100 @@ export declare const ClusterSchema: {
|
|
|
384
481
|
readonly tier: {
|
|
385
482
|
readonly type: "string";
|
|
386
483
|
readonly description: "Tier of the cluster.";
|
|
484
|
+
readonly default: "basic";
|
|
387
485
|
readonly example: "pro";
|
|
388
|
-
readonly enum: readonly ["basic", "pro"];
|
|
389
|
-
};
|
|
390
|
-
readonly region: {
|
|
391
|
-
readonly type: "string";
|
|
392
|
-
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.";
|
|
393
|
-
readonly default: "staging";
|
|
394
|
-
readonly example: "northamerica-central-1a";
|
|
395
|
-
readonly enum: readonly ["staging", "northamerica-central-1", "europe-central-1a", "northamerica-central-1a"];
|
|
486
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
396
487
|
};
|
|
397
488
|
readonly version_channel: {
|
|
398
489
|
readonly type: "string";
|
|
399
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-]+)*))?$";
|
|
400
491
|
readonly description: "Version of the kubernetes cluster.";
|
|
401
492
|
readonly default: "1.x.x-cfke.x";
|
|
402
|
-
readonly example: "1.
|
|
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
|
+
};
|
|
534
|
+
};
|
|
535
|
+
readonly region: {
|
|
536
|
+
readonly type: "string";
|
|
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
|
+
};
|
|
403
578
|
};
|
|
404
579
|
readonly id: {
|
|
405
580
|
readonly type: "string";
|
|
@@ -409,16 +584,27 @@ export declare const ClusterSchema: {
|
|
|
409
584
|
};
|
|
410
585
|
readonly status: {
|
|
411
586
|
readonly type: "string";
|
|
412
|
-
readonly description: "Status of the cluster.
|
|
413
|
-
readonly example: "
|
|
414
|
-
readonly enum: readonly ["
|
|
587
|
+
readonly description: "Status of the cluster.";
|
|
588
|
+
readonly example: "deployed";
|
|
589
|
+
readonly enum: readonly ["creating", "deployed", "updating", "disabled"];
|
|
415
590
|
};
|
|
416
591
|
readonly endpoint: {
|
|
417
592
|
readonly anyOf: readonly [{
|
|
418
593
|
readonly type: "string";
|
|
419
594
|
readonly format: "uri";
|
|
420
|
-
readonly description: "URL of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
421
|
-
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";
|
|
422
608
|
}, {
|
|
423
609
|
readonly type: "string";
|
|
424
610
|
readonly enum: readonly [""];
|
|
@@ -450,8 +636,9 @@ export declare const ClusterSchema: {
|
|
|
450
636
|
readonly example: true;
|
|
451
637
|
};
|
|
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,18 +654,60 @@ 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.";
|
|
477
|
-
readonly
|
|
665
|
+
readonly default: "1.x.x-cfke.x";
|
|
666
|
+
readonly example: "1.x.x-cfke.x";
|
|
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
|
+
};
|
|
478
706
|
};
|
|
479
707
|
};
|
|
480
|
-
readonly required: readonly ["
|
|
708
|
+
readonly required: readonly ["name"];
|
|
481
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.";
|
|
482
711
|
};
|
|
483
712
|
export declare const FleetCreateInputSchema: {
|
|
484
713
|
readonly type: "object";
|
|
@@ -487,13 +716,12 @@ export declare const FleetCreateInputSchema: {
|
|
|
487
716
|
readonly type: "object";
|
|
488
717
|
readonly properties: {
|
|
489
718
|
readonly cpu: {
|
|
490
|
-
readonly type: "
|
|
491
|
-
readonly format: "float";
|
|
719
|
+
readonly type: "integer";
|
|
492
720
|
readonly minimum: 0;
|
|
493
|
-
readonly
|
|
721
|
+
readonly maximum: 100000;
|
|
722
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
494
723
|
};
|
|
495
724
|
};
|
|
496
|
-
readonly required: readonly ["cpu"];
|
|
497
725
|
readonly additionalProperties: false;
|
|
498
726
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
499
727
|
};
|
|
@@ -502,14 +730,15 @@ export declare const FleetCreateInputSchema: {
|
|
|
502
730
|
readonly properties: {
|
|
503
731
|
readonly enabled: {
|
|
504
732
|
readonly type: "boolean";
|
|
505
|
-
readonly default: true;
|
|
506
733
|
};
|
|
507
734
|
readonly project: {
|
|
508
735
|
readonly type: "string";
|
|
509
|
-
readonly
|
|
736
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
737
|
+
readonly description: "GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.";
|
|
738
|
+
readonly example: "my-cloudfleet-project";
|
|
510
739
|
};
|
|
511
740
|
};
|
|
512
|
-
readonly required: readonly ["
|
|
741
|
+
readonly required: readonly ["enabled"];
|
|
513
742
|
readonly additionalProperties: false;
|
|
514
743
|
};
|
|
515
744
|
readonly hetzner: {
|
|
@@ -517,14 +746,16 @@ export declare const FleetCreateInputSchema: {
|
|
|
517
746
|
readonly properties: {
|
|
518
747
|
readonly enabled: {
|
|
519
748
|
readonly type: "boolean";
|
|
520
|
-
readonly default: true;
|
|
521
749
|
};
|
|
522
750
|
readonly apiKey: {
|
|
523
751
|
readonly type: "string";
|
|
524
|
-
readonly
|
|
752
|
+
readonly maxLength: 64;
|
|
753
|
+
readonly minLength: 64;
|
|
754
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
755
|
+
readonly description: "Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.";
|
|
525
756
|
};
|
|
526
757
|
};
|
|
527
|
-
readonly required: readonly ["
|
|
758
|
+
readonly required: readonly ["enabled"];
|
|
528
759
|
readonly additionalProperties: false;
|
|
529
760
|
};
|
|
530
761
|
readonly aws: {
|
|
@@ -532,16 +763,106 @@ export declare const FleetCreateInputSchema: {
|
|
|
532
763
|
readonly properties: {
|
|
533
764
|
readonly enabled: {
|
|
534
765
|
readonly type: "boolean";
|
|
535
|
-
readonly default: true;
|
|
536
766
|
};
|
|
537
767
|
readonly controllerRoleArn: {
|
|
538
768
|
readonly type: "string";
|
|
539
|
-
readonly
|
|
769
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
770
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
771
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
540
772
|
};
|
|
541
773
|
};
|
|
542
|
-
readonly required: readonly ["
|
|
774
|
+
readonly required: readonly ["enabled"];
|
|
543
775
|
readonly additionalProperties: false;
|
|
544
776
|
};
|
|
777
|
+
readonly constraints: {
|
|
778
|
+
readonly type: "object";
|
|
779
|
+
readonly properties: {
|
|
780
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
781
|
+
readonly type: "array";
|
|
782
|
+
readonly items: {
|
|
783
|
+
readonly type: "string";
|
|
784
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
785
|
+
};
|
|
786
|
+
readonly minItems: 1;
|
|
787
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
788
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
789
|
+
};
|
|
790
|
+
readonly 'kubernetes.io/arch': {
|
|
791
|
+
readonly type: "array";
|
|
792
|
+
readonly items: {
|
|
793
|
+
readonly type: "string";
|
|
794
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
795
|
+
};
|
|
796
|
+
readonly minItems: 1;
|
|
797
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
798
|
+
readonly default: readonly ["amd64"];
|
|
799
|
+
};
|
|
800
|
+
readonly 'cfke.io/instance-family': {
|
|
801
|
+
readonly type: "array";
|
|
802
|
+
readonly items: {
|
|
803
|
+
readonly type: "string";
|
|
804
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
805
|
+
};
|
|
806
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
807
|
+
readonly default: readonly [];
|
|
808
|
+
};
|
|
809
|
+
readonly 'topology.kubernetes.io/region': {
|
|
810
|
+
readonly type: "array";
|
|
811
|
+
readonly items: {
|
|
812
|
+
readonly type: "string";
|
|
813
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
814
|
+
};
|
|
815
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
816
|
+
readonly default: readonly [];
|
|
817
|
+
};
|
|
818
|
+
};
|
|
819
|
+
readonly additionalProperties: false;
|
|
820
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
821
|
+
readonly default: {
|
|
822
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
823
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
824
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
825
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
826
|
+
};
|
|
827
|
+
};
|
|
828
|
+
readonly scalingProfile: {
|
|
829
|
+
readonly type: "string";
|
|
830
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
831
|
+
readonly default: "conservative";
|
|
832
|
+
readonly example: "conservative";
|
|
833
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
834
|
+
};
|
|
835
|
+
readonly taints: {
|
|
836
|
+
readonly type: "array";
|
|
837
|
+
readonly items: {
|
|
838
|
+
readonly type: "object";
|
|
839
|
+
readonly properties: {
|
|
840
|
+
readonly key: {
|
|
841
|
+
readonly type: "string";
|
|
842
|
+
readonly description: "Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.";
|
|
843
|
+
readonly example: "dedicated";
|
|
844
|
+
};
|
|
845
|
+
readonly value: {
|
|
846
|
+
readonly type: "string";
|
|
847
|
+
readonly maxLength: 63;
|
|
848
|
+
readonly pattern: "^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$";
|
|
849
|
+
readonly description: "Taint value. Optional.";
|
|
850
|
+
readonly example: "ci";
|
|
851
|
+
};
|
|
852
|
+
readonly effect: {
|
|
853
|
+
readonly type: "string";
|
|
854
|
+
readonly description: "Taint effect.";
|
|
855
|
+
readonly example: "NoSchedule";
|
|
856
|
+
readonly enum: readonly ["NoSchedule", "PreferNoSchedule", "NoExecute"];
|
|
857
|
+
};
|
|
858
|
+
};
|
|
859
|
+
readonly required: readonly ["key", "effect"];
|
|
860
|
+
readonly additionalProperties: false;
|
|
861
|
+
};
|
|
862
|
+
readonly maxItems: 50;
|
|
863
|
+
readonly description: "Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.";
|
|
864
|
+
readonly default: readonly [];
|
|
865
|
+
};
|
|
545
866
|
readonly id: {
|
|
546
867
|
readonly type: "string";
|
|
547
868
|
readonly maxLength: 63;
|
|
@@ -553,6 +874,7 @@ export declare const FleetCreateInputSchema: {
|
|
|
553
874
|
};
|
|
554
875
|
readonly required: readonly ["id"];
|
|
555
876
|
readonly additionalProperties: false;
|
|
877
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
556
878
|
};
|
|
557
879
|
export declare const FleetSchema: {
|
|
558
880
|
readonly type: "object";
|
|
@@ -561,13 +883,12 @@ export declare const FleetSchema: {
|
|
|
561
883
|
readonly type: "object";
|
|
562
884
|
readonly properties: {
|
|
563
885
|
readonly cpu: {
|
|
564
|
-
readonly type: "
|
|
565
|
-
readonly format: "float";
|
|
886
|
+
readonly type: "integer";
|
|
566
887
|
readonly minimum: 0;
|
|
567
|
-
readonly
|
|
888
|
+
readonly maximum: 100000;
|
|
889
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
568
890
|
};
|
|
569
891
|
};
|
|
570
|
-
readonly required: readonly ["cpu"];
|
|
571
892
|
readonly additionalProperties: false;
|
|
572
893
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
573
894
|
};
|
|
@@ -576,14 +897,15 @@ export declare const FleetSchema: {
|
|
|
576
897
|
readonly properties: {
|
|
577
898
|
readonly enabled: {
|
|
578
899
|
readonly type: "boolean";
|
|
579
|
-
readonly default: true;
|
|
580
900
|
};
|
|
581
901
|
readonly project: {
|
|
582
902
|
readonly type: "string";
|
|
583
|
-
readonly
|
|
903
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
904
|
+
readonly description: "GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.";
|
|
905
|
+
readonly example: "my-cloudfleet-project";
|
|
584
906
|
};
|
|
585
907
|
};
|
|
586
|
-
readonly required: readonly ["
|
|
908
|
+
readonly required: readonly ["enabled"];
|
|
587
909
|
readonly additionalProperties: false;
|
|
588
910
|
};
|
|
589
911
|
readonly hetzner: {
|
|
@@ -591,14 +913,14 @@ export declare const FleetSchema: {
|
|
|
591
913
|
readonly properties: {
|
|
592
914
|
readonly enabled: {
|
|
593
915
|
readonly type: "boolean";
|
|
594
|
-
readonly default: true;
|
|
595
916
|
};
|
|
596
917
|
readonly apiKey: {
|
|
597
918
|
readonly type: "string";
|
|
598
|
-
readonly
|
|
919
|
+
readonly pattern: "^\\*{64}$";
|
|
920
|
+
readonly description: "Redacted Hetzner API token. Returned as 64 asterisks when a token is configured; omitted otherwise. The real value is never echoed by the API.";
|
|
599
921
|
};
|
|
600
922
|
};
|
|
601
|
-
readonly required: readonly ["
|
|
923
|
+
readonly required: readonly ["enabled"];
|
|
602
924
|
readonly additionalProperties: false;
|
|
603
925
|
};
|
|
604
926
|
readonly aws: {
|
|
@@ -606,15 +928,106 @@ export declare const FleetSchema: {
|
|
|
606
928
|
readonly properties: {
|
|
607
929
|
readonly enabled: {
|
|
608
930
|
readonly type: "boolean";
|
|
609
|
-
readonly default: true;
|
|
610
931
|
};
|
|
611
932
|
readonly controllerRoleArn: {
|
|
612
933
|
readonly type: "string";
|
|
613
|
-
readonly
|
|
934
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
935
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
936
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
937
|
+
};
|
|
938
|
+
};
|
|
939
|
+
readonly required: readonly ["enabled"];
|
|
940
|
+
readonly additionalProperties: false;
|
|
941
|
+
};
|
|
942
|
+
readonly constraints: {
|
|
943
|
+
readonly type: "object";
|
|
944
|
+
readonly properties: {
|
|
945
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
946
|
+
readonly type: "array";
|
|
947
|
+
readonly items: {
|
|
948
|
+
readonly type: "string";
|
|
949
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
950
|
+
};
|
|
951
|
+
readonly minItems: 1;
|
|
952
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
953
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
954
|
+
};
|
|
955
|
+
readonly 'kubernetes.io/arch': {
|
|
956
|
+
readonly type: "array";
|
|
957
|
+
readonly items: {
|
|
958
|
+
readonly type: "string";
|
|
959
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
960
|
+
};
|
|
961
|
+
readonly minItems: 1;
|
|
962
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
963
|
+
readonly default: readonly ["amd64"];
|
|
964
|
+
};
|
|
965
|
+
readonly 'cfke.io/instance-family': {
|
|
966
|
+
readonly type: "array";
|
|
967
|
+
readonly items: {
|
|
968
|
+
readonly type: "string";
|
|
969
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
970
|
+
};
|
|
971
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
972
|
+
readonly default: readonly [];
|
|
973
|
+
};
|
|
974
|
+
readonly 'topology.kubernetes.io/region': {
|
|
975
|
+
readonly type: "array";
|
|
976
|
+
readonly items: {
|
|
977
|
+
readonly type: "string";
|
|
978
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
979
|
+
};
|
|
980
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
981
|
+
readonly default: readonly [];
|
|
614
982
|
};
|
|
615
983
|
};
|
|
616
|
-
readonly required: readonly ["
|
|
984
|
+
readonly required: readonly ["karpenter.sh/capacity-type", "kubernetes.io/arch"];
|
|
617
985
|
readonly additionalProperties: false;
|
|
986
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
987
|
+
readonly default: {
|
|
988
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
989
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
990
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
991
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
992
|
+
};
|
|
993
|
+
};
|
|
994
|
+
readonly scalingProfile: {
|
|
995
|
+
readonly type: "string";
|
|
996
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
997
|
+
readonly default: "conservative";
|
|
998
|
+
readonly example: "conservative";
|
|
999
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
1000
|
+
};
|
|
1001
|
+
readonly taints: {
|
|
1002
|
+
readonly type: "array";
|
|
1003
|
+
readonly items: {
|
|
1004
|
+
readonly type: "object";
|
|
1005
|
+
readonly properties: {
|
|
1006
|
+
readonly key: {
|
|
1007
|
+
readonly type: "string";
|
|
1008
|
+
readonly description: "Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.";
|
|
1009
|
+
readonly example: "dedicated";
|
|
1010
|
+
};
|
|
1011
|
+
readonly value: {
|
|
1012
|
+
readonly type: "string";
|
|
1013
|
+
readonly maxLength: 63;
|
|
1014
|
+
readonly pattern: "^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$";
|
|
1015
|
+
readonly description: "Taint value. Optional.";
|
|
1016
|
+
readonly example: "ci";
|
|
1017
|
+
};
|
|
1018
|
+
readonly effect: {
|
|
1019
|
+
readonly type: "string";
|
|
1020
|
+
readonly description: "Taint effect.";
|
|
1021
|
+
readonly example: "NoSchedule";
|
|
1022
|
+
readonly enum: readonly ["NoSchedule", "PreferNoSchedule", "NoExecute"];
|
|
1023
|
+
};
|
|
1024
|
+
};
|
|
1025
|
+
readonly required: readonly ["key", "effect"];
|
|
1026
|
+
readonly additionalProperties: false;
|
|
1027
|
+
};
|
|
1028
|
+
readonly maxItems: 50;
|
|
1029
|
+
readonly description: "Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.";
|
|
1030
|
+
readonly default: readonly [];
|
|
618
1031
|
};
|
|
619
1032
|
readonly id: {
|
|
620
1033
|
readonly type: "string";
|
|
@@ -624,9 +1037,30 @@ export declare const FleetSchema: {
|
|
|
624
1037
|
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
625
1038
|
readonly example: "new-clouds-fleet";
|
|
626
1039
|
};
|
|
1040
|
+
readonly ready: {
|
|
1041
|
+
readonly type: "boolean";
|
|
1042
|
+
readonly description: "Indicates whether the fleet configuration is healthy.";
|
|
1043
|
+
readonly example: true;
|
|
1044
|
+
};
|
|
1045
|
+
readonly status_message: {
|
|
1046
|
+
readonly type: "string";
|
|
1047
|
+
readonly description: "Human-readable reason the fleet is not ready. Present only when `ready` is false.";
|
|
1048
|
+
readonly example: "Invalid provider permissions.";
|
|
1049
|
+
};
|
|
1050
|
+
readonly created_at: {
|
|
1051
|
+
readonly type: "string";
|
|
1052
|
+
readonly description: "Creation date and time of the fleet.";
|
|
1053
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
1054
|
+
};
|
|
1055
|
+
readonly updated_at: {
|
|
1056
|
+
readonly type: "string";
|
|
1057
|
+
readonly description: "Date and time the fleet was last updated.";
|
|
1058
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
1059
|
+
};
|
|
627
1060
|
};
|
|
628
|
-
readonly required: readonly ["id"];
|
|
1061
|
+
readonly required: readonly ["constraints", "scalingProfile", "taints", "id", "ready", "created_at", "updated_at"];
|
|
629
1062
|
readonly additionalProperties: false;
|
|
1063
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
630
1064
|
};
|
|
631
1065
|
export declare const FleetUpdateInputSchema: {
|
|
632
1066
|
readonly type: "object";
|
|
@@ -635,13 +1069,12 @@ export declare const FleetUpdateInputSchema: {
|
|
|
635
1069
|
readonly type: "object";
|
|
636
1070
|
readonly properties: {
|
|
637
1071
|
readonly cpu: {
|
|
638
|
-
readonly type: "
|
|
639
|
-
readonly format: "float";
|
|
1072
|
+
readonly type: "integer";
|
|
640
1073
|
readonly minimum: 0;
|
|
641
|
-
readonly
|
|
1074
|
+
readonly maximum: 100000;
|
|
1075
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
642
1076
|
};
|
|
643
1077
|
};
|
|
644
|
-
readonly required: readonly ["cpu"];
|
|
645
1078
|
readonly additionalProperties: false;
|
|
646
1079
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
647
1080
|
};
|
|
@@ -650,14 +1083,15 @@ export declare const FleetUpdateInputSchema: {
|
|
|
650
1083
|
readonly properties: {
|
|
651
1084
|
readonly enabled: {
|
|
652
1085
|
readonly type: "boolean";
|
|
653
|
-
readonly default: true;
|
|
654
1086
|
};
|
|
655
1087
|
readonly project: {
|
|
656
1088
|
readonly type: "string";
|
|
657
|
-
readonly
|
|
1089
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
1090
|
+
readonly description: "GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.";
|
|
1091
|
+
readonly example: "my-cloudfleet-project";
|
|
658
1092
|
};
|
|
659
1093
|
};
|
|
660
|
-
readonly required: readonly ["
|
|
1094
|
+
readonly required: readonly ["enabled"];
|
|
661
1095
|
readonly additionalProperties: false;
|
|
662
1096
|
};
|
|
663
1097
|
readonly hetzner: {
|
|
@@ -665,14 +1099,16 @@ export declare const FleetUpdateInputSchema: {
|
|
|
665
1099
|
readonly properties: {
|
|
666
1100
|
readonly enabled: {
|
|
667
1101
|
readonly type: "boolean";
|
|
668
|
-
readonly default: true;
|
|
669
1102
|
};
|
|
670
1103
|
readonly apiKey: {
|
|
671
1104
|
readonly type: "string";
|
|
672
|
-
readonly
|
|
1105
|
+
readonly maxLength: 64;
|
|
1106
|
+
readonly minLength: 64;
|
|
1107
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
1108
|
+
readonly description: "Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.";
|
|
673
1109
|
};
|
|
674
1110
|
};
|
|
675
|
-
readonly required: readonly ["
|
|
1111
|
+
readonly required: readonly ["enabled"];
|
|
676
1112
|
readonly additionalProperties: false;
|
|
677
1113
|
};
|
|
678
1114
|
readonly aws: {
|
|
@@ -680,17 +1116,128 @@ export declare const FleetUpdateInputSchema: {
|
|
|
680
1116
|
readonly properties: {
|
|
681
1117
|
readonly enabled: {
|
|
682
1118
|
readonly type: "boolean";
|
|
683
|
-
readonly default: true;
|
|
684
1119
|
};
|
|
685
1120
|
readonly controllerRoleArn: {
|
|
686
1121
|
readonly type: "string";
|
|
687
|
-
readonly
|
|
1122
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
1123
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
1124
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
688
1125
|
};
|
|
689
1126
|
};
|
|
690
|
-
readonly required: readonly ["
|
|
1127
|
+
readonly required: readonly ["enabled"];
|
|
691
1128
|
readonly additionalProperties: false;
|
|
692
1129
|
};
|
|
1130
|
+
readonly constraints: {
|
|
1131
|
+
readonly type: "object";
|
|
1132
|
+
readonly properties: {
|
|
1133
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
1134
|
+
readonly type: "array";
|
|
1135
|
+
readonly items: {
|
|
1136
|
+
readonly type: "string";
|
|
1137
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
1138
|
+
};
|
|
1139
|
+
readonly minItems: 1;
|
|
1140
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
1141
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
1142
|
+
};
|
|
1143
|
+
readonly 'kubernetes.io/arch': {
|
|
1144
|
+
readonly type: "array";
|
|
1145
|
+
readonly items: {
|
|
1146
|
+
readonly type: "string";
|
|
1147
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
1148
|
+
};
|
|
1149
|
+
readonly minItems: 1;
|
|
1150
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
1151
|
+
readonly default: readonly ["amd64"];
|
|
1152
|
+
};
|
|
1153
|
+
readonly 'cfke.io/instance-family': {
|
|
1154
|
+
readonly type: "array";
|
|
1155
|
+
readonly items: {
|
|
1156
|
+
readonly type: "string";
|
|
1157
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
1158
|
+
};
|
|
1159
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
1160
|
+
readonly default: readonly [];
|
|
1161
|
+
};
|
|
1162
|
+
readonly 'topology.kubernetes.io/region': {
|
|
1163
|
+
readonly type: "array";
|
|
1164
|
+
readonly items: {
|
|
1165
|
+
readonly type: "string";
|
|
1166
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
1167
|
+
};
|
|
1168
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
1169
|
+
readonly default: readonly [];
|
|
1170
|
+
};
|
|
1171
|
+
};
|
|
1172
|
+
readonly additionalProperties: false;
|
|
1173
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
1174
|
+
readonly default: {
|
|
1175
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
1176
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
1177
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
1178
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
1179
|
+
};
|
|
1180
|
+
};
|
|
1181
|
+
readonly scalingProfile: {
|
|
1182
|
+
readonly type: "string";
|
|
1183
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
1184
|
+
readonly default: "conservative";
|
|
1185
|
+
readonly example: "conservative";
|
|
1186
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
1187
|
+
};
|
|
1188
|
+
readonly taints: {
|
|
1189
|
+
readonly type: "array";
|
|
1190
|
+
readonly items: {
|
|
1191
|
+
readonly type: "object";
|
|
1192
|
+
readonly properties: {
|
|
1193
|
+
readonly key: {
|
|
1194
|
+
readonly type: "string";
|
|
1195
|
+
readonly description: "Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.";
|
|
1196
|
+
readonly example: "dedicated";
|
|
1197
|
+
};
|
|
1198
|
+
readonly value: {
|
|
1199
|
+
readonly type: "string";
|
|
1200
|
+
readonly maxLength: 63;
|
|
1201
|
+
readonly pattern: "^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$";
|
|
1202
|
+
readonly description: "Taint value. Optional.";
|
|
1203
|
+
readonly example: "ci";
|
|
1204
|
+
};
|
|
1205
|
+
readonly effect: {
|
|
1206
|
+
readonly type: "string";
|
|
1207
|
+
readonly description: "Taint effect.";
|
|
1208
|
+
readonly example: "NoSchedule";
|
|
1209
|
+
readonly enum: readonly ["NoSchedule", "PreferNoSchedule", "NoExecute"];
|
|
1210
|
+
};
|
|
1211
|
+
};
|
|
1212
|
+
readonly required: readonly ["key", "effect"];
|
|
1213
|
+
readonly additionalProperties: false;
|
|
1214
|
+
};
|
|
1215
|
+
readonly maxItems: 50;
|
|
1216
|
+
readonly description: "Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.";
|
|
1217
|
+
readonly default: readonly [];
|
|
1218
|
+
};
|
|
1219
|
+
};
|
|
1220
|
+
readonly additionalProperties: false;
|
|
1221
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
1222
|
+
};
|
|
1223
|
+
export declare const InviteCreateInputSchema: {
|
|
1224
|
+
readonly type: "object";
|
|
1225
|
+
readonly properties: {
|
|
1226
|
+
readonly email: {
|
|
1227
|
+
readonly type: "string";
|
|
1228
|
+
readonly format: "email";
|
|
1229
|
+
readonly description: "Email address of the user to invite.";
|
|
1230
|
+
readonly example: "email@example.com";
|
|
1231
|
+
};
|
|
1232
|
+
readonly role: {
|
|
1233
|
+
readonly type: "string";
|
|
1234
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1235
|
+
readonly default: "User";
|
|
1236
|
+
readonly example: "User";
|
|
1237
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1238
|
+
};
|
|
693
1239
|
};
|
|
1240
|
+
readonly required: readonly ["email"];
|
|
694
1241
|
readonly additionalProperties: false;
|
|
695
1242
|
};
|
|
696
1243
|
export declare const InviteSchema: {
|
|
@@ -724,18 +1271,148 @@ export declare const InviteSchema: {
|
|
|
724
1271
|
readonly description: "Generated unique invite code.";
|
|
725
1272
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
726
1273
|
};
|
|
1274
|
+
readonly role: {
|
|
1275
|
+
readonly type: "string";
|
|
1276
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1277
|
+
readonly default: "User";
|
|
1278
|
+
readonly example: "User";
|
|
1279
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1280
|
+
};
|
|
727
1281
|
};
|
|
728
1282
|
readonly required: readonly ["date_created"];
|
|
729
1283
|
readonly additionalProperties: false;
|
|
730
1284
|
};
|
|
1285
|
+
export declare const InvoicePaymentAttemptSchema: {
|
|
1286
|
+
readonly type: "object";
|
|
1287
|
+
readonly properties: {
|
|
1288
|
+
readonly invoice_id: {
|
|
1289
|
+
readonly type: "string";
|
|
1290
|
+
readonly description: "Identifier of the invoice.";
|
|
1291
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
1292
|
+
};
|
|
1293
|
+
readonly number: {
|
|
1294
|
+
readonly type: "string";
|
|
1295
|
+
readonly nullable: true;
|
|
1296
|
+
readonly description: "Invoice number. Null if the invoice has no number.";
|
|
1297
|
+
readonly example: "CF-0042";
|
|
1298
|
+
};
|
|
1299
|
+
readonly amount: {
|
|
1300
|
+
readonly type: "number";
|
|
1301
|
+
readonly format: "float";
|
|
1302
|
+
readonly description: "Amount outstanding when the charge was attempted, in the smallest currency unit.";
|
|
1303
|
+
readonly example: 4200;
|
|
1304
|
+
};
|
|
1305
|
+
readonly currency: {
|
|
1306
|
+
readonly type: "string";
|
|
1307
|
+
readonly description: "Currency of the invoice.";
|
|
1308
|
+
readonly example: "eur";
|
|
1309
|
+
};
|
|
1310
|
+
readonly status: {
|
|
1311
|
+
readonly type: "string";
|
|
1312
|
+
readonly description: "Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).";
|
|
1313
|
+
readonly example: "paid";
|
|
1314
|
+
readonly enum: readonly ["paid", "processing", "requires_action", "failed"];
|
|
1315
|
+
};
|
|
1316
|
+
readonly client_secret: {
|
|
1317
|
+
readonly type: "string";
|
|
1318
|
+
readonly nullable: true;
|
|
1319
|
+
readonly description: "Client secret used to complete customer authentication. Set only when `status` is `requires_action`.";
|
|
1320
|
+
readonly example: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH";
|
|
1321
|
+
};
|
|
1322
|
+
readonly failure_code: {
|
|
1323
|
+
readonly type: "string";
|
|
1324
|
+
readonly nullable: true;
|
|
1325
|
+
readonly description: "Decline code. Set only when `status` is `failed`.";
|
|
1326
|
+
readonly example: "insufficient_funds";
|
|
1327
|
+
};
|
|
1328
|
+
readonly failure_message: {
|
|
1329
|
+
readonly type: "string";
|
|
1330
|
+
readonly nullable: true;
|
|
1331
|
+
readonly description: "Explanation of the decline, suitable for display. Set only when `status` is `failed`.";
|
|
1332
|
+
readonly example: "Your card has insufficient funds.";
|
|
1333
|
+
};
|
|
1334
|
+
};
|
|
1335
|
+
readonly required: readonly ["invoice_id", "number", "amount", "currency", "status", "client_secret", "failure_code", "failure_message"];
|
|
1336
|
+
readonly additionalProperties: false;
|
|
1337
|
+
};
|
|
1338
|
+
export declare const InvoicePaymentResultSchema: {
|
|
1339
|
+
readonly type: "object";
|
|
1340
|
+
readonly properties: {
|
|
1341
|
+
readonly code: {
|
|
1342
|
+
readonly type: "string";
|
|
1343
|
+
readonly description: "Overall outcome: `paid` (nothing outstanding), `processing` (all accepted, not yet settled), `action_required` (one or more await customer authentication), `partially_paid`, `failed`, `nothing_due`, or `bank_transfer_due` (the organization pays by bank transfer; nothing was charged).";
|
|
1344
|
+
readonly example: "partially_paid";
|
|
1345
|
+
readonly enum: readonly ["paid", "processing", "action_required", "partially_paid", "failed", "nothing_due", "bank_transfer_due"];
|
|
1346
|
+
};
|
|
1347
|
+
readonly message: {
|
|
1348
|
+
readonly type: "string";
|
|
1349
|
+
readonly description: "Summary of the outcome, suitable for display.";
|
|
1350
|
+
readonly example: "1 of 2 open invoices was paid. Invoice CF-0043 was declined: Your card has insufficient funds.";
|
|
1351
|
+
};
|
|
1352
|
+
readonly results: {
|
|
1353
|
+
readonly type: "array";
|
|
1354
|
+
readonly items: {
|
|
1355
|
+
readonly type: "object";
|
|
1356
|
+
readonly properties: {
|
|
1357
|
+
readonly invoice_id: {
|
|
1358
|
+
readonly type: "string";
|
|
1359
|
+
readonly description: "Identifier of the invoice.";
|
|
1360
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
1361
|
+
};
|
|
1362
|
+
readonly number: {
|
|
1363
|
+
readonly type: "string";
|
|
1364
|
+
readonly description: "Invoice number. Null if the invoice has no number.";
|
|
1365
|
+
readonly example: "CF-0042";
|
|
1366
|
+
};
|
|
1367
|
+
readonly amount: {
|
|
1368
|
+
readonly type: "number";
|
|
1369
|
+
readonly format: "float";
|
|
1370
|
+
readonly description: "Amount outstanding when the charge was attempted, in the smallest currency unit.";
|
|
1371
|
+
readonly example: 4200;
|
|
1372
|
+
};
|
|
1373
|
+
readonly currency: {
|
|
1374
|
+
readonly type: "string";
|
|
1375
|
+
readonly description: "Currency of the invoice.";
|
|
1376
|
+
readonly example: "eur";
|
|
1377
|
+
};
|
|
1378
|
+
readonly status: {
|
|
1379
|
+
readonly type: "string";
|
|
1380
|
+
readonly description: "Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).";
|
|
1381
|
+
readonly example: "paid";
|
|
1382
|
+
readonly enum: readonly ["paid", "processing", "requires_action", "failed"];
|
|
1383
|
+
};
|
|
1384
|
+
readonly client_secret: {
|
|
1385
|
+
readonly type: "string";
|
|
1386
|
+
readonly description: "Client secret used to complete customer authentication. Set only when `status` is `requires_action`.";
|
|
1387
|
+
readonly example: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH";
|
|
1388
|
+
};
|
|
1389
|
+
readonly failure_code: {
|
|
1390
|
+
readonly type: "string";
|
|
1391
|
+
readonly description: "Decline code. Set only when `status` is `failed`.";
|
|
1392
|
+
readonly example: "insufficient_funds";
|
|
1393
|
+
};
|
|
1394
|
+
readonly failure_message: {
|
|
1395
|
+
readonly type: "string";
|
|
1396
|
+
readonly description: "Explanation of the decline, suitable for display. Set only when `status` is `failed`.";
|
|
1397
|
+
readonly example: "Your card has insufficient funds.";
|
|
1398
|
+
};
|
|
1399
|
+
};
|
|
1400
|
+
readonly required: readonly ["invoice_id", "number", "amount", "currency", "status", "client_secret", "failure_code", "failure_message"];
|
|
1401
|
+
readonly additionalProperties: false;
|
|
1402
|
+
};
|
|
1403
|
+
readonly description: "One entry per invoice charged, oldest first.";
|
|
1404
|
+
};
|
|
1405
|
+
};
|
|
1406
|
+
readonly required: readonly ["code", "message", "results"];
|
|
1407
|
+
readonly additionalProperties: false;
|
|
1408
|
+
};
|
|
731
1409
|
export declare const InvoiceSchema: {
|
|
732
1410
|
readonly type: "object";
|
|
733
1411
|
readonly properties: {
|
|
734
1412
|
readonly id: {
|
|
735
1413
|
readonly type: "string";
|
|
736
|
-
readonly
|
|
737
|
-
readonly
|
|
738
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
1414
|
+
readonly description: "Unique identifier of the invoice.";
|
|
1415
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
739
1416
|
};
|
|
740
1417
|
readonly number: {
|
|
741
1418
|
readonly type: "string";
|
|
@@ -781,91 +1458,153 @@ export declare const InvoiceSchema: {
|
|
|
781
1458
|
readonly required: readonly ["created", "period_start", "period_end"];
|
|
782
1459
|
readonly additionalProperties: false;
|
|
783
1460
|
};
|
|
784
|
-
export declare const
|
|
1461
|
+
export declare const MarketplaceListingFilesSchema: {
|
|
785
1462
|
readonly type: "object";
|
|
786
1463
|
readonly properties: {
|
|
787
|
-
readonly
|
|
1464
|
+
readonly chartYaml: {
|
|
788
1465
|
readonly type: "string";
|
|
789
|
-
readonly
|
|
790
|
-
readonly
|
|
791
|
-
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
792
|
-
readonly description: "Id of the chart listing";
|
|
793
|
-
readonly example: "portworx-enterprise-disaster-recovery-baremetal";
|
|
1466
|
+
readonly description: "Raw Chart.yaml content from the Helm chart";
|
|
1467
|
+
readonly example: "apiVersion: v2\nname: nginx-ingress\nversion: 1.18.2-cfke.45\nappVersion: 1.9.4";
|
|
794
1468
|
};
|
|
795
|
-
readonly
|
|
796
|
-
readonly type: "string";
|
|
797
|
-
readonly description: "Name of the chart listing";
|
|
798
|
-
readonly example: "Portworx Enterprise + Disaster Recovery - Baremetal";
|
|
799
|
-
};
|
|
800
|
-
readonly developer: {
|
|
801
|
-
readonly type: "string";
|
|
802
|
-
readonly description: "Author of the chart listing";
|
|
803
|
-
readonly example: "Portworx";
|
|
804
|
-
};
|
|
805
|
-
readonly description: {
|
|
1469
|
+
readonly valuesYaml: {
|
|
806
1470
|
readonly type: "string";
|
|
807
|
-
readonly description: "
|
|
808
|
-
readonly example: "
|
|
1471
|
+
readonly description: "Raw values.yaml content from the Helm chart";
|
|
1472
|
+
readonly example: "replicaCount: 1\nimage:\n repository: nginx\n tag: latest";
|
|
809
1473
|
};
|
|
810
|
-
readonly
|
|
1474
|
+
readonly valuesSchemaJson: {
|
|
811
1475
|
readonly type: "string";
|
|
812
|
-
readonly description: "
|
|
813
|
-
readonly example: "
|
|
1476
|
+
readonly description: "JSON schema for values.yaml as a string";
|
|
1477
|
+
readonly example: "{\"type\":\"object\",\"properties\":{\"replicaCount\":{\"type\":\"number\"}}}";
|
|
814
1478
|
};
|
|
815
|
-
|
|
1479
|
+
};
|
|
1480
|
+
readonly additionalProperties: false;
|
|
1481
|
+
};
|
|
1482
|
+
export declare const MarketplaceListingSchema: {
|
|
1483
|
+
readonly type: "object";
|
|
1484
|
+
readonly properties: {
|
|
1485
|
+
readonly name: {
|
|
816
1486
|
readonly type: "string";
|
|
817
|
-
readonly description: "
|
|
818
|
-
readonly example: "
|
|
1487
|
+
readonly description: "Name of the chart";
|
|
1488
|
+
readonly example: "nginx-ingress";
|
|
819
1489
|
};
|
|
820
|
-
readonly
|
|
1490
|
+
readonly versions: {
|
|
821
1491
|
readonly type: "array";
|
|
822
1492
|
readonly items: {
|
|
823
1493
|
readonly type: "string";
|
|
824
|
-
readonly
|
|
1494
|
+
readonly pattern: "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(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-]+)*))?$";
|
|
1495
|
+
readonly description: "Specific version of the chart";
|
|
1496
|
+
readonly example: "1.18.2-cfke.45";
|
|
825
1497
|
};
|
|
826
|
-
readonly description: "
|
|
1498
|
+
readonly description: "Available versions of the chart";
|
|
827
1499
|
};
|
|
828
1500
|
readonly version_channels: {
|
|
829
1501
|
readonly type: "array";
|
|
830
1502
|
readonly items: {
|
|
831
1503
|
readonly type: "string";
|
|
832
1504
|
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-]+)*))?$";
|
|
833
|
-
readonly description: "Version
|
|
834
|
-
readonly example: "
|
|
1505
|
+
readonly description: "Version channel pattern";
|
|
1506
|
+
readonly example: "1.18.x-cfke.x";
|
|
835
1507
|
};
|
|
1508
|
+
readonly description: "Version channels for the chart";
|
|
836
1509
|
};
|
|
837
|
-
readonly
|
|
838
|
-
readonly type: "
|
|
839
|
-
readonly
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
1510
|
+
readonly latestVersion: {
|
|
1511
|
+
readonly type: "string";
|
|
1512
|
+
readonly description: "Latest version of the chart";
|
|
1513
|
+
readonly example: "1.18.2-cfke.45";
|
|
1514
|
+
};
|
|
1515
|
+
readonly metadata: {
|
|
1516
|
+
readonly type: "object";
|
|
1517
|
+
readonly properties: {
|
|
1518
|
+
readonly name: {
|
|
1519
|
+
readonly type: "string";
|
|
1520
|
+
readonly description: "Chart name from metadata";
|
|
1521
|
+
readonly example: "nginx-ingress";
|
|
1522
|
+
};
|
|
1523
|
+
readonly version: {
|
|
1524
|
+
readonly type: "string";
|
|
1525
|
+
readonly description: "Chart version from metadata";
|
|
1526
|
+
readonly example: "1.18.2-cfke.45";
|
|
1527
|
+
};
|
|
1528
|
+
readonly description: {
|
|
1529
|
+
readonly type: "string";
|
|
1530
|
+
readonly description: "Chart description";
|
|
1531
|
+
readonly example: "NGINX Ingress Controller for Kubernetes";
|
|
1532
|
+
};
|
|
1533
|
+
readonly appVersion: {
|
|
1534
|
+
readonly type: "string";
|
|
1535
|
+
readonly description: "Application version";
|
|
1536
|
+
readonly example: "1.9.4";
|
|
1537
|
+
};
|
|
1538
|
+
readonly apiVersion: {
|
|
1539
|
+
readonly type: "string";
|
|
1540
|
+
readonly description: "Helm API version";
|
|
1541
|
+
readonly example: "v2";
|
|
1542
|
+
};
|
|
1543
|
+
readonly keywords: {
|
|
1544
|
+
readonly type: "array";
|
|
1545
|
+
readonly items: {
|
|
843
1546
|
readonly type: "string";
|
|
844
|
-
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-]+)*))?$";
|
|
845
|
-
readonly description: "Version of the chart.";
|
|
846
|
-
readonly example: "2.1.1-cfke.123";
|
|
847
1547
|
};
|
|
848
|
-
readonly
|
|
1548
|
+
readonly description: "Chart keywords";
|
|
1549
|
+
readonly example: readonly ["ingress", "nginx", "load-balancer"];
|
|
1550
|
+
};
|
|
1551
|
+
readonly home: {
|
|
1552
|
+
readonly type: "string";
|
|
1553
|
+
readonly description: "Chart home URL";
|
|
1554
|
+
readonly example: "https://kubernetes.github.io/ingress-nginx/";
|
|
1555
|
+
};
|
|
1556
|
+
readonly icon: {
|
|
1557
|
+
readonly type: "string";
|
|
1558
|
+
readonly description: "A URL to an SVG or PNG image to be used as an icon";
|
|
1559
|
+
readonly example: "https://cloudfleet.ai/images/marketplace/icons/ingress-nginx.png";
|
|
1560
|
+
};
|
|
1561
|
+
readonly sources: {
|
|
1562
|
+
readonly type: "array";
|
|
1563
|
+
readonly items: {
|
|
849
1564
|
readonly type: "string";
|
|
850
|
-
readonly description: "Schema of the chart values. JSON Schema as string";
|
|
851
1565
|
};
|
|
852
|
-
readonly
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
|
|
1566
|
+
readonly description: "Chart source URLs";
|
|
1567
|
+
readonly example: readonly ["https://github.com/kubernetes/ingress-nginx"];
|
|
1568
|
+
};
|
|
1569
|
+
readonly maintainers: {
|
|
1570
|
+
readonly type: "array";
|
|
1571
|
+
readonly items: {
|
|
1572
|
+
readonly type: "object";
|
|
1573
|
+
readonly properties: {
|
|
1574
|
+
readonly name: {
|
|
1575
|
+
readonly type: "string";
|
|
1576
|
+
readonly description: "Maintainer name";
|
|
1577
|
+
readonly example: "NGINX Team";
|
|
1578
|
+
};
|
|
1579
|
+
readonly email: {
|
|
1580
|
+
readonly type: "string";
|
|
1581
|
+
readonly description: "Maintainer email";
|
|
1582
|
+
readonly example: "support@nginx.org";
|
|
1583
|
+
};
|
|
1584
|
+
};
|
|
1585
|
+
readonly required: readonly ["name"];
|
|
1586
|
+
readonly additionalProperties: false;
|
|
856
1587
|
};
|
|
1588
|
+
readonly description: "Chart maintainers";
|
|
857
1589
|
};
|
|
858
|
-
readonly required: readonly ["version", "schema", "placeholder"];
|
|
859
|
-
readonly additionalProperties: false;
|
|
860
1590
|
};
|
|
1591
|
+
readonly required: readonly ["name", "version"];
|
|
1592
|
+
readonly additionalProperties: false;
|
|
1593
|
+
readonly description: "Chart metadata";
|
|
861
1594
|
};
|
|
862
1595
|
};
|
|
863
|
-
readonly required: readonly ["
|
|
1596
|
+
readonly required: readonly ["name", "versions", "version_channels", "latestVersion"];
|
|
864
1597
|
readonly additionalProperties: false;
|
|
865
1598
|
};
|
|
866
1599
|
export declare const OrganizationCreateInputSchema: {
|
|
867
1600
|
readonly type: "object";
|
|
868
1601
|
readonly properties: {
|
|
1602
|
+
readonly type: {
|
|
1603
|
+
readonly type: "string";
|
|
1604
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1605
|
+
readonly example: "business";
|
|
1606
|
+
readonly enum: readonly ["business", "personal"];
|
|
1607
|
+
};
|
|
869
1608
|
readonly email: {
|
|
870
1609
|
readonly type: "string";
|
|
871
1610
|
readonly format: "email";
|
|
@@ -874,11 +1613,13 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
874
1613
|
};
|
|
875
1614
|
readonly first_name: {
|
|
876
1615
|
readonly type: "string";
|
|
1616
|
+
readonly minLength: 1;
|
|
877
1617
|
readonly description: "First name of the billing contact person.";
|
|
878
1618
|
readonly example: "John";
|
|
879
1619
|
};
|
|
880
1620
|
readonly last_name: {
|
|
881
1621
|
readonly type: "string";
|
|
1622
|
+
readonly minLength: 1;
|
|
882
1623
|
readonly description: "Last name of the billing contact person.";
|
|
883
1624
|
readonly example: "Doe";
|
|
884
1625
|
};
|
|
@@ -896,7 +1637,19 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
896
1637
|
readonly description: "Password for the root account. Must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one number and one special character.";
|
|
897
1638
|
};
|
|
898
1639
|
};
|
|
899
|
-
readonly required: readonly ["email", "first_name", "last_name", "company_name", "password"];
|
|
1640
|
+
readonly required: readonly ["type", "email", "first_name", "last_name", "company_name", "password"];
|
|
1641
|
+
readonly additionalProperties: false;
|
|
1642
|
+
};
|
|
1643
|
+
export declare const OrganizationCreateOutputSchema: {
|
|
1644
|
+
readonly type: "object";
|
|
1645
|
+
readonly properties: {
|
|
1646
|
+
readonly id: {
|
|
1647
|
+
readonly type: "string";
|
|
1648
|
+
readonly description: "Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.";
|
|
1649
|
+
readonly example: "organization-id";
|
|
1650
|
+
};
|
|
1651
|
+
};
|
|
1652
|
+
readonly required: readonly ["id"];
|
|
900
1653
|
readonly additionalProperties: false;
|
|
901
1654
|
};
|
|
902
1655
|
export declare const OrganizationSchema: {
|
|
@@ -915,6 +1668,12 @@ export declare const OrganizationSchema: {
|
|
|
915
1668
|
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
916
1669
|
readonly example: "ACME Corp.";
|
|
917
1670
|
};
|
|
1671
|
+
readonly type: {
|
|
1672
|
+
readonly type: "string";
|
|
1673
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1674
|
+
readonly example: "business";
|
|
1675
|
+
readonly enum: readonly ["business", "personal"];
|
|
1676
|
+
};
|
|
918
1677
|
readonly date_created: {
|
|
919
1678
|
readonly type: "string";
|
|
920
1679
|
readonly format: "date-time";
|
|
@@ -946,6 +1705,17 @@ export declare const OrganizationSchema: {
|
|
|
946
1705
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
947
1706
|
readonly example: 999;
|
|
948
1707
|
};
|
|
1708
|
+
readonly enterprise_clusters_max: {
|
|
1709
|
+
readonly type: "integer";
|
|
1710
|
+
readonly minimum: 0;
|
|
1711
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1712
|
+
readonly example: 999;
|
|
1713
|
+
};
|
|
1714
|
+
readonly enterprise_clusters_available: {
|
|
1715
|
+
readonly type: "integer";
|
|
1716
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1717
|
+
readonly example: 999;
|
|
1718
|
+
};
|
|
949
1719
|
readonly fleets_max: {
|
|
950
1720
|
readonly type: "integer";
|
|
951
1721
|
readonly minimum: 0;
|
|
@@ -965,7 +1735,7 @@ export declare const OrganizationSchema: {
|
|
|
965
1735
|
readonly type: "array";
|
|
966
1736
|
readonly items: {
|
|
967
1737
|
readonly type: "string";
|
|
968
|
-
readonly example: "northamerica-central-
|
|
1738
|
+
readonly example: "northamerica-central-1a";
|
|
969
1739
|
};
|
|
970
1740
|
readonly minItems: 1;
|
|
971
1741
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -992,8 +1762,14 @@ export declare const OrganizationSchema: {
|
|
|
992
1762
|
readonly minItems: 1;
|
|
993
1763
|
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
994
1764
|
};
|
|
1765
|
+
readonly cfcr_storage_gb: {
|
|
1766
|
+
readonly type: "integer";
|
|
1767
|
+
readonly minimum: -1;
|
|
1768
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1769
|
+
readonly example: 500;
|
|
1770
|
+
};
|
|
995
1771
|
};
|
|
996
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions"];
|
|
1772
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "enterprise_clusters_max", "enterprise_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
997
1773
|
readonly additionalProperties: false;
|
|
998
1774
|
readonly description: "For security reasons, platform quota is controlled by Cloudfleet and can be updated only by Cloudfleet administrators. Please open a support ticket if you need to change the platform quota.";
|
|
999
1775
|
};
|
|
@@ -1002,8 +1778,14 @@ export declare const OrganizationSchema: {
|
|
|
1002
1778
|
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1003
1779
|
readonly enum: readonly ["active", "closed", "suspended"];
|
|
1004
1780
|
};
|
|
1781
|
+
readonly verification: {
|
|
1782
|
+
readonly type: "string";
|
|
1783
|
+
readonly description: "Verification status of the organization, which determines the assigned quota. `none` when billing information is incomplete, `submitted` when billing information is complete but the organization is not yet verified, `verified` when the organization is verified.";
|
|
1784
|
+
readonly example: "verified";
|
|
1785
|
+
readonly enum: readonly ["none", "submitted", "verified"];
|
|
1786
|
+
};
|
|
1005
1787
|
};
|
|
1006
|
-
readonly required: readonly ["id", "date_created", "quota", "status"];
|
|
1788
|
+
readonly required: readonly ["id", "type", "date_created", "quota", "status", "verification"];
|
|
1007
1789
|
readonly additionalProperties: false;
|
|
1008
1790
|
};
|
|
1009
1791
|
export declare const PaymentMethodSchema: {
|
|
@@ -1011,26 +1793,19 @@ export declare const PaymentMethodSchema: {
|
|
|
1011
1793
|
readonly properties: {
|
|
1012
1794
|
readonly id: {
|
|
1013
1795
|
readonly type: "string";
|
|
1014
|
-
readonly
|
|
1015
|
-
readonly
|
|
1016
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1017
|
-
};
|
|
1018
|
-
readonly setup: {
|
|
1019
|
-
readonly type: "boolean";
|
|
1020
|
-
readonly description: "Whether organization payment method was set up and ready to use for payments.";
|
|
1021
|
-
readonly example: true;
|
|
1796
|
+
readonly description: "Payment method identifier. Stripe payment method id for cards/SEPA; the constant `bank_transfer` for the invoice/bank-transfer method. Used to set as default or delete the payment method.";
|
|
1797
|
+
readonly example: "pm_1MtwBwLkdIwHu7ix28a3tqPa";
|
|
1022
1798
|
};
|
|
1023
1799
|
readonly type: {
|
|
1024
1800
|
readonly type: "string";
|
|
1025
|
-
readonly
|
|
1026
|
-
readonly description: "Payment method type type. Only `card` payments supported at the moment.";
|
|
1801
|
+
readonly description: "Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.";
|
|
1027
1802
|
readonly example: "card";
|
|
1028
|
-
readonly enum: readonly ["card"];
|
|
1803
|
+
readonly enum: readonly ["card", "sepa_debit", "bank_transfer"];
|
|
1029
1804
|
};
|
|
1030
1805
|
readonly last4: {
|
|
1031
1806
|
readonly type: "string";
|
|
1032
1807
|
readonly nullable: true;
|
|
1033
|
-
readonly description: "Last 4 digits of the payment card number.";
|
|
1808
|
+
readonly description: "Last 4 digits of the payment card number, of the bank account (IBAN) for SEPA Direct Debit, or of the destination IBAN for bank transfer.";
|
|
1034
1809
|
readonly example: "4242";
|
|
1035
1810
|
};
|
|
1036
1811
|
readonly exp_month: {
|
|
@@ -1038,25 +1813,46 @@ export declare const PaymentMethodSchema: {
|
|
|
1038
1813
|
readonly minimum: 1;
|
|
1039
1814
|
readonly maximum: 12;
|
|
1040
1815
|
readonly nullable: true;
|
|
1041
|
-
readonly description: "Two-digit number representing the card's expiration month.";
|
|
1042
|
-
readonly example:
|
|
1816
|
+
readonly description: "Two-digit number representing the card's expiration month. Null for SEPA Direct Debit and bank transfer.";
|
|
1817
|
+
readonly example: 12;
|
|
1043
1818
|
};
|
|
1044
1819
|
readonly exp_year: {
|
|
1045
1820
|
readonly type: "integer";
|
|
1046
|
-
readonly minimum: 2024;
|
|
1047
1821
|
readonly nullable: true;
|
|
1048
|
-
readonly description: "Four-digit number representing the card's expiration year.";
|
|
1049
|
-
readonly example:
|
|
1822
|
+
readonly description: "Four-digit number representing the card's expiration year. May be in the past for an expired card still on file. Null for SEPA Direct Debit and bank transfer.";
|
|
1823
|
+
readonly example: 2028;
|
|
1050
1824
|
};
|
|
1051
1825
|
readonly brand: {
|
|
1052
1826
|
readonly type: "string";
|
|
1053
1827
|
readonly nullable: true;
|
|
1054
|
-
readonly description: "Payment card brand
|
|
1828
|
+
readonly description: "Payment card brand as reported by Stripe, e.g. `visa`, `mastercard`, `amex`, `cartes_bancaires`, or `unknown`. Null for SEPA Direct Debit and bank transfer.";
|
|
1055
1829
|
readonly example: "visa";
|
|
1056
|
-
|
|
1830
|
+
};
|
|
1831
|
+
readonly iban: {
|
|
1832
|
+
readonly type: "string";
|
|
1833
|
+
readonly nullable: true;
|
|
1834
|
+
readonly description: "Full destination IBAN to send bank transfers to. Set only for `bank_transfer`; null otherwise. This is Cloudfleet's virtual receiving account, shown in full so the customer can pay into it.";
|
|
1835
|
+
readonly example: "DE11243015658023127510";
|
|
1836
|
+
};
|
|
1837
|
+
readonly bic: {
|
|
1838
|
+
readonly type: "string";
|
|
1839
|
+
readonly nullable: true;
|
|
1840
|
+
readonly description: "BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1841
|
+
readonly example: "SOGEDEFFXXX";
|
|
1842
|
+
};
|
|
1843
|
+
readonly account_holder_name: {
|
|
1844
|
+
readonly type: "string";
|
|
1845
|
+
readonly nullable: true;
|
|
1846
|
+
readonly description: "Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1847
|
+
readonly example: "Cloudfleet GmbH";
|
|
1848
|
+
};
|
|
1849
|
+
readonly is_default: {
|
|
1850
|
+
readonly type: "boolean";
|
|
1851
|
+
readonly description: "Whether this payment method is the default used for invoices and active subscriptions. Always false for `bank_transfer` (it cannot be a Stripe default payment method).";
|
|
1852
|
+
readonly example: true;
|
|
1057
1853
|
};
|
|
1058
1854
|
};
|
|
1059
|
-
readonly required: readonly ["id", "
|
|
1855
|
+
readonly required: readonly ["id", "type", "last4", "exp_month", "exp_year", "brand", "iban", "bic", "account_holder_name", "is_default"];
|
|
1060
1856
|
readonly additionalProperties: false;
|
|
1061
1857
|
};
|
|
1062
1858
|
export declare const PlatformQuotaSchema: {
|
|
@@ -1084,6 +1880,17 @@ export declare const PlatformQuotaSchema: {
|
|
|
1084
1880
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1085
1881
|
readonly example: 999;
|
|
1086
1882
|
};
|
|
1883
|
+
readonly enterprise_clusters_max: {
|
|
1884
|
+
readonly type: "integer";
|
|
1885
|
+
readonly minimum: 0;
|
|
1886
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1887
|
+
readonly example: 999;
|
|
1888
|
+
};
|
|
1889
|
+
readonly enterprise_clusters_available: {
|
|
1890
|
+
readonly type: "integer";
|
|
1891
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1892
|
+
readonly example: 999;
|
|
1893
|
+
};
|
|
1087
1894
|
readonly fleets_max: {
|
|
1088
1895
|
readonly type: "integer";
|
|
1089
1896
|
readonly minimum: 0;
|
|
@@ -1103,7 +1910,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1103
1910
|
readonly type: "array";
|
|
1104
1911
|
readonly items: {
|
|
1105
1912
|
readonly type: "string";
|
|
1106
|
-
readonly example: "northamerica-central-
|
|
1913
|
+
readonly example: "northamerica-central-1a";
|
|
1107
1914
|
};
|
|
1108
1915
|
readonly minItems: 1;
|
|
1109
1916
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1130,8 +1937,14 @@ export declare const PlatformQuotaSchema: {
|
|
|
1130
1937
|
readonly minItems: 1;
|
|
1131
1938
|
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1132
1939
|
};
|
|
1940
|
+
readonly cfcr_storage_gb: {
|
|
1941
|
+
readonly type: "integer";
|
|
1942
|
+
readonly minimum: -1;
|
|
1943
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1944
|
+
readonly example: 500;
|
|
1945
|
+
};
|
|
1133
1946
|
};
|
|
1134
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions"];
|
|
1947
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "enterprise_clusters_max", "enterprise_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1135
1948
|
readonly additionalProperties: false;
|
|
1136
1949
|
};
|
|
1137
1950
|
export declare const RegistryRepositorySchema: {
|
|
@@ -1150,7 +1963,7 @@ export declare const RegistryRepositorySchema: {
|
|
|
1150
1963
|
readonly uri: {
|
|
1151
1964
|
readonly type: "string";
|
|
1152
1965
|
readonly description: "Full URI of the repository.";
|
|
1153
|
-
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/
|
|
1966
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
1154
1967
|
};
|
|
1155
1968
|
};
|
|
1156
1969
|
readonly required: readonly ["name", "region", "uri"];
|
|
@@ -1172,7 +1985,7 @@ export declare const RegistryRepositoryWithTagsSchema: {
|
|
|
1172
1985
|
readonly uri: {
|
|
1173
1986
|
readonly type: "string";
|
|
1174
1987
|
readonly description: "Full URI of the repository.";
|
|
1175
|
-
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/
|
|
1988
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
1176
1989
|
};
|
|
1177
1990
|
readonly tags: {
|
|
1178
1991
|
readonly type: "array";
|
|
@@ -1195,6 +2008,14 @@ export declare const RegistryRepositoryWithTagsSchema: {
|
|
|
1195
2008
|
readonly description: "Media type of the manifest.";
|
|
1196
2009
|
readonly example: "application/vnd.docker.distribution.manifest.v2+json";
|
|
1197
2010
|
};
|
|
2011
|
+
readonly platforms: {
|
|
2012
|
+
readonly type: "array";
|
|
2013
|
+
readonly items: {
|
|
2014
|
+
readonly type: "string";
|
|
2015
|
+
};
|
|
2016
|
+
readonly description: "Array of platform strings for multi-arch images (e.g., linux/amd64, linux/arm64).";
|
|
2017
|
+
readonly example: readonly ["linux/amd64", "linux/arm64"];
|
|
2018
|
+
};
|
|
1198
2019
|
};
|
|
1199
2020
|
readonly required: readonly ["name", "size"];
|
|
1200
2021
|
readonly additionalProperties: false;
|
|
@@ -1219,6 +2040,11 @@ export declare const RegistryTagSchema: {
|
|
|
1219
2040
|
readonly description: "Tag name.";
|
|
1220
2041
|
readonly example: "latest";
|
|
1221
2042
|
};
|
|
2043
|
+
readonly digest: {
|
|
2044
|
+
readonly type: "string";
|
|
2045
|
+
readonly description: "Manifest digest for pulling by digest.";
|
|
2046
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
2047
|
+
};
|
|
1222
2048
|
readonly mediaType: {
|
|
1223
2049
|
readonly type: "string";
|
|
1224
2050
|
readonly description: "Media type of the manifest.";
|
|
@@ -1243,6 +2069,11 @@ export declare const RegistryTagSchema: {
|
|
|
1243
2069
|
readonly items: {
|
|
1244
2070
|
readonly type: "object";
|
|
1245
2071
|
readonly properties: {
|
|
2072
|
+
readonly digest: {
|
|
2073
|
+
readonly type: "string";
|
|
2074
|
+
readonly description: "Digest of the layer.";
|
|
2075
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
2076
|
+
};
|
|
1246
2077
|
readonly size: {
|
|
1247
2078
|
readonly type: "number";
|
|
1248
2079
|
readonly format: "float";
|
|
@@ -1278,11 +2109,44 @@ export declare const RegistryTagSchema: {
|
|
|
1278
2109
|
readonly description: "Operating system of the platform.";
|
|
1279
2110
|
readonly example: "linux";
|
|
1280
2111
|
};
|
|
2112
|
+
readonly variant: {
|
|
2113
|
+
readonly type: "string";
|
|
2114
|
+
readonly description: "Variant of the platform (e.g., v7, v8 for ARM).";
|
|
2115
|
+
readonly example: "v8";
|
|
2116
|
+
};
|
|
1281
2117
|
};
|
|
1282
2118
|
readonly required: readonly ["architecture", "os"];
|
|
1283
2119
|
readonly additionalProperties: false;
|
|
1284
2120
|
readonly description: "Platform information for the manifest.";
|
|
1285
2121
|
};
|
|
2122
|
+
readonly layers: {
|
|
2123
|
+
readonly type: "array";
|
|
2124
|
+
readonly items: {
|
|
2125
|
+
readonly type: "object";
|
|
2126
|
+
readonly properties: {
|
|
2127
|
+
readonly digest: {
|
|
2128
|
+
readonly type: "string";
|
|
2129
|
+
readonly description: "Digest of the layer.";
|
|
2130
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
2131
|
+
};
|
|
2132
|
+
readonly size: {
|
|
2133
|
+
readonly type: "number";
|
|
2134
|
+
readonly format: "float";
|
|
2135
|
+
readonly description: "Size of the layer in bytes.";
|
|
2136
|
+
readonly example: 5678;
|
|
2137
|
+
};
|
|
2138
|
+
};
|
|
2139
|
+
readonly required: readonly ["size"];
|
|
2140
|
+
readonly additionalProperties: false;
|
|
2141
|
+
};
|
|
2142
|
+
readonly description: "Layers for this platform.";
|
|
2143
|
+
};
|
|
2144
|
+
readonly size: {
|
|
2145
|
+
readonly type: "number";
|
|
2146
|
+
readonly format: "float";
|
|
2147
|
+
readonly description: "Total size of this platform manifest in bytes.";
|
|
2148
|
+
readonly example: 12345678;
|
|
2149
|
+
};
|
|
1286
2150
|
};
|
|
1287
2151
|
readonly required: readonly ["digest"];
|
|
1288
2152
|
readonly additionalProperties: false;
|
|
@@ -1311,7 +2175,343 @@ export declare const RegistryTagSchema: {
|
|
|
1311
2175
|
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app:latest";
|
|
1312
2176
|
};
|
|
1313
2177
|
};
|
|
1314
|
-
readonly required: readonly ["name", "size", "region", "repository", "uri"];
|
|
2178
|
+
readonly required: readonly ["name", "digest", "size", "region", "repository", "uri"];
|
|
2179
|
+
readonly additionalProperties: false;
|
|
2180
|
+
};
|
|
2181
|
+
export declare const RoadmapItemCreateInputSchema: {
|
|
2182
|
+
readonly type: "object";
|
|
2183
|
+
readonly properties: {
|
|
2184
|
+
readonly text: {
|
|
2185
|
+
readonly type: "string";
|
|
2186
|
+
readonly maxLength: 500;
|
|
2187
|
+
readonly minLength: 1;
|
|
2188
|
+
readonly description: "Your suggestion in one or two sentences. It is reviewed before it appears on the roadmap.";
|
|
2189
|
+
readonly example: "Support for ARM nodes on Hetzner.";
|
|
2190
|
+
};
|
|
2191
|
+
};
|
|
2192
|
+
readonly required: readonly ["text"];
|
|
2193
|
+
readonly additionalProperties: false;
|
|
2194
|
+
};
|
|
2195
|
+
export declare const RoadmapItemSchema: {
|
|
2196
|
+
readonly type: "object";
|
|
2197
|
+
readonly properties: {
|
|
2198
|
+
readonly id: {
|
|
2199
|
+
readonly type: "string";
|
|
2200
|
+
readonly description: "Unique identifier of the roadmap item (Mongo ObjectId).";
|
|
2201
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
2202
|
+
};
|
|
2203
|
+
readonly text: {
|
|
2204
|
+
readonly type: "string";
|
|
2205
|
+
readonly description: "Short description of the roadmap item.";
|
|
2206
|
+
readonly example: "Support for ARM nodes on Hetzner.";
|
|
2207
|
+
};
|
|
2208
|
+
readonly vote: {
|
|
2209
|
+
readonly type: "integer";
|
|
2210
|
+
readonly nullable: true;
|
|
2211
|
+
readonly description: "The caller's vote on this item: -1 (down), 1 (up), 2 (double up), or null if the caller has not voted.";
|
|
2212
|
+
readonly example: 1;
|
|
2213
|
+
readonly enum: readonly [-1, 1, 2];
|
|
2214
|
+
};
|
|
2215
|
+
};
|
|
2216
|
+
readonly required: readonly ["id", "text", "vote"];
|
|
2217
|
+
readonly additionalProperties: false;
|
|
2218
|
+
};
|
|
2219
|
+
export declare const RoadmapVoteInputSchema: {
|
|
2220
|
+
readonly type: "object";
|
|
2221
|
+
readonly properties: {
|
|
2222
|
+
readonly value: {
|
|
2223
|
+
readonly type: "integer";
|
|
2224
|
+
readonly description: "Vote value: -1 (down), 1 (up), or 2 (double up).";
|
|
2225
|
+
readonly example: 1;
|
|
2226
|
+
readonly enum: readonly [-1, 1, 2];
|
|
2227
|
+
};
|
|
2228
|
+
};
|
|
2229
|
+
readonly required: readonly ["value"];
|
|
2230
|
+
readonly additionalProperties: false;
|
|
2231
|
+
};
|
|
2232
|
+
export declare const TicketAttachmentSchema: {
|
|
2233
|
+
readonly type: "object";
|
|
2234
|
+
readonly properties: {
|
|
2235
|
+
readonly id: {
|
|
2236
|
+
readonly type: "string";
|
|
2237
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2238
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2239
|
+
};
|
|
2240
|
+
readonly filename: {
|
|
2241
|
+
readonly type: "string";
|
|
2242
|
+
readonly description: "Original filename as uploaded.";
|
|
2243
|
+
readonly example: "debug.log";
|
|
2244
|
+
};
|
|
2245
|
+
readonly content_type: {
|
|
2246
|
+
readonly type: "string";
|
|
2247
|
+
readonly description: "MIME content type of the attachment.";
|
|
2248
|
+
readonly example: "text/plain";
|
|
2249
|
+
};
|
|
2250
|
+
readonly size: {
|
|
2251
|
+
readonly type: "integer";
|
|
2252
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2253
|
+
readonly example: 12345;
|
|
2254
|
+
};
|
|
2255
|
+
};
|
|
2256
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2257
|
+
readonly additionalProperties: false;
|
|
2258
|
+
};
|
|
2259
|
+
export declare const TicketCreateInputSchema: {
|
|
2260
|
+
readonly type: "object";
|
|
2261
|
+
readonly properties: {
|
|
2262
|
+
readonly category: {
|
|
2263
|
+
readonly type: "string";
|
|
2264
|
+
readonly description: "Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.";
|
|
2265
|
+
readonly example: "technical";
|
|
2266
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
2267
|
+
};
|
|
2268
|
+
readonly body: {
|
|
2269
|
+
readonly type: "string";
|
|
2270
|
+
readonly maxLength: 50000;
|
|
2271
|
+
readonly minLength: 1;
|
|
2272
|
+
readonly pattern: "\\S";
|
|
2273
|
+
readonly description: "Initial message body in markdown. There is no separate subject — the first message body is the description.";
|
|
2274
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2275
|
+
};
|
|
2276
|
+
readonly properties: {
|
|
2277
|
+
readonly type: "object";
|
|
2278
|
+
readonly additionalProperties: true;
|
|
2279
|
+
readonly description: "Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).";
|
|
2280
|
+
readonly example: {
|
|
2281
|
+
readonly subcategory: "cluster-question";
|
|
2282
|
+
readonly cluster_id: "60c72b2f9f1b2c001f8e4d3a";
|
|
2283
|
+
};
|
|
2284
|
+
};
|
|
2285
|
+
readonly grant_support_access: {
|
|
2286
|
+
readonly type: "boolean";
|
|
2287
|
+
readonly description: "Grant Cloudfleet support staff access to the organization's resources while the ticket is open. Access cannot be revoked; it ends when the ticket is closed.";
|
|
2288
|
+
readonly example: true;
|
|
2289
|
+
};
|
|
2290
|
+
};
|
|
2291
|
+
readonly required: readonly ["category", "body"];
|
|
2292
|
+
readonly additionalProperties: false;
|
|
2293
|
+
};
|
|
2294
|
+
export declare const TicketMessageInputSchema: {
|
|
2295
|
+
readonly type: "object";
|
|
2296
|
+
readonly properties: {
|
|
2297
|
+
readonly body: {
|
|
2298
|
+
readonly type: "string";
|
|
2299
|
+
readonly maxLength: 50000;
|
|
2300
|
+
readonly minLength: 1;
|
|
2301
|
+
readonly pattern: "\\S";
|
|
2302
|
+
readonly description: "Reply body in markdown.";
|
|
2303
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2304
|
+
};
|
|
2305
|
+
};
|
|
2306
|
+
readonly required: readonly ["body"];
|
|
2307
|
+
readonly additionalProperties: false;
|
|
2308
|
+
};
|
|
2309
|
+
export declare const TicketMessageSchema: {
|
|
2310
|
+
readonly type: "object";
|
|
2311
|
+
readonly properties: {
|
|
2312
|
+
readonly id: {
|
|
2313
|
+
readonly type: "string";
|
|
2314
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2315
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2316
|
+
};
|
|
2317
|
+
readonly type: {
|
|
2318
|
+
readonly type: "string";
|
|
2319
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2320
|
+
readonly example: "customer_reply";
|
|
2321
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2322
|
+
};
|
|
2323
|
+
readonly body: {
|
|
2324
|
+
readonly type: "string";
|
|
2325
|
+
readonly description: "Message body in markdown.";
|
|
2326
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2327
|
+
};
|
|
2328
|
+
readonly author_first_name: {
|
|
2329
|
+
readonly type: "string";
|
|
2330
|
+
readonly nullable: true;
|
|
2331
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2332
|
+
readonly example: "Jane";
|
|
2333
|
+
};
|
|
2334
|
+
readonly author_last_name: {
|
|
2335
|
+
readonly type: "string";
|
|
2336
|
+
readonly nullable: true;
|
|
2337
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2338
|
+
readonly example: "Doe";
|
|
2339
|
+
};
|
|
2340
|
+
readonly attachments: {
|
|
2341
|
+
readonly type: "array";
|
|
2342
|
+
readonly items: {
|
|
2343
|
+
readonly type: "object";
|
|
2344
|
+
readonly properties: {
|
|
2345
|
+
readonly id: {
|
|
2346
|
+
readonly type: "string";
|
|
2347
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2348
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2349
|
+
};
|
|
2350
|
+
readonly filename: {
|
|
2351
|
+
readonly type: "string";
|
|
2352
|
+
readonly description: "Original filename as uploaded.";
|
|
2353
|
+
readonly example: "debug.log";
|
|
2354
|
+
};
|
|
2355
|
+
readonly content_type: {
|
|
2356
|
+
readonly type: "string";
|
|
2357
|
+
readonly description: "MIME content type of the attachment.";
|
|
2358
|
+
readonly example: "text/plain";
|
|
2359
|
+
};
|
|
2360
|
+
readonly size: {
|
|
2361
|
+
readonly type: "integer";
|
|
2362
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2363
|
+
readonly example: 12345;
|
|
2364
|
+
};
|
|
2365
|
+
};
|
|
2366
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2367
|
+
readonly additionalProperties: false;
|
|
2368
|
+
};
|
|
2369
|
+
readonly description: "Attachments associated with this message.";
|
|
2370
|
+
readonly example: readonly [];
|
|
2371
|
+
};
|
|
2372
|
+
readonly date_created: {
|
|
2373
|
+
readonly type: "string";
|
|
2374
|
+
readonly format: "date-time";
|
|
2375
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2376
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2377
|
+
};
|
|
2378
|
+
};
|
|
2379
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2380
|
+
readonly additionalProperties: false;
|
|
2381
|
+
};
|
|
2382
|
+
export declare const TicketSchema: {
|
|
2383
|
+
readonly type: "object";
|
|
2384
|
+
readonly properties: {
|
|
2385
|
+
readonly id: {
|
|
2386
|
+
readonly type: "string";
|
|
2387
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
2388
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
2389
|
+
};
|
|
2390
|
+
readonly status: {
|
|
2391
|
+
readonly type: "string";
|
|
2392
|
+
readonly description: "Current state of the ticket.";
|
|
2393
|
+
readonly example: "waiting_on_us";
|
|
2394
|
+
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
2395
|
+
};
|
|
2396
|
+
readonly category: {
|
|
2397
|
+
readonly type: "string";
|
|
2398
|
+
readonly description: "Ticket category.";
|
|
2399
|
+
readonly example: "technical";
|
|
2400
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
2401
|
+
};
|
|
2402
|
+
readonly summary: {
|
|
2403
|
+
readonly type: "string";
|
|
2404
|
+
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
2405
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2406
|
+
};
|
|
2407
|
+
readonly support_access_granted: {
|
|
2408
|
+
readonly type: "boolean";
|
|
2409
|
+
readonly description: "Whether Cloudfleet support staff currently have access to the organization's resources. True once access is granted and until the ticket is closed.";
|
|
2410
|
+
readonly example: true;
|
|
2411
|
+
};
|
|
2412
|
+
readonly support_access_granted_at: {
|
|
2413
|
+
readonly type: "string";
|
|
2414
|
+
readonly format: "date-time";
|
|
2415
|
+
readonly nullable: true;
|
|
2416
|
+
readonly description: "When support access was granted. Null if it never was. Kept after the ticket is closed.";
|
|
2417
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2418
|
+
};
|
|
2419
|
+
readonly closed_at: {
|
|
2420
|
+
readonly type: "string";
|
|
2421
|
+
readonly format: "date-time";
|
|
2422
|
+
readonly nullable: true;
|
|
2423
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
2424
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
2425
|
+
};
|
|
2426
|
+
readonly date_created: {
|
|
2427
|
+
readonly type: "string";
|
|
2428
|
+
readonly format: "date-time";
|
|
2429
|
+
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
2430
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2431
|
+
};
|
|
2432
|
+
readonly date_updated: {
|
|
2433
|
+
readonly type: "string";
|
|
2434
|
+
readonly format: "date-time";
|
|
2435
|
+
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
2436
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2437
|
+
};
|
|
2438
|
+
readonly messages: {
|
|
2439
|
+
readonly type: "array";
|
|
2440
|
+
readonly items: {
|
|
2441
|
+
readonly type: "object";
|
|
2442
|
+
readonly properties: {
|
|
2443
|
+
readonly id: {
|
|
2444
|
+
readonly type: "string";
|
|
2445
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2446
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2447
|
+
};
|
|
2448
|
+
readonly type: {
|
|
2449
|
+
readonly type: "string";
|
|
2450
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2451
|
+
readonly example: "customer_reply";
|
|
2452
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2453
|
+
};
|
|
2454
|
+
readonly body: {
|
|
2455
|
+
readonly type: "string";
|
|
2456
|
+
readonly description: "Message body in markdown.";
|
|
2457
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2458
|
+
};
|
|
2459
|
+
readonly author_first_name: {
|
|
2460
|
+
readonly type: "string";
|
|
2461
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2462
|
+
readonly example: "Jane";
|
|
2463
|
+
};
|
|
2464
|
+
readonly author_last_name: {
|
|
2465
|
+
readonly type: "string";
|
|
2466
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2467
|
+
readonly example: "Doe";
|
|
2468
|
+
};
|
|
2469
|
+
readonly attachments: {
|
|
2470
|
+
readonly type: "array";
|
|
2471
|
+
readonly items: {
|
|
2472
|
+
readonly type: "object";
|
|
2473
|
+
readonly properties: {
|
|
2474
|
+
readonly id: {
|
|
2475
|
+
readonly type: "string";
|
|
2476
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2477
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2478
|
+
};
|
|
2479
|
+
readonly filename: {
|
|
2480
|
+
readonly type: "string";
|
|
2481
|
+
readonly description: "Original filename as uploaded.";
|
|
2482
|
+
readonly example: "debug.log";
|
|
2483
|
+
};
|
|
2484
|
+
readonly content_type: {
|
|
2485
|
+
readonly type: "string";
|
|
2486
|
+
readonly description: "MIME content type of the attachment.";
|
|
2487
|
+
readonly example: "text/plain";
|
|
2488
|
+
};
|
|
2489
|
+
readonly size: {
|
|
2490
|
+
readonly type: "integer";
|
|
2491
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2492
|
+
readonly example: 12345;
|
|
2493
|
+
};
|
|
2494
|
+
};
|
|
2495
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2496
|
+
readonly additionalProperties: false;
|
|
2497
|
+
};
|
|
2498
|
+
readonly description: "Attachments associated with this message.";
|
|
2499
|
+
readonly example: readonly [];
|
|
2500
|
+
};
|
|
2501
|
+
readonly date_created: {
|
|
2502
|
+
readonly type: "string";
|
|
2503
|
+
readonly format: "date-time";
|
|
2504
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2505
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2506
|
+
};
|
|
2507
|
+
};
|
|
2508
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2509
|
+
readonly additionalProperties: false;
|
|
2510
|
+
};
|
|
2511
|
+
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
2512
|
+
};
|
|
2513
|
+
};
|
|
2514
|
+
readonly required: readonly ["id", "status", "category", "summary", "support_access_granted", "support_access_granted_at", "date_created", "date_updated"];
|
|
1315
2515
|
readonly additionalProperties: false;
|
|
1316
2516
|
};
|
|
1317
2517
|
export declare const TokenCreateInputSchema: {
|
|
@@ -1407,9 +2607,10 @@ export declare const UsageFacetsSchema: {
|
|
|
1407
2607
|
readonly type: "array";
|
|
1408
2608
|
readonly items: {
|
|
1409
2609
|
readonly type: "string";
|
|
2610
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
1410
2611
|
};
|
|
1411
2612
|
readonly description: "List of unique products";
|
|
1412
|
-
readonly example: readonly ["
|
|
2613
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
1413
2614
|
};
|
|
1414
2615
|
};
|
|
1415
2616
|
readonly additionalProperties: false;
|
|
@@ -1435,7 +2636,8 @@ export declare const UsageResponseSchema: {
|
|
|
1435
2636
|
readonly product: {
|
|
1436
2637
|
readonly type: "string";
|
|
1437
2638
|
readonly description: "The product the usage is associated with";
|
|
1438
|
-
readonly example: "
|
|
2639
|
+
readonly example: "cfke_controlplane_pro";
|
|
2640
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
1439
2641
|
};
|
|
1440
2642
|
readonly value: {
|
|
1441
2643
|
readonly type: "number";
|
|
@@ -1475,9 +2677,10 @@ export declare const UsageResponseSchema: {
|
|
|
1475
2677
|
readonly type: "array";
|
|
1476
2678
|
readonly items: {
|
|
1477
2679
|
readonly type: "string";
|
|
2680
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
1478
2681
|
};
|
|
1479
2682
|
readonly description: "List of unique products";
|
|
1480
|
-
readonly example: readonly ["
|
|
2683
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
1481
2684
|
};
|
|
1482
2685
|
};
|
|
1483
2686
|
readonly additionalProperties: false;
|
|
@@ -1503,7 +2706,8 @@ export declare const UsageSchema: {
|
|
|
1503
2706
|
readonly product: {
|
|
1504
2707
|
readonly type: "string";
|
|
1505
2708
|
readonly description: "The product the usage is associated with";
|
|
1506
|
-
readonly example: "
|
|
2709
|
+
readonly example: "cfke_controlplane_pro";
|
|
2710
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
1507
2711
|
};
|
|
1508
2712
|
readonly value: {
|
|
1509
2713
|
readonly type: "number";
|
|
@@ -1560,18 +2764,6 @@ export declare const UserCreateInputSchema: {
|
|
|
1560
2764
|
readonly minLength: 8;
|
|
1561
2765
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
1562
2766
|
};
|
|
1563
|
-
readonly status: {
|
|
1564
|
-
readonly type: "string";
|
|
1565
|
-
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
1566
|
-
readonly example: "active";
|
|
1567
|
-
readonly enum: readonly ["active", "inactive"];
|
|
1568
|
-
};
|
|
1569
|
-
readonly role: {
|
|
1570
|
-
readonly type: "string";
|
|
1571
|
-
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
1572
|
-
readonly example: "User";
|
|
1573
|
-
readonly enum: readonly ["Administrator", "User"];
|
|
1574
|
-
};
|
|
1575
2767
|
};
|
|
1576
2768
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
1577
2769
|
readonly additionalProperties: false;
|