@cloudfleet/sdk 0.0.1-869c561 → 0.0.1-882a962
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 +1199 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1215 -0
- package/dist/@tanstack/react-query.gen.js.map +1 -0
- package/dist/client/client.gen.d.ts +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 +9 -0
- package/dist/client/index.d.ts.map +1 -0
- package/dist/client/index.js +7 -0
- package/dist/client/index.js.map +1 -0
- package/dist/client/types.gen.d.ts +121 -0
- 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.gen.d.ts +38 -0
- package/dist/client/utils.gen.d.ts.map +1 -0
- package/dist/client/utils.gen.js +229 -0
- package/dist/client/utils.gen.js.map +1 -0
- package/dist/client.gen.d.ts +4 -4
- package/dist/client.gen.d.ts.map +1 -1
- package/dist/client.gen.js +2 -4
- package/dist/client.gen.js.map +1 -1
- package/dist/core/auth.gen.d.ts +19 -0
- package/dist/core/auth.gen.d.ts.map +1 -0
- package/dist/core/auth.gen.js +15 -0
- 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.gen.js +58 -0
- package/dist/core/bodySerializer.gen.js.map +1 -0
- package/dist/core/params.gen.d.ts +44 -0
- package/dist/core/params.gen.d.ts.map +1 -0
- package/dist/core/params.gen.js +101 -0
- package/dist/core/params.gen.js.map +1 -0
- package/dist/core/pathSerializer.gen.d.ts +34 -0
- package/dist/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/core/pathSerializer.gen.js +107 -0
- 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.gen.d.ts +79 -0
- 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 +1615 -663
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +2974 -727
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +316 -168
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +441 -335
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +20 -20
- package/dist/types.gen.d.ts +1826 -830
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3843 -2736
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1433 -995
- package/dist/zod.gen.js.map +1 -1
- package/package.json +28 -9
package/dist/schemas.gen.d.ts
CHANGED
|
@@ -1,6 +1,49 @@
|
|
|
1
|
+
export declare const BasicPriceConsentInputSchema: {
|
|
2
|
+
readonly type: "object";
|
|
3
|
+
readonly properties: {
|
|
4
|
+
readonly decision: {
|
|
5
|
+
readonly type: "string";
|
|
6
|
+
readonly description: "The administrator's decision on the new Basic price. `accepted` continues to paid billing when the signup credit runs out; `rejected` opts out (clusters are suspended, never charged). A `rejected` org can later be flipped back to `accepted`.";
|
|
7
|
+
readonly example: "accepted";
|
|
8
|
+
readonly enum: readonly ["accepted", "rejected"];
|
|
9
|
+
};
|
|
10
|
+
};
|
|
11
|
+
readonly required: readonly ["decision"];
|
|
12
|
+
readonly additionalProperties: false;
|
|
13
|
+
};
|
|
14
|
+
export declare const BasicPriceConsentSchema: {
|
|
15
|
+
readonly type: "object";
|
|
16
|
+
readonly properties: {
|
|
17
|
+
readonly status: {
|
|
18
|
+
readonly type: "string";
|
|
19
|
+
readonly description: "Consent status for the new Basic price. `not_applicable` when the organization is not in scope for the migration. `pending` when the organization must opt in but no admin has decided yet. `accepted` / `rejected` reflect the recorded decision.";
|
|
20
|
+
readonly example: "pending";
|
|
21
|
+
readonly enum: readonly ["not_applicable", "pending", "accepted", "rejected"];
|
|
22
|
+
};
|
|
23
|
+
readonly decided_at: {
|
|
24
|
+
readonly type: "string";
|
|
25
|
+
readonly format: "date-time";
|
|
26
|
+
readonly description: "When the current decision was recorded. Absent while `not_applicable` or `pending`.";
|
|
27
|
+
readonly example: "2026-09-05T10:12:00.000Z";
|
|
28
|
+
};
|
|
29
|
+
readonly decided_by: {
|
|
30
|
+
readonly type: "string";
|
|
31
|
+
readonly description: "User id of the administrator who recorded the current decision. Absent while `not_applicable` or `pending`.";
|
|
32
|
+
readonly example: "2b7a5c9e-1f4d-4a1b-9c3e-8d2f6a0b1c2d";
|
|
33
|
+
};
|
|
34
|
+
};
|
|
35
|
+
readonly required: readonly ["status"];
|
|
36
|
+
readonly additionalProperties: false;
|
|
37
|
+
};
|
|
1
38
|
export declare const BillingContactSchema: {
|
|
2
39
|
readonly type: "object";
|
|
3
40
|
readonly properties: {
|
|
41
|
+
readonly type: {
|
|
42
|
+
readonly type: "string";
|
|
43
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
44
|
+
readonly example: "business";
|
|
45
|
+
readonly enum: readonly ["business", "personal"];
|
|
46
|
+
};
|
|
4
47
|
readonly company: {
|
|
5
48
|
readonly type: "string";
|
|
6
49
|
readonly maxLength: 120;
|
|
@@ -57,15 +100,10 @@ export declare const BillingContactSchema: {
|
|
|
57
100
|
readonly description: "Email address used for billing as a string.";
|
|
58
101
|
readonly example: "email@example.com";
|
|
59
102
|
};
|
|
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: {
|
|
103
|
+
readonly individual_name: {
|
|
66
104
|
readonly type: "string";
|
|
67
|
-
readonly description: "
|
|
68
|
-
readonly example: "Doe";
|
|
105
|
+
readonly description: "Name of the billing contact person.";
|
|
106
|
+
readonly example: "John Doe";
|
|
69
107
|
};
|
|
70
108
|
readonly tax_id: {
|
|
71
109
|
readonly type: "string";
|
|
@@ -81,7 +119,7 @@ export declare const BillingContactSchema: {
|
|
|
81
119
|
readonly enum: readonly ["ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "at_vat", "au_abn", "au_arn", "ba_tin", "bb_tin", "be_vat", "bg_uic", "bg_vat", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", "cy_vat", "cz_vat", "de_stn", "de_vat", "dk_vat", "do_rcn", "ec_ruc", "ee_vat", "eg_tin", "es_cif", "es_vat", "eu_oss_vat", "fi_vat", "fr_vat", "gb_vat", "ge_vat", "gn_nif", "gr_vat", "hk_br", "hr_oib", "hr_vat", "hu_tin", "hu_vat", "id_npwp", "ie_vat", "il_vat", "in_gst", "is_vat", "it_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kh_tin", "kr_brn", "kz_bin", "li_uid", "li_vat", "lt_vat", "lu_vat", "lv_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mt_vat", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "nl_vat", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "pl_vat", "pt_vat", "ro_tin", "ro_vat", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "se_vat", "sg_gst", "sg_uen", "si_tin", "si_vat", "sk_vat", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "xi_vat", "za_vat", "zm_tin", "zw_tin", ""];
|
|
82
120
|
};
|
|
83
121
|
};
|
|
84
|
-
readonly required: readonly ["
|
|
122
|
+
readonly required: readonly ["type", "email", "individual_name"];
|
|
85
123
|
readonly additionalProperties: false;
|
|
86
124
|
};
|
|
87
125
|
export declare const BillingCreditsSchema: {
|
|
@@ -92,10 +130,22 @@ export declare const BillingCreditsSchema: {
|
|
|
92
130
|
readonly description: "Generated unique identifier of the promotional code.";
|
|
93
131
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
94
132
|
};
|
|
95
|
-
readonly
|
|
133
|
+
readonly type: {
|
|
134
|
+
readonly type: "string";
|
|
135
|
+
readonly description: "Type of the promotional code.";
|
|
136
|
+
readonly example: "credit";
|
|
137
|
+
readonly enum: readonly ["credit", "discount"];
|
|
138
|
+
};
|
|
139
|
+
readonly date_start: {
|
|
140
|
+
readonly type: "string";
|
|
141
|
+
readonly format: "date-time";
|
|
142
|
+
readonly description: "Timestamp when the credit becomes active. ISO 8601 date string in the UTC timezone.";
|
|
143
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
144
|
+
};
|
|
145
|
+
readonly date_end: {
|
|
96
146
|
readonly type: "string";
|
|
97
147
|
readonly format: "date-time";
|
|
98
|
-
readonly description: "
|
|
148
|
+
readonly description: "Timestamp when the credit expires or becomes inactive. ISO 8601 date string in the UTC timezone.";
|
|
99
149
|
readonly example: "2023-12-20T13:53:32.000Z";
|
|
100
150
|
};
|
|
101
151
|
readonly code: {
|
|
@@ -108,40 +158,20 @@ export declare const BillingCreditsSchema: {
|
|
|
108
158
|
readonly description: "Description of the promotional code.";
|
|
109
159
|
readonly example: "10% off on all products";
|
|
110
160
|
};
|
|
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: {
|
|
161
|
+
readonly value_total: {
|
|
126
162
|
readonly type: "number";
|
|
127
163
|
readonly format: "float";
|
|
128
|
-
readonly description: "
|
|
164
|
+
readonly description: "Total value of the promotional code.";
|
|
129
165
|
readonly example: 10;
|
|
130
166
|
};
|
|
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
167
|
readonly value_remaining: {
|
|
138
168
|
readonly type: "number";
|
|
139
169
|
readonly format: "float";
|
|
140
|
-
readonly description: "
|
|
141
|
-
readonly example:
|
|
170
|
+
readonly description: "Remaining value of the promotional code.";
|
|
171
|
+
readonly example: 8;
|
|
142
172
|
};
|
|
143
173
|
};
|
|
144
|
-
readonly required: readonly ["
|
|
174
|
+
readonly required: readonly ["type", "date_start", "code", "value_total"];
|
|
145
175
|
readonly additionalProperties: false;
|
|
146
176
|
};
|
|
147
177
|
export declare const ChartCreateInputSchema: {
|
|
@@ -224,9 +254,8 @@ export declare const ChartSchema: {
|
|
|
224
254
|
};
|
|
225
255
|
readonly status: {
|
|
226
256
|
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"];
|
|
257
|
+
readonly description: "Status of the chart deployment (Flux HelmRelease Ready condition reason, e.g. InstallSucceeded, UpgradeFailed, Progressing).";
|
|
258
|
+
readonly example: "InstallSucceeded";
|
|
230
259
|
};
|
|
231
260
|
readonly version_current: {
|
|
232
261
|
readonly type: "string";
|
|
@@ -280,29 +309,106 @@ export declare const ClusterCreateInputSchema: {
|
|
|
280
309
|
readonly description: "Name of the cluster.";
|
|
281
310
|
readonly example: "production-cluster";
|
|
282
311
|
};
|
|
283
|
-
readonly region: {
|
|
284
|
-
readonly type: "string";
|
|
285
|
-
readonly description: "Cloudfleet control plane region. One of \"staging\", \"northamerica-central-1\". This field can not be updated after creation.";
|
|
286
|
-
readonly default: "staging";
|
|
287
|
-
readonly example: "northamerica-central-1";
|
|
288
|
-
readonly enum: readonly ["staging", "northamerica-central-1"];
|
|
289
|
-
};
|
|
290
312
|
readonly tier: {
|
|
291
313
|
readonly type: "string";
|
|
292
314
|
readonly description: "Tier of the cluster.";
|
|
315
|
+
readonly default: "basic";
|
|
293
316
|
readonly example: "pro";
|
|
294
|
-
readonly enum: readonly ["basic", "pro"];
|
|
317
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
295
318
|
};
|
|
296
319
|
readonly version_channel: {
|
|
297
320
|
readonly type: "string";
|
|
298
321
|
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
299
322
|
readonly description: "Version of the kubernetes cluster.";
|
|
300
323
|
readonly default: "1.x.x-cfke.x";
|
|
301
|
-
readonly example: "1.
|
|
324
|
+
readonly example: "1.x.x-cfke.x";
|
|
325
|
+
};
|
|
326
|
+
readonly release_channel: {
|
|
327
|
+
readonly type: "string";
|
|
328
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
329
|
+
readonly default: "rapid";
|
|
330
|
+
readonly example: "rapid";
|
|
331
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
332
|
+
};
|
|
333
|
+
readonly features: {
|
|
334
|
+
readonly type: "object";
|
|
335
|
+
readonly properties: {
|
|
336
|
+
readonly gpu_sharing_strategy: {
|
|
337
|
+
readonly type: "string";
|
|
338
|
+
readonly description: "GPU sharing strategy.";
|
|
339
|
+
readonly default: "none";
|
|
340
|
+
readonly example: "none";
|
|
341
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
342
|
+
};
|
|
343
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
344
|
+
readonly type: "integer";
|
|
345
|
+
readonly minimum: 2;
|
|
346
|
+
readonly maximum: 48;
|
|
347
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
348
|
+
readonly default: 4;
|
|
349
|
+
readonly example: 10;
|
|
350
|
+
};
|
|
351
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
352
|
+
readonly type: "boolean";
|
|
353
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
354
|
+
readonly example: false;
|
|
355
|
+
};
|
|
356
|
+
};
|
|
357
|
+
readonly additionalProperties: false;
|
|
358
|
+
readonly description: "Cluster feature toggles.";
|
|
359
|
+
readonly default: {
|
|
360
|
+
readonly gpu_sharing_strategy: "none";
|
|
361
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
362
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
363
|
+
};
|
|
364
|
+
};
|
|
365
|
+
readonly region: {
|
|
366
|
+
readonly type: "string";
|
|
367
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
368
|
+
readonly example: "europe-central-1a";
|
|
369
|
+
};
|
|
370
|
+
readonly networking: {
|
|
371
|
+
readonly type: "object";
|
|
372
|
+
readonly properties: {
|
|
373
|
+
readonly pod_cidr: {
|
|
374
|
+
readonly type: "string";
|
|
375
|
+
readonly description: "CIDR block for pod IPs.";
|
|
376
|
+
readonly default: "10.244.0.0/16";
|
|
377
|
+
};
|
|
378
|
+
readonly service_cidr: {
|
|
379
|
+
readonly type: "string";
|
|
380
|
+
readonly description: "CIDR block for service IPs.";
|
|
381
|
+
readonly default: "10.96.0.0/12";
|
|
382
|
+
};
|
|
383
|
+
readonly dual_stack: {
|
|
384
|
+
readonly type: "boolean";
|
|
385
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
386
|
+
};
|
|
387
|
+
readonly pod_cidr_v6: {
|
|
388
|
+
readonly type: "string";
|
|
389
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
390
|
+
readonly default: "2001:db8:1:2::/48";
|
|
391
|
+
};
|
|
392
|
+
readonly service_cidr_v6: {
|
|
393
|
+
readonly type: "string";
|
|
394
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
395
|
+
readonly default: "2001:db8:1:1::/112";
|
|
396
|
+
};
|
|
397
|
+
};
|
|
398
|
+
readonly additionalProperties: false;
|
|
399
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
400
|
+
readonly default: {
|
|
401
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
402
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
403
|
+
readonly dual_stack: false;
|
|
404
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
405
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
406
|
+
};
|
|
302
407
|
};
|
|
303
408
|
};
|
|
304
|
-
readonly required: readonly ["name", "
|
|
409
|
+
readonly required: readonly ["name", "region"];
|
|
305
410
|
readonly additionalProperties: false;
|
|
411
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
306
412
|
};
|
|
307
413
|
export declare const ClusterJoinInformationSchema: {
|
|
308
414
|
readonly type: "object";
|
|
@@ -318,6 +424,16 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
318
424
|
readonly description: "Internal URL of the Kubernetes cluster control plane. This is the endpoint that kubelet uses to connect to the cluster.";
|
|
319
425
|
readonly example: "https://10.31.64.7:6443";
|
|
320
426
|
};
|
|
427
|
+
readonly cluster_dns: {
|
|
428
|
+
readonly type: "string";
|
|
429
|
+
readonly description: "Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.";
|
|
430
|
+
readonly example: "10.96.0.10";
|
|
431
|
+
};
|
|
432
|
+
readonly pod_cidr: {
|
|
433
|
+
readonly type: "string";
|
|
434
|
+
readonly description: "Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.";
|
|
435
|
+
readonly example: "10.244.0.0/16";
|
|
436
|
+
};
|
|
321
437
|
readonly auth_key: {
|
|
322
438
|
readonly type: "string";
|
|
323
439
|
readonly description: "Authentication key for the cluster.";
|
|
@@ -334,7 +450,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
334
450
|
readonly kubernetes: {
|
|
335
451
|
readonly type: "string";
|
|
336
452
|
readonly description: "Kubernetes version of the cluster.";
|
|
337
|
-
readonly example: "1.
|
|
453
|
+
readonly example: "1.33.7";
|
|
338
454
|
};
|
|
339
455
|
readonly tailscale: {
|
|
340
456
|
readonly type: "string";
|
|
@@ -346,8 +462,13 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
346
462
|
readonly description: "Containerd version of the cluster.";
|
|
347
463
|
readonly example: "1.7.19";
|
|
348
464
|
};
|
|
465
|
+
readonly nvidia_driver: {
|
|
466
|
+
readonly type: "string";
|
|
467
|
+
readonly description: "NVIDIA driver version of the cluster.";
|
|
468
|
+
readonly example: "565.0.0";
|
|
469
|
+
};
|
|
349
470
|
};
|
|
350
|
-
readonly required: readonly ["kubernetes", "tailscale", "containerd"];
|
|
471
|
+
readonly required: readonly ["kubernetes", "tailscale", "containerd", "nvidia_driver"];
|
|
351
472
|
readonly additionalProperties: false;
|
|
352
473
|
readonly description: "Versions of the different components of the cluster.";
|
|
353
474
|
};
|
|
@@ -375,7 +496,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
375
496
|
readonly description: "OIDC Information for hosts to access to third party API's.";
|
|
376
497
|
};
|
|
377
498
|
};
|
|
378
|
-
readonly required: readonly ["certificate_authority", "endpoint", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
499
|
+
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "pod_cidr", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
379
500
|
readonly additionalProperties: false;
|
|
380
501
|
};
|
|
381
502
|
export declare const ClusterSchema: {
|
|
@@ -389,25 +510,103 @@ export declare const ClusterSchema: {
|
|
|
389
510
|
readonly description: "Name of the cluster.";
|
|
390
511
|
readonly example: "production-cluster";
|
|
391
512
|
};
|
|
392
|
-
readonly region: {
|
|
393
|
-
readonly type: "string";
|
|
394
|
-
readonly description: "Cloudfleet control plane region. One of \"staging\", \"northamerica-central-1\". This field can not be updated after creation.";
|
|
395
|
-
readonly default: "staging";
|
|
396
|
-
readonly example: "northamerica-central-1";
|
|
397
|
-
readonly enum: readonly ["staging", "northamerica-central-1"];
|
|
398
|
-
};
|
|
399
513
|
readonly tier: {
|
|
400
514
|
readonly type: "string";
|
|
401
515
|
readonly description: "Tier of the cluster.";
|
|
516
|
+
readonly default: "basic";
|
|
402
517
|
readonly example: "pro";
|
|
403
|
-
readonly enum: readonly ["basic", "pro"];
|
|
518
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
404
519
|
};
|
|
405
520
|
readonly version_channel: {
|
|
406
521
|
readonly type: "string";
|
|
407
522
|
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-]+)*))?$";
|
|
408
523
|
readonly description: "Version of the kubernetes cluster.";
|
|
409
524
|
readonly default: "1.x.x-cfke.x";
|
|
410
|
-
readonly example: "1.
|
|
525
|
+
readonly example: "1.x.x-cfke.x";
|
|
526
|
+
};
|
|
527
|
+
readonly release_channel: {
|
|
528
|
+
readonly type: "string";
|
|
529
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
530
|
+
readonly default: "rapid";
|
|
531
|
+
readonly example: "rapid";
|
|
532
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
533
|
+
};
|
|
534
|
+
readonly features: {
|
|
535
|
+
readonly type: "object";
|
|
536
|
+
readonly properties: {
|
|
537
|
+
readonly gpu_sharing_strategy: {
|
|
538
|
+
readonly type: "string";
|
|
539
|
+
readonly description: "GPU sharing strategy.";
|
|
540
|
+
readonly default: "none";
|
|
541
|
+
readonly example: "none";
|
|
542
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
543
|
+
};
|
|
544
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
545
|
+
readonly type: "integer";
|
|
546
|
+
readonly minimum: 2;
|
|
547
|
+
readonly maximum: 48;
|
|
548
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
549
|
+
readonly default: 4;
|
|
550
|
+
readonly example: 10;
|
|
551
|
+
};
|
|
552
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
553
|
+
readonly type: "boolean";
|
|
554
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
555
|
+
readonly example: false;
|
|
556
|
+
};
|
|
557
|
+
};
|
|
558
|
+
readonly required: readonly ["gpu_sharing_strategy", "gpu_max_shared_clients_per_gpu", "cilium_socket_lb_host_namespace_only"];
|
|
559
|
+
readonly additionalProperties: false;
|
|
560
|
+
readonly description: "Cluster feature toggles.";
|
|
561
|
+
readonly default: {
|
|
562
|
+
readonly gpu_sharing_strategy: "none";
|
|
563
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
564
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
565
|
+
};
|
|
566
|
+
};
|
|
567
|
+
readonly region: {
|
|
568
|
+
readonly type: "string";
|
|
569
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
570
|
+
readonly example: "europe-central-1a";
|
|
571
|
+
};
|
|
572
|
+
readonly networking: {
|
|
573
|
+
readonly type: "object";
|
|
574
|
+
readonly properties: {
|
|
575
|
+
readonly pod_cidr: {
|
|
576
|
+
readonly type: "string";
|
|
577
|
+
readonly description: "CIDR block for pod IPs.";
|
|
578
|
+
readonly default: "10.244.0.0/16";
|
|
579
|
+
};
|
|
580
|
+
readonly service_cidr: {
|
|
581
|
+
readonly type: "string";
|
|
582
|
+
readonly description: "CIDR block for service IPs.";
|
|
583
|
+
readonly default: "10.96.0.0/12";
|
|
584
|
+
};
|
|
585
|
+
readonly dual_stack: {
|
|
586
|
+
readonly type: "boolean";
|
|
587
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
588
|
+
};
|
|
589
|
+
readonly pod_cidr_v6: {
|
|
590
|
+
readonly type: "string";
|
|
591
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
592
|
+
readonly default: "2001:db8:1:2::/48";
|
|
593
|
+
};
|
|
594
|
+
readonly service_cidr_v6: {
|
|
595
|
+
readonly type: "string";
|
|
596
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
597
|
+
readonly default: "2001:db8:1:1::/112";
|
|
598
|
+
};
|
|
599
|
+
};
|
|
600
|
+
readonly required: readonly ["pod_cidr", "service_cidr", "dual_stack", "pod_cidr_v6", "service_cidr_v6"];
|
|
601
|
+
readonly additionalProperties: false;
|
|
602
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
603
|
+
readonly default: {
|
|
604
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
605
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
606
|
+
readonly dual_stack: false;
|
|
607
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
608
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
609
|
+
};
|
|
411
610
|
};
|
|
412
611
|
readonly id: {
|
|
413
612
|
readonly type: "string";
|
|
@@ -417,16 +616,27 @@ export declare const ClusterSchema: {
|
|
|
417
616
|
};
|
|
418
617
|
readonly status: {
|
|
419
618
|
readonly type: "string";
|
|
420
|
-
readonly description: "Status of the cluster.
|
|
421
|
-
readonly example: "
|
|
422
|
-
readonly enum: readonly ["
|
|
619
|
+
readonly description: "Status of the cluster.";
|
|
620
|
+
readonly example: "deployed";
|
|
621
|
+
readonly enum: readonly ["creating", "deployed", "updating", "disabled"];
|
|
423
622
|
};
|
|
424
623
|
readonly endpoint: {
|
|
425
624
|
readonly anyOf: readonly [{
|
|
426
625
|
readonly type: "string";
|
|
427
626
|
readonly format: "uri";
|
|
428
|
-
readonly description: "URL of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
429
|
-
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
627
|
+
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.";
|
|
628
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
629
|
+
}, {
|
|
630
|
+
readonly type: "string";
|
|
631
|
+
readonly enum: readonly [""];
|
|
632
|
+
}];
|
|
633
|
+
};
|
|
634
|
+
readonly endpoint_public: {
|
|
635
|
+
readonly anyOf: readonly [{
|
|
636
|
+
readonly type: "string";
|
|
637
|
+
readonly format: "uri";
|
|
638
|
+
readonly description: "Deprecated alias of `endpoint`; retained for backward compatibility.";
|
|
639
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
430
640
|
}, {
|
|
431
641
|
readonly type: "string";
|
|
432
642
|
readonly enum: readonly [""];
|
|
@@ -440,7 +650,7 @@ export declare const ClusterSchema: {
|
|
|
440
650
|
readonly version_current: {
|
|
441
651
|
readonly type: "string";
|
|
442
652
|
readonly description: "Current version of the cluster.";
|
|
443
|
-
readonly example: "1.
|
|
653
|
+
readonly example: "1.33.7-cfke.264";
|
|
444
654
|
};
|
|
445
655
|
readonly created_at: {
|
|
446
656
|
readonly type: "string";
|
|
@@ -458,8 +668,9 @@ export declare const ClusterSchema: {
|
|
|
458
668
|
readonly example: true;
|
|
459
669
|
};
|
|
460
670
|
};
|
|
461
|
-
readonly required: readonly ["name", "tier", "id", "status"];
|
|
671
|
+
readonly required: readonly ["name", "tier", "version_channel", "release_channel", "features", "region", "networking", "id", "status", "ready"];
|
|
462
672
|
readonly additionalProperties: false;
|
|
673
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
463
674
|
};
|
|
464
675
|
export declare const ClusterUpdateInputSchema: {
|
|
465
676
|
readonly type: "object";
|
|
@@ -472,14 +683,63 @@ export declare const ClusterUpdateInputSchema: {
|
|
|
472
683
|
readonly description: "Name of the cluster.";
|
|
473
684
|
readonly example: "production-cluster";
|
|
474
685
|
};
|
|
686
|
+
readonly tier: {
|
|
687
|
+
readonly type: "string";
|
|
688
|
+
readonly description: "Tier of the cluster.";
|
|
689
|
+
readonly default: "basic";
|
|
690
|
+
readonly example: "pro";
|
|
691
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
692
|
+
};
|
|
475
693
|
readonly version_channel: {
|
|
476
694
|
readonly type: "string";
|
|
477
695
|
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-]+)*))?$";
|
|
478
696
|
readonly description: "Version of the kubernetes cluster.";
|
|
479
|
-
readonly
|
|
697
|
+
readonly default: "1.x.x-cfke.x";
|
|
698
|
+
readonly example: "1.x.x-cfke.x";
|
|
699
|
+
};
|
|
700
|
+
readonly release_channel: {
|
|
701
|
+
readonly type: "string";
|
|
702
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
703
|
+
readonly default: "rapid";
|
|
704
|
+
readonly example: "rapid";
|
|
705
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
706
|
+
};
|
|
707
|
+
readonly features: {
|
|
708
|
+
readonly type: "object";
|
|
709
|
+
readonly properties: {
|
|
710
|
+
readonly gpu_sharing_strategy: {
|
|
711
|
+
readonly type: "string";
|
|
712
|
+
readonly description: "GPU sharing strategy.";
|
|
713
|
+
readonly default: "none";
|
|
714
|
+
readonly example: "none";
|
|
715
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
716
|
+
};
|
|
717
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
718
|
+
readonly type: "integer";
|
|
719
|
+
readonly minimum: 2;
|
|
720
|
+
readonly maximum: 48;
|
|
721
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
722
|
+
readonly default: 4;
|
|
723
|
+
readonly example: 10;
|
|
724
|
+
};
|
|
725
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
726
|
+
readonly type: "boolean";
|
|
727
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
728
|
+
readonly example: false;
|
|
729
|
+
};
|
|
730
|
+
};
|
|
731
|
+
readonly additionalProperties: false;
|
|
732
|
+
readonly description: "Cluster feature toggles.";
|
|
733
|
+
readonly default: {
|
|
734
|
+
readonly gpu_sharing_strategy: "none";
|
|
735
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
736
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
737
|
+
};
|
|
480
738
|
};
|
|
481
739
|
};
|
|
740
|
+
readonly required: readonly ["name"];
|
|
482
741
|
readonly additionalProperties: false;
|
|
742
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
483
743
|
};
|
|
484
744
|
export declare const FleetCreateInputSchema: {
|
|
485
745
|
readonly type: "object";
|
|
@@ -488,13 +748,12 @@ export declare const FleetCreateInputSchema: {
|
|
|
488
748
|
readonly type: "object";
|
|
489
749
|
readonly properties: {
|
|
490
750
|
readonly cpu: {
|
|
491
|
-
readonly type: "
|
|
492
|
-
readonly format: "float";
|
|
751
|
+
readonly type: "integer";
|
|
493
752
|
readonly minimum: 0;
|
|
494
|
-
readonly
|
|
753
|
+
readonly maximum: 100000;
|
|
754
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
495
755
|
};
|
|
496
756
|
};
|
|
497
|
-
readonly required: readonly ["cpu"];
|
|
498
757
|
readonly additionalProperties: false;
|
|
499
758
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
500
759
|
};
|
|
@@ -503,14 +762,15 @@ export declare const FleetCreateInputSchema: {
|
|
|
503
762
|
readonly properties: {
|
|
504
763
|
readonly enabled: {
|
|
505
764
|
readonly type: "boolean";
|
|
506
|
-
readonly default: true;
|
|
507
765
|
};
|
|
508
766
|
readonly project: {
|
|
509
767
|
readonly type: "string";
|
|
510
|
-
readonly
|
|
768
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
769
|
+
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.";
|
|
770
|
+
readonly example: "my-cloudfleet-project";
|
|
511
771
|
};
|
|
512
772
|
};
|
|
513
|
-
readonly required: readonly ["
|
|
773
|
+
readonly required: readonly ["enabled"];
|
|
514
774
|
readonly additionalProperties: false;
|
|
515
775
|
};
|
|
516
776
|
readonly hetzner: {
|
|
@@ -518,14 +778,16 @@ export declare const FleetCreateInputSchema: {
|
|
|
518
778
|
readonly properties: {
|
|
519
779
|
readonly enabled: {
|
|
520
780
|
readonly type: "boolean";
|
|
521
|
-
readonly default: true;
|
|
522
781
|
};
|
|
523
782
|
readonly apiKey: {
|
|
524
783
|
readonly type: "string";
|
|
525
|
-
readonly
|
|
784
|
+
readonly maxLength: 64;
|
|
785
|
+
readonly minLength: 64;
|
|
786
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
787
|
+
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.";
|
|
526
788
|
};
|
|
527
789
|
};
|
|
528
|
-
readonly required: readonly ["
|
|
790
|
+
readonly required: readonly ["enabled"];
|
|
529
791
|
readonly additionalProperties: false;
|
|
530
792
|
};
|
|
531
793
|
readonly aws: {
|
|
@@ -533,15 +795,74 @@ export declare const FleetCreateInputSchema: {
|
|
|
533
795
|
readonly properties: {
|
|
534
796
|
readonly enabled: {
|
|
535
797
|
readonly type: "boolean";
|
|
536
|
-
readonly default: true;
|
|
537
798
|
};
|
|
538
799
|
readonly controllerRoleArn: {
|
|
539
800
|
readonly type: "string";
|
|
540
|
-
readonly
|
|
801
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
802
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
803
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
804
|
+
};
|
|
805
|
+
};
|
|
806
|
+
readonly required: readonly ["enabled"];
|
|
807
|
+
readonly additionalProperties: false;
|
|
808
|
+
};
|
|
809
|
+
readonly constraints: {
|
|
810
|
+
readonly type: "object";
|
|
811
|
+
readonly properties: {
|
|
812
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
813
|
+
readonly type: "array";
|
|
814
|
+
readonly items: {
|
|
815
|
+
readonly type: "string";
|
|
816
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
817
|
+
};
|
|
818
|
+
readonly minItems: 1;
|
|
819
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
820
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
821
|
+
};
|
|
822
|
+
readonly 'kubernetes.io/arch': {
|
|
823
|
+
readonly type: "array";
|
|
824
|
+
readonly items: {
|
|
825
|
+
readonly type: "string";
|
|
826
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
827
|
+
};
|
|
828
|
+
readonly minItems: 1;
|
|
829
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
830
|
+
readonly default: readonly ["amd64"];
|
|
831
|
+
};
|
|
832
|
+
readonly 'cfke.io/instance-family': {
|
|
833
|
+
readonly type: "array";
|
|
834
|
+
readonly items: {
|
|
835
|
+
readonly type: "string";
|
|
836
|
+
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"];
|
|
837
|
+
};
|
|
838
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
839
|
+
readonly default: readonly [];
|
|
840
|
+
};
|
|
841
|
+
readonly 'topology.kubernetes.io/region': {
|
|
842
|
+
readonly type: "array";
|
|
843
|
+
readonly items: {
|
|
844
|
+
readonly type: "string";
|
|
845
|
+
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"];
|
|
846
|
+
};
|
|
847
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
848
|
+
readonly default: readonly [];
|
|
541
849
|
};
|
|
542
850
|
};
|
|
543
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
544
851
|
readonly additionalProperties: false;
|
|
852
|
+
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.";
|
|
853
|
+
readonly default: {
|
|
854
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
855
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
856
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
857
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
858
|
+
};
|
|
859
|
+
};
|
|
860
|
+
readonly scalingProfile: {
|
|
861
|
+
readonly type: "string";
|
|
862
|
+
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`).";
|
|
863
|
+
readonly default: "conservative";
|
|
864
|
+
readonly example: "conservative";
|
|
865
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
545
866
|
};
|
|
546
867
|
readonly id: {
|
|
547
868
|
readonly type: "string";
|
|
@@ -554,6 +875,7 @@ export declare const FleetCreateInputSchema: {
|
|
|
554
875
|
};
|
|
555
876
|
readonly required: readonly ["id"];
|
|
556
877
|
readonly additionalProperties: false;
|
|
878
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
557
879
|
};
|
|
558
880
|
export declare const FleetSchema: {
|
|
559
881
|
readonly type: "object";
|
|
@@ -562,13 +884,12 @@ export declare const FleetSchema: {
|
|
|
562
884
|
readonly type: "object";
|
|
563
885
|
readonly properties: {
|
|
564
886
|
readonly cpu: {
|
|
565
|
-
readonly type: "
|
|
566
|
-
readonly format: "float";
|
|
887
|
+
readonly type: "integer";
|
|
567
888
|
readonly minimum: 0;
|
|
568
|
-
readonly
|
|
889
|
+
readonly maximum: 100000;
|
|
890
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
569
891
|
};
|
|
570
892
|
};
|
|
571
|
-
readonly required: readonly ["cpu"];
|
|
572
893
|
readonly additionalProperties: false;
|
|
573
894
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
574
895
|
};
|
|
@@ -577,14 +898,15 @@ export declare const FleetSchema: {
|
|
|
577
898
|
readonly properties: {
|
|
578
899
|
readonly enabled: {
|
|
579
900
|
readonly type: "boolean";
|
|
580
|
-
readonly default: true;
|
|
581
901
|
};
|
|
582
902
|
readonly project: {
|
|
583
903
|
readonly type: "string";
|
|
584
|
-
readonly
|
|
904
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
905
|
+
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.";
|
|
906
|
+
readonly example: "my-cloudfleet-project";
|
|
585
907
|
};
|
|
586
908
|
};
|
|
587
|
-
readonly required: readonly ["
|
|
909
|
+
readonly required: readonly ["enabled"];
|
|
588
910
|
readonly additionalProperties: false;
|
|
589
911
|
};
|
|
590
912
|
readonly hetzner: {
|
|
@@ -592,14 +914,14 @@ export declare const FleetSchema: {
|
|
|
592
914
|
readonly properties: {
|
|
593
915
|
readonly enabled: {
|
|
594
916
|
readonly type: "boolean";
|
|
595
|
-
readonly default: true;
|
|
596
917
|
};
|
|
597
918
|
readonly apiKey: {
|
|
598
919
|
readonly type: "string";
|
|
599
|
-
readonly
|
|
920
|
+
readonly pattern: "^\\*{64}$";
|
|
921
|
+
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.";
|
|
600
922
|
};
|
|
601
923
|
};
|
|
602
|
-
readonly required: readonly ["
|
|
924
|
+
readonly required: readonly ["enabled"];
|
|
603
925
|
readonly additionalProperties: false;
|
|
604
926
|
};
|
|
605
927
|
readonly aws: {
|
|
@@ -607,15 +929,75 @@ export declare const FleetSchema: {
|
|
|
607
929
|
readonly properties: {
|
|
608
930
|
readonly enabled: {
|
|
609
931
|
readonly type: "boolean";
|
|
610
|
-
readonly default: true;
|
|
611
932
|
};
|
|
612
933
|
readonly controllerRoleArn: {
|
|
613
934
|
readonly type: "string";
|
|
614
|
-
readonly
|
|
935
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
936
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
937
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
938
|
+
};
|
|
939
|
+
};
|
|
940
|
+
readonly required: readonly ["enabled"];
|
|
941
|
+
readonly additionalProperties: false;
|
|
942
|
+
};
|
|
943
|
+
readonly constraints: {
|
|
944
|
+
readonly type: "object";
|
|
945
|
+
readonly properties: {
|
|
946
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
947
|
+
readonly type: "array";
|
|
948
|
+
readonly items: {
|
|
949
|
+
readonly type: "string";
|
|
950
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
951
|
+
};
|
|
952
|
+
readonly minItems: 1;
|
|
953
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
954
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
955
|
+
};
|
|
956
|
+
readonly 'kubernetes.io/arch': {
|
|
957
|
+
readonly type: "array";
|
|
958
|
+
readonly items: {
|
|
959
|
+
readonly type: "string";
|
|
960
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
961
|
+
};
|
|
962
|
+
readonly minItems: 1;
|
|
963
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
964
|
+
readonly default: readonly ["amd64"];
|
|
965
|
+
};
|
|
966
|
+
readonly 'cfke.io/instance-family': {
|
|
967
|
+
readonly type: "array";
|
|
968
|
+
readonly items: {
|
|
969
|
+
readonly type: "string";
|
|
970
|
+
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"];
|
|
971
|
+
};
|
|
972
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
973
|
+
readonly default: readonly [];
|
|
974
|
+
};
|
|
975
|
+
readonly 'topology.kubernetes.io/region': {
|
|
976
|
+
readonly type: "array";
|
|
977
|
+
readonly items: {
|
|
978
|
+
readonly type: "string";
|
|
979
|
+
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"];
|
|
980
|
+
};
|
|
981
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
982
|
+
readonly default: readonly [];
|
|
615
983
|
};
|
|
616
984
|
};
|
|
617
|
-
readonly required: readonly ["
|
|
985
|
+
readonly required: readonly ["karpenter.sh/capacity-type", "kubernetes.io/arch"];
|
|
618
986
|
readonly additionalProperties: false;
|
|
987
|
+
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.";
|
|
988
|
+
readonly default: {
|
|
989
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
990
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
991
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
992
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
993
|
+
};
|
|
994
|
+
};
|
|
995
|
+
readonly scalingProfile: {
|
|
996
|
+
readonly type: "string";
|
|
997
|
+
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`).";
|
|
998
|
+
readonly default: "conservative";
|
|
999
|
+
readonly example: "conservative";
|
|
1000
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
619
1001
|
};
|
|
620
1002
|
readonly id: {
|
|
621
1003
|
readonly type: "string";
|
|
@@ -625,9 +1007,30 @@ export declare const FleetSchema: {
|
|
|
625
1007
|
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
626
1008
|
readonly example: "new-clouds-fleet";
|
|
627
1009
|
};
|
|
1010
|
+
readonly ready: {
|
|
1011
|
+
readonly type: "boolean";
|
|
1012
|
+
readonly description: "Indicates whether the fleet configuration is healthy.";
|
|
1013
|
+
readonly example: true;
|
|
1014
|
+
};
|
|
1015
|
+
readonly status_message: {
|
|
1016
|
+
readonly type: "string";
|
|
1017
|
+
readonly description: "Human-readable reason the fleet is not ready. Present only when `ready` is false.";
|
|
1018
|
+
readonly example: "Invalid provider permissions.";
|
|
1019
|
+
};
|
|
1020
|
+
readonly created_at: {
|
|
1021
|
+
readonly type: "string";
|
|
1022
|
+
readonly description: "Creation date and time of the fleet.";
|
|
1023
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
1024
|
+
};
|
|
1025
|
+
readonly updated_at: {
|
|
1026
|
+
readonly type: "string";
|
|
1027
|
+
readonly description: "Date and time the fleet was last updated.";
|
|
1028
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
1029
|
+
};
|
|
628
1030
|
};
|
|
629
|
-
readonly required: readonly ["id"];
|
|
1031
|
+
readonly required: readonly ["constraints", "scalingProfile", "id", "ready", "created_at", "updated_at"];
|
|
630
1032
|
readonly additionalProperties: false;
|
|
1033
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
631
1034
|
};
|
|
632
1035
|
export declare const FleetUpdateInputSchema: {
|
|
633
1036
|
readonly type: "object";
|
|
@@ -636,13 +1039,12 @@ export declare const FleetUpdateInputSchema: {
|
|
|
636
1039
|
readonly type: "object";
|
|
637
1040
|
readonly properties: {
|
|
638
1041
|
readonly cpu: {
|
|
639
|
-
readonly type: "
|
|
640
|
-
readonly format: "float";
|
|
1042
|
+
readonly type: "integer";
|
|
641
1043
|
readonly minimum: 0;
|
|
642
|
-
readonly
|
|
1044
|
+
readonly maximum: 100000;
|
|
1045
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
643
1046
|
};
|
|
644
1047
|
};
|
|
645
|
-
readonly required: readonly ["cpu"];
|
|
646
1048
|
readonly additionalProperties: false;
|
|
647
1049
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
648
1050
|
};
|
|
@@ -651,14 +1053,15 @@ export declare const FleetUpdateInputSchema: {
|
|
|
651
1053
|
readonly properties: {
|
|
652
1054
|
readonly enabled: {
|
|
653
1055
|
readonly type: "boolean";
|
|
654
|
-
readonly default: true;
|
|
655
1056
|
};
|
|
656
1057
|
readonly project: {
|
|
657
1058
|
readonly type: "string";
|
|
658
|
-
readonly
|
|
1059
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
1060
|
+
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.";
|
|
1061
|
+
readonly example: "my-cloudfleet-project";
|
|
659
1062
|
};
|
|
660
1063
|
};
|
|
661
|
-
readonly required: readonly ["
|
|
1064
|
+
readonly required: readonly ["enabled"];
|
|
662
1065
|
readonly additionalProperties: false;
|
|
663
1066
|
};
|
|
664
1067
|
readonly hetzner: {
|
|
@@ -666,14 +1069,16 @@ export declare const FleetUpdateInputSchema: {
|
|
|
666
1069
|
readonly properties: {
|
|
667
1070
|
readonly enabled: {
|
|
668
1071
|
readonly type: "boolean";
|
|
669
|
-
readonly default: true;
|
|
670
1072
|
};
|
|
671
1073
|
readonly apiKey: {
|
|
672
1074
|
readonly type: "string";
|
|
673
|
-
readonly
|
|
1075
|
+
readonly maxLength: 64;
|
|
1076
|
+
readonly minLength: 64;
|
|
1077
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
1078
|
+
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.";
|
|
674
1079
|
};
|
|
675
1080
|
};
|
|
676
|
-
readonly required: readonly ["
|
|
1081
|
+
readonly required: readonly ["enabled"];
|
|
677
1082
|
readonly additionalProperties: false;
|
|
678
1083
|
};
|
|
679
1084
|
readonly aws: {
|
|
@@ -681,21 +1086,101 @@ export declare const FleetUpdateInputSchema: {
|
|
|
681
1086
|
readonly properties: {
|
|
682
1087
|
readonly enabled: {
|
|
683
1088
|
readonly type: "boolean";
|
|
684
|
-
readonly default: true;
|
|
685
1089
|
};
|
|
686
1090
|
readonly controllerRoleArn: {
|
|
687
1091
|
readonly type: "string";
|
|
688
|
-
readonly
|
|
1092
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
1093
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
1094
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
689
1095
|
};
|
|
690
1096
|
};
|
|
691
|
-
readonly required: readonly ["
|
|
1097
|
+
readonly required: readonly ["enabled"];
|
|
692
1098
|
readonly additionalProperties: false;
|
|
693
1099
|
};
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
1100
|
+
readonly constraints: {
|
|
1101
|
+
readonly type: "object";
|
|
1102
|
+
readonly properties: {
|
|
1103
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
1104
|
+
readonly type: "array";
|
|
1105
|
+
readonly items: {
|
|
1106
|
+
readonly type: "string";
|
|
1107
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
1108
|
+
};
|
|
1109
|
+
readonly minItems: 1;
|
|
1110
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
1111
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
1112
|
+
};
|
|
1113
|
+
readonly 'kubernetes.io/arch': {
|
|
1114
|
+
readonly type: "array";
|
|
1115
|
+
readonly items: {
|
|
1116
|
+
readonly type: "string";
|
|
1117
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
1118
|
+
};
|
|
1119
|
+
readonly minItems: 1;
|
|
1120
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
1121
|
+
readonly default: readonly ["amd64"];
|
|
1122
|
+
};
|
|
1123
|
+
readonly 'cfke.io/instance-family': {
|
|
1124
|
+
readonly type: "array";
|
|
1125
|
+
readonly items: {
|
|
1126
|
+
readonly type: "string";
|
|
1127
|
+
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"];
|
|
1128
|
+
};
|
|
1129
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
1130
|
+
readonly default: readonly [];
|
|
1131
|
+
};
|
|
1132
|
+
readonly 'topology.kubernetes.io/region': {
|
|
1133
|
+
readonly type: "array";
|
|
1134
|
+
readonly items: {
|
|
1135
|
+
readonly type: "string";
|
|
1136
|
+
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"];
|
|
1137
|
+
};
|
|
1138
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
1139
|
+
readonly default: readonly [];
|
|
1140
|
+
};
|
|
1141
|
+
};
|
|
1142
|
+
readonly additionalProperties: false;
|
|
1143
|
+
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.";
|
|
1144
|
+
readonly default: {
|
|
1145
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
1146
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
1147
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
1148
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
1149
|
+
};
|
|
1150
|
+
};
|
|
1151
|
+
readonly scalingProfile: {
|
|
1152
|
+
readonly type: "string";
|
|
1153
|
+
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`).";
|
|
1154
|
+
readonly default: "conservative";
|
|
1155
|
+
readonly example: "conservative";
|
|
1156
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
1157
|
+
};
|
|
1158
|
+
};
|
|
1159
|
+
readonly additionalProperties: false;
|
|
1160
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
1161
|
+
};
|
|
1162
|
+
export declare const InviteCreateInputSchema: {
|
|
1163
|
+
readonly type: "object";
|
|
1164
|
+
readonly properties: {
|
|
1165
|
+
readonly email: {
|
|
1166
|
+
readonly type: "string";
|
|
1167
|
+
readonly format: "email";
|
|
1168
|
+
readonly description: "Email address of the user to invite.";
|
|
1169
|
+
readonly example: "email@example.com";
|
|
1170
|
+
};
|
|
1171
|
+
readonly role: {
|
|
1172
|
+
readonly type: "string";
|
|
1173
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1174
|
+
readonly default: "User";
|
|
1175
|
+
readonly example: "User";
|
|
1176
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1177
|
+
};
|
|
1178
|
+
};
|
|
1179
|
+
readonly required: readonly ["email"];
|
|
1180
|
+
readonly additionalProperties: false;
|
|
1181
|
+
};
|
|
1182
|
+
export declare const InviteSchema: {
|
|
1183
|
+
readonly type: "object";
|
|
699
1184
|
readonly properties: {
|
|
700
1185
|
readonly id: {
|
|
701
1186
|
readonly type: "string";
|
|
@@ -725,6 +1210,13 @@ export declare const InviteSchema: {
|
|
|
725
1210
|
readonly description: "Generated unique invite code.";
|
|
726
1211
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
727
1212
|
};
|
|
1213
|
+
readonly role: {
|
|
1214
|
+
readonly type: "string";
|
|
1215
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1216
|
+
readonly default: "User";
|
|
1217
|
+
readonly example: "User";
|
|
1218
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1219
|
+
};
|
|
728
1220
|
};
|
|
729
1221
|
readonly required: readonly ["date_created"];
|
|
730
1222
|
readonly additionalProperties: false;
|
|
@@ -734,23 +1226,18 @@ export declare const InvoiceSchema: {
|
|
|
734
1226
|
readonly properties: {
|
|
735
1227
|
readonly id: {
|
|
736
1228
|
readonly type: "string";
|
|
737
|
-
readonly
|
|
738
|
-
readonly
|
|
739
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
1229
|
+
readonly description: "Unique identifier of the invoice.";
|
|
1230
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
740
1231
|
};
|
|
741
|
-
readonly
|
|
1232
|
+
readonly number: {
|
|
742
1233
|
readonly type: "string";
|
|
743
|
-
readonly format: "uuid";
|
|
744
|
-
readonly description: "Unique identifier of the organization. UUID v4 string in canonical form";
|
|
745
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
746
1234
|
};
|
|
747
1235
|
readonly status: {
|
|
748
1236
|
readonly type: "string";
|
|
749
1237
|
readonly description: "Status of the invoice";
|
|
750
|
-
readonly example: "
|
|
751
|
-
readonly enum: readonly ["DRAFT", "COMMITTED", "VOID"];
|
|
1238
|
+
readonly example: "paid";
|
|
752
1239
|
};
|
|
753
|
-
readonly
|
|
1240
|
+
readonly total: {
|
|
754
1241
|
readonly type: "number";
|
|
755
1242
|
readonly format: "float";
|
|
756
1243
|
readonly description: "Total amount of the invoice";
|
|
@@ -759,405 +1246,180 @@ export declare const InvoiceSchema: {
|
|
|
759
1246
|
readonly currency: {
|
|
760
1247
|
readonly type: "string";
|
|
761
1248
|
readonly description: "Currency of the invoice";
|
|
762
|
-
readonly example: "
|
|
763
|
-
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"];
|
|
764
|
-
};
|
|
765
|
-
readonly creditAdj: {
|
|
766
|
-
readonly type: "number";
|
|
767
|
-
readonly format: "float";
|
|
768
|
-
readonly description: "Total amount of credit adjustments";
|
|
769
|
-
readonly example: 0;
|
|
770
|
-
};
|
|
771
|
-
readonly refundAdj: {
|
|
772
|
-
readonly type: "number";
|
|
773
|
-
readonly format: "float";
|
|
774
|
-
readonly description: "Total amount of refund adjustments";
|
|
775
|
-
readonly example: 0;
|
|
1249
|
+
readonly example: "usd";
|
|
776
1250
|
};
|
|
777
|
-
readonly
|
|
1251
|
+
readonly created: {
|
|
778
1252
|
readonly type: "string";
|
|
779
|
-
readonly
|
|
780
|
-
readonly
|
|
1253
|
+
readonly format: "date-time";
|
|
1254
|
+
readonly description: "Timestamp when the invoice was issued. ISO 8601 date string in the UTC timezone.";
|
|
1255
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
781
1256
|
};
|
|
782
|
-
readonly
|
|
1257
|
+
readonly period_start: {
|
|
783
1258
|
readonly type: "string";
|
|
784
|
-
readonly
|
|
785
|
-
readonly
|
|
1259
|
+
readonly format: "date-time";
|
|
1260
|
+
readonly description: "Billing period start timestamp. ISO 8601 date string in the UTC timezone.";
|
|
1261
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
786
1262
|
};
|
|
787
|
-
readonly
|
|
1263
|
+
readonly period_end: {
|
|
788
1264
|
readonly type: "string";
|
|
789
|
-
readonly
|
|
790
|
-
readonly
|
|
791
|
-
|
|
792
|
-
readonly balance: {
|
|
793
|
-
readonly type: "number";
|
|
794
|
-
readonly format: "float";
|
|
795
|
-
readonly description: "Balance of the invoice";
|
|
796
|
-
readonly example: 100;
|
|
1265
|
+
readonly format: "date-time";
|
|
1266
|
+
readonly description: "Billing period end timestamp. ISO 8601 date string in the UTC timezone.";
|
|
1267
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
797
1268
|
};
|
|
798
|
-
readonly
|
|
1269
|
+
readonly invoice_pdf: {
|
|
799
1270
|
readonly type: "string";
|
|
800
|
-
readonly description: "Bundle keys of the invoice";
|
|
801
|
-
readonly example: "bundleKey1,bundleKey2";
|
|
802
|
-
};
|
|
803
|
-
readonly credits: {
|
|
804
|
-
readonly type: "array";
|
|
805
|
-
readonly items: {
|
|
806
|
-
readonly type: "object";
|
|
807
|
-
readonly properties: {
|
|
808
|
-
readonly id: {
|
|
809
|
-
readonly type: "string";
|
|
810
|
-
readonly format: "uuid";
|
|
811
|
-
readonly description: "Unique identifier of the invoice item. UUID v4 string in canonical form";
|
|
812
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
813
|
-
};
|
|
814
|
-
readonly linkedInvoiceItemId: {
|
|
815
|
-
readonly type: "string";
|
|
816
|
-
readonly format: "uuid";
|
|
817
|
-
readonly description: "Unique identifier of the linked invoice item. UUID v4 string in canonical form";
|
|
818
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
819
|
-
};
|
|
820
|
-
readonly productName: {
|
|
821
|
-
readonly type: "string";
|
|
822
|
-
readonly description: "Name of the product";
|
|
823
|
-
readonly example: "Research team";
|
|
824
|
-
};
|
|
825
|
-
readonly planName: {
|
|
826
|
-
readonly type: "string";
|
|
827
|
-
readonly description: "Name of the plan";
|
|
828
|
-
readonly example: "Plan A";
|
|
829
|
-
};
|
|
830
|
-
readonly phaseName: {
|
|
831
|
-
readonly type: "string";
|
|
832
|
-
readonly description: "Name of the phase";
|
|
833
|
-
readonly example: "Phase A";
|
|
834
|
-
};
|
|
835
|
-
readonly usageName: {
|
|
836
|
-
readonly type: "string";
|
|
837
|
-
readonly description: "Name of the usage";
|
|
838
|
-
readonly example: "Usage A";
|
|
839
|
-
};
|
|
840
|
-
readonly prettyProductName: {
|
|
841
|
-
readonly type: "string";
|
|
842
|
-
readonly description: "Pretty name of the product";
|
|
843
|
-
readonly example: "Research team";
|
|
844
|
-
};
|
|
845
|
-
readonly prettyPlanName: {
|
|
846
|
-
readonly type: "string";
|
|
847
|
-
readonly description: "Pretty name of the plan";
|
|
848
|
-
readonly example: "Plan A";
|
|
849
|
-
};
|
|
850
|
-
readonly prettyPhaseName: {
|
|
851
|
-
readonly type: "string";
|
|
852
|
-
readonly description: "Pretty name of the phase";
|
|
853
|
-
readonly example: "Phase A";
|
|
854
|
-
};
|
|
855
|
-
readonly prettyUsageName: {
|
|
856
|
-
readonly type: "string";
|
|
857
|
-
readonly description: "Pretty name of the usage";
|
|
858
|
-
readonly example: "Usage A";
|
|
859
|
-
};
|
|
860
|
-
readonly itemType: {
|
|
861
|
-
readonly type: "string";
|
|
862
|
-
readonly description: "Type of the invoice item";
|
|
863
|
-
readonly example: "EXTERNAL_CHARGE";
|
|
864
|
-
readonly enum: readonly ["EXTERNAL_CHARGE", "FIXED", "RECURRING", "REPAIR_ADJ", "CBA_ADJ", "CREDIT_ADJ", "ITEM_ADJ", "USAGE", "TAX", "PARENT_SUMMARY"];
|
|
865
|
-
};
|
|
866
|
-
readonly description: {
|
|
867
|
-
readonly type: "string";
|
|
868
|
-
readonly description: "Description of the invoice item";
|
|
869
|
-
readonly example: "Description of the invoice item";
|
|
870
|
-
};
|
|
871
|
-
readonly startDate: {
|
|
872
|
-
readonly type: "string";
|
|
873
|
-
readonly description: "Start date of the invoice item";
|
|
874
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
875
|
-
};
|
|
876
|
-
readonly endDate: {
|
|
877
|
-
readonly type: "string";
|
|
878
|
-
readonly description: "End date of the invoice item";
|
|
879
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
880
|
-
};
|
|
881
|
-
readonly amount: {
|
|
882
|
-
readonly type: "number";
|
|
883
|
-
readonly format: "float";
|
|
884
|
-
readonly description: "Amount of the invoice item";
|
|
885
|
-
readonly example: 100;
|
|
886
|
-
};
|
|
887
|
-
readonly rate: {
|
|
888
|
-
readonly type: "number";
|
|
889
|
-
readonly format: "float";
|
|
890
|
-
readonly description: "Rate of the invoice item";
|
|
891
|
-
readonly example: 100;
|
|
892
|
-
};
|
|
893
|
-
readonly currency: {
|
|
894
|
-
readonly type: "string";
|
|
895
|
-
readonly description: "Currency of the invoice item";
|
|
896
|
-
readonly example: "USD";
|
|
897
|
-
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"];
|
|
898
|
-
};
|
|
899
|
-
readonly quantity: {
|
|
900
|
-
readonly type: "number";
|
|
901
|
-
readonly format: "float";
|
|
902
|
-
readonly description: "Quantity of the invoice item";
|
|
903
|
-
readonly example: 1;
|
|
904
|
-
};
|
|
905
|
-
readonly itemDetails: {
|
|
906
|
-
readonly type: "string";
|
|
907
|
-
readonly description: "Details of the invoice item";
|
|
908
|
-
readonly example: "Details of the invoice item";
|
|
909
|
-
};
|
|
910
|
-
readonly catalogEffectiveDate: {
|
|
911
|
-
readonly type: "string";
|
|
912
|
-
readonly description: "Effective date of the catalog";
|
|
913
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
914
|
-
};
|
|
915
|
-
readonly childItems: {
|
|
916
|
-
readonly type: "array";
|
|
917
|
-
readonly items: {
|
|
918
|
-
readonly oneOf: readonly [{
|
|
919
|
-
readonly type: "array";
|
|
920
|
-
}, {
|
|
921
|
-
readonly type: "boolean";
|
|
922
|
-
}, {
|
|
923
|
-
readonly type: "number";
|
|
924
|
-
}, {
|
|
925
|
-
readonly type: "object";
|
|
926
|
-
readonly additionalProperties: true;
|
|
927
|
-
}, {
|
|
928
|
-
readonly type: "string";
|
|
929
|
-
}];
|
|
930
|
-
};
|
|
931
|
-
readonly description: "Child items of the invoice item";
|
|
932
|
-
};
|
|
933
|
-
};
|
|
934
|
-
readonly additionalProperties: false;
|
|
935
|
-
};
|
|
936
|
-
readonly description: "Credits of the invoice";
|
|
937
|
-
};
|
|
938
|
-
readonly items: {
|
|
939
|
-
readonly type: "array";
|
|
940
|
-
readonly items: {
|
|
941
|
-
readonly type: "object";
|
|
942
|
-
readonly properties: {
|
|
943
|
-
readonly id: {
|
|
944
|
-
readonly type: "string";
|
|
945
|
-
readonly format: "uuid";
|
|
946
|
-
readonly description: "Unique identifier of the invoice item. UUID v4 string in canonical form";
|
|
947
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
948
|
-
};
|
|
949
|
-
readonly linkedInvoiceItemId: {
|
|
950
|
-
readonly type: "string";
|
|
951
|
-
readonly format: "uuid";
|
|
952
|
-
readonly description: "Unique identifier of the linked invoice item. UUID v4 string in canonical form";
|
|
953
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
954
|
-
};
|
|
955
|
-
readonly productName: {
|
|
956
|
-
readonly type: "string";
|
|
957
|
-
readonly description: "Name of the product";
|
|
958
|
-
readonly example: "Research team";
|
|
959
|
-
};
|
|
960
|
-
readonly planName: {
|
|
961
|
-
readonly type: "string";
|
|
962
|
-
readonly description: "Name of the plan";
|
|
963
|
-
readonly example: "Plan A";
|
|
964
|
-
};
|
|
965
|
-
readonly phaseName: {
|
|
966
|
-
readonly type: "string";
|
|
967
|
-
readonly description: "Name of the phase";
|
|
968
|
-
readonly example: "Phase A";
|
|
969
|
-
};
|
|
970
|
-
readonly usageName: {
|
|
971
|
-
readonly type: "string";
|
|
972
|
-
readonly description: "Name of the usage";
|
|
973
|
-
readonly example: "Usage A";
|
|
974
|
-
};
|
|
975
|
-
readonly prettyProductName: {
|
|
976
|
-
readonly type: "string";
|
|
977
|
-
readonly description: "Pretty name of the product";
|
|
978
|
-
readonly example: "Research team";
|
|
979
|
-
};
|
|
980
|
-
readonly prettyPlanName: {
|
|
981
|
-
readonly type: "string";
|
|
982
|
-
readonly description: "Pretty name of the plan";
|
|
983
|
-
readonly example: "Plan A";
|
|
984
|
-
};
|
|
985
|
-
readonly prettyPhaseName: {
|
|
986
|
-
readonly type: "string";
|
|
987
|
-
readonly description: "Pretty name of the phase";
|
|
988
|
-
readonly example: "Phase A";
|
|
989
|
-
};
|
|
990
|
-
readonly prettyUsageName: {
|
|
991
|
-
readonly type: "string";
|
|
992
|
-
readonly description: "Pretty name of the usage";
|
|
993
|
-
readonly example: "Usage A";
|
|
994
|
-
};
|
|
995
|
-
readonly itemType: {
|
|
996
|
-
readonly type: "string";
|
|
997
|
-
readonly description: "Type of the invoice item";
|
|
998
|
-
readonly example: "EXTERNAL_CHARGE";
|
|
999
|
-
readonly enum: readonly ["EXTERNAL_CHARGE", "FIXED", "RECURRING", "REPAIR_ADJ", "CBA_ADJ", "CREDIT_ADJ", "ITEM_ADJ", "USAGE", "TAX", "PARENT_SUMMARY"];
|
|
1000
|
-
};
|
|
1001
|
-
readonly description: {
|
|
1002
|
-
readonly type: "string";
|
|
1003
|
-
readonly description: "Description of the invoice item";
|
|
1004
|
-
readonly example: "Description of the invoice item";
|
|
1005
|
-
};
|
|
1006
|
-
readonly startDate: {
|
|
1007
|
-
readonly type: "string";
|
|
1008
|
-
readonly description: "Start date of the invoice item";
|
|
1009
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
1010
|
-
};
|
|
1011
|
-
readonly endDate: {
|
|
1012
|
-
readonly type: "string";
|
|
1013
|
-
readonly description: "End date of the invoice item";
|
|
1014
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
1015
|
-
};
|
|
1016
|
-
readonly amount: {
|
|
1017
|
-
readonly type: "number";
|
|
1018
|
-
readonly format: "float";
|
|
1019
|
-
readonly description: "Amount of the invoice item";
|
|
1020
|
-
readonly example: 100;
|
|
1021
|
-
};
|
|
1022
|
-
readonly rate: {
|
|
1023
|
-
readonly type: "number";
|
|
1024
|
-
readonly format: "float";
|
|
1025
|
-
readonly description: "Rate of the invoice item";
|
|
1026
|
-
readonly example: 100;
|
|
1027
|
-
};
|
|
1028
|
-
readonly currency: {
|
|
1029
|
-
readonly type: "string";
|
|
1030
|
-
readonly description: "Currency of the invoice item";
|
|
1031
|
-
readonly example: "USD";
|
|
1032
|
-
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"];
|
|
1033
|
-
};
|
|
1034
|
-
readonly quantity: {
|
|
1035
|
-
readonly type: "number";
|
|
1036
|
-
readonly format: "float";
|
|
1037
|
-
readonly description: "Quantity of the invoice item";
|
|
1038
|
-
readonly example: 1;
|
|
1039
|
-
};
|
|
1040
|
-
readonly itemDetails: {
|
|
1041
|
-
readonly type: "string";
|
|
1042
|
-
readonly description: "Details of the invoice item";
|
|
1043
|
-
readonly example: "Details of the invoice item";
|
|
1044
|
-
};
|
|
1045
|
-
readonly catalogEffectiveDate: {
|
|
1046
|
-
readonly type: "string";
|
|
1047
|
-
readonly description: "Effective date of the catalog";
|
|
1048
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
1049
|
-
};
|
|
1050
|
-
readonly childItems: {
|
|
1051
|
-
readonly type: "array";
|
|
1052
|
-
readonly items: {
|
|
1053
|
-
readonly oneOf: readonly [{
|
|
1054
|
-
readonly type: "array";
|
|
1055
|
-
}, {
|
|
1056
|
-
readonly type: "boolean";
|
|
1057
|
-
}, {
|
|
1058
|
-
readonly type: "number";
|
|
1059
|
-
}, {
|
|
1060
|
-
readonly type: "object";
|
|
1061
|
-
readonly additionalProperties: true;
|
|
1062
|
-
}, {
|
|
1063
|
-
readonly type: "string";
|
|
1064
|
-
}];
|
|
1065
|
-
};
|
|
1066
|
-
readonly description: "Child items of the invoice item";
|
|
1067
|
-
};
|
|
1068
|
-
};
|
|
1069
|
-
readonly additionalProperties: false;
|
|
1070
|
-
};
|
|
1071
|
-
readonly description: "Items of the invoice";
|
|
1072
1271
|
};
|
|
1073
1272
|
};
|
|
1273
|
+
readonly required: readonly ["created", "period_start", "period_end"];
|
|
1074
1274
|
readonly additionalProperties: false;
|
|
1075
1275
|
};
|
|
1076
|
-
export declare const
|
|
1276
|
+
export declare const MarketplaceListingFilesSchema: {
|
|
1077
1277
|
readonly type: "object";
|
|
1078
1278
|
readonly properties: {
|
|
1079
|
-
readonly
|
|
1080
|
-
readonly type: "string";
|
|
1081
|
-
readonly maxLength: 63;
|
|
1082
|
-
readonly minLength: 1;
|
|
1083
|
-
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
1084
|
-
readonly description: "Id of the chart listing";
|
|
1085
|
-
readonly example: "portworx-enterprise-disaster-recovery-baremetal";
|
|
1086
|
-
};
|
|
1087
|
-
readonly name: {
|
|
1088
|
-
readonly type: "string";
|
|
1089
|
-
readonly description: "Name of the chart listing";
|
|
1090
|
-
readonly example: "Portworx Enterprise + Disaster Recovery - Baremetal";
|
|
1091
|
-
};
|
|
1092
|
-
readonly developer: {
|
|
1279
|
+
readonly chartYaml: {
|
|
1093
1280
|
readonly type: "string";
|
|
1094
|
-
readonly description: "
|
|
1095
|
-
readonly example: "
|
|
1281
|
+
readonly description: "Raw Chart.yaml content from the Helm chart";
|
|
1282
|
+
readonly example: "apiVersion: v2\nname: nginx-ingress\nversion: 1.18.2-cfke.45\nappVersion: 1.9.4";
|
|
1096
1283
|
};
|
|
1097
|
-
readonly
|
|
1284
|
+
readonly valuesYaml: {
|
|
1098
1285
|
readonly type: "string";
|
|
1099
|
-
readonly description: "
|
|
1100
|
-
readonly example: "
|
|
1286
|
+
readonly description: "Raw values.yaml content from the Helm chart";
|
|
1287
|
+
readonly example: "replicaCount: 1\nimage:\n repository: nginx\n tag: latest";
|
|
1101
1288
|
};
|
|
1102
|
-
readonly
|
|
1289
|
+
readonly valuesSchemaJson: {
|
|
1103
1290
|
readonly type: "string";
|
|
1104
|
-
readonly description: "
|
|
1105
|
-
readonly example: "
|
|
1291
|
+
readonly description: "JSON schema for values.yaml as a string";
|
|
1292
|
+
readonly example: "{\"type\":\"object\",\"properties\":{\"replicaCount\":{\"type\":\"number\"}}}";
|
|
1106
1293
|
};
|
|
1107
|
-
|
|
1294
|
+
};
|
|
1295
|
+
readonly additionalProperties: false;
|
|
1296
|
+
};
|
|
1297
|
+
export declare const MarketplaceListingSchema: {
|
|
1298
|
+
readonly type: "object";
|
|
1299
|
+
readonly properties: {
|
|
1300
|
+
readonly name: {
|
|
1108
1301
|
readonly type: "string";
|
|
1109
|
-
readonly description: "
|
|
1110
|
-
readonly example: "
|
|
1302
|
+
readonly description: "Name of the chart";
|
|
1303
|
+
readonly example: "nginx-ingress";
|
|
1111
1304
|
};
|
|
1112
|
-
readonly
|
|
1305
|
+
readonly versions: {
|
|
1113
1306
|
readonly type: "array";
|
|
1114
1307
|
readonly items: {
|
|
1115
1308
|
readonly type: "string";
|
|
1116
|
-
readonly
|
|
1309
|
+
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-]+)*))?$";
|
|
1310
|
+
readonly description: "Specific version of the chart";
|
|
1311
|
+
readonly example: "1.18.2-cfke.45";
|
|
1117
1312
|
};
|
|
1118
|
-
readonly description: "
|
|
1313
|
+
readonly description: "Available versions of the chart";
|
|
1119
1314
|
};
|
|
1120
1315
|
readonly version_channels: {
|
|
1121
1316
|
readonly type: "array";
|
|
1122
1317
|
readonly items: {
|
|
1123
1318
|
readonly type: "string";
|
|
1124
1319
|
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-]+)*))?$";
|
|
1125
|
-
readonly description: "Version
|
|
1126
|
-
readonly example: "
|
|
1320
|
+
readonly description: "Version channel pattern";
|
|
1321
|
+
readonly example: "1.18.x-cfke.x";
|
|
1127
1322
|
};
|
|
1323
|
+
readonly description: "Version channels for the chart";
|
|
1128
1324
|
};
|
|
1129
|
-
readonly
|
|
1130
|
-
readonly type: "
|
|
1131
|
-
readonly
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
|
|
1325
|
+
readonly latestVersion: {
|
|
1326
|
+
readonly type: "string";
|
|
1327
|
+
readonly description: "Latest version of the chart";
|
|
1328
|
+
readonly example: "1.18.2-cfke.45";
|
|
1329
|
+
};
|
|
1330
|
+
readonly metadata: {
|
|
1331
|
+
readonly type: "object";
|
|
1332
|
+
readonly properties: {
|
|
1333
|
+
readonly name: {
|
|
1334
|
+
readonly type: "string";
|
|
1335
|
+
readonly description: "Chart name from metadata";
|
|
1336
|
+
readonly example: "nginx-ingress";
|
|
1337
|
+
};
|
|
1338
|
+
readonly version: {
|
|
1339
|
+
readonly type: "string";
|
|
1340
|
+
readonly description: "Chart version from metadata";
|
|
1341
|
+
readonly example: "1.18.2-cfke.45";
|
|
1342
|
+
};
|
|
1343
|
+
readonly description: {
|
|
1344
|
+
readonly type: "string";
|
|
1345
|
+
readonly description: "Chart description";
|
|
1346
|
+
readonly example: "NGINX Ingress Controller for Kubernetes";
|
|
1347
|
+
};
|
|
1348
|
+
readonly appVersion: {
|
|
1349
|
+
readonly type: "string";
|
|
1350
|
+
readonly description: "Application version";
|
|
1351
|
+
readonly example: "1.9.4";
|
|
1352
|
+
};
|
|
1353
|
+
readonly apiVersion: {
|
|
1354
|
+
readonly type: "string";
|
|
1355
|
+
readonly description: "Helm API version";
|
|
1356
|
+
readonly example: "v2";
|
|
1357
|
+
};
|
|
1358
|
+
readonly keywords: {
|
|
1359
|
+
readonly type: "array";
|
|
1360
|
+
readonly items: {
|
|
1135
1361
|
readonly type: "string";
|
|
1136
|
-
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 of the chart.";
|
|
1138
|
-
readonly example: "2.1.1-cfke.123";
|
|
1139
1362
|
};
|
|
1140
|
-
readonly
|
|
1363
|
+
readonly description: "Chart keywords";
|
|
1364
|
+
readonly example: readonly ["ingress", "nginx", "load-balancer"];
|
|
1365
|
+
};
|
|
1366
|
+
readonly home: {
|
|
1367
|
+
readonly type: "string";
|
|
1368
|
+
readonly description: "Chart home URL";
|
|
1369
|
+
readonly example: "https://kubernetes.github.io/ingress-nginx/";
|
|
1370
|
+
};
|
|
1371
|
+
readonly icon: {
|
|
1372
|
+
readonly type: "string";
|
|
1373
|
+
readonly description: "A URL to an SVG or PNG image to be used as an icon";
|
|
1374
|
+
readonly example: "https://cloudfleet.ai/images/marketplace/icons/ingress-nginx.png";
|
|
1375
|
+
};
|
|
1376
|
+
readonly sources: {
|
|
1377
|
+
readonly type: "array";
|
|
1378
|
+
readonly items: {
|
|
1141
1379
|
readonly type: "string";
|
|
1142
|
-
readonly description: "Schema of the chart values. JSON Schema as string";
|
|
1143
1380
|
};
|
|
1144
|
-
readonly
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
1381
|
+
readonly description: "Chart source URLs";
|
|
1382
|
+
readonly example: readonly ["https://github.com/kubernetes/ingress-nginx"];
|
|
1383
|
+
};
|
|
1384
|
+
readonly maintainers: {
|
|
1385
|
+
readonly type: "array";
|
|
1386
|
+
readonly items: {
|
|
1387
|
+
readonly type: "object";
|
|
1388
|
+
readonly properties: {
|
|
1389
|
+
readonly name: {
|
|
1390
|
+
readonly type: "string";
|
|
1391
|
+
readonly description: "Maintainer name";
|
|
1392
|
+
readonly example: "NGINX Team";
|
|
1393
|
+
};
|
|
1394
|
+
readonly email: {
|
|
1395
|
+
readonly type: "string";
|
|
1396
|
+
readonly description: "Maintainer email";
|
|
1397
|
+
readonly example: "support@nginx.org";
|
|
1398
|
+
};
|
|
1399
|
+
};
|
|
1400
|
+
readonly required: readonly ["name"];
|
|
1401
|
+
readonly additionalProperties: false;
|
|
1148
1402
|
};
|
|
1403
|
+
readonly description: "Chart maintainers";
|
|
1149
1404
|
};
|
|
1150
|
-
readonly required: readonly ["version", "schema", "placeholder"];
|
|
1151
|
-
readonly additionalProperties: false;
|
|
1152
1405
|
};
|
|
1406
|
+
readonly required: readonly ["name", "version"];
|
|
1407
|
+
readonly additionalProperties: false;
|
|
1408
|
+
readonly description: "Chart metadata";
|
|
1153
1409
|
};
|
|
1154
1410
|
};
|
|
1155
|
-
readonly required: readonly ["
|
|
1411
|
+
readonly required: readonly ["name", "versions", "version_channels", "latestVersion"];
|
|
1156
1412
|
readonly additionalProperties: false;
|
|
1157
1413
|
};
|
|
1158
1414
|
export declare const OrganizationCreateInputSchema: {
|
|
1159
1415
|
readonly type: "object";
|
|
1160
1416
|
readonly properties: {
|
|
1417
|
+
readonly type: {
|
|
1418
|
+
readonly type: "string";
|
|
1419
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1420
|
+
readonly example: "business";
|
|
1421
|
+
readonly enum: readonly ["business", "personal"];
|
|
1422
|
+
};
|
|
1161
1423
|
readonly email: {
|
|
1162
1424
|
readonly type: "string";
|
|
1163
1425
|
readonly format: "email";
|
|
@@ -1166,11 +1428,13 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
1166
1428
|
};
|
|
1167
1429
|
readonly first_name: {
|
|
1168
1430
|
readonly type: "string";
|
|
1431
|
+
readonly minLength: 1;
|
|
1169
1432
|
readonly description: "First name of the billing contact person.";
|
|
1170
1433
|
readonly example: "John";
|
|
1171
1434
|
};
|
|
1172
1435
|
readonly last_name: {
|
|
1173
1436
|
readonly type: "string";
|
|
1437
|
+
readonly minLength: 1;
|
|
1174
1438
|
readonly description: "Last name of the billing contact person.";
|
|
1175
1439
|
readonly example: "Doe";
|
|
1176
1440
|
};
|
|
@@ -1188,7 +1452,19 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
1188
1452
|
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.";
|
|
1189
1453
|
};
|
|
1190
1454
|
};
|
|
1191
|
-
readonly required: readonly ["email", "first_name", "last_name", "company_name", "password"];
|
|
1455
|
+
readonly required: readonly ["type", "email", "first_name", "last_name", "company_name", "password"];
|
|
1456
|
+
readonly additionalProperties: false;
|
|
1457
|
+
};
|
|
1458
|
+
export declare const OrganizationCreateOutputSchema: {
|
|
1459
|
+
readonly type: "object";
|
|
1460
|
+
readonly properties: {
|
|
1461
|
+
readonly id: {
|
|
1462
|
+
readonly type: "string";
|
|
1463
|
+
readonly description: "Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.";
|
|
1464
|
+
readonly example: "organization-id";
|
|
1465
|
+
};
|
|
1466
|
+
};
|
|
1467
|
+
readonly required: readonly ["id"];
|
|
1192
1468
|
readonly additionalProperties: false;
|
|
1193
1469
|
};
|
|
1194
1470
|
export declare const OrganizationSchema: {
|
|
@@ -1200,155 +1476,789 @@ export declare const OrganizationSchema: {
|
|
|
1200
1476
|
readonly description: "Unique identifier of the organization. UUID v4 string in canonical form";
|
|
1201
1477
|
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1202
1478
|
};
|
|
1203
|
-
readonly name: {
|
|
1479
|
+
readonly name: {
|
|
1480
|
+
readonly type: "string";
|
|
1481
|
+
readonly maxLength: 120;
|
|
1482
|
+
readonly minLength: 2;
|
|
1483
|
+
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
1484
|
+
readonly example: "ACME Corp.";
|
|
1485
|
+
};
|
|
1486
|
+
readonly type: {
|
|
1487
|
+
readonly type: "string";
|
|
1488
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1489
|
+
readonly example: "business";
|
|
1490
|
+
readonly enum: readonly ["business", "personal"];
|
|
1491
|
+
};
|
|
1492
|
+
readonly date_created: {
|
|
1493
|
+
readonly type: "string";
|
|
1494
|
+
readonly format: "date-time";
|
|
1495
|
+
readonly description: "Creation date of the organization. ISO 8601 date string in UTC timezone";
|
|
1496
|
+
readonly example: "2023-11-02T16:08:14.338Z";
|
|
1497
|
+
};
|
|
1498
|
+
readonly quota: {
|
|
1499
|
+
readonly type: "object";
|
|
1500
|
+
readonly properties: {
|
|
1501
|
+
readonly basic_clusters_max: {
|
|
1502
|
+
readonly type: "integer";
|
|
1503
|
+
readonly minimum: 0;
|
|
1504
|
+
readonly description: "Maximum number of Basic clusters that can be created.";
|
|
1505
|
+
readonly example: 999;
|
|
1506
|
+
};
|
|
1507
|
+
readonly basic_clusters_available: {
|
|
1508
|
+
readonly type: "integer";
|
|
1509
|
+
readonly description: "Available number of Basic clusters that can be created.";
|
|
1510
|
+
readonly example: 999;
|
|
1511
|
+
};
|
|
1512
|
+
readonly pro_clusters_max: {
|
|
1513
|
+
readonly type: "integer";
|
|
1514
|
+
readonly minimum: 0;
|
|
1515
|
+
readonly description: "Maximum number of Pro clusters that can be created.";
|
|
1516
|
+
readonly example: 999;
|
|
1517
|
+
};
|
|
1518
|
+
readonly pro_clusters_available: {
|
|
1519
|
+
readonly type: "integer";
|
|
1520
|
+
readonly description: "Available number of Pro clusters that can be created.";
|
|
1521
|
+
readonly example: 999;
|
|
1522
|
+
};
|
|
1523
|
+
readonly enterprise_clusters_max: {
|
|
1524
|
+
readonly type: "integer";
|
|
1525
|
+
readonly minimum: 0;
|
|
1526
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1527
|
+
readonly example: 999;
|
|
1528
|
+
};
|
|
1529
|
+
readonly enterprise_clusters_available: {
|
|
1530
|
+
readonly type: "integer";
|
|
1531
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1532
|
+
readonly example: 999;
|
|
1533
|
+
};
|
|
1534
|
+
readonly fleets_max: {
|
|
1535
|
+
readonly type: "integer";
|
|
1536
|
+
readonly minimum: 0;
|
|
1537
|
+
readonly description: "Maximum number of fleets that can be created per cluster.";
|
|
1538
|
+
readonly example: 999;
|
|
1539
|
+
};
|
|
1540
|
+
readonly cluster_tiers: {
|
|
1541
|
+
readonly type: "array";
|
|
1542
|
+
readonly items: {
|
|
1543
|
+
readonly type: "string";
|
|
1544
|
+
readonly example: "basic";
|
|
1545
|
+
};
|
|
1546
|
+
readonly minItems: 0;
|
|
1547
|
+
readonly description: "List of Cloudfleet cluster tiers available for the organization.";
|
|
1548
|
+
};
|
|
1549
|
+
readonly regions: {
|
|
1550
|
+
readonly type: "array";
|
|
1551
|
+
readonly items: {
|
|
1552
|
+
readonly type: "string";
|
|
1553
|
+
readonly example: "northamerica-central-1a";
|
|
1554
|
+
};
|
|
1555
|
+
readonly minItems: 1;
|
|
1556
|
+
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
1557
|
+
};
|
|
1558
|
+
readonly versions: {
|
|
1559
|
+
readonly type: "array";
|
|
1560
|
+
readonly items: {
|
|
1561
|
+
readonly type: "object";
|
|
1562
|
+
readonly properties: {
|
|
1563
|
+
readonly id: {
|
|
1564
|
+
readonly type: "string";
|
|
1565
|
+
readonly description: "Id of the control plane version. Used in API calls.";
|
|
1566
|
+
readonly example: "1.33.x-cfke.x";
|
|
1567
|
+
};
|
|
1568
|
+
readonly label: {
|
|
1569
|
+
readonly type: "string";
|
|
1570
|
+
readonly description: "Label of the control plane version. Used in frontent UI.";
|
|
1571
|
+
readonly example: "1.33.x (Always latest 1.33 patch version)";
|
|
1572
|
+
};
|
|
1573
|
+
};
|
|
1574
|
+
readonly required: readonly ["id", "label"];
|
|
1575
|
+
readonly additionalProperties: false;
|
|
1576
|
+
};
|
|
1577
|
+
readonly minItems: 1;
|
|
1578
|
+
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1579
|
+
};
|
|
1580
|
+
readonly cfcr_storage_gb: {
|
|
1581
|
+
readonly type: "integer";
|
|
1582
|
+
readonly minimum: -1;
|
|
1583
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1584
|
+
readonly example: 500;
|
|
1585
|
+
};
|
|
1586
|
+
};
|
|
1587
|
+
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"];
|
|
1588
|
+
readonly additionalProperties: false;
|
|
1589
|
+
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.";
|
|
1590
|
+
};
|
|
1591
|
+
readonly status: {
|
|
1592
|
+
readonly type: "string";
|
|
1593
|
+
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1594
|
+
readonly enum: readonly ["active", "closed", "suspended"];
|
|
1595
|
+
};
|
|
1596
|
+
readonly verification: {
|
|
1597
|
+
readonly type: "string";
|
|
1598
|
+
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.";
|
|
1599
|
+
readonly example: "verified";
|
|
1600
|
+
readonly enum: readonly ["none", "submitted", "verified"];
|
|
1601
|
+
};
|
|
1602
|
+
};
|
|
1603
|
+
readonly required: readonly ["id", "type", "date_created", "quota", "status", "verification"];
|
|
1604
|
+
readonly additionalProperties: false;
|
|
1605
|
+
};
|
|
1606
|
+
export declare const PaymentMethodSchema: {
|
|
1607
|
+
readonly type: "object";
|
|
1608
|
+
readonly properties: {
|
|
1609
|
+
readonly id: {
|
|
1610
|
+
readonly type: "string";
|
|
1611
|
+
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.";
|
|
1612
|
+
readonly example: "pm_1MtwBwLkdIwHu7ix28a3tqPa";
|
|
1613
|
+
};
|
|
1614
|
+
readonly type: {
|
|
1615
|
+
readonly type: "string";
|
|
1616
|
+
readonly description: "Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.";
|
|
1617
|
+
readonly example: "card";
|
|
1618
|
+
readonly enum: readonly ["card", "sepa_debit", "bank_transfer"];
|
|
1619
|
+
};
|
|
1620
|
+
readonly last4: {
|
|
1621
|
+
readonly type: "string";
|
|
1622
|
+
readonly nullable: true;
|
|
1623
|
+
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.";
|
|
1624
|
+
readonly example: "4242";
|
|
1625
|
+
};
|
|
1626
|
+
readonly exp_month: {
|
|
1627
|
+
readonly type: "integer";
|
|
1628
|
+
readonly minimum: 1;
|
|
1629
|
+
readonly maximum: 12;
|
|
1630
|
+
readonly nullable: true;
|
|
1631
|
+
readonly description: "Two-digit number representing the card's expiration month. Null for SEPA Direct Debit and bank transfer.";
|
|
1632
|
+
readonly example: 12;
|
|
1633
|
+
};
|
|
1634
|
+
readonly exp_year: {
|
|
1635
|
+
readonly type: "integer";
|
|
1636
|
+
readonly nullable: true;
|
|
1637
|
+
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.";
|
|
1638
|
+
readonly example: 2028;
|
|
1639
|
+
};
|
|
1640
|
+
readonly brand: {
|
|
1641
|
+
readonly type: "string";
|
|
1642
|
+
readonly nullable: true;
|
|
1643
|
+
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.";
|
|
1644
|
+
readonly example: "visa";
|
|
1645
|
+
};
|
|
1646
|
+
readonly iban: {
|
|
1647
|
+
readonly type: "string";
|
|
1648
|
+
readonly nullable: true;
|
|
1649
|
+
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.";
|
|
1650
|
+
readonly example: "DE11243015658023127510";
|
|
1651
|
+
};
|
|
1652
|
+
readonly bic: {
|
|
1653
|
+
readonly type: "string";
|
|
1654
|
+
readonly nullable: true;
|
|
1655
|
+
readonly description: "BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1656
|
+
readonly example: "SOGEDEFFXXX";
|
|
1657
|
+
};
|
|
1658
|
+
readonly account_holder_name: {
|
|
1659
|
+
readonly type: "string";
|
|
1660
|
+
readonly nullable: true;
|
|
1661
|
+
readonly description: "Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1662
|
+
readonly example: "Cloudfleet GmbH";
|
|
1663
|
+
};
|
|
1664
|
+
readonly is_default: {
|
|
1665
|
+
readonly type: "boolean";
|
|
1666
|
+
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).";
|
|
1667
|
+
readonly example: true;
|
|
1668
|
+
};
|
|
1669
|
+
};
|
|
1670
|
+
readonly required: readonly ["id", "type", "last4", "exp_month", "exp_year", "brand", "iban", "bic", "account_holder_name", "is_default"];
|
|
1671
|
+
readonly additionalProperties: false;
|
|
1672
|
+
};
|
|
1673
|
+
export declare const PlatformQuotaSchema: {
|
|
1674
|
+
readonly type: "object";
|
|
1675
|
+
readonly properties: {
|
|
1676
|
+
readonly basic_clusters_max: {
|
|
1677
|
+
readonly type: "integer";
|
|
1678
|
+
readonly minimum: 0;
|
|
1679
|
+
readonly description: "Maximum number of Basic clusters that can be created.";
|
|
1680
|
+
readonly example: 999;
|
|
1681
|
+
};
|
|
1682
|
+
readonly basic_clusters_available: {
|
|
1683
|
+
readonly type: "integer";
|
|
1684
|
+
readonly description: "Available number of Basic clusters that can be created.";
|
|
1685
|
+
readonly example: 999;
|
|
1686
|
+
};
|
|
1687
|
+
readonly pro_clusters_max: {
|
|
1688
|
+
readonly type: "integer";
|
|
1689
|
+
readonly minimum: 0;
|
|
1690
|
+
readonly description: "Maximum number of Pro clusters that can be created.";
|
|
1691
|
+
readonly example: 999;
|
|
1692
|
+
};
|
|
1693
|
+
readonly pro_clusters_available: {
|
|
1694
|
+
readonly type: "integer";
|
|
1695
|
+
readonly description: "Available number of Pro clusters that can be created.";
|
|
1696
|
+
readonly example: 999;
|
|
1697
|
+
};
|
|
1698
|
+
readonly enterprise_clusters_max: {
|
|
1699
|
+
readonly type: "integer";
|
|
1700
|
+
readonly minimum: 0;
|
|
1701
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1702
|
+
readonly example: 999;
|
|
1703
|
+
};
|
|
1704
|
+
readonly enterprise_clusters_available: {
|
|
1705
|
+
readonly type: "integer";
|
|
1706
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1707
|
+
readonly example: 999;
|
|
1708
|
+
};
|
|
1709
|
+
readonly fleets_max: {
|
|
1710
|
+
readonly type: "integer";
|
|
1711
|
+
readonly minimum: 0;
|
|
1712
|
+
readonly description: "Maximum number of fleets that can be created per cluster.";
|
|
1713
|
+
readonly example: 999;
|
|
1714
|
+
};
|
|
1715
|
+
readonly cluster_tiers: {
|
|
1716
|
+
readonly type: "array";
|
|
1717
|
+
readonly items: {
|
|
1718
|
+
readonly type: "string";
|
|
1719
|
+
readonly example: "basic";
|
|
1720
|
+
};
|
|
1721
|
+
readonly minItems: 0;
|
|
1722
|
+
readonly description: "List of Cloudfleet cluster tiers available for the organization.";
|
|
1723
|
+
};
|
|
1724
|
+
readonly regions: {
|
|
1725
|
+
readonly type: "array";
|
|
1726
|
+
readonly items: {
|
|
1727
|
+
readonly type: "string";
|
|
1728
|
+
readonly example: "northamerica-central-1a";
|
|
1729
|
+
};
|
|
1730
|
+
readonly minItems: 1;
|
|
1731
|
+
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
1732
|
+
};
|
|
1733
|
+
readonly versions: {
|
|
1734
|
+
readonly type: "array";
|
|
1735
|
+
readonly items: {
|
|
1736
|
+
readonly type: "object";
|
|
1737
|
+
readonly properties: {
|
|
1738
|
+
readonly id: {
|
|
1739
|
+
readonly type: "string";
|
|
1740
|
+
readonly description: "Id of the control plane version. Used in API calls.";
|
|
1741
|
+
readonly example: "1.33.x-cfke.x";
|
|
1742
|
+
};
|
|
1743
|
+
readonly label: {
|
|
1744
|
+
readonly type: "string";
|
|
1745
|
+
readonly description: "Label of the control plane version. Used in frontent UI.";
|
|
1746
|
+
readonly example: "1.33.x (Always latest 1.33 patch version)";
|
|
1747
|
+
};
|
|
1748
|
+
};
|
|
1749
|
+
readonly required: readonly ["id", "label"];
|
|
1750
|
+
readonly additionalProperties: false;
|
|
1751
|
+
};
|
|
1752
|
+
readonly minItems: 1;
|
|
1753
|
+
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1754
|
+
};
|
|
1755
|
+
readonly cfcr_storage_gb: {
|
|
1756
|
+
readonly type: "integer";
|
|
1757
|
+
readonly minimum: -1;
|
|
1758
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1759
|
+
readonly example: 500;
|
|
1760
|
+
};
|
|
1761
|
+
};
|
|
1762
|
+
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"];
|
|
1763
|
+
readonly additionalProperties: false;
|
|
1764
|
+
};
|
|
1765
|
+
export declare const RegistryRepositorySchema: {
|
|
1766
|
+
readonly type: "object";
|
|
1767
|
+
readonly properties: {
|
|
1768
|
+
readonly name: {
|
|
1769
|
+
readonly type: "string";
|
|
1770
|
+
readonly description: "Repository name.";
|
|
1771
|
+
readonly example: "my-app";
|
|
1772
|
+
};
|
|
1773
|
+
readonly region: {
|
|
1774
|
+
readonly type: "string";
|
|
1775
|
+
readonly description: "Registry region.";
|
|
1776
|
+
readonly example: "northamerica";
|
|
1777
|
+
};
|
|
1778
|
+
readonly uri: {
|
|
1779
|
+
readonly type: "string";
|
|
1780
|
+
readonly description: "Full URI of the repository.";
|
|
1781
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
1782
|
+
};
|
|
1783
|
+
};
|
|
1784
|
+
readonly required: readonly ["name", "region", "uri"];
|
|
1785
|
+
readonly additionalProperties: false;
|
|
1786
|
+
};
|
|
1787
|
+
export declare const RegistryRepositoryWithTagsSchema: {
|
|
1788
|
+
readonly type: "object";
|
|
1789
|
+
readonly properties: {
|
|
1790
|
+
readonly name: {
|
|
1791
|
+
readonly type: "string";
|
|
1792
|
+
readonly description: "Repository name.";
|
|
1793
|
+
readonly example: "my-app";
|
|
1794
|
+
};
|
|
1795
|
+
readonly region: {
|
|
1796
|
+
readonly type: "string";
|
|
1797
|
+
readonly description: "Registry region.";
|
|
1798
|
+
readonly example: "northamerica";
|
|
1799
|
+
};
|
|
1800
|
+
readonly uri: {
|
|
1801
|
+
readonly type: "string";
|
|
1802
|
+
readonly description: "Full URI of the repository.";
|
|
1803
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
1804
|
+
};
|
|
1805
|
+
readonly tags: {
|
|
1806
|
+
readonly type: "array";
|
|
1807
|
+
readonly items: {
|
|
1808
|
+
readonly type: "object";
|
|
1809
|
+
readonly properties: {
|
|
1810
|
+
readonly name: {
|
|
1811
|
+
readonly type: "string";
|
|
1812
|
+
readonly description: "Tag name.";
|
|
1813
|
+
readonly example: "latest";
|
|
1814
|
+
};
|
|
1815
|
+
readonly size: {
|
|
1816
|
+
readonly type: "number";
|
|
1817
|
+
readonly format: "float";
|
|
1818
|
+
readonly description: "Size of the tag in bytes.";
|
|
1819
|
+
readonly example: 123456789;
|
|
1820
|
+
};
|
|
1821
|
+
readonly mediaType: {
|
|
1822
|
+
readonly type: "string";
|
|
1823
|
+
readonly description: "Media type of the manifest.";
|
|
1824
|
+
readonly example: "application/vnd.docker.distribution.manifest.v2+json";
|
|
1825
|
+
};
|
|
1826
|
+
readonly platforms: {
|
|
1827
|
+
readonly type: "array";
|
|
1828
|
+
readonly items: {
|
|
1829
|
+
readonly type: "string";
|
|
1830
|
+
};
|
|
1831
|
+
readonly description: "Array of platform strings for multi-arch images (e.g., linux/amd64, linux/arm64).";
|
|
1832
|
+
readonly example: readonly ["linux/amd64", "linux/arm64"];
|
|
1833
|
+
};
|
|
1834
|
+
};
|
|
1835
|
+
readonly required: readonly ["name", "size"];
|
|
1836
|
+
readonly additionalProperties: false;
|
|
1837
|
+
};
|
|
1838
|
+
readonly description: "Array of tags in the repository.";
|
|
1839
|
+
};
|
|
1840
|
+
readonly totalSize: {
|
|
1841
|
+
readonly type: "number";
|
|
1842
|
+
readonly format: "float";
|
|
1843
|
+
readonly description: "Total size of all tags in the repository in bytes.";
|
|
1844
|
+
readonly example: 987654321;
|
|
1845
|
+
};
|
|
1846
|
+
};
|
|
1847
|
+
readonly required: readonly ["name", "region", "uri", "tags", "totalSize"];
|
|
1848
|
+
readonly additionalProperties: false;
|
|
1849
|
+
};
|
|
1850
|
+
export declare const RegistryTagSchema: {
|
|
1851
|
+
readonly type: "object";
|
|
1852
|
+
readonly properties: {
|
|
1853
|
+
readonly name: {
|
|
1854
|
+
readonly type: "string";
|
|
1855
|
+
readonly description: "Tag name.";
|
|
1856
|
+
readonly example: "latest";
|
|
1857
|
+
};
|
|
1858
|
+
readonly digest: {
|
|
1859
|
+
readonly type: "string";
|
|
1860
|
+
readonly description: "Manifest digest for pulling by digest.";
|
|
1861
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1862
|
+
};
|
|
1863
|
+
readonly mediaType: {
|
|
1864
|
+
readonly type: "string";
|
|
1865
|
+
readonly description: "Media type of the manifest.";
|
|
1866
|
+
readonly example: "application/vnd.docker.distribution.manifest.v2+json";
|
|
1867
|
+
};
|
|
1868
|
+
readonly config: {
|
|
1869
|
+
readonly type: "object";
|
|
1870
|
+
readonly properties: {
|
|
1871
|
+
readonly size: {
|
|
1872
|
+
readonly type: "number";
|
|
1873
|
+
readonly format: "float";
|
|
1874
|
+
readonly description: "Size of the config in bytes.";
|
|
1875
|
+
readonly example: 1234;
|
|
1876
|
+
};
|
|
1877
|
+
};
|
|
1878
|
+
readonly required: readonly ["size"];
|
|
1879
|
+
readonly additionalProperties: false;
|
|
1880
|
+
readonly description: "Manifest config metadata.";
|
|
1881
|
+
};
|
|
1882
|
+
readonly layers: {
|
|
1883
|
+
readonly type: "array";
|
|
1884
|
+
readonly items: {
|
|
1885
|
+
readonly type: "object";
|
|
1886
|
+
readonly properties: {
|
|
1887
|
+
readonly digest: {
|
|
1888
|
+
readonly type: "string";
|
|
1889
|
+
readonly description: "Digest of the layer.";
|
|
1890
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1891
|
+
};
|
|
1892
|
+
readonly size: {
|
|
1893
|
+
readonly type: "number";
|
|
1894
|
+
readonly format: "float";
|
|
1895
|
+
readonly description: "Size of the layer in bytes.";
|
|
1896
|
+
readonly example: 5678;
|
|
1897
|
+
};
|
|
1898
|
+
};
|
|
1899
|
+
readonly required: readonly ["size"];
|
|
1900
|
+
readonly additionalProperties: false;
|
|
1901
|
+
};
|
|
1902
|
+
readonly description: "Array of layer metadata.";
|
|
1903
|
+
};
|
|
1904
|
+
readonly manifests: {
|
|
1905
|
+
readonly type: "array";
|
|
1906
|
+
readonly items: {
|
|
1907
|
+
readonly type: "object";
|
|
1908
|
+
readonly properties: {
|
|
1909
|
+
readonly digest: {
|
|
1910
|
+
readonly type: "string";
|
|
1911
|
+
readonly description: "Digest of the manifest.";
|
|
1912
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1913
|
+
};
|
|
1914
|
+
readonly platform: {
|
|
1915
|
+
readonly type: "object";
|
|
1916
|
+
readonly properties: {
|
|
1917
|
+
readonly architecture: {
|
|
1918
|
+
readonly type: "string";
|
|
1919
|
+
readonly description: "Architecture of the platform.";
|
|
1920
|
+
readonly example: "amd64";
|
|
1921
|
+
};
|
|
1922
|
+
readonly os: {
|
|
1923
|
+
readonly type: "string";
|
|
1924
|
+
readonly description: "Operating system of the platform.";
|
|
1925
|
+
readonly example: "linux";
|
|
1926
|
+
};
|
|
1927
|
+
readonly variant: {
|
|
1928
|
+
readonly type: "string";
|
|
1929
|
+
readonly description: "Variant of the platform (e.g., v7, v8 for ARM).";
|
|
1930
|
+
readonly example: "v8";
|
|
1931
|
+
};
|
|
1932
|
+
};
|
|
1933
|
+
readonly required: readonly ["architecture", "os"];
|
|
1934
|
+
readonly additionalProperties: false;
|
|
1935
|
+
readonly description: "Platform information for the manifest.";
|
|
1936
|
+
};
|
|
1937
|
+
readonly layers: {
|
|
1938
|
+
readonly type: "array";
|
|
1939
|
+
readonly items: {
|
|
1940
|
+
readonly type: "object";
|
|
1941
|
+
readonly properties: {
|
|
1942
|
+
readonly digest: {
|
|
1943
|
+
readonly type: "string";
|
|
1944
|
+
readonly description: "Digest of the layer.";
|
|
1945
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1946
|
+
};
|
|
1947
|
+
readonly size: {
|
|
1948
|
+
readonly type: "number";
|
|
1949
|
+
readonly format: "float";
|
|
1950
|
+
readonly description: "Size of the layer in bytes.";
|
|
1951
|
+
readonly example: 5678;
|
|
1952
|
+
};
|
|
1953
|
+
};
|
|
1954
|
+
readonly required: readonly ["size"];
|
|
1955
|
+
readonly additionalProperties: false;
|
|
1956
|
+
};
|
|
1957
|
+
readonly description: "Layers for this platform.";
|
|
1958
|
+
};
|
|
1959
|
+
readonly size: {
|
|
1960
|
+
readonly type: "number";
|
|
1961
|
+
readonly format: "float";
|
|
1962
|
+
readonly description: "Total size of this platform manifest in bytes.";
|
|
1963
|
+
readonly example: 12345678;
|
|
1964
|
+
};
|
|
1965
|
+
};
|
|
1966
|
+
readonly required: readonly ["digest"];
|
|
1967
|
+
readonly additionalProperties: false;
|
|
1968
|
+
};
|
|
1969
|
+
readonly description: "Array of manifests for multi-arch images.";
|
|
1970
|
+
};
|
|
1971
|
+
readonly size: {
|
|
1972
|
+
readonly type: "number";
|
|
1973
|
+
readonly format: "float";
|
|
1974
|
+
readonly description: "Total size of the tag in bytes.";
|
|
1975
|
+
readonly example: 123456789;
|
|
1976
|
+
};
|
|
1977
|
+
readonly region: {
|
|
1978
|
+
readonly type: "string";
|
|
1979
|
+
readonly description: "Registry region.";
|
|
1980
|
+
readonly example: "northamerica";
|
|
1981
|
+
};
|
|
1982
|
+
readonly repository: {
|
|
1983
|
+
readonly type: "string";
|
|
1984
|
+
readonly description: "Repository name.";
|
|
1985
|
+
readonly example: "my-app";
|
|
1986
|
+
};
|
|
1987
|
+
readonly uri: {
|
|
1988
|
+
readonly type: "string";
|
|
1989
|
+
readonly description: "Full URI of the tag.";
|
|
1990
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app:latest";
|
|
1991
|
+
};
|
|
1992
|
+
};
|
|
1993
|
+
readonly required: readonly ["name", "digest", "size", "region", "repository", "uri"];
|
|
1994
|
+
readonly additionalProperties: false;
|
|
1995
|
+
};
|
|
1996
|
+
export declare const TicketAttachmentSchema: {
|
|
1997
|
+
readonly type: "object";
|
|
1998
|
+
readonly properties: {
|
|
1999
|
+
readonly id: {
|
|
2000
|
+
readonly type: "string";
|
|
2001
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2002
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2003
|
+
};
|
|
2004
|
+
readonly filename: {
|
|
2005
|
+
readonly type: "string";
|
|
2006
|
+
readonly description: "Original filename as uploaded.";
|
|
2007
|
+
readonly example: "debug.log";
|
|
2008
|
+
};
|
|
2009
|
+
readonly content_type: {
|
|
2010
|
+
readonly type: "string";
|
|
2011
|
+
readonly description: "MIME content type of the attachment.";
|
|
2012
|
+
readonly example: "text/plain";
|
|
2013
|
+
};
|
|
2014
|
+
readonly size: {
|
|
2015
|
+
readonly type: "integer";
|
|
2016
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2017
|
+
readonly example: 12345;
|
|
2018
|
+
};
|
|
2019
|
+
};
|
|
2020
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2021
|
+
readonly additionalProperties: false;
|
|
2022
|
+
};
|
|
2023
|
+
export declare const TicketCreateInputSchema: {
|
|
2024
|
+
readonly type: "object";
|
|
2025
|
+
readonly properties: {
|
|
2026
|
+
readonly category: {
|
|
2027
|
+
readonly type: "string";
|
|
2028
|
+
readonly description: "Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.";
|
|
2029
|
+
readonly example: "technical";
|
|
2030
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
2031
|
+
};
|
|
2032
|
+
readonly body: {
|
|
2033
|
+
readonly type: "string";
|
|
2034
|
+
readonly maxLength: 50000;
|
|
2035
|
+
readonly minLength: 1;
|
|
2036
|
+
readonly pattern: "\\S";
|
|
2037
|
+
readonly description: "Initial message body in markdown. There is no separate subject — the first message body is the description.";
|
|
2038
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2039
|
+
};
|
|
2040
|
+
readonly properties: {
|
|
2041
|
+
readonly type: "object";
|
|
2042
|
+
readonly additionalProperties: true;
|
|
2043
|
+
readonly description: "Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).";
|
|
2044
|
+
readonly example: {
|
|
2045
|
+
readonly subcategory: "cluster-question";
|
|
2046
|
+
readonly cluster_id: "60c72b2f9f1b2c001f8e4d3a";
|
|
2047
|
+
};
|
|
2048
|
+
};
|
|
2049
|
+
};
|
|
2050
|
+
readonly required: readonly ["category", "body"];
|
|
2051
|
+
readonly additionalProperties: false;
|
|
2052
|
+
};
|
|
2053
|
+
export declare const TicketMessageInputSchema: {
|
|
2054
|
+
readonly type: "object";
|
|
2055
|
+
readonly properties: {
|
|
2056
|
+
readonly body: {
|
|
2057
|
+
readonly type: "string";
|
|
2058
|
+
readonly maxLength: 50000;
|
|
2059
|
+
readonly minLength: 1;
|
|
2060
|
+
readonly pattern: "\\S";
|
|
2061
|
+
readonly description: "Reply body in markdown.";
|
|
2062
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2063
|
+
};
|
|
2064
|
+
};
|
|
2065
|
+
readonly required: readonly ["body"];
|
|
2066
|
+
readonly additionalProperties: false;
|
|
2067
|
+
};
|
|
2068
|
+
export declare const TicketMessageSchema: {
|
|
2069
|
+
readonly type: "object";
|
|
2070
|
+
readonly properties: {
|
|
2071
|
+
readonly id: {
|
|
2072
|
+
readonly type: "string";
|
|
2073
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2074
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2075
|
+
};
|
|
2076
|
+
readonly type: {
|
|
2077
|
+
readonly type: "string";
|
|
2078
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2079
|
+
readonly example: "customer_reply";
|
|
2080
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2081
|
+
};
|
|
2082
|
+
readonly body: {
|
|
2083
|
+
readonly type: "string";
|
|
2084
|
+
readonly description: "Message body in markdown.";
|
|
2085
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2086
|
+
};
|
|
2087
|
+
readonly author_first_name: {
|
|
1204
2088
|
readonly type: "string";
|
|
1205
|
-
readonly
|
|
1206
|
-
readonly
|
|
1207
|
-
readonly
|
|
1208
|
-
readonly example: "ACME Corp.";
|
|
2089
|
+
readonly nullable: true;
|
|
2090
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2091
|
+
readonly example: "Jane";
|
|
1209
2092
|
};
|
|
1210
|
-
readonly
|
|
2093
|
+
readonly author_last_name: {
|
|
1211
2094
|
readonly type: "string";
|
|
1212
|
-
readonly
|
|
1213
|
-
readonly description: "
|
|
1214
|
-
readonly example: "
|
|
2095
|
+
readonly nullable: true;
|
|
2096
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2097
|
+
readonly example: "Doe";
|
|
1215
2098
|
};
|
|
1216
|
-
readonly
|
|
1217
|
-
readonly type: "
|
|
1218
|
-
readonly
|
|
1219
|
-
readonly
|
|
1220
|
-
|
|
1221
|
-
readonly
|
|
1222
|
-
readonly description: "Maximum number of Basic clusters that can be created.";
|
|
1223
|
-
readonly example: 999;
|
|
1224
|
-
};
|
|
1225
|
-
readonly basic_clusters_available: {
|
|
1226
|
-
readonly type: "integer";
|
|
1227
|
-
readonly description: "Available number of Basic clusters that can be created.";
|
|
1228
|
-
readonly example: 999;
|
|
1229
|
-
};
|
|
1230
|
-
readonly pro_clusters_max: {
|
|
1231
|
-
readonly type: "integer";
|
|
1232
|
-
readonly minimum: 0;
|
|
1233
|
-
readonly description: "Maximum number of Pro clusters that can be created.";
|
|
1234
|
-
readonly example: 999;
|
|
1235
|
-
};
|
|
1236
|
-
readonly pro_clusters_available: {
|
|
1237
|
-
readonly type: "integer";
|
|
1238
|
-
readonly description: "Available number of Pro clusters that can be created.";
|
|
1239
|
-
readonly example: 999;
|
|
1240
|
-
};
|
|
1241
|
-
readonly fleets_max: {
|
|
1242
|
-
readonly type: "integer";
|
|
1243
|
-
readonly minimum: 0;
|
|
1244
|
-
readonly description: "Maximum number of fleets that can be created per cluster.";
|
|
1245
|
-
readonly example: 999;
|
|
1246
|
-
};
|
|
1247
|
-
readonly cluster_tiers: {
|
|
1248
|
-
readonly type: "array";
|
|
1249
|
-
readonly items: {
|
|
2099
|
+
readonly attachments: {
|
|
2100
|
+
readonly type: "array";
|
|
2101
|
+
readonly items: {
|
|
2102
|
+
readonly type: "object";
|
|
2103
|
+
readonly properties: {
|
|
2104
|
+
readonly id: {
|
|
1250
2105
|
readonly type: "string";
|
|
1251
|
-
readonly
|
|
2106
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2107
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1252
2108
|
};
|
|
1253
|
-
readonly
|
|
1254
|
-
readonly description: "List of Cloudfleet cluster tiers available for the organization.";
|
|
1255
|
-
};
|
|
1256
|
-
readonly regions: {
|
|
1257
|
-
readonly type: "array";
|
|
1258
|
-
readonly items: {
|
|
2109
|
+
readonly filename: {
|
|
1259
2110
|
readonly type: "string";
|
|
1260
|
-
readonly
|
|
2111
|
+
readonly description: "Original filename as uploaded.";
|
|
2112
|
+
readonly example: "debug.log";
|
|
1261
2113
|
};
|
|
1262
|
-
readonly
|
|
1263
|
-
|
|
1264
|
-
|
|
1265
|
-
|
|
1266
|
-
|
|
1267
|
-
readonly
|
|
1268
|
-
readonly type: "
|
|
1269
|
-
readonly
|
|
1270
|
-
|
|
1271
|
-
readonly type: "string";
|
|
1272
|
-
readonly description: "Id of the control plane version. Used in API calls.";
|
|
1273
|
-
readonly example: "1.29.x-cfke.x";
|
|
1274
|
-
};
|
|
1275
|
-
readonly label: {
|
|
1276
|
-
readonly type: "string";
|
|
1277
|
-
readonly description: "Label of the control plane version. Used in frontent UI.";
|
|
1278
|
-
readonly example: "1.29.x (Always latest 1.29 patch version)";
|
|
1279
|
-
};
|
|
1280
|
-
};
|
|
1281
|
-
readonly required: readonly ["id", "label"];
|
|
1282
|
-
readonly additionalProperties: false;
|
|
2114
|
+
readonly content_type: {
|
|
2115
|
+
readonly type: "string";
|
|
2116
|
+
readonly description: "MIME content type of the attachment.";
|
|
2117
|
+
readonly example: "text/plain";
|
|
2118
|
+
};
|
|
2119
|
+
readonly size: {
|
|
2120
|
+
readonly type: "integer";
|
|
2121
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2122
|
+
readonly example: 12345;
|
|
1283
2123
|
};
|
|
1284
|
-
readonly minItems: 1;
|
|
1285
|
-
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1286
2124
|
};
|
|
2125
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2126
|
+
readonly additionalProperties: false;
|
|
1287
2127
|
};
|
|
1288
|
-
readonly
|
|
1289
|
-
readonly
|
|
1290
|
-
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.";
|
|
2128
|
+
readonly description: "Attachments associated with this message.";
|
|
2129
|
+
readonly example: readonly [];
|
|
1291
2130
|
};
|
|
1292
|
-
readonly
|
|
2131
|
+
readonly date_created: {
|
|
1293
2132
|
readonly type: "string";
|
|
1294
|
-
readonly
|
|
1295
|
-
readonly
|
|
2133
|
+
readonly format: "date-time";
|
|
2134
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2135
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1296
2136
|
};
|
|
1297
2137
|
};
|
|
1298
|
-
readonly required: readonly ["id", "
|
|
2138
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
1299
2139
|
readonly additionalProperties: false;
|
|
1300
2140
|
};
|
|
1301
|
-
export declare const
|
|
2141
|
+
export declare const TicketSchema: {
|
|
1302
2142
|
readonly type: "object";
|
|
1303
2143
|
readonly properties: {
|
|
1304
2144
|
readonly id: {
|
|
1305
2145
|
readonly type: "string";
|
|
1306
|
-
readonly
|
|
1307
|
-
readonly
|
|
1308
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
2146
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
2147
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
1309
2148
|
};
|
|
1310
|
-
readonly
|
|
1311
|
-
readonly type: "
|
|
1312
|
-
readonly description: "
|
|
1313
|
-
readonly example:
|
|
2149
|
+
readonly status: {
|
|
2150
|
+
readonly type: "string";
|
|
2151
|
+
readonly description: "Current state of the ticket.";
|
|
2152
|
+
readonly example: "waiting_on_us";
|
|
2153
|
+
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
1314
2154
|
};
|
|
1315
|
-
readonly
|
|
2155
|
+
readonly category: {
|
|
1316
2156
|
readonly type: "string";
|
|
1317
|
-
readonly
|
|
1318
|
-
readonly
|
|
1319
|
-
readonly
|
|
1320
|
-
readonly enum: readonly ["card"];
|
|
2157
|
+
readonly description: "Ticket category.";
|
|
2158
|
+
readonly example: "technical";
|
|
2159
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
1321
2160
|
};
|
|
1322
|
-
readonly
|
|
2161
|
+
readonly summary: {
|
|
1323
2162
|
readonly type: "string";
|
|
1324
|
-
readonly
|
|
1325
|
-
readonly
|
|
1326
|
-
readonly example: "4242";
|
|
2163
|
+
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
2164
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
1327
2165
|
};
|
|
1328
|
-
readonly
|
|
1329
|
-
readonly type: "
|
|
1330
|
-
readonly
|
|
1331
|
-
readonly maximum: 12;
|
|
2166
|
+
readonly closed_at: {
|
|
2167
|
+
readonly type: "string";
|
|
2168
|
+
readonly format: "date-time";
|
|
1332
2169
|
readonly nullable: true;
|
|
1333
|
-
readonly description: "
|
|
1334
|
-
readonly example: "
|
|
2170
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
2171
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
1335
2172
|
};
|
|
1336
|
-
readonly
|
|
1337
|
-
readonly type: "
|
|
1338
|
-
readonly
|
|
1339
|
-
readonly
|
|
1340
|
-
readonly
|
|
1341
|
-
readonly example: "2028";
|
|
2173
|
+
readonly date_created: {
|
|
2174
|
+
readonly type: "string";
|
|
2175
|
+
readonly format: "date-time";
|
|
2176
|
+
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
2177
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1342
2178
|
};
|
|
1343
|
-
readonly
|
|
2179
|
+
readonly date_updated: {
|
|
1344
2180
|
readonly type: "string";
|
|
1345
|
-
readonly
|
|
1346
|
-
readonly description: "
|
|
1347
|
-
readonly example: "
|
|
1348
|
-
|
|
2181
|
+
readonly format: "date-time";
|
|
2182
|
+
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
2183
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2184
|
+
};
|
|
2185
|
+
readonly messages: {
|
|
2186
|
+
readonly type: "array";
|
|
2187
|
+
readonly items: {
|
|
2188
|
+
readonly type: "object";
|
|
2189
|
+
readonly properties: {
|
|
2190
|
+
readonly id: {
|
|
2191
|
+
readonly type: "string";
|
|
2192
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2193
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2194
|
+
};
|
|
2195
|
+
readonly type: {
|
|
2196
|
+
readonly type: "string";
|
|
2197
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2198
|
+
readonly example: "customer_reply";
|
|
2199
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2200
|
+
};
|
|
2201
|
+
readonly body: {
|
|
2202
|
+
readonly type: "string";
|
|
2203
|
+
readonly description: "Message body in markdown.";
|
|
2204
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2205
|
+
};
|
|
2206
|
+
readonly author_first_name: {
|
|
2207
|
+
readonly type: "string";
|
|
2208
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2209
|
+
readonly example: "Jane";
|
|
2210
|
+
};
|
|
2211
|
+
readonly author_last_name: {
|
|
2212
|
+
readonly type: "string";
|
|
2213
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2214
|
+
readonly example: "Doe";
|
|
2215
|
+
};
|
|
2216
|
+
readonly attachments: {
|
|
2217
|
+
readonly type: "array";
|
|
2218
|
+
readonly items: {
|
|
2219
|
+
readonly type: "object";
|
|
2220
|
+
readonly properties: {
|
|
2221
|
+
readonly id: {
|
|
2222
|
+
readonly type: "string";
|
|
2223
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2224
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2225
|
+
};
|
|
2226
|
+
readonly filename: {
|
|
2227
|
+
readonly type: "string";
|
|
2228
|
+
readonly description: "Original filename as uploaded.";
|
|
2229
|
+
readonly example: "debug.log";
|
|
2230
|
+
};
|
|
2231
|
+
readonly content_type: {
|
|
2232
|
+
readonly type: "string";
|
|
2233
|
+
readonly description: "MIME content type of the attachment.";
|
|
2234
|
+
readonly example: "text/plain";
|
|
2235
|
+
};
|
|
2236
|
+
readonly size: {
|
|
2237
|
+
readonly type: "integer";
|
|
2238
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2239
|
+
readonly example: 12345;
|
|
2240
|
+
};
|
|
2241
|
+
};
|
|
2242
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2243
|
+
readonly additionalProperties: false;
|
|
2244
|
+
};
|
|
2245
|
+
readonly description: "Attachments associated with this message.";
|
|
2246
|
+
readonly example: readonly [];
|
|
2247
|
+
};
|
|
2248
|
+
readonly date_created: {
|
|
2249
|
+
readonly type: "string";
|
|
2250
|
+
readonly format: "date-time";
|
|
2251
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2252
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2253
|
+
};
|
|
2254
|
+
};
|
|
2255
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2256
|
+
readonly additionalProperties: false;
|
|
2257
|
+
};
|
|
2258
|
+
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
1349
2259
|
};
|
|
1350
2260
|
};
|
|
1351
|
-
readonly required: readonly ["id", "
|
|
2261
|
+
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
1352
2262
|
readonly additionalProperties: false;
|
|
1353
2263
|
};
|
|
1354
2264
|
export declare const TokenCreateInputSchema: {
|
|
@@ -1429,6 +2339,104 @@ export declare const TokenUpdateInputSchema: {
|
|
|
1429
2339
|
};
|
|
1430
2340
|
readonly additionalProperties: false;
|
|
1431
2341
|
};
|
|
2342
|
+
export declare const UsageFacetsSchema: {
|
|
2343
|
+
readonly type: "object";
|
|
2344
|
+
readonly properties: {
|
|
2345
|
+
readonly cluster_id: {
|
|
2346
|
+
readonly type: "array";
|
|
2347
|
+
readonly items: {
|
|
2348
|
+
readonly type: "string";
|
|
2349
|
+
};
|
|
2350
|
+
readonly description: "List of unique cluster IDs";
|
|
2351
|
+
readonly example: readonly ["6b5439b1-923a-4f2b-a371-d554e5ea23fa"];
|
|
2352
|
+
};
|
|
2353
|
+
readonly product: {
|
|
2354
|
+
readonly type: "array";
|
|
2355
|
+
readonly items: {
|
|
2356
|
+
readonly type: "string";
|
|
2357
|
+
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"];
|
|
2358
|
+
};
|
|
2359
|
+
readonly description: "List of unique products";
|
|
2360
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
2361
|
+
};
|
|
2362
|
+
};
|
|
2363
|
+
readonly additionalProperties: false;
|
|
2364
|
+
};
|
|
2365
|
+
export declare const UsageResponseSchema: {
|
|
2366
|
+
readonly type: "object";
|
|
2367
|
+
readonly properties: {
|
|
2368
|
+
readonly data: {
|
|
2369
|
+
readonly type: "array";
|
|
2370
|
+
readonly items: {
|
|
2371
|
+
readonly type: "object";
|
|
2372
|
+
readonly properties: {
|
|
2373
|
+
readonly hour: {
|
|
2374
|
+
readonly type: "string";
|
|
2375
|
+
readonly description: "Hour of the usage";
|
|
2376
|
+
readonly example: "2019-01-01T00:00:00.000Z";
|
|
2377
|
+
};
|
|
2378
|
+
readonly cluster_id: {
|
|
2379
|
+
readonly type: "string";
|
|
2380
|
+
readonly description: "Unique identifier of the kubernetes cluster. UUID v4 string in canonical form";
|
|
2381
|
+
readonly example: "6b5439b1-923a-4f2b-a371-d554e5ea23fa";
|
|
2382
|
+
};
|
|
2383
|
+
readonly product: {
|
|
2384
|
+
readonly type: "string";
|
|
2385
|
+
readonly description: "The product the usage is associated with";
|
|
2386
|
+
readonly example: "cfke_controlplane_pro";
|
|
2387
|
+
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"];
|
|
2388
|
+
};
|
|
2389
|
+
readonly value: {
|
|
2390
|
+
readonly type: "number";
|
|
2391
|
+
readonly format: "float";
|
|
2392
|
+
readonly description: "Consumption";
|
|
2393
|
+
readonly example: 4;
|
|
2394
|
+
};
|
|
2395
|
+
readonly price: {
|
|
2396
|
+
readonly type: "number";
|
|
2397
|
+
readonly format: "float";
|
|
2398
|
+
readonly description: "Price per unit";
|
|
2399
|
+
readonly example: 0.01;
|
|
2400
|
+
};
|
|
2401
|
+
readonly total: {
|
|
2402
|
+
readonly type: "number";
|
|
2403
|
+
readonly format: "float";
|
|
2404
|
+
readonly description: "Total cost";
|
|
2405
|
+
};
|
|
2406
|
+
};
|
|
2407
|
+
readonly required: readonly ["hour", "cluster_id", "product", "value", "price", "total"];
|
|
2408
|
+
readonly additionalProperties: false;
|
|
2409
|
+
};
|
|
2410
|
+
readonly description: "Usage data";
|
|
2411
|
+
};
|
|
2412
|
+
readonly facets: {
|
|
2413
|
+
readonly type: "object";
|
|
2414
|
+
readonly properties: {
|
|
2415
|
+
readonly cluster_id: {
|
|
2416
|
+
readonly type: "array";
|
|
2417
|
+
readonly items: {
|
|
2418
|
+
readonly type: "string";
|
|
2419
|
+
};
|
|
2420
|
+
readonly description: "List of unique cluster IDs";
|
|
2421
|
+
readonly example: readonly ["6b5439b1-923a-4f2b-a371-d554e5ea23fa"];
|
|
2422
|
+
};
|
|
2423
|
+
readonly product: {
|
|
2424
|
+
readonly type: "array";
|
|
2425
|
+
readonly items: {
|
|
2426
|
+
readonly type: "string";
|
|
2427
|
+
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"];
|
|
2428
|
+
};
|
|
2429
|
+
readonly description: "List of unique products";
|
|
2430
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
2431
|
+
};
|
|
2432
|
+
};
|
|
2433
|
+
readonly additionalProperties: false;
|
|
2434
|
+
readonly description: "Facets for filtering";
|
|
2435
|
+
};
|
|
2436
|
+
};
|
|
2437
|
+
readonly required: readonly ["data", "facets"];
|
|
2438
|
+
readonly additionalProperties: false;
|
|
2439
|
+
};
|
|
1432
2440
|
export declare const UsageSchema: {
|
|
1433
2441
|
readonly type: "object";
|
|
1434
2442
|
readonly properties: {
|
|
@@ -1439,78 +2447,34 @@ export declare const UsageSchema: {
|
|
|
1439
2447
|
};
|
|
1440
2448
|
readonly cluster_id: {
|
|
1441
2449
|
readonly type: "string";
|
|
1442
|
-
readonly format: "uuid";
|
|
1443
2450
|
readonly description: "Unique identifier of the kubernetes cluster. UUID v4 string in canonical form";
|
|
1444
2451
|
readonly example: "6b5439b1-923a-4f2b-a371-d554e5ea23fa";
|
|
1445
2452
|
};
|
|
1446
|
-
readonly cluster_tier: {
|
|
1447
|
-
readonly type: "string";
|
|
1448
|
-
readonly description: "Tier of the cluster.";
|
|
1449
|
-
readonly example: "pro";
|
|
1450
|
-
readonly enum: readonly ["basic", "pro", ""];
|
|
1451
|
-
};
|
|
1452
2453
|
readonly product: {
|
|
1453
2454
|
readonly type: "string";
|
|
1454
2455
|
readonly description: "The product the usage is associated with";
|
|
1455
|
-
readonly example: "
|
|
1456
|
-
readonly enum: readonly ["
|
|
1457
|
-
};
|
|
1458
|
-
readonly node_name: {
|
|
1459
|
-
readonly type: "string";
|
|
1460
|
-
readonly description: "Name of the Kubernetes node";
|
|
1461
|
-
readonly example: "flexible-moth-956037384";
|
|
1462
|
-
};
|
|
1463
|
-
readonly sku: {
|
|
1464
|
-
readonly type: "string";
|
|
1465
|
-
readonly description: "SKU of the Kubernetes node";
|
|
1466
|
-
readonly example: "GCP-NORTHAMERICA-NORTHEAST1-A-G1-SMALL-SPOT";
|
|
2456
|
+
readonly example: "cfke_controlplane_pro";
|
|
2457
|
+
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"];
|
|
1467
2458
|
};
|
|
1468
|
-
readonly
|
|
1469
|
-
readonly
|
|
1470
|
-
|
|
1471
|
-
|
|
1472
|
-
|
|
1473
|
-
readonly example: 4;
|
|
1474
|
-
}, {
|
|
1475
|
-
readonly type: "string";
|
|
1476
|
-
readonly enum: readonly [""];
|
|
1477
|
-
}];
|
|
2459
|
+
readonly value: {
|
|
2460
|
+
readonly type: "number";
|
|
2461
|
+
readonly format: "float";
|
|
2462
|
+
readonly description: "Consumption";
|
|
2463
|
+
readonly example: 4;
|
|
1478
2464
|
};
|
|
1479
2465
|
readonly price: {
|
|
1480
|
-
readonly
|
|
1481
|
-
|
|
1482
|
-
|
|
1483
|
-
|
|
1484
|
-
readonly example: 4;
|
|
1485
|
-
}, {
|
|
1486
|
-
readonly type: "string";
|
|
1487
|
-
readonly enum: readonly [""];
|
|
1488
|
-
}];
|
|
1489
|
-
};
|
|
1490
|
-
readonly value: {
|
|
1491
|
-
readonly anyOf: readonly [{
|
|
1492
|
-
readonly type: "number";
|
|
1493
|
-
readonly format: "float";
|
|
1494
|
-
readonly description: "Value";
|
|
1495
|
-
readonly example: 4;
|
|
1496
|
-
}, {
|
|
1497
|
-
readonly type: "string";
|
|
1498
|
-
readonly enum: readonly [""];
|
|
1499
|
-
}];
|
|
2466
|
+
readonly type: "number";
|
|
2467
|
+
readonly format: "float";
|
|
2468
|
+
readonly description: "Price per unit";
|
|
2469
|
+
readonly example: 0.01;
|
|
1500
2470
|
};
|
|
1501
2471
|
readonly total: {
|
|
1502
|
-
readonly
|
|
1503
|
-
|
|
1504
|
-
|
|
1505
|
-
readonly description: "Total";
|
|
1506
|
-
readonly example: 4;
|
|
1507
|
-
}, {
|
|
1508
|
-
readonly type: "string";
|
|
1509
|
-
readonly enum: readonly [""];
|
|
1510
|
-
}];
|
|
2472
|
+
readonly type: "number";
|
|
2473
|
+
readonly format: "float";
|
|
2474
|
+
readonly description: "Total cost";
|
|
1511
2475
|
};
|
|
1512
2476
|
};
|
|
1513
|
-
readonly required: readonly ["
|
|
2477
|
+
readonly required: readonly ["hour", "cluster_id", "product", "value", "price", "total"];
|
|
1514
2478
|
readonly additionalProperties: false;
|
|
1515
2479
|
};
|
|
1516
2480
|
export declare const UserCreateInputSchema: {
|
|
@@ -1547,18 +2511,6 @@ export declare const UserCreateInputSchema: {
|
|
|
1547
2511
|
readonly minLength: 8;
|
|
1548
2512
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
1549
2513
|
};
|
|
1550
|
-
readonly status: {
|
|
1551
|
-
readonly type: "string";
|
|
1552
|
-
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
1553
|
-
readonly example: "active";
|
|
1554
|
-
readonly enum: readonly ["active", "inactive"];
|
|
1555
|
-
};
|
|
1556
|
-
readonly role: {
|
|
1557
|
-
readonly type: "string";
|
|
1558
|
-
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
1559
|
-
readonly example: "User";
|
|
1560
|
-
readonly enum: readonly ["Administrator", "User"];
|
|
1561
|
-
};
|
|
1562
2514
|
};
|
|
1563
2515
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
1564
2516
|
readonly additionalProperties: false;
|