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