@cloudfleet/sdk 0.0.1-830b4e3 → 0.0.1-8608ef2
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 +1026 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1194 -0
- package/dist/@tanstack/react-query.gen.js.map +1 -0
- package/dist/client/client.gen.d.ts +3 -0
- package/dist/client/client.gen.d.ts.map +1 -0
- package/dist/client/client.gen.js +217 -0
- package/dist/client/client.gen.js.map +1 -0
- package/dist/client/index.d.ts +8 -7
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +6 -4
- package/dist/client/index.js.map +1 -1
- package/dist/client/{types.d.ts → types.gen.d.ts} +23 -22
- package/dist/client/types.gen.d.ts.map +1 -0
- package/dist/client/types.gen.js +3 -0
- package/dist/client/types.gen.js.map +1 -0
- package/dist/client/{utils.d.ts → utils.gen.d.ts} +17 -25
- package/dist/client/utils.gen.d.ts.map +1 -0
- package/dist/client/{utils.js → utils.gen.js} +66 -122
- package/dist/client/utils.gen.js.map +1 -0
- package/dist/client.gen.d.ts +3 -3
- 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.d.ts → auth.gen.d.ts} +1 -1
- package/dist/core/auth.gen.d.ts.map +1 -0
- package/dist/core/{auth.js → auth.gen.js} +2 -1
- package/dist/core/auth.gen.js.map +1 -0
- package/dist/core/bodySerializer.gen.d.ts +26 -0
- package/dist/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/core/{bodySerializer.js → bodySerializer.gen.js} +6 -2
- package/dist/core/bodySerializer.gen.js.map +1 -0
- package/dist/core/{params.d.ts → params.gen.d.ts} +21 -1
- package/dist/core/params.gen.d.ts.map +1 -0
- package/dist/core/{params.js → params.gen.js} +24 -11
- package/dist/core/params.gen.js.map +1 -0
- package/dist/core/{pathSerializer.d.ts → pathSerializer.gen.d.ts} +1 -1
- package/dist/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/core/{pathSerializer.js → pathSerializer.gen.js} +5 -12
- package/dist/core/pathSerializer.gen.js.map +1 -0
- package/dist/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/core/queryKeySerializer.gen.js +93 -0
- package/dist/core/queryKeySerializer.gen.js.map +1 -0
- package/dist/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/core/serverSentEvents.gen.js +133 -0
- package/dist/core/serverSentEvents.gen.js.map +1 -0
- package/dist/core/{types.d.ts → types.gen.d.ts} +21 -16
- package/dist/core/types.gen.d.ts.map +1 -0
- package/dist/core/types.gen.js +3 -0
- package/dist/core/types.gen.js.map +1 -0
- package/dist/core/utils.gen.d.ts +20 -0
- package/dist/core/utils.gen.d.ts.map +1 -0
- package/dist/core/utils.gen.js +88 -0
- package/dist/core/utils.gen.js.map +1 -0
- package/dist/schemas.gen.d.ts +1764 -639
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +3159 -688
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +300 -161
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +423 -335
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +20 -20
- package/dist/types.gen.d.ts +1939 -841
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3947 -3751
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1478 -1151
- package/dist/zod.gen.js.map +1 -1
- package/package.json +28 -8
- package/dist/client/client.d.ts +0 -3
- package/dist/client/client.d.ts.map +0 -1
- package/dist/client/client.js +0 -144
- package/dist/client/client.js.map +0 -1
- package/dist/client/types.d.ts.map +0 -1
- package/dist/client/types.js +0 -2
- package/dist/client/types.js.map +0 -1
- package/dist/client/utils.d.ts.map +0 -1
- package/dist/client/utils.js.map +0 -1
- package/dist/core/auth.d.ts.map +0 -1
- package/dist/core/auth.js.map +0 -1
- package/dist/core/bodySerializer.d.ts +0 -18
- package/dist/core/bodySerializer.d.ts.map +0 -1
- package/dist/core/bodySerializer.js.map +0 -1
- package/dist/core/params.d.ts.map +0 -1
- package/dist/core/params.js.map +0 -1
- package/dist/core/pathSerializer.d.ts.map +0 -1
- package/dist/core/pathSerializer.js.map +0 -1
- package/dist/core/types.d.ts.map +0 -1
- package/dist/core/types.js +0 -2
- package/dist/core/types.js.map +0 -1
package/dist/schemas.gen.d.ts
CHANGED
|
@@ -1,6 +1,12 @@
|
|
|
1
1
|
export declare const BillingContactSchema: {
|
|
2
2
|
readonly type: "object";
|
|
3
3
|
readonly properties: {
|
|
4
|
+
readonly type: {
|
|
5
|
+
readonly type: "string";
|
|
6
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
7
|
+
readonly example: "business";
|
|
8
|
+
readonly enum: readonly ["business", "personal"];
|
|
9
|
+
};
|
|
4
10
|
readonly company: {
|
|
5
11
|
readonly type: "string";
|
|
6
12
|
readonly maxLength: 120;
|
|
@@ -57,15 +63,10 @@ export declare const BillingContactSchema: {
|
|
|
57
63
|
readonly description: "Email address used for billing as a string.";
|
|
58
64
|
readonly example: "email@example.com";
|
|
59
65
|
};
|
|
60
|
-
readonly
|
|
61
|
-
readonly type: "string";
|
|
62
|
-
readonly description: "First name of the billing contact person.";
|
|
63
|
-
readonly example: "John";
|
|
64
|
-
};
|
|
65
|
-
readonly last_name: {
|
|
66
|
+
readonly individual_name: {
|
|
66
67
|
readonly type: "string";
|
|
67
|
-
readonly description: "
|
|
68
|
-
readonly example: "Doe";
|
|
68
|
+
readonly description: "Name of the billing contact person.";
|
|
69
|
+
readonly example: "John Doe";
|
|
69
70
|
};
|
|
70
71
|
readonly tax_id: {
|
|
71
72
|
readonly type: "string";
|
|
@@ -81,7 +82,7 @@ export declare const BillingContactSchema: {
|
|
|
81
82
|
readonly enum: readonly ["ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "at_vat", "au_abn", "au_arn", "ba_tin", "bb_tin", "be_vat", "bg_uic", "bg_vat", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", "cy_vat", "cz_vat", "de_stn", "de_vat", "dk_vat", "do_rcn", "ec_ruc", "ee_vat", "eg_tin", "es_cif", "es_vat", "eu_oss_vat", "fi_vat", "fr_vat", "gb_vat", "ge_vat", "gn_nif", "gr_vat", "hk_br", "hr_oib", "hr_vat", "hu_tin", "hu_vat", "id_npwp", "ie_vat", "il_vat", "in_gst", "is_vat", "it_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kh_tin", "kr_brn", "kz_bin", "li_uid", "li_vat", "lt_vat", "lu_vat", "lv_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mt_vat", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "nl_vat", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "pl_vat", "pt_vat", "ro_tin", "ro_vat", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "se_vat", "sg_gst", "sg_uen", "si_tin", "si_vat", "sk_vat", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "xi_vat", "za_vat", "zm_tin", "zw_tin", ""];
|
|
82
83
|
};
|
|
83
84
|
};
|
|
84
|
-
readonly required: readonly ["
|
|
85
|
+
readonly required: readonly ["type", "email", "individual_name"];
|
|
85
86
|
readonly additionalProperties: false;
|
|
86
87
|
};
|
|
87
88
|
export declare const BillingCreditsSchema: {
|
|
@@ -92,10 +93,22 @@ export declare const BillingCreditsSchema: {
|
|
|
92
93
|
readonly description: "Generated unique identifier of the promotional code.";
|
|
93
94
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
94
95
|
};
|
|
95
|
-
readonly
|
|
96
|
+
readonly type: {
|
|
97
|
+
readonly type: "string";
|
|
98
|
+
readonly description: "Type of the promotional code.";
|
|
99
|
+
readonly example: "credit";
|
|
100
|
+
readonly enum: readonly ["credit", "discount"];
|
|
101
|
+
};
|
|
102
|
+
readonly date_start: {
|
|
103
|
+
readonly type: "string";
|
|
104
|
+
readonly format: "date-time";
|
|
105
|
+
readonly description: "Timestamp when the credit becomes active. ISO 8601 date string in the UTC timezone.";
|
|
106
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
107
|
+
};
|
|
108
|
+
readonly date_end: {
|
|
96
109
|
readonly type: "string";
|
|
97
110
|
readonly format: "date-time";
|
|
98
|
-
readonly description: "
|
|
111
|
+
readonly description: "Timestamp when the credit expires or becomes inactive. ISO 8601 date string in the UTC timezone.";
|
|
99
112
|
readonly example: "2023-12-20T13:53:32.000Z";
|
|
100
113
|
};
|
|
101
114
|
readonly code: {
|
|
@@ -108,40 +121,20 @@ export declare const BillingCreditsSchema: {
|
|
|
108
121
|
readonly description: "Description of the promotional code.";
|
|
109
122
|
readonly example: "10% off on all products";
|
|
110
123
|
};
|
|
111
|
-
readonly
|
|
112
|
-
readonly type: "array";
|
|
113
|
-
readonly items: {
|
|
114
|
-
readonly type: "string";
|
|
115
|
-
};
|
|
116
|
-
readonly description: "List of product SKUs that the promotional code can be used on.";
|
|
117
|
-
readonly example: readonly ["cfke_controlplane", "cfke_connected_nodes", "infra_compute", "infra_storage", "infra_loadbalancing", "infra_traffic", "cfcr_storage"];
|
|
118
|
-
};
|
|
119
|
-
readonly type: {
|
|
120
|
-
readonly type: "string";
|
|
121
|
-
readonly description: "Type of the promotional code.";
|
|
122
|
-
readonly example: "credit";
|
|
123
|
-
readonly enum: readonly ["credit", "discount"];
|
|
124
|
-
};
|
|
125
|
-
readonly value: {
|
|
124
|
+
readonly value_total: {
|
|
126
125
|
readonly type: "number";
|
|
127
126
|
readonly format: "float";
|
|
128
|
-
readonly description: "
|
|
127
|
+
readonly description: "Total value of the promotional code.";
|
|
129
128
|
readonly example: 10;
|
|
130
129
|
};
|
|
131
|
-
readonly billing_period: {
|
|
132
|
-
readonly type: "string";
|
|
133
|
-
readonly format: "date-time";
|
|
134
|
-
readonly description: "Date of the billing cycle. An ISO 8601 date string in the UTC timezone.";
|
|
135
|
-
readonly example: "2023-12-20T13:53:32.000Z";
|
|
136
|
-
};
|
|
137
130
|
readonly value_remaining: {
|
|
138
131
|
readonly type: "number";
|
|
139
132
|
readonly format: "float";
|
|
140
|
-
readonly description: "
|
|
141
|
-
readonly example:
|
|
133
|
+
readonly description: "Remaining value of the promotional code.";
|
|
134
|
+
readonly example: 8;
|
|
142
135
|
};
|
|
143
136
|
};
|
|
144
|
-
readonly required: readonly ["
|
|
137
|
+
readonly required: readonly ["type", "date_start", "code", "value_total"];
|
|
145
138
|
readonly additionalProperties: false;
|
|
146
139
|
};
|
|
147
140
|
export declare const ChartCreateInputSchema: {
|
|
@@ -224,9 +217,8 @@ export declare const ChartSchema: {
|
|
|
224
217
|
};
|
|
225
218
|
readonly status: {
|
|
226
219
|
readonly type: "string";
|
|
227
|
-
readonly description: "Status of the chart deployment.";
|
|
228
|
-
readonly example: "
|
|
229
|
-
readonly enum: readonly ["InstallSucceeded", "InstallFailed", "UpgradeSucceeded", "UpgradeFailed", "TestSucceeded", "TestFailed", "RollbackSucceeded", "RollbackFailed", "UninstallSucceeded", "UninstallFailed", "ArtifactFailed", "DependencyNotReady", "Progressing", "SourceNotReady"];
|
|
220
|
+
readonly description: "Status of the chart deployment (Flux HelmRelease Ready condition reason, e.g. InstallSucceeded, UpgradeFailed, Progressing).";
|
|
221
|
+
readonly example: "InstallSucceeded";
|
|
230
222
|
};
|
|
231
223
|
readonly version_current: {
|
|
232
224
|
readonly type: "string";
|
|
@@ -283,26 +275,103 @@ export declare const ClusterCreateInputSchema: {
|
|
|
283
275
|
readonly tier: {
|
|
284
276
|
readonly type: "string";
|
|
285
277
|
readonly description: "Tier of the cluster.";
|
|
278
|
+
readonly default: "basic";
|
|
286
279
|
readonly example: "pro";
|
|
287
|
-
readonly enum: readonly ["basic", "pro"];
|
|
288
|
-
};
|
|
289
|
-
readonly region: {
|
|
290
|
-
readonly type: "string";
|
|
291
|
-
readonly description: "Cloudfleet control plane region. One of \"staging\", \"northamerica-central-1\", \"europe-central-1a\". This field can not be updated after creation.";
|
|
292
|
-
readonly default: "staging";
|
|
293
|
-
readonly example: "northamerica-central-1";
|
|
294
|
-
readonly enum: readonly ["staging", "northamerica-central-1", "europe-central-1a"];
|
|
280
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
295
281
|
};
|
|
296
282
|
readonly version_channel: {
|
|
297
283
|
readonly type: "string";
|
|
298
284
|
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
299
285
|
readonly description: "Version of the kubernetes cluster.";
|
|
300
286
|
readonly default: "1.x.x-cfke.x";
|
|
301
|
-
readonly example: "1.
|
|
287
|
+
readonly example: "1.x.x-cfke.x";
|
|
288
|
+
};
|
|
289
|
+
readonly release_channel: {
|
|
290
|
+
readonly type: "string";
|
|
291
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
292
|
+
readonly default: "rapid";
|
|
293
|
+
readonly example: "rapid";
|
|
294
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
295
|
+
};
|
|
296
|
+
readonly features: {
|
|
297
|
+
readonly type: "object";
|
|
298
|
+
readonly properties: {
|
|
299
|
+
readonly gpu_sharing_strategy: {
|
|
300
|
+
readonly type: "string";
|
|
301
|
+
readonly description: "GPU sharing strategy.";
|
|
302
|
+
readonly default: "none";
|
|
303
|
+
readonly example: "none";
|
|
304
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
305
|
+
};
|
|
306
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
307
|
+
readonly type: "integer";
|
|
308
|
+
readonly minimum: 2;
|
|
309
|
+
readonly maximum: 48;
|
|
310
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
311
|
+
readonly default: 4;
|
|
312
|
+
readonly example: 10;
|
|
313
|
+
};
|
|
314
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
315
|
+
readonly type: "boolean";
|
|
316
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
317
|
+
readonly example: false;
|
|
318
|
+
};
|
|
319
|
+
};
|
|
320
|
+
readonly additionalProperties: false;
|
|
321
|
+
readonly description: "Cluster feature toggles.";
|
|
322
|
+
readonly default: {
|
|
323
|
+
readonly gpu_sharing_strategy: "none";
|
|
324
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
325
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
326
|
+
};
|
|
327
|
+
};
|
|
328
|
+
readonly region: {
|
|
329
|
+
readonly type: "string";
|
|
330
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
331
|
+
readonly example: "europe-central-1a";
|
|
332
|
+
};
|
|
333
|
+
readonly networking: {
|
|
334
|
+
readonly type: "object";
|
|
335
|
+
readonly properties: {
|
|
336
|
+
readonly pod_cidr: {
|
|
337
|
+
readonly type: "string";
|
|
338
|
+
readonly description: "CIDR block for pod IPs.";
|
|
339
|
+
readonly default: "10.244.0.0/16";
|
|
340
|
+
};
|
|
341
|
+
readonly service_cidr: {
|
|
342
|
+
readonly type: "string";
|
|
343
|
+
readonly description: "CIDR block for service IPs.";
|
|
344
|
+
readonly default: "10.96.0.0/12";
|
|
345
|
+
};
|
|
346
|
+
readonly dual_stack: {
|
|
347
|
+
readonly type: "boolean";
|
|
348
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
349
|
+
};
|
|
350
|
+
readonly pod_cidr_v6: {
|
|
351
|
+
readonly type: "string";
|
|
352
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
353
|
+
readonly default: "2001:db8:1:2::/48";
|
|
354
|
+
};
|
|
355
|
+
readonly service_cidr_v6: {
|
|
356
|
+
readonly type: "string";
|
|
357
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
358
|
+
readonly default: "2001:db8:1:1::/112";
|
|
359
|
+
};
|
|
360
|
+
};
|
|
361
|
+
readonly additionalProperties: false;
|
|
362
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
363
|
+
readonly default: {
|
|
364
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
365
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
366
|
+
readonly dual_stack: false;
|
|
367
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
368
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
369
|
+
};
|
|
302
370
|
};
|
|
303
371
|
};
|
|
304
|
-
readonly required: readonly ["name", "
|
|
372
|
+
readonly required: readonly ["name", "region"];
|
|
305
373
|
readonly additionalProperties: false;
|
|
374
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
306
375
|
};
|
|
307
376
|
export declare const ClusterJoinInformationSchema: {
|
|
308
377
|
readonly type: "object";
|
|
@@ -318,11 +387,26 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
318
387
|
readonly description: "Internal URL of the Kubernetes cluster control plane. This is the endpoint that kubelet uses to connect to the cluster.";
|
|
319
388
|
readonly example: "https://10.31.64.7:6443";
|
|
320
389
|
};
|
|
390
|
+
readonly cluster_dns: {
|
|
391
|
+
readonly type: "string";
|
|
392
|
+
readonly description: "Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.";
|
|
393
|
+
readonly example: "10.96.0.10";
|
|
394
|
+
};
|
|
395
|
+
readonly pod_cidr: {
|
|
396
|
+
readonly type: "string";
|
|
397
|
+
readonly description: "Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.";
|
|
398
|
+
readonly example: "10.244.0.0/16";
|
|
399
|
+
};
|
|
321
400
|
readonly auth_key: {
|
|
322
401
|
readonly type: "string";
|
|
323
402
|
readonly description: "Authentication key for the cluster.";
|
|
324
403
|
readonly example: "tskey-auth-kBV8wr1dk911CNTRL-...";
|
|
325
404
|
};
|
|
405
|
+
readonly login_server: {
|
|
406
|
+
readonly type: "string";
|
|
407
|
+
readonly description: "Coordination server the node registers against. Empty on data plane v1 clusters, where the node advertises its own tag instead. A non-empty value requires a client that declares the dataplane-v2 capability.";
|
|
408
|
+
readonly example: "https://415026b6-f00f-44f8-968d-fc6ef4d0fc6d.fabric.europe-central-1a.cfke.io";
|
|
409
|
+
};
|
|
326
410
|
readonly bootstrap_token: {
|
|
327
411
|
readonly type: "string";
|
|
328
412
|
readonly description: "Bootstrap token for the cluster.";
|
|
@@ -334,7 +418,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
334
418
|
readonly kubernetes: {
|
|
335
419
|
readonly type: "string";
|
|
336
420
|
readonly description: "Kubernetes version of the cluster.";
|
|
337
|
-
readonly example: "1.
|
|
421
|
+
readonly example: "1.33.7";
|
|
338
422
|
};
|
|
339
423
|
readonly tailscale: {
|
|
340
424
|
readonly type: "string";
|
|
@@ -380,7 +464,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
380
464
|
readonly description: "OIDC Information for hosts to access to third party API's.";
|
|
381
465
|
};
|
|
382
466
|
};
|
|
383
|
-
readonly required: readonly ["certificate_authority", "endpoint", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
467
|
+
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "pod_cidr", "auth_key", "login_server", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
384
468
|
readonly additionalProperties: false;
|
|
385
469
|
};
|
|
386
470
|
export declare const ClusterSchema: {
|
|
@@ -397,22 +481,100 @@ export declare const ClusterSchema: {
|
|
|
397
481
|
readonly tier: {
|
|
398
482
|
readonly type: "string";
|
|
399
483
|
readonly description: "Tier of the cluster.";
|
|
484
|
+
readonly default: "basic";
|
|
400
485
|
readonly example: "pro";
|
|
401
|
-
readonly enum: readonly ["basic", "pro"];
|
|
402
|
-
};
|
|
403
|
-
readonly region: {
|
|
404
|
-
readonly type: "string";
|
|
405
|
-
readonly description: "Cloudfleet control plane region. One of \"staging\", \"northamerica-central-1\", \"europe-central-1a\". This field can not be updated after creation.";
|
|
406
|
-
readonly default: "staging";
|
|
407
|
-
readonly example: "northamerica-central-1";
|
|
408
|
-
readonly enum: readonly ["staging", "northamerica-central-1", "europe-central-1a"];
|
|
486
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
409
487
|
};
|
|
410
488
|
readonly version_channel: {
|
|
411
489
|
readonly type: "string";
|
|
412
490
|
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
413
491
|
readonly description: "Version of the kubernetes cluster.";
|
|
414
492
|
readonly default: "1.x.x-cfke.x";
|
|
415
|
-
readonly example: "1.
|
|
493
|
+
readonly example: "1.x.x-cfke.x";
|
|
494
|
+
};
|
|
495
|
+
readonly release_channel: {
|
|
496
|
+
readonly type: "string";
|
|
497
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
498
|
+
readonly default: "rapid";
|
|
499
|
+
readonly example: "rapid";
|
|
500
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
501
|
+
};
|
|
502
|
+
readonly features: {
|
|
503
|
+
readonly type: "object";
|
|
504
|
+
readonly properties: {
|
|
505
|
+
readonly gpu_sharing_strategy: {
|
|
506
|
+
readonly type: "string";
|
|
507
|
+
readonly description: "GPU sharing strategy.";
|
|
508
|
+
readonly default: "none";
|
|
509
|
+
readonly example: "none";
|
|
510
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
511
|
+
};
|
|
512
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
513
|
+
readonly type: "integer";
|
|
514
|
+
readonly minimum: 2;
|
|
515
|
+
readonly maximum: 48;
|
|
516
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
517
|
+
readonly default: 4;
|
|
518
|
+
readonly example: 10;
|
|
519
|
+
};
|
|
520
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
521
|
+
readonly type: "boolean";
|
|
522
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
523
|
+
readonly example: false;
|
|
524
|
+
};
|
|
525
|
+
};
|
|
526
|
+
readonly required: readonly ["gpu_sharing_strategy", "gpu_max_shared_clients_per_gpu", "cilium_socket_lb_host_namespace_only"];
|
|
527
|
+
readonly additionalProperties: false;
|
|
528
|
+
readonly description: "Cluster feature toggles.";
|
|
529
|
+
readonly default: {
|
|
530
|
+
readonly gpu_sharing_strategy: "none";
|
|
531
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
532
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
533
|
+
};
|
|
534
|
+
};
|
|
535
|
+
readonly region: {
|
|
536
|
+
readonly type: "string";
|
|
537
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
538
|
+
readonly example: "europe-central-1a";
|
|
539
|
+
};
|
|
540
|
+
readonly networking: {
|
|
541
|
+
readonly type: "object";
|
|
542
|
+
readonly properties: {
|
|
543
|
+
readonly pod_cidr: {
|
|
544
|
+
readonly type: "string";
|
|
545
|
+
readonly description: "CIDR block for pod IPs.";
|
|
546
|
+
readonly default: "10.244.0.0/16";
|
|
547
|
+
};
|
|
548
|
+
readonly service_cidr: {
|
|
549
|
+
readonly type: "string";
|
|
550
|
+
readonly description: "CIDR block for service IPs.";
|
|
551
|
+
readonly default: "10.96.0.0/12";
|
|
552
|
+
};
|
|
553
|
+
readonly dual_stack: {
|
|
554
|
+
readonly type: "boolean";
|
|
555
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
556
|
+
};
|
|
557
|
+
readonly pod_cidr_v6: {
|
|
558
|
+
readonly type: "string";
|
|
559
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
560
|
+
readonly default: "2001:db8:1:2::/48";
|
|
561
|
+
};
|
|
562
|
+
readonly service_cidr_v6: {
|
|
563
|
+
readonly type: "string";
|
|
564
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
565
|
+
readonly default: "2001:db8:1:1::/112";
|
|
566
|
+
};
|
|
567
|
+
};
|
|
568
|
+
readonly required: readonly ["pod_cidr", "service_cidr", "dual_stack", "pod_cidr_v6", "service_cidr_v6"];
|
|
569
|
+
readonly additionalProperties: false;
|
|
570
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
571
|
+
readonly default: {
|
|
572
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
573
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
574
|
+
readonly dual_stack: false;
|
|
575
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
576
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
577
|
+
};
|
|
416
578
|
};
|
|
417
579
|
readonly id: {
|
|
418
580
|
readonly type: "string";
|
|
@@ -422,16 +584,27 @@ export declare const ClusterSchema: {
|
|
|
422
584
|
};
|
|
423
585
|
readonly status: {
|
|
424
586
|
readonly type: "string";
|
|
425
|
-
readonly description: "Status of the cluster.
|
|
426
|
-
readonly example: "
|
|
427
|
-
readonly enum: readonly ["
|
|
587
|
+
readonly description: "Status of the cluster.";
|
|
588
|
+
readonly example: "deployed";
|
|
589
|
+
readonly enum: readonly ["creating", "deployed", "updating", "disabled"];
|
|
428
590
|
};
|
|
429
591
|
readonly endpoint: {
|
|
430
592
|
readonly anyOf: readonly [{
|
|
431
593
|
readonly type: "string";
|
|
432
594
|
readonly format: "uri";
|
|
433
|
-
readonly description: "URL of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
434
|
-
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
595
|
+
readonly description: "URL signed by a public CA of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
596
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
597
|
+
}, {
|
|
598
|
+
readonly type: "string";
|
|
599
|
+
readonly enum: readonly [""];
|
|
600
|
+
}];
|
|
601
|
+
};
|
|
602
|
+
readonly endpoint_public: {
|
|
603
|
+
readonly anyOf: readonly [{
|
|
604
|
+
readonly type: "string";
|
|
605
|
+
readonly format: "uri";
|
|
606
|
+
readonly description: "Deprecated alias of `endpoint`; retained for backward compatibility.";
|
|
607
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
435
608
|
}, {
|
|
436
609
|
readonly type: "string";
|
|
437
610
|
readonly enum: readonly [""];
|
|
@@ -445,7 +618,7 @@ export declare const ClusterSchema: {
|
|
|
445
618
|
readonly version_current: {
|
|
446
619
|
readonly type: "string";
|
|
447
620
|
readonly description: "Current version of the cluster.";
|
|
448
|
-
readonly example: "1.
|
|
621
|
+
readonly example: "1.33.7-cfke.264";
|
|
449
622
|
};
|
|
450
623
|
readonly created_at: {
|
|
451
624
|
readonly type: "string";
|
|
@@ -463,8 +636,9 @@ export declare const ClusterSchema: {
|
|
|
463
636
|
readonly example: true;
|
|
464
637
|
};
|
|
465
638
|
};
|
|
466
|
-
readonly required: readonly ["name", "tier", "id", "status"];
|
|
639
|
+
readonly required: readonly ["name", "tier", "version_channel", "release_channel", "features", "region", "networking", "id", "status", "ready"];
|
|
467
640
|
readonly additionalProperties: false;
|
|
641
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
468
642
|
};
|
|
469
643
|
export declare const ClusterUpdateInputSchema: {
|
|
470
644
|
readonly type: "object";
|
|
@@ -480,18 +654,60 @@ export declare const ClusterUpdateInputSchema: {
|
|
|
480
654
|
readonly tier: {
|
|
481
655
|
readonly type: "string";
|
|
482
656
|
readonly description: "Tier of the cluster.";
|
|
657
|
+
readonly default: "basic";
|
|
483
658
|
readonly example: "pro";
|
|
484
|
-
readonly enum: readonly ["basic", "pro"];
|
|
659
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
485
660
|
};
|
|
486
661
|
readonly version_channel: {
|
|
487
662
|
readonly type: "string";
|
|
488
663
|
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
489
664
|
readonly description: "Version of the kubernetes cluster.";
|
|
490
|
-
readonly
|
|
665
|
+
readonly default: "1.x.x-cfke.x";
|
|
666
|
+
readonly example: "1.x.x-cfke.x";
|
|
667
|
+
};
|
|
668
|
+
readonly release_channel: {
|
|
669
|
+
readonly type: "string";
|
|
670
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
671
|
+
readonly default: "rapid";
|
|
672
|
+
readonly example: "rapid";
|
|
673
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
674
|
+
};
|
|
675
|
+
readonly features: {
|
|
676
|
+
readonly type: "object";
|
|
677
|
+
readonly properties: {
|
|
678
|
+
readonly gpu_sharing_strategy: {
|
|
679
|
+
readonly type: "string";
|
|
680
|
+
readonly description: "GPU sharing strategy.";
|
|
681
|
+
readonly default: "none";
|
|
682
|
+
readonly example: "none";
|
|
683
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
684
|
+
};
|
|
685
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
686
|
+
readonly type: "integer";
|
|
687
|
+
readonly minimum: 2;
|
|
688
|
+
readonly maximum: 48;
|
|
689
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
690
|
+
readonly default: 4;
|
|
691
|
+
readonly example: 10;
|
|
692
|
+
};
|
|
693
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
694
|
+
readonly type: "boolean";
|
|
695
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
696
|
+
readonly example: false;
|
|
697
|
+
};
|
|
698
|
+
};
|
|
699
|
+
readonly additionalProperties: false;
|
|
700
|
+
readonly description: "Cluster feature toggles.";
|
|
701
|
+
readonly default: {
|
|
702
|
+
readonly gpu_sharing_strategy: "none";
|
|
703
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
704
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
705
|
+
};
|
|
491
706
|
};
|
|
492
707
|
};
|
|
493
|
-
readonly required: readonly ["
|
|
708
|
+
readonly required: readonly ["name"];
|
|
494
709
|
readonly additionalProperties: false;
|
|
710
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
495
711
|
};
|
|
496
712
|
export declare const FleetCreateInputSchema: {
|
|
497
713
|
readonly type: "object";
|
|
@@ -500,13 +716,12 @@ export declare const FleetCreateInputSchema: {
|
|
|
500
716
|
readonly type: "object";
|
|
501
717
|
readonly properties: {
|
|
502
718
|
readonly cpu: {
|
|
503
|
-
readonly type: "
|
|
504
|
-
readonly format: "float";
|
|
719
|
+
readonly type: "integer";
|
|
505
720
|
readonly minimum: 0;
|
|
506
|
-
readonly
|
|
721
|
+
readonly maximum: 100000;
|
|
722
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
507
723
|
};
|
|
508
724
|
};
|
|
509
|
-
readonly required: readonly ["cpu"];
|
|
510
725
|
readonly additionalProperties: false;
|
|
511
726
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
512
727
|
};
|
|
@@ -515,14 +730,15 @@ export declare const FleetCreateInputSchema: {
|
|
|
515
730
|
readonly properties: {
|
|
516
731
|
readonly enabled: {
|
|
517
732
|
readonly type: "boolean";
|
|
518
|
-
readonly default: true;
|
|
519
733
|
};
|
|
520
734
|
readonly project: {
|
|
521
735
|
readonly type: "string";
|
|
522
|
-
readonly
|
|
736
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
737
|
+
readonly description: "GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.";
|
|
738
|
+
readonly example: "my-cloudfleet-project";
|
|
523
739
|
};
|
|
524
740
|
};
|
|
525
|
-
readonly required: readonly ["
|
|
741
|
+
readonly required: readonly ["enabled"];
|
|
526
742
|
readonly additionalProperties: false;
|
|
527
743
|
};
|
|
528
744
|
readonly hetzner: {
|
|
@@ -530,14 +746,16 @@ export declare const FleetCreateInputSchema: {
|
|
|
530
746
|
readonly properties: {
|
|
531
747
|
readonly enabled: {
|
|
532
748
|
readonly type: "boolean";
|
|
533
|
-
readonly default: true;
|
|
534
749
|
};
|
|
535
750
|
readonly apiKey: {
|
|
536
751
|
readonly type: "string";
|
|
537
|
-
readonly
|
|
752
|
+
readonly maxLength: 64;
|
|
753
|
+
readonly minLength: 64;
|
|
754
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
755
|
+
readonly description: "Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.";
|
|
538
756
|
};
|
|
539
757
|
};
|
|
540
|
-
readonly required: readonly ["
|
|
758
|
+
readonly required: readonly ["enabled"];
|
|
541
759
|
readonly additionalProperties: false;
|
|
542
760
|
};
|
|
543
761
|
readonly aws: {
|
|
@@ -545,15 +763,105 @@ export declare const FleetCreateInputSchema: {
|
|
|
545
763
|
readonly properties: {
|
|
546
764
|
readonly enabled: {
|
|
547
765
|
readonly type: "boolean";
|
|
548
|
-
readonly default: true;
|
|
549
766
|
};
|
|
550
767
|
readonly controllerRoleArn: {
|
|
551
768
|
readonly type: "string";
|
|
552
|
-
readonly
|
|
769
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
770
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
771
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
772
|
+
};
|
|
773
|
+
};
|
|
774
|
+
readonly required: readonly ["enabled"];
|
|
775
|
+
readonly additionalProperties: false;
|
|
776
|
+
};
|
|
777
|
+
readonly constraints: {
|
|
778
|
+
readonly type: "object";
|
|
779
|
+
readonly properties: {
|
|
780
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
781
|
+
readonly type: "array";
|
|
782
|
+
readonly items: {
|
|
783
|
+
readonly type: "string";
|
|
784
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
785
|
+
};
|
|
786
|
+
readonly minItems: 1;
|
|
787
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
788
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
789
|
+
};
|
|
790
|
+
readonly 'kubernetes.io/arch': {
|
|
791
|
+
readonly type: "array";
|
|
792
|
+
readonly items: {
|
|
793
|
+
readonly type: "string";
|
|
794
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
795
|
+
};
|
|
796
|
+
readonly minItems: 1;
|
|
797
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
798
|
+
readonly default: readonly ["amd64"];
|
|
799
|
+
};
|
|
800
|
+
readonly 'cfke.io/instance-family': {
|
|
801
|
+
readonly type: "array";
|
|
802
|
+
readonly items: {
|
|
803
|
+
readonly type: "string";
|
|
804
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
805
|
+
};
|
|
806
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
807
|
+
readonly default: readonly [];
|
|
808
|
+
};
|
|
809
|
+
readonly 'topology.kubernetes.io/region': {
|
|
810
|
+
readonly type: "array";
|
|
811
|
+
readonly items: {
|
|
812
|
+
readonly type: "string";
|
|
813
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
814
|
+
};
|
|
815
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
816
|
+
readonly default: readonly [];
|
|
553
817
|
};
|
|
554
818
|
};
|
|
555
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
556
819
|
readonly additionalProperties: false;
|
|
820
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
821
|
+
readonly default: {
|
|
822
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
823
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
824
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
825
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
826
|
+
};
|
|
827
|
+
};
|
|
828
|
+
readonly scalingProfile: {
|
|
829
|
+
readonly type: "string";
|
|
830
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
831
|
+
readonly default: "conservative";
|
|
832
|
+
readonly example: "conservative";
|
|
833
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
834
|
+
};
|
|
835
|
+
readonly taints: {
|
|
836
|
+
readonly type: "array";
|
|
837
|
+
readonly items: {
|
|
838
|
+
readonly type: "object";
|
|
839
|
+
readonly properties: {
|
|
840
|
+
readonly key: {
|
|
841
|
+
readonly type: "string";
|
|
842
|
+
readonly description: "Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.";
|
|
843
|
+
readonly example: "dedicated";
|
|
844
|
+
};
|
|
845
|
+
readonly value: {
|
|
846
|
+
readonly type: "string";
|
|
847
|
+
readonly maxLength: 63;
|
|
848
|
+
readonly pattern: "^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$";
|
|
849
|
+
readonly description: "Taint value. Optional.";
|
|
850
|
+
readonly example: "ci";
|
|
851
|
+
};
|
|
852
|
+
readonly effect: {
|
|
853
|
+
readonly type: "string";
|
|
854
|
+
readonly description: "Taint effect.";
|
|
855
|
+
readonly example: "NoSchedule";
|
|
856
|
+
readonly enum: readonly ["NoSchedule", "PreferNoSchedule", "NoExecute"];
|
|
857
|
+
};
|
|
858
|
+
};
|
|
859
|
+
readonly required: readonly ["key", "effect"];
|
|
860
|
+
readonly additionalProperties: false;
|
|
861
|
+
};
|
|
862
|
+
readonly maxItems: 50;
|
|
863
|
+
readonly description: "Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.";
|
|
864
|
+
readonly default: readonly [];
|
|
557
865
|
};
|
|
558
866
|
readonly id: {
|
|
559
867
|
readonly type: "string";
|
|
@@ -566,6 +874,7 @@ export declare const FleetCreateInputSchema: {
|
|
|
566
874
|
};
|
|
567
875
|
readonly required: readonly ["id"];
|
|
568
876
|
readonly additionalProperties: false;
|
|
877
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
569
878
|
};
|
|
570
879
|
export declare const FleetSchema: {
|
|
571
880
|
readonly type: "object";
|
|
@@ -574,13 +883,12 @@ export declare const FleetSchema: {
|
|
|
574
883
|
readonly type: "object";
|
|
575
884
|
readonly properties: {
|
|
576
885
|
readonly cpu: {
|
|
577
|
-
readonly type: "
|
|
578
|
-
readonly format: "float";
|
|
886
|
+
readonly type: "integer";
|
|
579
887
|
readonly minimum: 0;
|
|
580
|
-
readonly
|
|
888
|
+
readonly maximum: 100000;
|
|
889
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
581
890
|
};
|
|
582
891
|
};
|
|
583
|
-
readonly required: readonly ["cpu"];
|
|
584
892
|
readonly additionalProperties: false;
|
|
585
893
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
586
894
|
};
|
|
@@ -589,14 +897,15 @@ export declare const FleetSchema: {
|
|
|
589
897
|
readonly properties: {
|
|
590
898
|
readonly enabled: {
|
|
591
899
|
readonly type: "boolean";
|
|
592
|
-
readonly default: true;
|
|
593
900
|
};
|
|
594
901
|
readonly project: {
|
|
595
902
|
readonly type: "string";
|
|
596
|
-
readonly
|
|
903
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
904
|
+
readonly description: "GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.";
|
|
905
|
+
readonly example: "my-cloudfleet-project";
|
|
597
906
|
};
|
|
598
907
|
};
|
|
599
|
-
readonly required: readonly ["
|
|
908
|
+
readonly required: readonly ["enabled"];
|
|
600
909
|
readonly additionalProperties: false;
|
|
601
910
|
};
|
|
602
911
|
readonly hetzner: {
|
|
@@ -604,14 +913,14 @@ export declare const FleetSchema: {
|
|
|
604
913
|
readonly properties: {
|
|
605
914
|
readonly enabled: {
|
|
606
915
|
readonly type: "boolean";
|
|
607
|
-
readonly default: true;
|
|
608
916
|
};
|
|
609
917
|
readonly apiKey: {
|
|
610
918
|
readonly type: "string";
|
|
611
|
-
readonly
|
|
919
|
+
readonly pattern: "^\\*{64}$";
|
|
920
|
+
readonly description: "Redacted Hetzner API token. Returned as 64 asterisks when a token is configured; omitted otherwise. The real value is never echoed by the API.";
|
|
612
921
|
};
|
|
613
922
|
};
|
|
614
|
-
readonly required: readonly ["
|
|
923
|
+
readonly required: readonly ["enabled"];
|
|
615
924
|
readonly additionalProperties: false;
|
|
616
925
|
};
|
|
617
926
|
readonly aws: {
|
|
@@ -619,16 +928,107 @@ export declare const FleetSchema: {
|
|
|
619
928
|
readonly properties: {
|
|
620
929
|
readonly enabled: {
|
|
621
930
|
readonly type: "boolean";
|
|
622
|
-
readonly default: true;
|
|
623
931
|
};
|
|
624
932
|
readonly controllerRoleArn: {
|
|
625
933
|
readonly type: "string";
|
|
626
|
-
readonly
|
|
934
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
935
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
936
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
627
937
|
};
|
|
628
938
|
};
|
|
629
|
-
readonly required: readonly ["
|
|
939
|
+
readonly required: readonly ["enabled"];
|
|
630
940
|
readonly additionalProperties: false;
|
|
631
941
|
};
|
|
942
|
+
readonly constraints: {
|
|
943
|
+
readonly type: "object";
|
|
944
|
+
readonly properties: {
|
|
945
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
946
|
+
readonly type: "array";
|
|
947
|
+
readonly items: {
|
|
948
|
+
readonly type: "string";
|
|
949
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
950
|
+
};
|
|
951
|
+
readonly minItems: 1;
|
|
952
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
953
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
954
|
+
};
|
|
955
|
+
readonly 'kubernetes.io/arch': {
|
|
956
|
+
readonly type: "array";
|
|
957
|
+
readonly items: {
|
|
958
|
+
readonly type: "string";
|
|
959
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
960
|
+
};
|
|
961
|
+
readonly minItems: 1;
|
|
962
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
963
|
+
readonly default: readonly ["amd64"];
|
|
964
|
+
};
|
|
965
|
+
readonly 'cfke.io/instance-family': {
|
|
966
|
+
readonly type: "array";
|
|
967
|
+
readonly items: {
|
|
968
|
+
readonly type: "string";
|
|
969
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
970
|
+
};
|
|
971
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
972
|
+
readonly default: readonly [];
|
|
973
|
+
};
|
|
974
|
+
readonly 'topology.kubernetes.io/region': {
|
|
975
|
+
readonly type: "array";
|
|
976
|
+
readonly items: {
|
|
977
|
+
readonly type: "string";
|
|
978
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
979
|
+
};
|
|
980
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
981
|
+
readonly default: readonly [];
|
|
982
|
+
};
|
|
983
|
+
};
|
|
984
|
+
readonly required: readonly ["karpenter.sh/capacity-type", "kubernetes.io/arch"];
|
|
985
|
+
readonly additionalProperties: false;
|
|
986
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
987
|
+
readonly default: {
|
|
988
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
989
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
990
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
991
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
992
|
+
};
|
|
993
|
+
};
|
|
994
|
+
readonly scalingProfile: {
|
|
995
|
+
readonly type: "string";
|
|
996
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
997
|
+
readonly default: "conservative";
|
|
998
|
+
readonly example: "conservative";
|
|
999
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
1000
|
+
};
|
|
1001
|
+
readonly taints: {
|
|
1002
|
+
readonly type: "array";
|
|
1003
|
+
readonly items: {
|
|
1004
|
+
readonly type: "object";
|
|
1005
|
+
readonly properties: {
|
|
1006
|
+
readonly key: {
|
|
1007
|
+
readonly type: "string";
|
|
1008
|
+
readonly description: "Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.";
|
|
1009
|
+
readonly example: "dedicated";
|
|
1010
|
+
};
|
|
1011
|
+
readonly value: {
|
|
1012
|
+
readonly type: "string";
|
|
1013
|
+
readonly maxLength: 63;
|
|
1014
|
+
readonly pattern: "^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$";
|
|
1015
|
+
readonly description: "Taint value. Optional.";
|
|
1016
|
+
readonly example: "ci";
|
|
1017
|
+
};
|
|
1018
|
+
readonly effect: {
|
|
1019
|
+
readonly type: "string";
|
|
1020
|
+
readonly description: "Taint effect.";
|
|
1021
|
+
readonly example: "NoSchedule";
|
|
1022
|
+
readonly enum: readonly ["NoSchedule", "PreferNoSchedule", "NoExecute"];
|
|
1023
|
+
};
|
|
1024
|
+
};
|
|
1025
|
+
readonly required: readonly ["key", "effect"];
|
|
1026
|
+
readonly additionalProperties: false;
|
|
1027
|
+
};
|
|
1028
|
+
readonly maxItems: 50;
|
|
1029
|
+
readonly description: "Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.";
|
|
1030
|
+
readonly default: readonly [];
|
|
1031
|
+
};
|
|
632
1032
|
readonly id: {
|
|
633
1033
|
readonly type: "string";
|
|
634
1034
|
readonly maxLength: 63;
|
|
@@ -637,9 +1037,30 @@ export declare const FleetSchema: {
|
|
|
637
1037
|
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
638
1038
|
readonly example: "new-clouds-fleet";
|
|
639
1039
|
};
|
|
1040
|
+
readonly ready: {
|
|
1041
|
+
readonly type: "boolean";
|
|
1042
|
+
readonly description: "Indicates whether the fleet configuration is healthy.";
|
|
1043
|
+
readonly example: true;
|
|
1044
|
+
};
|
|
1045
|
+
readonly status_message: {
|
|
1046
|
+
readonly type: "string";
|
|
1047
|
+
readonly description: "Human-readable reason the fleet is not ready. Present only when `ready` is false.";
|
|
1048
|
+
readonly example: "Invalid provider permissions.";
|
|
1049
|
+
};
|
|
1050
|
+
readonly created_at: {
|
|
1051
|
+
readonly type: "string";
|
|
1052
|
+
readonly description: "Creation date and time of the fleet.";
|
|
1053
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
1054
|
+
};
|
|
1055
|
+
readonly updated_at: {
|
|
1056
|
+
readonly type: "string";
|
|
1057
|
+
readonly description: "Date and time the fleet was last updated.";
|
|
1058
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
1059
|
+
};
|
|
640
1060
|
};
|
|
641
|
-
readonly required: readonly ["id"];
|
|
1061
|
+
readonly required: readonly ["constraints", "scalingProfile", "taints", "id", "ready", "created_at", "updated_at"];
|
|
642
1062
|
readonly additionalProperties: false;
|
|
1063
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
643
1064
|
};
|
|
644
1065
|
export declare const FleetUpdateInputSchema: {
|
|
645
1066
|
readonly type: "object";
|
|
@@ -648,13 +1069,12 @@ export declare const FleetUpdateInputSchema: {
|
|
|
648
1069
|
readonly type: "object";
|
|
649
1070
|
readonly properties: {
|
|
650
1071
|
readonly cpu: {
|
|
651
|
-
readonly type: "
|
|
652
|
-
readonly format: "float";
|
|
1072
|
+
readonly type: "integer";
|
|
653
1073
|
readonly minimum: 0;
|
|
654
|
-
readonly
|
|
1074
|
+
readonly maximum: 100000;
|
|
1075
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
655
1076
|
};
|
|
656
1077
|
};
|
|
657
|
-
readonly required: readonly ["cpu"];
|
|
658
1078
|
readonly additionalProperties: false;
|
|
659
1079
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
660
1080
|
};
|
|
@@ -663,14 +1083,15 @@ export declare const FleetUpdateInputSchema: {
|
|
|
663
1083
|
readonly properties: {
|
|
664
1084
|
readonly enabled: {
|
|
665
1085
|
readonly type: "boolean";
|
|
666
|
-
readonly default: true;
|
|
667
1086
|
};
|
|
668
1087
|
readonly project: {
|
|
669
1088
|
readonly type: "string";
|
|
670
|
-
readonly
|
|
1089
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
1090
|
+
readonly description: "GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.";
|
|
1091
|
+
readonly example: "my-cloudfleet-project";
|
|
671
1092
|
};
|
|
672
1093
|
};
|
|
673
|
-
readonly required: readonly ["
|
|
1094
|
+
readonly required: readonly ["enabled"];
|
|
674
1095
|
readonly additionalProperties: false;
|
|
675
1096
|
};
|
|
676
1097
|
readonly hetzner: {
|
|
@@ -678,14 +1099,16 @@ export declare const FleetUpdateInputSchema: {
|
|
|
678
1099
|
readonly properties: {
|
|
679
1100
|
readonly enabled: {
|
|
680
1101
|
readonly type: "boolean";
|
|
681
|
-
readonly default: true;
|
|
682
1102
|
};
|
|
683
1103
|
readonly apiKey: {
|
|
684
1104
|
readonly type: "string";
|
|
685
|
-
readonly
|
|
1105
|
+
readonly maxLength: 64;
|
|
1106
|
+
readonly minLength: 64;
|
|
1107
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
1108
|
+
readonly description: "Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.";
|
|
686
1109
|
};
|
|
687
1110
|
};
|
|
688
|
-
readonly required: readonly ["
|
|
1111
|
+
readonly required: readonly ["enabled"];
|
|
689
1112
|
readonly additionalProperties: false;
|
|
690
1113
|
};
|
|
691
1114
|
readonly aws: {
|
|
@@ -693,18 +1116,129 @@ export declare const FleetUpdateInputSchema: {
|
|
|
693
1116
|
readonly properties: {
|
|
694
1117
|
readonly enabled: {
|
|
695
1118
|
readonly type: "boolean";
|
|
696
|
-
readonly default: true;
|
|
697
1119
|
};
|
|
698
1120
|
readonly controllerRoleArn: {
|
|
699
1121
|
readonly type: "string";
|
|
700
|
-
readonly
|
|
1122
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
1123
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
1124
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
701
1125
|
};
|
|
702
1126
|
};
|
|
703
|
-
readonly required: readonly ["
|
|
1127
|
+
readonly required: readonly ["enabled"];
|
|
704
1128
|
readonly additionalProperties: false;
|
|
705
1129
|
};
|
|
706
|
-
|
|
707
|
-
|
|
1130
|
+
readonly constraints: {
|
|
1131
|
+
readonly type: "object";
|
|
1132
|
+
readonly properties: {
|
|
1133
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
1134
|
+
readonly type: "array";
|
|
1135
|
+
readonly items: {
|
|
1136
|
+
readonly type: "string";
|
|
1137
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
1138
|
+
};
|
|
1139
|
+
readonly minItems: 1;
|
|
1140
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
1141
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
1142
|
+
};
|
|
1143
|
+
readonly 'kubernetes.io/arch': {
|
|
1144
|
+
readonly type: "array";
|
|
1145
|
+
readonly items: {
|
|
1146
|
+
readonly type: "string";
|
|
1147
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
1148
|
+
};
|
|
1149
|
+
readonly minItems: 1;
|
|
1150
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
1151
|
+
readonly default: readonly ["amd64"];
|
|
1152
|
+
};
|
|
1153
|
+
readonly 'cfke.io/instance-family': {
|
|
1154
|
+
readonly type: "array";
|
|
1155
|
+
readonly items: {
|
|
1156
|
+
readonly type: "string";
|
|
1157
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
1158
|
+
};
|
|
1159
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
1160
|
+
readonly default: readonly [];
|
|
1161
|
+
};
|
|
1162
|
+
readonly 'topology.kubernetes.io/region': {
|
|
1163
|
+
readonly type: "array";
|
|
1164
|
+
readonly items: {
|
|
1165
|
+
readonly type: "string";
|
|
1166
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
1167
|
+
};
|
|
1168
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
1169
|
+
readonly default: readonly [];
|
|
1170
|
+
};
|
|
1171
|
+
};
|
|
1172
|
+
readonly additionalProperties: false;
|
|
1173
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
1174
|
+
readonly default: {
|
|
1175
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
1176
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
1177
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
1178
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
1179
|
+
};
|
|
1180
|
+
};
|
|
1181
|
+
readonly scalingProfile: {
|
|
1182
|
+
readonly type: "string";
|
|
1183
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
1184
|
+
readonly default: "conservative";
|
|
1185
|
+
readonly example: "conservative";
|
|
1186
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
1187
|
+
};
|
|
1188
|
+
readonly taints: {
|
|
1189
|
+
readonly type: "array";
|
|
1190
|
+
readonly items: {
|
|
1191
|
+
readonly type: "object";
|
|
1192
|
+
readonly properties: {
|
|
1193
|
+
readonly key: {
|
|
1194
|
+
readonly type: "string";
|
|
1195
|
+
readonly description: "Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.";
|
|
1196
|
+
readonly example: "dedicated";
|
|
1197
|
+
};
|
|
1198
|
+
readonly value: {
|
|
1199
|
+
readonly type: "string";
|
|
1200
|
+
readonly maxLength: 63;
|
|
1201
|
+
readonly pattern: "^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$";
|
|
1202
|
+
readonly description: "Taint value. Optional.";
|
|
1203
|
+
readonly example: "ci";
|
|
1204
|
+
};
|
|
1205
|
+
readonly effect: {
|
|
1206
|
+
readonly type: "string";
|
|
1207
|
+
readonly description: "Taint effect.";
|
|
1208
|
+
readonly example: "NoSchedule";
|
|
1209
|
+
readonly enum: readonly ["NoSchedule", "PreferNoSchedule", "NoExecute"];
|
|
1210
|
+
};
|
|
1211
|
+
};
|
|
1212
|
+
readonly required: readonly ["key", "effect"];
|
|
1213
|
+
readonly additionalProperties: false;
|
|
1214
|
+
};
|
|
1215
|
+
readonly maxItems: 50;
|
|
1216
|
+
readonly description: "Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.";
|
|
1217
|
+
readonly default: readonly [];
|
|
1218
|
+
};
|
|
1219
|
+
};
|
|
1220
|
+
readonly additionalProperties: false;
|
|
1221
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
1222
|
+
};
|
|
1223
|
+
export declare const InviteCreateInputSchema: {
|
|
1224
|
+
readonly type: "object";
|
|
1225
|
+
readonly properties: {
|
|
1226
|
+
readonly email: {
|
|
1227
|
+
readonly type: "string";
|
|
1228
|
+
readonly format: "email";
|
|
1229
|
+
readonly description: "Email address of the user to invite.";
|
|
1230
|
+
readonly example: "email@example.com";
|
|
1231
|
+
};
|
|
1232
|
+
readonly role: {
|
|
1233
|
+
readonly type: "string";
|
|
1234
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1235
|
+
readonly default: "User";
|
|
1236
|
+
readonly example: "User";
|
|
1237
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1238
|
+
};
|
|
1239
|
+
};
|
|
1240
|
+
readonly required: readonly ["email"];
|
|
1241
|
+
readonly additionalProperties: false;
|
|
708
1242
|
};
|
|
709
1243
|
export declare const InviteSchema: {
|
|
710
1244
|
readonly type: "object";
|
|
@@ -737,439 +1271,340 @@ export declare const InviteSchema: {
|
|
|
737
1271
|
readonly description: "Generated unique invite code.";
|
|
738
1272
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
739
1273
|
};
|
|
1274
|
+
readonly role: {
|
|
1275
|
+
readonly type: "string";
|
|
1276
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1277
|
+
readonly default: "User";
|
|
1278
|
+
readonly example: "User";
|
|
1279
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1280
|
+
};
|
|
740
1281
|
};
|
|
741
1282
|
readonly required: readonly ["date_created"];
|
|
742
1283
|
readonly additionalProperties: false;
|
|
743
1284
|
};
|
|
744
|
-
export declare const
|
|
1285
|
+
export declare const InvoicePaymentAttemptSchema: {
|
|
745
1286
|
readonly type: "object";
|
|
746
1287
|
readonly properties: {
|
|
747
|
-
readonly
|
|
1288
|
+
readonly invoice_id: {
|
|
748
1289
|
readonly type: "string";
|
|
749
|
-
readonly
|
|
750
|
-
readonly
|
|
751
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
752
|
-
};
|
|
753
|
-
readonly organizationId: {
|
|
754
|
-
readonly type: "string";
|
|
755
|
-
readonly format: "uuid";
|
|
756
|
-
readonly description: "Unique identifier of the organization. UUID v4 string in canonical form";
|
|
757
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
1290
|
+
readonly description: "Identifier of the invoice.";
|
|
1291
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
758
1292
|
};
|
|
759
|
-
readonly
|
|
1293
|
+
readonly number: {
|
|
760
1294
|
readonly type: "string";
|
|
761
|
-
readonly
|
|
762
|
-
readonly
|
|
763
|
-
readonly
|
|
1295
|
+
readonly nullable: true;
|
|
1296
|
+
readonly description: "Invoice number. Null if the invoice has no number.";
|
|
1297
|
+
readonly example: "CF-0042";
|
|
764
1298
|
};
|
|
765
1299
|
readonly amount: {
|
|
766
1300
|
readonly type: "number";
|
|
767
1301
|
readonly format: "float";
|
|
768
|
-
readonly description: "
|
|
769
|
-
readonly example:
|
|
1302
|
+
readonly description: "Amount outstanding when the charge was attempted, in the smallest currency unit.";
|
|
1303
|
+
readonly example: 4200;
|
|
770
1304
|
};
|
|
771
1305
|
readonly currency: {
|
|
772
1306
|
readonly type: "string";
|
|
773
|
-
readonly description: "Currency of the invoice";
|
|
774
|
-
readonly example: "
|
|
775
|
-
readonly enum: readonly ["AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD", "BTC"];
|
|
776
|
-
};
|
|
777
|
-
readonly creditAdj: {
|
|
778
|
-
readonly type: "number";
|
|
779
|
-
readonly format: "float";
|
|
780
|
-
readonly description: "Total amount of credit adjustments";
|
|
781
|
-
readonly example: 0;
|
|
1307
|
+
readonly description: "Currency of the invoice.";
|
|
1308
|
+
readonly example: "eur";
|
|
782
1309
|
};
|
|
783
|
-
readonly
|
|
784
|
-
readonly type: "
|
|
785
|
-
readonly
|
|
786
|
-
readonly
|
|
787
|
-
readonly
|
|
1310
|
+
readonly status: {
|
|
1311
|
+
readonly type: "string";
|
|
1312
|
+
readonly description: "Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).";
|
|
1313
|
+
readonly example: "paid";
|
|
1314
|
+
readonly enum: readonly ["paid", "processing", "requires_action", "failed"];
|
|
788
1315
|
};
|
|
789
|
-
readonly
|
|
1316
|
+
readonly client_secret: {
|
|
790
1317
|
readonly type: "string";
|
|
791
|
-
readonly
|
|
792
|
-
readonly
|
|
1318
|
+
readonly nullable: true;
|
|
1319
|
+
readonly description: "Client secret used to complete customer authentication. Set only when `status` is `requires_action`.";
|
|
1320
|
+
readonly example: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH";
|
|
793
1321
|
};
|
|
794
|
-
readonly
|
|
1322
|
+
readonly failure_code: {
|
|
795
1323
|
readonly type: "string";
|
|
796
|
-
readonly
|
|
797
|
-
readonly
|
|
1324
|
+
readonly nullable: true;
|
|
1325
|
+
readonly description: "Decline code. Set only when `status` is `failed`.";
|
|
1326
|
+
readonly example: "insufficient_funds";
|
|
798
1327
|
};
|
|
799
|
-
readonly
|
|
1328
|
+
readonly failure_message: {
|
|
800
1329
|
readonly type: "string";
|
|
801
|
-
readonly
|
|
802
|
-
readonly
|
|
1330
|
+
readonly nullable: true;
|
|
1331
|
+
readonly description: "Explanation of the decline, suitable for display. Set only when `status` is `failed`.";
|
|
1332
|
+
readonly example: "Your card has insufficient funds.";
|
|
803
1333
|
};
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
|
|
1334
|
+
};
|
|
1335
|
+
readonly required: readonly ["invoice_id", "number", "amount", "currency", "status", "client_secret", "failure_code", "failure_message"];
|
|
1336
|
+
readonly additionalProperties: false;
|
|
1337
|
+
};
|
|
1338
|
+
export declare const InvoicePaymentResultSchema: {
|
|
1339
|
+
readonly type: "object";
|
|
1340
|
+
readonly properties: {
|
|
1341
|
+
readonly code: {
|
|
1342
|
+
readonly type: "string";
|
|
1343
|
+
readonly description: "Overall outcome: `paid` (nothing outstanding), `processing` (all accepted, not yet settled), `action_required` (one or more await customer authentication), `partially_paid`, `failed`, `nothing_due`, or `bank_transfer_due` (the organization pays by bank transfer; nothing was charged).";
|
|
1344
|
+
readonly example: "partially_paid";
|
|
1345
|
+
readonly enum: readonly ["paid", "processing", "action_required", "partially_paid", "failed", "nothing_due", "bank_transfer_due"];
|
|
809
1346
|
};
|
|
810
|
-
readonly
|
|
1347
|
+
readonly message: {
|
|
811
1348
|
readonly type: "string";
|
|
812
|
-
readonly description: "
|
|
813
|
-
readonly example: "
|
|
1349
|
+
readonly description: "Summary of the outcome, suitable for display.";
|
|
1350
|
+
readonly example: "1 of 2 open invoices was paid. Invoice CF-0043 was declined: Your card has insufficient funds.";
|
|
814
1351
|
};
|
|
815
|
-
readonly
|
|
1352
|
+
readonly results: {
|
|
816
1353
|
readonly type: "array";
|
|
817
1354
|
readonly items: {
|
|
818
1355
|
readonly type: "object";
|
|
819
1356
|
readonly properties: {
|
|
820
|
-
readonly
|
|
821
|
-
readonly type: "string";
|
|
822
|
-
readonly format: "uuid";
|
|
823
|
-
readonly description: "Unique identifier of the invoice item. UUID v4 string in canonical form";
|
|
824
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
825
|
-
};
|
|
826
|
-
readonly linkedInvoiceItemId: {
|
|
827
|
-
readonly type: "string";
|
|
828
|
-
readonly format: "uuid";
|
|
829
|
-
readonly description: "Unique identifier of the linked invoice item. UUID v4 string in canonical form";
|
|
830
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
831
|
-
};
|
|
832
|
-
readonly productName: {
|
|
833
|
-
readonly type: "string";
|
|
834
|
-
readonly description: "Name of the product";
|
|
835
|
-
readonly example: "Research team";
|
|
836
|
-
};
|
|
837
|
-
readonly planName: {
|
|
838
|
-
readonly type: "string";
|
|
839
|
-
readonly description: "Name of the plan";
|
|
840
|
-
readonly example: "Plan A";
|
|
841
|
-
};
|
|
842
|
-
readonly phaseName: {
|
|
843
|
-
readonly type: "string";
|
|
844
|
-
readonly description: "Name of the phase";
|
|
845
|
-
readonly example: "Phase A";
|
|
846
|
-
};
|
|
847
|
-
readonly usageName: {
|
|
1357
|
+
readonly invoice_id: {
|
|
848
1358
|
readonly type: "string";
|
|
849
|
-
readonly description: "
|
|
850
|
-
readonly example: "
|
|
1359
|
+
readonly description: "Identifier of the invoice.";
|
|
1360
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
851
1361
|
};
|
|
852
|
-
readonly
|
|
1362
|
+
readonly number: {
|
|
853
1363
|
readonly type: "string";
|
|
854
|
-
readonly description: "
|
|
855
|
-
readonly example: "
|
|
856
|
-
};
|
|
857
|
-
readonly prettyPlanName: {
|
|
858
|
-
readonly type: "string";
|
|
859
|
-
readonly description: "Pretty name of the plan";
|
|
860
|
-
readonly example: "Plan A";
|
|
861
|
-
};
|
|
862
|
-
readonly prettyPhaseName: {
|
|
863
|
-
readonly type: "string";
|
|
864
|
-
readonly description: "Pretty name of the phase";
|
|
865
|
-
readonly example: "Phase A";
|
|
866
|
-
};
|
|
867
|
-
readonly prettyUsageName: {
|
|
868
|
-
readonly type: "string";
|
|
869
|
-
readonly description: "Pretty name of the usage";
|
|
870
|
-
readonly example: "Usage A";
|
|
871
|
-
};
|
|
872
|
-
readonly itemType: {
|
|
873
|
-
readonly type: "string";
|
|
874
|
-
readonly description: "Type of the invoice item";
|
|
875
|
-
readonly example: "EXTERNAL_CHARGE";
|
|
876
|
-
readonly enum: readonly ["EXTERNAL_CHARGE", "FIXED", "RECURRING", "REPAIR_ADJ", "CBA_ADJ", "CREDIT_ADJ", "ITEM_ADJ", "USAGE", "TAX", "PARENT_SUMMARY"];
|
|
877
|
-
};
|
|
878
|
-
readonly description: {
|
|
879
|
-
readonly type: "string";
|
|
880
|
-
readonly description: "Description of the invoice item";
|
|
881
|
-
readonly example: "Description of the invoice item";
|
|
882
|
-
};
|
|
883
|
-
readonly startDate: {
|
|
884
|
-
readonly type: "string";
|
|
885
|
-
readonly description: "Start date of the invoice item";
|
|
886
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
887
|
-
};
|
|
888
|
-
readonly endDate: {
|
|
889
|
-
readonly type: "string";
|
|
890
|
-
readonly description: "End date of the invoice item";
|
|
891
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
1364
|
+
readonly description: "Invoice number. Null if the invoice has no number.";
|
|
1365
|
+
readonly example: "CF-0042";
|
|
892
1366
|
};
|
|
893
1367
|
readonly amount: {
|
|
894
1368
|
readonly type: "number";
|
|
895
1369
|
readonly format: "float";
|
|
896
|
-
readonly description: "Amount
|
|
897
|
-
readonly example:
|
|
898
|
-
};
|
|
899
|
-
readonly rate: {
|
|
900
|
-
readonly type: "number";
|
|
901
|
-
readonly format: "float";
|
|
902
|
-
readonly description: "Rate of the invoice item";
|
|
903
|
-
readonly example: 100;
|
|
1370
|
+
readonly description: "Amount outstanding when the charge was attempted, in the smallest currency unit.";
|
|
1371
|
+
readonly example: 4200;
|
|
904
1372
|
};
|
|
905
1373
|
readonly currency: {
|
|
906
1374
|
readonly type: "string";
|
|
907
|
-
readonly description: "Currency of the invoice
|
|
908
|
-
readonly example: "
|
|
909
|
-
readonly enum: readonly ["AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD", "BTC"];
|
|
910
|
-
};
|
|
911
|
-
readonly quantity: {
|
|
912
|
-
readonly type: "number";
|
|
913
|
-
readonly format: "float";
|
|
914
|
-
readonly description: "Quantity of the invoice item";
|
|
915
|
-
readonly example: 1;
|
|
916
|
-
};
|
|
917
|
-
readonly itemDetails: {
|
|
918
|
-
readonly type: "string";
|
|
919
|
-
readonly description: "Details of the invoice item";
|
|
920
|
-
readonly example: "Details of the invoice item";
|
|
921
|
-
};
|
|
922
|
-
readonly catalogEffectiveDate: {
|
|
923
|
-
readonly type: "string";
|
|
924
|
-
readonly description: "Effective date of the catalog";
|
|
925
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
926
|
-
};
|
|
927
|
-
readonly childItems: {
|
|
928
|
-
readonly type: "array";
|
|
929
|
-
readonly items: {
|
|
930
|
-
readonly oneOf: readonly [{
|
|
931
|
-
readonly type: "array";
|
|
932
|
-
}, {
|
|
933
|
-
readonly type: "boolean";
|
|
934
|
-
}, {
|
|
935
|
-
readonly type: "number";
|
|
936
|
-
}, {
|
|
937
|
-
readonly type: "object";
|
|
938
|
-
readonly additionalProperties: true;
|
|
939
|
-
}, {
|
|
940
|
-
readonly type: "string";
|
|
941
|
-
}];
|
|
942
|
-
};
|
|
943
|
-
readonly description: "Child items of the invoice item";
|
|
944
|
-
};
|
|
945
|
-
};
|
|
946
|
-
readonly additionalProperties: false;
|
|
947
|
-
};
|
|
948
|
-
readonly description: "Credits of the invoice";
|
|
949
|
-
};
|
|
950
|
-
readonly items: {
|
|
951
|
-
readonly type: "array";
|
|
952
|
-
readonly items: {
|
|
953
|
-
readonly type: "object";
|
|
954
|
-
readonly properties: {
|
|
955
|
-
readonly id: {
|
|
956
|
-
readonly type: "string";
|
|
957
|
-
readonly format: "uuid";
|
|
958
|
-
readonly description: "Unique identifier of the invoice item. UUID v4 string in canonical form";
|
|
959
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
960
|
-
};
|
|
961
|
-
readonly linkedInvoiceItemId: {
|
|
962
|
-
readonly type: "string";
|
|
963
|
-
readonly format: "uuid";
|
|
964
|
-
readonly description: "Unique identifier of the linked invoice item. UUID v4 string in canonical form";
|
|
965
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
966
|
-
};
|
|
967
|
-
readonly productName: {
|
|
968
|
-
readonly type: "string";
|
|
969
|
-
readonly description: "Name of the product";
|
|
970
|
-
readonly example: "Research team";
|
|
971
|
-
};
|
|
972
|
-
readonly planName: {
|
|
973
|
-
readonly type: "string";
|
|
974
|
-
readonly description: "Name of the plan";
|
|
975
|
-
readonly example: "Plan A";
|
|
976
|
-
};
|
|
977
|
-
readonly phaseName: {
|
|
978
|
-
readonly type: "string";
|
|
979
|
-
readonly description: "Name of the phase";
|
|
980
|
-
readonly example: "Phase A";
|
|
981
|
-
};
|
|
982
|
-
readonly usageName: {
|
|
983
|
-
readonly type: "string";
|
|
984
|
-
readonly description: "Name of the usage";
|
|
985
|
-
readonly example: "Usage A";
|
|
986
|
-
};
|
|
987
|
-
readonly prettyProductName: {
|
|
988
|
-
readonly type: "string";
|
|
989
|
-
readonly description: "Pretty name of the product";
|
|
990
|
-
readonly example: "Research team";
|
|
991
|
-
};
|
|
992
|
-
readonly prettyPlanName: {
|
|
993
|
-
readonly type: "string";
|
|
994
|
-
readonly description: "Pretty name of the plan";
|
|
995
|
-
readonly example: "Plan A";
|
|
996
|
-
};
|
|
997
|
-
readonly prettyPhaseName: {
|
|
998
|
-
readonly type: "string";
|
|
999
|
-
readonly description: "Pretty name of the phase";
|
|
1000
|
-
readonly example: "Phase A";
|
|
1001
|
-
};
|
|
1002
|
-
readonly prettyUsageName: {
|
|
1003
|
-
readonly type: "string";
|
|
1004
|
-
readonly description: "Pretty name of the usage";
|
|
1005
|
-
readonly example: "Usage A";
|
|
1006
|
-
};
|
|
1007
|
-
readonly itemType: {
|
|
1008
|
-
readonly type: "string";
|
|
1009
|
-
readonly description: "Type of the invoice item";
|
|
1010
|
-
readonly example: "EXTERNAL_CHARGE";
|
|
1011
|
-
readonly enum: readonly ["EXTERNAL_CHARGE", "FIXED", "RECURRING", "REPAIR_ADJ", "CBA_ADJ", "CREDIT_ADJ", "ITEM_ADJ", "USAGE", "TAX", "PARENT_SUMMARY"];
|
|
1012
|
-
};
|
|
1013
|
-
readonly description: {
|
|
1014
|
-
readonly type: "string";
|
|
1015
|
-
readonly description: "Description of the invoice item";
|
|
1016
|
-
readonly example: "Description of the invoice item";
|
|
1017
|
-
};
|
|
1018
|
-
readonly startDate: {
|
|
1019
|
-
readonly type: "string";
|
|
1020
|
-
readonly description: "Start date of the invoice item";
|
|
1021
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
1375
|
+
readonly description: "Currency of the invoice.";
|
|
1376
|
+
readonly example: "eur";
|
|
1022
1377
|
};
|
|
1023
|
-
readonly
|
|
1378
|
+
readonly status: {
|
|
1024
1379
|
readonly type: "string";
|
|
1025
|
-
readonly description: "
|
|
1026
|
-
readonly example: "
|
|
1027
|
-
|
|
1028
|
-
readonly amount: {
|
|
1029
|
-
readonly type: "number";
|
|
1030
|
-
readonly format: "float";
|
|
1031
|
-
readonly description: "Amount of the invoice item";
|
|
1032
|
-
readonly example: 100;
|
|
1033
|
-
};
|
|
1034
|
-
readonly rate: {
|
|
1035
|
-
readonly type: "number";
|
|
1036
|
-
readonly format: "float";
|
|
1037
|
-
readonly description: "Rate of the invoice item";
|
|
1038
|
-
readonly example: 100;
|
|
1380
|
+
readonly description: "Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).";
|
|
1381
|
+
readonly example: "paid";
|
|
1382
|
+
readonly enum: readonly ["paid", "processing", "requires_action", "failed"];
|
|
1039
1383
|
};
|
|
1040
|
-
readonly
|
|
1384
|
+
readonly client_secret: {
|
|
1041
1385
|
readonly type: "string";
|
|
1042
|
-
readonly description: "
|
|
1043
|
-
readonly example: "
|
|
1044
|
-
readonly enum: readonly ["AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD", "BTC"];
|
|
1045
|
-
};
|
|
1046
|
-
readonly quantity: {
|
|
1047
|
-
readonly type: "number";
|
|
1048
|
-
readonly format: "float";
|
|
1049
|
-
readonly description: "Quantity of the invoice item";
|
|
1050
|
-
readonly example: 1;
|
|
1386
|
+
readonly description: "Client secret used to complete customer authentication. Set only when `status` is `requires_action`.";
|
|
1387
|
+
readonly example: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH";
|
|
1051
1388
|
};
|
|
1052
|
-
readonly
|
|
1389
|
+
readonly failure_code: {
|
|
1053
1390
|
readonly type: "string";
|
|
1054
|
-
readonly description: "
|
|
1055
|
-
readonly example: "
|
|
1391
|
+
readonly description: "Decline code. Set only when `status` is `failed`.";
|
|
1392
|
+
readonly example: "insufficient_funds";
|
|
1056
1393
|
};
|
|
1057
|
-
readonly
|
|
1394
|
+
readonly failure_message: {
|
|
1058
1395
|
readonly type: "string";
|
|
1059
|
-
readonly description: "
|
|
1060
|
-
readonly example: "
|
|
1061
|
-
};
|
|
1062
|
-
readonly childItems: {
|
|
1063
|
-
readonly type: "array";
|
|
1064
|
-
readonly items: {
|
|
1065
|
-
readonly oneOf: readonly [{
|
|
1066
|
-
readonly type: "array";
|
|
1067
|
-
}, {
|
|
1068
|
-
readonly type: "boolean";
|
|
1069
|
-
}, {
|
|
1070
|
-
readonly type: "number";
|
|
1071
|
-
}, {
|
|
1072
|
-
readonly type: "object";
|
|
1073
|
-
readonly additionalProperties: true;
|
|
1074
|
-
}, {
|
|
1075
|
-
readonly type: "string";
|
|
1076
|
-
}];
|
|
1077
|
-
};
|
|
1078
|
-
readonly description: "Child items of the invoice item";
|
|
1396
|
+
readonly description: "Explanation of the decline, suitable for display. Set only when `status` is `failed`.";
|
|
1397
|
+
readonly example: "Your card has insufficient funds.";
|
|
1079
1398
|
};
|
|
1080
1399
|
};
|
|
1400
|
+
readonly required: readonly ["invoice_id", "number", "amount", "currency", "status", "client_secret", "failure_code", "failure_message"];
|
|
1081
1401
|
readonly additionalProperties: false;
|
|
1082
1402
|
};
|
|
1083
|
-
readonly description: "
|
|
1403
|
+
readonly description: "One entry per invoice charged, oldest first.";
|
|
1084
1404
|
};
|
|
1085
1405
|
};
|
|
1406
|
+
readonly required: readonly ["code", "message", "results"];
|
|
1086
1407
|
readonly additionalProperties: false;
|
|
1087
1408
|
};
|
|
1088
|
-
export declare const
|
|
1409
|
+
export declare const InvoiceSchema: {
|
|
1089
1410
|
readonly type: "object";
|
|
1090
1411
|
readonly properties: {
|
|
1091
1412
|
readonly id: {
|
|
1092
1413
|
readonly type: "string";
|
|
1093
|
-
readonly
|
|
1094
|
-
readonly
|
|
1095
|
-
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
1096
|
-
readonly description: "Id of the chart listing";
|
|
1097
|
-
readonly example: "portworx-enterprise-disaster-recovery-baremetal";
|
|
1414
|
+
readonly description: "Unique identifier of the invoice.";
|
|
1415
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
1098
1416
|
};
|
|
1099
|
-
readonly
|
|
1417
|
+
readonly number: {
|
|
1100
1418
|
readonly type: "string";
|
|
1101
|
-
readonly description: "Name of the chart listing";
|
|
1102
|
-
readonly example: "Portworx Enterprise + Disaster Recovery - Baremetal";
|
|
1103
1419
|
};
|
|
1104
|
-
readonly
|
|
1420
|
+
readonly status: {
|
|
1105
1421
|
readonly type: "string";
|
|
1106
|
-
readonly description: "
|
|
1107
|
-
readonly example: "
|
|
1422
|
+
readonly description: "Status of the invoice";
|
|
1423
|
+
readonly example: "paid";
|
|
1108
1424
|
};
|
|
1109
|
-
readonly
|
|
1425
|
+
readonly total: {
|
|
1426
|
+
readonly type: "number";
|
|
1427
|
+
readonly format: "float";
|
|
1428
|
+
readonly description: "Total amount of the invoice";
|
|
1429
|
+
readonly example: 100;
|
|
1430
|
+
};
|
|
1431
|
+
readonly currency: {
|
|
1432
|
+
readonly type: "string";
|
|
1433
|
+
readonly description: "Currency of the invoice";
|
|
1434
|
+
readonly example: "usd";
|
|
1435
|
+
};
|
|
1436
|
+
readonly created: {
|
|
1437
|
+
readonly type: "string";
|
|
1438
|
+
readonly format: "date-time";
|
|
1439
|
+
readonly description: "Timestamp when the invoice was issued. ISO 8601 date string in the UTC timezone.";
|
|
1440
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
1441
|
+
};
|
|
1442
|
+
readonly period_start: {
|
|
1443
|
+
readonly type: "string";
|
|
1444
|
+
readonly format: "date-time";
|
|
1445
|
+
readonly description: "Billing period start timestamp. ISO 8601 date string in the UTC timezone.";
|
|
1446
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
1447
|
+
};
|
|
1448
|
+
readonly period_end: {
|
|
1449
|
+
readonly type: "string";
|
|
1450
|
+
readonly format: "date-time";
|
|
1451
|
+
readonly description: "Billing period end timestamp. ISO 8601 date string in the UTC timezone.";
|
|
1452
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
1453
|
+
};
|
|
1454
|
+
readonly invoice_pdf: {
|
|
1455
|
+
readonly type: "string";
|
|
1456
|
+
};
|
|
1457
|
+
};
|
|
1458
|
+
readonly required: readonly ["created", "period_start", "period_end"];
|
|
1459
|
+
readonly additionalProperties: false;
|
|
1460
|
+
};
|
|
1461
|
+
export declare const MarketplaceListingFilesSchema: {
|
|
1462
|
+
readonly type: "object";
|
|
1463
|
+
readonly properties: {
|
|
1464
|
+
readonly chartYaml: {
|
|
1465
|
+
readonly type: "string";
|
|
1466
|
+
readonly description: "Raw Chart.yaml content from the Helm chart";
|
|
1467
|
+
readonly example: "apiVersion: v2\nname: nginx-ingress\nversion: 1.18.2-cfke.45\nappVersion: 1.9.4";
|
|
1468
|
+
};
|
|
1469
|
+
readonly valuesYaml: {
|
|
1110
1470
|
readonly type: "string";
|
|
1111
|
-
readonly description: "
|
|
1112
|
-
readonly example: "
|
|
1471
|
+
readonly description: "Raw values.yaml content from the Helm chart";
|
|
1472
|
+
readonly example: "replicaCount: 1\nimage:\n repository: nginx\n tag: latest";
|
|
1113
1473
|
};
|
|
1114
|
-
readonly
|
|
1474
|
+
readonly valuesSchemaJson: {
|
|
1115
1475
|
readonly type: "string";
|
|
1116
|
-
readonly description: "
|
|
1117
|
-
readonly example: "
|
|
1476
|
+
readonly description: "JSON schema for values.yaml as a string";
|
|
1477
|
+
readonly example: "{\"type\":\"object\",\"properties\":{\"replicaCount\":{\"type\":\"number\"}}}";
|
|
1118
1478
|
};
|
|
1119
|
-
|
|
1479
|
+
};
|
|
1480
|
+
readonly additionalProperties: false;
|
|
1481
|
+
};
|
|
1482
|
+
export declare const MarketplaceListingSchema: {
|
|
1483
|
+
readonly type: "object";
|
|
1484
|
+
readonly properties: {
|
|
1485
|
+
readonly name: {
|
|
1120
1486
|
readonly type: "string";
|
|
1121
|
-
readonly description: "
|
|
1122
|
-
readonly example: "
|
|
1487
|
+
readonly description: "Name of the chart";
|
|
1488
|
+
readonly example: "nginx-ingress";
|
|
1123
1489
|
};
|
|
1124
|
-
readonly
|
|
1490
|
+
readonly versions: {
|
|
1125
1491
|
readonly type: "array";
|
|
1126
1492
|
readonly items: {
|
|
1127
1493
|
readonly type: "string";
|
|
1128
|
-
readonly
|
|
1494
|
+
readonly pattern: "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
1495
|
+
readonly description: "Specific version of the chart";
|
|
1496
|
+
readonly example: "1.18.2-cfke.45";
|
|
1129
1497
|
};
|
|
1130
|
-
readonly description: "
|
|
1498
|
+
readonly description: "Available versions of the chart";
|
|
1131
1499
|
};
|
|
1132
1500
|
readonly version_channels: {
|
|
1133
1501
|
readonly type: "array";
|
|
1134
1502
|
readonly items: {
|
|
1135
1503
|
readonly type: "string";
|
|
1136
1504
|
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
1137
|
-
readonly description: "Version
|
|
1138
|
-
readonly example: "
|
|
1505
|
+
readonly description: "Version channel pattern";
|
|
1506
|
+
readonly example: "1.18.x-cfke.x";
|
|
1139
1507
|
};
|
|
1508
|
+
readonly description: "Version channels for the chart";
|
|
1140
1509
|
};
|
|
1141
|
-
readonly
|
|
1142
|
-
readonly type: "
|
|
1143
|
-
readonly
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
|
|
1150
|
-
|
|
1151
|
-
|
|
1152
|
-
readonly
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
|
-
|
|
1156
|
-
readonly
|
|
1157
|
-
|
|
1158
|
-
|
|
1159
|
-
|
|
1510
|
+
readonly latestVersion: {
|
|
1511
|
+
readonly type: "string";
|
|
1512
|
+
readonly description: "Latest version of the chart";
|
|
1513
|
+
readonly example: "1.18.2-cfke.45";
|
|
1514
|
+
};
|
|
1515
|
+
readonly metadata: {
|
|
1516
|
+
readonly type: "object";
|
|
1517
|
+
readonly properties: {
|
|
1518
|
+
readonly name: {
|
|
1519
|
+
readonly type: "string";
|
|
1520
|
+
readonly description: "Chart name from metadata";
|
|
1521
|
+
readonly example: "nginx-ingress";
|
|
1522
|
+
};
|
|
1523
|
+
readonly version: {
|
|
1524
|
+
readonly type: "string";
|
|
1525
|
+
readonly description: "Chart version from metadata";
|
|
1526
|
+
readonly example: "1.18.2-cfke.45";
|
|
1527
|
+
};
|
|
1528
|
+
readonly description: {
|
|
1529
|
+
readonly type: "string";
|
|
1530
|
+
readonly description: "Chart description";
|
|
1531
|
+
readonly example: "NGINX Ingress Controller for Kubernetes";
|
|
1532
|
+
};
|
|
1533
|
+
readonly appVersion: {
|
|
1534
|
+
readonly type: "string";
|
|
1535
|
+
readonly description: "Application version";
|
|
1536
|
+
readonly example: "1.9.4";
|
|
1537
|
+
};
|
|
1538
|
+
readonly apiVersion: {
|
|
1539
|
+
readonly type: "string";
|
|
1540
|
+
readonly description: "Helm API version";
|
|
1541
|
+
readonly example: "v2";
|
|
1542
|
+
};
|
|
1543
|
+
readonly keywords: {
|
|
1544
|
+
readonly type: "array";
|
|
1545
|
+
readonly items: {
|
|
1546
|
+
readonly type: "string";
|
|
1160
1547
|
};
|
|
1548
|
+
readonly description: "Chart keywords";
|
|
1549
|
+
readonly example: readonly ["ingress", "nginx", "load-balancer"];
|
|
1550
|
+
};
|
|
1551
|
+
readonly home: {
|
|
1552
|
+
readonly type: "string";
|
|
1553
|
+
readonly description: "Chart home URL";
|
|
1554
|
+
readonly example: "https://kubernetes.github.io/ingress-nginx/";
|
|
1555
|
+
};
|
|
1556
|
+
readonly icon: {
|
|
1557
|
+
readonly type: "string";
|
|
1558
|
+
readonly description: "A URL to an SVG or PNG image to be used as an icon";
|
|
1559
|
+
readonly example: "https://cloudfleet.ai/images/marketplace/icons/ingress-nginx.png";
|
|
1560
|
+
};
|
|
1561
|
+
readonly sources: {
|
|
1562
|
+
readonly type: "array";
|
|
1563
|
+
readonly items: {
|
|
1564
|
+
readonly type: "string";
|
|
1565
|
+
};
|
|
1566
|
+
readonly description: "Chart source URLs";
|
|
1567
|
+
readonly example: readonly ["https://github.com/kubernetes/ingress-nginx"];
|
|
1568
|
+
};
|
|
1569
|
+
readonly maintainers: {
|
|
1570
|
+
readonly type: "array";
|
|
1571
|
+
readonly items: {
|
|
1572
|
+
readonly type: "object";
|
|
1573
|
+
readonly properties: {
|
|
1574
|
+
readonly name: {
|
|
1575
|
+
readonly type: "string";
|
|
1576
|
+
readonly description: "Maintainer name";
|
|
1577
|
+
readonly example: "NGINX Team";
|
|
1578
|
+
};
|
|
1579
|
+
readonly email: {
|
|
1580
|
+
readonly type: "string";
|
|
1581
|
+
readonly description: "Maintainer email";
|
|
1582
|
+
readonly example: "support@nginx.org";
|
|
1583
|
+
};
|
|
1584
|
+
};
|
|
1585
|
+
readonly required: readonly ["name"];
|
|
1586
|
+
readonly additionalProperties: false;
|
|
1587
|
+
};
|
|
1588
|
+
readonly description: "Chart maintainers";
|
|
1161
1589
|
};
|
|
1162
|
-
readonly required: readonly ["version", "schema", "placeholder"];
|
|
1163
|
-
readonly additionalProperties: false;
|
|
1164
1590
|
};
|
|
1591
|
+
readonly required: readonly ["name", "version"];
|
|
1592
|
+
readonly additionalProperties: false;
|
|
1593
|
+
readonly description: "Chart metadata";
|
|
1165
1594
|
};
|
|
1166
1595
|
};
|
|
1167
|
-
readonly required: readonly ["
|
|
1596
|
+
readonly required: readonly ["name", "versions", "version_channels", "latestVersion"];
|
|
1168
1597
|
readonly additionalProperties: false;
|
|
1169
1598
|
};
|
|
1170
1599
|
export declare const OrganizationCreateInputSchema: {
|
|
1171
1600
|
readonly type: "object";
|
|
1172
1601
|
readonly properties: {
|
|
1602
|
+
readonly type: {
|
|
1603
|
+
readonly type: "string";
|
|
1604
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1605
|
+
readonly example: "business";
|
|
1606
|
+
readonly enum: readonly ["business", "personal"];
|
|
1607
|
+
};
|
|
1173
1608
|
readonly email: {
|
|
1174
1609
|
readonly type: "string";
|
|
1175
1610
|
readonly format: "email";
|
|
@@ -1178,11 +1613,13 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
1178
1613
|
};
|
|
1179
1614
|
readonly first_name: {
|
|
1180
1615
|
readonly type: "string";
|
|
1616
|
+
readonly minLength: 1;
|
|
1181
1617
|
readonly description: "First name of the billing contact person.";
|
|
1182
1618
|
readonly example: "John";
|
|
1183
1619
|
};
|
|
1184
1620
|
readonly last_name: {
|
|
1185
1621
|
readonly type: "string";
|
|
1622
|
+
readonly minLength: 1;
|
|
1186
1623
|
readonly description: "Last name of the billing contact person.";
|
|
1187
1624
|
readonly example: "Doe";
|
|
1188
1625
|
};
|
|
@@ -1200,7 +1637,19 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
1200
1637
|
readonly description: "Password for the root account. Must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one number and one special character.";
|
|
1201
1638
|
};
|
|
1202
1639
|
};
|
|
1203
|
-
readonly required: readonly ["email", "first_name", "last_name", "company_name", "password"];
|
|
1640
|
+
readonly required: readonly ["type", "email", "first_name", "last_name", "company_name", "password"];
|
|
1641
|
+
readonly additionalProperties: false;
|
|
1642
|
+
};
|
|
1643
|
+
export declare const OrganizationCreateOutputSchema: {
|
|
1644
|
+
readonly type: "object";
|
|
1645
|
+
readonly properties: {
|
|
1646
|
+
readonly id: {
|
|
1647
|
+
readonly type: "string";
|
|
1648
|
+
readonly description: "Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.";
|
|
1649
|
+
readonly example: "organization-id";
|
|
1650
|
+
};
|
|
1651
|
+
};
|
|
1652
|
+
readonly required: readonly ["id"];
|
|
1204
1653
|
readonly additionalProperties: false;
|
|
1205
1654
|
};
|
|
1206
1655
|
export declare const OrganizationSchema: {
|
|
@@ -1212,155 +1661,789 @@ export declare const OrganizationSchema: {
|
|
|
1212
1661
|
readonly description: "Unique identifier of the organization. UUID v4 string in canonical form";
|
|
1213
1662
|
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1214
1663
|
};
|
|
1215
|
-
readonly name: {
|
|
1664
|
+
readonly name: {
|
|
1665
|
+
readonly type: "string";
|
|
1666
|
+
readonly maxLength: 120;
|
|
1667
|
+
readonly minLength: 2;
|
|
1668
|
+
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
1669
|
+
readonly example: "ACME Corp.";
|
|
1670
|
+
};
|
|
1671
|
+
readonly type: {
|
|
1672
|
+
readonly type: "string";
|
|
1673
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1674
|
+
readonly example: "business";
|
|
1675
|
+
readonly enum: readonly ["business", "personal"];
|
|
1676
|
+
};
|
|
1677
|
+
readonly date_created: {
|
|
1678
|
+
readonly type: "string";
|
|
1679
|
+
readonly format: "date-time";
|
|
1680
|
+
readonly description: "Creation date of the organization. ISO 8601 date string in UTC timezone";
|
|
1681
|
+
readonly example: "2023-11-02T16:08:14.338Z";
|
|
1682
|
+
};
|
|
1683
|
+
readonly quota: {
|
|
1684
|
+
readonly type: "object";
|
|
1685
|
+
readonly properties: {
|
|
1686
|
+
readonly basic_clusters_max: {
|
|
1687
|
+
readonly type: "integer";
|
|
1688
|
+
readonly minimum: 0;
|
|
1689
|
+
readonly description: "Maximum number of Basic clusters that can be created.";
|
|
1690
|
+
readonly example: 999;
|
|
1691
|
+
};
|
|
1692
|
+
readonly basic_clusters_available: {
|
|
1693
|
+
readonly type: "integer";
|
|
1694
|
+
readonly description: "Available number of Basic clusters that can be created.";
|
|
1695
|
+
readonly example: 999;
|
|
1696
|
+
};
|
|
1697
|
+
readonly pro_clusters_max: {
|
|
1698
|
+
readonly type: "integer";
|
|
1699
|
+
readonly minimum: 0;
|
|
1700
|
+
readonly description: "Maximum number of Pro clusters that can be created.";
|
|
1701
|
+
readonly example: 999;
|
|
1702
|
+
};
|
|
1703
|
+
readonly pro_clusters_available: {
|
|
1704
|
+
readonly type: "integer";
|
|
1705
|
+
readonly description: "Available number of Pro clusters that can be created.";
|
|
1706
|
+
readonly example: 999;
|
|
1707
|
+
};
|
|
1708
|
+
readonly enterprise_clusters_max: {
|
|
1709
|
+
readonly type: "integer";
|
|
1710
|
+
readonly minimum: 0;
|
|
1711
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1712
|
+
readonly example: 999;
|
|
1713
|
+
};
|
|
1714
|
+
readonly enterprise_clusters_available: {
|
|
1715
|
+
readonly type: "integer";
|
|
1716
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1717
|
+
readonly example: 999;
|
|
1718
|
+
};
|
|
1719
|
+
readonly fleets_max: {
|
|
1720
|
+
readonly type: "integer";
|
|
1721
|
+
readonly minimum: 0;
|
|
1722
|
+
readonly description: "Maximum number of fleets that can be created per cluster.";
|
|
1723
|
+
readonly example: 999;
|
|
1724
|
+
};
|
|
1725
|
+
readonly cluster_tiers: {
|
|
1726
|
+
readonly type: "array";
|
|
1727
|
+
readonly items: {
|
|
1728
|
+
readonly type: "string";
|
|
1729
|
+
readonly example: "basic";
|
|
1730
|
+
};
|
|
1731
|
+
readonly minItems: 0;
|
|
1732
|
+
readonly description: "List of Cloudfleet cluster tiers available for the organization.";
|
|
1733
|
+
};
|
|
1734
|
+
readonly regions: {
|
|
1735
|
+
readonly type: "array";
|
|
1736
|
+
readonly items: {
|
|
1737
|
+
readonly type: "string";
|
|
1738
|
+
readonly example: "northamerica-central-1a";
|
|
1739
|
+
};
|
|
1740
|
+
readonly minItems: 1;
|
|
1741
|
+
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
1742
|
+
};
|
|
1743
|
+
readonly versions: {
|
|
1744
|
+
readonly type: "array";
|
|
1745
|
+
readonly items: {
|
|
1746
|
+
readonly type: "object";
|
|
1747
|
+
readonly properties: {
|
|
1748
|
+
readonly id: {
|
|
1749
|
+
readonly type: "string";
|
|
1750
|
+
readonly description: "Id of the control plane version. Used in API calls.";
|
|
1751
|
+
readonly example: "1.33.x-cfke.x";
|
|
1752
|
+
};
|
|
1753
|
+
readonly label: {
|
|
1754
|
+
readonly type: "string";
|
|
1755
|
+
readonly description: "Label of the control plane version. Used in frontent UI.";
|
|
1756
|
+
readonly example: "1.33.x (Always latest 1.33 patch version)";
|
|
1757
|
+
};
|
|
1758
|
+
};
|
|
1759
|
+
readonly required: readonly ["id", "label"];
|
|
1760
|
+
readonly additionalProperties: false;
|
|
1761
|
+
};
|
|
1762
|
+
readonly minItems: 1;
|
|
1763
|
+
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1764
|
+
};
|
|
1765
|
+
readonly cfcr_storage_gb: {
|
|
1766
|
+
readonly type: "integer";
|
|
1767
|
+
readonly minimum: -1;
|
|
1768
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1769
|
+
readonly example: 500;
|
|
1770
|
+
};
|
|
1771
|
+
};
|
|
1772
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "enterprise_clusters_max", "enterprise_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1773
|
+
readonly additionalProperties: false;
|
|
1774
|
+
readonly description: "For security reasons, platform quota is controlled by Cloudfleet and can be updated only by Cloudfleet administrators. Please open a support ticket if you need to change the platform quota.";
|
|
1775
|
+
};
|
|
1776
|
+
readonly status: {
|
|
1777
|
+
readonly type: "string";
|
|
1778
|
+
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1779
|
+
readonly enum: readonly ["active", "closed", "suspended"];
|
|
1780
|
+
};
|
|
1781
|
+
readonly verification: {
|
|
1782
|
+
readonly type: "string";
|
|
1783
|
+
readonly description: "Verification status of the organization, which determines the assigned quota. `none` when billing information is incomplete, `submitted` when billing information is complete but the organization is not yet verified, `verified` when the organization is verified.";
|
|
1784
|
+
readonly example: "verified";
|
|
1785
|
+
readonly enum: readonly ["none", "submitted", "verified"];
|
|
1786
|
+
};
|
|
1787
|
+
};
|
|
1788
|
+
readonly required: readonly ["id", "type", "date_created", "quota", "status", "verification"];
|
|
1789
|
+
readonly additionalProperties: false;
|
|
1790
|
+
};
|
|
1791
|
+
export declare const PaymentMethodSchema: {
|
|
1792
|
+
readonly type: "object";
|
|
1793
|
+
readonly properties: {
|
|
1794
|
+
readonly id: {
|
|
1795
|
+
readonly type: "string";
|
|
1796
|
+
readonly description: "Payment method identifier. Stripe payment method id for cards/SEPA; the constant `bank_transfer` for the invoice/bank-transfer method. Used to set as default or delete the payment method.";
|
|
1797
|
+
readonly example: "pm_1MtwBwLkdIwHu7ix28a3tqPa";
|
|
1798
|
+
};
|
|
1799
|
+
readonly type: {
|
|
1800
|
+
readonly type: "string";
|
|
1801
|
+
readonly description: "Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.";
|
|
1802
|
+
readonly example: "card";
|
|
1803
|
+
readonly enum: readonly ["card", "sepa_debit", "bank_transfer"];
|
|
1804
|
+
};
|
|
1805
|
+
readonly last4: {
|
|
1806
|
+
readonly type: "string";
|
|
1807
|
+
readonly nullable: true;
|
|
1808
|
+
readonly description: "Last 4 digits of the payment card number, of the bank account (IBAN) for SEPA Direct Debit, or of the destination IBAN for bank transfer.";
|
|
1809
|
+
readonly example: "4242";
|
|
1810
|
+
};
|
|
1811
|
+
readonly exp_month: {
|
|
1812
|
+
readonly type: "integer";
|
|
1813
|
+
readonly minimum: 1;
|
|
1814
|
+
readonly maximum: 12;
|
|
1815
|
+
readonly nullable: true;
|
|
1816
|
+
readonly description: "Two-digit number representing the card's expiration month. Null for SEPA Direct Debit and bank transfer.";
|
|
1817
|
+
readonly example: 12;
|
|
1818
|
+
};
|
|
1819
|
+
readonly exp_year: {
|
|
1820
|
+
readonly type: "integer";
|
|
1821
|
+
readonly nullable: true;
|
|
1822
|
+
readonly description: "Four-digit number representing the card's expiration year. May be in the past for an expired card still on file. Null for SEPA Direct Debit and bank transfer.";
|
|
1823
|
+
readonly example: 2028;
|
|
1824
|
+
};
|
|
1825
|
+
readonly brand: {
|
|
1826
|
+
readonly type: "string";
|
|
1827
|
+
readonly nullable: true;
|
|
1828
|
+
readonly description: "Payment card brand as reported by Stripe, e.g. `visa`, `mastercard`, `amex`, `cartes_bancaires`, or `unknown`. Null for SEPA Direct Debit and bank transfer.";
|
|
1829
|
+
readonly example: "visa";
|
|
1830
|
+
};
|
|
1831
|
+
readonly iban: {
|
|
1832
|
+
readonly type: "string";
|
|
1833
|
+
readonly nullable: true;
|
|
1834
|
+
readonly description: "Full destination IBAN to send bank transfers to. Set only for `bank_transfer`; null otherwise. This is Cloudfleet's virtual receiving account, shown in full so the customer can pay into it.";
|
|
1835
|
+
readonly example: "DE11243015658023127510";
|
|
1836
|
+
};
|
|
1837
|
+
readonly bic: {
|
|
1838
|
+
readonly type: "string";
|
|
1839
|
+
readonly nullable: true;
|
|
1840
|
+
readonly description: "BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1841
|
+
readonly example: "SOGEDEFFXXX";
|
|
1842
|
+
};
|
|
1843
|
+
readonly account_holder_name: {
|
|
1844
|
+
readonly type: "string";
|
|
1845
|
+
readonly nullable: true;
|
|
1846
|
+
readonly description: "Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1847
|
+
readonly example: "Cloudfleet GmbH";
|
|
1848
|
+
};
|
|
1849
|
+
readonly is_default: {
|
|
1850
|
+
readonly type: "boolean";
|
|
1851
|
+
readonly description: "Whether this payment method is the default used for invoices and active subscriptions. Always false for `bank_transfer` (it cannot be a Stripe default payment method).";
|
|
1852
|
+
readonly example: true;
|
|
1853
|
+
};
|
|
1854
|
+
};
|
|
1855
|
+
readonly required: readonly ["id", "type", "last4", "exp_month", "exp_year", "brand", "iban", "bic", "account_holder_name", "is_default"];
|
|
1856
|
+
readonly additionalProperties: false;
|
|
1857
|
+
};
|
|
1858
|
+
export declare const PlatformQuotaSchema: {
|
|
1859
|
+
readonly type: "object";
|
|
1860
|
+
readonly properties: {
|
|
1861
|
+
readonly basic_clusters_max: {
|
|
1862
|
+
readonly type: "integer";
|
|
1863
|
+
readonly minimum: 0;
|
|
1864
|
+
readonly description: "Maximum number of Basic clusters that can be created.";
|
|
1865
|
+
readonly example: 999;
|
|
1866
|
+
};
|
|
1867
|
+
readonly basic_clusters_available: {
|
|
1868
|
+
readonly type: "integer";
|
|
1869
|
+
readonly description: "Available number of Basic clusters that can be created.";
|
|
1870
|
+
readonly example: 999;
|
|
1871
|
+
};
|
|
1872
|
+
readonly pro_clusters_max: {
|
|
1873
|
+
readonly type: "integer";
|
|
1874
|
+
readonly minimum: 0;
|
|
1875
|
+
readonly description: "Maximum number of Pro clusters that can be created.";
|
|
1876
|
+
readonly example: 999;
|
|
1877
|
+
};
|
|
1878
|
+
readonly pro_clusters_available: {
|
|
1879
|
+
readonly type: "integer";
|
|
1880
|
+
readonly description: "Available number of Pro clusters that can be created.";
|
|
1881
|
+
readonly example: 999;
|
|
1882
|
+
};
|
|
1883
|
+
readonly enterprise_clusters_max: {
|
|
1884
|
+
readonly type: "integer";
|
|
1885
|
+
readonly minimum: 0;
|
|
1886
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1887
|
+
readonly example: 999;
|
|
1888
|
+
};
|
|
1889
|
+
readonly enterprise_clusters_available: {
|
|
1890
|
+
readonly type: "integer";
|
|
1891
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1892
|
+
readonly example: 999;
|
|
1893
|
+
};
|
|
1894
|
+
readonly fleets_max: {
|
|
1895
|
+
readonly type: "integer";
|
|
1896
|
+
readonly minimum: 0;
|
|
1897
|
+
readonly description: "Maximum number of fleets that can be created per cluster.";
|
|
1898
|
+
readonly example: 999;
|
|
1899
|
+
};
|
|
1900
|
+
readonly cluster_tiers: {
|
|
1901
|
+
readonly type: "array";
|
|
1902
|
+
readonly items: {
|
|
1903
|
+
readonly type: "string";
|
|
1904
|
+
readonly example: "basic";
|
|
1905
|
+
};
|
|
1906
|
+
readonly minItems: 0;
|
|
1907
|
+
readonly description: "List of Cloudfleet cluster tiers available for the organization.";
|
|
1908
|
+
};
|
|
1909
|
+
readonly regions: {
|
|
1910
|
+
readonly type: "array";
|
|
1911
|
+
readonly items: {
|
|
1912
|
+
readonly type: "string";
|
|
1913
|
+
readonly example: "northamerica-central-1a";
|
|
1914
|
+
};
|
|
1915
|
+
readonly minItems: 1;
|
|
1916
|
+
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
1917
|
+
};
|
|
1918
|
+
readonly versions: {
|
|
1919
|
+
readonly type: "array";
|
|
1920
|
+
readonly items: {
|
|
1921
|
+
readonly type: "object";
|
|
1922
|
+
readonly properties: {
|
|
1923
|
+
readonly id: {
|
|
1924
|
+
readonly type: "string";
|
|
1925
|
+
readonly description: "Id of the control plane version. Used in API calls.";
|
|
1926
|
+
readonly example: "1.33.x-cfke.x";
|
|
1927
|
+
};
|
|
1928
|
+
readonly label: {
|
|
1929
|
+
readonly type: "string";
|
|
1930
|
+
readonly description: "Label of the control plane version. Used in frontent UI.";
|
|
1931
|
+
readonly example: "1.33.x (Always latest 1.33 patch version)";
|
|
1932
|
+
};
|
|
1933
|
+
};
|
|
1934
|
+
readonly required: readonly ["id", "label"];
|
|
1935
|
+
readonly additionalProperties: false;
|
|
1936
|
+
};
|
|
1937
|
+
readonly minItems: 1;
|
|
1938
|
+
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1939
|
+
};
|
|
1940
|
+
readonly cfcr_storage_gb: {
|
|
1941
|
+
readonly type: "integer";
|
|
1942
|
+
readonly minimum: -1;
|
|
1943
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1944
|
+
readonly example: 500;
|
|
1945
|
+
};
|
|
1946
|
+
};
|
|
1947
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "enterprise_clusters_max", "enterprise_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1948
|
+
readonly additionalProperties: false;
|
|
1949
|
+
};
|
|
1950
|
+
export declare const RegistryRepositorySchema: {
|
|
1951
|
+
readonly type: "object";
|
|
1952
|
+
readonly properties: {
|
|
1953
|
+
readonly name: {
|
|
1954
|
+
readonly type: "string";
|
|
1955
|
+
readonly description: "Repository name.";
|
|
1956
|
+
readonly example: "my-app";
|
|
1957
|
+
};
|
|
1958
|
+
readonly region: {
|
|
1959
|
+
readonly type: "string";
|
|
1960
|
+
readonly description: "Registry region.";
|
|
1961
|
+
readonly example: "northamerica";
|
|
1962
|
+
};
|
|
1963
|
+
readonly uri: {
|
|
1964
|
+
readonly type: "string";
|
|
1965
|
+
readonly description: "Full URI of the repository.";
|
|
1966
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
1967
|
+
};
|
|
1968
|
+
};
|
|
1969
|
+
readonly required: readonly ["name", "region", "uri"];
|
|
1970
|
+
readonly additionalProperties: false;
|
|
1971
|
+
};
|
|
1972
|
+
export declare const RegistryRepositoryWithTagsSchema: {
|
|
1973
|
+
readonly type: "object";
|
|
1974
|
+
readonly properties: {
|
|
1975
|
+
readonly name: {
|
|
1976
|
+
readonly type: "string";
|
|
1977
|
+
readonly description: "Repository name.";
|
|
1978
|
+
readonly example: "my-app";
|
|
1979
|
+
};
|
|
1980
|
+
readonly region: {
|
|
1981
|
+
readonly type: "string";
|
|
1982
|
+
readonly description: "Registry region.";
|
|
1983
|
+
readonly example: "northamerica";
|
|
1984
|
+
};
|
|
1985
|
+
readonly uri: {
|
|
1986
|
+
readonly type: "string";
|
|
1987
|
+
readonly description: "Full URI of the repository.";
|
|
1988
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
1989
|
+
};
|
|
1990
|
+
readonly tags: {
|
|
1991
|
+
readonly type: "array";
|
|
1992
|
+
readonly items: {
|
|
1993
|
+
readonly type: "object";
|
|
1994
|
+
readonly properties: {
|
|
1995
|
+
readonly name: {
|
|
1996
|
+
readonly type: "string";
|
|
1997
|
+
readonly description: "Tag name.";
|
|
1998
|
+
readonly example: "latest";
|
|
1999
|
+
};
|
|
2000
|
+
readonly size: {
|
|
2001
|
+
readonly type: "number";
|
|
2002
|
+
readonly format: "float";
|
|
2003
|
+
readonly description: "Size of the tag in bytes.";
|
|
2004
|
+
readonly example: 123456789;
|
|
2005
|
+
};
|
|
2006
|
+
readonly mediaType: {
|
|
2007
|
+
readonly type: "string";
|
|
2008
|
+
readonly description: "Media type of the manifest.";
|
|
2009
|
+
readonly example: "application/vnd.docker.distribution.manifest.v2+json";
|
|
2010
|
+
};
|
|
2011
|
+
readonly platforms: {
|
|
2012
|
+
readonly type: "array";
|
|
2013
|
+
readonly items: {
|
|
2014
|
+
readonly type: "string";
|
|
2015
|
+
};
|
|
2016
|
+
readonly description: "Array of platform strings for multi-arch images (e.g., linux/amd64, linux/arm64).";
|
|
2017
|
+
readonly example: readonly ["linux/amd64", "linux/arm64"];
|
|
2018
|
+
};
|
|
2019
|
+
};
|
|
2020
|
+
readonly required: readonly ["name", "size"];
|
|
2021
|
+
readonly additionalProperties: false;
|
|
2022
|
+
};
|
|
2023
|
+
readonly description: "Array of tags in the repository.";
|
|
2024
|
+
};
|
|
2025
|
+
readonly totalSize: {
|
|
2026
|
+
readonly type: "number";
|
|
2027
|
+
readonly format: "float";
|
|
2028
|
+
readonly description: "Total size of all tags in the repository in bytes.";
|
|
2029
|
+
readonly example: 987654321;
|
|
2030
|
+
};
|
|
2031
|
+
};
|
|
2032
|
+
readonly required: readonly ["name", "region", "uri", "tags", "totalSize"];
|
|
2033
|
+
readonly additionalProperties: false;
|
|
2034
|
+
};
|
|
2035
|
+
export declare const RegistryTagSchema: {
|
|
2036
|
+
readonly type: "object";
|
|
2037
|
+
readonly properties: {
|
|
2038
|
+
readonly name: {
|
|
2039
|
+
readonly type: "string";
|
|
2040
|
+
readonly description: "Tag name.";
|
|
2041
|
+
readonly example: "latest";
|
|
2042
|
+
};
|
|
2043
|
+
readonly digest: {
|
|
2044
|
+
readonly type: "string";
|
|
2045
|
+
readonly description: "Manifest digest for pulling by digest.";
|
|
2046
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
2047
|
+
};
|
|
2048
|
+
readonly mediaType: {
|
|
2049
|
+
readonly type: "string";
|
|
2050
|
+
readonly description: "Media type of the manifest.";
|
|
2051
|
+
readonly example: "application/vnd.docker.distribution.manifest.v2+json";
|
|
2052
|
+
};
|
|
2053
|
+
readonly config: {
|
|
2054
|
+
readonly type: "object";
|
|
2055
|
+
readonly properties: {
|
|
2056
|
+
readonly size: {
|
|
2057
|
+
readonly type: "number";
|
|
2058
|
+
readonly format: "float";
|
|
2059
|
+
readonly description: "Size of the config in bytes.";
|
|
2060
|
+
readonly example: 1234;
|
|
2061
|
+
};
|
|
2062
|
+
};
|
|
2063
|
+
readonly required: readonly ["size"];
|
|
2064
|
+
readonly additionalProperties: false;
|
|
2065
|
+
readonly description: "Manifest config metadata.";
|
|
2066
|
+
};
|
|
2067
|
+
readonly layers: {
|
|
2068
|
+
readonly type: "array";
|
|
2069
|
+
readonly items: {
|
|
2070
|
+
readonly type: "object";
|
|
2071
|
+
readonly properties: {
|
|
2072
|
+
readonly digest: {
|
|
2073
|
+
readonly type: "string";
|
|
2074
|
+
readonly description: "Digest of the layer.";
|
|
2075
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
2076
|
+
};
|
|
2077
|
+
readonly size: {
|
|
2078
|
+
readonly type: "number";
|
|
2079
|
+
readonly format: "float";
|
|
2080
|
+
readonly description: "Size of the layer in bytes.";
|
|
2081
|
+
readonly example: 5678;
|
|
2082
|
+
};
|
|
2083
|
+
};
|
|
2084
|
+
readonly required: readonly ["size"];
|
|
2085
|
+
readonly additionalProperties: false;
|
|
2086
|
+
};
|
|
2087
|
+
readonly description: "Array of layer metadata.";
|
|
2088
|
+
};
|
|
2089
|
+
readonly manifests: {
|
|
2090
|
+
readonly type: "array";
|
|
2091
|
+
readonly items: {
|
|
2092
|
+
readonly type: "object";
|
|
2093
|
+
readonly properties: {
|
|
2094
|
+
readonly digest: {
|
|
2095
|
+
readonly type: "string";
|
|
2096
|
+
readonly description: "Digest of the manifest.";
|
|
2097
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
2098
|
+
};
|
|
2099
|
+
readonly platform: {
|
|
2100
|
+
readonly type: "object";
|
|
2101
|
+
readonly properties: {
|
|
2102
|
+
readonly architecture: {
|
|
2103
|
+
readonly type: "string";
|
|
2104
|
+
readonly description: "Architecture of the platform.";
|
|
2105
|
+
readonly example: "amd64";
|
|
2106
|
+
};
|
|
2107
|
+
readonly os: {
|
|
2108
|
+
readonly type: "string";
|
|
2109
|
+
readonly description: "Operating system of the platform.";
|
|
2110
|
+
readonly example: "linux";
|
|
2111
|
+
};
|
|
2112
|
+
readonly variant: {
|
|
2113
|
+
readonly type: "string";
|
|
2114
|
+
readonly description: "Variant of the platform (e.g., v7, v8 for ARM).";
|
|
2115
|
+
readonly example: "v8";
|
|
2116
|
+
};
|
|
2117
|
+
};
|
|
2118
|
+
readonly required: readonly ["architecture", "os"];
|
|
2119
|
+
readonly additionalProperties: false;
|
|
2120
|
+
readonly description: "Platform information for the manifest.";
|
|
2121
|
+
};
|
|
2122
|
+
readonly layers: {
|
|
2123
|
+
readonly type: "array";
|
|
2124
|
+
readonly items: {
|
|
2125
|
+
readonly type: "object";
|
|
2126
|
+
readonly properties: {
|
|
2127
|
+
readonly digest: {
|
|
2128
|
+
readonly type: "string";
|
|
2129
|
+
readonly description: "Digest of the layer.";
|
|
2130
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
2131
|
+
};
|
|
2132
|
+
readonly size: {
|
|
2133
|
+
readonly type: "number";
|
|
2134
|
+
readonly format: "float";
|
|
2135
|
+
readonly description: "Size of the layer in bytes.";
|
|
2136
|
+
readonly example: 5678;
|
|
2137
|
+
};
|
|
2138
|
+
};
|
|
2139
|
+
readonly required: readonly ["size"];
|
|
2140
|
+
readonly additionalProperties: false;
|
|
2141
|
+
};
|
|
2142
|
+
readonly description: "Layers for this platform.";
|
|
2143
|
+
};
|
|
2144
|
+
readonly size: {
|
|
2145
|
+
readonly type: "number";
|
|
2146
|
+
readonly format: "float";
|
|
2147
|
+
readonly description: "Total size of this platform manifest in bytes.";
|
|
2148
|
+
readonly example: 12345678;
|
|
2149
|
+
};
|
|
2150
|
+
};
|
|
2151
|
+
readonly required: readonly ["digest"];
|
|
2152
|
+
readonly additionalProperties: false;
|
|
2153
|
+
};
|
|
2154
|
+
readonly description: "Array of manifests for multi-arch images.";
|
|
2155
|
+
};
|
|
2156
|
+
readonly size: {
|
|
2157
|
+
readonly type: "number";
|
|
2158
|
+
readonly format: "float";
|
|
2159
|
+
readonly description: "Total size of the tag in bytes.";
|
|
2160
|
+
readonly example: 123456789;
|
|
2161
|
+
};
|
|
2162
|
+
readonly region: {
|
|
2163
|
+
readonly type: "string";
|
|
2164
|
+
readonly description: "Registry region.";
|
|
2165
|
+
readonly example: "northamerica";
|
|
2166
|
+
};
|
|
2167
|
+
readonly repository: {
|
|
2168
|
+
readonly type: "string";
|
|
2169
|
+
readonly description: "Repository name.";
|
|
2170
|
+
readonly example: "my-app";
|
|
2171
|
+
};
|
|
2172
|
+
readonly uri: {
|
|
2173
|
+
readonly type: "string";
|
|
2174
|
+
readonly description: "Full URI of the tag.";
|
|
2175
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app:latest";
|
|
2176
|
+
};
|
|
2177
|
+
};
|
|
2178
|
+
readonly required: readonly ["name", "digest", "size", "region", "repository", "uri"];
|
|
2179
|
+
readonly additionalProperties: false;
|
|
2180
|
+
};
|
|
2181
|
+
export declare const TicketAttachmentSchema: {
|
|
2182
|
+
readonly type: "object";
|
|
2183
|
+
readonly properties: {
|
|
2184
|
+
readonly id: {
|
|
2185
|
+
readonly type: "string";
|
|
2186
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2187
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2188
|
+
};
|
|
2189
|
+
readonly filename: {
|
|
2190
|
+
readonly type: "string";
|
|
2191
|
+
readonly description: "Original filename as uploaded.";
|
|
2192
|
+
readonly example: "debug.log";
|
|
2193
|
+
};
|
|
2194
|
+
readonly content_type: {
|
|
2195
|
+
readonly type: "string";
|
|
2196
|
+
readonly description: "MIME content type of the attachment.";
|
|
2197
|
+
readonly example: "text/plain";
|
|
2198
|
+
};
|
|
2199
|
+
readonly size: {
|
|
2200
|
+
readonly type: "integer";
|
|
2201
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2202
|
+
readonly example: 12345;
|
|
2203
|
+
};
|
|
2204
|
+
};
|
|
2205
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2206
|
+
readonly additionalProperties: false;
|
|
2207
|
+
};
|
|
2208
|
+
export declare const TicketCreateInputSchema: {
|
|
2209
|
+
readonly type: "object";
|
|
2210
|
+
readonly properties: {
|
|
2211
|
+
readonly category: {
|
|
2212
|
+
readonly type: "string";
|
|
2213
|
+
readonly description: "Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.";
|
|
2214
|
+
readonly example: "technical";
|
|
2215
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
2216
|
+
};
|
|
2217
|
+
readonly body: {
|
|
2218
|
+
readonly type: "string";
|
|
2219
|
+
readonly maxLength: 50000;
|
|
2220
|
+
readonly minLength: 1;
|
|
2221
|
+
readonly pattern: "\\S";
|
|
2222
|
+
readonly description: "Initial message body in markdown. There is no separate subject — the first message body is the description.";
|
|
2223
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2224
|
+
};
|
|
2225
|
+
readonly properties: {
|
|
2226
|
+
readonly type: "object";
|
|
2227
|
+
readonly additionalProperties: true;
|
|
2228
|
+
readonly description: "Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).";
|
|
2229
|
+
readonly example: {
|
|
2230
|
+
readonly subcategory: "cluster-question";
|
|
2231
|
+
readonly cluster_id: "60c72b2f9f1b2c001f8e4d3a";
|
|
2232
|
+
};
|
|
2233
|
+
};
|
|
2234
|
+
};
|
|
2235
|
+
readonly required: readonly ["category", "body"];
|
|
2236
|
+
readonly additionalProperties: false;
|
|
2237
|
+
};
|
|
2238
|
+
export declare const TicketMessageInputSchema: {
|
|
2239
|
+
readonly type: "object";
|
|
2240
|
+
readonly properties: {
|
|
2241
|
+
readonly body: {
|
|
2242
|
+
readonly type: "string";
|
|
2243
|
+
readonly maxLength: 50000;
|
|
2244
|
+
readonly minLength: 1;
|
|
2245
|
+
readonly pattern: "\\S";
|
|
2246
|
+
readonly description: "Reply body in markdown.";
|
|
2247
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2248
|
+
};
|
|
2249
|
+
};
|
|
2250
|
+
readonly required: readonly ["body"];
|
|
2251
|
+
readonly additionalProperties: false;
|
|
2252
|
+
};
|
|
2253
|
+
export declare const TicketMessageSchema: {
|
|
2254
|
+
readonly type: "object";
|
|
2255
|
+
readonly properties: {
|
|
2256
|
+
readonly id: {
|
|
2257
|
+
readonly type: "string";
|
|
2258
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2259
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2260
|
+
};
|
|
2261
|
+
readonly type: {
|
|
2262
|
+
readonly type: "string";
|
|
2263
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2264
|
+
readonly example: "customer_reply";
|
|
2265
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2266
|
+
};
|
|
2267
|
+
readonly body: {
|
|
2268
|
+
readonly type: "string";
|
|
2269
|
+
readonly description: "Message body in markdown.";
|
|
2270
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2271
|
+
};
|
|
2272
|
+
readonly author_first_name: {
|
|
1216
2273
|
readonly type: "string";
|
|
1217
|
-
readonly
|
|
1218
|
-
readonly
|
|
1219
|
-
readonly
|
|
1220
|
-
readonly example: "ACME Corp.";
|
|
2274
|
+
readonly nullable: true;
|
|
2275
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2276
|
+
readonly example: "Jane";
|
|
1221
2277
|
};
|
|
1222
|
-
readonly
|
|
2278
|
+
readonly author_last_name: {
|
|
1223
2279
|
readonly type: "string";
|
|
1224
|
-
readonly
|
|
1225
|
-
readonly description: "
|
|
1226
|
-
readonly example: "
|
|
2280
|
+
readonly nullable: true;
|
|
2281
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2282
|
+
readonly example: "Doe";
|
|
1227
2283
|
};
|
|
1228
|
-
readonly
|
|
1229
|
-
readonly type: "
|
|
1230
|
-
readonly
|
|
1231
|
-
readonly
|
|
1232
|
-
|
|
1233
|
-
readonly
|
|
1234
|
-
readonly description: "Maximum number of Basic clusters that can be created.";
|
|
1235
|
-
readonly example: 999;
|
|
1236
|
-
};
|
|
1237
|
-
readonly basic_clusters_available: {
|
|
1238
|
-
readonly type: "integer";
|
|
1239
|
-
readonly description: "Available number of Basic clusters that can be created.";
|
|
1240
|
-
readonly example: 999;
|
|
1241
|
-
};
|
|
1242
|
-
readonly pro_clusters_max: {
|
|
1243
|
-
readonly type: "integer";
|
|
1244
|
-
readonly minimum: 0;
|
|
1245
|
-
readonly description: "Maximum number of Pro clusters that can be created.";
|
|
1246
|
-
readonly example: 999;
|
|
1247
|
-
};
|
|
1248
|
-
readonly pro_clusters_available: {
|
|
1249
|
-
readonly type: "integer";
|
|
1250
|
-
readonly description: "Available number of Pro clusters that can be created.";
|
|
1251
|
-
readonly example: 999;
|
|
1252
|
-
};
|
|
1253
|
-
readonly fleets_max: {
|
|
1254
|
-
readonly type: "integer";
|
|
1255
|
-
readonly minimum: 0;
|
|
1256
|
-
readonly description: "Maximum number of fleets that can be created per cluster.";
|
|
1257
|
-
readonly example: 999;
|
|
1258
|
-
};
|
|
1259
|
-
readonly cluster_tiers: {
|
|
1260
|
-
readonly type: "array";
|
|
1261
|
-
readonly items: {
|
|
2284
|
+
readonly attachments: {
|
|
2285
|
+
readonly type: "array";
|
|
2286
|
+
readonly items: {
|
|
2287
|
+
readonly type: "object";
|
|
2288
|
+
readonly properties: {
|
|
2289
|
+
readonly id: {
|
|
1262
2290
|
readonly type: "string";
|
|
1263
|
-
readonly
|
|
2291
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2292
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1264
2293
|
};
|
|
1265
|
-
readonly
|
|
1266
|
-
readonly description: "List of Cloudfleet cluster tiers available for the organization.";
|
|
1267
|
-
};
|
|
1268
|
-
readonly regions: {
|
|
1269
|
-
readonly type: "array";
|
|
1270
|
-
readonly items: {
|
|
2294
|
+
readonly filename: {
|
|
1271
2295
|
readonly type: "string";
|
|
1272
|
-
readonly
|
|
2296
|
+
readonly description: "Original filename as uploaded.";
|
|
2297
|
+
readonly example: "debug.log";
|
|
1273
2298
|
};
|
|
1274
|
-
readonly
|
|
1275
|
-
|
|
1276
|
-
|
|
1277
|
-
|
|
1278
|
-
|
|
1279
|
-
readonly
|
|
1280
|
-
readonly type: "
|
|
1281
|
-
readonly
|
|
1282
|
-
|
|
1283
|
-
readonly type: "string";
|
|
1284
|
-
readonly description: "Id of the control plane version. Used in API calls.";
|
|
1285
|
-
readonly example: "1.29.x-cfke.x";
|
|
1286
|
-
};
|
|
1287
|
-
readonly label: {
|
|
1288
|
-
readonly type: "string";
|
|
1289
|
-
readonly description: "Label of the control plane version. Used in frontent UI.";
|
|
1290
|
-
readonly example: "1.29.x (Always latest 1.29 patch version)";
|
|
1291
|
-
};
|
|
1292
|
-
};
|
|
1293
|
-
readonly required: readonly ["id", "label"];
|
|
1294
|
-
readonly additionalProperties: false;
|
|
2299
|
+
readonly content_type: {
|
|
2300
|
+
readonly type: "string";
|
|
2301
|
+
readonly description: "MIME content type of the attachment.";
|
|
2302
|
+
readonly example: "text/plain";
|
|
2303
|
+
};
|
|
2304
|
+
readonly size: {
|
|
2305
|
+
readonly type: "integer";
|
|
2306
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2307
|
+
readonly example: 12345;
|
|
1295
2308
|
};
|
|
1296
|
-
readonly minItems: 1;
|
|
1297
|
-
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1298
2309
|
};
|
|
2310
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2311
|
+
readonly additionalProperties: false;
|
|
1299
2312
|
};
|
|
1300
|
-
readonly
|
|
1301
|
-
readonly
|
|
1302
|
-
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.";
|
|
2313
|
+
readonly description: "Attachments associated with this message.";
|
|
2314
|
+
readonly example: readonly [];
|
|
1303
2315
|
};
|
|
1304
|
-
readonly
|
|
2316
|
+
readonly date_created: {
|
|
1305
2317
|
readonly type: "string";
|
|
1306
|
-
readonly
|
|
1307
|
-
readonly
|
|
2318
|
+
readonly format: "date-time";
|
|
2319
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2320
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1308
2321
|
};
|
|
1309
2322
|
};
|
|
1310
|
-
readonly required: readonly ["id", "
|
|
2323
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
1311
2324
|
readonly additionalProperties: false;
|
|
1312
2325
|
};
|
|
1313
|
-
export declare const
|
|
2326
|
+
export declare const TicketSchema: {
|
|
1314
2327
|
readonly type: "object";
|
|
1315
2328
|
readonly properties: {
|
|
1316
2329
|
readonly id: {
|
|
1317
2330
|
readonly type: "string";
|
|
1318
|
-
readonly
|
|
1319
|
-
readonly
|
|
1320
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
2331
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
2332
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
1321
2333
|
};
|
|
1322
|
-
readonly
|
|
1323
|
-
readonly type: "
|
|
1324
|
-
readonly description: "
|
|
1325
|
-
readonly example:
|
|
2334
|
+
readonly status: {
|
|
2335
|
+
readonly type: "string";
|
|
2336
|
+
readonly description: "Current state of the ticket.";
|
|
2337
|
+
readonly example: "waiting_on_us";
|
|
2338
|
+
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
1326
2339
|
};
|
|
1327
|
-
readonly
|
|
2340
|
+
readonly category: {
|
|
1328
2341
|
readonly type: "string";
|
|
1329
|
-
readonly
|
|
1330
|
-
readonly
|
|
1331
|
-
readonly
|
|
1332
|
-
readonly enum: readonly ["card"];
|
|
2342
|
+
readonly description: "Ticket category.";
|
|
2343
|
+
readonly example: "technical";
|
|
2344
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
1333
2345
|
};
|
|
1334
|
-
readonly
|
|
2346
|
+
readonly summary: {
|
|
1335
2347
|
readonly type: "string";
|
|
1336
|
-
readonly
|
|
1337
|
-
readonly
|
|
1338
|
-
readonly example: "4242";
|
|
2348
|
+
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
2349
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
1339
2350
|
};
|
|
1340
|
-
readonly
|
|
1341
|
-
readonly type: "
|
|
1342
|
-
readonly
|
|
1343
|
-
readonly maximum: 12;
|
|
2351
|
+
readonly closed_at: {
|
|
2352
|
+
readonly type: "string";
|
|
2353
|
+
readonly format: "date-time";
|
|
1344
2354
|
readonly nullable: true;
|
|
1345
|
-
readonly description: "
|
|
1346
|
-
readonly example: "
|
|
2355
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
2356
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
1347
2357
|
};
|
|
1348
|
-
readonly
|
|
1349
|
-
readonly type: "
|
|
1350
|
-
readonly
|
|
1351
|
-
readonly
|
|
1352
|
-
readonly
|
|
1353
|
-
readonly example: "2028";
|
|
2358
|
+
readonly date_created: {
|
|
2359
|
+
readonly type: "string";
|
|
2360
|
+
readonly format: "date-time";
|
|
2361
|
+
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
2362
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1354
2363
|
};
|
|
1355
|
-
readonly
|
|
2364
|
+
readonly date_updated: {
|
|
1356
2365
|
readonly type: "string";
|
|
1357
|
-
readonly
|
|
1358
|
-
readonly description: "
|
|
1359
|
-
readonly example: "
|
|
1360
|
-
|
|
2366
|
+
readonly format: "date-time";
|
|
2367
|
+
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
2368
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2369
|
+
};
|
|
2370
|
+
readonly messages: {
|
|
2371
|
+
readonly type: "array";
|
|
2372
|
+
readonly items: {
|
|
2373
|
+
readonly type: "object";
|
|
2374
|
+
readonly properties: {
|
|
2375
|
+
readonly id: {
|
|
2376
|
+
readonly type: "string";
|
|
2377
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2378
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2379
|
+
};
|
|
2380
|
+
readonly type: {
|
|
2381
|
+
readonly type: "string";
|
|
2382
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2383
|
+
readonly example: "customer_reply";
|
|
2384
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2385
|
+
};
|
|
2386
|
+
readonly body: {
|
|
2387
|
+
readonly type: "string";
|
|
2388
|
+
readonly description: "Message body in markdown.";
|
|
2389
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2390
|
+
};
|
|
2391
|
+
readonly author_first_name: {
|
|
2392
|
+
readonly type: "string";
|
|
2393
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2394
|
+
readonly example: "Jane";
|
|
2395
|
+
};
|
|
2396
|
+
readonly author_last_name: {
|
|
2397
|
+
readonly type: "string";
|
|
2398
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2399
|
+
readonly example: "Doe";
|
|
2400
|
+
};
|
|
2401
|
+
readonly attachments: {
|
|
2402
|
+
readonly type: "array";
|
|
2403
|
+
readonly items: {
|
|
2404
|
+
readonly type: "object";
|
|
2405
|
+
readonly properties: {
|
|
2406
|
+
readonly id: {
|
|
2407
|
+
readonly type: "string";
|
|
2408
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2409
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2410
|
+
};
|
|
2411
|
+
readonly filename: {
|
|
2412
|
+
readonly type: "string";
|
|
2413
|
+
readonly description: "Original filename as uploaded.";
|
|
2414
|
+
readonly example: "debug.log";
|
|
2415
|
+
};
|
|
2416
|
+
readonly content_type: {
|
|
2417
|
+
readonly type: "string";
|
|
2418
|
+
readonly description: "MIME content type of the attachment.";
|
|
2419
|
+
readonly example: "text/plain";
|
|
2420
|
+
};
|
|
2421
|
+
readonly size: {
|
|
2422
|
+
readonly type: "integer";
|
|
2423
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2424
|
+
readonly example: 12345;
|
|
2425
|
+
};
|
|
2426
|
+
};
|
|
2427
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2428
|
+
readonly additionalProperties: false;
|
|
2429
|
+
};
|
|
2430
|
+
readonly description: "Attachments associated with this message.";
|
|
2431
|
+
readonly example: readonly [];
|
|
2432
|
+
};
|
|
2433
|
+
readonly date_created: {
|
|
2434
|
+
readonly type: "string";
|
|
2435
|
+
readonly format: "date-time";
|
|
2436
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2437
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2438
|
+
};
|
|
2439
|
+
};
|
|
2440
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2441
|
+
readonly additionalProperties: false;
|
|
2442
|
+
};
|
|
2443
|
+
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
1361
2444
|
};
|
|
1362
2445
|
};
|
|
1363
|
-
readonly required: readonly ["id", "
|
|
2446
|
+
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
1364
2447
|
readonly additionalProperties: false;
|
|
1365
2448
|
};
|
|
1366
2449
|
export declare const TokenCreateInputSchema: {
|
|
@@ -1441,6 +2524,104 @@ export declare const TokenUpdateInputSchema: {
|
|
|
1441
2524
|
};
|
|
1442
2525
|
readonly additionalProperties: false;
|
|
1443
2526
|
};
|
|
2527
|
+
export declare const UsageFacetsSchema: {
|
|
2528
|
+
readonly type: "object";
|
|
2529
|
+
readonly properties: {
|
|
2530
|
+
readonly cluster_id: {
|
|
2531
|
+
readonly type: "array";
|
|
2532
|
+
readonly items: {
|
|
2533
|
+
readonly type: "string";
|
|
2534
|
+
};
|
|
2535
|
+
readonly description: "List of unique cluster IDs";
|
|
2536
|
+
readonly example: readonly ["6b5439b1-923a-4f2b-a371-d554e5ea23fa"];
|
|
2537
|
+
};
|
|
2538
|
+
readonly product: {
|
|
2539
|
+
readonly type: "array";
|
|
2540
|
+
readonly items: {
|
|
2541
|
+
readonly type: "string";
|
|
2542
|
+
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"];
|
|
2543
|
+
};
|
|
2544
|
+
readonly description: "List of unique products";
|
|
2545
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
2546
|
+
};
|
|
2547
|
+
};
|
|
2548
|
+
readonly additionalProperties: false;
|
|
2549
|
+
};
|
|
2550
|
+
export declare const UsageResponseSchema: {
|
|
2551
|
+
readonly type: "object";
|
|
2552
|
+
readonly properties: {
|
|
2553
|
+
readonly data: {
|
|
2554
|
+
readonly type: "array";
|
|
2555
|
+
readonly items: {
|
|
2556
|
+
readonly type: "object";
|
|
2557
|
+
readonly properties: {
|
|
2558
|
+
readonly hour: {
|
|
2559
|
+
readonly type: "string";
|
|
2560
|
+
readonly description: "Hour of the usage";
|
|
2561
|
+
readonly example: "2019-01-01T00:00:00.000Z";
|
|
2562
|
+
};
|
|
2563
|
+
readonly cluster_id: {
|
|
2564
|
+
readonly type: "string";
|
|
2565
|
+
readonly description: "Unique identifier of the kubernetes cluster. UUID v4 string in canonical form";
|
|
2566
|
+
readonly example: "6b5439b1-923a-4f2b-a371-d554e5ea23fa";
|
|
2567
|
+
};
|
|
2568
|
+
readonly product: {
|
|
2569
|
+
readonly type: "string";
|
|
2570
|
+
readonly description: "The product the usage is associated with";
|
|
2571
|
+
readonly example: "cfke_controlplane_pro";
|
|
2572
|
+
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"];
|
|
2573
|
+
};
|
|
2574
|
+
readonly value: {
|
|
2575
|
+
readonly type: "number";
|
|
2576
|
+
readonly format: "float";
|
|
2577
|
+
readonly description: "Consumption";
|
|
2578
|
+
readonly example: 4;
|
|
2579
|
+
};
|
|
2580
|
+
readonly price: {
|
|
2581
|
+
readonly type: "number";
|
|
2582
|
+
readonly format: "float";
|
|
2583
|
+
readonly description: "Price per unit";
|
|
2584
|
+
readonly example: 0.01;
|
|
2585
|
+
};
|
|
2586
|
+
readonly total: {
|
|
2587
|
+
readonly type: "number";
|
|
2588
|
+
readonly format: "float";
|
|
2589
|
+
readonly description: "Total cost";
|
|
2590
|
+
};
|
|
2591
|
+
};
|
|
2592
|
+
readonly required: readonly ["hour", "cluster_id", "product", "value", "price", "total"];
|
|
2593
|
+
readonly additionalProperties: false;
|
|
2594
|
+
};
|
|
2595
|
+
readonly description: "Usage data";
|
|
2596
|
+
};
|
|
2597
|
+
readonly facets: {
|
|
2598
|
+
readonly type: "object";
|
|
2599
|
+
readonly properties: {
|
|
2600
|
+
readonly cluster_id: {
|
|
2601
|
+
readonly type: "array";
|
|
2602
|
+
readonly items: {
|
|
2603
|
+
readonly type: "string";
|
|
2604
|
+
};
|
|
2605
|
+
readonly description: "List of unique cluster IDs";
|
|
2606
|
+
readonly example: readonly ["6b5439b1-923a-4f2b-a371-d554e5ea23fa"];
|
|
2607
|
+
};
|
|
2608
|
+
readonly product: {
|
|
2609
|
+
readonly type: "array";
|
|
2610
|
+
readonly items: {
|
|
2611
|
+
readonly type: "string";
|
|
2612
|
+
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"];
|
|
2613
|
+
};
|
|
2614
|
+
readonly description: "List of unique products";
|
|
2615
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
2616
|
+
};
|
|
2617
|
+
};
|
|
2618
|
+
readonly additionalProperties: false;
|
|
2619
|
+
readonly description: "Facets for filtering";
|
|
2620
|
+
};
|
|
2621
|
+
};
|
|
2622
|
+
readonly required: readonly ["data", "facets"];
|
|
2623
|
+
readonly additionalProperties: false;
|
|
2624
|
+
};
|
|
1444
2625
|
export declare const UsageSchema: {
|
|
1445
2626
|
readonly type: "object";
|
|
1446
2627
|
readonly properties: {
|
|
@@ -1451,78 +2632,34 @@ export declare const UsageSchema: {
|
|
|
1451
2632
|
};
|
|
1452
2633
|
readonly cluster_id: {
|
|
1453
2634
|
readonly type: "string";
|
|
1454
|
-
readonly format: "uuid";
|
|
1455
2635
|
readonly description: "Unique identifier of the kubernetes cluster. UUID v4 string in canonical form";
|
|
1456
2636
|
readonly example: "6b5439b1-923a-4f2b-a371-d554e5ea23fa";
|
|
1457
2637
|
};
|
|
1458
|
-
readonly cluster_tier: {
|
|
1459
|
-
readonly type: "string";
|
|
1460
|
-
readonly description: "Tier of the cluster.";
|
|
1461
|
-
readonly example: "pro";
|
|
1462
|
-
readonly enum: readonly ["basic", "pro", ""];
|
|
1463
|
-
};
|
|
1464
2638
|
readonly product: {
|
|
1465
2639
|
readonly type: "string";
|
|
1466
2640
|
readonly description: "The product the usage is associated with";
|
|
1467
|
-
readonly example: "
|
|
1468
|
-
readonly enum: readonly ["
|
|
1469
|
-
};
|
|
1470
|
-
readonly node_name: {
|
|
1471
|
-
readonly type: "string";
|
|
1472
|
-
readonly description: "Name of the Kubernetes node";
|
|
1473
|
-
readonly example: "flexible-moth-956037384";
|
|
1474
|
-
};
|
|
1475
|
-
readonly sku: {
|
|
1476
|
-
readonly type: "string";
|
|
1477
|
-
readonly description: "SKU of the Kubernetes node";
|
|
1478
|
-
readonly example: "GCP-NORTHAMERICA-NORTHEAST1-A-G1-SMALL-SPOT";
|
|
2641
|
+
readonly example: "cfke_controlplane_pro";
|
|
2642
|
+
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"];
|
|
1479
2643
|
};
|
|
1480
|
-
readonly
|
|
1481
|
-
readonly
|
|
1482
|
-
|
|
1483
|
-
|
|
1484
|
-
|
|
1485
|
-
readonly example: 4;
|
|
1486
|
-
}, {
|
|
1487
|
-
readonly type: "string";
|
|
1488
|
-
readonly enum: readonly [""];
|
|
1489
|
-
}];
|
|
2644
|
+
readonly value: {
|
|
2645
|
+
readonly type: "number";
|
|
2646
|
+
readonly format: "float";
|
|
2647
|
+
readonly description: "Consumption";
|
|
2648
|
+
readonly example: 4;
|
|
1490
2649
|
};
|
|
1491
2650
|
readonly price: {
|
|
1492
|
-
readonly
|
|
1493
|
-
|
|
1494
|
-
|
|
1495
|
-
|
|
1496
|
-
readonly example: 4;
|
|
1497
|
-
}, {
|
|
1498
|
-
readonly type: "string";
|
|
1499
|
-
readonly enum: readonly [""];
|
|
1500
|
-
}];
|
|
1501
|
-
};
|
|
1502
|
-
readonly value: {
|
|
1503
|
-
readonly anyOf: readonly [{
|
|
1504
|
-
readonly type: "number";
|
|
1505
|
-
readonly format: "float";
|
|
1506
|
-
readonly description: "Value";
|
|
1507
|
-
readonly example: 4;
|
|
1508
|
-
}, {
|
|
1509
|
-
readonly type: "string";
|
|
1510
|
-
readonly enum: readonly [""];
|
|
1511
|
-
}];
|
|
2651
|
+
readonly type: "number";
|
|
2652
|
+
readonly format: "float";
|
|
2653
|
+
readonly description: "Price per unit";
|
|
2654
|
+
readonly example: 0.01;
|
|
1512
2655
|
};
|
|
1513
2656
|
readonly total: {
|
|
1514
|
-
readonly
|
|
1515
|
-
|
|
1516
|
-
|
|
1517
|
-
readonly description: "Total";
|
|
1518
|
-
readonly example: 4;
|
|
1519
|
-
}, {
|
|
1520
|
-
readonly type: "string";
|
|
1521
|
-
readonly enum: readonly [""];
|
|
1522
|
-
}];
|
|
2657
|
+
readonly type: "number";
|
|
2658
|
+
readonly format: "float";
|
|
2659
|
+
readonly description: "Total cost";
|
|
1523
2660
|
};
|
|
1524
2661
|
};
|
|
1525
|
-
readonly required: readonly ["
|
|
2662
|
+
readonly required: readonly ["hour", "cluster_id", "product", "value", "price", "total"];
|
|
1526
2663
|
readonly additionalProperties: false;
|
|
1527
2664
|
};
|
|
1528
2665
|
export declare const UserCreateInputSchema: {
|
|
@@ -1559,18 +2696,6 @@ export declare const UserCreateInputSchema: {
|
|
|
1559
2696
|
readonly minLength: 8;
|
|
1560
2697
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
1561
2698
|
};
|
|
1562
|
-
readonly status: {
|
|
1563
|
-
readonly type: "string";
|
|
1564
|
-
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
1565
|
-
readonly example: "active";
|
|
1566
|
-
readonly enum: readonly ["active", "inactive"];
|
|
1567
|
-
};
|
|
1568
|
-
readonly role: {
|
|
1569
|
-
readonly type: "string";
|
|
1570
|
-
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
1571
|
-
readonly example: "User";
|
|
1572
|
-
readonly enum: readonly ["Administrator", "User"];
|
|
1573
|
-
};
|
|
1574
2699
|
};
|
|
1575
2700
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
1576
2701
|
readonly additionalProperties: false;
|