@cloudfleet/sdk 0.0.1-72f9b66 → 0.0.1-737b8cd
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 +1611 -666
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +2935 -695
- 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 +1791 -799
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3843 -2742
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1431 -999
- 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";
|
|
@@ -283,26 +312,103 @@ export declare const ClusterCreateInputSchema: {
|
|
|
283
312
|
readonly tier: {
|
|
284
313
|
readonly type: "string";
|
|
285
314
|
readonly description: "Tier of the cluster.";
|
|
315
|
+
readonly default: "basic";
|
|
286
316
|
readonly example: "pro";
|
|
287
|
-
readonly enum: readonly ["basic", "pro"];
|
|
288
|
-
};
|
|
289
|
-
readonly region: {
|
|
290
|
-
readonly type: "string";
|
|
291
|
-
readonly description: "Cloudfleet control plane region. One of \"staging\", \"northamerica-central-1\", \"europe-central-1a\". This field can not be updated after creation.";
|
|
292
|
-
readonly default: "staging";
|
|
293
|
-
readonly example: "northamerica-central-1";
|
|
294
|
-
readonly enum: readonly ["staging", "northamerica-central-1", "europe-central-1a"];
|
|
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: {
|
|
@@ -392,22 +513,100 @@ export declare const ClusterSchema: {
|
|
|
392
513
|
readonly tier: {
|
|
393
514
|
readonly type: "string";
|
|
394
515
|
readonly description: "Tier of the cluster.";
|
|
516
|
+
readonly default: "basic";
|
|
395
517
|
readonly example: "pro";
|
|
396
|
-
readonly enum: readonly ["basic", "pro"];
|
|
397
|
-
};
|
|
398
|
-
readonly region: {
|
|
399
|
-
readonly type: "string";
|
|
400
|
-
readonly description: "Cloudfleet control plane region. One of \"staging\", \"northamerica-central-1\", \"europe-central-1a\". This field can not be updated after creation.";
|
|
401
|
-
readonly default: "staging";
|
|
402
|
-
readonly example: "northamerica-central-1";
|
|
403
|
-
readonly enum: readonly ["staging", "northamerica-central-1", "europe-central-1a"];
|
|
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";
|
|
@@ -475,18 +686,60 @@ export declare const ClusterUpdateInputSchema: {
|
|
|
475
686
|
readonly tier: {
|
|
476
687
|
readonly type: "string";
|
|
477
688
|
readonly description: "Tier of the cluster.";
|
|
689
|
+
readonly default: "basic";
|
|
478
690
|
readonly example: "pro";
|
|
479
|
-
readonly enum: readonly ["basic", "pro"];
|
|
691
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
480
692
|
};
|
|
481
693
|
readonly version_channel: {
|
|
482
694
|
readonly type: "string";
|
|
483
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-]+)*))?$";
|
|
484
696
|
readonly description: "Version of the kubernetes cluster.";
|
|
485
|
-
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
|
+
};
|
|
486
738
|
};
|
|
487
739
|
};
|
|
488
|
-
readonly required: readonly ["
|
|
740
|
+
readonly required: readonly ["name"];
|
|
489
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.";
|
|
490
743
|
};
|
|
491
744
|
export declare const FleetCreateInputSchema: {
|
|
492
745
|
readonly type: "object";
|
|
@@ -495,13 +748,12 @@ export declare const FleetCreateInputSchema: {
|
|
|
495
748
|
readonly type: "object";
|
|
496
749
|
readonly properties: {
|
|
497
750
|
readonly cpu: {
|
|
498
|
-
readonly type: "
|
|
499
|
-
readonly format: "float";
|
|
751
|
+
readonly type: "integer";
|
|
500
752
|
readonly minimum: 0;
|
|
501
|
-
readonly
|
|
753
|
+
readonly maximum: 100000;
|
|
754
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
502
755
|
};
|
|
503
756
|
};
|
|
504
|
-
readonly required: readonly ["cpu"];
|
|
505
757
|
readonly additionalProperties: false;
|
|
506
758
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
507
759
|
};
|
|
@@ -510,14 +762,15 @@ export declare const FleetCreateInputSchema: {
|
|
|
510
762
|
readonly properties: {
|
|
511
763
|
readonly enabled: {
|
|
512
764
|
readonly type: "boolean";
|
|
513
|
-
readonly default: true;
|
|
514
765
|
};
|
|
515
766
|
readonly project: {
|
|
516
767
|
readonly type: "string";
|
|
517
|
-
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";
|
|
518
771
|
};
|
|
519
772
|
};
|
|
520
|
-
readonly required: readonly ["
|
|
773
|
+
readonly required: readonly ["enabled"];
|
|
521
774
|
readonly additionalProperties: false;
|
|
522
775
|
};
|
|
523
776
|
readonly hetzner: {
|
|
@@ -525,14 +778,16 @@ export declare const FleetCreateInputSchema: {
|
|
|
525
778
|
readonly properties: {
|
|
526
779
|
readonly enabled: {
|
|
527
780
|
readonly type: "boolean";
|
|
528
|
-
readonly default: true;
|
|
529
781
|
};
|
|
530
782
|
readonly apiKey: {
|
|
531
783
|
readonly type: "string";
|
|
532
|
-
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.";
|
|
533
788
|
};
|
|
534
789
|
};
|
|
535
|
-
readonly required: readonly ["
|
|
790
|
+
readonly required: readonly ["enabled"];
|
|
536
791
|
readonly additionalProperties: false;
|
|
537
792
|
};
|
|
538
793
|
readonly aws: {
|
|
@@ -540,15 +795,74 @@ export declare const FleetCreateInputSchema: {
|
|
|
540
795
|
readonly properties: {
|
|
541
796
|
readonly enabled: {
|
|
542
797
|
readonly type: "boolean";
|
|
543
|
-
readonly default: true;
|
|
544
798
|
};
|
|
545
799
|
readonly controllerRoleArn: {
|
|
546
800
|
readonly type: "string";
|
|
547
|
-
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 [];
|
|
548
849
|
};
|
|
549
850
|
};
|
|
550
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
551
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"];
|
|
552
866
|
};
|
|
553
867
|
readonly id: {
|
|
554
868
|
readonly type: "string";
|
|
@@ -561,6 +875,7 @@ export declare const FleetCreateInputSchema: {
|
|
|
561
875
|
};
|
|
562
876
|
readonly required: readonly ["id"];
|
|
563
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.";
|
|
564
879
|
};
|
|
565
880
|
export declare const FleetSchema: {
|
|
566
881
|
readonly type: "object";
|
|
@@ -569,13 +884,12 @@ export declare const FleetSchema: {
|
|
|
569
884
|
readonly type: "object";
|
|
570
885
|
readonly properties: {
|
|
571
886
|
readonly cpu: {
|
|
572
|
-
readonly type: "
|
|
573
|
-
readonly format: "float";
|
|
887
|
+
readonly type: "integer";
|
|
574
888
|
readonly minimum: 0;
|
|
575
|
-
readonly
|
|
889
|
+
readonly maximum: 100000;
|
|
890
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
576
891
|
};
|
|
577
892
|
};
|
|
578
|
-
readonly required: readonly ["cpu"];
|
|
579
893
|
readonly additionalProperties: false;
|
|
580
894
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
581
895
|
};
|
|
@@ -584,14 +898,15 @@ export declare const FleetSchema: {
|
|
|
584
898
|
readonly properties: {
|
|
585
899
|
readonly enabled: {
|
|
586
900
|
readonly type: "boolean";
|
|
587
|
-
readonly default: true;
|
|
588
901
|
};
|
|
589
902
|
readonly project: {
|
|
590
903
|
readonly type: "string";
|
|
591
|
-
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";
|
|
592
907
|
};
|
|
593
908
|
};
|
|
594
|
-
readonly required: readonly ["
|
|
909
|
+
readonly required: readonly ["enabled"];
|
|
595
910
|
readonly additionalProperties: false;
|
|
596
911
|
};
|
|
597
912
|
readonly hetzner: {
|
|
@@ -599,14 +914,14 @@ export declare const FleetSchema: {
|
|
|
599
914
|
readonly properties: {
|
|
600
915
|
readonly enabled: {
|
|
601
916
|
readonly type: "boolean";
|
|
602
|
-
readonly default: true;
|
|
603
917
|
};
|
|
604
918
|
readonly apiKey: {
|
|
605
919
|
readonly type: "string";
|
|
606
|
-
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.";
|
|
607
922
|
};
|
|
608
923
|
};
|
|
609
|
-
readonly required: readonly ["
|
|
924
|
+
readonly required: readonly ["enabled"];
|
|
610
925
|
readonly additionalProperties: false;
|
|
611
926
|
};
|
|
612
927
|
readonly aws: {
|
|
@@ -614,15 +929,75 @@ export declare const FleetSchema: {
|
|
|
614
929
|
readonly properties: {
|
|
615
930
|
readonly enabled: {
|
|
616
931
|
readonly type: "boolean";
|
|
617
|
-
readonly default: true;
|
|
618
932
|
};
|
|
619
933
|
readonly controllerRoleArn: {
|
|
620
934
|
readonly type: "string";
|
|
621
|
-
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 [];
|
|
622
983
|
};
|
|
623
984
|
};
|
|
624
|
-
readonly required: readonly ["
|
|
985
|
+
readonly required: readonly ["karpenter.sh/capacity-type", "kubernetes.io/arch"];
|
|
625
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"];
|
|
626
1001
|
};
|
|
627
1002
|
readonly id: {
|
|
628
1003
|
readonly type: "string";
|
|
@@ -632,9 +1007,30 @@ export declare const FleetSchema: {
|
|
|
632
1007
|
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
633
1008
|
readonly example: "new-clouds-fleet";
|
|
634
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
|
+
};
|
|
635
1030
|
};
|
|
636
|
-
readonly required: readonly ["id"];
|
|
1031
|
+
readonly required: readonly ["constraints", "scalingProfile", "id", "ready", "created_at", "updated_at"];
|
|
637
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.";
|
|
638
1034
|
};
|
|
639
1035
|
export declare const FleetUpdateInputSchema: {
|
|
640
1036
|
readonly type: "object";
|
|
@@ -643,13 +1039,12 @@ export declare const FleetUpdateInputSchema: {
|
|
|
643
1039
|
readonly type: "object";
|
|
644
1040
|
readonly properties: {
|
|
645
1041
|
readonly cpu: {
|
|
646
|
-
readonly type: "
|
|
647
|
-
readonly format: "float";
|
|
1042
|
+
readonly type: "integer";
|
|
648
1043
|
readonly minimum: 0;
|
|
649
|
-
readonly
|
|
1044
|
+
readonly maximum: 100000;
|
|
1045
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
650
1046
|
};
|
|
651
1047
|
};
|
|
652
|
-
readonly required: readonly ["cpu"];
|
|
653
1048
|
readonly additionalProperties: false;
|
|
654
1049
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
655
1050
|
};
|
|
@@ -658,14 +1053,15 @@ export declare const FleetUpdateInputSchema: {
|
|
|
658
1053
|
readonly properties: {
|
|
659
1054
|
readonly enabled: {
|
|
660
1055
|
readonly type: "boolean";
|
|
661
|
-
readonly default: true;
|
|
662
1056
|
};
|
|
663
1057
|
readonly project: {
|
|
664
1058
|
readonly type: "string";
|
|
665
|
-
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";
|
|
666
1062
|
};
|
|
667
1063
|
};
|
|
668
|
-
readonly required: readonly ["
|
|
1064
|
+
readonly required: readonly ["enabled"];
|
|
669
1065
|
readonly additionalProperties: false;
|
|
670
1066
|
};
|
|
671
1067
|
readonly hetzner: {
|
|
@@ -673,14 +1069,16 @@ export declare const FleetUpdateInputSchema: {
|
|
|
673
1069
|
readonly properties: {
|
|
674
1070
|
readonly enabled: {
|
|
675
1071
|
readonly type: "boolean";
|
|
676
|
-
readonly default: true;
|
|
677
1072
|
};
|
|
678
1073
|
readonly apiKey: {
|
|
679
1074
|
readonly type: "string";
|
|
680
|
-
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.";
|
|
681
1079
|
};
|
|
682
1080
|
};
|
|
683
|
-
readonly required: readonly ["
|
|
1081
|
+
readonly required: readonly ["enabled"];
|
|
684
1082
|
readonly additionalProperties: false;
|
|
685
1083
|
};
|
|
686
1084
|
readonly aws: {
|
|
@@ -688,26 +1086,106 @@ export declare const FleetUpdateInputSchema: {
|
|
|
688
1086
|
readonly properties: {
|
|
689
1087
|
readonly enabled: {
|
|
690
1088
|
readonly type: "boolean";
|
|
691
|
-
readonly default: true;
|
|
692
1089
|
};
|
|
693
1090
|
readonly controllerRoleArn: {
|
|
694
1091
|
readonly type: "string";
|
|
695
|
-
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";
|
|
696
1095
|
};
|
|
697
1096
|
};
|
|
698
|
-
readonly required: readonly ["
|
|
1097
|
+
readonly required: readonly ["enabled"];
|
|
699
1098
|
readonly additionalProperties: false;
|
|
700
1099
|
};
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
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";
|
|
1184
|
+
readonly properties: {
|
|
1185
|
+
readonly id: {
|
|
1186
|
+
readonly type: "string";
|
|
1187
|
+
readonly description: "Unique identifier of the invitation.";
|
|
1188
|
+
readonly example: "65831dd20d20165489cbb868";
|
|
711
1189
|
};
|
|
712
1190
|
readonly organization_id: {
|
|
713
1191
|
readonly type: "string";
|
|
@@ -732,6 +1210,13 @@ export declare const InviteSchema: {
|
|
|
732
1210
|
readonly description: "Generated unique invite code.";
|
|
733
1211
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
734
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
|
+
};
|
|
735
1220
|
};
|
|
736
1221
|
readonly required: readonly ["date_created"];
|
|
737
1222
|
readonly additionalProperties: false;
|
|
@@ -741,23 +1226,18 @@ export declare const InvoiceSchema: {
|
|
|
741
1226
|
readonly properties: {
|
|
742
1227
|
readonly id: {
|
|
743
1228
|
readonly type: "string";
|
|
744
|
-
readonly
|
|
745
|
-
readonly
|
|
746
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
1229
|
+
readonly description: "Unique identifier of the invoice.";
|
|
1230
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
747
1231
|
};
|
|
748
|
-
readonly
|
|
1232
|
+
readonly number: {
|
|
749
1233
|
readonly type: "string";
|
|
750
|
-
readonly format: "uuid";
|
|
751
|
-
readonly description: "Unique identifier of the organization. UUID v4 string in canonical form";
|
|
752
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
753
1234
|
};
|
|
754
1235
|
readonly status: {
|
|
755
1236
|
readonly type: "string";
|
|
756
1237
|
readonly description: "Status of the invoice";
|
|
757
|
-
readonly example: "
|
|
758
|
-
readonly enum: readonly ["DRAFT", "COMMITTED", "VOID"];
|
|
1238
|
+
readonly example: "paid";
|
|
759
1239
|
};
|
|
760
|
-
readonly
|
|
1240
|
+
readonly total: {
|
|
761
1241
|
readonly type: "number";
|
|
762
1242
|
readonly format: "float";
|
|
763
1243
|
readonly description: "Total amount of the invoice";
|
|
@@ -766,596 +1246,1019 @@ export declare const InvoiceSchema: {
|
|
|
766
1246
|
readonly currency: {
|
|
767
1247
|
readonly type: "string";
|
|
768
1248
|
readonly description: "Currency of the invoice";
|
|
769
|
-
readonly example: "
|
|
770
|
-
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"];
|
|
1249
|
+
readonly example: "usd";
|
|
771
1250
|
};
|
|
772
|
-
readonly
|
|
773
|
-
readonly type: "
|
|
774
|
-
readonly format: "
|
|
775
|
-
readonly description: "
|
|
776
|
-
readonly example:
|
|
1251
|
+
readonly created: {
|
|
1252
|
+
readonly type: "string";
|
|
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";
|
|
1256
|
+
};
|
|
1257
|
+
readonly period_start: {
|
|
1258
|
+
readonly type: "string";
|
|
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";
|
|
1262
|
+
};
|
|
1263
|
+
readonly period_end: {
|
|
1264
|
+
readonly type: "string";
|
|
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";
|
|
1268
|
+
};
|
|
1269
|
+
readonly invoice_pdf: {
|
|
1270
|
+
readonly type: "string";
|
|
1271
|
+
};
|
|
1272
|
+
};
|
|
1273
|
+
readonly required: readonly ["created", "period_start", "period_end"];
|
|
1274
|
+
readonly additionalProperties: false;
|
|
1275
|
+
};
|
|
1276
|
+
export declare const MarketplaceListingFilesSchema: {
|
|
1277
|
+
readonly type: "object";
|
|
1278
|
+
readonly properties: {
|
|
1279
|
+
readonly chartYaml: {
|
|
1280
|
+
readonly type: "string";
|
|
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";
|
|
1283
|
+
};
|
|
1284
|
+
readonly valuesYaml: {
|
|
1285
|
+
readonly type: "string";
|
|
1286
|
+
readonly description: "Raw values.yaml content from the Helm chart";
|
|
1287
|
+
readonly example: "replicaCount: 1\nimage:\n repository: nginx\n tag: latest";
|
|
1288
|
+
};
|
|
1289
|
+
readonly valuesSchemaJson: {
|
|
1290
|
+
readonly type: "string";
|
|
1291
|
+
readonly description: "JSON schema for values.yaml as a string";
|
|
1292
|
+
readonly example: "{\"type\":\"object\",\"properties\":{\"replicaCount\":{\"type\":\"number\"}}}";
|
|
1293
|
+
};
|
|
1294
|
+
};
|
|
1295
|
+
readonly additionalProperties: false;
|
|
1296
|
+
};
|
|
1297
|
+
export declare const MarketplaceListingSchema: {
|
|
1298
|
+
readonly type: "object";
|
|
1299
|
+
readonly properties: {
|
|
1300
|
+
readonly name: {
|
|
1301
|
+
readonly type: "string";
|
|
1302
|
+
readonly description: "Name of the chart";
|
|
1303
|
+
readonly example: "nginx-ingress";
|
|
1304
|
+
};
|
|
1305
|
+
readonly versions: {
|
|
1306
|
+
readonly type: "array";
|
|
1307
|
+
readonly items: {
|
|
1308
|
+
readonly type: "string";
|
|
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";
|
|
1312
|
+
};
|
|
1313
|
+
readonly description: "Available versions of the chart";
|
|
1314
|
+
};
|
|
1315
|
+
readonly version_channels: {
|
|
1316
|
+
readonly type: "array";
|
|
1317
|
+
readonly items: {
|
|
1318
|
+
readonly type: "string";
|
|
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-]+)*))?$";
|
|
1320
|
+
readonly description: "Version channel pattern";
|
|
1321
|
+
readonly example: "1.18.x-cfke.x";
|
|
1322
|
+
};
|
|
1323
|
+
readonly description: "Version channels for the chart";
|
|
1324
|
+
};
|
|
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: {
|
|
1361
|
+
readonly type: "string";
|
|
1362
|
+
};
|
|
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: {
|
|
1379
|
+
readonly type: "string";
|
|
1380
|
+
};
|
|
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;
|
|
1402
|
+
};
|
|
1403
|
+
readonly description: "Chart maintainers";
|
|
1404
|
+
};
|
|
1405
|
+
};
|
|
1406
|
+
readonly required: readonly ["name", "version"];
|
|
1407
|
+
readonly additionalProperties: false;
|
|
1408
|
+
readonly description: "Chart metadata";
|
|
1409
|
+
};
|
|
1410
|
+
};
|
|
1411
|
+
readonly required: readonly ["name", "versions", "version_channels", "latestVersion"];
|
|
1412
|
+
readonly additionalProperties: false;
|
|
1413
|
+
};
|
|
1414
|
+
export declare const OrganizationCreateInputSchema: {
|
|
1415
|
+
readonly type: "object";
|
|
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
|
+
};
|
|
1423
|
+
readonly email: {
|
|
1424
|
+
readonly type: "string";
|
|
1425
|
+
readonly format: "email";
|
|
1426
|
+
readonly description: "Email address used for billing as a string.";
|
|
1427
|
+
readonly example: "email@example.com";
|
|
1428
|
+
};
|
|
1429
|
+
readonly first_name: {
|
|
1430
|
+
readonly type: "string";
|
|
1431
|
+
readonly minLength: 1;
|
|
1432
|
+
readonly description: "First name of the billing contact person.";
|
|
1433
|
+
readonly example: "John";
|
|
1434
|
+
};
|
|
1435
|
+
readonly last_name: {
|
|
1436
|
+
readonly type: "string";
|
|
1437
|
+
readonly minLength: 1;
|
|
1438
|
+
readonly description: "Last name of the billing contact person.";
|
|
1439
|
+
readonly example: "Doe";
|
|
1440
|
+
};
|
|
1441
|
+
readonly company_name: {
|
|
1442
|
+
readonly type: "string";
|
|
1443
|
+
readonly maxLength: 120;
|
|
1444
|
+
readonly minLength: 2;
|
|
1445
|
+
readonly pattern: "^(?!\\s)(?!.*\\s$)(?=.*[a-zA-ZÆÐƎƏƐƔIJŊŒẞÞǷȜæðǝəɛɣijŋœĸſßþƿȝĄƁÇĐƊĘĦĮƘŁØƠŞȘŢȚŦŲƯY̨Ƴąɓçđɗęħįƙłøơşșţțŧųưy̨ƴÁÀÂÄǍĂĀÃÅǺĄÆǼǢƁĆĊĈČÇĎḌĐƊÐÉÈĖÊËĚĔĒĘẸƎƏƐĠĜǦĞĢƔáàâäǎăāãåǻąæǽǣɓćċĉčçďḍđɗðéèėêëěĕēęẹǝəɛġĝǧğģɣĤḤĦIÍÌİÎÏǏĬĪĨĮỊIJĴĶƘĹĻŁĽĿʼNŃN̈ŇÑŅŊÓÒÔÖǑŎŌÕŐỌØǾƠŒĥḥħıíìiîïǐĭīĩįịijĵķƙĸĺļłľŀʼnńn̈ňñņŋóòôöǒŏōõőọøǿơœŔŘŖŚŜŠŞȘṢẞŤŢṬŦÞÚÙÛÜǓŬŪŨŰŮŲỤƯẂẀŴẄǷÝỲŶŸȲỸƳŹŻŽẒŕřŗſśŝšşșṣßťţṭŧþúùûüǔŭūũűůųụưẃẁŵẅƿýỳŷÿȳỹƴźżžẓ0-9])[a-zA-ZÆÐƎƏƐƔIJŊŒẞÞǷȜæðǝəɛɣijŋœĸſßþƿȝĄƁÇĐƊĘĦĮƘŁØƠŞȘŢȚŦŲƯY̨Ƴąɓçđɗęħįƙłøơşșţțŧųưy̨ƴÁÀÂÄǍĂĀÃÅǺĄÆǼǢƁĆĊĈČÇĎḌĐƊÐÉÈĖÊËĚĔĒĘẸƎƏƐĠĜǦĞĢƔáàâäǎăāãåǻąæǽǣɓćċĉčçďḍđɗðéèėêëěĕēęẹǝəɛġĝǧğģɣĤḤĦIÍÌİÎÏǏĬĪĨĮỊIJĴĶƘĹĻŁĽĿʼNŃN̈ŇÑŅŊÓÒÔÖǑŎŌÕŐỌØǾƠŒĥḥħıíìiîïǐĭīĩįịijĵķƙĸĺļłľŀʼnńn̈ňñņŋóòôöǒŏōõőọøǿơœŔŘŖŚŜŠŞȘṢẞŤŢṬŦÞÚÙÛÜǓŬŪŨŰŮŲỤƯẂẀŴẄǷÝỲŶŸȲỸƳŹŻŽẒŕřŗſśŝšşșṣßťţṭŧþúùûüǔŭūũűůųụưẃẁŵẅƿýỳŷÿȳỹƴźżžẓ0-9 -.]{2,}$";
|
|
1446
|
+
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
1447
|
+
readonly example: "ACME Corp.";
|
|
1448
|
+
};
|
|
1449
|
+
readonly password: {
|
|
1450
|
+
readonly type: "string";
|
|
1451
|
+
readonly minLength: 8;
|
|
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.";
|
|
1453
|
+
};
|
|
1454
|
+
};
|
|
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"];
|
|
1468
|
+
readonly additionalProperties: false;
|
|
1469
|
+
};
|
|
1470
|
+
export declare const OrganizationSchema: {
|
|
1471
|
+
readonly type: "object";
|
|
1472
|
+
readonly properties: {
|
|
1473
|
+
readonly id: {
|
|
1474
|
+
readonly type: "string";
|
|
1475
|
+
readonly format: "uuid";
|
|
1476
|
+
readonly description: "Unique identifier of the organization. UUID v4 string in canonical form";
|
|
1477
|
+
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1478
|
+
};
|
|
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;
|
|
777
1686
|
};
|
|
778
|
-
readonly
|
|
779
|
-
readonly type: "
|
|
780
|
-
readonly
|
|
781
|
-
readonly description: "
|
|
782
|
-
readonly example:
|
|
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;
|
|
783
1692
|
};
|
|
784
|
-
readonly
|
|
785
|
-
readonly type: "
|
|
786
|
-
readonly description: "
|
|
787
|
-
readonly example:
|
|
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;
|
|
788
1697
|
};
|
|
789
|
-
readonly
|
|
790
|
-
readonly type: "
|
|
791
|
-
readonly
|
|
792
|
-
readonly
|
|
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;
|
|
793
1703
|
};
|
|
794
|
-
readonly
|
|
795
|
-
readonly type: "
|
|
796
|
-
readonly description: "
|
|
797
|
-
readonly example:
|
|
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;
|
|
798
1708
|
};
|
|
799
|
-
readonly
|
|
800
|
-
readonly type: "
|
|
801
|
-
readonly
|
|
802
|
-
readonly description: "
|
|
803
|
-
readonly example:
|
|
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;
|
|
804
1714
|
};
|
|
805
|
-
readonly
|
|
806
|
-
readonly type: "
|
|
807
|
-
readonly
|
|
808
|
-
|
|
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.";
|
|
809
1732
|
};
|
|
810
|
-
readonly
|
|
1733
|
+
readonly versions: {
|
|
811
1734
|
readonly type: "array";
|
|
812
1735
|
readonly items: {
|
|
813
1736
|
readonly type: "object";
|
|
814
1737
|
readonly properties: {
|
|
815
1738
|
readonly id: {
|
|
816
1739
|
readonly type: "string";
|
|
817
|
-
readonly
|
|
818
|
-
readonly
|
|
819
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
820
|
-
};
|
|
821
|
-
readonly linkedInvoiceItemId: {
|
|
822
|
-
readonly type: "string";
|
|
823
|
-
readonly format: "uuid";
|
|
824
|
-
readonly description: "Unique identifier of the linked invoice item. UUID v4 string in canonical form";
|
|
825
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
826
|
-
};
|
|
827
|
-
readonly productName: {
|
|
828
|
-
readonly type: "string";
|
|
829
|
-
readonly description: "Name of the product";
|
|
830
|
-
readonly example: "Research team";
|
|
831
|
-
};
|
|
832
|
-
readonly planName: {
|
|
833
|
-
readonly type: "string";
|
|
834
|
-
readonly description: "Name of the plan";
|
|
835
|
-
readonly example: "Plan A";
|
|
836
|
-
};
|
|
837
|
-
readonly phaseName: {
|
|
838
|
-
readonly type: "string";
|
|
839
|
-
readonly description: "Name of the phase";
|
|
840
|
-
readonly example: "Phase A";
|
|
841
|
-
};
|
|
842
|
-
readonly usageName: {
|
|
843
|
-
readonly type: "string";
|
|
844
|
-
readonly description: "Name of the usage";
|
|
845
|
-
readonly example: "Usage A";
|
|
846
|
-
};
|
|
847
|
-
readonly prettyProductName: {
|
|
848
|
-
readonly type: "string";
|
|
849
|
-
readonly description: "Pretty name of the product";
|
|
850
|
-
readonly example: "Research team";
|
|
851
|
-
};
|
|
852
|
-
readonly prettyPlanName: {
|
|
853
|
-
readonly type: "string";
|
|
854
|
-
readonly description: "Pretty name of the plan";
|
|
855
|
-
readonly example: "Plan A";
|
|
856
|
-
};
|
|
857
|
-
readonly prettyPhaseName: {
|
|
858
|
-
readonly type: "string";
|
|
859
|
-
readonly description: "Pretty name of the phase";
|
|
860
|
-
readonly example: "Phase A";
|
|
861
|
-
};
|
|
862
|
-
readonly prettyUsageName: {
|
|
863
|
-
readonly type: "string";
|
|
864
|
-
readonly description: "Pretty name of the usage";
|
|
865
|
-
readonly example: "Usage A";
|
|
866
|
-
};
|
|
867
|
-
readonly itemType: {
|
|
868
|
-
readonly type: "string";
|
|
869
|
-
readonly description: "Type of the invoice item";
|
|
870
|
-
readonly example: "EXTERNAL_CHARGE";
|
|
871
|
-
readonly enum: readonly ["EXTERNAL_CHARGE", "FIXED", "RECURRING", "REPAIR_ADJ", "CBA_ADJ", "CREDIT_ADJ", "ITEM_ADJ", "USAGE", "TAX", "PARENT_SUMMARY"];
|
|
872
|
-
};
|
|
873
|
-
readonly description: {
|
|
874
|
-
readonly type: "string";
|
|
875
|
-
readonly description: "Description of the invoice item";
|
|
876
|
-
readonly example: "Description of the invoice item";
|
|
877
|
-
};
|
|
878
|
-
readonly startDate: {
|
|
879
|
-
readonly type: "string";
|
|
880
|
-
readonly description: "Start date of the invoice item";
|
|
881
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
882
|
-
};
|
|
883
|
-
readonly endDate: {
|
|
884
|
-
readonly type: "string";
|
|
885
|
-
readonly description: "End date of the invoice item";
|
|
886
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
887
|
-
};
|
|
888
|
-
readonly amount: {
|
|
889
|
-
readonly type: "number";
|
|
890
|
-
readonly format: "float";
|
|
891
|
-
readonly description: "Amount of the invoice item";
|
|
892
|
-
readonly example: 100;
|
|
893
|
-
};
|
|
894
|
-
readonly rate: {
|
|
895
|
-
readonly type: "number";
|
|
896
|
-
readonly format: "float";
|
|
897
|
-
readonly description: "Rate of the invoice item";
|
|
898
|
-
readonly example: 100;
|
|
899
|
-
};
|
|
900
|
-
readonly currency: {
|
|
901
|
-
readonly type: "string";
|
|
902
|
-
readonly description: "Currency of the invoice item";
|
|
903
|
-
readonly example: "USD";
|
|
904
|
-
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"];
|
|
905
|
-
};
|
|
906
|
-
readonly quantity: {
|
|
907
|
-
readonly type: "number";
|
|
908
|
-
readonly format: "float";
|
|
909
|
-
readonly description: "Quantity of the invoice item";
|
|
910
|
-
readonly example: 1;
|
|
911
|
-
};
|
|
912
|
-
readonly itemDetails: {
|
|
913
|
-
readonly type: "string";
|
|
914
|
-
readonly description: "Details of the invoice item";
|
|
915
|
-
readonly example: "Details of the invoice item";
|
|
1740
|
+
readonly description: "Id of the control plane version. Used in API calls.";
|
|
1741
|
+
readonly example: "1.33.x-cfke.x";
|
|
916
1742
|
};
|
|
917
|
-
readonly
|
|
1743
|
+
readonly label: {
|
|
918
1744
|
readonly type: "string";
|
|
919
|
-
readonly description: "
|
|
920
|
-
readonly example: "
|
|
921
|
-
};
|
|
922
|
-
readonly childItems: {
|
|
923
|
-
readonly type: "array";
|
|
924
|
-
readonly items: {
|
|
925
|
-
readonly oneOf: readonly [{
|
|
926
|
-
readonly type: "array";
|
|
927
|
-
}, {
|
|
928
|
-
readonly type: "boolean";
|
|
929
|
-
}, {
|
|
930
|
-
readonly type: "number";
|
|
931
|
-
}, {
|
|
932
|
-
readonly type: "object";
|
|
933
|
-
readonly additionalProperties: true;
|
|
934
|
-
}, {
|
|
935
|
-
readonly type: "string";
|
|
936
|
-
}];
|
|
937
|
-
};
|
|
938
|
-
readonly description: "Child items of the invoice item";
|
|
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)";
|
|
939
1747
|
};
|
|
940
1748
|
};
|
|
1749
|
+
readonly required: readonly ["id", "label"];
|
|
941
1750
|
readonly additionalProperties: false;
|
|
942
1751
|
};
|
|
943
|
-
readonly
|
|
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";
|
|
944
1794
|
};
|
|
945
|
-
readonly
|
|
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: {
|
|
946
1806
|
readonly type: "array";
|
|
947
1807
|
readonly items: {
|
|
948
1808
|
readonly type: "object";
|
|
949
1809
|
readonly properties: {
|
|
950
|
-
readonly
|
|
951
|
-
readonly type: "string";
|
|
952
|
-
readonly format: "uuid";
|
|
953
|
-
readonly description: "Unique identifier of the invoice item. UUID v4 string in canonical form";
|
|
954
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
955
|
-
};
|
|
956
|
-
readonly linkedInvoiceItemId: {
|
|
957
|
-
readonly type: "string";
|
|
958
|
-
readonly format: "uuid";
|
|
959
|
-
readonly description: "Unique identifier of the linked invoice item. UUID v4 string in canonical form";
|
|
960
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
961
|
-
};
|
|
962
|
-
readonly productName: {
|
|
963
|
-
readonly type: "string";
|
|
964
|
-
readonly description: "Name of the product";
|
|
965
|
-
readonly example: "Research team";
|
|
966
|
-
};
|
|
967
|
-
readonly planName: {
|
|
968
|
-
readonly type: "string";
|
|
969
|
-
readonly description: "Name of the plan";
|
|
970
|
-
readonly example: "Plan A";
|
|
971
|
-
};
|
|
972
|
-
readonly phaseName: {
|
|
973
|
-
readonly type: "string";
|
|
974
|
-
readonly description: "Name of the phase";
|
|
975
|
-
readonly example: "Phase A";
|
|
976
|
-
};
|
|
977
|
-
readonly usageName: {
|
|
978
|
-
readonly type: "string";
|
|
979
|
-
readonly description: "Name of the usage";
|
|
980
|
-
readonly example: "Usage A";
|
|
981
|
-
};
|
|
982
|
-
readonly prettyProductName: {
|
|
983
|
-
readonly type: "string";
|
|
984
|
-
readonly description: "Pretty name of the product";
|
|
985
|
-
readonly example: "Research team";
|
|
986
|
-
};
|
|
987
|
-
readonly prettyPlanName: {
|
|
988
|
-
readonly type: "string";
|
|
989
|
-
readonly description: "Pretty name of the plan";
|
|
990
|
-
readonly example: "Plan A";
|
|
991
|
-
};
|
|
992
|
-
readonly prettyPhaseName: {
|
|
993
|
-
readonly type: "string";
|
|
994
|
-
readonly description: "Pretty name of the phase";
|
|
995
|
-
readonly example: "Phase A";
|
|
996
|
-
};
|
|
997
|
-
readonly prettyUsageName: {
|
|
998
|
-
readonly type: "string";
|
|
999
|
-
readonly description: "Pretty name of the usage";
|
|
1000
|
-
readonly example: "Usage A";
|
|
1001
|
-
};
|
|
1002
|
-
readonly itemType: {
|
|
1003
|
-
readonly type: "string";
|
|
1004
|
-
readonly description: "Type of the invoice item";
|
|
1005
|
-
readonly example: "EXTERNAL_CHARGE";
|
|
1006
|
-
readonly enum: readonly ["EXTERNAL_CHARGE", "FIXED", "RECURRING", "REPAIR_ADJ", "CBA_ADJ", "CREDIT_ADJ", "ITEM_ADJ", "USAGE", "TAX", "PARENT_SUMMARY"];
|
|
1007
|
-
};
|
|
1008
|
-
readonly description: {
|
|
1009
|
-
readonly type: "string";
|
|
1010
|
-
readonly description: "Description of the invoice item";
|
|
1011
|
-
readonly example: "Description of the invoice item";
|
|
1012
|
-
};
|
|
1013
|
-
readonly startDate: {
|
|
1014
|
-
readonly type: "string";
|
|
1015
|
-
readonly description: "Start date of the invoice item";
|
|
1016
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
1017
|
-
};
|
|
1018
|
-
readonly endDate: {
|
|
1019
|
-
readonly type: "string";
|
|
1020
|
-
readonly description: "End date of the invoice item";
|
|
1021
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
1022
|
-
};
|
|
1023
|
-
readonly amount: {
|
|
1024
|
-
readonly type: "number";
|
|
1025
|
-
readonly format: "float";
|
|
1026
|
-
readonly description: "Amount of the invoice item";
|
|
1027
|
-
readonly example: 100;
|
|
1028
|
-
};
|
|
1029
|
-
readonly rate: {
|
|
1030
|
-
readonly type: "number";
|
|
1031
|
-
readonly format: "float";
|
|
1032
|
-
readonly description: "Rate of the invoice item";
|
|
1033
|
-
readonly example: 100;
|
|
1034
|
-
};
|
|
1035
|
-
readonly currency: {
|
|
1810
|
+
readonly name: {
|
|
1036
1811
|
readonly type: "string";
|
|
1037
|
-
readonly description: "
|
|
1038
|
-
readonly example: "
|
|
1039
|
-
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"];
|
|
1812
|
+
readonly description: "Tag name.";
|
|
1813
|
+
readonly example: "latest";
|
|
1040
1814
|
};
|
|
1041
|
-
readonly
|
|
1815
|
+
readonly size: {
|
|
1042
1816
|
readonly type: "number";
|
|
1043
1817
|
readonly format: "float";
|
|
1044
|
-
readonly description: "
|
|
1045
|
-
readonly example:
|
|
1046
|
-
};
|
|
1047
|
-
readonly itemDetails: {
|
|
1048
|
-
readonly type: "string";
|
|
1049
|
-
readonly description: "Details of the invoice item";
|
|
1050
|
-
readonly example: "Details of the invoice item";
|
|
1818
|
+
readonly description: "Size of the tag in bytes.";
|
|
1819
|
+
readonly example: 123456789;
|
|
1051
1820
|
};
|
|
1052
|
-
readonly
|
|
1821
|
+
readonly mediaType: {
|
|
1053
1822
|
readonly type: "string";
|
|
1054
|
-
readonly description: "
|
|
1055
|
-
readonly example: "
|
|
1823
|
+
readonly description: "Media type of the manifest.";
|
|
1824
|
+
readonly example: "application/vnd.docker.distribution.manifest.v2+json";
|
|
1056
1825
|
};
|
|
1057
|
-
readonly
|
|
1826
|
+
readonly platforms: {
|
|
1058
1827
|
readonly type: "array";
|
|
1059
1828
|
readonly items: {
|
|
1060
|
-
readonly
|
|
1061
|
-
readonly type: "array";
|
|
1062
|
-
}, {
|
|
1063
|
-
readonly type: "boolean";
|
|
1064
|
-
}, {
|
|
1065
|
-
readonly type: "number";
|
|
1066
|
-
}, {
|
|
1067
|
-
readonly type: "object";
|
|
1068
|
-
readonly additionalProperties: true;
|
|
1069
|
-
}, {
|
|
1070
|
-
readonly type: "string";
|
|
1071
|
-
}];
|
|
1829
|
+
readonly type: "string";
|
|
1072
1830
|
};
|
|
1073
|
-
readonly description: "
|
|
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"];
|
|
1074
1833
|
};
|
|
1075
1834
|
};
|
|
1835
|
+
readonly required: readonly ["name", "size"];
|
|
1076
1836
|
readonly additionalProperties: false;
|
|
1077
1837
|
};
|
|
1078
|
-
readonly description: "
|
|
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;
|
|
1079
1845
|
};
|
|
1080
1846
|
};
|
|
1847
|
+
readonly required: readonly ["name", "region", "uri", "tags", "totalSize"];
|
|
1081
1848
|
readonly additionalProperties: false;
|
|
1082
1849
|
};
|
|
1083
|
-
export declare const
|
|
1850
|
+
export declare const RegistryTagSchema: {
|
|
1084
1851
|
readonly type: "object";
|
|
1085
1852
|
readonly properties: {
|
|
1086
|
-
readonly id: {
|
|
1087
|
-
readonly type: "string";
|
|
1088
|
-
readonly maxLength: 63;
|
|
1089
|
-
readonly minLength: 1;
|
|
1090
|
-
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
1091
|
-
readonly description: "Id of the chart listing";
|
|
1092
|
-
readonly example: "portworx-enterprise-disaster-recovery-baremetal";
|
|
1093
|
-
};
|
|
1094
1853
|
readonly name: {
|
|
1095
1854
|
readonly type: "string";
|
|
1096
|
-
readonly description: "
|
|
1097
|
-
readonly example: "
|
|
1098
|
-
};
|
|
1099
|
-
readonly developer: {
|
|
1100
|
-
readonly type: "string";
|
|
1101
|
-
readonly description: "Author of the chart listing";
|
|
1102
|
-
readonly example: "Portworx";
|
|
1103
|
-
};
|
|
1104
|
-
readonly description: {
|
|
1105
|
-
readonly type: "string";
|
|
1106
|
-
readonly description: "Short description of the chart listing";
|
|
1107
|
-
readonly example: "Run Kubernetes with unmatched scalability, availability, and self-service access to any storage";
|
|
1855
|
+
readonly description: "Tag name.";
|
|
1856
|
+
readonly example: "latest";
|
|
1108
1857
|
};
|
|
1109
|
-
readonly
|
|
1858
|
+
readonly digest: {
|
|
1110
1859
|
readonly type: "string";
|
|
1111
|
-
readonly description: "
|
|
1112
|
-
readonly example: "
|
|
1860
|
+
readonly description: "Manifest digest for pulling by digest.";
|
|
1861
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1113
1862
|
};
|
|
1114
|
-
readonly
|
|
1863
|
+
readonly mediaType: {
|
|
1115
1864
|
readonly type: "string";
|
|
1116
|
-
readonly description: "
|
|
1117
|
-
readonly example: "
|
|
1865
|
+
readonly description: "Media type of the manifest.";
|
|
1866
|
+
readonly example: "application/vnd.docker.distribution.manifest.v2+json";
|
|
1118
1867
|
};
|
|
1119
|
-
readonly
|
|
1120
|
-
readonly type: "
|
|
1121
|
-
readonly
|
|
1122
|
-
readonly
|
|
1123
|
-
|
|
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
|
+
};
|
|
1124
1877
|
};
|
|
1125
|
-
readonly
|
|
1878
|
+
readonly required: readonly ["size"];
|
|
1879
|
+
readonly additionalProperties: false;
|
|
1880
|
+
readonly description: "Manifest config metadata.";
|
|
1126
1881
|
};
|
|
1127
|
-
readonly
|
|
1882
|
+
readonly layers: {
|
|
1128
1883
|
readonly type: "array";
|
|
1129
1884
|
readonly items: {
|
|
1130
|
-
readonly type: "
|
|
1131
|
-
readonly
|
|
1132
|
-
|
|
1133
|
-
|
|
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;
|
|
1134
1901
|
};
|
|
1902
|
+
readonly description: "Array of layer metadata.";
|
|
1135
1903
|
};
|
|
1136
|
-
readonly
|
|
1904
|
+
readonly manifests: {
|
|
1137
1905
|
readonly type: "array";
|
|
1138
1906
|
readonly items: {
|
|
1139
1907
|
readonly type: "object";
|
|
1140
1908
|
readonly properties: {
|
|
1141
|
-
readonly
|
|
1909
|
+
readonly digest: {
|
|
1142
1910
|
readonly type: "string";
|
|
1143
|
-
readonly
|
|
1144
|
-
readonly
|
|
1145
|
-
readonly example: "2.1.1-cfke.123";
|
|
1911
|
+
readonly description: "Digest of the manifest.";
|
|
1912
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1146
1913
|
};
|
|
1147
|
-
readonly
|
|
1148
|
-
readonly type: "
|
|
1149
|
-
readonly
|
|
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.";
|
|
1150
1936
|
};
|
|
1151
|
-
readonly
|
|
1152
|
-
readonly type: "
|
|
1153
|
-
readonly
|
|
1154
|
-
|
|
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;
|
|
1155
1964
|
};
|
|
1156
1965
|
};
|
|
1157
|
-
readonly required: readonly ["
|
|
1966
|
+
readonly required: readonly ["digest"];
|
|
1158
1967
|
readonly additionalProperties: false;
|
|
1159
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";
|
|
1160
1991
|
};
|
|
1161
1992
|
};
|
|
1162
|
-
readonly required: readonly ["
|
|
1993
|
+
readonly required: readonly ["name", "digest", "size", "region", "repository", "uri"];
|
|
1163
1994
|
readonly additionalProperties: false;
|
|
1164
1995
|
};
|
|
1165
|
-
export declare const
|
|
1996
|
+
export declare const TicketAttachmentSchema: {
|
|
1166
1997
|
readonly type: "object";
|
|
1167
1998
|
readonly properties: {
|
|
1168
|
-
readonly
|
|
1999
|
+
readonly id: {
|
|
1169
2000
|
readonly type: "string";
|
|
1170
|
-
readonly
|
|
1171
|
-
readonly
|
|
1172
|
-
readonly example: "email@example.com";
|
|
2001
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2002
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1173
2003
|
};
|
|
1174
|
-
readonly
|
|
2004
|
+
readonly filename: {
|
|
1175
2005
|
readonly type: "string";
|
|
1176
|
-
readonly description: "
|
|
1177
|
-
readonly example: "
|
|
2006
|
+
readonly description: "Original filename as uploaded.";
|
|
2007
|
+
readonly example: "debug.log";
|
|
1178
2008
|
};
|
|
1179
|
-
readonly
|
|
2009
|
+
readonly content_type: {
|
|
1180
2010
|
readonly type: "string";
|
|
1181
|
-
readonly description: "
|
|
1182
|
-
readonly example: "
|
|
2011
|
+
readonly description: "MIME content type of the attachment.";
|
|
2012
|
+
readonly example: "text/plain";
|
|
1183
2013
|
};
|
|
1184
|
-
readonly
|
|
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: {
|
|
1185
2027
|
readonly type: "string";
|
|
1186
|
-
readonly
|
|
1187
|
-
readonly
|
|
1188
|
-
readonly
|
|
1189
|
-
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
1190
|
-
readonly example: "ACME Corp.";
|
|
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"];
|
|
1191
2031
|
};
|
|
1192
|
-
readonly
|
|
2032
|
+
readonly body: {
|
|
1193
2033
|
readonly type: "string";
|
|
1194
|
-
readonly
|
|
1195
|
-
readonly
|
|
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
|
+
};
|
|
1196
2048
|
};
|
|
1197
2049
|
};
|
|
1198
|
-
readonly required: readonly ["
|
|
2050
|
+
readonly required: readonly ["category", "body"];
|
|
1199
2051
|
readonly additionalProperties: false;
|
|
1200
2052
|
};
|
|
1201
|
-
export declare const
|
|
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: {
|
|
1202
2069
|
readonly type: "object";
|
|
1203
2070
|
readonly properties: {
|
|
1204
2071
|
readonly id: {
|
|
1205
2072
|
readonly type: "string";
|
|
1206
|
-
readonly
|
|
1207
|
-
readonly
|
|
1208
|
-
|
|
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.";
|
|
1209
2086
|
};
|
|
1210
|
-
readonly
|
|
2087
|
+
readonly author_first_name: {
|
|
1211
2088
|
readonly type: "string";
|
|
1212
|
-
readonly
|
|
1213
|
-
readonly
|
|
1214
|
-
readonly
|
|
1215
|
-
readonly example: "ACME Corp.";
|
|
2089
|
+
readonly nullable: true;
|
|
2090
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2091
|
+
readonly example: "Jane";
|
|
1216
2092
|
};
|
|
1217
|
-
readonly
|
|
2093
|
+
readonly author_last_name: {
|
|
1218
2094
|
readonly type: "string";
|
|
1219
|
-
readonly
|
|
1220
|
-
readonly description: "
|
|
1221
|
-
readonly example: "
|
|
2095
|
+
readonly nullable: true;
|
|
2096
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2097
|
+
readonly example: "Doe";
|
|
1222
2098
|
};
|
|
1223
|
-
readonly
|
|
1224
|
-
readonly type: "
|
|
1225
|
-
readonly
|
|
1226
|
-
readonly
|
|
1227
|
-
|
|
1228
|
-
readonly
|
|
1229
|
-
readonly description: "Maximum number of Basic clusters that can be created.";
|
|
1230
|
-
readonly example: 999;
|
|
1231
|
-
};
|
|
1232
|
-
readonly basic_clusters_available: {
|
|
1233
|
-
readonly type: "integer";
|
|
1234
|
-
readonly description: "Available number of Basic clusters that can be created.";
|
|
1235
|
-
readonly example: 999;
|
|
1236
|
-
};
|
|
1237
|
-
readonly pro_clusters_max: {
|
|
1238
|
-
readonly type: "integer";
|
|
1239
|
-
readonly minimum: 0;
|
|
1240
|
-
readonly description: "Maximum number of Pro clusters that can be created.";
|
|
1241
|
-
readonly example: 999;
|
|
1242
|
-
};
|
|
1243
|
-
readonly pro_clusters_available: {
|
|
1244
|
-
readonly type: "integer";
|
|
1245
|
-
readonly description: "Available number of Pro clusters that can be created.";
|
|
1246
|
-
readonly example: 999;
|
|
1247
|
-
};
|
|
1248
|
-
readonly fleets_max: {
|
|
1249
|
-
readonly type: "integer";
|
|
1250
|
-
readonly minimum: 0;
|
|
1251
|
-
readonly description: "Maximum number of fleets that can be created per cluster.";
|
|
1252
|
-
readonly example: 999;
|
|
1253
|
-
};
|
|
1254
|
-
readonly cluster_tiers: {
|
|
1255
|
-
readonly type: "array";
|
|
1256
|
-
readonly items: {
|
|
2099
|
+
readonly attachments: {
|
|
2100
|
+
readonly type: "array";
|
|
2101
|
+
readonly items: {
|
|
2102
|
+
readonly type: "object";
|
|
2103
|
+
readonly properties: {
|
|
2104
|
+
readonly id: {
|
|
1257
2105
|
readonly type: "string";
|
|
1258
|
-
readonly
|
|
2106
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2107
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1259
2108
|
};
|
|
1260
|
-
readonly
|
|
1261
|
-
readonly description: "List of Cloudfleet cluster tiers available for the organization.";
|
|
1262
|
-
};
|
|
1263
|
-
readonly regions: {
|
|
1264
|
-
readonly type: "array";
|
|
1265
|
-
readonly items: {
|
|
2109
|
+
readonly filename: {
|
|
1266
2110
|
readonly type: "string";
|
|
1267
|
-
readonly
|
|
2111
|
+
readonly description: "Original filename as uploaded.";
|
|
2112
|
+
readonly example: "debug.log";
|
|
1268
2113
|
};
|
|
1269
|
-
readonly
|
|
1270
|
-
|
|
1271
|
-
|
|
1272
|
-
|
|
1273
|
-
|
|
1274
|
-
readonly
|
|
1275
|
-
readonly type: "
|
|
1276
|
-
readonly
|
|
1277
|
-
|
|
1278
|
-
readonly type: "string";
|
|
1279
|
-
readonly description: "Id of the control plane version. Used in API calls.";
|
|
1280
|
-
readonly example: "1.29.x-cfke.x";
|
|
1281
|
-
};
|
|
1282
|
-
readonly label: {
|
|
1283
|
-
readonly type: "string";
|
|
1284
|
-
readonly description: "Label of the control plane version. Used in frontent UI.";
|
|
1285
|
-
readonly example: "1.29.x (Always latest 1.29 patch version)";
|
|
1286
|
-
};
|
|
1287
|
-
};
|
|
1288
|
-
readonly required: readonly ["id", "label"];
|
|
1289
|
-
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;
|
|
1290
2123
|
};
|
|
1291
|
-
readonly minItems: 1;
|
|
1292
|
-
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1293
2124
|
};
|
|
2125
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2126
|
+
readonly additionalProperties: false;
|
|
1294
2127
|
};
|
|
1295
|
-
readonly
|
|
1296
|
-
readonly
|
|
1297
|
-
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 [];
|
|
1298
2130
|
};
|
|
1299
|
-
readonly
|
|
2131
|
+
readonly date_created: {
|
|
1300
2132
|
readonly type: "string";
|
|
1301
|
-
readonly
|
|
1302
|
-
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";
|
|
1303
2136
|
};
|
|
1304
2137
|
};
|
|
1305
|
-
readonly required: readonly ["id", "
|
|
2138
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
1306
2139
|
readonly additionalProperties: false;
|
|
1307
2140
|
};
|
|
1308
|
-
export declare const
|
|
2141
|
+
export declare const TicketSchema: {
|
|
1309
2142
|
readonly type: "object";
|
|
1310
2143
|
readonly properties: {
|
|
1311
2144
|
readonly id: {
|
|
1312
2145
|
readonly type: "string";
|
|
1313
|
-
readonly
|
|
1314
|
-
readonly
|
|
1315
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
2146
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
2147
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
1316
2148
|
};
|
|
1317
|
-
readonly
|
|
1318
|
-
readonly type: "
|
|
1319
|
-
readonly description: "
|
|
1320
|
-
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"];
|
|
1321
2154
|
};
|
|
1322
|
-
readonly
|
|
2155
|
+
readonly category: {
|
|
1323
2156
|
readonly type: "string";
|
|
1324
|
-
readonly
|
|
1325
|
-
readonly
|
|
1326
|
-
readonly
|
|
1327
|
-
readonly enum: readonly ["card"];
|
|
2157
|
+
readonly description: "Ticket category.";
|
|
2158
|
+
readonly example: "technical";
|
|
2159
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
1328
2160
|
};
|
|
1329
|
-
readonly
|
|
2161
|
+
readonly summary: {
|
|
1330
2162
|
readonly type: "string";
|
|
1331
|
-
readonly
|
|
1332
|
-
readonly
|
|
1333
|
-
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.";
|
|
1334
2165
|
};
|
|
1335
|
-
readonly
|
|
1336
|
-
readonly type: "
|
|
1337
|
-
readonly
|
|
1338
|
-
readonly maximum: 12;
|
|
2166
|
+
readonly closed_at: {
|
|
2167
|
+
readonly type: "string";
|
|
2168
|
+
readonly format: "date-time";
|
|
1339
2169
|
readonly nullable: true;
|
|
1340
|
-
readonly description: "
|
|
1341
|
-
readonly example: "
|
|
2170
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
2171
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
1342
2172
|
};
|
|
1343
|
-
readonly
|
|
1344
|
-
readonly type: "
|
|
1345
|
-
readonly
|
|
1346
|
-
readonly
|
|
1347
|
-
readonly
|
|
1348
|
-
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";
|
|
1349
2178
|
};
|
|
1350
|
-
readonly
|
|
2179
|
+
readonly date_updated: {
|
|
1351
2180
|
readonly type: "string";
|
|
1352
|
-
readonly
|
|
1353
|
-
readonly description: "
|
|
1354
|
-
readonly example: "
|
|
1355
|
-
|
|
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.";
|
|
1356
2259
|
};
|
|
1357
2260
|
};
|
|
1358
|
-
readonly required: readonly ["id", "
|
|
2261
|
+
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
1359
2262
|
readonly additionalProperties: false;
|
|
1360
2263
|
};
|
|
1361
2264
|
export declare const TokenCreateInputSchema: {
|
|
@@ -1436,6 +2339,104 @@ export declare const TokenUpdateInputSchema: {
|
|
|
1436
2339
|
};
|
|
1437
2340
|
readonly additionalProperties: false;
|
|
1438
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
|
+
};
|
|
1439
2440
|
export declare const UsageSchema: {
|
|
1440
2441
|
readonly type: "object";
|
|
1441
2442
|
readonly properties: {
|
|
@@ -1446,78 +2447,34 @@ export declare const UsageSchema: {
|
|
|
1446
2447
|
};
|
|
1447
2448
|
readonly cluster_id: {
|
|
1448
2449
|
readonly type: "string";
|
|
1449
|
-
readonly format: "uuid";
|
|
1450
2450
|
readonly description: "Unique identifier of the kubernetes cluster. UUID v4 string in canonical form";
|
|
1451
2451
|
readonly example: "6b5439b1-923a-4f2b-a371-d554e5ea23fa";
|
|
1452
2452
|
};
|
|
1453
|
-
readonly cluster_tier: {
|
|
1454
|
-
readonly type: "string";
|
|
1455
|
-
readonly description: "Tier of the cluster.";
|
|
1456
|
-
readonly example: "pro";
|
|
1457
|
-
readonly enum: readonly ["basic", "pro", ""];
|
|
1458
|
-
};
|
|
1459
2453
|
readonly product: {
|
|
1460
2454
|
readonly type: "string";
|
|
1461
2455
|
readonly description: "The product the usage is associated with";
|
|
1462
|
-
readonly example: "
|
|
1463
|
-
readonly enum: readonly ["
|
|
1464
|
-
};
|
|
1465
|
-
readonly node_name: {
|
|
1466
|
-
readonly type: "string";
|
|
1467
|
-
readonly description: "Name of the Kubernetes node";
|
|
1468
|
-
readonly example: "flexible-moth-956037384";
|
|
1469
|
-
};
|
|
1470
|
-
readonly sku: {
|
|
1471
|
-
readonly type: "string";
|
|
1472
|
-
readonly description: "SKU of the Kubernetes node";
|
|
1473
|
-
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"];
|
|
1474
2458
|
};
|
|
1475
|
-
readonly
|
|
1476
|
-
readonly
|
|
1477
|
-
|
|
1478
|
-
|
|
1479
|
-
|
|
1480
|
-
readonly example: 4;
|
|
1481
|
-
}, {
|
|
1482
|
-
readonly type: "string";
|
|
1483
|
-
readonly enum: readonly [""];
|
|
1484
|
-
}];
|
|
2459
|
+
readonly value: {
|
|
2460
|
+
readonly type: "number";
|
|
2461
|
+
readonly format: "float";
|
|
2462
|
+
readonly description: "Consumption";
|
|
2463
|
+
readonly example: 4;
|
|
1485
2464
|
};
|
|
1486
2465
|
readonly price: {
|
|
1487
|
-
readonly
|
|
1488
|
-
|
|
1489
|
-
|
|
1490
|
-
|
|
1491
|
-
readonly example: 4;
|
|
1492
|
-
}, {
|
|
1493
|
-
readonly type: "string";
|
|
1494
|
-
readonly enum: readonly [""];
|
|
1495
|
-
}];
|
|
1496
|
-
};
|
|
1497
|
-
readonly value: {
|
|
1498
|
-
readonly anyOf: readonly [{
|
|
1499
|
-
readonly type: "number";
|
|
1500
|
-
readonly format: "float";
|
|
1501
|
-
readonly description: "Value";
|
|
1502
|
-
readonly example: 4;
|
|
1503
|
-
}, {
|
|
1504
|
-
readonly type: "string";
|
|
1505
|
-
readonly enum: readonly [""];
|
|
1506
|
-
}];
|
|
2466
|
+
readonly type: "number";
|
|
2467
|
+
readonly format: "float";
|
|
2468
|
+
readonly description: "Price per unit";
|
|
2469
|
+
readonly example: 0.01;
|
|
1507
2470
|
};
|
|
1508
2471
|
readonly total: {
|
|
1509
|
-
readonly
|
|
1510
|
-
|
|
1511
|
-
|
|
1512
|
-
readonly description: "Total";
|
|
1513
|
-
readonly example: 4;
|
|
1514
|
-
}, {
|
|
1515
|
-
readonly type: "string";
|
|
1516
|
-
readonly enum: readonly [""];
|
|
1517
|
-
}];
|
|
2472
|
+
readonly type: "number";
|
|
2473
|
+
readonly format: "float";
|
|
2474
|
+
readonly description: "Total cost";
|
|
1518
2475
|
};
|
|
1519
2476
|
};
|
|
1520
|
-
readonly required: readonly ["
|
|
2477
|
+
readonly required: readonly ["hour", "cluster_id", "product", "value", "price", "total"];
|
|
1521
2478
|
readonly additionalProperties: false;
|
|
1522
2479
|
};
|
|
1523
2480
|
export declare const UserCreateInputSchema: {
|
|
@@ -1554,18 +2511,6 @@ export declare const UserCreateInputSchema: {
|
|
|
1554
2511
|
readonly minLength: 8;
|
|
1555
2512
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
1556
2513
|
};
|
|
1557
|
-
readonly status: {
|
|
1558
|
-
readonly type: "string";
|
|
1559
|
-
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
1560
|
-
readonly example: "active";
|
|
1561
|
-
readonly enum: readonly ["active", "inactive"];
|
|
1562
|
-
};
|
|
1563
|
-
readonly role: {
|
|
1564
|
-
readonly type: "string";
|
|
1565
|
-
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
1566
|
-
readonly example: "User";
|
|
1567
|
-
readonly enum: readonly ["Administrator", "User"];
|
|
1568
|
-
};
|
|
1569
2514
|
};
|
|
1570
2515
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
1571
2516
|
readonly additionalProperties: false;
|