@cloudfleet/sdk 0.0.1-32a25f1 → 0.0.1-35f1713
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 +1054 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1215 -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 +1014 -121
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +2404 -196
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +264 -186
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +376 -359
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +8 -8
- package/dist/types.gen.d.ts +1494 -688
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3462 -1414
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1389 -624
- package/dist/zod.gen.js.map +1 -1
- package/package.json +28 -8
package/dist/schemas.gen.d.ts
CHANGED
|
@@ -1,6 +1,49 @@
|
|
|
1
|
+
export declare const BasicPriceConsentInputSchema: {
|
|
2
|
+
readonly type: "object";
|
|
3
|
+
readonly properties: {
|
|
4
|
+
readonly decision: {
|
|
5
|
+
readonly type: "string";
|
|
6
|
+
readonly description: "The administrator's decision on the new Basic price. `accepted` continues to paid billing when the signup credit runs out; `rejected` opts out (clusters are suspended, never charged). A `rejected` org can later be flipped back to `accepted`.";
|
|
7
|
+
readonly example: "accepted";
|
|
8
|
+
readonly enum: readonly ["accepted", "rejected"];
|
|
9
|
+
};
|
|
10
|
+
};
|
|
11
|
+
readonly required: readonly ["decision"];
|
|
12
|
+
readonly additionalProperties: false;
|
|
13
|
+
};
|
|
14
|
+
export declare const BasicPriceConsentSchema: {
|
|
15
|
+
readonly type: "object";
|
|
16
|
+
readonly properties: {
|
|
17
|
+
readonly status: {
|
|
18
|
+
readonly type: "string";
|
|
19
|
+
readonly description: "Consent status for the new Basic price. `not_applicable` when the organization is not in scope for the migration. `pending` when the organization must opt in but no admin has decided yet. `accepted` / `rejected` reflect the recorded decision.";
|
|
20
|
+
readonly example: "pending";
|
|
21
|
+
readonly enum: readonly ["not_applicable", "pending", "accepted", "rejected"];
|
|
22
|
+
};
|
|
23
|
+
readonly decided_at: {
|
|
24
|
+
readonly type: "string";
|
|
25
|
+
readonly format: "date-time";
|
|
26
|
+
readonly description: "When the current decision was recorded. Absent while `not_applicable` or `pending`.";
|
|
27
|
+
readonly example: "2026-09-05T10:12:00.000Z";
|
|
28
|
+
};
|
|
29
|
+
readonly decided_by: {
|
|
30
|
+
readonly type: "string";
|
|
31
|
+
readonly description: "User id of the administrator who recorded the current decision. Absent while `not_applicable` or `pending`.";
|
|
32
|
+
readonly example: "2b7a5c9e-1f4d-4a1b-9c3e-8d2f6a0b1c2d";
|
|
33
|
+
};
|
|
34
|
+
};
|
|
35
|
+
readonly required: readonly ["status"];
|
|
36
|
+
readonly additionalProperties: false;
|
|
37
|
+
};
|
|
1
38
|
export declare const BillingContactSchema: {
|
|
2
39
|
readonly type: "object";
|
|
3
40
|
readonly properties: {
|
|
41
|
+
readonly type: {
|
|
42
|
+
readonly type: "string";
|
|
43
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
44
|
+
readonly example: "business";
|
|
45
|
+
readonly enum: readonly ["business", "personal"];
|
|
46
|
+
};
|
|
4
47
|
readonly company: {
|
|
5
48
|
readonly type: "string";
|
|
6
49
|
readonly maxLength: 120;
|
|
@@ -76,7 +119,7 @@ export declare const BillingContactSchema: {
|
|
|
76
119
|
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", ""];
|
|
77
120
|
};
|
|
78
121
|
};
|
|
79
|
-
readonly required: readonly ["email", "individual_name"];
|
|
122
|
+
readonly required: readonly ["type", "email", "individual_name"];
|
|
80
123
|
readonly additionalProperties: false;
|
|
81
124
|
};
|
|
82
125
|
export declare const BillingCreditsSchema: {
|
|
@@ -211,9 +254,8 @@ export declare const ChartSchema: {
|
|
|
211
254
|
};
|
|
212
255
|
readonly status: {
|
|
213
256
|
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"];
|
|
257
|
+
readonly description: "Status of the chart deployment (Flux HelmRelease Ready condition reason, e.g. InstallSucceeded, UpgradeFailed, Progressing).";
|
|
258
|
+
readonly example: "InstallSucceeded";
|
|
217
259
|
};
|
|
218
260
|
readonly version_current: {
|
|
219
261
|
readonly type: "string";
|
|
@@ -270,26 +312,103 @@ export declare const ClusterCreateInputSchema: {
|
|
|
270
312
|
readonly tier: {
|
|
271
313
|
readonly type: "string";
|
|
272
314
|
readonly description: "Tier of the cluster.";
|
|
315
|
+
readonly default: "basic";
|
|
273
316
|
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"];
|
|
317
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
282
318
|
};
|
|
283
319
|
readonly version_channel: {
|
|
284
320
|
readonly type: "string";
|
|
285
321
|
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
322
|
readonly description: "Version of the kubernetes cluster.";
|
|
287
323
|
readonly default: "1.x.x-cfke.x";
|
|
288
|
-
readonly example: "1.
|
|
324
|
+
readonly example: "1.x.x-cfke.x";
|
|
325
|
+
};
|
|
326
|
+
readonly release_channel: {
|
|
327
|
+
readonly type: "string";
|
|
328
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
329
|
+
readonly default: "rapid";
|
|
330
|
+
readonly example: "rapid";
|
|
331
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
332
|
+
};
|
|
333
|
+
readonly features: {
|
|
334
|
+
readonly type: "object";
|
|
335
|
+
readonly properties: {
|
|
336
|
+
readonly gpu_sharing_strategy: {
|
|
337
|
+
readonly type: "string";
|
|
338
|
+
readonly description: "GPU sharing strategy.";
|
|
339
|
+
readonly default: "none";
|
|
340
|
+
readonly example: "none";
|
|
341
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
342
|
+
};
|
|
343
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
344
|
+
readonly type: "integer";
|
|
345
|
+
readonly minimum: 2;
|
|
346
|
+
readonly maximum: 48;
|
|
347
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
348
|
+
readonly default: 4;
|
|
349
|
+
readonly example: 10;
|
|
350
|
+
};
|
|
351
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
352
|
+
readonly type: "boolean";
|
|
353
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
354
|
+
readonly example: false;
|
|
355
|
+
};
|
|
356
|
+
};
|
|
357
|
+
readonly additionalProperties: false;
|
|
358
|
+
readonly description: "Cluster feature toggles.";
|
|
359
|
+
readonly default: {
|
|
360
|
+
readonly gpu_sharing_strategy: "none";
|
|
361
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
362
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
363
|
+
};
|
|
364
|
+
};
|
|
365
|
+
readonly region: {
|
|
366
|
+
readonly type: "string";
|
|
367
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
368
|
+
readonly example: "europe-central-1a";
|
|
369
|
+
};
|
|
370
|
+
readonly networking: {
|
|
371
|
+
readonly type: "object";
|
|
372
|
+
readonly properties: {
|
|
373
|
+
readonly pod_cidr: {
|
|
374
|
+
readonly type: "string";
|
|
375
|
+
readonly description: "CIDR block for pod IPs.";
|
|
376
|
+
readonly default: "10.244.0.0/16";
|
|
377
|
+
};
|
|
378
|
+
readonly service_cidr: {
|
|
379
|
+
readonly type: "string";
|
|
380
|
+
readonly description: "CIDR block for service IPs.";
|
|
381
|
+
readonly default: "10.96.0.0/12";
|
|
382
|
+
};
|
|
383
|
+
readonly dual_stack: {
|
|
384
|
+
readonly type: "boolean";
|
|
385
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
386
|
+
};
|
|
387
|
+
readonly pod_cidr_v6: {
|
|
388
|
+
readonly type: "string";
|
|
389
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
390
|
+
readonly default: "2001:db8:1:2::/48";
|
|
391
|
+
};
|
|
392
|
+
readonly service_cidr_v6: {
|
|
393
|
+
readonly type: "string";
|
|
394
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
395
|
+
readonly default: "2001:db8:1:1::/112";
|
|
396
|
+
};
|
|
397
|
+
};
|
|
398
|
+
readonly additionalProperties: false;
|
|
399
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
400
|
+
readonly default: {
|
|
401
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
402
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
403
|
+
readonly dual_stack: false;
|
|
404
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
405
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
406
|
+
};
|
|
289
407
|
};
|
|
290
408
|
};
|
|
291
|
-
readonly required: readonly ["name", "
|
|
409
|
+
readonly required: readonly ["name", "region"];
|
|
292
410
|
readonly additionalProperties: false;
|
|
411
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
293
412
|
};
|
|
294
413
|
export declare const ClusterJoinInformationSchema: {
|
|
295
414
|
readonly type: "object";
|
|
@@ -305,11 +424,26 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
305
424
|
readonly description: "Internal URL of the Kubernetes cluster control plane. This is the endpoint that kubelet uses to connect to the cluster.";
|
|
306
425
|
readonly example: "https://10.31.64.7:6443";
|
|
307
426
|
};
|
|
427
|
+
readonly cluster_dns: {
|
|
428
|
+
readonly type: "string";
|
|
429
|
+
readonly description: "Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.";
|
|
430
|
+
readonly example: "10.96.0.10";
|
|
431
|
+
};
|
|
432
|
+
readonly pod_cidr: {
|
|
433
|
+
readonly type: "string";
|
|
434
|
+
readonly description: "Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.";
|
|
435
|
+
readonly example: "10.244.0.0/16";
|
|
436
|
+
};
|
|
308
437
|
readonly auth_key: {
|
|
309
438
|
readonly type: "string";
|
|
310
439
|
readonly description: "Authentication key for the cluster.";
|
|
311
440
|
readonly example: "tskey-auth-kBV8wr1dk911CNTRL-...";
|
|
312
441
|
};
|
|
442
|
+
readonly login_server: {
|
|
443
|
+
readonly type: "string";
|
|
444
|
+
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.";
|
|
445
|
+
readonly example: "https://415026b6-f00f-44f8-968d-fc6ef4d0fc6d.fabric.europe-central-1a.cfke.io";
|
|
446
|
+
};
|
|
313
447
|
readonly bootstrap_token: {
|
|
314
448
|
readonly type: "string";
|
|
315
449
|
readonly description: "Bootstrap token for the cluster.";
|
|
@@ -367,7 +501,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
367
501
|
readonly description: "OIDC Information for hosts to access to third party API's.";
|
|
368
502
|
};
|
|
369
503
|
};
|
|
370
|
-
readonly required: readonly ["certificate_authority", "endpoint", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
504
|
+
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "pod_cidr", "auth_key", "login_server", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
371
505
|
readonly additionalProperties: false;
|
|
372
506
|
};
|
|
373
507
|
export declare const ClusterSchema: {
|
|
@@ -384,22 +518,100 @@ export declare const ClusterSchema: {
|
|
|
384
518
|
readonly tier: {
|
|
385
519
|
readonly type: "string";
|
|
386
520
|
readonly description: "Tier of the cluster.";
|
|
521
|
+
readonly default: "basic";
|
|
387
522
|
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"];
|
|
523
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
396
524
|
};
|
|
397
525
|
readonly version_channel: {
|
|
398
526
|
readonly type: "string";
|
|
399
527
|
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
528
|
readonly description: "Version of the kubernetes cluster.";
|
|
401
529
|
readonly default: "1.x.x-cfke.x";
|
|
402
|
-
readonly example: "1.
|
|
530
|
+
readonly example: "1.x.x-cfke.x";
|
|
531
|
+
};
|
|
532
|
+
readonly release_channel: {
|
|
533
|
+
readonly type: "string";
|
|
534
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
535
|
+
readonly default: "rapid";
|
|
536
|
+
readonly example: "rapid";
|
|
537
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
538
|
+
};
|
|
539
|
+
readonly features: {
|
|
540
|
+
readonly type: "object";
|
|
541
|
+
readonly properties: {
|
|
542
|
+
readonly gpu_sharing_strategy: {
|
|
543
|
+
readonly type: "string";
|
|
544
|
+
readonly description: "GPU sharing strategy.";
|
|
545
|
+
readonly default: "none";
|
|
546
|
+
readonly example: "none";
|
|
547
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
548
|
+
};
|
|
549
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
550
|
+
readonly type: "integer";
|
|
551
|
+
readonly minimum: 2;
|
|
552
|
+
readonly maximum: 48;
|
|
553
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
554
|
+
readonly default: 4;
|
|
555
|
+
readonly example: 10;
|
|
556
|
+
};
|
|
557
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
558
|
+
readonly type: "boolean";
|
|
559
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
560
|
+
readonly example: false;
|
|
561
|
+
};
|
|
562
|
+
};
|
|
563
|
+
readonly required: readonly ["gpu_sharing_strategy", "gpu_max_shared_clients_per_gpu", "cilium_socket_lb_host_namespace_only"];
|
|
564
|
+
readonly additionalProperties: false;
|
|
565
|
+
readonly description: "Cluster feature toggles.";
|
|
566
|
+
readonly default: {
|
|
567
|
+
readonly gpu_sharing_strategy: "none";
|
|
568
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
569
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
570
|
+
};
|
|
571
|
+
};
|
|
572
|
+
readonly region: {
|
|
573
|
+
readonly type: "string";
|
|
574
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
575
|
+
readonly example: "europe-central-1a";
|
|
576
|
+
};
|
|
577
|
+
readonly networking: {
|
|
578
|
+
readonly type: "object";
|
|
579
|
+
readonly properties: {
|
|
580
|
+
readonly pod_cidr: {
|
|
581
|
+
readonly type: "string";
|
|
582
|
+
readonly description: "CIDR block for pod IPs.";
|
|
583
|
+
readonly default: "10.244.0.0/16";
|
|
584
|
+
};
|
|
585
|
+
readonly service_cidr: {
|
|
586
|
+
readonly type: "string";
|
|
587
|
+
readonly description: "CIDR block for service IPs.";
|
|
588
|
+
readonly default: "10.96.0.0/12";
|
|
589
|
+
};
|
|
590
|
+
readonly dual_stack: {
|
|
591
|
+
readonly type: "boolean";
|
|
592
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
593
|
+
};
|
|
594
|
+
readonly pod_cidr_v6: {
|
|
595
|
+
readonly type: "string";
|
|
596
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
597
|
+
readonly default: "2001:db8:1:2::/48";
|
|
598
|
+
};
|
|
599
|
+
readonly service_cidr_v6: {
|
|
600
|
+
readonly type: "string";
|
|
601
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
602
|
+
readonly default: "2001:db8:1:1::/112";
|
|
603
|
+
};
|
|
604
|
+
};
|
|
605
|
+
readonly required: readonly ["pod_cidr", "service_cidr", "dual_stack", "pod_cidr_v6", "service_cidr_v6"];
|
|
606
|
+
readonly additionalProperties: false;
|
|
607
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
608
|
+
readonly default: {
|
|
609
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
610
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
611
|
+
readonly dual_stack: false;
|
|
612
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
613
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
614
|
+
};
|
|
403
615
|
};
|
|
404
616
|
readonly id: {
|
|
405
617
|
readonly type: "string";
|
|
@@ -409,16 +621,27 @@ export declare const ClusterSchema: {
|
|
|
409
621
|
};
|
|
410
622
|
readonly status: {
|
|
411
623
|
readonly type: "string";
|
|
412
|
-
readonly description: "Status of the cluster.
|
|
413
|
-
readonly example: "
|
|
414
|
-
readonly enum: readonly ["
|
|
624
|
+
readonly description: "Status of the cluster.";
|
|
625
|
+
readonly example: "deployed";
|
|
626
|
+
readonly enum: readonly ["creating", "deployed", "updating", "disabled"];
|
|
415
627
|
};
|
|
416
628
|
readonly endpoint: {
|
|
417
629
|
readonly anyOf: readonly [{
|
|
418
630
|
readonly type: "string";
|
|
419
631
|
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.
|
|
632
|
+
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.";
|
|
633
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
634
|
+
}, {
|
|
635
|
+
readonly type: "string";
|
|
636
|
+
readonly enum: readonly [""];
|
|
637
|
+
}];
|
|
638
|
+
};
|
|
639
|
+
readonly endpoint_public: {
|
|
640
|
+
readonly anyOf: readonly [{
|
|
641
|
+
readonly type: "string";
|
|
642
|
+
readonly format: "uri";
|
|
643
|
+
readonly description: "Deprecated alias of `endpoint`; retained for backward compatibility.";
|
|
644
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
422
645
|
}, {
|
|
423
646
|
readonly type: "string";
|
|
424
647
|
readonly enum: readonly [""];
|
|
@@ -450,8 +673,9 @@ export declare const ClusterSchema: {
|
|
|
450
673
|
readonly example: true;
|
|
451
674
|
};
|
|
452
675
|
};
|
|
453
|
-
readonly required: readonly ["name", "tier", "id", "status"];
|
|
676
|
+
readonly required: readonly ["name", "tier", "version_channel", "release_channel", "features", "region", "networking", "id", "status", "ready"];
|
|
454
677
|
readonly additionalProperties: false;
|
|
678
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
455
679
|
};
|
|
456
680
|
export declare const ClusterUpdateInputSchema: {
|
|
457
681
|
readonly type: "object";
|
|
@@ -467,18 +691,60 @@ export declare const ClusterUpdateInputSchema: {
|
|
|
467
691
|
readonly tier: {
|
|
468
692
|
readonly type: "string";
|
|
469
693
|
readonly description: "Tier of the cluster.";
|
|
694
|
+
readonly default: "basic";
|
|
470
695
|
readonly example: "pro";
|
|
471
|
-
readonly enum: readonly ["basic", "pro"];
|
|
696
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
472
697
|
};
|
|
473
698
|
readonly version_channel: {
|
|
474
699
|
readonly type: "string";
|
|
475
700
|
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
701
|
readonly description: "Version of the kubernetes cluster.";
|
|
477
|
-
readonly
|
|
702
|
+
readonly default: "1.x.x-cfke.x";
|
|
703
|
+
readonly example: "1.x.x-cfke.x";
|
|
704
|
+
};
|
|
705
|
+
readonly release_channel: {
|
|
706
|
+
readonly type: "string";
|
|
707
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
708
|
+
readonly default: "rapid";
|
|
709
|
+
readonly example: "rapid";
|
|
710
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
711
|
+
};
|
|
712
|
+
readonly features: {
|
|
713
|
+
readonly type: "object";
|
|
714
|
+
readonly properties: {
|
|
715
|
+
readonly gpu_sharing_strategy: {
|
|
716
|
+
readonly type: "string";
|
|
717
|
+
readonly description: "GPU sharing strategy.";
|
|
718
|
+
readonly default: "none";
|
|
719
|
+
readonly example: "none";
|
|
720
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
721
|
+
};
|
|
722
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
723
|
+
readonly type: "integer";
|
|
724
|
+
readonly minimum: 2;
|
|
725
|
+
readonly maximum: 48;
|
|
726
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
727
|
+
readonly default: 4;
|
|
728
|
+
readonly example: 10;
|
|
729
|
+
};
|
|
730
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
731
|
+
readonly type: "boolean";
|
|
732
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
733
|
+
readonly example: false;
|
|
734
|
+
};
|
|
735
|
+
};
|
|
736
|
+
readonly additionalProperties: false;
|
|
737
|
+
readonly description: "Cluster feature toggles.";
|
|
738
|
+
readonly default: {
|
|
739
|
+
readonly gpu_sharing_strategy: "none";
|
|
740
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
741
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
742
|
+
};
|
|
478
743
|
};
|
|
479
744
|
};
|
|
480
|
-
readonly required: readonly ["
|
|
745
|
+
readonly required: readonly ["name"];
|
|
481
746
|
readonly additionalProperties: false;
|
|
747
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
482
748
|
};
|
|
483
749
|
export declare const FleetCreateInputSchema: {
|
|
484
750
|
readonly type: "object";
|
|
@@ -487,13 +753,12 @@ export declare const FleetCreateInputSchema: {
|
|
|
487
753
|
readonly type: "object";
|
|
488
754
|
readonly properties: {
|
|
489
755
|
readonly cpu: {
|
|
490
|
-
readonly type: "
|
|
491
|
-
readonly format: "float";
|
|
756
|
+
readonly type: "integer";
|
|
492
757
|
readonly minimum: 0;
|
|
493
|
-
readonly
|
|
758
|
+
readonly maximum: 100000;
|
|
759
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
494
760
|
};
|
|
495
761
|
};
|
|
496
|
-
readonly required: readonly ["cpu"];
|
|
497
762
|
readonly additionalProperties: false;
|
|
498
763
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
499
764
|
};
|
|
@@ -502,14 +767,15 @@ export declare const FleetCreateInputSchema: {
|
|
|
502
767
|
readonly properties: {
|
|
503
768
|
readonly enabled: {
|
|
504
769
|
readonly type: "boolean";
|
|
505
|
-
readonly default: true;
|
|
506
770
|
};
|
|
507
771
|
readonly project: {
|
|
508
772
|
readonly type: "string";
|
|
509
|
-
readonly
|
|
773
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
774
|
+
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.";
|
|
775
|
+
readonly example: "my-cloudfleet-project";
|
|
510
776
|
};
|
|
511
777
|
};
|
|
512
|
-
readonly required: readonly ["
|
|
778
|
+
readonly required: readonly ["enabled"];
|
|
513
779
|
readonly additionalProperties: false;
|
|
514
780
|
};
|
|
515
781
|
readonly hetzner: {
|
|
@@ -517,14 +783,16 @@ export declare const FleetCreateInputSchema: {
|
|
|
517
783
|
readonly properties: {
|
|
518
784
|
readonly enabled: {
|
|
519
785
|
readonly type: "boolean";
|
|
520
|
-
readonly default: true;
|
|
521
786
|
};
|
|
522
787
|
readonly apiKey: {
|
|
523
788
|
readonly type: "string";
|
|
524
|
-
readonly
|
|
789
|
+
readonly maxLength: 64;
|
|
790
|
+
readonly minLength: 64;
|
|
791
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
792
|
+
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
793
|
};
|
|
526
794
|
};
|
|
527
|
-
readonly required: readonly ["
|
|
795
|
+
readonly required: readonly ["enabled"];
|
|
528
796
|
readonly additionalProperties: false;
|
|
529
797
|
};
|
|
530
798
|
readonly aws: {
|
|
@@ -532,16 +800,75 @@ export declare const FleetCreateInputSchema: {
|
|
|
532
800
|
readonly properties: {
|
|
533
801
|
readonly enabled: {
|
|
534
802
|
readonly type: "boolean";
|
|
535
|
-
readonly default: true;
|
|
536
803
|
};
|
|
537
804
|
readonly controllerRoleArn: {
|
|
538
805
|
readonly type: "string";
|
|
539
|
-
readonly
|
|
806
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
807
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
808
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
540
809
|
};
|
|
541
810
|
};
|
|
542
|
-
readonly required: readonly ["
|
|
811
|
+
readonly required: readonly ["enabled"];
|
|
543
812
|
readonly additionalProperties: false;
|
|
544
813
|
};
|
|
814
|
+
readonly constraints: {
|
|
815
|
+
readonly type: "object";
|
|
816
|
+
readonly properties: {
|
|
817
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
818
|
+
readonly type: "array";
|
|
819
|
+
readonly items: {
|
|
820
|
+
readonly type: "string";
|
|
821
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
822
|
+
};
|
|
823
|
+
readonly minItems: 1;
|
|
824
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
825
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
826
|
+
};
|
|
827
|
+
readonly 'kubernetes.io/arch': {
|
|
828
|
+
readonly type: "array";
|
|
829
|
+
readonly items: {
|
|
830
|
+
readonly type: "string";
|
|
831
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
832
|
+
};
|
|
833
|
+
readonly minItems: 1;
|
|
834
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
835
|
+
readonly default: readonly ["amd64"];
|
|
836
|
+
};
|
|
837
|
+
readonly 'cfke.io/instance-family': {
|
|
838
|
+
readonly type: "array";
|
|
839
|
+
readonly items: {
|
|
840
|
+
readonly type: "string";
|
|
841
|
+
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"];
|
|
842
|
+
};
|
|
843
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
844
|
+
readonly default: readonly [];
|
|
845
|
+
};
|
|
846
|
+
readonly 'topology.kubernetes.io/region': {
|
|
847
|
+
readonly type: "array";
|
|
848
|
+
readonly items: {
|
|
849
|
+
readonly type: "string";
|
|
850
|
+
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"];
|
|
851
|
+
};
|
|
852
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
853
|
+
readonly default: readonly [];
|
|
854
|
+
};
|
|
855
|
+
};
|
|
856
|
+
readonly additionalProperties: false;
|
|
857
|
+
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.";
|
|
858
|
+
readonly default: {
|
|
859
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
860
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
861
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
862
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
863
|
+
};
|
|
864
|
+
};
|
|
865
|
+
readonly scalingProfile: {
|
|
866
|
+
readonly type: "string";
|
|
867
|
+
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`).";
|
|
868
|
+
readonly default: "conservative";
|
|
869
|
+
readonly example: "conservative";
|
|
870
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
871
|
+
};
|
|
545
872
|
readonly id: {
|
|
546
873
|
readonly type: "string";
|
|
547
874
|
readonly maxLength: 63;
|
|
@@ -553,6 +880,7 @@ export declare const FleetCreateInputSchema: {
|
|
|
553
880
|
};
|
|
554
881
|
readonly required: readonly ["id"];
|
|
555
882
|
readonly additionalProperties: false;
|
|
883
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
556
884
|
};
|
|
557
885
|
export declare const FleetSchema: {
|
|
558
886
|
readonly type: "object";
|
|
@@ -561,13 +889,12 @@ export declare const FleetSchema: {
|
|
|
561
889
|
readonly type: "object";
|
|
562
890
|
readonly properties: {
|
|
563
891
|
readonly cpu: {
|
|
564
|
-
readonly type: "
|
|
565
|
-
readonly format: "float";
|
|
892
|
+
readonly type: "integer";
|
|
566
893
|
readonly minimum: 0;
|
|
567
|
-
readonly
|
|
894
|
+
readonly maximum: 100000;
|
|
895
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
568
896
|
};
|
|
569
897
|
};
|
|
570
|
-
readonly required: readonly ["cpu"];
|
|
571
898
|
readonly additionalProperties: false;
|
|
572
899
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
573
900
|
};
|
|
@@ -576,14 +903,15 @@ export declare const FleetSchema: {
|
|
|
576
903
|
readonly properties: {
|
|
577
904
|
readonly enabled: {
|
|
578
905
|
readonly type: "boolean";
|
|
579
|
-
readonly default: true;
|
|
580
906
|
};
|
|
581
907
|
readonly project: {
|
|
582
908
|
readonly type: "string";
|
|
583
|
-
readonly
|
|
909
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
910
|
+
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.";
|
|
911
|
+
readonly example: "my-cloudfleet-project";
|
|
584
912
|
};
|
|
585
913
|
};
|
|
586
|
-
readonly required: readonly ["
|
|
914
|
+
readonly required: readonly ["enabled"];
|
|
587
915
|
readonly additionalProperties: false;
|
|
588
916
|
};
|
|
589
917
|
readonly hetzner: {
|
|
@@ -591,14 +919,14 @@ export declare const FleetSchema: {
|
|
|
591
919
|
readonly properties: {
|
|
592
920
|
readonly enabled: {
|
|
593
921
|
readonly type: "boolean";
|
|
594
|
-
readonly default: true;
|
|
595
922
|
};
|
|
596
923
|
readonly apiKey: {
|
|
597
924
|
readonly type: "string";
|
|
598
|
-
readonly
|
|
925
|
+
readonly pattern: "^\\*{64}$";
|
|
926
|
+
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
927
|
};
|
|
600
928
|
};
|
|
601
|
-
readonly required: readonly ["
|
|
929
|
+
readonly required: readonly ["enabled"];
|
|
602
930
|
readonly additionalProperties: false;
|
|
603
931
|
};
|
|
604
932
|
readonly aws: {
|
|
@@ -606,15 +934,75 @@ export declare const FleetSchema: {
|
|
|
606
934
|
readonly properties: {
|
|
607
935
|
readonly enabled: {
|
|
608
936
|
readonly type: "boolean";
|
|
609
|
-
readonly default: true;
|
|
610
937
|
};
|
|
611
938
|
readonly controllerRoleArn: {
|
|
612
939
|
readonly type: "string";
|
|
613
|
-
readonly
|
|
940
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
941
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
942
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
943
|
+
};
|
|
944
|
+
};
|
|
945
|
+
readonly required: readonly ["enabled"];
|
|
946
|
+
readonly additionalProperties: false;
|
|
947
|
+
};
|
|
948
|
+
readonly constraints: {
|
|
949
|
+
readonly type: "object";
|
|
950
|
+
readonly properties: {
|
|
951
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
952
|
+
readonly type: "array";
|
|
953
|
+
readonly items: {
|
|
954
|
+
readonly type: "string";
|
|
955
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
956
|
+
};
|
|
957
|
+
readonly minItems: 1;
|
|
958
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
959
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
960
|
+
};
|
|
961
|
+
readonly 'kubernetes.io/arch': {
|
|
962
|
+
readonly type: "array";
|
|
963
|
+
readonly items: {
|
|
964
|
+
readonly type: "string";
|
|
965
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
966
|
+
};
|
|
967
|
+
readonly minItems: 1;
|
|
968
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
969
|
+
readonly default: readonly ["amd64"];
|
|
970
|
+
};
|
|
971
|
+
readonly 'cfke.io/instance-family': {
|
|
972
|
+
readonly type: "array";
|
|
973
|
+
readonly items: {
|
|
974
|
+
readonly type: "string";
|
|
975
|
+
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"];
|
|
976
|
+
};
|
|
977
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
978
|
+
readonly default: readonly [];
|
|
979
|
+
};
|
|
980
|
+
readonly 'topology.kubernetes.io/region': {
|
|
981
|
+
readonly type: "array";
|
|
982
|
+
readonly items: {
|
|
983
|
+
readonly type: "string";
|
|
984
|
+
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"];
|
|
985
|
+
};
|
|
986
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
987
|
+
readonly default: readonly [];
|
|
614
988
|
};
|
|
615
989
|
};
|
|
616
|
-
readonly required: readonly ["
|
|
990
|
+
readonly required: readonly ["karpenter.sh/capacity-type", "kubernetes.io/arch"];
|
|
617
991
|
readonly additionalProperties: false;
|
|
992
|
+
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.";
|
|
993
|
+
readonly default: {
|
|
994
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
995
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
996
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
997
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
998
|
+
};
|
|
999
|
+
};
|
|
1000
|
+
readonly scalingProfile: {
|
|
1001
|
+
readonly type: "string";
|
|
1002
|
+
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`).";
|
|
1003
|
+
readonly default: "conservative";
|
|
1004
|
+
readonly example: "conservative";
|
|
1005
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
618
1006
|
};
|
|
619
1007
|
readonly id: {
|
|
620
1008
|
readonly type: "string";
|
|
@@ -624,9 +1012,30 @@ export declare const FleetSchema: {
|
|
|
624
1012
|
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
625
1013
|
readonly example: "new-clouds-fleet";
|
|
626
1014
|
};
|
|
1015
|
+
readonly ready: {
|
|
1016
|
+
readonly type: "boolean";
|
|
1017
|
+
readonly description: "Indicates whether the fleet configuration is healthy.";
|
|
1018
|
+
readonly example: true;
|
|
1019
|
+
};
|
|
1020
|
+
readonly status_message: {
|
|
1021
|
+
readonly type: "string";
|
|
1022
|
+
readonly description: "Human-readable reason the fleet is not ready. Present only when `ready` is false.";
|
|
1023
|
+
readonly example: "Invalid provider permissions.";
|
|
1024
|
+
};
|
|
1025
|
+
readonly created_at: {
|
|
1026
|
+
readonly type: "string";
|
|
1027
|
+
readonly description: "Creation date and time of the fleet.";
|
|
1028
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
1029
|
+
};
|
|
1030
|
+
readonly updated_at: {
|
|
1031
|
+
readonly type: "string";
|
|
1032
|
+
readonly description: "Date and time the fleet was last updated.";
|
|
1033
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
1034
|
+
};
|
|
627
1035
|
};
|
|
628
|
-
readonly required: readonly ["id"];
|
|
1036
|
+
readonly required: readonly ["constraints", "scalingProfile", "id", "ready", "created_at", "updated_at"];
|
|
629
1037
|
readonly additionalProperties: false;
|
|
1038
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
630
1039
|
};
|
|
631
1040
|
export declare const FleetUpdateInputSchema: {
|
|
632
1041
|
readonly type: "object";
|
|
@@ -635,13 +1044,12 @@ export declare const FleetUpdateInputSchema: {
|
|
|
635
1044
|
readonly type: "object";
|
|
636
1045
|
readonly properties: {
|
|
637
1046
|
readonly cpu: {
|
|
638
|
-
readonly type: "
|
|
639
|
-
readonly format: "float";
|
|
1047
|
+
readonly type: "integer";
|
|
640
1048
|
readonly minimum: 0;
|
|
641
|
-
readonly
|
|
1049
|
+
readonly maximum: 100000;
|
|
1050
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
642
1051
|
};
|
|
643
1052
|
};
|
|
644
|
-
readonly required: readonly ["cpu"];
|
|
645
1053
|
readonly additionalProperties: false;
|
|
646
1054
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
647
1055
|
};
|
|
@@ -650,14 +1058,15 @@ export declare const FleetUpdateInputSchema: {
|
|
|
650
1058
|
readonly properties: {
|
|
651
1059
|
readonly enabled: {
|
|
652
1060
|
readonly type: "boolean";
|
|
653
|
-
readonly default: true;
|
|
654
1061
|
};
|
|
655
1062
|
readonly project: {
|
|
656
1063
|
readonly type: "string";
|
|
657
|
-
readonly
|
|
1064
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
1065
|
+
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.";
|
|
1066
|
+
readonly example: "my-cloudfleet-project";
|
|
658
1067
|
};
|
|
659
1068
|
};
|
|
660
|
-
readonly required: readonly ["
|
|
1069
|
+
readonly required: readonly ["enabled"];
|
|
661
1070
|
readonly additionalProperties: false;
|
|
662
1071
|
};
|
|
663
1072
|
readonly hetzner: {
|
|
@@ -665,14 +1074,16 @@ export declare const FleetUpdateInputSchema: {
|
|
|
665
1074
|
readonly properties: {
|
|
666
1075
|
readonly enabled: {
|
|
667
1076
|
readonly type: "boolean";
|
|
668
|
-
readonly default: true;
|
|
669
1077
|
};
|
|
670
1078
|
readonly apiKey: {
|
|
671
1079
|
readonly type: "string";
|
|
672
|
-
readonly
|
|
1080
|
+
readonly maxLength: 64;
|
|
1081
|
+
readonly minLength: 64;
|
|
1082
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
1083
|
+
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
1084
|
};
|
|
674
1085
|
};
|
|
675
|
-
readonly required: readonly ["
|
|
1086
|
+
readonly required: readonly ["enabled"];
|
|
676
1087
|
readonly additionalProperties: false;
|
|
677
1088
|
};
|
|
678
1089
|
readonly aws: {
|
|
@@ -680,17 +1091,97 @@ export declare const FleetUpdateInputSchema: {
|
|
|
680
1091
|
readonly properties: {
|
|
681
1092
|
readonly enabled: {
|
|
682
1093
|
readonly type: "boolean";
|
|
683
|
-
readonly default: true;
|
|
684
1094
|
};
|
|
685
1095
|
readonly controllerRoleArn: {
|
|
686
1096
|
readonly type: "string";
|
|
687
|
-
readonly
|
|
1097
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
1098
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
1099
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
1100
|
+
};
|
|
1101
|
+
};
|
|
1102
|
+
readonly required: readonly ["enabled"];
|
|
1103
|
+
readonly additionalProperties: false;
|
|
1104
|
+
};
|
|
1105
|
+
readonly constraints: {
|
|
1106
|
+
readonly type: "object";
|
|
1107
|
+
readonly properties: {
|
|
1108
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
1109
|
+
readonly type: "array";
|
|
1110
|
+
readonly items: {
|
|
1111
|
+
readonly type: "string";
|
|
1112
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
1113
|
+
};
|
|
1114
|
+
readonly minItems: 1;
|
|
1115
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
1116
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
1117
|
+
};
|
|
1118
|
+
readonly 'kubernetes.io/arch': {
|
|
1119
|
+
readonly type: "array";
|
|
1120
|
+
readonly items: {
|
|
1121
|
+
readonly type: "string";
|
|
1122
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
1123
|
+
};
|
|
1124
|
+
readonly minItems: 1;
|
|
1125
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
1126
|
+
readonly default: readonly ["amd64"];
|
|
1127
|
+
};
|
|
1128
|
+
readonly 'cfke.io/instance-family': {
|
|
1129
|
+
readonly type: "array";
|
|
1130
|
+
readonly items: {
|
|
1131
|
+
readonly type: "string";
|
|
1132
|
+
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"];
|
|
1133
|
+
};
|
|
1134
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
1135
|
+
readonly default: readonly [];
|
|
1136
|
+
};
|
|
1137
|
+
readonly 'topology.kubernetes.io/region': {
|
|
1138
|
+
readonly type: "array";
|
|
1139
|
+
readonly items: {
|
|
1140
|
+
readonly type: "string";
|
|
1141
|
+
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"];
|
|
1142
|
+
};
|
|
1143
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
1144
|
+
readonly default: readonly [];
|
|
688
1145
|
};
|
|
689
1146
|
};
|
|
690
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
691
1147
|
readonly additionalProperties: false;
|
|
1148
|
+
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.";
|
|
1149
|
+
readonly default: {
|
|
1150
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
1151
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
1152
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
1153
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
1154
|
+
};
|
|
1155
|
+
};
|
|
1156
|
+
readonly scalingProfile: {
|
|
1157
|
+
readonly type: "string";
|
|
1158
|
+
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`).";
|
|
1159
|
+
readonly default: "conservative";
|
|
1160
|
+
readonly example: "conservative";
|
|
1161
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
1162
|
+
};
|
|
1163
|
+
};
|
|
1164
|
+
readonly additionalProperties: false;
|
|
1165
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
1166
|
+
};
|
|
1167
|
+
export declare const InviteCreateInputSchema: {
|
|
1168
|
+
readonly type: "object";
|
|
1169
|
+
readonly properties: {
|
|
1170
|
+
readonly email: {
|
|
1171
|
+
readonly type: "string";
|
|
1172
|
+
readonly format: "email";
|
|
1173
|
+
readonly description: "Email address of the user to invite.";
|
|
1174
|
+
readonly example: "email@example.com";
|
|
1175
|
+
};
|
|
1176
|
+
readonly role: {
|
|
1177
|
+
readonly type: "string";
|
|
1178
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1179
|
+
readonly default: "User";
|
|
1180
|
+
readonly example: "User";
|
|
1181
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
692
1182
|
};
|
|
693
1183
|
};
|
|
1184
|
+
readonly required: readonly ["email"];
|
|
694
1185
|
readonly additionalProperties: false;
|
|
695
1186
|
};
|
|
696
1187
|
export declare const InviteSchema: {
|
|
@@ -724,6 +1215,13 @@ export declare const InviteSchema: {
|
|
|
724
1215
|
readonly description: "Generated unique invite code.";
|
|
725
1216
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
726
1217
|
};
|
|
1218
|
+
readonly role: {
|
|
1219
|
+
readonly type: "string";
|
|
1220
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1221
|
+
readonly default: "User";
|
|
1222
|
+
readonly example: "User";
|
|
1223
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1224
|
+
};
|
|
727
1225
|
};
|
|
728
1226
|
readonly required: readonly ["date_created"];
|
|
729
1227
|
readonly additionalProperties: false;
|
|
@@ -733,9 +1231,8 @@ export declare const InvoiceSchema: {
|
|
|
733
1231
|
readonly properties: {
|
|
734
1232
|
readonly id: {
|
|
735
1233
|
readonly type: "string";
|
|
736
|
-
readonly
|
|
737
|
-
readonly
|
|
738
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
1234
|
+
readonly description: "Unique identifier of the invoice.";
|
|
1235
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
739
1236
|
};
|
|
740
1237
|
readonly number: {
|
|
741
1238
|
readonly type: "string";
|
|
@@ -876,6 +1373,11 @@ export declare const MarketplaceListingSchema: {
|
|
|
876
1373
|
readonly description: "Chart home URL";
|
|
877
1374
|
readonly example: "https://kubernetes.github.io/ingress-nginx/";
|
|
878
1375
|
};
|
|
1376
|
+
readonly icon: {
|
|
1377
|
+
readonly type: "string";
|
|
1378
|
+
readonly description: "A URL to an SVG or PNG image to be used as an icon";
|
|
1379
|
+
readonly example: "https://cloudfleet.ai/images/marketplace/icons/ingress-nginx.png";
|
|
1380
|
+
};
|
|
879
1381
|
readonly sources: {
|
|
880
1382
|
readonly type: "array";
|
|
881
1383
|
readonly items: {
|
|
@@ -917,6 +1419,12 @@ export declare const MarketplaceListingSchema: {
|
|
|
917
1419
|
export declare const OrganizationCreateInputSchema: {
|
|
918
1420
|
readonly type: "object";
|
|
919
1421
|
readonly properties: {
|
|
1422
|
+
readonly type: {
|
|
1423
|
+
readonly type: "string";
|
|
1424
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1425
|
+
readonly example: "business";
|
|
1426
|
+
readonly enum: readonly ["business", "personal"];
|
|
1427
|
+
};
|
|
920
1428
|
readonly email: {
|
|
921
1429
|
readonly type: "string";
|
|
922
1430
|
readonly format: "email";
|
|
@@ -925,11 +1433,13 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
925
1433
|
};
|
|
926
1434
|
readonly first_name: {
|
|
927
1435
|
readonly type: "string";
|
|
1436
|
+
readonly minLength: 1;
|
|
928
1437
|
readonly description: "First name of the billing contact person.";
|
|
929
1438
|
readonly example: "John";
|
|
930
1439
|
};
|
|
931
1440
|
readonly last_name: {
|
|
932
1441
|
readonly type: "string";
|
|
1442
|
+
readonly minLength: 1;
|
|
933
1443
|
readonly description: "Last name of the billing contact person.";
|
|
934
1444
|
readonly example: "Doe";
|
|
935
1445
|
};
|
|
@@ -947,7 +1457,19 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
947
1457
|
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.";
|
|
948
1458
|
};
|
|
949
1459
|
};
|
|
950
|
-
readonly required: readonly ["email", "first_name", "last_name", "company_name", "password"];
|
|
1460
|
+
readonly required: readonly ["type", "email", "first_name", "last_name", "company_name", "password"];
|
|
1461
|
+
readonly additionalProperties: false;
|
|
1462
|
+
};
|
|
1463
|
+
export declare const OrganizationCreateOutputSchema: {
|
|
1464
|
+
readonly type: "object";
|
|
1465
|
+
readonly properties: {
|
|
1466
|
+
readonly id: {
|
|
1467
|
+
readonly type: "string";
|
|
1468
|
+
readonly description: "Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.";
|
|
1469
|
+
readonly example: "organization-id";
|
|
1470
|
+
};
|
|
1471
|
+
};
|
|
1472
|
+
readonly required: readonly ["id"];
|
|
951
1473
|
readonly additionalProperties: false;
|
|
952
1474
|
};
|
|
953
1475
|
export declare const OrganizationSchema: {
|
|
@@ -966,6 +1488,12 @@ export declare const OrganizationSchema: {
|
|
|
966
1488
|
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
967
1489
|
readonly example: "ACME Corp.";
|
|
968
1490
|
};
|
|
1491
|
+
readonly type: {
|
|
1492
|
+
readonly type: "string";
|
|
1493
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1494
|
+
readonly example: "business";
|
|
1495
|
+
readonly enum: readonly ["business", "personal"];
|
|
1496
|
+
};
|
|
969
1497
|
readonly date_created: {
|
|
970
1498
|
readonly type: "string";
|
|
971
1499
|
readonly format: "date-time";
|
|
@@ -997,6 +1525,17 @@ export declare const OrganizationSchema: {
|
|
|
997
1525
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
998
1526
|
readonly example: 999;
|
|
999
1527
|
};
|
|
1528
|
+
readonly enterprise_clusters_max: {
|
|
1529
|
+
readonly type: "integer";
|
|
1530
|
+
readonly minimum: 0;
|
|
1531
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1532
|
+
readonly example: 999;
|
|
1533
|
+
};
|
|
1534
|
+
readonly enterprise_clusters_available: {
|
|
1535
|
+
readonly type: "integer";
|
|
1536
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1537
|
+
readonly example: 999;
|
|
1538
|
+
};
|
|
1000
1539
|
readonly fleets_max: {
|
|
1001
1540
|
readonly type: "integer";
|
|
1002
1541
|
readonly minimum: 0;
|
|
@@ -1016,7 +1555,7 @@ export declare const OrganizationSchema: {
|
|
|
1016
1555
|
readonly type: "array";
|
|
1017
1556
|
readonly items: {
|
|
1018
1557
|
readonly type: "string";
|
|
1019
|
-
readonly example: "northamerica-central-
|
|
1558
|
+
readonly example: "northamerica-central-1a";
|
|
1020
1559
|
};
|
|
1021
1560
|
readonly minItems: 1;
|
|
1022
1561
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1043,8 +1582,14 @@ export declare const OrganizationSchema: {
|
|
|
1043
1582
|
readonly minItems: 1;
|
|
1044
1583
|
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1045
1584
|
};
|
|
1585
|
+
readonly cfcr_storage_gb: {
|
|
1586
|
+
readonly type: "integer";
|
|
1587
|
+
readonly minimum: -1;
|
|
1588
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1589
|
+
readonly example: 500;
|
|
1590
|
+
};
|
|
1046
1591
|
};
|
|
1047
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions"];
|
|
1592
|
+
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"];
|
|
1048
1593
|
readonly additionalProperties: false;
|
|
1049
1594
|
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.";
|
|
1050
1595
|
};
|
|
@@ -1053,8 +1598,14 @@ export declare const OrganizationSchema: {
|
|
|
1053
1598
|
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1054
1599
|
readonly enum: readonly ["active", "closed", "suspended"];
|
|
1055
1600
|
};
|
|
1601
|
+
readonly verification: {
|
|
1602
|
+
readonly type: "string";
|
|
1603
|
+
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.";
|
|
1604
|
+
readonly example: "verified";
|
|
1605
|
+
readonly enum: readonly ["none", "submitted", "verified"];
|
|
1606
|
+
};
|
|
1056
1607
|
};
|
|
1057
|
-
readonly required: readonly ["id", "date_created", "quota", "status"];
|
|
1608
|
+
readonly required: readonly ["id", "type", "date_created", "quota", "status", "verification"];
|
|
1058
1609
|
readonly additionalProperties: false;
|
|
1059
1610
|
};
|
|
1060
1611
|
export declare const PaymentMethodSchema: {
|
|
@@ -1062,26 +1613,19 @@ export declare const PaymentMethodSchema: {
|
|
|
1062
1613
|
readonly properties: {
|
|
1063
1614
|
readonly id: {
|
|
1064
1615
|
readonly type: "string";
|
|
1065
|
-
readonly
|
|
1066
|
-
readonly
|
|
1067
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1068
|
-
};
|
|
1069
|
-
readonly setup: {
|
|
1070
|
-
readonly type: "boolean";
|
|
1071
|
-
readonly description: "Whether organization payment method was set up and ready to use for payments.";
|
|
1072
|
-
readonly example: true;
|
|
1616
|
+
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.";
|
|
1617
|
+
readonly example: "pm_1MtwBwLkdIwHu7ix28a3tqPa";
|
|
1073
1618
|
};
|
|
1074
1619
|
readonly type: {
|
|
1075
1620
|
readonly type: "string";
|
|
1076
|
-
readonly
|
|
1077
|
-
readonly description: "Payment method type type. Only `card` payments supported at the moment.";
|
|
1621
|
+
readonly description: "Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.";
|
|
1078
1622
|
readonly example: "card";
|
|
1079
|
-
readonly enum: readonly ["card"];
|
|
1623
|
+
readonly enum: readonly ["card", "sepa_debit", "bank_transfer"];
|
|
1080
1624
|
};
|
|
1081
1625
|
readonly last4: {
|
|
1082
1626
|
readonly type: "string";
|
|
1083
1627
|
readonly nullable: true;
|
|
1084
|
-
readonly description: "Last 4 digits of the payment card number.";
|
|
1628
|
+
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.";
|
|
1085
1629
|
readonly example: "4242";
|
|
1086
1630
|
};
|
|
1087
1631
|
readonly exp_month: {
|
|
@@ -1089,25 +1633,46 @@ export declare const PaymentMethodSchema: {
|
|
|
1089
1633
|
readonly minimum: 1;
|
|
1090
1634
|
readonly maximum: 12;
|
|
1091
1635
|
readonly nullable: true;
|
|
1092
|
-
readonly description: "Two-digit number representing the card's expiration month.";
|
|
1093
|
-
readonly example:
|
|
1636
|
+
readonly description: "Two-digit number representing the card's expiration month. Null for SEPA Direct Debit and bank transfer.";
|
|
1637
|
+
readonly example: 12;
|
|
1094
1638
|
};
|
|
1095
1639
|
readonly exp_year: {
|
|
1096
1640
|
readonly type: "integer";
|
|
1097
|
-
readonly minimum: 2024;
|
|
1098
1641
|
readonly nullable: true;
|
|
1099
|
-
readonly description: "Four-digit number representing the card's expiration year.";
|
|
1100
|
-
readonly example:
|
|
1642
|
+
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.";
|
|
1643
|
+
readonly example: 2028;
|
|
1101
1644
|
};
|
|
1102
1645
|
readonly brand: {
|
|
1103
1646
|
readonly type: "string";
|
|
1104
1647
|
readonly nullable: true;
|
|
1105
|
-
readonly description: "Payment card brand
|
|
1648
|
+
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.";
|
|
1106
1649
|
readonly example: "visa";
|
|
1107
|
-
|
|
1650
|
+
};
|
|
1651
|
+
readonly iban: {
|
|
1652
|
+
readonly type: "string";
|
|
1653
|
+
readonly nullable: true;
|
|
1654
|
+
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.";
|
|
1655
|
+
readonly example: "DE11243015658023127510";
|
|
1656
|
+
};
|
|
1657
|
+
readonly bic: {
|
|
1658
|
+
readonly type: "string";
|
|
1659
|
+
readonly nullable: true;
|
|
1660
|
+
readonly description: "BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1661
|
+
readonly example: "SOGEDEFFXXX";
|
|
1662
|
+
};
|
|
1663
|
+
readonly account_holder_name: {
|
|
1664
|
+
readonly type: "string";
|
|
1665
|
+
readonly nullable: true;
|
|
1666
|
+
readonly description: "Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1667
|
+
readonly example: "Cloudfleet GmbH";
|
|
1668
|
+
};
|
|
1669
|
+
readonly is_default: {
|
|
1670
|
+
readonly type: "boolean";
|
|
1671
|
+
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).";
|
|
1672
|
+
readonly example: true;
|
|
1108
1673
|
};
|
|
1109
1674
|
};
|
|
1110
|
-
readonly required: readonly ["id", "
|
|
1675
|
+
readonly required: readonly ["id", "type", "last4", "exp_month", "exp_year", "brand", "iban", "bic", "account_holder_name", "is_default"];
|
|
1111
1676
|
readonly additionalProperties: false;
|
|
1112
1677
|
};
|
|
1113
1678
|
export declare const PlatformQuotaSchema: {
|
|
@@ -1135,6 +1700,17 @@ export declare const PlatformQuotaSchema: {
|
|
|
1135
1700
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1136
1701
|
readonly example: 999;
|
|
1137
1702
|
};
|
|
1703
|
+
readonly enterprise_clusters_max: {
|
|
1704
|
+
readonly type: "integer";
|
|
1705
|
+
readonly minimum: 0;
|
|
1706
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1707
|
+
readonly example: 999;
|
|
1708
|
+
};
|
|
1709
|
+
readonly enterprise_clusters_available: {
|
|
1710
|
+
readonly type: "integer";
|
|
1711
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1712
|
+
readonly example: 999;
|
|
1713
|
+
};
|
|
1138
1714
|
readonly fleets_max: {
|
|
1139
1715
|
readonly type: "integer";
|
|
1140
1716
|
readonly minimum: 0;
|
|
@@ -1154,7 +1730,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1154
1730
|
readonly type: "array";
|
|
1155
1731
|
readonly items: {
|
|
1156
1732
|
readonly type: "string";
|
|
1157
|
-
readonly example: "northamerica-central-
|
|
1733
|
+
readonly example: "northamerica-central-1a";
|
|
1158
1734
|
};
|
|
1159
1735
|
readonly minItems: 1;
|
|
1160
1736
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1181,8 +1757,14 @@ export declare const PlatformQuotaSchema: {
|
|
|
1181
1757
|
readonly minItems: 1;
|
|
1182
1758
|
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1183
1759
|
};
|
|
1760
|
+
readonly cfcr_storage_gb: {
|
|
1761
|
+
readonly type: "integer";
|
|
1762
|
+
readonly minimum: -1;
|
|
1763
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1764
|
+
readonly example: 500;
|
|
1765
|
+
};
|
|
1184
1766
|
};
|
|
1185
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions"];
|
|
1767
|
+
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"];
|
|
1186
1768
|
readonly additionalProperties: false;
|
|
1187
1769
|
};
|
|
1188
1770
|
export declare const RegistryRepositorySchema: {
|
|
@@ -1201,7 +1783,7 @@ export declare const RegistryRepositorySchema: {
|
|
|
1201
1783
|
readonly uri: {
|
|
1202
1784
|
readonly type: "string";
|
|
1203
1785
|
readonly description: "Full URI of the repository.";
|
|
1204
|
-
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/
|
|
1786
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
1205
1787
|
};
|
|
1206
1788
|
};
|
|
1207
1789
|
readonly required: readonly ["name", "region", "uri"];
|
|
@@ -1223,7 +1805,7 @@ export declare const RegistryRepositoryWithTagsSchema: {
|
|
|
1223
1805
|
readonly uri: {
|
|
1224
1806
|
readonly type: "string";
|
|
1225
1807
|
readonly description: "Full URI of the repository.";
|
|
1226
|
-
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/
|
|
1808
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
1227
1809
|
};
|
|
1228
1810
|
readonly tags: {
|
|
1229
1811
|
readonly type: "array";
|
|
@@ -1246,6 +1828,14 @@ export declare const RegistryRepositoryWithTagsSchema: {
|
|
|
1246
1828
|
readonly description: "Media type of the manifest.";
|
|
1247
1829
|
readonly example: "application/vnd.docker.distribution.manifest.v2+json";
|
|
1248
1830
|
};
|
|
1831
|
+
readonly platforms: {
|
|
1832
|
+
readonly type: "array";
|
|
1833
|
+
readonly items: {
|
|
1834
|
+
readonly type: "string";
|
|
1835
|
+
};
|
|
1836
|
+
readonly description: "Array of platform strings for multi-arch images (e.g., linux/amd64, linux/arm64).";
|
|
1837
|
+
readonly example: readonly ["linux/amd64", "linux/arm64"];
|
|
1838
|
+
};
|
|
1249
1839
|
};
|
|
1250
1840
|
readonly required: readonly ["name", "size"];
|
|
1251
1841
|
readonly additionalProperties: false;
|
|
@@ -1270,6 +1860,11 @@ export declare const RegistryTagSchema: {
|
|
|
1270
1860
|
readonly description: "Tag name.";
|
|
1271
1861
|
readonly example: "latest";
|
|
1272
1862
|
};
|
|
1863
|
+
readonly digest: {
|
|
1864
|
+
readonly type: "string";
|
|
1865
|
+
readonly description: "Manifest digest for pulling by digest.";
|
|
1866
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1867
|
+
};
|
|
1273
1868
|
readonly mediaType: {
|
|
1274
1869
|
readonly type: "string";
|
|
1275
1870
|
readonly description: "Media type of the manifest.";
|
|
@@ -1294,6 +1889,11 @@ export declare const RegistryTagSchema: {
|
|
|
1294
1889
|
readonly items: {
|
|
1295
1890
|
readonly type: "object";
|
|
1296
1891
|
readonly properties: {
|
|
1892
|
+
readonly digest: {
|
|
1893
|
+
readonly type: "string";
|
|
1894
|
+
readonly description: "Digest of the layer.";
|
|
1895
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1896
|
+
};
|
|
1297
1897
|
readonly size: {
|
|
1298
1898
|
readonly type: "number";
|
|
1299
1899
|
readonly format: "float";
|
|
@@ -1329,11 +1929,44 @@ export declare const RegistryTagSchema: {
|
|
|
1329
1929
|
readonly description: "Operating system of the platform.";
|
|
1330
1930
|
readonly example: "linux";
|
|
1331
1931
|
};
|
|
1932
|
+
readonly variant: {
|
|
1933
|
+
readonly type: "string";
|
|
1934
|
+
readonly description: "Variant of the platform (e.g., v7, v8 for ARM).";
|
|
1935
|
+
readonly example: "v8";
|
|
1936
|
+
};
|
|
1332
1937
|
};
|
|
1333
1938
|
readonly required: readonly ["architecture", "os"];
|
|
1334
1939
|
readonly additionalProperties: false;
|
|
1335
1940
|
readonly description: "Platform information for the manifest.";
|
|
1336
1941
|
};
|
|
1942
|
+
readonly layers: {
|
|
1943
|
+
readonly type: "array";
|
|
1944
|
+
readonly items: {
|
|
1945
|
+
readonly type: "object";
|
|
1946
|
+
readonly properties: {
|
|
1947
|
+
readonly digest: {
|
|
1948
|
+
readonly type: "string";
|
|
1949
|
+
readonly description: "Digest of the layer.";
|
|
1950
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1951
|
+
};
|
|
1952
|
+
readonly size: {
|
|
1953
|
+
readonly type: "number";
|
|
1954
|
+
readonly format: "float";
|
|
1955
|
+
readonly description: "Size of the layer in bytes.";
|
|
1956
|
+
readonly example: 5678;
|
|
1957
|
+
};
|
|
1958
|
+
};
|
|
1959
|
+
readonly required: readonly ["size"];
|
|
1960
|
+
readonly additionalProperties: false;
|
|
1961
|
+
};
|
|
1962
|
+
readonly description: "Layers for this platform.";
|
|
1963
|
+
};
|
|
1964
|
+
readonly size: {
|
|
1965
|
+
readonly type: "number";
|
|
1966
|
+
readonly format: "float";
|
|
1967
|
+
readonly description: "Total size of this platform manifest in bytes.";
|
|
1968
|
+
readonly example: 12345678;
|
|
1969
|
+
};
|
|
1337
1970
|
};
|
|
1338
1971
|
readonly required: readonly ["digest"];
|
|
1339
1972
|
readonly additionalProperties: false;
|
|
@@ -1362,7 +1995,275 @@ export declare const RegistryTagSchema: {
|
|
|
1362
1995
|
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app:latest";
|
|
1363
1996
|
};
|
|
1364
1997
|
};
|
|
1365
|
-
readonly required: readonly ["name", "size", "region", "repository", "uri"];
|
|
1998
|
+
readonly required: readonly ["name", "digest", "size", "region", "repository", "uri"];
|
|
1999
|
+
readonly additionalProperties: false;
|
|
2000
|
+
};
|
|
2001
|
+
export declare const TicketAttachmentSchema: {
|
|
2002
|
+
readonly type: "object";
|
|
2003
|
+
readonly properties: {
|
|
2004
|
+
readonly id: {
|
|
2005
|
+
readonly type: "string";
|
|
2006
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2007
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2008
|
+
};
|
|
2009
|
+
readonly filename: {
|
|
2010
|
+
readonly type: "string";
|
|
2011
|
+
readonly description: "Original filename as uploaded.";
|
|
2012
|
+
readonly example: "debug.log";
|
|
2013
|
+
};
|
|
2014
|
+
readonly content_type: {
|
|
2015
|
+
readonly type: "string";
|
|
2016
|
+
readonly description: "MIME content type of the attachment.";
|
|
2017
|
+
readonly example: "text/plain";
|
|
2018
|
+
};
|
|
2019
|
+
readonly size: {
|
|
2020
|
+
readonly type: "integer";
|
|
2021
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2022
|
+
readonly example: 12345;
|
|
2023
|
+
};
|
|
2024
|
+
};
|
|
2025
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2026
|
+
readonly additionalProperties: false;
|
|
2027
|
+
};
|
|
2028
|
+
export declare const TicketCreateInputSchema: {
|
|
2029
|
+
readonly type: "object";
|
|
2030
|
+
readonly properties: {
|
|
2031
|
+
readonly category: {
|
|
2032
|
+
readonly type: "string";
|
|
2033
|
+
readonly description: "Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.";
|
|
2034
|
+
readonly example: "technical";
|
|
2035
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
2036
|
+
};
|
|
2037
|
+
readonly body: {
|
|
2038
|
+
readonly type: "string";
|
|
2039
|
+
readonly maxLength: 50000;
|
|
2040
|
+
readonly minLength: 1;
|
|
2041
|
+
readonly pattern: "\\S";
|
|
2042
|
+
readonly description: "Initial message body in markdown. There is no separate subject — the first message body is the description.";
|
|
2043
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2044
|
+
};
|
|
2045
|
+
readonly properties: {
|
|
2046
|
+
readonly type: "object";
|
|
2047
|
+
readonly additionalProperties: true;
|
|
2048
|
+
readonly description: "Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).";
|
|
2049
|
+
readonly example: {
|
|
2050
|
+
readonly subcategory: "cluster-question";
|
|
2051
|
+
readonly cluster_id: "60c72b2f9f1b2c001f8e4d3a";
|
|
2052
|
+
};
|
|
2053
|
+
};
|
|
2054
|
+
};
|
|
2055
|
+
readonly required: readonly ["category", "body"];
|
|
2056
|
+
readonly additionalProperties: false;
|
|
2057
|
+
};
|
|
2058
|
+
export declare const TicketMessageInputSchema: {
|
|
2059
|
+
readonly type: "object";
|
|
2060
|
+
readonly properties: {
|
|
2061
|
+
readonly body: {
|
|
2062
|
+
readonly type: "string";
|
|
2063
|
+
readonly maxLength: 50000;
|
|
2064
|
+
readonly minLength: 1;
|
|
2065
|
+
readonly pattern: "\\S";
|
|
2066
|
+
readonly description: "Reply body in markdown.";
|
|
2067
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2068
|
+
};
|
|
2069
|
+
};
|
|
2070
|
+
readonly required: readonly ["body"];
|
|
2071
|
+
readonly additionalProperties: false;
|
|
2072
|
+
};
|
|
2073
|
+
export declare const TicketMessageSchema: {
|
|
2074
|
+
readonly type: "object";
|
|
2075
|
+
readonly properties: {
|
|
2076
|
+
readonly id: {
|
|
2077
|
+
readonly type: "string";
|
|
2078
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2079
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2080
|
+
};
|
|
2081
|
+
readonly type: {
|
|
2082
|
+
readonly type: "string";
|
|
2083
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2084
|
+
readonly example: "customer_reply";
|
|
2085
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2086
|
+
};
|
|
2087
|
+
readonly body: {
|
|
2088
|
+
readonly type: "string";
|
|
2089
|
+
readonly description: "Message body in markdown.";
|
|
2090
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2091
|
+
};
|
|
2092
|
+
readonly author_first_name: {
|
|
2093
|
+
readonly type: "string";
|
|
2094
|
+
readonly nullable: true;
|
|
2095
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2096
|
+
readonly example: "Jane";
|
|
2097
|
+
};
|
|
2098
|
+
readonly author_last_name: {
|
|
2099
|
+
readonly type: "string";
|
|
2100
|
+
readonly nullable: true;
|
|
2101
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2102
|
+
readonly example: "Doe";
|
|
2103
|
+
};
|
|
2104
|
+
readonly attachments: {
|
|
2105
|
+
readonly type: "array";
|
|
2106
|
+
readonly items: {
|
|
2107
|
+
readonly type: "object";
|
|
2108
|
+
readonly properties: {
|
|
2109
|
+
readonly id: {
|
|
2110
|
+
readonly type: "string";
|
|
2111
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2112
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2113
|
+
};
|
|
2114
|
+
readonly filename: {
|
|
2115
|
+
readonly type: "string";
|
|
2116
|
+
readonly description: "Original filename as uploaded.";
|
|
2117
|
+
readonly example: "debug.log";
|
|
2118
|
+
};
|
|
2119
|
+
readonly content_type: {
|
|
2120
|
+
readonly type: "string";
|
|
2121
|
+
readonly description: "MIME content type of the attachment.";
|
|
2122
|
+
readonly example: "text/plain";
|
|
2123
|
+
};
|
|
2124
|
+
readonly size: {
|
|
2125
|
+
readonly type: "integer";
|
|
2126
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2127
|
+
readonly example: 12345;
|
|
2128
|
+
};
|
|
2129
|
+
};
|
|
2130
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2131
|
+
readonly additionalProperties: false;
|
|
2132
|
+
};
|
|
2133
|
+
readonly description: "Attachments associated with this message.";
|
|
2134
|
+
readonly example: readonly [];
|
|
2135
|
+
};
|
|
2136
|
+
readonly date_created: {
|
|
2137
|
+
readonly type: "string";
|
|
2138
|
+
readonly format: "date-time";
|
|
2139
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2140
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2141
|
+
};
|
|
2142
|
+
};
|
|
2143
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2144
|
+
readonly additionalProperties: false;
|
|
2145
|
+
};
|
|
2146
|
+
export declare const TicketSchema: {
|
|
2147
|
+
readonly type: "object";
|
|
2148
|
+
readonly properties: {
|
|
2149
|
+
readonly id: {
|
|
2150
|
+
readonly type: "string";
|
|
2151
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
2152
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
2153
|
+
};
|
|
2154
|
+
readonly status: {
|
|
2155
|
+
readonly type: "string";
|
|
2156
|
+
readonly description: "Current state of the ticket.";
|
|
2157
|
+
readonly example: "waiting_on_us";
|
|
2158
|
+
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
2159
|
+
};
|
|
2160
|
+
readonly category: {
|
|
2161
|
+
readonly type: "string";
|
|
2162
|
+
readonly description: "Ticket category.";
|
|
2163
|
+
readonly example: "technical";
|
|
2164
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
2165
|
+
};
|
|
2166
|
+
readonly summary: {
|
|
2167
|
+
readonly type: "string";
|
|
2168
|
+
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
2169
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2170
|
+
};
|
|
2171
|
+
readonly closed_at: {
|
|
2172
|
+
readonly type: "string";
|
|
2173
|
+
readonly format: "date-time";
|
|
2174
|
+
readonly nullable: true;
|
|
2175
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
2176
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
2177
|
+
};
|
|
2178
|
+
readonly date_created: {
|
|
2179
|
+
readonly type: "string";
|
|
2180
|
+
readonly format: "date-time";
|
|
2181
|
+
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
2182
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2183
|
+
};
|
|
2184
|
+
readonly date_updated: {
|
|
2185
|
+
readonly type: "string";
|
|
2186
|
+
readonly format: "date-time";
|
|
2187
|
+
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
2188
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2189
|
+
};
|
|
2190
|
+
readonly messages: {
|
|
2191
|
+
readonly type: "array";
|
|
2192
|
+
readonly items: {
|
|
2193
|
+
readonly type: "object";
|
|
2194
|
+
readonly properties: {
|
|
2195
|
+
readonly id: {
|
|
2196
|
+
readonly type: "string";
|
|
2197
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2198
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2199
|
+
};
|
|
2200
|
+
readonly type: {
|
|
2201
|
+
readonly type: "string";
|
|
2202
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2203
|
+
readonly example: "customer_reply";
|
|
2204
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2205
|
+
};
|
|
2206
|
+
readonly body: {
|
|
2207
|
+
readonly type: "string";
|
|
2208
|
+
readonly description: "Message body in markdown.";
|
|
2209
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2210
|
+
};
|
|
2211
|
+
readonly author_first_name: {
|
|
2212
|
+
readonly type: "string";
|
|
2213
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2214
|
+
readonly example: "Jane";
|
|
2215
|
+
};
|
|
2216
|
+
readonly author_last_name: {
|
|
2217
|
+
readonly type: "string";
|
|
2218
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2219
|
+
readonly example: "Doe";
|
|
2220
|
+
};
|
|
2221
|
+
readonly attachments: {
|
|
2222
|
+
readonly type: "array";
|
|
2223
|
+
readonly items: {
|
|
2224
|
+
readonly type: "object";
|
|
2225
|
+
readonly properties: {
|
|
2226
|
+
readonly id: {
|
|
2227
|
+
readonly type: "string";
|
|
2228
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2229
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2230
|
+
};
|
|
2231
|
+
readonly filename: {
|
|
2232
|
+
readonly type: "string";
|
|
2233
|
+
readonly description: "Original filename as uploaded.";
|
|
2234
|
+
readonly example: "debug.log";
|
|
2235
|
+
};
|
|
2236
|
+
readonly content_type: {
|
|
2237
|
+
readonly type: "string";
|
|
2238
|
+
readonly description: "MIME content type of the attachment.";
|
|
2239
|
+
readonly example: "text/plain";
|
|
2240
|
+
};
|
|
2241
|
+
readonly size: {
|
|
2242
|
+
readonly type: "integer";
|
|
2243
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2244
|
+
readonly example: 12345;
|
|
2245
|
+
};
|
|
2246
|
+
};
|
|
2247
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2248
|
+
readonly additionalProperties: false;
|
|
2249
|
+
};
|
|
2250
|
+
readonly description: "Attachments associated with this message.";
|
|
2251
|
+
readonly example: readonly [];
|
|
2252
|
+
};
|
|
2253
|
+
readonly date_created: {
|
|
2254
|
+
readonly type: "string";
|
|
2255
|
+
readonly format: "date-time";
|
|
2256
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2257
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2258
|
+
};
|
|
2259
|
+
};
|
|
2260
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2261
|
+
readonly additionalProperties: false;
|
|
2262
|
+
};
|
|
2263
|
+
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
2264
|
+
};
|
|
2265
|
+
};
|
|
2266
|
+
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
1366
2267
|
readonly additionalProperties: false;
|
|
1367
2268
|
};
|
|
1368
2269
|
export declare const TokenCreateInputSchema: {
|
|
@@ -1458,9 +2359,10 @@ export declare const UsageFacetsSchema: {
|
|
|
1458
2359
|
readonly type: "array";
|
|
1459
2360
|
readonly items: {
|
|
1460
2361
|
readonly type: "string";
|
|
2362
|
+
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"];
|
|
1461
2363
|
};
|
|
1462
2364
|
readonly description: "List of unique products";
|
|
1463
|
-
readonly example: readonly ["
|
|
2365
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
1464
2366
|
};
|
|
1465
2367
|
};
|
|
1466
2368
|
readonly additionalProperties: false;
|
|
@@ -1486,7 +2388,8 @@ export declare const UsageResponseSchema: {
|
|
|
1486
2388
|
readonly product: {
|
|
1487
2389
|
readonly type: "string";
|
|
1488
2390
|
readonly description: "The product the usage is associated with";
|
|
1489
|
-
readonly example: "
|
|
2391
|
+
readonly example: "cfke_controlplane_pro";
|
|
2392
|
+
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"];
|
|
1490
2393
|
};
|
|
1491
2394
|
readonly value: {
|
|
1492
2395
|
readonly type: "number";
|
|
@@ -1526,9 +2429,10 @@ export declare const UsageResponseSchema: {
|
|
|
1526
2429
|
readonly type: "array";
|
|
1527
2430
|
readonly items: {
|
|
1528
2431
|
readonly type: "string";
|
|
2432
|
+
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"];
|
|
1529
2433
|
};
|
|
1530
2434
|
readonly description: "List of unique products";
|
|
1531
|
-
readonly example: readonly ["
|
|
2435
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
1532
2436
|
};
|
|
1533
2437
|
};
|
|
1534
2438
|
readonly additionalProperties: false;
|
|
@@ -1554,7 +2458,8 @@ export declare const UsageSchema: {
|
|
|
1554
2458
|
readonly product: {
|
|
1555
2459
|
readonly type: "string";
|
|
1556
2460
|
readonly description: "The product the usage is associated with";
|
|
1557
|
-
readonly example: "
|
|
2461
|
+
readonly example: "cfke_controlplane_pro";
|
|
2462
|
+
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"];
|
|
1558
2463
|
};
|
|
1559
2464
|
readonly value: {
|
|
1560
2465
|
readonly type: "number";
|
|
@@ -1611,18 +2516,6 @@ export declare const UserCreateInputSchema: {
|
|
|
1611
2516
|
readonly minLength: 8;
|
|
1612
2517
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
1613
2518
|
};
|
|
1614
|
-
readonly status: {
|
|
1615
|
-
readonly type: "string";
|
|
1616
|
-
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
1617
|
-
readonly example: "active";
|
|
1618
|
-
readonly enum: readonly ["active", "inactive"];
|
|
1619
|
-
};
|
|
1620
|
-
readonly role: {
|
|
1621
|
-
readonly type: "string";
|
|
1622
|
-
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
1623
|
-
readonly example: "User";
|
|
1624
|
-
readonly enum: readonly ["Administrator", "User"];
|
|
1625
|
-
};
|
|
1626
2519
|
};
|
|
1627
2520
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
1628
2521
|
readonly additionalProperties: false;
|