@cloudfleet/sdk 0.0.1-76e2a56 → 0.0.1-7796b47
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -2
- package/dist/@tanstack/react-query.gen.d.ts +1199 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1215 -0
- package/dist/@tanstack/react-query.gen.js.map +1 -0
- package/dist/client/client.gen.d.ts +3 -0
- package/dist/client/client.gen.d.ts.map +1 -0
- package/dist/client/client.gen.js +217 -0
- package/dist/client/client.gen.js.map +1 -0
- package/dist/client/index.d.ts +9 -0
- package/dist/client/index.d.ts.map +1 -0
- package/dist/client/index.js +7 -0
- package/dist/client/index.js.map +1 -0
- package/dist/client/types.gen.d.ts +121 -0
- package/dist/client/types.gen.d.ts.map +1 -0
- package/dist/client/types.gen.js +3 -0
- package/dist/client/types.gen.js.map +1 -0
- package/dist/client/utils.gen.d.ts +38 -0
- package/dist/client/utils.gen.d.ts.map +1 -0
- package/dist/client/utils.gen.js +229 -0
- package/dist/client/utils.gen.js.map +1 -0
- package/dist/client.gen.d.ts +4 -4
- package/dist/client.gen.d.ts.map +1 -1
- package/dist/client.gen.js +2 -4
- package/dist/client.gen.js.map +1 -1
- package/dist/core/auth.gen.d.ts +19 -0
- package/dist/core/auth.gen.d.ts.map +1 -0
- package/dist/core/auth.gen.js +15 -0
- package/dist/core/auth.gen.js.map +1 -0
- package/dist/core/bodySerializer.gen.d.ts +26 -0
- package/dist/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/core/bodySerializer.gen.js +58 -0
- package/dist/core/bodySerializer.gen.js.map +1 -0
- package/dist/core/params.gen.d.ts +44 -0
- package/dist/core/params.gen.d.ts.map +1 -0
- package/dist/core/params.gen.js +101 -0
- package/dist/core/params.gen.js.map +1 -0
- package/dist/core/pathSerializer.gen.d.ts +34 -0
- package/dist/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/core/pathSerializer.gen.js +107 -0
- package/dist/core/pathSerializer.gen.js.map +1 -0
- package/dist/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/core/queryKeySerializer.gen.js +93 -0
- package/dist/core/queryKeySerializer.gen.js.map +1 -0
- package/dist/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/core/serverSentEvents.gen.js +133 -0
- package/dist/core/serverSentEvents.gen.js.map +1 -0
- package/dist/core/types.gen.d.ts +79 -0
- package/dist/core/types.gen.d.ts.map +1 -0
- package/dist/core/types.gen.js +3 -0
- package/dist/core/types.gen.js.map +1 -0
- package/dist/core/utils.gen.d.ts +20 -0
- package/dist/core/utils.gen.d.ts.map +1 -0
- package/dist/core/utils.gen.js +88 -0
- package/dist/core/utils.gen.js.map +1 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3 -0
- package/dist/index.js.map +1 -1
- package/dist/schemas.gen.d.ts +1794 -906
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +3141 -966
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +340 -202
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +471 -307
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +196 -0
- package/dist/services/kubernetes/api.d.ts.map +1 -0
- package/dist/services/kubernetes/api.js +140 -0
- package/dist/services/kubernetes/api.js.map +1 -0
- package/dist/services/kubernetes/index.d.ts +44 -0
- package/dist/services/kubernetes/index.d.ts.map +1 -0
- package/dist/services/kubernetes/index.js +68 -0
- package/dist/services/kubernetes/index.js.map +1 -0
- package/dist/services/kubernetes/types.d.ts +1335 -0
- package/dist/services/kubernetes/types.d.ts.map +1 -0
- package/dist/services/kubernetes/types.js +2 -0
- package/dist/services/kubernetes/types.js.map +1 -0
- package/dist/types.gen.d.ts +2027 -1168
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3982 -2497
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1712 -893
- package/dist/zod.gen.js.map +1 -1
- package/package.json +30 -7
package/dist/schemas.gen.d.ts
CHANGED
|
@@ -1,6 +1,49 @@
|
|
|
1
|
+
export declare const BasicPriceConsentInputSchema: {
|
|
2
|
+
readonly type: "object";
|
|
3
|
+
readonly properties: {
|
|
4
|
+
readonly decision: {
|
|
5
|
+
readonly type: "string";
|
|
6
|
+
readonly description: "The administrator's decision on the new Basic price. `accepted` continues to paid billing when the signup credit runs out; `rejected` opts out (clusters are suspended, never charged). A `rejected` org can later be flipped back to `accepted`.";
|
|
7
|
+
readonly example: "accepted";
|
|
8
|
+
readonly enum: readonly ["accepted", "rejected"];
|
|
9
|
+
};
|
|
10
|
+
};
|
|
11
|
+
readonly required: readonly ["decision"];
|
|
12
|
+
readonly additionalProperties: false;
|
|
13
|
+
};
|
|
14
|
+
export declare const BasicPriceConsentSchema: {
|
|
15
|
+
readonly type: "object";
|
|
16
|
+
readonly properties: {
|
|
17
|
+
readonly status: {
|
|
18
|
+
readonly type: "string";
|
|
19
|
+
readonly description: "Consent status for the new Basic price. `not_applicable` when the organization is not in scope for the migration. `pending` when the organization must opt in but no admin has decided yet. `accepted` / `rejected` reflect the recorded decision.";
|
|
20
|
+
readonly example: "pending";
|
|
21
|
+
readonly enum: readonly ["not_applicable", "pending", "accepted", "rejected"];
|
|
22
|
+
};
|
|
23
|
+
readonly decided_at: {
|
|
24
|
+
readonly type: "string";
|
|
25
|
+
readonly format: "date-time";
|
|
26
|
+
readonly description: "When the current decision was recorded. Absent while `not_applicable` or `pending`.";
|
|
27
|
+
readonly example: "2026-09-05T10:12:00.000Z";
|
|
28
|
+
};
|
|
29
|
+
readonly decided_by: {
|
|
30
|
+
readonly type: "string";
|
|
31
|
+
readonly description: "User id of the administrator who recorded the current decision. Absent while `not_applicable` or `pending`.";
|
|
32
|
+
readonly example: "2b7a5c9e-1f4d-4a1b-9c3e-8d2f6a0b1c2d";
|
|
33
|
+
};
|
|
34
|
+
};
|
|
35
|
+
readonly required: readonly ["status"];
|
|
36
|
+
readonly additionalProperties: false;
|
|
37
|
+
};
|
|
1
38
|
export declare const BillingContactSchema: {
|
|
2
39
|
readonly type: "object";
|
|
3
40
|
readonly properties: {
|
|
41
|
+
readonly type: {
|
|
42
|
+
readonly type: "string";
|
|
43
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
44
|
+
readonly example: "business";
|
|
45
|
+
readonly enum: readonly ["business", "personal"];
|
|
46
|
+
};
|
|
4
47
|
readonly company: {
|
|
5
48
|
readonly type: "string";
|
|
6
49
|
readonly maxLength: 120;
|
|
@@ -57,18 +100,202 @@ export declare const BillingContactSchema: {
|
|
|
57
100
|
readonly description: "Email address used for billing as a string.";
|
|
58
101
|
readonly example: "email@example.com";
|
|
59
102
|
};
|
|
60
|
-
readonly
|
|
103
|
+
readonly individual_name: {
|
|
61
104
|
readonly type: "string";
|
|
62
|
-
readonly description: "
|
|
63
|
-
readonly example: "John";
|
|
105
|
+
readonly description: "Name of the billing contact person.";
|
|
106
|
+
readonly example: "John Doe";
|
|
64
107
|
};
|
|
65
|
-
readonly
|
|
108
|
+
readonly tax_id: {
|
|
66
109
|
readonly type: "string";
|
|
67
|
-
readonly
|
|
68
|
-
readonly
|
|
110
|
+
readonly nullable: true;
|
|
111
|
+
readonly description: "Tax ID of the organization.";
|
|
112
|
+
readonly example: "DE123456789";
|
|
113
|
+
};
|
|
114
|
+
readonly tax_id_type: {
|
|
115
|
+
readonly type: "string";
|
|
116
|
+
readonly nullable: true;
|
|
117
|
+
readonly description: "Type of the tax ID.";
|
|
118
|
+
readonly example: "de_vat";
|
|
119
|
+
readonly enum: readonly ["ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "at_vat", "au_abn", "au_arn", "ba_tin", "bb_tin", "be_vat", "bg_uic", "bg_vat", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", "cy_vat", "cz_vat", "de_stn", "de_vat", "dk_vat", "do_rcn", "ec_ruc", "ee_vat", "eg_tin", "es_cif", "es_vat", "eu_oss_vat", "fi_vat", "fr_vat", "gb_vat", "ge_vat", "gn_nif", "gr_vat", "hk_br", "hr_oib", "hr_vat", "hu_tin", "hu_vat", "id_npwp", "ie_vat", "il_vat", "in_gst", "is_vat", "it_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kh_tin", "kr_brn", "kz_bin", "li_uid", "li_vat", "lt_vat", "lu_vat", "lv_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mt_vat", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "nl_vat", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "pl_vat", "pt_vat", "ro_tin", "ro_vat", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "se_vat", "sg_gst", "sg_uen", "si_tin", "si_vat", "sk_vat", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "xi_vat", "za_vat", "zm_tin", "zw_tin", ""];
|
|
120
|
+
};
|
|
121
|
+
};
|
|
122
|
+
readonly required: readonly ["type", "email", "individual_name"];
|
|
123
|
+
readonly additionalProperties: false;
|
|
124
|
+
};
|
|
125
|
+
export declare const BillingCreditsSchema: {
|
|
126
|
+
readonly type: "object";
|
|
127
|
+
readonly properties: {
|
|
128
|
+
readonly id: {
|
|
129
|
+
readonly type: "string";
|
|
130
|
+
readonly description: "Generated unique identifier of the promotional code.";
|
|
131
|
+
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
132
|
+
};
|
|
133
|
+
readonly type: {
|
|
134
|
+
readonly type: "string";
|
|
135
|
+
readonly description: "Type of the promotional code.";
|
|
136
|
+
readonly example: "credit";
|
|
137
|
+
readonly enum: readonly ["credit", "discount"];
|
|
138
|
+
};
|
|
139
|
+
readonly date_start: {
|
|
140
|
+
readonly type: "string";
|
|
141
|
+
readonly format: "date-time";
|
|
142
|
+
readonly description: "Timestamp when the credit becomes active. ISO 8601 date string in the UTC timezone.";
|
|
143
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
144
|
+
};
|
|
145
|
+
readonly date_end: {
|
|
146
|
+
readonly type: "string";
|
|
147
|
+
readonly format: "date-time";
|
|
148
|
+
readonly description: "Timestamp when the credit expires or becomes inactive. ISO 8601 date string in the UTC timezone.";
|
|
149
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
150
|
+
};
|
|
151
|
+
readonly code: {
|
|
152
|
+
readonly type: "string";
|
|
153
|
+
readonly description: "Promotional code used by the customer.";
|
|
154
|
+
readonly example: "VQ4SCMB";
|
|
155
|
+
};
|
|
156
|
+
readonly description: {
|
|
157
|
+
readonly type: "string";
|
|
158
|
+
readonly description: "Description of the promotional code.";
|
|
159
|
+
readonly example: "10% off on all products";
|
|
160
|
+
};
|
|
161
|
+
readonly value_total: {
|
|
162
|
+
readonly type: "number";
|
|
163
|
+
readonly format: "float";
|
|
164
|
+
readonly description: "Total value of the promotional code.";
|
|
165
|
+
readonly example: 10;
|
|
166
|
+
};
|
|
167
|
+
readonly value_remaining: {
|
|
168
|
+
readonly type: "number";
|
|
169
|
+
readonly format: "float";
|
|
170
|
+
readonly description: "Remaining value of the promotional code.";
|
|
171
|
+
readonly example: 8;
|
|
172
|
+
};
|
|
173
|
+
};
|
|
174
|
+
readonly required: readonly ["type", "date_start", "code", "value_total"];
|
|
175
|
+
readonly additionalProperties: false;
|
|
176
|
+
};
|
|
177
|
+
export declare const ChartCreateInputSchema: {
|
|
178
|
+
readonly type: "object";
|
|
179
|
+
readonly properties: {
|
|
180
|
+
readonly values: {
|
|
181
|
+
readonly type: "string";
|
|
182
|
+
readonly description: "Values to be used in the chart encoded as a JSON string.";
|
|
183
|
+
};
|
|
184
|
+
readonly version_channel: {
|
|
185
|
+
readonly type: "string";
|
|
186
|
+
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-]+)*))?$";
|
|
187
|
+
readonly description: "Desired version range or channel for the chart.";
|
|
188
|
+
readonly example: "2.x.x-cfke.x";
|
|
189
|
+
};
|
|
190
|
+
readonly name: {
|
|
191
|
+
readonly type: "string";
|
|
192
|
+
readonly maxLength: 63;
|
|
193
|
+
readonly minLength: 1;
|
|
194
|
+
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
195
|
+
readonly description: "Unique identifier of the chart deployment aka name of the helm release.";
|
|
196
|
+
readonly example: "postgresql-0";
|
|
197
|
+
};
|
|
198
|
+
readonly namespace: {
|
|
199
|
+
readonly type: "string";
|
|
200
|
+
readonly maxLength: 63;
|
|
201
|
+
readonly minLength: 1;
|
|
202
|
+
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
203
|
+
readonly description: "Namespace of the chart deployment";
|
|
204
|
+
readonly example: "default";
|
|
205
|
+
};
|
|
206
|
+
readonly chart: {
|
|
207
|
+
readonly type: "string";
|
|
208
|
+
readonly maxLength: 63;
|
|
209
|
+
readonly minLength: 1;
|
|
210
|
+
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
211
|
+
readonly description: "Name of the chart listing";
|
|
212
|
+
readonly example: "postgresql";
|
|
213
|
+
};
|
|
214
|
+
};
|
|
215
|
+
readonly required: readonly ["values", "version_channel", "name", "namespace", "chart"];
|
|
216
|
+
readonly additionalProperties: false;
|
|
217
|
+
};
|
|
218
|
+
export declare const ChartSchema: {
|
|
219
|
+
readonly type: "object";
|
|
220
|
+
readonly properties: {
|
|
221
|
+
readonly values: {
|
|
222
|
+
readonly type: "string";
|
|
223
|
+
readonly description: "Values to be used in the chart encoded as a JSON string.";
|
|
224
|
+
};
|
|
225
|
+
readonly version_channel: {
|
|
226
|
+
readonly type: "string";
|
|
227
|
+
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-]+)*))?$";
|
|
228
|
+
readonly description: "Desired version range or channel for the chart.";
|
|
229
|
+
readonly example: "2.x.x-cfke.x";
|
|
230
|
+
};
|
|
231
|
+
readonly name: {
|
|
232
|
+
readonly type: "string";
|
|
233
|
+
readonly maxLength: 63;
|
|
234
|
+
readonly minLength: 1;
|
|
235
|
+
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
236
|
+
readonly description: "Unique identifier of the chart deployment aka name of the helm release.";
|
|
237
|
+
readonly example: "postgresql-0";
|
|
238
|
+
};
|
|
239
|
+
readonly namespace: {
|
|
240
|
+
readonly type: "string";
|
|
241
|
+
readonly maxLength: 63;
|
|
242
|
+
readonly minLength: 1;
|
|
243
|
+
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
244
|
+
readonly description: "Namespace of the chart deployment";
|
|
245
|
+
readonly example: "default";
|
|
246
|
+
};
|
|
247
|
+
readonly chart: {
|
|
248
|
+
readonly type: "string";
|
|
249
|
+
readonly maxLength: 63;
|
|
250
|
+
readonly minLength: 1;
|
|
251
|
+
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
252
|
+
readonly description: "Name of the chart listing";
|
|
253
|
+
readonly example: "postgresql";
|
|
254
|
+
};
|
|
255
|
+
readonly status: {
|
|
256
|
+
readonly type: "string";
|
|
257
|
+
readonly description: "Status of the chart deployment (Flux HelmRelease Ready condition reason, e.g. InstallSucceeded, UpgradeFailed, Progressing).";
|
|
258
|
+
readonly example: "InstallSucceeded";
|
|
259
|
+
};
|
|
260
|
+
readonly version_current: {
|
|
261
|
+
readonly type: "string";
|
|
262
|
+
readonly description: "Current version of the chart deployment.";
|
|
263
|
+
readonly example: "2.1.33-cfke.11";
|
|
264
|
+
};
|
|
265
|
+
readonly created_at: {
|
|
266
|
+
readonly type: "string";
|
|
267
|
+
readonly description: "Creation date and time of the chart deployment.";
|
|
268
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
269
|
+
};
|
|
270
|
+
readonly updated_at: {
|
|
271
|
+
readonly type: "string";
|
|
272
|
+
readonly description: "Last update date and time of the chart deployment.";
|
|
273
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
274
|
+
};
|
|
275
|
+
readonly ready: {
|
|
276
|
+
readonly type: "boolean";
|
|
277
|
+
readonly description: "Indicates if the chart deployment is ready to be used.";
|
|
278
|
+
readonly example: true;
|
|
279
|
+
};
|
|
280
|
+
};
|
|
281
|
+
readonly required: readonly ["values", "version_channel", "name", "namespace", "chart", "status", "version_current", "created_at", "updated_at", "ready"];
|
|
282
|
+
readonly additionalProperties: false;
|
|
283
|
+
};
|
|
284
|
+
export declare const ChartUpdateInputSchema: {
|
|
285
|
+
readonly type: "object";
|
|
286
|
+
readonly properties: {
|
|
287
|
+
readonly values: {
|
|
288
|
+
readonly type: "string";
|
|
289
|
+
readonly description: "Values to be used in the chart encoded as a JSON string.";
|
|
290
|
+
};
|
|
291
|
+
readonly version_channel: {
|
|
292
|
+
readonly type: "string";
|
|
293
|
+
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-]+)*))?$";
|
|
294
|
+
readonly description: "Desired version range or channel for the chart.";
|
|
295
|
+
readonly example: "2.x.x-cfke.x";
|
|
69
296
|
};
|
|
70
297
|
};
|
|
71
|
-
readonly required: readonly ["
|
|
298
|
+
readonly required: readonly ["values", "version_channel"];
|
|
72
299
|
readonly additionalProperties: false;
|
|
73
300
|
};
|
|
74
301
|
export declare const ClusterCreateInputSchema: {
|
|
@@ -82,29 +309,106 @@ export declare const ClusterCreateInputSchema: {
|
|
|
82
309
|
readonly description: "Name of the cluster.";
|
|
83
310
|
readonly example: "production-cluster";
|
|
84
311
|
};
|
|
85
|
-
readonly region: {
|
|
86
|
-
readonly type: "string";
|
|
87
|
-
readonly description: "Cloudfleet control plane region. One of \"staging\", \"northamerica-central-1\". This field can not be updated after creation.";
|
|
88
|
-
readonly default: "staging";
|
|
89
|
-
readonly example: "northamerica-central-1";
|
|
90
|
-
readonly enum: readonly ["staging", "northamerica-central-1"];
|
|
91
|
-
};
|
|
92
312
|
readonly tier: {
|
|
93
313
|
readonly type: "string";
|
|
94
314
|
readonly description: "Tier of the cluster.";
|
|
315
|
+
readonly default: "basic";
|
|
95
316
|
readonly example: "pro";
|
|
96
|
-
readonly enum: readonly ["basic", "pro"];
|
|
317
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
97
318
|
};
|
|
98
319
|
readonly version_channel: {
|
|
99
320
|
readonly type: "string";
|
|
100
321
|
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
101
322
|
readonly description: "Version of the kubernetes cluster.";
|
|
102
323
|
readonly default: "1.x.x-cfke.x";
|
|
103
|
-
readonly example: "1.
|
|
324
|
+
readonly example: "1.x.x-cfke.x";
|
|
325
|
+
};
|
|
326
|
+
readonly release_channel: {
|
|
327
|
+
readonly type: "string";
|
|
328
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
329
|
+
readonly default: "rapid";
|
|
330
|
+
readonly example: "rapid";
|
|
331
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
332
|
+
};
|
|
333
|
+
readonly features: {
|
|
334
|
+
readonly type: "object";
|
|
335
|
+
readonly properties: {
|
|
336
|
+
readonly gpu_sharing_strategy: {
|
|
337
|
+
readonly type: "string";
|
|
338
|
+
readonly description: "GPU sharing strategy.";
|
|
339
|
+
readonly default: "none";
|
|
340
|
+
readonly example: "none";
|
|
341
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
342
|
+
};
|
|
343
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
344
|
+
readonly type: "integer";
|
|
345
|
+
readonly minimum: 2;
|
|
346
|
+
readonly maximum: 48;
|
|
347
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
348
|
+
readonly default: 4;
|
|
349
|
+
readonly example: 10;
|
|
350
|
+
};
|
|
351
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
352
|
+
readonly type: "boolean";
|
|
353
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
354
|
+
readonly example: false;
|
|
355
|
+
};
|
|
356
|
+
};
|
|
357
|
+
readonly additionalProperties: false;
|
|
358
|
+
readonly description: "Cluster feature toggles.";
|
|
359
|
+
readonly default: {
|
|
360
|
+
readonly gpu_sharing_strategy: "none";
|
|
361
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
362
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
363
|
+
};
|
|
364
|
+
};
|
|
365
|
+
readonly region: {
|
|
366
|
+
readonly type: "string";
|
|
367
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
368
|
+
readonly example: "europe-central-1a";
|
|
369
|
+
};
|
|
370
|
+
readonly networking: {
|
|
371
|
+
readonly type: "object";
|
|
372
|
+
readonly properties: {
|
|
373
|
+
readonly pod_cidr: {
|
|
374
|
+
readonly type: "string";
|
|
375
|
+
readonly description: "CIDR block for pod IPs.";
|
|
376
|
+
readonly default: "10.244.0.0/16";
|
|
377
|
+
};
|
|
378
|
+
readonly service_cidr: {
|
|
379
|
+
readonly type: "string";
|
|
380
|
+
readonly description: "CIDR block for service IPs.";
|
|
381
|
+
readonly default: "10.96.0.0/12";
|
|
382
|
+
};
|
|
383
|
+
readonly dual_stack: {
|
|
384
|
+
readonly type: "boolean";
|
|
385
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
386
|
+
};
|
|
387
|
+
readonly pod_cidr_v6: {
|
|
388
|
+
readonly type: "string";
|
|
389
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
390
|
+
readonly default: "2001:db8:1:2::/48";
|
|
391
|
+
};
|
|
392
|
+
readonly service_cidr_v6: {
|
|
393
|
+
readonly type: "string";
|
|
394
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
395
|
+
readonly default: "2001:db8:1:1::/112";
|
|
396
|
+
};
|
|
397
|
+
};
|
|
398
|
+
readonly additionalProperties: false;
|
|
399
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
400
|
+
readonly default: {
|
|
401
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
402
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
403
|
+
readonly dual_stack: false;
|
|
404
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
405
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
406
|
+
};
|
|
104
407
|
};
|
|
105
408
|
};
|
|
106
|
-
readonly required: readonly ["name", "
|
|
409
|
+
readonly required: readonly ["name", "region"];
|
|
107
410
|
readonly additionalProperties: false;
|
|
411
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
108
412
|
};
|
|
109
413
|
export declare const ClusterJoinInformationSchema: {
|
|
110
414
|
readonly type: "object";
|
|
@@ -120,6 +424,16 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
120
424
|
readonly description: "Internal URL of the Kubernetes cluster control plane. This is the endpoint that kubelet uses to connect to the cluster.";
|
|
121
425
|
readonly example: "https://10.31.64.7:6443";
|
|
122
426
|
};
|
|
427
|
+
readonly cluster_dns: {
|
|
428
|
+
readonly type: "string";
|
|
429
|
+
readonly description: "Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.";
|
|
430
|
+
readonly example: "10.96.0.10";
|
|
431
|
+
};
|
|
432
|
+
readonly pod_cidr: {
|
|
433
|
+
readonly type: "string";
|
|
434
|
+
readonly description: "Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.";
|
|
435
|
+
readonly example: "10.244.0.0/16";
|
|
436
|
+
};
|
|
123
437
|
readonly auth_key: {
|
|
124
438
|
readonly type: "string";
|
|
125
439
|
readonly description: "Authentication key for the cluster.";
|
|
@@ -136,7 +450,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
136
450
|
readonly kubernetes: {
|
|
137
451
|
readonly type: "string";
|
|
138
452
|
readonly description: "Kubernetes version of the cluster.";
|
|
139
|
-
readonly example: "1.
|
|
453
|
+
readonly example: "1.33.7";
|
|
140
454
|
};
|
|
141
455
|
readonly tailscale: {
|
|
142
456
|
readonly type: "string";
|
|
@@ -148,8 +462,13 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
148
462
|
readonly description: "Containerd version of the cluster.";
|
|
149
463
|
readonly example: "1.7.19";
|
|
150
464
|
};
|
|
465
|
+
readonly nvidia_driver: {
|
|
466
|
+
readonly type: "string";
|
|
467
|
+
readonly description: "NVIDIA driver version of the cluster.";
|
|
468
|
+
readonly example: "565.0.0";
|
|
469
|
+
};
|
|
151
470
|
};
|
|
152
|
-
readonly required: readonly ["kubernetes", "tailscale", "containerd"];
|
|
471
|
+
readonly required: readonly ["kubernetes", "tailscale", "containerd", "nvidia_driver"];
|
|
153
472
|
readonly additionalProperties: false;
|
|
154
473
|
readonly description: "Versions of the different components of the cluster.";
|
|
155
474
|
};
|
|
@@ -177,7 +496,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
177
496
|
readonly description: "OIDC Information for hosts to access to third party API's.";
|
|
178
497
|
};
|
|
179
498
|
};
|
|
180
|
-
readonly required: readonly ["certificate_authority", "endpoint", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
499
|
+
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "pod_cidr", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
181
500
|
readonly additionalProperties: false;
|
|
182
501
|
};
|
|
183
502
|
export declare const ClusterSchema: {
|
|
@@ -191,25 +510,103 @@ export declare const ClusterSchema: {
|
|
|
191
510
|
readonly description: "Name of the cluster.";
|
|
192
511
|
readonly example: "production-cluster";
|
|
193
512
|
};
|
|
194
|
-
readonly region: {
|
|
195
|
-
readonly type: "string";
|
|
196
|
-
readonly description: "Cloudfleet control plane region. One of \"staging\", \"northamerica-central-1\". This field can not be updated after creation.";
|
|
197
|
-
readonly default: "staging";
|
|
198
|
-
readonly example: "northamerica-central-1";
|
|
199
|
-
readonly enum: readonly ["staging", "northamerica-central-1"];
|
|
200
|
-
};
|
|
201
513
|
readonly tier: {
|
|
202
514
|
readonly type: "string";
|
|
203
515
|
readonly description: "Tier of the cluster.";
|
|
516
|
+
readonly default: "basic";
|
|
204
517
|
readonly example: "pro";
|
|
205
|
-
readonly enum: readonly ["basic", "pro"];
|
|
518
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
206
519
|
};
|
|
207
520
|
readonly version_channel: {
|
|
208
521
|
readonly type: "string";
|
|
209
522
|
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
210
523
|
readonly description: "Version of the kubernetes cluster.";
|
|
211
524
|
readonly default: "1.x.x-cfke.x";
|
|
212
|
-
readonly example: "1.
|
|
525
|
+
readonly example: "1.x.x-cfke.x";
|
|
526
|
+
};
|
|
527
|
+
readonly release_channel: {
|
|
528
|
+
readonly type: "string";
|
|
529
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
530
|
+
readonly default: "rapid";
|
|
531
|
+
readonly example: "rapid";
|
|
532
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
533
|
+
};
|
|
534
|
+
readonly features: {
|
|
535
|
+
readonly type: "object";
|
|
536
|
+
readonly properties: {
|
|
537
|
+
readonly gpu_sharing_strategy: {
|
|
538
|
+
readonly type: "string";
|
|
539
|
+
readonly description: "GPU sharing strategy.";
|
|
540
|
+
readonly default: "none";
|
|
541
|
+
readonly example: "none";
|
|
542
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
543
|
+
};
|
|
544
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
545
|
+
readonly type: "integer";
|
|
546
|
+
readonly minimum: 2;
|
|
547
|
+
readonly maximum: 48;
|
|
548
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
549
|
+
readonly default: 4;
|
|
550
|
+
readonly example: 10;
|
|
551
|
+
};
|
|
552
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
553
|
+
readonly type: "boolean";
|
|
554
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
555
|
+
readonly example: false;
|
|
556
|
+
};
|
|
557
|
+
};
|
|
558
|
+
readonly required: readonly ["gpu_sharing_strategy", "gpu_max_shared_clients_per_gpu", "cilium_socket_lb_host_namespace_only"];
|
|
559
|
+
readonly additionalProperties: false;
|
|
560
|
+
readonly description: "Cluster feature toggles.";
|
|
561
|
+
readonly default: {
|
|
562
|
+
readonly gpu_sharing_strategy: "none";
|
|
563
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
564
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
565
|
+
};
|
|
566
|
+
};
|
|
567
|
+
readonly region: {
|
|
568
|
+
readonly type: "string";
|
|
569
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
570
|
+
readonly example: "europe-central-1a";
|
|
571
|
+
};
|
|
572
|
+
readonly networking: {
|
|
573
|
+
readonly type: "object";
|
|
574
|
+
readonly properties: {
|
|
575
|
+
readonly pod_cidr: {
|
|
576
|
+
readonly type: "string";
|
|
577
|
+
readonly description: "CIDR block for pod IPs.";
|
|
578
|
+
readonly default: "10.244.0.0/16";
|
|
579
|
+
};
|
|
580
|
+
readonly service_cidr: {
|
|
581
|
+
readonly type: "string";
|
|
582
|
+
readonly description: "CIDR block for service IPs.";
|
|
583
|
+
readonly default: "10.96.0.0/12";
|
|
584
|
+
};
|
|
585
|
+
readonly dual_stack: {
|
|
586
|
+
readonly type: "boolean";
|
|
587
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
588
|
+
};
|
|
589
|
+
readonly pod_cidr_v6: {
|
|
590
|
+
readonly type: "string";
|
|
591
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
592
|
+
readonly default: "2001:db8:1:2::/48";
|
|
593
|
+
};
|
|
594
|
+
readonly service_cidr_v6: {
|
|
595
|
+
readonly type: "string";
|
|
596
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
597
|
+
readonly default: "2001:db8:1:1::/112";
|
|
598
|
+
};
|
|
599
|
+
};
|
|
600
|
+
readonly required: readonly ["pod_cidr", "service_cidr", "dual_stack", "pod_cidr_v6", "service_cidr_v6"];
|
|
601
|
+
readonly additionalProperties: false;
|
|
602
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
603
|
+
readonly default: {
|
|
604
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
605
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
606
|
+
readonly dual_stack: false;
|
|
607
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
608
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
609
|
+
};
|
|
213
610
|
};
|
|
214
611
|
readonly id: {
|
|
215
612
|
readonly type: "string";
|
|
@@ -219,16 +616,27 @@ export declare const ClusterSchema: {
|
|
|
219
616
|
};
|
|
220
617
|
readonly status: {
|
|
221
618
|
readonly type: "string";
|
|
222
|
-
readonly description: "Status of the cluster.
|
|
223
|
-
readonly example: "
|
|
224
|
-
readonly enum: readonly ["
|
|
619
|
+
readonly description: "Status of the cluster.";
|
|
620
|
+
readonly example: "deployed";
|
|
621
|
+
readonly enum: readonly ["creating", "deployed", "updating", "disabled"];
|
|
225
622
|
};
|
|
226
623
|
readonly endpoint: {
|
|
227
624
|
readonly anyOf: readonly [{
|
|
228
625
|
readonly type: "string";
|
|
229
626
|
readonly format: "uri";
|
|
230
|
-
readonly description: "URL of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
231
|
-
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
627
|
+
readonly description: "URL signed by a public CA of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
628
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
629
|
+
}, {
|
|
630
|
+
readonly type: "string";
|
|
631
|
+
readonly enum: readonly [""];
|
|
632
|
+
}];
|
|
633
|
+
};
|
|
634
|
+
readonly endpoint_public: {
|
|
635
|
+
readonly anyOf: readonly [{
|
|
636
|
+
readonly type: "string";
|
|
637
|
+
readonly format: "uri";
|
|
638
|
+
readonly description: "Deprecated alias of `endpoint`; retained for backward compatibility.";
|
|
639
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
232
640
|
}, {
|
|
233
641
|
readonly type: "string";
|
|
234
642
|
readonly enum: readonly [""];
|
|
@@ -242,7 +650,7 @@ export declare const ClusterSchema: {
|
|
|
242
650
|
readonly version_current: {
|
|
243
651
|
readonly type: "string";
|
|
244
652
|
readonly description: "Current version of the cluster.";
|
|
245
|
-
readonly example: "1.
|
|
653
|
+
readonly example: "1.33.7-cfke.264";
|
|
246
654
|
};
|
|
247
655
|
readonly created_at: {
|
|
248
656
|
readonly type: "string";
|
|
@@ -260,8 +668,9 @@ export declare const ClusterSchema: {
|
|
|
260
668
|
readonly example: true;
|
|
261
669
|
};
|
|
262
670
|
};
|
|
263
|
-
readonly required: readonly ["name", "tier", "id", "status"];
|
|
671
|
+
readonly required: readonly ["name", "tier", "version_channel", "release_channel", "features", "region", "networking", "id", "status", "ready"];
|
|
264
672
|
readonly additionalProperties: false;
|
|
673
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
265
674
|
};
|
|
266
675
|
export declare const ClusterUpdateInputSchema: {
|
|
267
676
|
readonly type: "object";
|
|
@@ -274,14 +683,63 @@ export declare const ClusterUpdateInputSchema: {
|
|
|
274
683
|
readonly description: "Name of the cluster.";
|
|
275
684
|
readonly example: "production-cluster";
|
|
276
685
|
};
|
|
686
|
+
readonly tier: {
|
|
687
|
+
readonly type: "string";
|
|
688
|
+
readonly description: "Tier of the cluster.";
|
|
689
|
+
readonly default: "basic";
|
|
690
|
+
readonly example: "pro";
|
|
691
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
692
|
+
};
|
|
277
693
|
readonly version_channel: {
|
|
278
694
|
readonly type: "string";
|
|
279
695
|
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
280
696
|
readonly description: "Version of the kubernetes cluster.";
|
|
281
|
-
readonly
|
|
697
|
+
readonly default: "1.x.x-cfke.x";
|
|
698
|
+
readonly example: "1.x.x-cfke.x";
|
|
699
|
+
};
|
|
700
|
+
readonly release_channel: {
|
|
701
|
+
readonly type: "string";
|
|
702
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
703
|
+
readonly default: "rapid";
|
|
704
|
+
readonly example: "rapid";
|
|
705
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
706
|
+
};
|
|
707
|
+
readonly features: {
|
|
708
|
+
readonly type: "object";
|
|
709
|
+
readonly properties: {
|
|
710
|
+
readonly gpu_sharing_strategy: {
|
|
711
|
+
readonly type: "string";
|
|
712
|
+
readonly description: "GPU sharing strategy.";
|
|
713
|
+
readonly default: "none";
|
|
714
|
+
readonly example: "none";
|
|
715
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
716
|
+
};
|
|
717
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
718
|
+
readonly type: "integer";
|
|
719
|
+
readonly minimum: 2;
|
|
720
|
+
readonly maximum: 48;
|
|
721
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
722
|
+
readonly default: 4;
|
|
723
|
+
readonly example: 10;
|
|
724
|
+
};
|
|
725
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
726
|
+
readonly type: "boolean";
|
|
727
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
728
|
+
readonly example: false;
|
|
729
|
+
};
|
|
730
|
+
};
|
|
731
|
+
readonly additionalProperties: false;
|
|
732
|
+
readonly description: "Cluster feature toggles.";
|
|
733
|
+
readonly default: {
|
|
734
|
+
readonly gpu_sharing_strategy: "none";
|
|
735
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
736
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
737
|
+
};
|
|
282
738
|
};
|
|
283
739
|
};
|
|
740
|
+
readonly required: readonly ["name"];
|
|
284
741
|
readonly additionalProperties: false;
|
|
742
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
285
743
|
};
|
|
286
744
|
export declare const FleetCreateInputSchema: {
|
|
287
745
|
readonly type: "object";
|
|
@@ -290,13 +748,12 @@ export declare const FleetCreateInputSchema: {
|
|
|
290
748
|
readonly type: "object";
|
|
291
749
|
readonly properties: {
|
|
292
750
|
readonly cpu: {
|
|
293
|
-
readonly type: "
|
|
294
|
-
readonly format: "float";
|
|
751
|
+
readonly type: "integer";
|
|
295
752
|
readonly minimum: 0;
|
|
296
|
-
readonly
|
|
753
|
+
readonly maximum: 100000;
|
|
754
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
297
755
|
};
|
|
298
756
|
};
|
|
299
|
-
readonly required: readonly ["cpu"];
|
|
300
757
|
readonly additionalProperties: false;
|
|
301
758
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
302
759
|
};
|
|
@@ -305,57 +762,107 @@ export declare const FleetCreateInputSchema: {
|
|
|
305
762
|
readonly properties: {
|
|
306
763
|
readonly enabled: {
|
|
307
764
|
readonly type: "boolean";
|
|
308
|
-
readonly default: true;
|
|
309
765
|
};
|
|
310
766
|
readonly project: {
|
|
311
767
|
readonly type: "string";
|
|
312
|
-
readonly
|
|
768
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
769
|
+
readonly description: "GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.";
|
|
770
|
+
readonly example: "my-cloudfleet-project";
|
|
313
771
|
};
|
|
314
772
|
};
|
|
315
|
-
readonly required: readonly ["
|
|
773
|
+
readonly required: readonly ["enabled"];
|
|
316
774
|
readonly additionalProperties: false;
|
|
317
775
|
};
|
|
318
776
|
readonly hetzner: {
|
|
319
|
-
readonly
|
|
320
|
-
|
|
321
|
-
readonly
|
|
322
|
-
readonly
|
|
323
|
-
readonly type: "boolean";
|
|
324
|
-
readonly default: true;
|
|
325
|
-
};
|
|
326
|
-
readonly apiKey: {
|
|
327
|
-
readonly type: "string";
|
|
328
|
-
};
|
|
777
|
+
readonly type: "object";
|
|
778
|
+
readonly properties: {
|
|
779
|
+
readonly enabled: {
|
|
780
|
+
readonly type: "boolean";
|
|
329
781
|
};
|
|
330
|
-
readonly
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
readonly
|
|
335
|
-
|
|
336
|
-
};
|
|
337
|
-
readonly enabled: {
|
|
338
|
-
readonly type: "boolean";
|
|
339
|
-
readonly default: true;
|
|
340
|
-
};
|
|
782
|
+
readonly apiKey: {
|
|
783
|
+
readonly type: "string";
|
|
784
|
+
readonly maxLength: 64;
|
|
785
|
+
readonly minLength: 64;
|
|
786
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
787
|
+
readonly description: "Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.";
|
|
341
788
|
};
|
|
342
|
-
|
|
343
|
-
|
|
789
|
+
};
|
|
790
|
+
readonly required: readonly ["enabled"];
|
|
791
|
+
readonly additionalProperties: false;
|
|
344
792
|
};
|
|
345
793
|
readonly aws: {
|
|
346
794
|
readonly type: "object";
|
|
347
795
|
readonly properties: {
|
|
348
796
|
readonly enabled: {
|
|
349
797
|
readonly type: "boolean";
|
|
350
|
-
readonly default: true;
|
|
351
798
|
};
|
|
352
799
|
readonly controllerRoleArn: {
|
|
353
800
|
readonly type: "string";
|
|
354
|
-
readonly
|
|
801
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
802
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
803
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
804
|
+
};
|
|
805
|
+
};
|
|
806
|
+
readonly required: readonly ["enabled"];
|
|
807
|
+
readonly additionalProperties: false;
|
|
808
|
+
};
|
|
809
|
+
readonly constraints: {
|
|
810
|
+
readonly type: "object";
|
|
811
|
+
readonly properties: {
|
|
812
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
813
|
+
readonly type: "array";
|
|
814
|
+
readonly items: {
|
|
815
|
+
readonly type: "string";
|
|
816
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
817
|
+
};
|
|
818
|
+
readonly minItems: 1;
|
|
819
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
820
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
821
|
+
};
|
|
822
|
+
readonly 'kubernetes.io/arch': {
|
|
823
|
+
readonly type: "array";
|
|
824
|
+
readonly items: {
|
|
825
|
+
readonly type: "string";
|
|
826
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
827
|
+
};
|
|
828
|
+
readonly minItems: 1;
|
|
829
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
830
|
+
readonly default: readonly ["amd64"];
|
|
831
|
+
};
|
|
832
|
+
readonly 'cfke.io/instance-family': {
|
|
833
|
+
readonly type: "array";
|
|
834
|
+
readonly items: {
|
|
835
|
+
readonly type: "string";
|
|
836
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
837
|
+
};
|
|
838
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
839
|
+
readonly default: readonly [];
|
|
840
|
+
};
|
|
841
|
+
readonly 'topology.kubernetes.io/region': {
|
|
842
|
+
readonly type: "array";
|
|
843
|
+
readonly items: {
|
|
844
|
+
readonly type: "string";
|
|
845
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
846
|
+
};
|
|
847
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
848
|
+
readonly default: readonly [];
|
|
355
849
|
};
|
|
356
850
|
};
|
|
357
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
358
851
|
readonly additionalProperties: false;
|
|
852
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
853
|
+
readonly default: {
|
|
854
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
855
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
856
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
857
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
858
|
+
};
|
|
859
|
+
};
|
|
860
|
+
readonly scalingProfile: {
|
|
861
|
+
readonly type: "string";
|
|
862
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
863
|
+
readonly default: "conservative";
|
|
864
|
+
readonly example: "conservative";
|
|
865
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
359
866
|
};
|
|
360
867
|
readonly id: {
|
|
361
868
|
readonly type: "string";
|
|
@@ -365,14 +872,10 @@ export declare const FleetCreateInputSchema: {
|
|
|
365
872
|
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
366
873
|
readonly example: "new-clouds-fleet";
|
|
367
874
|
};
|
|
368
|
-
readonly type: {
|
|
369
|
-
readonly type: "string";
|
|
370
|
-
readonly description: "Specifies the fleet type: infrastructure managed by Cloudfleet or Connected Fleets.";
|
|
371
|
-
readonly enum: readonly ["managed", "connected"];
|
|
372
|
-
};
|
|
373
875
|
};
|
|
374
|
-
readonly required: readonly ["id"
|
|
876
|
+
readonly required: readonly ["id"];
|
|
375
877
|
readonly additionalProperties: false;
|
|
878
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
376
879
|
};
|
|
377
880
|
export declare const FleetSchema: {
|
|
378
881
|
readonly type: "object";
|
|
@@ -381,13 +884,12 @@ export declare const FleetSchema: {
|
|
|
381
884
|
readonly type: "object";
|
|
382
885
|
readonly properties: {
|
|
383
886
|
readonly cpu: {
|
|
384
|
-
readonly type: "
|
|
385
|
-
readonly format: "float";
|
|
887
|
+
readonly type: "integer";
|
|
386
888
|
readonly minimum: 0;
|
|
387
|
-
readonly
|
|
889
|
+
readonly maximum: 100000;
|
|
890
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
388
891
|
};
|
|
389
892
|
};
|
|
390
|
-
readonly required: readonly ["cpu"];
|
|
391
893
|
readonly additionalProperties: false;
|
|
392
894
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
393
895
|
};
|
|
@@ -396,57 +898,106 @@ export declare const FleetSchema: {
|
|
|
396
898
|
readonly properties: {
|
|
397
899
|
readonly enabled: {
|
|
398
900
|
readonly type: "boolean";
|
|
399
|
-
readonly default: true;
|
|
400
901
|
};
|
|
401
902
|
readonly project: {
|
|
402
903
|
readonly type: "string";
|
|
403
|
-
readonly
|
|
904
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
905
|
+
readonly description: "GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.";
|
|
906
|
+
readonly example: "my-cloudfleet-project";
|
|
404
907
|
};
|
|
405
908
|
};
|
|
406
|
-
readonly required: readonly ["
|
|
909
|
+
readonly required: readonly ["enabled"];
|
|
407
910
|
readonly additionalProperties: false;
|
|
408
911
|
};
|
|
409
912
|
readonly hetzner: {
|
|
410
|
-
readonly
|
|
411
|
-
|
|
412
|
-
readonly
|
|
413
|
-
readonly
|
|
414
|
-
readonly type: "boolean";
|
|
415
|
-
readonly default: true;
|
|
416
|
-
};
|
|
417
|
-
readonly apiKey: {
|
|
418
|
-
readonly type: "string";
|
|
419
|
-
};
|
|
913
|
+
readonly type: "object";
|
|
914
|
+
readonly properties: {
|
|
915
|
+
readonly enabled: {
|
|
916
|
+
readonly type: "boolean";
|
|
420
917
|
};
|
|
421
|
-
readonly
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
readonly apiKey: {
|
|
426
|
-
readonly type: "string";
|
|
427
|
-
};
|
|
428
|
-
readonly enabled: {
|
|
429
|
-
readonly type: "boolean";
|
|
430
|
-
readonly default: true;
|
|
431
|
-
};
|
|
918
|
+
readonly apiKey: {
|
|
919
|
+
readonly type: "string";
|
|
920
|
+
readonly pattern: "^\\*{64}$";
|
|
921
|
+
readonly description: "Redacted Hetzner API token. Returned as 64 asterisks when a token is configured; omitted otherwise. The real value is never echoed by the API.";
|
|
432
922
|
};
|
|
433
|
-
|
|
434
|
-
|
|
923
|
+
};
|
|
924
|
+
readonly required: readonly ["enabled"];
|
|
925
|
+
readonly additionalProperties: false;
|
|
435
926
|
};
|
|
436
927
|
readonly aws: {
|
|
437
928
|
readonly type: "object";
|
|
438
929
|
readonly properties: {
|
|
439
930
|
readonly enabled: {
|
|
440
931
|
readonly type: "boolean";
|
|
441
|
-
readonly default: true;
|
|
442
932
|
};
|
|
443
933
|
readonly controllerRoleArn: {
|
|
444
934
|
readonly type: "string";
|
|
445
|
-
readonly
|
|
935
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
936
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
937
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
938
|
+
};
|
|
939
|
+
};
|
|
940
|
+
readonly required: readonly ["enabled"];
|
|
941
|
+
readonly additionalProperties: false;
|
|
942
|
+
};
|
|
943
|
+
readonly constraints: {
|
|
944
|
+
readonly type: "object";
|
|
945
|
+
readonly properties: {
|
|
946
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
947
|
+
readonly type: "array";
|
|
948
|
+
readonly items: {
|
|
949
|
+
readonly type: "string";
|
|
950
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
951
|
+
};
|
|
952
|
+
readonly minItems: 1;
|
|
953
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
954
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
955
|
+
};
|
|
956
|
+
readonly 'kubernetes.io/arch': {
|
|
957
|
+
readonly type: "array";
|
|
958
|
+
readonly items: {
|
|
959
|
+
readonly type: "string";
|
|
960
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
961
|
+
};
|
|
962
|
+
readonly minItems: 1;
|
|
963
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
964
|
+
readonly default: readonly ["amd64"];
|
|
965
|
+
};
|
|
966
|
+
readonly 'cfke.io/instance-family': {
|
|
967
|
+
readonly type: "array";
|
|
968
|
+
readonly items: {
|
|
969
|
+
readonly type: "string";
|
|
970
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
971
|
+
};
|
|
972
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
973
|
+
readonly default: readonly [];
|
|
974
|
+
};
|
|
975
|
+
readonly 'topology.kubernetes.io/region': {
|
|
976
|
+
readonly type: "array";
|
|
977
|
+
readonly items: {
|
|
978
|
+
readonly type: "string";
|
|
979
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
980
|
+
};
|
|
981
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
982
|
+
readonly default: readonly [];
|
|
446
983
|
};
|
|
447
984
|
};
|
|
448
|
-
readonly required: readonly ["
|
|
985
|
+
readonly required: readonly ["karpenter.sh/capacity-type", "kubernetes.io/arch"];
|
|
449
986
|
readonly additionalProperties: false;
|
|
987
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
988
|
+
readonly default: {
|
|
989
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
990
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
991
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
992
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
993
|
+
};
|
|
994
|
+
};
|
|
995
|
+
readonly scalingProfile: {
|
|
996
|
+
readonly type: "string";
|
|
997
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
998
|
+
readonly default: "conservative";
|
|
999
|
+
readonly example: "conservative";
|
|
1000
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
450
1001
|
};
|
|
451
1002
|
readonly id: {
|
|
452
1003
|
readonly type: "string";
|
|
@@ -456,14 +1007,30 @@ export declare const FleetSchema: {
|
|
|
456
1007
|
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
457
1008
|
readonly example: "new-clouds-fleet";
|
|
458
1009
|
};
|
|
459
|
-
readonly
|
|
1010
|
+
readonly ready: {
|
|
1011
|
+
readonly type: "boolean";
|
|
1012
|
+
readonly description: "Indicates whether the fleet configuration is healthy.";
|
|
1013
|
+
readonly example: true;
|
|
1014
|
+
};
|
|
1015
|
+
readonly status_message: {
|
|
1016
|
+
readonly type: "string";
|
|
1017
|
+
readonly description: "Human-readable reason the fleet is not ready. Present only when `ready` is false.";
|
|
1018
|
+
readonly example: "Invalid provider permissions.";
|
|
1019
|
+
};
|
|
1020
|
+
readonly created_at: {
|
|
1021
|
+
readonly type: "string";
|
|
1022
|
+
readonly description: "Creation date and time of the fleet.";
|
|
1023
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
1024
|
+
};
|
|
1025
|
+
readonly updated_at: {
|
|
460
1026
|
readonly type: "string";
|
|
461
|
-
readonly description: "
|
|
462
|
-
readonly
|
|
1027
|
+
readonly description: "Date and time the fleet was last updated.";
|
|
1028
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
463
1029
|
};
|
|
464
1030
|
};
|
|
465
|
-
readonly required: readonly ["id", "
|
|
1031
|
+
readonly required: readonly ["constraints", "scalingProfile", "id", "ready", "created_at", "updated_at"];
|
|
466
1032
|
readonly additionalProperties: false;
|
|
1033
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
467
1034
|
};
|
|
468
1035
|
export declare const FleetUpdateInputSchema: {
|
|
469
1036
|
readonly type: "object";
|
|
@@ -472,13 +1039,12 @@ export declare const FleetUpdateInputSchema: {
|
|
|
472
1039
|
readonly type: "object";
|
|
473
1040
|
readonly properties: {
|
|
474
1041
|
readonly cpu: {
|
|
475
|
-
readonly type: "
|
|
476
|
-
readonly format: "float";
|
|
1042
|
+
readonly type: "integer";
|
|
477
1043
|
readonly minimum: 0;
|
|
478
|
-
readonly
|
|
1044
|
+
readonly maximum: 100000;
|
|
1045
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
479
1046
|
};
|
|
480
1047
|
};
|
|
481
|
-
readonly required: readonly ["cpu"];
|
|
482
1048
|
readonly additionalProperties: false;
|
|
483
1049
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
484
1050
|
};
|
|
@@ -487,910 +1053,1212 @@ export declare const FleetUpdateInputSchema: {
|
|
|
487
1053
|
readonly properties: {
|
|
488
1054
|
readonly enabled: {
|
|
489
1055
|
readonly type: "boolean";
|
|
490
|
-
readonly default: true;
|
|
491
1056
|
};
|
|
492
1057
|
readonly project: {
|
|
493
1058
|
readonly type: "string";
|
|
494
|
-
readonly
|
|
1059
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
1060
|
+
readonly description: "GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.";
|
|
1061
|
+
readonly example: "my-cloudfleet-project";
|
|
495
1062
|
};
|
|
496
1063
|
};
|
|
497
|
-
readonly required: readonly ["
|
|
1064
|
+
readonly required: readonly ["enabled"];
|
|
498
1065
|
readonly additionalProperties: false;
|
|
499
1066
|
};
|
|
500
1067
|
readonly hetzner: {
|
|
501
|
-
readonly
|
|
502
|
-
|
|
503
|
-
readonly
|
|
504
|
-
readonly
|
|
505
|
-
readonly type: "boolean";
|
|
506
|
-
readonly default: true;
|
|
507
|
-
};
|
|
508
|
-
readonly apiKey: {
|
|
509
|
-
readonly type: "string";
|
|
510
|
-
};
|
|
1068
|
+
readonly type: "object";
|
|
1069
|
+
readonly properties: {
|
|
1070
|
+
readonly enabled: {
|
|
1071
|
+
readonly type: "boolean";
|
|
511
1072
|
};
|
|
512
|
-
readonly
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
readonly
|
|
517
|
-
|
|
518
|
-
};
|
|
519
|
-
readonly enabled: {
|
|
520
|
-
readonly type: "boolean";
|
|
521
|
-
readonly default: true;
|
|
522
|
-
};
|
|
1073
|
+
readonly apiKey: {
|
|
1074
|
+
readonly type: "string";
|
|
1075
|
+
readonly maxLength: 64;
|
|
1076
|
+
readonly minLength: 64;
|
|
1077
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
1078
|
+
readonly description: "Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.";
|
|
523
1079
|
};
|
|
524
|
-
|
|
525
|
-
|
|
1080
|
+
};
|
|
1081
|
+
readonly required: readonly ["enabled"];
|
|
1082
|
+
readonly additionalProperties: false;
|
|
526
1083
|
};
|
|
527
1084
|
readonly aws: {
|
|
528
1085
|
readonly type: "object";
|
|
529
1086
|
readonly properties: {
|
|
530
1087
|
readonly enabled: {
|
|
531
1088
|
readonly type: "boolean";
|
|
532
|
-
readonly default: true;
|
|
533
1089
|
};
|
|
534
1090
|
readonly controllerRoleArn: {
|
|
535
1091
|
readonly type: "string";
|
|
536
|
-
readonly
|
|
1092
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
1093
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
1094
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
1095
|
+
};
|
|
1096
|
+
};
|
|
1097
|
+
readonly required: readonly ["enabled"];
|
|
1098
|
+
readonly additionalProperties: false;
|
|
1099
|
+
};
|
|
1100
|
+
readonly constraints: {
|
|
1101
|
+
readonly type: "object";
|
|
1102
|
+
readonly properties: {
|
|
1103
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
1104
|
+
readonly type: "array";
|
|
1105
|
+
readonly items: {
|
|
1106
|
+
readonly type: "string";
|
|
1107
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
1108
|
+
};
|
|
1109
|
+
readonly minItems: 1;
|
|
1110
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
1111
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
1112
|
+
};
|
|
1113
|
+
readonly 'kubernetes.io/arch': {
|
|
1114
|
+
readonly type: "array";
|
|
1115
|
+
readonly items: {
|
|
1116
|
+
readonly type: "string";
|
|
1117
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
1118
|
+
};
|
|
1119
|
+
readonly minItems: 1;
|
|
1120
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
1121
|
+
readonly default: readonly ["amd64"];
|
|
1122
|
+
};
|
|
1123
|
+
readonly 'cfke.io/instance-family': {
|
|
1124
|
+
readonly type: "array";
|
|
1125
|
+
readonly items: {
|
|
1126
|
+
readonly type: "string";
|
|
1127
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
1128
|
+
};
|
|
1129
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
1130
|
+
readonly default: readonly [];
|
|
1131
|
+
};
|
|
1132
|
+
readonly 'topology.kubernetes.io/region': {
|
|
1133
|
+
readonly type: "array";
|
|
1134
|
+
readonly items: {
|
|
1135
|
+
readonly type: "string";
|
|
1136
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
1137
|
+
};
|
|
1138
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
1139
|
+
readonly default: readonly [];
|
|
537
1140
|
};
|
|
538
1141
|
};
|
|
539
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
540
1142
|
readonly additionalProperties: false;
|
|
1143
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
1144
|
+
readonly default: {
|
|
1145
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
1146
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
1147
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
1148
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
1149
|
+
};
|
|
1150
|
+
};
|
|
1151
|
+
readonly scalingProfile: {
|
|
1152
|
+
readonly type: "string";
|
|
1153
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
1154
|
+
readonly default: "conservative";
|
|
1155
|
+
readonly example: "conservative";
|
|
1156
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
541
1157
|
};
|
|
542
1158
|
};
|
|
543
1159
|
readonly additionalProperties: false;
|
|
1160
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
544
1161
|
};
|
|
545
|
-
export declare const
|
|
1162
|
+
export declare const InviteCreateInputSchema: {
|
|
546
1163
|
readonly type: "object";
|
|
547
1164
|
readonly properties: {
|
|
548
|
-
readonly
|
|
549
|
-
readonly type: "
|
|
550
|
-
readonly
|
|
551
|
-
readonly
|
|
552
|
-
readonly example:
|
|
553
|
-
readonly enum: readonly [1];
|
|
554
|
-
};
|
|
555
|
-
readonly provider: {
|
|
556
|
-
readonly type: "array";
|
|
557
|
-
readonly items: {
|
|
558
|
-
readonly type: "string";
|
|
559
|
-
};
|
|
560
|
-
readonly description: "Limit selection of cloud providers to this list. For the full list of supported providers, see [Providers](https://cloudfleet.ai/docs/cloud-infrastructure/providers/)";
|
|
561
|
-
readonly example: "AWS";
|
|
1165
|
+
readonly email: {
|
|
1166
|
+
readonly type: "string";
|
|
1167
|
+
readonly format: "email";
|
|
1168
|
+
readonly description: "Email address of the user to invite.";
|
|
1169
|
+
readonly example: "email@example.com";
|
|
562
1170
|
};
|
|
563
|
-
readonly
|
|
564
|
-
readonly type: "
|
|
565
|
-
readonly
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
readonly
|
|
569
|
-
readonly example: "northamerica";
|
|
1171
|
+
readonly role: {
|
|
1172
|
+
readonly type: "string";
|
|
1173
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1174
|
+
readonly default: "User";
|
|
1175
|
+
readonly example: "User";
|
|
1176
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
570
1177
|
};
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
1178
|
+
};
|
|
1179
|
+
readonly required: readonly ["email"];
|
|
1180
|
+
readonly additionalProperties: false;
|
|
1181
|
+
};
|
|
1182
|
+
export declare const InviteSchema: {
|
|
1183
|
+
readonly type: "object";
|
|
1184
|
+
readonly properties: {
|
|
1185
|
+
readonly id: {
|
|
1186
|
+
readonly type: "string";
|
|
1187
|
+
readonly description: "Unique identifier of the invitation.";
|
|
1188
|
+
readonly example: "65831dd20d20165489cbb868";
|
|
578
1189
|
};
|
|
579
|
-
readonly
|
|
580
|
-
readonly type: "
|
|
581
|
-
readonly
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
readonly description: "Limits selection of cloud regions to this list of canonical provider regions";
|
|
585
|
-
readonly example: "eu-west-1";
|
|
1190
|
+
readonly organization_id: {
|
|
1191
|
+
readonly type: "string";
|
|
1192
|
+
readonly format: "uuid";
|
|
1193
|
+
readonly description: "Unique identifier of the organization the project belongs to. UUID v4 string in canonical form";
|
|
1194
|
+
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
586
1195
|
};
|
|
587
|
-
readonly
|
|
588
|
-
readonly type: "
|
|
589
|
-
readonly
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
readonly description: "Limits selection of instance types to this list. Instance / VM type as defined by the cloud service provider";
|
|
593
|
-
readonly example: "p4d.24xlarge";
|
|
1196
|
+
readonly date_created: {
|
|
1197
|
+
readonly type: "string";
|
|
1198
|
+
readonly format: "date-time";
|
|
1199
|
+
readonly description: "Creation date of the project. ISO 8601 date string in UTC timezone";
|
|
1200
|
+
readonly example: "2023-11-02T16:08:14.338Z";
|
|
594
1201
|
};
|
|
595
|
-
readonly
|
|
596
|
-
readonly type: "
|
|
597
|
-
readonly
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
readonly description: "List of Normalized accelerator model names. For example, all variations of Nvidia A100 GPUs will have 'A100' as accelerator name with various memory configurations set in accelerator_memory field";
|
|
601
|
-
readonly example: "A100";
|
|
1202
|
+
readonly email: {
|
|
1203
|
+
readonly type: "string";
|
|
1204
|
+
readonly format: "email";
|
|
1205
|
+
readonly description: "User email address.";
|
|
1206
|
+
readonly example: "email@example.com";
|
|
602
1207
|
};
|
|
603
|
-
readonly
|
|
604
|
-
readonly type: "
|
|
605
|
-
readonly
|
|
606
|
-
|
|
607
|
-
};
|
|
608
|
-
readonly description: "List of normalized accelerator manufacturer names. For example, all Nvidia GPUs will have 'NVIDIA' as accelerator manufacturer";
|
|
609
|
-
readonly example: "NVIDIA";
|
|
1208
|
+
readonly code: {
|
|
1209
|
+
readonly type: "string";
|
|
1210
|
+
readonly description: "Generated unique invite code.";
|
|
1211
|
+
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
610
1212
|
};
|
|
611
|
-
readonly
|
|
612
|
-
readonly type: "
|
|
613
|
-
readonly
|
|
614
|
-
readonly
|
|
615
|
-
readonly example:
|
|
1213
|
+
readonly role: {
|
|
1214
|
+
readonly type: "string";
|
|
1215
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1216
|
+
readonly default: "User";
|
|
1217
|
+
readonly example: "User";
|
|
1218
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
616
1219
|
};
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
readonly
|
|
626
|
-
readonly description: "
|
|
627
|
-
readonly example:
|
|
628
|
-
};
|
|
629
|
-
readonly accelerator_memory_max: {
|
|
630
|
-
readonly type: "number";
|
|
631
|
-
readonly format: "float";
|
|
632
|
-
readonly description: "Maximum amount of accelerator memory available to each accelerator. For example, Nvidia A100 GPUs will typically have '40.0' gibibytes (GiB) of memory, while A100 GPUs with HBM2E memory will have '80.0' gibibytes (GiB) of memory";
|
|
633
|
-
readonly example: 80;
|
|
634
|
-
};
|
|
635
|
-
readonly memory_min: {
|
|
636
|
-
readonly type: "integer";
|
|
637
|
-
readonly minimum: 0;
|
|
638
|
-
readonly description: "Minimum amount of RAM in gibibytes (GiB)";
|
|
639
|
-
readonly example: 32;
|
|
640
|
-
};
|
|
641
|
-
readonly memory_max: {
|
|
642
|
-
readonly type: "integer";
|
|
643
|
-
readonly minimum: 0;
|
|
644
|
-
readonly description: "Maximum amount of RAM in gibibytes (GiB)";
|
|
645
|
-
readonly example: 64;
|
|
1220
|
+
};
|
|
1221
|
+
readonly required: readonly ["date_created"];
|
|
1222
|
+
readonly additionalProperties: false;
|
|
1223
|
+
};
|
|
1224
|
+
export declare const InvoiceSchema: {
|
|
1225
|
+
readonly type: "object";
|
|
1226
|
+
readonly properties: {
|
|
1227
|
+
readonly id: {
|
|
1228
|
+
readonly type: "string";
|
|
1229
|
+
readonly description: "Unique identifier of the invoice.";
|
|
1230
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
646
1231
|
};
|
|
647
|
-
readonly
|
|
648
|
-
readonly type: "
|
|
649
|
-
readonly minimum: 1;
|
|
650
|
-
readonly description: "Minimum number of vCPUs as defined by the cloud service provider. Some cloud providers use hyperthreading, so the number of vCPUs may be twice as high as the number of physical cores.";
|
|
651
|
-
readonly example: 32;
|
|
1232
|
+
readonly number: {
|
|
1233
|
+
readonly type: "string";
|
|
652
1234
|
};
|
|
653
|
-
readonly
|
|
654
|
-
readonly type: "
|
|
655
|
-
readonly
|
|
656
|
-
readonly
|
|
657
|
-
readonly example: 128;
|
|
1235
|
+
readonly status: {
|
|
1236
|
+
readonly type: "string";
|
|
1237
|
+
readonly description: "Status of the invoice";
|
|
1238
|
+
readonly example: "paid";
|
|
658
1239
|
};
|
|
659
|
-
readonly
|
|
1240
|
+
readonly total: {
|
|
660
1241
|
readonly type: "number";
|
|
661
1242
|
readonly format: "float";
|
|
662
|
-
readonly
|
|
663
|
-
readonly
|
|
664
|
-
readonly example: 128;
|
|
1243
|
+
readonly description: "Total amount of the invoice";
|
|
1244
|
+
readonly example: 100;
|
|
665
1245
|
};
|
|
666
|
-
readonly
|
|
667
|
-
readonly type: "
|
|
668
|
-
readonly
|
|
669
|
-
readonly
|
|
670
|
-
readonly description: "Maximum total storage in GiB (attached and local)";
|
|
671
|
-
readonly example: 256;
|
|
1246
|
+
readonly currency: {
|
|
1247
|
+
readonly type: "string";
|
|
1248
|
+
readonly description: "Currency of the invoice";
|
|
1249
|
+
readonly example: "usd";
|
|
672
1250
|
};
|
|
673
|
-
readonly
|
|
674
|
-
readonly type: "
|
|
675
|
-
readonly format: "
|
|
676
|
-
readonly description: "
|
|
677
|
-
readonly example:
|
|
1251
|
+
readonly created: {
|
|
1252
|
+
readonly type: "string";
|
|
1253
|
+
readonly format: "date-time";
|
|
1254
|
+
readonly description: "Timestamp when the invoice was issued. ISO 8601 date string in the UTC timezone.";
|
|
1255
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
678
1256
|
};
|
|
679
|
-
readonly
|
|
680
|
-
readonly type: "
|
|
681
|
-
readonly format: "
|
|
682
|
-
readonly description: "
|
|
683
|
-
readonly example:
|
|
1257
|
+
readonly period_start: {
|
|
1258
|
+
readonly type: "string";
|
|
1259
|
+
readonly format: "date-time";
|
|
1260
|
+
readonly description: "Billing period start timestamp. ISO 8601 date string in the UTC timezone.";
|
|
1261
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
684
1262
|
};
|
|
685
|
-
readonly
|
|
686
|
-
readonly type: "
|
|
687
|
-
readonly format: "
|
|
688
|
-
readonly description: "
|
|
689
|
-
readonly example:
|
|
1263
|
+
readonly period_end: {
|
|
1264
|
+
readonly type: "string";
|
|
1265
|
+
readonly format: "date-time";
|
|
1266
|
+
readonly description: "Billing period end timestamp. ISO 8601 date string in the UTC timezone.";
|
|
1267
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
690
1268
|
};
|
|
691
|
-
readonly
|
|
692
|
-
readonly type: "
|
|
693
|
-
readonly format: "float";
|
|
694
|
-
readonly description: "Maximum price of running the inctance per hour in USD as defined by the cloud service provider. The cheapest instance will be selected.";
|
|
695
|
-
readonly example: 50;
|
|
1269
|
+
readonly invoice_pdf: {
|
|
1270
|
+
readonly type: "string";
|
|
696
1271
|
};
|
|
697
1272
|
};
|
|
1273
|
+
readonly required: readonly ["created", "period_start", "period_end"];
|
|
698
1274
|
readonly additionalProperties: false;
|
|
699
1275
|
};
|
|
700
|
-
export declare const
|
|
1276
|
+
export declare const MarketplaceListingFilesSchema: {
|
|
701
1277
|
readonly type: "object";
|
|
702
1278
|
readonly properties: {
|
|
703
|
-
readonly
|
|
1279
|
+
readonly chartYaml: {
|
|
704
1280
|
readonly type: "string";
|
|
705
|
-
readonly description: "
|
|
706
|
-
readonly example: "
|
|
1281
|
+
readonly description: "Raw Chart.yaml content from the Helm chart";
|
|
1282
|
+
readonly example: "apiVersion: v2\nname: nginx-ingress\nversion: 1.18.2-cfke.45\nappVersion: 1.9.4";
|
|
707
1283
|
};
|
|
708
|
-
readonly
|
|
1284
|
+
readonly valuesYaml: {
|
|
709
1285
|
readonly type: "string";
|
|
710
|
-
readonly description: "
|
|
711
|
-
readonly example: "
|
|
1286
|
+
readonly description: "Raw values.yaml content from the Helm chart";
|
|
1287
|
+
readonly example: "replicaCount: 1\nimage:\n repository: nginx\n tag: latest";
|
|
712
1288
|
};
|
|
713
|
-
readonly
|
|
1289
|
+
readonly valuesSchemaJson: {
|
|
714
1290
|
readonly type: "string";
|
|
715
|
-
readonly description: "
|
|
716
|
-
readonly example: "
|
|
1291
|
+
readonly description: "JSON schema for values.yaml as a string";
|
|
1292
|
+
readonly example: "{\"type\":\"object\",\"properties\":{\"replicaCount\":{\"type\":\"number\"}}}";
|
|
717
1293
|
};
|
|
718
|
-
|
|
1294
|
+
};
|
|
1295
|
+
readonly additionalProperties: false;
|
|
1296
|
+
};
|
|
1297
|
+
export declare const MarketplaceListingSchema: {
|
|
1298
|
+
readonly type: "object";
|
|
1299
|
+
readonly properties: {
|
|
1300
|
+
readonly name: {
|
|
719
1301
|
readonly type: "string";
|
|
720
|
-
readonly description: "
|
|
721
|
-
readonly example: "
|
|
1302
|
+
readonly description: "Name of the chart";
|
|
1303
|
+
readonly example: "nginx-ingress";
|
|
722
1304
|
};
|
|
723
|
-
readonly
|
|
724
|
-
readonly type: "
|
|
725
|
-
readonly
|
|
726
|
-
|
|
1305
|
+
readonly versions: {
|
|
1306
|
+
readonly type: "array";
|
|
1307
|
+
readonly items: {
|
|
1308
|
+
readonly type: "string";
|
|
1309
|
+
readonly pattern: "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
1310
|
+
readonly description: "Specific version of the chart";
|
|
1311
|
+
readonly example: "1.18.2-cfke.45";
|
|
1312
|
+
};
|
|
1313
|
+
readonly description: "Available versions of the chart";
|
|
727
1314
|
};
|
|
728
|
-
readonly
|
|
729
|
-
readonly type: "
|
|
730
|
-
readonly
|
|
731
|
-
|
|
1315
|
+
readonly version_channels: {
|
|
1316
|
+
readonly type: "array";
|
|
1317
|
+
readonly items: {
|
|
1318
|
+
readonly type: "string";
|
|
1319
|
+
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
1320
|
+
readonly description: "Version channel pattern";
|
|
1321
|
+
readonly example: "1.18.x-cfke.x";
|
|
1322
|
+
};
|
|
1323
|
+
readonly description: "Version channels for the chart";
|
|
732
1324
|
};
|
|
733
|
-
readonly
|
|
1325
|
+
readonly latestVersion: {
|
|
734
1326
|
readonly type: "string";
|
|
735
|
-
readonly description: "
|
|
736
|
-
readonly example: "
|
|
1327
|
+
readonly description: "Latest version of the chart";
|
|
1328
|
+
readonly example: "1.18.2-cfke.45";
|
|
737
1329
|
};
|
|
738
|
-
readonly
|
|
739
|
-
readonly type: "
|
|
740
|
-
readonly
|
|
741
|
-
|
|
1330
|
+
readonly metadata: {
|
|
1331
|
+
readonly type: "object";
|
|
1332
|
+
readonly properties: {
|
|
1333
|
+
readonly name: {
|
|
1334
|
+
readonly type: "string";
|
|
1335
|
+
readonly description: "Chart name from metadata";
|
|
1336
|
+
readonly example: "nginx-ingress";
|
|
1337
|
+
};
|
|
1338
|
+
readonly version: {
|
|
1339
|
+
readonly type: "string";
|
|
1340
|
+
readonly description: "Chart version from metadata";
|
|
1341
|
+
readonly example: "1.18.2-cfke.45";
|
|
1342
|
+
};
|
|
1343
|
+
readonly description: {
|
|
1344
|
+
readonly type: "string";
|
|
1345
|
+
readonly description: "Chart description";
|
|
1346
|
+
readonly example: "NGINX Ingress Controller for Kubernetes";
|
|
1347
|
+
};
|
|
1348
|
+
readonly appVersion: {
|
|
1349
|
+
readonly type: "string";
|
|
1350
|
+
readonly description: "Application version";
|
|
1351
|
+
readonly example: "1.9.4";
|
|
1352
|
+
};
|
|
1353
|
+
readonly apiVersion: {
|
|
1354
|
+
readonly type: "string";
|
|
1355
|
+
readonly description: "Helm API version";
|
|
1356
|
+
readonly example: "v2";
|
|
1357
|
+
};
|
|
1358
|
+
readonly keywords: {
|
|
1359
|
+
readonly type: "array";
|
|
1360
|
+
readonly items: {
|
|
1361
|
+
readonly type: "string";
|
|
1362
|
+
};
|
|
1363
|
+
readonly description: "Chart keywords";
|
|
1364
|
+
readonly example: readonly ["ingress", "nginx", "load-balancer"];
|
|
1365
|
+
};
|
|
1366
|
+
readonly home: {
|
|
1367
|
+
readonly type: "string";
|
|
1368
|
+
readonly description: "Chart home URL";
|
|
1369
|
+
readonly example: "https://kubernetes.github.io/ingress-nginx/";
|
|
1370
|
+
};
|
|
1371
|
+
readonly icon: {
|
|
1372
|
+
readonly type: "string";
|
|
1373
|
+
readonly description: "A URL to an SVG or PNG image to be used as an icon";
|
|
1374
|
+
readonly example: "https://cloudfleet.ai/images/marketplace/icons/ingress-nginx.png";
|
|
1375
|
+
};
|
|
1376
|
+
readonly sources: {
|
|
1377
|
+
readonly type: "array";
|
|
1378
|
+
readonly items: {
|
|
1379
|
+
readonly type: "string";
|
|
1380
|
+
};
|
|
1381
|
+
readonly description: "Chart source URLs";
|
|
1382
|
+
readonly example: readonly ["https://github.com/kubernetes/ingress-nginx"];
|
|
1383
|
+
};
|
|
1384
|
+
readonly maintainers: {
|
|
1385
|
+
readonly type: "array";
|
|
1386
|
+
readonly items: {
|
|
1387
|
+
readonly type: "object";
|
|
1388
|
+
readonly properties: {
|
|
1389
|
+
readonly name: {
|
|
1390
|
+
readonly type: "string";
|
|
1391
|
+
readonly description: "Maintainer name";
|
|
1392
|
+
readonly example: "NGINX Team";
|
|
1393
|
+
};
|
|
1394
|
+
readonly email: {
|
|
1395
|
+
readonly type: "string";
|
|
1396
|
+
readonly description: "Maintainer email";
|
|
1397
|
+
readonly example: "support@nginx.org";
|
|
1398
|
+
};
|
|
1399
|
+
};
|
|
1400
|
+
readonly required: readonly ["name"];
|
|
1401
|
+
readonly additionalProperties: false;
|
|
1402
|
+
};
|
|
1403
|
+
readonly description: "Chart maintainers";
|
|
1404
|
+
};
|
|
1405
|
+
};
|
|
1406
|
+
readonly required: readonly ["name", "version"];
|
|
1407
|
+
readonly additionalProperties: false;
|
|
1408
|
+
readonly description: "Chart metadata";
|
|
742
1409
|
};
|
|
743
|
-
|
|
1410
|
+
};
|
|
1411
|
+
readonly required: readonly ["name", "versions", "version_channels", "latestVersion"];
|
|
1412
|
+
readonly additionalProperties: false;
|
|
1413
|
+
};
|
|
1414
|
+
export declare const OrganizationCreateInputSchema: {
|
|
1415
|
+
readonly type: "object";
|
|
1416
|
+
readonly properties: {
|
|
1417
|
+
readonly type: {
|
|
744
1418
|
readonly type: "string";
|
|
745
|
-
readonly description: "
|
|
746
|
-
readonly example: "
|
|
1419
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1420
|
+
readonly example: "business";
|
|
1421
|
+
readonly enum: readonly ["business", "personal"];
|
|
747
1422
|
};
|
|
748
|
-
readonly
|
|
749
|
-
readonly type: "number";
|
|
750
|
-
readonly format: "float";
|
|
751
|
-
readonly minimum: 1;
|
|
752
|
-
readonly description: "CPU count as defined by the cloud service provider. Some cloud providers use hyperthreading, so the number of vCPUs may be twice as high as the number of physical cores.";
|
|
753
|
-
readonly example: 96;
|
|
754
|
-
};
|
|
755
|
-
readonly memory: {
|
|
756
|
-
readonly type: "number";
|
|
757
|
-
readonly format: "float";
|
|
758
|
-
readonly minimum: 1;
|
|
759
|
-
readonly description: "Total amount of RAM in gibibytes (GiB)";
|
|
760
|
-
readonly example: 1152;
|
|
761
|
-
};
|
|
762
|
-
readonly local_storage: {
|
|
763
|
-
readonly type: "number";
|
|
764
|
-
readonly format: "float";
|
|
765
|
-
readonly description: "Volume of directly attached, block-device local storage in gibibytes (GiB)";
|
|
766
|
-
readonly example: 8000;
|
|
767
|
-
};
|
|
768
|
-
readonly accelerator_name: {
|
|
1423
|
+
readonly email: {
|
|
769
1424
|
readonly type: "string";
|
|
770
|
-
readonly
|
|
771
|
-
readonly
|
|
1425
|
+
readonly format: "email";
|
|
1426
|
+
readonly description: "Email address used for billing as a string.";
|
|
1427
|
+
readonly example: "email@example.com";
|
|
772
1428
|
};
|
|
773
|
-
readonly
|
|
1429
|
+
readonly first_name: {
|
|
774
1430
|
readonly type: "string";
|
|
775
|
-
readonly
|
|
776
|
-
readonly
|
|
777
|
-
|
|
778
|
-
readonly accelerator_count: {
|
|
779
|
-
readonly type: "integer";
|
|
780
|
-
readonly description: "Number of accelerators available on the instance. Some cloud providers support shared accelerators, so the number of accelerators may be a fraction of the number of physical accelerators.";
|
|
781
|
-
readonly example: 8;
|
|
782
|
-
};
|
|
783
|
-
readonly accelerator_memory: {
|
|
784
|
-
readonly type: "number";
|
|
785
|
-
readonly format: "float";
|
|
786
|
-
readonly description: "Ammount of accelerator memory available to each accelerator. For example, Nvidia A100 GPUs will typically have '40.0' gibibytes (GiB) of memory, while A100 GPUs with HBM2E memory will have '80.0' gibibytes (GiB) of memory";
|
|
787
|
-
readonly example: 40;
|
|
788
|
-
};
|
|
789
|
-
readonly pods_capacity: {
|
|
790
|
-
readonly type: "number";
|
|
791
|
-
readonly format: "float";
|
|
792
|
-
readonly description: "Maximum number of pods that can be run on this instance type.";
|
|
793
|
-
readonly example: 110;
|
|
1431
|
+
readonly minLength: 1;
|
|
1432
|
+
readonly description: "First name of the billing contact person.";
|
|
1433
|
+
readonly example: "John";
|
|
794
1434
|
};
|
|
795
|
-
readonly
|
|
1435
|
+
readonly last_name: {
|
|
796
1436
|
readonly type: "string";
|
|
797
|
-
readonly
|
|
798
|
-
readonly
|
|
1437
|
+
readonly minLength: 1;
|
|
1438
|
+
readonly description: "Last name of the billing contact person.";
|
|
1439
|
+
readonly example: "Doe";
|
|
799
1440
|
};
|
|
800
|
-
readonly
|
|
801
|
-
readonly type: "
|
|
802
|
-
readonly
|
|
803
|
-
readonly
|
|
804
|
-
readonly
|
|
1441
|
+
readonly company_name: {
|
|
1442
|
+
readonly type: "string";
|
|
1443
|
+
readonly maxLength: 120;
|
|
1444
|
+
readonly minLength: 2;
|
|
1445
|
+
readonly pattern: "^(?!\\s)(?!.*\\s$)(?=.*[a-zA-ZÆÐƎƏƐƔIJŊŒẞÞǷȜæðǝəɛɣijŋœĸſßþƿȝĄƁÇĐƊĘĦĮƘŁØƠŞȘŢȚŦŲƯY̨Ƴąɓçđɗęħįƙłøơşșţțŧųưy̨ƴÁÀÂÄǍĂĀÃÅǺĄÆǼǢƁĆĊĈČÇĎḌĐƊÐÉÈĖÊËĚĔĒĘẸƎƏƐĠĜǦĞĢƔáàâäǎăāãåǻąæǽǣɓćċĉčçďḍđɗðéèėêëěĕēęẹǝəɛġĝǧğģɣĤḤĦIÍÌİÎÏǏĬĪĨĮỊIJĴĶƘĹĻŁĽĿʼNŃN̈ŇÑŅŊÓÒÔÖǑŎŌÕŐỌØǾƠŒĥḥħıíìiîïǐĭīĩįịijĵķƙĸĺļłľŀʼnńn̈ňñņŋóòôöǒŏōõőọøǿơœŔŘŖŚŜŠŞȘṢẞŤŢṬŦÞÚÙÛÜǓŬŪŨŰŮŲỤƯẂẀŴẄǷÝỲŶŸȲỸƳŹŻŽẒŕřŗſśŝšşșṣßťţṭŧþúùûüǔŭūũűůųụưẃẁŵẅƿýỳŷÿȳỹƴźżžẓ0-9])[a-zA-ZÆÐƎƏƐƔIJŊŒẞÞǷȜæðǝəɛɣijŋœĸſßþƿȝĄƁÇĐƊĘĦĮƘŁØƠŞȘŢȚŦŲƯY̨Ƴąɓçđɗęħįƙłøơşșţțŧųưy̨ƴÁÀÂÄǍĂĀÃÅǺĄÆǼǢƁĆĊĈČÇĎḌĐƊÐÉÈĖÊËĚĔĒĘẸƎƏƐĠĜǦĞĢƔáàâäǎăāãåǻąæǽǣɓćċĉčçďḍđɗðéèėêëěĕēęẹǝəɛġĝǧğģɣĤḤĦIÍÌİÎÏǏĬĪĨĮỊIJĴĶƘĹĻŁĽĿʼNŃN̈ŇÑŅŊÓÒÔÖǑŎŌÕŐỌØǾƠŒĥḥħıíìiîïǐĭīĩįịijĵķƙĸĺļłľŀʼnńn̈ňñņŋóòôöǒŏōõőọøǿơœŔŘŖŚŜŠŞȘṢẞŤŢṬŦÞÚÙÛÜǓŬŪŨŰŮŲỤƯẂẀŴẄǷÝỲŶŸȲỸƳŹŻŽẒŕřŗſśŝšşșṣßťţṭŧþúùûüǔŭūũűůųụưẃẁŵẅƿýỳŷÿȳỹƴźżžẓ0-9 -.]{2,}$";
|
|
1446
|
+
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
1447
|
+
readonly example: "ACME Corp.";
|
|
805
1448
|
};
|
|
806
|
-
readonly
|
|
807
|
-
readonly type: "
|
|
808
|
-
readonly
|
|
809
|
-
readonly
|
|
1449
|
+
readonly password: {
|
|
1450
|
+
readonly type: "string";
|
|
1451
|
+
readonly minLength: 8;
|
|
1452
|
+
readonly description: "Password for the root account. Must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one number and one special character.";
|
|
810
1453
|
};
|
|
811
1454
|
};
|
|
812
|
-
readonly required: readonly ["
|
|
1455
|
+
readonly required: readonly ["type", "email", "first_name", "last_name", "company_name", "password"];
|
|
813
1456
|
readonly additionalProperties: false;
|
|
814
1457
|
};
|
|
815
|
-
export declare const
|
|
1458
|
+
export declare const OrganizationCreateOutputSchema: {
|
|
816
1459
|
readonly type: "object";
|
|
817
1460
|
readonly properties: {
|
|
818
1461
|
readonly id: {
|
|
819
1462
|
readonly type: "string";
|
|
820
|
-
readonly description: "Unique identifier of the
|
|
821
|
-
readonly example: "
|
|
1463
|
+
readonly description: "Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.";
|
|
1464
|
+
readonly example: "organization-id";
|
|
822
1465
|
};
|
|
823
|
-
|
|
1466
|
+
};
|
|
1467
|
+
readonly required: readonly ["id"];
|
|
1468
|
+
readonly additionalProperties: false;
|
|
1469
|
+
};
|
|
1470
|
+
export declare const OrganizationSchema: {
|
|
1471
|
+
readonly type: "object";
|
|
1472
|
+
readonly properties: {
|
|
1473
|
+
readonly id: {
|
|
824
1474
|
readonly type: "string";
|
|
825
1475
|
readonly format: "uuid";
|
|
826
|
-
readonly description: "Unique identifier of the organization
|
|
1476
|
+
readonly description: "Unique identifier of the organization. UUID v4 string in canonical form";
|
|
827
1477
|
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
828
1478
|
};
|
|
1479
|
+
readonly name: {
|
|
1480
|
+
readonly type: "string";
|
|
1481
|
+
readonly maxLength: 120;
|
|
1482
|
+
readonly minLength: 2;
|
|
1483
|
+
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
1484
|
+
readonly example: "ACME Corp.";
|
|
1485
|
+
};
|
|
1486
|
+
readonly type: {
|
|
1487
|
+
readonly type: "string";
|
|
1488
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1489
|
+
readonly example: "business";
|
|
1490
|
+
readonly enum: readonly ["business", "personal"];
|
|
1491
|
+
};
|
|
829
1492
|
readonly date_created: {
|
|
830
1493
|
readonly type: "string";
|
|
831
1494
|
readonly format: "date-time";
|
|
832
|
-
readonly description: "Creation date of the
|
|
1495
|
+
readonly description: "Creation date of the organization. ISO 8601 date string in UTC timezone";
|
|
833
1496
|
readonly example: "2023-11-02T16:08:14.338Z";
|
|
834
1497
|
};
|
|
835
|
-
readonly
|
|
1498
|
+
readonly quota: {
|
|
1499
|
+
readonly type: "object";
|
|
1500
|
+
readonly properties: {
|
|
1501
|
+
readonly basic_clusters_max: {
|
|
1502
|
+
readonly type: "integer";
|
|
1503
|
+
readonly minimum: 0;
|
|
1504
|
+
readonly description: "Maximum number of Basic clusters that can be created.";
|
|
1505
|
+
readonly example: 999;
|
|
1506
|
+
};
|
|
1507
|
+
readonly basic_clusters_available: {
|
|
1508
|
+
readonly type: "integer";
|
|
1509
|
+
readonly description: "Available number of Basic clusters that can be created.";
|
|
1510
|
+
readonly example: 999;
|
|
1511
|
+
};
|
|
1512
|
+
readonly pro_clusters_max: {
|
|
1513
|
+
readonly type: "integer";
|
|
1514
|
+
readonly minimum: 0;
|
|
1515
|
+
readonly description: "Maximum number of Pro clusters that can be created.";
|
|
1516
|
+
readonly example: 999;
|
|
1517
|
+
};
|
|
1518
|
+
readonly pro_clusters_available: {
|
|
1519
|
+
readonly type: "integer";
|
|
1520
|
+
readonly description: "Available number of Pro clusters that can be created.";
|
|
1521
|
+
readonly example: 999;
|
|
1522
|
+
};
|
|
1523
|
+
readonly enterprise_clusters_max: {
|
|
1524
|
+
readonly type: "integer";
|
|
1525
|
+
readonly minimum: 0;
|
|
1526
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1527
|
+
readonly example: 999;
|
|
1528
|
+
};
|
|
1529
|
+
readonly enterprise_clusters_available: {
|
|
1530
|
+
readonly type: "integer";
|
|
1531
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1532
|
+
readonly example: 999;
|
|
1533
|
+
};
|
|
1534
|
+
readonly fleets_max: {
|
|
1535
|
+
readonly type: "integer";
|
|
1536
|
+
readonly minimum: 0;
|
|
1537
|
+
readonly description: "Maximum number of fleets that can be created per cluster.";
|
|
1538
|
+
readonly example: 999;
|
|
1539
|
+
};
|
|
1540
|
+
readonly cluster_tiers: {
|
|
1541
|
+
readonly type: "array";
|
|
1542
|
+
readonly items: {
|
|
1543
|
+
readonly type: "string";
|
|
1544
|
+
readonly example: "basic";
|
|
1545
|
+
};
|
|
1546
|
+
readonly minItems: 0;
|
|
1547
|
+
readonly description: "List of Cloudfleet cluster tiers available for the organization.";
|
|
1548
|
+
};
|
|
1549
|
+
readonly regions: {
|
|
1550
|
+
readonly type: "array";
|
|
1551
|
+
readonly items: {
|
|
1552
|
+
readonly type: "string";
|
|
1553
|
+
readonly example: "northamerica-central-1a";
|
|
1554
|
+
};
|
|
1555
|
+
readonly minItems: 1;
|
|
1556
|
+
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
1557
|
+
};
|
|
1558
|
+
readonly versions: {
|
|
1559
|
+
readonly type: "array";
|
|
1560
|
+
readonly items: {
|
|
1561
|
+
readonly type: "object";
|
|
1562
|
+
readonly properties: {
|
|
1563
|
+
readonly id: {
|
|
1564
|
+
readonly type: "string";
|
|
1565
|
+
readonly description: "Id of the control plane version. Used in API calls.";
|
|
1566
|
+
readonly example: "1.33.x-cfke.x";
|
|
1567
|
+
};
|
|
1568
|
+
readonly label: {
|
|
1569
|
+
readonly type: "string";
|
|
1570
|
+
readonly description: "Label of the control plane version. Used in frontent UI.";
|
|
1571
|
+
readonly example: "1.33.x (Always latest 1.33 patch version)";
|
|
1572
|
+
};
|
|
1573
|
+
};
|
|
1574
|
+
readonly required: readonly ["id", "label"];
|
|
1575
|
+
readonly additionalProperties: false;
|
|
1576
|
+
};
|
|
1577
|
+
readonly minItems: 1;
|
|
1578
|
+
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1579
|
+
};
|
|
1580
|
+
readonly cfcr_storage_gb: {
|
|
1581
|
+
readonly type: "integer";
|
|
1582
|
+
readonly minimum: -1;
|
|
1583
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1584
|
+
readonly example: 500;
|
|
1585
|
+
};
|
|
1586
|
+
};
|
|
1587
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "enterprise_clusters_max", "enterprise_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1588
|
+
readonly additionalProperties: false;
|
|
1589
|
+
readonly description: "For security reasons, platform quota is controlled by Cloudfleet and can be updated only by Cloudfleet administrators. Please open a support ticket if you need to change the platform quota.";
|
|
1590
|
+
};
|
|
1591
|
+
readonly status: {
|
|
836
1592
|
readonly type: "string";
|
|
837
|
-
readonly
|
|
838
|
-
readonly
|
|
839
|
-
readonly example: "email@example.com";
|
|
1593
|
+
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1594
|
+
readonly enum: readonly ["active", "closed", "suspended"];
|
|
840
1595
|
};
|
|
841
|
-
readonly
|
|
1596
|
+
readonly verification: {
|
|
842
1597
|
readonly type: "string";
|
|
843
|
-
readonly description: "
|
|
844
|
-
readonly example: "
|
|
1598
|
+
readonly description: "Verification status of the organization, which determines the assigned quota. `none` when billing information is incomplete, `submitted` when billing information is complete but the organization is not yet verified, `verified` when the organization is verified.";
|
|
1599
|
+
readonly example: "verified";
|
|
1600
|
+
readonly enum: readonly ["none", "submitted", "verified"];
|
|
845
1601
|
};
|
|
846
1602
|
};
|
|
847
|
-
readonly required: readonly ["date_created"];
|
|
1603
|
+
readonly required: readonly ["id", "type", "date_created", "quota", "status", "verification"];
|
|
848
1604
|
readonly additionalProperties: false;
|
|
849
1605
|
};
|
|
850
|
-
export declare const
|
|
1606
|
+
export declare const PaymentMethodSchema: {
|
|
851
1607
|
readonly type: "object";
|
|
852
1608
|
readonly properties: {
|
|
853
1609
|
readonly id: {
|
|
854
1610
|
readonly type: "string";
|
|
855
|
-
readonly
|
|
856
|
-
readonly
|
|
857
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
1611
|
+
readonly description: "Payment method identifier. Stripe payment method id for cards/SEPA; the constant `bank_transfer` for the invoice/bank-transfer method. Used to set as default or delete the payment method.";
|
|
1612
|
+
readonly example: "pm_1MtwBwLkdIwHu7ix28a3tqPa";
|
|
858
1613
|
};
|
|
859
|
-
readonly
|
|
1614
|
+
readonly type: {
|
|
860
1615
|
readonly type: "string";
|
|
861
|
-
readonly
|
|
862
|
-
readonly
|
|
863
|
-
readonly
|
|
1616
|
+
readonly description: "Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.";
|
|
1617
|
+
readonly example: "card";
|
|
1618
|
+
readonly enum: readonly ["card", "sepa_debit", "bank_transfer"];
|
|
864
1619
|
};
|
|
865
|
-
readonly
|
|
1620
|
+
readonly last4: {
|
|
866
1621
|
readonly type: "string";
|
|
867
|
-
readonly
|
|
868
|
-
readonly
|
|
869
|
-
readonly
|
|
1622
|
+
readonly nullable: true;
|
|
1623
|
+
readonly description: "Last 4 digits of the payment card number, of the bank account (IBAN) for SEPA Direct Debit, or of the destination IBAN for bank transfer.";
|
|
1624
|
+
readonly example: "4242";
|
|
1625
|
+
};
|
|
1626
|
+
readonly exp_month: {
|
|
1627
|
+
readonly type: "integer";
|
|
1628
|
+
readonly minimum: 1;
|
|
1629
|
+
readonly maximum: 12;
|
|
1630
|
+
readonly nullable: true;
|
|
1631
|
+
readonly description: "Two-digit number representing the card's expiration month. Null for SEPA Direct Debit and bank transfer.";
|
|
1632
|
+
readonly example: 12;
|
|
1633
|
+
};
|
|
1634
|
+
readonly exp_year: {
|
|
1635
|
+
readonly type: "integer";
|
|
1636
|
+
readonly nullable: true;
|
|
1637
|
+
readonly description: "Four-digit number representing the card's expiration year. May be in the past for an expired card still on file. Null for SEPA Direct Debit and bank transfer.";
|
|
1638
|
+
readonly example: 2028;
|
|
1639
|
+
};
|
|
1640
|
+
readonly brand: {
|
|
1641
|
+
readonly type: "string";
|
|
1642
|
+
readonly nullable: true;
|
|
1643
|
+
readonly description: "Payment card brand as reported by Stripe, e.g. `visa`, `mastercard`, `amex`, `cartes_bancaires`, or `unknown`. Null for SEPA Direct Debit and bank transfer.";
|
|
1644
|
+
readonly example: "visa";
|
|
1645
|
+
};
|
|
1646
|
+
readonly iban: {
|
|
1647
|
+
readonly type: "string";
|
|
1648
|
+
readonly nullable: true;
|
|
1649
|
+
readonly description: "Full destination IBAN to send bank transfers to. Set only for `bank_transfer`; null otherwise. This is Cloudfleet's virtual receiving account, shown in full so the customer can pay into it.";
|
|
1650
|
+
readonly example: "DE11243015658023127510";
|
|
1651
|
+
};
|
|
1652
|
+
readonly bic: {
|
|
1653
|
+
readonly type: "string";
|
|
1654
|
+
readonly nullable: true;
|
|
1655
|
+
readonly description: "BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1656
|
+
readonly example: "SOGEDEFFXXX";
|
|
1657
|
+
};
|
|
1658
|
+
readonly account_holder_name: {
|
|
1659
|
+
readonly type: "string";
|
|
1660
|
+
readonly nullable: true;
|
|
1661
|
+
readonly description: "Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1662
|
+
readonly example: "Cloudfleet GmbH";
|
|
1663
|
+
};
|
|
1664
|
+
readonly is_default: {
|
|
1665
|
+
readonly type: "boolean";
|
|
1666
|
+
readonly description: "Whether this payment method is the default used for invoices and active subscriptions. Always false for `bank_transfer` (it cannot be a Stripe default payment method).";
|
|
1667
|
+
readonly example: true;
|
|
1668
|
+
};
|
|
1669
|
+
};
|
|
1670
|
+
readonly required: readonly ["id", "type", "last4", "exp_month", "exp_year", "brand", "iban", "bic", "account_holder_name", "is_default"];
|
|
1671
|
+
readonly additionalProperties: false;
|
|
1672
|
+
};
|
|
1673
|
+
export declare const PlatformQuotaSchema: {
|
|
1674
|
+
readonly type: "object";
|
|
1675
|
+
readonly properties: {
|
|
1676
|
+
readonly basic_clusters_max: {
|
|
1677
|
+
readonly type: "integer";
|
|
1678
|
+
readonly minimum: 0;
|
|
1679
|
+
readonly description: "Maximum number of Basic clusters that can be created.";
|
|
1680
|
+
readonly example: 999;
|
|
1681
|
+
};
|
|
1682
|
+
readonly basic_clusters_available: {
|
|
1683
|
+
readonly type: "integer";
|
|
1684
|
+
readonly description: "Available number of Basic clusters that can be created.";
|
|
1685
|
+
readonly example: 999;
|
|
1686
|
+
};
|
|
1687
|
+
readonly pro_clusters_max: {
|
|
1688
|
+
readonly type: "integer";
|
|
1689
|
+
readonly minimum: 0;
|
|
1690
|
+
readonly description: "Maximum number of Pro clusters that can be created.";
|
|
1691
|
+
readonly example: 999;
|
|
1692
|
+
};
|
|
1693
|
+
readonly pro_clusters_available: {
|
|
1694
|
+
readonly type: "integer";
|
|
1695
|
+
readonly description: "Available number of Pro clusters that can be created.";
|
|
1696
|
+
readonly example: 999;
|
|
1697
|
+
};
|
|
1698
|
+
readonly enterprise_clusters_max: {
|
|
1699
|
+
readonly type: "integer";
|
|
1700
|
+
readonly minimum: 0;
|
|
1701
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1702
|
+
readonly example: 999;
|
|
1703
|
+
};
|
|
1704
|
+
readonly enterprise_clusters_available: {
|
|
1705
|
+
readonly type: "integer";
|
|
1706
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1707
|
+
readonly example: 999;
|
|
1708
|
+
};
|
|
1709
|
+
readonly fleets_max: {
|
|
1710
|
+
readonly type: "integer";
|
|
1711
|
+
readonly minimum: 0;
|
|
1712
|
+
readonly description: "Maximum number of fleets that can be created per cluster.";
|
|
1713
|
+
readonly example: 999;
|
|
1714
|
+
};
|
|
1715
|
+
readonly cluster_tiers: {
|
|
1716
|
+
readonly type: "array";
|
|
1717
|
+
readonly items: {
|
|
1718
|
+
readonly type: "string";
|
|
1719
|
+
readonly example: "basic";
|
|
1720
|
+
};
|
|
1721
|
+
readonly minItems: 0;
|
|
1722
|
+
readonly description: "List of Cloudfleet cluster tiers available for the organization.";
|
|
1723
|
+
};
|
|
1724
|
+
readonly regions: {
|
|
1725
|
+
readonly type: "array";
|
|
1726
|
+
readonly items: {
|
|
1727
|
+
readonly type: "string";
|
|
1728
|
+
readonly example: "northamerica-central-1a";
|
|
1729
|
+
};
|
|
1730
|
+
readonly minItems: 1;
|
|
1731
|
+
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
1732
|
+
};
|
|
1733
|
+
readonly versions: {
|
|
1734
|
+
readonly type: "array";
|
|
1735
|
+
readonly items: {
|
|
1736
|
+
readonly type: "object";
|
|
1737
|
+
readonly properties: {
|
|
1738
|
+
readonly id: {
|
|
1739
|
+
readonly type: "string";
|
|
1740
|
+
readonly description: "Id of the control plane version. Used in API calls.";
|
|
1741
|
+
readonly example: "1.33.x-cfke.x";
|
|
1742
|
+
};
|
|
1743
|
+
readonly label: {
|
|
1744
|
+
readonly type: "string";
|
|
1745
|
+
readonly description: "Label of the control plane version. Used in frontent UI.";
|
|
1746
|
+
readonly example: "1.33.x (Always latest 1.33 patch version)";
|
|
1747
|
+
};
|
|
1748
|
+
};
|
|
1749
|
+
readonly required: readonly ["id", "label"];
|
|
1750
|
+
readonly additionalProperties: false;
|
|
1751
|
+
};
|
|
1752
|
+
readonly minItems: 1;
|
|
1753
|
+
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
870
1754
|
};
|
|
871
|
-
readonly
|
|
872
|
-
readonly type: "
|
|
873
|
-
readonly
|
|
874
|
-
readonly description: "
|
|
875
|
-
readonly example:
|
|
1755
|
+
readonly cfcr_storage_gb: {
|
|
1756
|
+
readonly type: "integer";
|
|
1757
|
+
readonly minimum: -1;
|
|
1758
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1759
|
+
readonly example: 500;
|
|
876
1760
|
};
|
|
877
|
-
|
|
1761
|
+
};
|
|
1762
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "enterprise_clusters_max", "enterprise_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1763
|
+
readonly additionalProperties: false;
|
|
1764
|
+
};
|
|
1765
|
+
export declare const RegistryRepositorySchema: {
|
|
1766
|
+
readonly type: "object";
|
|
1767
|
+
readonly properties: {
|
|
1768
|
+
readonly name: {
|
|
878
1769
|
readonly type: "string";
|
|
879
|
-
readonly description: "
|
|
880
|
-
readonly example: "
|
|
881
|
-
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"];
|
|
882
|
-
};
|
|
883
|
-
readonly creditAdj: {
|
|
884
|
-
readonly type: "number";
|
|
885
|
-
readonly format: "float";
|
|
886
|
-
readonly description: "Total amount of credit adjustments";
|
|
887
|
-
readonly example: 0;
|
|
1770
|
+
readonly description: "Repository name.";
|
|
1771
|
+
readonly example: "my-app";
|
|
888
1772
|
};
|
|
889
|
-
readonly
|
|
890
|
-
readonly type: "number";
|
|
891
|
-
readonly format: "float";
|
|
892
|
-
readonly description: "Total amount of refund adjustments";
|
|
893
|
-
readonly example: 0;
|
|
894
|
-
};
|
|
895
|
-
readonly invoiceDate: {
|
|
1773
|
+
readonly region: {
|
|
896
1774
|
readonly type: "string";
|
|
897
|
-
readonly description: "
|
|
898
|
-
readonly example: "
|
|
1775
|
+
readonly description: "Registry region.";
|
|
1776
|
+
readonly example: "northamerica";
|
|
899
1777
|
};
|
|
900
|
-
readonly
|
|
1778
|
+
readonly uri: {
|
|
901
1779
|
readonly type: "string";
|
|
902
|
-
readonly description: "
|
|
903
|
-
readonly example: "
|
|
1780
|
+
readonly description: "Full URI of the repository.";
|
|
1781
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
904
1782
|
};
|
|
905
|
-
|
|
1783
|
+
};
|
|
1784
|
+
readonly required: readonly ["name", "region", "uri"];
|
|
1785
|
+
readonly additionalProperties: false;
|
|
1786
|
+
};
|
|
1787
|
+
export declare const RegistryRepositoryWithTagsSchema: {
|
|
1788
|
+
readonly type: "object";
|
|
1789
|
+
readonly properties: {
|
|
1790
|
+
readonly name: {
|
|
906
1791
|
readonly type: "string";
|
|
907
|
-
readonly description: "
|
|
908
|
-
readonly example: "
|
|
1792
|
+
readonly description: "Repository name.";
|
|
1793
|
+
readonly example: "my-app";
|
|
909
1794
|
};
|
|
910
|
-
readonly
|
|
911
|
-
readonly type: "
|
|
912
|
-
readonly
|
|
913
|
-
readonly
|
|
914
|
-
readonly example: 100;
|
|
1795
|
+
readonly region: {
|
|
1796
|
+
readonly type: "string";
|
|
1797
|
+
readonly description: "Registry region.";
|
|
1798
|
+
readonly example: "northamerica";
|
|
915
1799
|
};
|
|
916
|
-
readonly
|
|
1800
|
+
readonly uri: {
|
|
917
1801
|
readonly type: "string";
|
|
918
|
-
readonly description: "
|
|
919
|
-
readonly example: "
|
|
1802
|
+
readonly description: "Full URI of the repository.";
|
|
1803
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
920
1804
|
};
|
|
921
|
-
readonly
|
|
1805
|
+
readonly tags: {
|
|
922
1806
|
readonly type: "array";
|
|
923
1807
|
readonly items: {
|
|
924
1808
|
readonly type: "object";
|
|
925
1809
|
readonly properties: {
|
|
926
|
-
readonly
|
|
927
|
-
readonly type: "string";
|
|
928
|
-
readonly format: "uuid";
|
|
929
|
-
readonly description: "Unique identifier of the invoice item. UUID v4 string in canonical form";
|
|
930
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
931
|
-
};
|
|
932
|
-
readonly linkedInvoiceItemId: {
|
|
933
|
-
readonly type: "string";
|
|
934
|
-
readonly format: "uuid";
|
|
935
|
-
readonly description: "Unique identifier of the linked invoice item. UUID v4 string in canonical form";
|
|
936
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
937
|
-
};
|
|
938
|
-
readonly productName: {
|
|
939
|
-
readonly type: "string";
|
|
940
|
-
readonly description: "Name of the product";
|
|
941
|
-
readonly example: "Research team";
|
|
942
|
-
};
|
|
943
|
-
readonly planName: {
|
|
944
|
-
readonly type: "string";
|
|
945
|
-
readonly description: "Name of the plan";
|
|
946
|
-
readonly example: "Plan A";
|
|
947
|
-
};
|
|
948
|
-
readonly phaseName: {
|
|
949
|
-
readonly type: "string";
|
|
950
|
-
readonly description: "Name of the phase";
|
|
951
|
-
readonly example: "Phase A";
|
|
952
|
-
};
|
|
953
|
-
readonly usageName: {
|
|
954
|
-
readonly type: "string";
|
|
955
|
-
readonly description: "Name of the usage";
|
|
956
|
-
readonly example: "Usage A";
|
|
957
|
-
};
|
|
958
|
-
readonly prettyProductName: {
|
|
959
|
-
readonly type: "string";
|
|
960
|
-
readonly description: "Pretty name of the product";
|
|
961
|
-
readonly example: "Research team";
|
|
962
|
-
};
|
|
963
|
-
readonly prettyPlanName: {
|
|
964
|
-
readonly type: "string";
|
|
965
|
-
readonly description: "Pretty name of the plan";
|
|
966
|
-
readonly example: "Plan A";
|
|
967
|
-
};
|
|
968
|
-
readonly prettyPhaseName: {
|
|
969
|
-
readonly type: "string";
|
|
970
|
-
readonly description: "Pretty name of the phase";
|
|
971
|
-
readonly example: "Phase A";
|
|
972
|
-
};
|
|
973
|
-
readonly prettyUsageName: {
|
|
974
|
-
readonly type: "string";
|
|
975
|
-
readonly description: "Pretty name of the usage";
|
|
976
|
-
readonly example: "Usage A";
|
|
977
|
-
};
|
|
978
|
-
readonly itemType: {
|
|
979
|
-
readonly type: "string";
|
|
980
|
-
readonly description: "Type of the invoice item";
|
|
981
|
-
readonly example: "EXTERNAL_CHARGE";
|
|
982
|
-
readonly enum: readonly ["EXTERNAL_CHARGE", "FIXED", "RECURRING", "REPAIR_ADJ", "CBA_ADJ", "CREDIT_ADJ", "ITEM_ADJ", "USAGE", "TAX", "PARENT_SUMMARY"];
|
|
983
|
-
};
|
|
984
|
-
readonly description: {
|
|
985
|
-
readonly type: "string";
|
|
986
|
-
readonly description: "Description of the invoice item";
|
|
987
|
-
readonly example: "Description of the invoice item";
|
|
988
|
-
};
|
|
989
|
-
readonly startDate: {
|
|
1810
|
+
readonly name: {
|
|
990
1811
|
readonly type: "string";
|
|
991
|
-
readonly description: "
|
|
992
|
-
readonly example: "
|
|
993
|
-
};
|
|
994
|
-
readonly endDate: {
|
|
995
|
-
readonly type: "string";
|
|
996
|
-
readonly description: "End date of the invoice item";
|
|
997
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
998
|
-
};
|
|
999
|
-
readonly amount: {
|
|
1000
|
-
readonly type: "number";
|
|
1001
|
-
readonly format: "float";
|
|
1002
|
-
readonly description: "Amount of the invoice item";
|
|
1003
|
-
readonly example: 100;
|
|
1004
|
-
};
|
|
1005
|
-
readonly rate: {
|
|
1006
|
-
readonly type: "number";
|
|
1007
|
-
readonly format: "float";
|
|
1008
|
-
readonly description: "Rate of the invoice item";
|
|
1009
|
-
readonly example: 100;
|
|
1010
|
-
};
|
|
1011
|
-
readonly currency: {
|
|
1012
|
-
readonly type: "string";
|
|
1013
|
-
readonly description: "Currency of the invoice item";
|
|
1014
|
-
readonly example: "USD";
|
|
1015
|
-
readonly enum: readonly ["AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD", "BTC"];
|
|
1812
|
+
readonly description: "Tag name.";
|
|
1813
|
+
readonly example: "latest";
|
|
1016
1814
|
};
|
|
1017
|
-
readonly
|
|
1815
|
+
readonly size: {
|
|
1018
1816
|
readonly type: "number";
|
|
1019
1817
|
readonly format: "float";
|
|
1020
|
-
readonly description: "
|
|
1021
|
-
readonly example:
|
|
1818
|
+
readonly description: "Size of the tag in bytes.";
|
|
1819
|
+
readonly example: 123456789;
|
|
1022
1820
|
};
|
|
1023
|
-
readonly
|
|
1821
|
+
readonly mediaType: {
|
|
1024
1822
|
readonly type: "string";
|
|
1025
|
-
readonly description: "
|
|
1026
|
-
readonly example: "
|
|
1823
|
+
readonly description: "Media type of the manifest.";
|
|
1824
|
+
readonly example: "application/vnd.docker.distribution.manifest.v2+json";
|
|
1027
1825
|
};
|
|
1028
|
-
readonly
|
|
1029
|
-
readonly type: "string";
|
|
1030
|
-
readonly description: "Effective date of the catalog";
|
|
1031
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
1032
|
-
};
|
|
1033
|
-
readonly childItems: {
|
|
1826
|
+
readonly platforms: {
|
|
1034
1827
|
readonly type: "array";
|
|
1035
1828
|
readonly items: {
|
|
1036
|
-
readonly
|
|
1037
|
-
readonly type: "array";
|
|
1038
|
-
}, {
|
|
1039
|
-
readonly type: "boolean";
|
|
1040
|
-
}, {
|
|
1041
|
-
readonly type: "number";
|
|
1042
|
-
}, {
|
|
1043
|
-
readonly type: "object";
|
|
1044
|
-
readonly additionalProperties: true;
|
|
1045
|
-
}, {
|
|
1046
|
-
readonly type: "string";
|
|
1047
|
-
}];
|
|
1829
|
+
readonly type: "string";
|
|
1048
1830
|
};
|
|
1049
|
-
readonly description: "
|
|
1831
|
+
readonly description: "Array of platform strings for multi-arch images (e.g., linux/amd64, linux/arm64).";
|
|
1832
|
+
readonly example: readonly ["linux/amd64", "linux/arm64"];
|
|
1050
1833
|
};
|
|
1051
1834
|
};
|
|
1835
|
+
readonly required: readonly ["name", "size"];
|
|
1052
1836
|
readonly additionalProperties: false;
|
|
1053
1837
|
};
|
|
1054
|
-
readonly description: "
|
|
1838
|
+
readonly description: "Array of tags in the repository.";
|
|
1839
|
+
};
|
|
1840
|
+
readonly totalSize: {
|
|
1841
|
+
readonly type: "number";
|
|
1842
|
+
readonly format: "float";
|
|
1843
|
+
readonly description: "Total size of all tags in the repository in bytes.";
|
|
1844
|
+
readonly example: 987654321;
|
|
1845
|
+
};
|
|
1846
|
+
};
|
|
1847
|
+
readonly required: readonly ["name", "region", "uri", "tags", "totalSize"];
|
|
1848
|
+
readonly additionalProperties: false;
|
|
1849
|
+
};
|
|
1850
|
+
export declare const RegistryTagSchema: {
|
|
1851
|
+
readonly type: "object";
|
|
1852
|
+
readonly properties: {
|
|
1853
|
+
readonly name: {
|
|
1854
|
+
readonly type: "string";
|
|
1855
|
+
readonly description: "Tag name.";
|
|
1856
|
+
readonly example: "latest";
|
|
1857
|
+
};
|
|
1858
|
+
readonly digest: {
|
|
1859
|
+
readonly type: "string";
|
|
1860
|
+
readonly description: "Manifest digest for pulling by digest.";
|
|
1861
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1862
|
+
};
|
|
1863
|
+
readonly mediaType: {
|
|
1864
|
+
readonly type: "string";
|
|
1865
|
+
readonly description: "Media type of the manifest.";
|
|
1866
|
+
readonly example: "application/vnd.docker.distribution.manifest.v2+json";
|
|
1867
|
+
};
|
|
1868
|
+
readonly config: {
|
|
1869
|
+
readonly type: "object";
|
|
1870
|
+
readonly properties: {
|
|
1871
|
+
readonly size: {
|
|
1872
|
+
readonly type: "number";
|
|
1873
|
+
readonly format: "float";
|
|
1874
|
+
readonly description: "Size of the config in bytes.";
|
|
1875
|
+
readonly example: 1234;
|
|
1876
|
+
};
|
|
1877
|
+
};
|
|
1878
|
+
readonly required: readonly ["size"];
|
|
1879
|
+
readonly additionalProperties: false;
|
|
1880
|
+
readonly description: "Manifest config metadata.";
|
|
1055
1881
|
};
|
|
1056
|
-
readonly
|
|
1882
|
+
readonly layers: {
|
|
1057
1883
|
readonly type: "array";
|
|
1058
1884
|
readonly items: {
|
|
1059
1885
|
readonly type: "object";
|
|
1060
1886
|
readonly properties: {
|
|
1061
|
-
readonly
|
|
1062
|
-
readonly type: "string";
|
|
1063
|
-
readonly format: "uuid";
|
|
1064
|
-
readonly description: "Unique identifier of the invoice item. UUID v4 string in canonical form";
|
|
1065
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
1066
|
-
};
|
|
1067
|
-
readonly linkedInvoiceItemId: {
|
|
1068
|
-
readonly type: "string";
|
|
1069
|
-
readonly format: "uuid";
|
|
1070
|
-
readonly description: "Unique identifier of the linked invoice item. UUID v4 string in canonical form";
|
|
1071
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
1072
|
-
};
|
|
1073
|
-
readonly productName: {
|
|
1074
|
-
readonly type: "string";
|
|
1075
|
-
readonly description: "Name of the product";
|
|
1076
|
-
readonly example: "Research team";
|
|
1077
|
-
};
|
|
1078
|
-
readonly planName: {
|
|
1079
|
-
readonly type: "string";
|
|
1080
|
-
readonly description: "Name of the plan";
|
|
1081
|
-
readonly example: "Plan A";
|
|
1082
|
-
};
|
|
1083
|
-
readonly phaseName: {
|
|
1084
|
-
readonly type: "string";
|
|
1085
|
-
readonly description: "Name of the phase";
|
|
1086
|
-
readonly example: "Phase A";
|
|
1087
|
-
};
|
|
1088
|
-
readonly usageName: {
|
|
1089
|
-
readonly type: "string";
|
|
1090
|
-
readonly description: "Name of the usage";
|
|
1091
|
-
readonly example: "Usage A";
|
|
1092
|
-
};
|
|
1093
|
-
readonly prettyProductName: {
|
|
1094
|
-
readonly type: "string";
|
|
1095
|
-
readonly description: "Pretty name of the product";
|
|
1096
|
-
readonly example: "Research team";
|
|
1097
|
-
};
|
|
1098
|
-
readonly prettyPlanName: {
|
|
1099
|
-
readonly type: "string";
|
|
1100
|
-
readonly description: "Pretty name of the plan";
|
|
1101
|
-
readonly example: "Plan A";
|
|
1102
|
-
};
|
|
1103
|
-
readonly prettyPhaseName: {
|
|
1104
|
-
readonly type: "string";
|
|
1105
|
-
readonly description: "Pretty name of the phase";
|
|
1106
|
-
readonly example: "Phase A";
|
|
1107
|
-
};
|
|
1108
|
-
readonly prettyUsageName: {
|
|
1109
|
-
readonly type: "string";
|
|
1110
|
-
readonly description: "Pretty name of the usage";
|
|
1111
|
-
readonly example: "Usage A";
|
|
1112
|
-
};
|
|
1113
|
-
readonly itemType: {
|
|
1114
|
-
readonly type: "string";
|
|
1115
|
-
readonly description: "Type of the invoice item";
|
|
1116
|
-
readonly example: "EXTERNAL_CHARGE";
|
|
1117
|
-
readonly enum: readonly ["EXTERNAL_CHARGE", "FIXED", "RECURRING", "REPAIR_ADJ", "CBA_ADJ", "CREDIT_ADJ", "ITEM_ADJ", "USAGE", "TAX", "PARENT_SUMMARY"];
|
|
1118
|
-
};
|
|
1119
|
-
readonly description: {
|
|
1120
|
-
readonly type: "string";
|
|
1121
|
-
readonly description: "Description of the invoice item";
|
|
1122
|
-
readonly example: "Description of the invoice item";
|
|
1123
|
-
};
|
|
1124
|
-
readonly startDate: {
|
|
1887
|
+
readonly digest: {
|
|
1125
1888
|
readonly type: "string";
|
|
1126
|
-
readonly description: "
|
|
1127
|
-
readonly example: "
|
|
1128
|
-
};
|
|
1129
|
-
readonly endDate: {
|
|
1130
|
-
readonly type: "string";
|
|
1131
|
-
readonly description: "End date of the invoice item";
|
|
1132
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
1133
|
-
};
|
|
1134
|
-
readonly amount: {
|
|
1135
|
-
readonly type: "number";
|
|
1136
|
-
readonly format: "float";
|
|
1137
|
-
readonly description: "Amount of the invoice item";
|
|
1138
|
-
readonly example: 100;
|
|
1139
|
-
};
|
|
1140
|
-
readonly rate: {
|
|
1141
|
-
readonly type: "number";
|
|
1142
|
-
readonly format: "float";
|
|
1143
|
-
readonly description: "Rate of the invoice item";
|
|
1144
|
-
readonly example: 100;
|
|
1145
|
-
};
|
|
1146
|
-
readonly currency: {
|
|
1147
|
-
readonly type: "string";
|
|
1148
|
-
readonly description: "Currency of the invoice item";
|
|
1149
|
-
readonly example: "USD";
|
|
1150
|
-
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"];
|
|
1889
|
+
readonly description: "Digest of the layer.";
|
|
1890
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1151
1891
|
};
|
|
1152
|
-
readonly
|
|
1892
|
+
readonly size: {
|
|
1153
1893
|
readonly type: "number";
|
|
1154
1894
|
readonly format: "float";
|
|
1155
|
-
readonly description: "
|
|
1156
|
-
readonly example:
|
|
1895
|
+
readonly description: "Size of the layer in bytes.";
|
|
1896
|
+
readonly example: 5678;
|
|
1157
1897
|
};
|
|
1158
|
-
|
|
1898
|
+
};
|
|
1899
|
+
readonly required: readonly ["size"];
|
|
1900
|
+
readonly additionalProperties: false;
|
|
1901
|
+
};
|
|
1902
|
+
readonly description: "Array of layer metadata.";
|
|
1903
|
+
};
|
|
1904
|
+
readonly manifests: {
|
|
1905
|
+
readonly type: "array";
|
|
1906
|
+
readonly items: {
|
|
1907
|
+
readonly type: "object";
|
|
1908
|
+
readonly properties: {
|
|
1909
|
+
readonly digest: {
|
|
1159
1910
|
readonly type: "string";
|
|
1160
|
-
readonly description: "
|
|
1161
|
-
readonly example: "
|
|
1911
|
+
readonly description: "Digest of the manifest.";
|
|
1912
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1162
1913
|
};
|
|
1163
|
-
readonly
|
|
1164
|
-
readonly type: "
|
|
1165
|
-
readonly
|
|
1166
|
-
|
|
1914
|
+
readonly platform: {
|
|
1915
|
+
readonly type: "object";
|
|
1916
|
+
readonly properties: {
|
|
1917
|
+
readonly architecture: {
|
|
1918
|
+
readonly type: "string";
|
|
1919
|
+
readonly description: "Architecture of the platform.";
|
|
1920
|
+
readonly example: "amd64";
|
|
1921
|
+
};
|
|
1922
|
+
readonly os: {
|
|
1923
|
+
readonly type: "string";
|
|
1924
|
+
readonly description: "Operating system of the platform.";
|
|
1925
|
+
readonly example: "linux";
|
|
1926
|
+
};
|
|
1927
|
+
readonly variant: {
|
|
1928
|
+
readonly type: "string";
|
|
1929
|
+
readonly description: "Variant of the platform (e.g., v7, v8 for ARM).";
|
|
1930
|
+
readonly example: "v8";
|
|
1931
|
+
};
|
|
1932
|
+
};
|
|
1933
|
+
readonly required: readonly ["architecture", "os"];
|
|
1934
|
+
readonly additionalProperties: false;
|
|
1935
|
+
readonly description: "Platform information for the manifest.";
|
|
1167
1936
|
};
|
|
1168
|
-
readonly
|
|
1937
|
+
readonly layers: {
|
|
1169
1938
|
readonly type: "array";
|
|
1170
1939
|
readonly items: {
|
|
1171
|
-
readonly
|
|
1172
|
-
|
|
1173
|
-
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
|
|
1177
|
-
|
|
1178
|
-
readonly
|
|
1179
|
-
|
|
1180
|
-
|
|
1181
|
-
|
|
1182
|
-
|
|
1940
|
+
readonly type: "object";
|
|
1941
|
+
readonly properties: {
|
|
1942
|
+
readonly digest: {
|
|
1943
|
+
readonly type: "string";
|
|
1944
|
+
readonly description: "Digest of the layer.";
|
|
1945
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1946
|
+
};
|
|
1947
|
+
readonly size: {
|
|
1948
|
+
readonly type: "number";
|
|
1949
|
+
readonly format: "float";
|
|
1950
|
+
readonly description: "Size of the layer in bytes.";
|
|
1951
|
+
readonly example: 5678;
|
|
1952
|
+
};
|
|
1953
|
+
};
|
|
1954
|
+
readonly required: readonly ["size"];
|
|
1955
|
+
readonly additionalProperties: false;
|
|
1183
1956
|
};
|
|
1184
|
-
readonly description: "
|
|
1957
|
+
readonly description: "Layers for this platform.";
|
|
1958
|
+
};
|
|
1959
|
+
readonly size: {
|
|
1960
|
+
readonly type: "number";
|
|
1961
|
+
readonly format: "float";
|
|
1962
|
+
readonly description: "Total size of this platform manifest in bytes.";
|
|
1963
|
+
readonly example: 12345678;
|
|
1185
1964
|
};
|
|
1186
1965
|
};
|
|
1966
|
+
readonly required: readonly ["digest"];
|
|
1187
1967
|
readonly additionalProperties: false;
|
|
1188
1968
|
};
|
|
1189
|
-
readonly description: "
|
|
1969
|
+
readonly description: "Array of manifests for multi-arch images.";
|
|
1970
|
+
};
|
|
1971
|
+
readonly size: {
|
|
1972
|
+
readonly type: "number";
|
|
1973
|
+
readonly format: "float";
|
|
1974
|
+
readonly description: "Total size of the tag in bytes.";
|
|
1975
|
+
readonly example: 123456789;
|
|
1976
|
+
};
|
|
1977
|
+
readonly region: {
|
|
1978
|
+
readonly type: "string";
|
|
1979
|
+
readonly description: "Registry region.";
|
|
1980
|
+
readonly example: "northamerica";
|
|
1981
|
+
};
|
|
1982
|
+
readonly repository: {
|
|
1983
|
+
readonly type: "string";
|
|
1984
|
+
readonly description: "Repository name.";
|
|
1985
|
+
readonly example: "my-app";
|
|
1986
|
+
};
|
|
1987
|
+
readonly uri: {
|
|
1988
|
+
readonly type: "string";
|
|
1989
|
+
readonly description: "Full URI of the tag.";
|
|
1990
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app:latest";
|
|
1190
1991
|
};
|
|
1191
1992
|
};
|
|
1993
|
+
readonly required: readonly ["name", "digest", "size", "region", "repository", "uri"];
|
|
1192
1994
|
readonly additionalProperties: false;
|
|
1193
1995
|
};
|
|
1194
|
-
export declare const
|
|
1996
|
+
export declare const TicketAttachmentSchema: {
|
|
1195
1997
|
readonly type: "object";
|
|
1196
1998
|
readonly properties: {
|
|
1197
|
-
readonly
|
|
1198
|
-
readonly type: "string";
|
|
1199
|
-
readonly format: "email";
|
|
1200
|
-
readonly description: "Email address used for billing as a string.";
|
|
1201
|
-
readonly example: "email@example.com";
|
|
1202
|
-
};
|
|
1203
|
-
readonly first_name: {
|
|
1999
|
+
readonly id: {
|
|
1204
2000
|
readonly type: "string";
|
|
1205
|
-
readonly description: "
|
|
1206
|
-
readonly example: "
|
|
2001
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2002
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1207
2003
|
};
|
|
1208
|
-
readonly
|
|
2004
|
+
readonly filename: {
|
|
1209
2005
|
readonly type: "string";
|
|
1210
|
-
readonly description: "
|
|
1211
|
-
readonly example: "
|
|
2006
|
+
readonly description: "Original filename as uploaded.";
|
|
2007
|
+
readonly example: "debug.log";
|
|
1212
2008
|
};
|
|
1213
|
-
readonly
|
|
2009
|
+
readonly content_type: {
|
|
1214
2010
|
readonly type: "string";
|
|
1215
|
-
readonly
|
|
1216
|
-
readonly
|
|
1217
|
-
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,}$";
|
|
1218
|
-
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
1219
|
-
readonly example: "ACME Corp.";
|
|
2011
|
+
readonly description: "MIME content type of the attachment.";
|
|
2012
|
+
readonly example: "text/plain";
|
|
1220
2013
|
};
|
|
1221
|
-
readonly
|
|
1222
|
-
readonly type: "
|
|
1223
|
-
readonly
|
|
1224
|
-
readonly
|
|
2014
|
+
readonly size: {
|
|
2015
|
+
readonly type: "integer";
|
|
2016
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2017
|
+
readonly example: 12345;
|
|
1225
2018
|
};
|
|
1226
2019
|
};
|
|
1227
|
-
readonly required: readonly ["
|
|
2020
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
1228
2021
|
readonly additionalProperties: false;
|
|
1229
2022
|
};
|
|
1230
|
-
export declare const
|
|
2023
|
+
export declare const TicketCreateInputSchema: {
|
|
1231
2024
|
readonly type: "object";
|
|
1232
2025
|
readonly properties: {
|
|
1233
|
-
readonly
|
|
1234
|
-
readonly type: "string";
|
|
1235
|
-
readonly format: "uuid";
|
|
1236
|
-
readonly description: "Unique identifier of the organization. UUID v4 string in canonical form";
|
|
1237
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1238
|
-
};
|
|
1239
|
-
readonly name: {
|
|
2026
|
+
readonly category: {
|
|
1240
2027
|
readonly type: "string";
|
|
1241
|
-
readonly
|
|
1242
|
-
readonly
|
|
1243
|
-
readonly
|
|
1244
|
-
readonly example: "ACME Corp.";
|
|
2028
|
+
readonly description: "Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.";
|
|
2029
|
+
readonly example: "technical";
|
|
2030
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
1245
2031
|
};
|
|
1246
|
-
readonly
|
|
2032
|
+
readonly body: {
|
|
1247
2033
|
readonly type: "string";
|
|
1248
|
-
readonly
|
|
1249
|
-
readonly
|
|
1250
|
-
readonly
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
|
|
1254
|
-
|
|
1255
|
-
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
-
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
|
|
1262
|
-
|
|
1263
|
-
|
|
1264
|
-
|
|
1265
|
-
|
|
1266
|
-
|
|
1267
|
-
|
|
1268
|
-
|
|
1269
|
-
|
|
1270
|
-
|
|
1271
|
-
|
|
1272
|
-
|
|
1273
|
-
|
|
1274
|
-
|
|
1275
|
-
|
|
1276
|
-
|
|
1277
|
-
|
|
1278
|
-
|
|
1279
|
-
|
|
1280
|
-
|
|
1281
|
-
|
|
1282
|
-
|
|
1283
|
-
|
|
1284
|
-
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
|
-
|
|
1288
|
-
|
|
1289
|
-
|
|
1290
|
-
|
|
1291
|
-
|
|
2034
|
+
readonly maxLength: 50000;
|
|
2035
|
+
readonly minLength: 1;
|
|
2036
|
+
readonly pattern: "\\S";
|
|
2037
|
+
readonly description: "Initial message body in markdown. There is no separate subject — the first message body is the description.";
|
|
2038
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2039
|
+
};
|
|
2040
|
+
readonly properties: {
|
|
2041
|
+
readonly type: "object";
|
|
2042
|
+
readonly additionalProperties: true;
|
|
2043
|
+
readonly description: "Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).";
|
|
2044
|
+
readonly example: {
|
|
2045
|
+
readonly subcategory: "cluster-question";
|
|
2046
|
+
readonly cluster_id: "60c72b2f9f1b2c001f8e4d3a";
|
|
2047
|
+
};
|
|
2048
|
+
};
|
|
2049
|
+
};
|
|
2050
|
+
readonly required: readonly ["category", "body"];
|
|
2051
|
+
readonly additionalProperties: false;
|
|
2052
|
+
};
|
|
2053
|
+
export declare const TicketMessageInputSchema: {
|
|
2054
|
+
readonly type: "object";
|
|
2055
|
+
readonly properties: {
|
|
2056
|
+
readonly body: {
|
|
2057
|
+
readonly type: "string";
|
|
2058
|
+
readonly maxLength: 50000;
|
|
2059
|
+
readonly minLength: 1;
|
|
2060
|
+
readonly pattern: "\\S";
|
|
2061
|
+
readonly description: "Reply body in markdown.";
|
|
2062
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2063
|
+
};
|
|
2064
|
+
};
|
|
2065
|
+
readonly required: readonly ["body"];
|
|
2066
|
+
readonly additionalProperties: false;
|
|
2067
|
+
};
|
|
2068
|
+
export declare const TicketMessageSchema: {
|
|
2069
|
+
readonly type: "object";
|
|
2070
|
+
readonly properties: {
|
|
2071
|
+
readonly id: {
|
|
2072
|
+
readonly type: "string";
|
|
2073
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2074
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2075
|
+
};
|
|
2076
|
+
readonly type: {
|
|
2077
|
+
readonly type: "string";
|
|
2078
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2079
|
+
readonly example: "customer_reply";
|
|
2080
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2081
|
+
};
|
|
2082
|
+
readonly body: {
|
|
2083
|
+
readonly type: "string";
|
|
2084
|
+
readonly description: "Message body in markdown.";
|
|
2085
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2086
|
+
};
|
|
2087
|
+
readonly author_first_name: {
|
|
2088
|
+
readonly type: "string";
|
|
2089
|
+
readonly nullable: true;
|
|
2090
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2091
|
+
readonly example: "Jane";
|
|
2092
|
+
};
|
|
2093
|
+
readonly author_last_name: {
|
|
2094
|
+
readonly type: "string";
|
|
2095
|
+
readonly nullable: true;
|
|
2096
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2097
|
+
readonly example: "Doe";
|
|
2098
|
+
};
|
|
2099
|
+
readonly attachments: {
|
|
2100
|
+
readonly type: "array";
|
|
2101
|
+
readonly items: {
|
|
2102
|
+
readonly type: "object";
|
|
2103
|
+
readonly properties: {
|
|
2104
|
+
readonly id: {
|
|
1292
2105
|
readonly type: "string";
|
|
1293
|
-
readonly
|
|
2106
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2107
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1294
2108
|
};
|
|
1295
|
-
readonly
|
|
1296
|
-
readonly description: "List of Cloudfleet cluster tiers available for the organization.";
|
|
1297
|
-
};
|
|
1298
|
-
readonly regions: {
|
|
1299
|
-
readonly type: "array";
|
|
1300
|
-
readonly items: {
|
|
2109
|
+
readonly filename: {
|
|
1301
2110
|
readonly type: "string";
|
|
1302
|
-
readonly
|
|
2111
|
+
readonly description: "Original filename as uploaded.";
|
|
2112
|
+
readonly example: "debug.log";
|
|
1303
2113
|
};
|
|
1304
|
-
readonly
|
|
1305
|
-
|
|
1306
|
-
|
|
1307
|
-
|
|
1308
|
-
|
|
1309
|
-
readonly
|
|
1310
|
-
readonly type: "
|
|
1311
|
-
readonly
|
|
1312
|
-
|
|
1313
|
-
readonly type: "string";
|
|
1314
|
-
readonly description: "Id of the control plane version. Used in API calls.";
|
|
1315
|
-
readonly example: "1.29.x-cfke.x";
|
|
1316
|
-
};
|
|
1317
|
-
readonly label: {
|
|
1318
|
-
readonly type: "string";
|
|
1319
|
-
readonly description: "Label of the control plane version. Used in frontent UI.";
|
|
1320
|
-
readonly example: "1.29.x (Always latest 1.29 patch version)";
|
|
1321
|
-
};
|
|
1322
|
-
};
|
|
1323
|
-
readonly required: readonly ["id", "label"];
|
|
1324
|
-
readonly additionalProperties: false;
|
|
2114
|
+
readonly content_type: {
|
|
2115
|
+
readonly type: "string";
|
|
2116
|
+
readonly description: "MIME content type of the attachment.";
|
|
2117
|
+
readonly example: "text/plain";
|
|
2118
|
+
};
|
|
2119
|
+
readonly size: {
|
|
2120
|
+
readonly type: "integer";
|
|
2121
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2122
|
+
readonly example: 12345;
|
|
1325
2123
|
};
|
|
1326
|
-
readonly minItems: 1;
|
|
1327
|
-
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1328
2124
|
};
|
|
2125
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2126
|
+
readonly additionalProperties: false;
|
|
1329
2127
|
};
|
|
1330
|
-
readonly
|
|
1331
|
-
readonly
|
|
1332
|
-
readonly description: "For security reasons, platform quota is controlled by Cloudfleet and can be updated only by Cloudfleet administrators. Please open a support ticket if you need to change the platform quota.";
|
|
2128
|
+
readonly description: "Attachments associated with this message.";
|
|
2129
|
+
readonly example: readonly [];
|
|
1333
2130
|
};
|
|
1334
|
-
readonly
|
|
2131
|
+
readonly date_created: {
|
|
1335
2132
|
readonly type: "string";
|
|
1336
|
-
readonly
|
|
1337
|
-
readonly
|
|
2133
|
+
readonly format: "date-time";
|
|
2134
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2135
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1338
2136
|
};
|
|
1339
2137
|
};
|
|
1340
|
-
readonly required: readonly ["id", "
|
|
2138
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
1341
2139
|
readonly additionalProperties: false;
|
|
1342
2140
|
};
|
|
1343
|
-
export declare const
|
|
2141
|
+
export declare const TicketSchema: {
|
|
1344
2142
|
readonly type: "object";
|
|
1345
2143
|
readonly properties: {
|
|
1346
2144
|
readonly id: {
|
|
1347
2145
|
readonly type: "string";
|
|
1348
|
-
readonly
|
|
1349
|
-
readonly
|
|
1350
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
2146
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
2147
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
1351
2148
|
};
|
|
1352
|
-
readonly
|
|
1353
|
-
readonly type: "
|
|
1354
|
-
readonly description: "
|
|
1355
|
-
readonly example:
|
|
2149
|
+
readonly status: {
|
|
2150
|
+
readonly type: "string";
|
|
2151
|
+
readonly description: "Current state of the ticket.";
|
|
2152
|
+
readonly example: "waiting_on_us";
|
|
2153
|
+
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
1356
2154
|
};
|
|
1357
|
-
readonly
|
|
2155
|
+
readonly category: {
|
|
1358
2156
|
readonly type: "string";
|
|
1359
|
-
readonly
|
|
1360
|
-
readonly
|
|
1361
|
-
readonly
|
|
1362
|
-
readonly enum: readonly ["card"];
|
|
2157
|
+
readonly description: "Ticket category.";
|
|
2158
|
+
readonly example: "technical";
|
|
2159
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
1363
2160
|
};
|
|
1364
|
-
readonly
|
|
2161
|
+
readonly summary: {
|
|
1365
2162
|
readonly type: "string";
|
|
1366
|
-
readonly
|
|
1367
|
-
readonly
|
|
1368
|
-
readonly example: "4242";
|
|
2163
|
+
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
2164
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
1369
2165
|
};
|
|
1370
|
-
readonly
|
|
1371
|
-
readonly type: "
|
|
1372
|
-
readonly
|
|
1373
|
-
readonly maximum: 12;
|
|
2166
|
+
readonly closed_at: {
|
|
2167
|
+
readonly type: "string";
|
|
2168
|
+
readonly format: "date-time";
|
|
1374
2169
|
readonly nullable: true;
|
|
1375
|
-
readonly description: "
|
|
1376
|
-
readonly example: "
|
|
2170
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
2171
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
1377
2172
|
};
|
|
1378
|
-
readonly
|
|
1379
|
-
readonly type: "
|
|
1380
|
-
readonly
|
|
1381
|
-
readonly
|
|
1382
|
-
readonly
|
|
1383
|
-
readonly example: "2028";
|
|
2173
|
+
readonly date_created: {
|
|
2174
|
+
readonly type: "string";
|
|
2175
|
+
readonly format: "date-time";
|
|
2176
|
+
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
2177
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1384
2178
|
};
|
|
1385
|
-
readonly
|
|
2179
|
+
readonly date_updated: {
|
|
1386
2180
|
readonly type: "string";
|
|
1387
|
-
readonly
|
|
1388
|
-
readonly description: "
|
|
1389
|
-
readonly example: "
|
|
1390
|
-
|
|
2181
|
+
readonly format: "date-time";
|
|
2182
|
+
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
2183
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2184
|
+
};
|
|
2185
|
+
readonly messages: {
|
|
2186
|
+
readonly type: "array";
|
|
2187
|
+
readonly items: {
|
|
2188
|
+
readonly type: "object";
|
|
2189
|
+
readonly properties: {
|
|
2190
|
+
readonly id: {
|
|
2191
|
+
readonly type: "string";
|
|
2192
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2193
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2194
|
+
};
|
|
2195
|
+
readonly type: {
|
|
2196
|
+
readonly type: "string";
|
|
2197
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2198
|
+
readonly example: "customer_reply";
|
|
2199
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2200
|
+
};
|
|
2201
|
+
readonly body: {
|
|
2202
|
+
readonly type: "string";
|
|
2203
|
+
readonly description: "Message body in markdown.";
|
|
2204
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2205
|
+
};
|
|
2206
|
+
readonly author_first_name: {
|
|
2207
|
+
readonly type: "string";
|
|
2208
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2209
|
+
readonly example: "Jane";
|
|
2210
|
+
};
|
|
2211
|
+
readonly author_last_name: {
|
|
2212
|
+
readonly type: "string";
|
|
2213
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2214
|
+
readonly example: "Doe";
|
|
2215
|
+
};
|
|
2216
|
+
readonly attachments: {
|
|
2217
|
+
readonly type: "array";
|
|
2218
|
+
readonly items: {
|
|
2219
|
+
readonly type: "object";
|
|
2220
|
+
readonly properties: {
|
|
2221
|
+
readonly id: {
|
|
2222
|
+
readonly type: "string";
|
|
2223
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2224
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2225
|
+
};
|
|
2226
|
+
readonly filename: {
|
|
2227
|
+
readonly type: "string";
|
|
2228
|
+
readonly description: "Original filename as uploaded.";
|
|
2229
|
+
readonly example: "debug.log";
|
|
2230
|
+
};
|
|
2231
|
+
readonly content_type: {
|
|
2232
|
+
readonly type: "string";
|
|
2233
|
+
readonly description: "MIME content type of the attachment.";
|
|
2234
|
+
readonly example: "text/plain";
|
|
2235
|
+
};
|
|
2236
|
+
readonly size: {
|
|
2237
|
+
readonly type: "integer";
|
|
2238
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2239
|
+
readonly example: 12345;
|
|
2240
|
+
};
|
|
2241
|
+
};
|
|
2242
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2243
|
+
readonly additionalProperties: false;
|
|
2244
|
+
};
|
|
2245
|
+
readonly description: "Attachments associated with this message.";
|
|
2246
|
+
readonly example: readonly [];
|
|
2247
|
+
};
|
|
2248
|
+
readonly date_created: {
|
|
2249
|
+
readonly type: "string";
|
|
2250
|
+
readonly format: "date-time";
|
|
2251
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2252
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2253
|
+
};
|
|
2254
|
+
};
|
|
2255
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2256
|
+
readonly additionalProperties: false;
|
|
2257
|
+
};
|
|
2258
|
+
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
1391
2259
|
};
|
|
1392
2260
|
};
|
|
1393
|
-
readonly required: readonly ["id", "
|
|
2261
|
+
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
1394
2262
|
readonly additionalProperties: false;
|
|
1395
2263
|
};
|
|
1396
2264
|
export declare const TokenCreateInputSchema: {
|
|
@@ -1471,6 +2339,104 @@ export declare const TokenUpdateInputSchema: {
|
|
|
1471
2339
|
};
|
|
1472
2340
|
readonly additionalProperties: false;
|
|
1473
2341
|
};
|
|
2342
|
+
export declare const UsageFacetsSchema: {
|
|
2343
|
+
readonly type: "object";
|
|
2344
|
+
readonly properties: {
|
|
2345
|
+
readonly cluster_id: {
|
|
2346
|
+
readonly type: "array";
|
|
2347
|
+
readonly items: {
|
|
2348
|
+
readonly type: "string";
|
|
2349
|
+
};
|
|
2350
|
+
readonly description: "List of unique cluster IDs";
|
|
2351
|
+
readonly example: readonly ["6b5439b1-923a-4f2b-a371-d554e5ea23fa"];
|
|
2352
|
+
};
|
|
2353
|
+
readonly product: {
|
|
2354
|
+
readonly type: "array";
|
|
2355
|
+
readonly items: {
|
|
2356
|
+
readonly type: "string";
|
|
2357
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
2358
|
+
};
|
|
2359
|
+
readonly description: "List of unique products";
|
|
2360
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
2361
|
+
};
|
|
2362
|
+
};
|
|
2363
|
+
readonly additionalProperties: false;
|
|
2364
|
+
};
|
|
2365
|
+
export declare const UsageResponseSchema: {
|
|
2366
|
+
readonly type: "object";
|
|
2367
|
+
readonly properties: {
|
|
2368
|
+
readonly data: {
|
|
2369
|
+
readonly type: "array";
|
|
2370
|
+
readonly items: {
|
|
2371
|
+
readonly type: "object";
|
|
2372
|
+
readonly properties: {
|
|
2373
|
+
readonly hour: {
|
|
2374
|
+
readonly type: "string";
|
|
2375
|
+
readonly description: "Hour of the usage";
|
|
2376
|
+
readonly example: "2019-01-01T00:00:00.000Z";
|
|
2377
|
+
};
|
|
2378
|
+
readonly cluster_id: {
|
|
2379
|
+
readonly type: "string";
|
|
2380
|
+
readonly description: "Unique identifier of the kubernetes cluster. UUID v4 string in canonical form";
|
|
2381
|
+
readonly example: "6b5439b1-923a-4f2b-a371-d554e5ea23fa";
|
|
2382
|
+
};
|
|
2383
|
+
readonly product: {
|
|
2384
|
+
readonly type: "string";
|
|
2385
|
+
readonly description: "The product the usage is associated with";
|
|
2386
|
+
readonly example: "cfke_controlplane_pro";
|
|
2387
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
2388
|
+
};
|
|
2389
|
+
readonly value: {
|
|
2390
|
+
readonly type: "number";
|
|
2391
|
+
readonly format: "float";
|
|
2392
|
+
readonly description: "Consumption";
|
|
2393
|
+
readonly example: 4;
|
|
2394
|
+
};
|
|
2395
|
+
readonly price: {
|
|
2396
|
+
readonly type: "number";
|
|
2397
|
+
readonly format: "float";
|
|
2398
|
+
readonly description: "Price per unit";
|
|
2399
|
+
readonly example: 0.01;
|
|
2400
|
+
};
|
|
2401
|
+
readonly total: {
|
|
2402
|
+
readonly type: "number";
|
|
2403
|
+
readonly format: "float";
|
|
2404
|
+
readonly description: "Total cost";
|
|
2405
|
+
};
|
|
2406
|
+
};
|
|
2407
|
+
readonly required: readonly ["hour", "cluster_id", "product", "value", "price", "total"];
|
|
2408
|
+
readonly additionalProperties: false;
|
|
2409
|
+
};
|
|
2410
|
+
readonly description: "Usage data";
|
|
2411
|
+
};
|
|
2412
|
+
readonly facets: {
|
|
2413
|
+
readonly type: "object";
|
|
2414
|
+
readonly properties: {
|
|
2415
|
+
readonly cluster_id: {
|
|
2416
|
+
readonly type: "array";
|
|
2417
|
+
readonly items: {
|
|
2418
|
+
readonly type: "string";
|
|
2419
|
+
};
|
|
2420
|
+
readonly description: "List of unique cluster IDs";
|
|
2421
|
+
readonly example: readonly ["6b5439b1-923a-4f2b-a371-d554e5ea23fa"];
|
|
2422
|
+
};
|
|
2423
|
+
readonly product: {
|
|
2424
|
+
readonly type: "array";
|
|
2425
|
+
readonly items: {
|
|
2426
|
+
readonly type: "string";
|
|
2427
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
2428
|
+
};
|
|
2429
|
+
readonly description: "List of unique products";
|
|
2430
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
2431
|
+
};
|
|
2432
|
+
};
|
|
2433
|
+
readonly additionalProperties: false;
|
|
2434
|
+
readonly description: "Facets for filtering";
|
|
2435
|
+
};
|
|
2436
|
+
};
|
|
2437
|
+
readonly required: readonly ["data", "facets"];
|
|
2438
|
+
readonly additionalProperties: false;
|
|
2439
|
+
};
|
|
1474
2440
|
export declare const UsageSchema: {
|
|
1475
2441
|
readonly type: "object";
|
|
1476
2442
|
readonly properties: {
|
|
@@ -1481,78 +2447,34 @@ export declare const UsageSchema: {
|
|
|
1481
2447
|
};
|
|
1482
2448
|
readonly cluster_id: {
|
|
1483
2449
|
readonly type: "string";
|
|
1484
|
-
readonly format: "uuid";
|
|
1485
2450
|
readonly description: "Unique identifier of the kubernetes cluster. UUID v4 string in canonical form";
|
|
1486
2451
|
readonly example: "6b5439b1-923a-4f2b-a371-d554e5ea23fa";
|
|
1487
2452
|
};
|
|
1488
|
-
readonly cluster_tier: {
|
|
1489
|
-
readonly type: "string";
|
|
1490
|
-
readonly description: "Tier of the cluster.";
|
|
1491
|
-
readonly example: "pro";
|
|
1492
|
-
readonly enum: readonly [""];
|
|
1493
|
-
};
|
|
1494
2453
|
readonly product: {
|
|
1495
2454
|
readonly type: "string";
|
|
1496
2455
|
readonly description: "The product the usage is associated with";
|
|
1497
|
-
readonly example: "
|
|
1498
|
-
readonly enum: readonly ["
|
|
1499
|
-
};
|
|
1500
|
-
readonly node_name: {
|
|
1501
|
-
readonly type: "string";
|
|
1502
|
-
readonly description: "Name of the Kubernetes node";
|
|
1503
|
-
readonly example: "flexible-moth-956037384";
|
|
2456
|
+
readonly example: "cfke_controlplane_pro";
|
|
2457
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
1504
2458
|
};
|
|
1505
|
-
readonly
|
|
1506
|
-
readonly type: "
|
|
1507
|
-
readonly
|
|
1508
|
-
readonly
|
|
1509
|
-
|
|
1510
|
-
readonly cpu: {
|
|
1511
|
-
readonly anyOf: readonly [{
|
|
1512
|
-
readonly type: "number";
|
|
1513
|
-
readonly format: "float";
|
|
1514
|
-
readonly description: "CPU core count of the node";
|
|
1515
|
-
readonly example: 4;
|
|
1516
|
-
}, {
|
|
1517
|
-
readonly type: "string";
|
|
1518
|
-
readonly enum: readonly [""];
|
|
1519
|
-
}];
|
|
2459
|
+
readonly value: {
|
|
2460
|
+
readonly type: "number";
|
|
2461
|
+
readonly format: "float";
|
|
2462
|
+
readonly description: "Consumption";
|
|
2463
|
+
readonly example: 4;
|
|
1520
2464
|
};
|
|
1521
2465
|
readonly price: {
|
|
1522
|
-
readonly
|
|
1523
|
-
|
|
1524
|
-
|
|
1525
|
-
|
|
1526
|
-
readonly example: 4;
|
|
1527
|
-
}, {
|
|
1528
|
-
readonly type: "string";
|
|
1529
|
-
readonly enum: readonly [""];
|
|
1530
|
-
}];
|
|
1531
|
-
};
|
|
1532
|
-
readonly value: {
|
|
1533
|
-
readonly anyOf: readonly [{
|
|
1534
|
-
readonly type: "number";
|
|
1535
|
-
readonly format: "float";
|
|
1536
|
-
readonly description: "Value";
|
|
1537
|
-
readonly example: 4;
|
|
1538
|
-
}, {
|
|
1539
|
-
readonly type: "string";
|
|
1540
|
-
readonly enum: readonly [""];
|
|
1541
|
-
}];
|
|
2466
|
+
readonly type: "number";
|
|
2467
|
+
readonly format: "float";
|
|
2468
|
+
readonly description: "Price per unit";
|
|
2469
|
+
readonly example: 0.01;
|
|
1542
2470
|
};
|
|
1543
2471
|
readonly total: {
|
|
1544
|
-
readonly
|
|
1545
|
-
|
|
1546
|
-
|
|
1547
|
-
readonly description: "Total";
|
|
1548
|
-
readonly example: 4;
|
|
1549
|
-
}, {
|
|
1550
|
-
readonly type: "string";
|
|
1551
|
-
readonly enum: readonly [""];
|
|
1552
|
-
}];
|
|
2472
|
+
readonly type: "number";
|
|
2473
|
+
readonly format: "float";
|
|
2474
|
+
readonly description: "Total cost";
|
|
1553
2475
|
};
|
|
1554
2476
|
};
|
|
1555
|
-
readonly required: readonly ["
|
|
2477
|
+
readonly required: readonly ["hour", "cluster_id", "product", "value", "price", "total"];
|
|
1556
2478
|
readonly additionalProperties: false;
|
|
1557
2479
|
};
|
|
1558
2480
|
export declare const UserCreateInputSchema: {
|
|
@@ -1589,18 +2511,6 @@ export declare const UserCreateInputSchema: {
|
|
|
1589
2511
|
readonly minLength: 8;
|
|
1590
2512
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
1591
2513
|
};
|
|
1592
|
-
readonly status: {
|
|
1593
|
-
readonly type: "string";
|
|
1594
|
-
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
1595
|
-
readonly example: "active";
|
|
1596
|
-
readonly enum: readonly ["active", "inactive"];
|
|
1597
|
-
};
|
|
1598
|
-
readonly role: {
|
|
1599
|
-
readonly type: "string";
|
|
1600
|
-
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
1601
|
-
readonly example: "User";
|
|
1602
|
-
readonly enum: readonly ["Administrator", "User"];
|
|
1603
|
-
};
|
|
1604
2514
|
};
|
|
1605
2515
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
1606
2516
|
readonly additionalProperties: false;
|
|
@@ -1652,28 +2562,6 @@ export declare const UserSchema: {
|
|
|
1652
2562
|
readonly description: "Creation date of the user. ISO 8601 date string in UTC timezone";
|
|
1653
2563
|
readonly example: "2023-11-02T16:08:14.338Z";
|
|
1654
2564
|
};
|
|
1655
|
-
readonly cluster_permissions: {
|
|
1656
|
-
readonly type: "array";
|
|
1657
|
-
readonly items: {
|
|
1658
|
-
readonly type: "object";
|
|
1659
|
-
readonly properties: {
|
|
1660
|
-
readonly cluster_id: {
|
|
1661
|
-
readonly type: "string";
|
|
1662
|
-
readonly format: "uuid";
|
|
1663
|
-
readonly description: "Unique identifier of the cluster. UUID v4 string in canonical form";
|
|
1664
|
-
readonly example: "035ce46d-44d8-4e58-a8a2-b0192d1c27df";
|
|
1665
|
-
};
|
|
1666
|
-
readonly permissions: {
|
|
1667
|
-
readonly type: "string";
|
|
1668
|
-
readonly description: "User permissions to access the cluster. Can be `readwrite` or `readonly`.";
|
|
1669
|
-
readonly example: "readwrite";
|
|
1670
|
-
readonly enum: readonly ["readwrite", "readonly"];
|
|
1671
|
-
};
|
|
1672
|
-
};
|
|
1673
|
-
readonly required: readonly ["cluster_id", "permissions"];
|
|
1674
|
-
readonly additionalProperties: false;
|
|
1675
|
-
};
|
|
1676
|
-
};
|
|
1677
2565
|
};
|
|
1678
2566
|
readonly required: readonly ["email", "first_name", "last_name", "role", "status", "id", "date_created"];
|
|
1679
2567
|
readonly additionalProperties: false;
|