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