@cloudfleet/sdk 0.0.1-45910ae → 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/schemas.gen.d.ts +1953 -704
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +3321 -682
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +347 -165
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +495 -331
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +20 -20
- package/dist/types.gen.d.ts +2115 -839
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +4130 -2745
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1567 -994
- package/dist/zod.gen.js.map +1 -1
- package/package.json +28 -9
package/dist/schemas.gen.d.ts
CHANGED
|
@@ -1,6 +1,12 @@
|
|
|
1
1
|
export declare const BillingContactSchema: {
|
|
2
2
|
readonly type: "object";
|
|
3
3
|
readonly properties: {
|
|
4
|
+
readonly type: {
|
|
5
|
+
readonly type: "string";
|
|
6
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
7
|
+
readonly example: "business";
|
|
8
|
+
readonly enum: readonly ["business", "personal"];
|
|
9
|
+
};
|
|
4
10
|
readonly company: {
|
|
5
11
|
readonly type: "string";
|
|
6
12
|
readonly maxLength: 120;
|
|
@@ -57,15 +63,10 @@ export declare const BillingContactSchema: {
|
|
|
57
63
|
readonly description: "Email address used for billing as a string.";
|
|
58
64
|
readonly example: "email@example.com";
|
|
59
65
|
};
|
|
60
|
-
readonly
|
|
61
|
-
readonly type: "string";
|
|
62
|
-
readonly description: "First name of the billing contact person.";
|
|
63
|
-
readonly example: "John";
|
|
64
|
-
};
|
|
65
|
-
readonly last_name: {
|
|
66
|
+
readonly individual_name: {
|
|
66
67
|
readonly type: "string";
|
|
67
|
-
readonly description: "
|
|
68
|
-
readonly example: "Doe";
|
|
68
|
+
readonly description: "Name of the billing contact person.";
|
|
69
|
+
readonly example: "John Doe";
|
|
69
70
|
};
|
|
70
71
|
readonly tax_id: {
|
|
71
72
|
readonly type: "string";
|
|
@@ -78,10 +79,10 @@ export declare const BillingContactSchema: {
|
|
|
78
79
|
readonly nullable: true;
|
|
79
80
|
readonly description: "Type of the tax ID.";
|
|
80
81
|
readonly example: "de_vat";
|
|
81
|
-
readonly enum: readonly ["ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "at_vat", "au_abn", "au_arn", "ba_tin", "bb_tin", "be_vat", "bg_uic", "bg_vat", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", "cy_vat", "cz_vat", "de_stn", "de_vat", "dk_vat", "do_rcn", "ec_ruc", "ee_vat", "eg_tin", "es_cif", "es_vat", "eu_oss_vat", "fi_vat", "fr_vat", "gb_vat", "ge_vat", "gn_nif", "gr_vat", "hk_br", "hr_oib", "hr_vat", "hu_tin", "hu_vat", "id_npwp", "ie_vat", "il_vat", "in_gst", "is_vat", "it_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kh_tin", "kr_brn", "kz_bin", "li_uid", "li_vat", "lt_vat", "lu_vat", "lv_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mt_vat", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "nl_vat", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "pl_vat", "pt_vat", "ro_tin", "ro_vat", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "se_vat", "sg_gst", "sg_uen", "si_tin", "si_vat", "sk_vat", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "xi_vat", "za_vat", "zm_tin", "zw_tin", ""];
|
|
82
|
+
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", ""];
|
|
82
83
|
};
|
|
83
84
|
};
|
|
84
|
-
readonly required: readonly ["
|
|
85
|
+
readonly required: readonly ["type", "email", "individual_name"];
|
|
85
86
|
readonly additionalProperties: false;
|
|
86
87
|
};
|
|
87
88
|
export declare const BillingCreditsSchema: {
|
|
@@ -92,10 +93,22 @@ export declare const BillingCreditsSchema: {
|
|
|
92
93
|
readonly description: "Generated unique identifier of the promotional code.";
|
|
93
94
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
94
95
|
};
|
|
95
|
-
readonly
|
|
96
|
+
readonly type: {
|
|
97
|
+
readonly type: "string";
|
|
98
|
+
readonly description: "Type of the promotional code.";
|
|
99
|
+
readonly example: "credit";
|
|
100
|
+
readonly enum: readonly ["credit", "discount"];
|
|
101
|
+
};
|
|
102
|
+
readonly date_start: {
|
|
103
|
+
readonly type: "string";
|
|
104
|
+
readonly format: "date-time";
|
|
105
|
+
readonly description: "Timestamp when the credit becomes active. ISO 8601 date string in the UTC timezone.";
|
|
106
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
107
|
+
};
|
|
108
|
+
readonly date_end: {
|
|
96
109
|
readonly type: "string";
|
|
97
110
|
readonly format: "date-time";
|
|
98
|
-
readonly description: "
|
|
111
|
+
readonly description: "Timestamp when the credit expires or becomes inactive. ISO 8601 date string in the UTC timezone.";
|
|
99
112
|
readonly example: "2023-12-20T13:53:32.000Z";
|
|
100
113
|
};
|
|
101
114
|
readonly code: {
|
|
@@ -108,40 +121,20 @@ export declare const BillingCreditsSchema: {
|
|
|
108
121
|
readonly description: "Description of the promotional code.";
|
|
109
122
|
readonly example: "10% off on all products";
|
|
110
123
|
};
|
|
111
|
-
readonly
|
|
112
|
-
readonly type: "array";
|
|
113
|
-
readonly items: {
|
|
114
|
-
readonly type: "string";
|
|
115
|
-
};
|
|
116
|
-
readonly description: "List of product SKUs that the promotional code can be used on.";
|
|
117
|
-
readonly example: readonly ["cfke_controlplane", "cfke_connected_nodes", "infra_compute", "infra_storage", "infra_loadbalancing", "infra_traffic", "cfcr_storage"];
|
|
118
|
-
};
|
|
119
|
-
readonly type: {
|
|
120
|
-
readonly type: "string";
|
|
121
|
-
readonly description: "Type of the promotional code.";
|
|
122
|
-
readonly example: "credit";
|
|
123
|
-
readonly enum: readonly ["credit", "discount"];
|
|
124
|
-
};
|
|
125
|
-
readonly value: {
|
|
124
|
+
readonly value_total: {
|
|
126
125
|
readonly type: "number";
|
|
127
126
|
readonly format: "float";
|
|
128
|
-
readonly description: "
|
|
127
|
+
readonly description: "Total value of the promotional code.";
|
|
129
128
|
readonly example: 10;
|
|
130
129
|
};
|
|
131
|
-
readonly billing_period: {
|
|
132
|
-
readonly type: "string";
|
|
133
|
-
readonly format: "date-time";
|
|
134
|
-
readonly description: "Date of the billing cycle. An ISO 8601 date string in the UTC timezone.";
|
|
135
|
-
readonly example: "2023-12-20T13:53:32.000Z";
|
|
136
|
-
};
|
|
137
130
|
readonly value_remaining: {
|
|
138
131
|
readonly type: "number";
|
|
139
132
|
readonly format: "float";
|
|
140
|
-
readonly description: "
|
|
141
|
-
readonly example:
|
|
133
|
+
readonly description: "Remaining value of the promotional code.";
|
|
134
|
+
readonly example: 8;
|
|
142
135
|
};
|
|
143
136
|
};
|
|
144
|
-
readonly required: readonly ["
|
|
137
|
+
readonly required: readonly ["type", "date_start", "code", "value_total"];
|
|
145
138
|
readonly additionalProperties: false;
|
|
146
139
|
};
|
|
147
140
|
export declare const ChartCreateInputSchema: {
|
|
@@ -224,9 +217,8 @@ export declare const ChartSchema: {
|
|
|
224
217
|
};
|
|
225
218
|
readonly status: {
|
|
226
219
|
readonly type: "string";
|
|
227
|
-
readonly description: "Status of the chart deployment.";
|
|
228
|
-
readonly example: "
|
|
229
|
-
readonly enum: readonly ["InstallSucceeded", "InstallFailed", "UpgradeSucceeded", "UpgradeFailed", "TestSucceeded", "TestFailed", "RollbackSucceeded", "RollbackFailed", "UninstallSucceeded", "UninstallFailed", "ArtifactFailed", "DependencyNotReady", "Progressing", "SourceNotReady"];
|
|
220
|
+
readonly description: "Status of the chart deployment (Flux HelmRelease Ready condition reason, e.g. InstallSucceeded, UpgradeFailed, Progressing).";
|
|
221
|
+
readonly example: "InstallSucceeded";
|
|
230
222
|
};
|
|
231
223
|
readonly version_current: {
|
|
232
224
|
readonly type: "string";
|
|
@@ -283,26 +275,103 @@ export declare const ClusterCreateInputSchema: {
|
|
|
283
275
|
readonly tier: {
|
|
284
276
|
readonly type: "string";
|
|
285
277
|
readonly description: "Tier of the cluster.";
|
|
278
|
+
readonly default: "basic";
|
|
286
279
|
readonly example: "pro";
|
|
287
|
-
readonly enum: readonly ["basic", "pro"];
|
|
288
|
-
};
|
|
289
|
-
readonly region: {
|
|
290
|
-
readonly type: "string";
|
|
291
|
-
readonly description: "Cloudfleet control plane region. One of \"staging\", \"northamerica-central-1\", \"europe-central-1a\". This field can not be updated after creation.";
|
|
292
|
-
readonly default: "staging";
|
|
293
|
-
readonly example: "northamerica-central-1";
|
|
294
|
-
readonly enum: readonly ["staging", "northamerica-central-1", "europe-central-1a"];
|
|
280
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
295
281
|
};
|
|
296
282
|
readonly version_channel: {
|
|
297
283
|
readonly type: "string";
|
|
298
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-]+)*))?$";
|
|
299
285
|
readonly description: "Version of the kubernetes cluster.";
|
|
300
286
|
readonly default: "1.x.x-cfke.x";
|
|
301
|
-
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
|
+
};
|
|
302
370
|
};
|
|
303
371
|
};
|
|
304
|
-
readonly required: readonly ["name", "
|
|
372
|
+
readonly required: readonly ["name", "region"];
|
|
305
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.";
|
|
306
375
|
};
|
|
307
376
|
export declare const ClusterJoinInformationSchema: {
|
|
308
377
|
readonly type: "object";
|
|
@@ -318,11 +387,26 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
318
387
|
readonly description: "Internal URL of the Kubernetes cluster control plane. This is the endpoint that kubelet uses to connect to the cluster.";
|
|
319
388
|
readonly example: "https://10.31.64.7:6443";
|
|
320
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
|
+
};
|
|
321
400
|
readonly auth_key: {
|
|
322
401
|
readonly type: "string";
|
|
323
402
|
readonly description: "Authentication key for the cluster.";
|
|
324
403
|
readonly example: "tskey-auth-kBV8wr1dk911CNTRL-...";
|
|
325
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
|
+
};
|
|
326
410
|
readonly bootstrap_token: {
|
|
327
411
|
readonly type: "string";
|
|
328
412
|
readonly description: "Bootstrap token for the cluster.";
|
|
@@ -334,7 +418,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
334
418
|
readonly kubernetes: {
|
|
335
419
|
readonly type: "string";
|
|
336
420
|
readonly description: "Kubernetes version of the cluster.";
|
|
337
|
-
readonly example: "1.
|
|
421
|
+
readonly example: "1.33.7";
|
|
338
422
|
};
|
|
339
423
|
readonly tailscale: {
|
|
340
424
|
readonly type: "string";
|
|
@@ -346,8 +430,13 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
346
430
|
readonly description: "Containerd version of the cluster.";
|
|
347
431
|
readonly example: "1.7.19";
|
|
348
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
|
+
};
|
|
349
438
|
};
|
|
350
|
-
readonly required: readonly ["kubernetes", "tailscale", "containerd"];
|
|
439
|
+
readonly required: readonly ["kubernetes", "tailscale", "containerd", "nvidia_driver"];
|
|
351
440
|
readonly additionalProperties: false;
|
|
352
441
|
readonly description: "Versions of the different components of the cluster.";
|
|
353
442
|
};
|
|
@@ -375,7 +464,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
375
464
|
readonly description: "OIDC Information for hosts to access to third party API's.";
|
|
376
465
|
};
|
|
377
466
|
};
|
|
378
|
-
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"];
|
|
379
468
|
readonly additionalProperties: false;
|
|
380
469
|
};
|
|
381
470
|
export declare const ClusterSchema: {
|
|
@@ -392,22 +481,100 @@ export declare const ClusterSchema: {
|
|
|
392
481
|
readonly tier: {
|
|
393
482
|
readonly type: "string";
|
|
394
483
|
readonly description: "Tier of the cluster.";
|
|
484
|
+
readonly default: "basic";
|
|
395
485
|
readonly example: "pro";
|
|
396
|
-
readonly enum: readonly ["basic", "pro"];
|
|
397
|
-
};
|
|
398
|
-
readonly region: {
|
|
399
|
-
readonly type: "string";
|
|
400
|
-
readonly description: "Cloudfleet control plane region. One of \"staging\", \"northamerica-central-1\", \"europe-central-1a\". This field can not be updated after creation.";
|
|
401
|
-
readonly default: "staging";
|
|
402
|
-
readonly example: "northamerica-central-1";
|
|
403
|
-
readonly enum: readonly ["staging", "northamerica-central-1", "europe-central-1a"];
|
|
486
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
404
487
|
};
|
|
405
488
|
readonly version_channel: {
|
|
406
489
|
readonly type: "string";
|
|
407
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-]+)*))?$";
|
|
408
491
|
readonly description: "Version of the kubernetes cluster.";
|
|
409
492
|
readonly default: "1.x.x-cfke.x";
|
|
410
|
-
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
|
+
};
|
|
411
578
|
};
|
|
412
579
|
readonly id: {
|
|
413
580
|
readonly type: "string";
|
|
@@ -417,16 +584,27 @@ export declare const ClusterSchema: {
|
|
|
417
584
|
};
|
|
418
585
|
readonly status: {
|
|
419
586
|
readonly type: "string";
|
|
420
|
-
readonly description: "Status of the cluster.
|
|
421
|
-
readonly example: "
|
|
422
|
-
readonly enum: readonly ["
|
|
587
|
+
readonly description: "Status of the cluster.";
|
|
588
|
+
readonly example: "deployed";
|
|
589
|
+
readonly enum: readonly ["creating", "deployed", "updating", "disabled"];
|
|
423
590
|
};
|
|
424
591
|
readonly endpoint: {
|
|
425
592
|
readonly anyOf: readonly [{
|
|
426
593
|
readonly type: "string";
|
|
427
594
|
readonly format: "uri";
|
|
428
|
-
readonly description: "URL of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
429
|
-
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
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";
|
|
430
608
|
}, {
|
|
431
609
|
readonly type: "string";
|
|
432
610
|
readonly enum: readonly [""];
|
|
@@ -440,7 +618,7 @@ export declare const ClusterSchema: {
|
|
|
440
618
|
readonly version_current: {
|
|
441
619
|
readonly type: "string";
|
|
442
620
|
readonly description: "Current version of the cluster.";
|
|
443
|
-
readonly example: "1.
|
|
621
|
+
readonly example: "1.33.7-cfke.264";
|
|
444
622
|
};
|
|
445
623
|
readonly created_at: {
|
|
446
624
|
readonly type: "string";
|
|
@@ -458,8 +636,9 @@ export declare const ClusterSchema: {
|
|
|
458
636
|
readonly example: true;
|
|
459
637
|
};
|
|
460
638
|
};
|
|
461
|
-
readonly required: readonly ["name", "tier", "id", "status"];
|
|
639
|
+
readonly required: readonly ["name", "tier", "version_channel", "release_channel", "features", "region", "networking", "id", "status", "ready"];
|
|
462
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.";
|
|
463
642
|
};
|
|
464
643
|
export declare const ClusterUpdateInputSchema: {
|
|
465
644
|
readonly type: "object";
|
|
@@ -475,107 +654,125 @@ export declare const ClusterUpdateInputSchema: {
|
|
|
475
654
|
readonly tier: {
|
|
476
655
|
readonly type: "string";
|
|
477
656
|
readonly description: "Tier of the cluster.";
|
|
657
|
+
readonly default: "basic";
|
|
478
658
|
readonly example: "pro";
|
|
479
|
-
readonly enum: readonly ["basic", "pro"];
|
|
659
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
480
660
|
};
|
|
481
661
|
readonly version_channel: {
|
|
482
662
|
readonly type: "string";
|
|
483
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-]+)*))?$";
|
|
484
664
|
readonly description: "Version of the kubernetes cluster.";
|
|
485
|
-
readonly
|
|
665
|
+
readonly default: "1.x.x-cfke.x";
|
|
666
|
+
readonly example: "1.x.x-cfke.x";
|
|
486
667
|
};
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
readonly properties: {
|
|
494
|
-
readonly limits: {
|
|
495
|
-
readonly type: "object";
|
|
496
|
-
readonly properties: {
|
|
497
|
-
readonly cpu: {
|
|
498
|
-
readonly type: "number";
|
|
499
|
-
readonly format: "float";
|
|
500
|
-
readonly minimum: 0;
|
|
501
|
-
readonly description: "CPU limit in cores.";
|
|
502
|
-
};
|
|
503
|
-
};
|
|
504
|
-
readonly required: readonly ["cpu"];
|
|
505
|
-
readonly additionalProperties: false;
|
|
506
|
-
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"];
|
|
507
674
|
};
|
|
508
|
-
readonly
|
|
675
|
+
readonly features: {
|
|
509
676
|
readonly type: "object";
|
|
510
677
|
readonly properties: {
|
|
511
|
-
readonly
|
|
512
|
-
readonly type: "boolean";
|
|
513
|
-
readonly default: true;
|
|
514
|
-
};
|
|
515
|
-
readonly project: {
|
|
678
|
+
readonly gpu_sharing_strategy: {
|
|
516
679
|
readonly type: "string";
|
|
517
|
-
readonly description: "
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
readonly additionalProperties: false;
|
|
522
|
-
};
|
|
523
|
-
readonly hetzner: {
|
|
524
|
-
readonly type: "object";
|
|
525
|
-
readonly properties: {
|
|
526
|
-
readonly enabled: {
|
|
527
|
-
readonly type: "boolean";
|
|
528
|
-
readonly default: true;
|
|
680
|
+
readonly description: "GPU sharing strategy.";
|
|
681
|
+
readonly default: "none";
|
|
682
|
+
readonly example: "none";
|
|
683
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
529
684
|
};
|
|
530
|
-
readonly
|
|
531
|
-
readonly type: "
|
|
532
|
-
readonly
|
|
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;
|
|
533
692
|
};
|
|
534
|
-
|
|
535
|
-
readonly required: readonly ["apiKey"];
|
|
536
|
-
readonly additionalProperties: false;
|
|
537
|
-
};
|
|
538
|
-
readonly aws: {
|
|
539
|
-
readonly type: "object";
|
|
540
|
-
readonly properties: {
|
|
541
|
-
readonly enabled: {
|
|
693
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
542
694
|
readonly type: "boolean";
|
|
543
|
-
readonly
|
|
544
|
-
|
|
545
|
-
readonly controllerRoleArn: {
|
|
546
|
-
readonly type: "string";
|
|
547
|
-
readonly description: "ControllerRoleArn is the AWS IAM role that Karpenter uses to manage resources.";
|
|
695
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
696
|
+
readonly example: false;
|
|
548
697
|
};
|
|
549
698
|
};
|
|
550
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
551
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
|
+
};
|
|
552
706
|
};
|
|
553
|
-
|
|
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: {
|
|
554
716
|
readonly type: "string";
|
|
555
|
-
readonly
|
|
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;
|
|
556
724
|
readonly minLength: 1;
|
|
557
|
-
readonly
|
|
558
|
-
readonly
|
|
559
|
-
|
|
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";
|
|
560
758
|
};
|
|
561
759
|
};
|
|
562
760
|
readonly required: readonly ["id"];
|
|
563
761
|
readonly additionalProperties: false;
|
|
564
762
|
};
|
|
565
|
-
export declare const
|
|
763
|
+
export declare const FleetCreateInputSchema: {
|
|
566
764
|
readonly type: "object";
|
|
567
765
|
readonly properties: {
|
|
568
766
|
readonly limits: {
|
|
569
767
|
readonly type: "object";
|
|
570
768
|
readonly properties: {
|
|
571
769
|
readonly cpu: {
|
|
572
|
-
readonly type: "
|
|
573
|
-
readonly format: "float";
|
|
770
|
+
readonly type: "integer";
|
|
574
771
|
readonly minimum: 0;
|
|
575
|
-
readonly
|
|
772
|
+
readonly maximum: 100000;
|
|
773
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
576
774
|
};
|
|
577
775
|
};
|
|
578
|
-
readonly required: readonly ["cpu"];
|
|
579
776
|
readonly additionalProperties: false;
|
|
580
777
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
581
778
|
};
|
|
@@ -584,14 +781,15 @@ export declare const FleetSchema: {
|
|
|
584
781
|
readonly properties: {
|
|
585
782
|
readonly enabled: {
|
|
586
783
|
readonly type: "boolean";
|
|
587
|
-
readonly default: true;
|
|
588
784
|
};
|
|
589
785
|
readonly project: {
|
|
590
786
|
readonly type: "string";
|
|
591
|
-
readonly
|
|
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";
|
|
592
790
|
};
|
|
593
791
|
};
|
|
594
|
-
readonly required: readonly ["
|
|
792
|
+
readonly required: readonly ["enabled"];
|
|
595
793
|
readonly additionalProperties: false;
|
|
596
794
|
};
|
|
597
795
|
readonly hetzner: {
|
|
@@ -599,14 +797,16 @@ export declare const FleetSchema: {
|
|
|
599
797
|
readonly properties: {
|
|
600
798
|
readonly enabled: {
|
|
601
799
|
readonly type: "boolean";
|
|
602
|
-
readonly default: true;
|
|
603
800
|
};
|
|
604
801
|
readonly apiKey: {
|
|
605
802
|
readonly type: "string";
|
|
606
|
-
readonly
|
|
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.";
|
|
607
807
|
};
|
|
608
808
|
};
|
|
609
|
-
readonly required: readonly ["
|
|
809
|
+
readonly required: readonly ["enabled"];
|
|
610
810
|
readonly additionalProperties: false;
|
|
611
811
|
};
|
|
612
812
|
readonly aws: {
|
|
@@ -614,15 +814,105 @@ export declare const FleetSchema: {
|
|
|
614
814
|
readonly properties: {
|
|
615
815
|
readonly enabled: {
|
|
616
816
|
readonly type: "boolean";
|
|
617
|
-
readonly default: true;
|
|
618
817
|
};
|
|
619
818
|
readonly controllerRoleArn: {
|
|
620
819
|
readonly type: "string";
|
|
621
|
-
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 [];
|
|
622
868
|
};
|
|
623
869
|
};
|
|
624
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
625
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 [];
|
|
626
916
|
};
|
|
627
917
|
readonly id: {
|
|
628
918
|
readonly type: "string";
|
|
@@ -635,21 +925,21 @@ export declare const FleetSchema: {
|
|
|
635
925
|
};
|
|
636
926
|
readonly required: readonly ["id"];
|
|
637
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.";
|
|
638
929
|
};
|
|
639
|
-
export declare const
|
|
930
|
+
export declare const FleetSchema: {
|
|
640
931
|
readonly type: "object";
|
|
641
932
|
readonly properties: {
|
|
642
933
|
readonly limits: {
|
|
643
934
|
readonly type: "object";
|
|
644
935
|
readonly properties: {
|
|
645
936
|
readonly cpu: {
|
|
646
|
-
readonly type: "
|
|
647
|
-
readonly format: "float";
|
|
937
|
+
readonly type: "integer";
|
|
648
938
|
readonly minimum: 0;
|
|
649
|
-
readonly
|
|
939
|
+
readonly maximum: 100000;
|
|
940
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
650
941
|
};
|
|
651
942
|
};
|
|
652
|
-
readonly required: readonly ["cpu"];
|
|
653
943
|
readonly additionalProperties: false;
|
|
654
944
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
655
945
|
};
|
|
@@ -658,14 +948,15 @@ export declare const FleetUpdateInputSchema: {
|
|
|
658
948
|
readonly properties: {
|
|
659
949
|
readonly enabled: {
|
|
660
950
|
readonly type: "boolean";
|
|
661
|
-
readonly default: true;
|
|
662
951
|
};
|
|
663
952
|
readonly project: {
|
|
664
953
|
readonly type: "string";
|
|
665
|
-
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";
|
|
666
957
|
};
|
|
667
958
|
};
|
|
668
|
-
readonly required: readonly ["
|
|
959
|
+
readonly required: readonly ["enabled"];
|
|
669
960
|
readonly additionalProperties: false;
|
|
670
961
|
};
|
|
671
962
|
readonly hetzner: {
|
|
@@ -673,14 +964,14 @@ export declare const FleetUpdateInputSchema: {
|
|
|
673
964
|
readonly properties: {
|
|
674
965
|
readonly enabled: {
|
|
675
966
|
readonly type: "boolean";
|
|
676
|
-
readonly default: true;
|
|
677
967
|
};
|
|
678
968
|
readonly apiKey: {
|
|
679
969
|
readonly type: "string";
|
|
680
|
-
readonly
|
|
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.";
|
|
681
972
|
};
|
|
682
973
|
};
|
|
683
|
-
readonly required: readonly ["
|
|
974
|
+
readonly required: readonly ["enabled"];
|
|
684
975
|
readonly additionalProperties: false;
|
|
685
976
|
};
|
|
686
977
|
readonly aws: {
|
|
@@ -688,17 +979,316 @@ export declare const FleetUpdateInputSchema: {
|
|
|
688
979
|
readonly properties: {
|
|
689
980
|
readonly enabled: {
|
|
690
981
|
readonly type: "boolean";
|
|
691
|
-
readonly default: true;
|
|
692
982
|
};
|
|
693
983
|
readonly controllerRoleArn: {
|
|
694
984
|
readonly type: "string";
|
|
695
|
-
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";
|
|
696
988
|
};
|
|
697
989
|
};
|
|
698
|
-
readonly required: readonly ["
|
|
990
|
+
readonly required: readonly ["enabled"];
|
|
699
991
|
readonly additionalProperties: false;
|
|
700
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 [];
|
|
1033
|
+
};
|
|
1034
|
+
};
|
|
1035
|
+
readonly required: readonly ["karpenter.sh/capacity-type", "kubernetes.io/arch"];
|
|
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 [];
|
|
1082
|
+
};
|
|
1083
|
+
readonly id: {
|
|
1084
|
+
readonly type: "string";
|
|
1085
|
+
readonly maxLength: 63;
|
|
1086
|
+
readonly minLength: 1;
|
|
1087
|
+
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
1088
|
+
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
1089
|
+
readonly example: "new-clouds-fleet";
|
|
1090
|
+
};
|
|
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: {
|
|
1107
|
+
readonly type: "string";
|
|
1108
|
+
readonly description: "Date and time the fleet was last updated.";
|
|
1109
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
1110
|
+
};
|
|
1111
|
+
};
|
|
1112
|
+
readonly required: readonly ["constraints", "scalingProfile", "taints", "id", "ready", "created_at", "updated_at"];
|
|
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.";
|
|
1115
|
+
};
|
|
1116
|
+
export declare const FleetUpdateInputSchema: {
|
|
1117
|
+
readonly type: "object";
|
|
1118
|
+
readonly properties: {
|
|
1119
|
+
readonly limits: {
|
|
1120
|
+
readonly type: "object";
|
|
1121
|
+
readonly properties: {
|
|
1122
|
+
readonly cpu: {
|
|
1123
|
+
readonly type: "integer";
|
|
1124
|
+
readonly minimum: 0;
|
|
1125
|
+
readonly maximum: 100000;
|
|
1126
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
1127
|
+
};
|
|
1128
|
+
};
|
|
1129
|
+
readonly additionalProperties: false;
|
|
1130
|
+
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
1131
|
+
};
|
|
1132
|
+
readonly gcp: {
|
|
1133
|
+
readonly type: "object";
|
|
1134
|
+
readonly properties: {
|
|
1135
|
+
readonly enabled: {
|
|
1136
|
+
readonly type: "boolean";
|
|
1137
|
+
};
|
|
1138
|
+
readonly project: {
|
|
1139
|
+
readonly type: "string";
|
|
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";
|
|
1143
|
+
};
|
|
1144
|
+
};
|
|
1145
|
+
readonly required: readonly ["enabled"];
|
|
1146
|
+
readonly additionalProperties: false;
|
|
1147
|
+
};
|
|
1148
|
+
readonly hetzner: {
|
|
1149
|
+
readonly type: "object";
|
|
1150
|
+
readonly properties: {
|
|
1151
|
+
readonly enabled: {
|
|
1152
|
+
readonly type: "boolean";
|
|
1153
|
+
};
|
|
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.";
|
|
1160
|
+
};
|
|
1161
|
+
};
|
|
1162
|
+
readonly required: readonly ["enabled"];
|
|
1163
|
+
readonly additionalProperties: false;
|
|
1164
|
+
};
|
|
1165
|
+
readonly aws: {
|
|
1166
|
+
readonly type: "object";
|
|
1167
|
+
readonly properties: {
|
|
1168
|
+
readonly enabled: {
|
|
1169
|
+
readonly type: "boolean";
|
|
1170
|
+
};
|
|
1171
|
+
readonly controllerRoleArn: {
|
|
1172
|
+
readonly type: "string";
|
|
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";
|
|
1176
|
+
};
|
|
1177
|
+
};
|
|
1178
|
+
readonly required: readonly ["enabled"];
|
|
1179
|
+
readonly additionalProperties: false;
|
|
1180
|
+
};
|
|
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
|
+
};
|
|
701
1290
|
};
|
|
1291
|
+
readonly required: readonly ["email"];
|
|
702
1292
|
readonly additionalProperties: false;
|
|
703
1293
|
};
|
|
704
1294
|
export declare const InviteSchema: {
|
|
@@ -732,32 +1322,158 @@ export declare const InviteSchema: {
|
|
|
732
1322
|
readonly description: "Generated unique invite code.";
|
|
733
1323
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
734
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
|
+
};
|
|
735
1332
|
};
|
|
736
1333
|
readonly required: readonly ["date_created"];
|
|
737
1334
|
readonly additionalProperties: false;
|
|
738
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
|
+
};
|
|
739
1460
|
export declare const InvoiceSchema: {
|
|
740
1461
|
readonly type: "object";
|
|
741
1462
|
readonly properties: {
|
|
742
1463
|
readonly id: {
|
|
743
1464
|
readonly type: "string";
|
|
744
|
-
readonly
|
|
745
|
-
readonly
|
|
746
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
1465
|
+
readonly description: "Unique identifier of the invoice.";
|
|
1466
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
747
1467
|
};
|
|
748
|
-
readonly
|
|
1468
|
+
readonly number: {
|
|
749
1469
|
readonly type: "string";
|
|
750
|
-
readonly format: "uuid";
|
|
751
|
-
readonly description: "Unique identifier of the organization. UUID v4 string in canonical form";
|
|
752
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
753
1470
|
};
|
|
754
1471
|
readonly status: {
|
|
755
1472
|
readonly type: "string";
|
|
756
1473
|
readonly description: "Status of the invoice";
|
|
757
|
-
readonly example: "
|
|
758
|
-
readonly enum: readonly ["DRAFT", "COMMITTED", "VOID"];
|
|
1474
|
+
readonly example: "paid";
|
|
759
1475
|
};
|
|
760
|
-
readonly
|
|
1476
|
+
readonly total: {
|
|
761
1477
|
readonly type: "number";
|
|
762
1478
|
readonly format: "float";
|
|
763
1479
|
readonly description: "Total amount of the invoice";
|
|
@@ -766,596 +1482,1087 @@ export declare const InvoiceSchema: {
|
|
|
766
1482
|
readonly currency: {
|
|
767
1483
|
readonly type: "string";
|
|
768
1484
|
readonly description: "Currency of the invoice";
|
|
769
|
-
readonly example: "
|
|
770
|
-
readonly enum: readonly ["AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD", "BTC"];
|
|
1485
|
+
readonly example: "usd";
|
|
771
1486
|
};
|
|
772
|
-
readonly
|
|
773
|
-
readonly type: "
|
|
774
|
-
readonly format: "
|
|
775
|
-
readonly description: "
|
|
776
|
-
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";
|
|
777
1492
|
};
|
|
778
|
-
readonly
|
|
779
|
-
readonly type: "
|
|
780
|
-
readonly format: "
|
|
781
|
-
readonly description: "
|
|
782
|
-
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";
|
|
1519
|
+
};
|
|
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";
|
|
783
2008
|
};
|
|
784
|
-
readonly
|
|
2009
|
+
readonly region: {
|
|
785
2010
|
readonly type: "string";
|
|
786
|
-
readonly description: "
|
|
787
|
-
readonly example: "
|
|
2011
|
+
readonly description: "Registry region.";
|
|
2012
|
+
readonly example: "northamerica";
|
|
788
2013
|
};
|
|
789
|
-
readonly
|
|
2014
|
+
readonly uri: {
|
|
790
2015
|
readonly type: "string";
|
|
791
|
-
readonly description: "
|
|
792
|
-
readonly example: "
|
|
2016
|
+
readonly description: "Full URI of the repository.";
|
|
2017
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
793
2018
|
};
|
|
794
|
-
|
|
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: {
|
|
795
2027
|
readonly type: "string";
|
|
796
|
-
readonly description: "
|
|
797
|
-
readonly example: "
|
|
2028
|
+
readonly description: "Repository name.";
|
|
2029
|
+
readonly example: "my-app";
|
|
798
2030
|
};
|
|
799
|
-
readonly
|
|
800
|
-
readonly type: "
|
|
801
|
-
readonly
|
|
802
|
-
readonly
|
|
803
|
-
readonly example: 100;
|
|
2031
|
+
readonly region: {
|
|
2032
|
+
readonly type: "string";
|
|
2033
|
+
readonly description: "Registry region.";
|
|
2034
|
+
readonly example: "northamerica";
|
|
804
2035
|
};
|
|
805
|
-
readonly
|
|
2036
|
+
readonly uri: {
|
|
806
2037
|
readonly type: "string";
|
|
807
|
-
readonly description: "
|
|
808
|
-
readonly example: "
|
|
2038
|
+
readonly description: "Full URI of the repository.";
|
|
2039
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
809
2040
|
};
|
|
810
|
-
readonly
|
|
2041
|
+
readonly tags: {
|
|
811
2042
|
readonly type: "array";
|
|
812
2043
|
readonly items: {
|
|
813
2044
|
readonly type: "object";
|
|
814
2045
|
readonly properties: {
|
|
815
|
-
readonly
|
|
816
|
-
readonly type: "string";
|
|
817
|
-
readonly format: "uuid";
|
|
818
|
-
readonly description: "Unique identifier of the invoice item. UUID v4 string in canonical form";
|
|
819
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
820
|
-
};
|
|
821
|
-
readonly linkedInvoiceItemId: {
|
|
822
|
-
readonly type: "string";
|
|
823
|
-
readonly format: "uuid";
|
|
824
|
-
readonly description: "Unique identifier of the linked invoice item. UUID v4 string in canonical form";
|
|
825
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
826
|
-
};
|
|
827
|
-
readonly productName: {
|
|
828
|
-
readonly type: "string";
|
|
829
|
-
readonly description: "Name of the product";
|
|
830
|
-
readonly example: "Research team";
|
|
831
|
-
};
|
|
832
|
-
readonly planName: {
|
|
833
|
-
readonly type: "string";
|
|
834
|
-
readonly description: "Name of the plan";
|
|
835
|
-
readonly example: "Plan A";
|
|
836
|
-
};
|
|
837
|
-
readonly phaseName: {
|
|
838
|
-
readonly type: "string";
|
|
839
|
-
readonly description: "Name of the phase";
|
|
840
|
-
readonly example: "Phase A";
|
|
841
|
-
};
|
|
842
|
-
readonly usageName: {
|
|
843
|
-
readonly type: "string";
|
|
844
|
-
readonly description: "Name of the usage";
|
|
845
|
-
readonly example: "Usage A";
|
|
846
|
-
};
|
|
847
|
-
readonly prettyProductName: {
|
|
848
|
-
readonly type: "string";
|
|
849
|
-
readonly description: "Pretty name of the product";
|
|
850
|
-
readonly example: "Research team";
|
|
851
|
-
};
|
|
852
|
-
readonly prettyPlanName: {
|
|
853
|
-
readonly type: "string";
|
|
854
|
-
readonly description: "Pretty name of the plan";
|
|
855
|
-
readonly example: "Plan A";
|
|
856
|
-
};
|
|
857
|
-
readonly prettyPhaseName: {
|
|
858
|
-
readonly type: "string";
|
|
859
|
-
readonly description: "Pretty name of the phase";
|
|
860
|
-
readonly example: "Phase A";
|
|
861
|
-
};
|
|
862
|
-
readonly prettyUsageName: {
|
|
863
|
-
readonly type: "string";
|
|
864
|
-
readonly description: "Pretty name of the usage";
|
|
865
|
-
readonly example: "Usage A";
|
|
866
|
-
};
|
|
867
|
-
readonly itemType: {
|
|
868
|
-
readonly type: "string";
|
|
869
|
-
readonly description: "Type of the invoice item";
|
|
870
|
-
readonly example: "EXTERNAL_CHARGE";
|
|
871
|
-
readonly enum: readonly ["EXTERNAL_CHARGE", "FIXED", "RECURRING", "REPAIR_ADJ", "CBA_ADJ", "CREDIT_ADJ", "ITEM_ADJ", "USAGE", "TAX", "PARENT_SUMMARY"];
|
|
872
|
-
};
|
|
873
|
-
readonly description: {
|
|
874
|
-
readonly type: "string";
|
|
875
|
-
readonly description: "Description of the invoice item";
|
|
876
|
-
readonly example: "Description of the invoice item";
|
|
877
|
-
};
|
|
878
|
-
readonly startDate: {
|
|
879
|
-
readonly type: "string";
|
|
880
|
-
readonly description: "Start date of the invoice item";
|
|
881
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
882
|
-
};
|
|
883
|
-
readonly endDate: {
|
|
884
|
-
readonly type: "string";
|
|
885
|
-
readonly description: "End date of the invoice item";
|
|
886
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
887
|
-
};
|
|
888
|
-
readonly amount: {
|
|
889
|
-
readonly type: "number";
|
|
890
|
-
readonly format: "float";
|
|
891
|
-
readonly description: "Amount of the invoice item";
|
|
892
|
-
readonly example: 100;
|
|
893
|
-
};
|
|
894
|
-
readonly rate: {
|
|
895
|
-
readonly type: "number";
|
|
896
|
-
readonly format: "float";
|
|
897
|
-
readonly description: "Rate of the invoice item";
|
|
898
|
-
readonly example: 100;
|
|
899
|
-
};
|
|
900
|
-
readonly currency: {
|
|
2046
|
+
readonly name: {
|
|
901
2047
|
readonly type: "string";
|
|
902
|
-
readonly description: "
|
|
903
|
-
readonly example: "
|
|
904
|
-
readonly enum: readonly ["AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD", "BTC"];
|
|
2048
|
+
readonly description: "Tag name.";
|
|
2049
|
+
readonly example: "latest";
|
|
905
2050
|
};
|
|
906
|
-
readonly
|
|
2051
|
+
readonly size: {
|
|
907
2052
|
readonly type: "number";
|
|
908
2053
|
readonly format: "float";
|
|
909
|
-
readonly description: "
|
|
910
|
-
readonly example:
|
|
911
|
-
};
|
|
912
|
-
readonly itemDetails: {
|
|
913
|
-
readonly type: "string";
|
|
914
|
-
readonly description: "Details of the invoice item";
|
|
915
|
-
readonly example: "Details of the invoice item";
|
|
2054
|
+
readonly description: "Size of the tag in bytes.";
|
|
2055
|
+
readonly example: 123456789;
|
|
916
2056
|
};
|
|
917
|
-
readonly
|
|
2057
|
+
readonly mediaType: {
|
|
918
2058
|
readonly type: "string";
|
|
919
|
-
readonly description: "
|
|
920
|
-
readonly example: "
|
|
2059
|
+
readonly description: "Media type of the manifest.";
|
|
2060
|
+
readonly example: "application/vnd.docker.distribution.manifest.v2+json";
|
|
921
2061
|
};
|
|
922
|
-
readonly
|
|
2062
|
+
readonly platforms: {
|
|
923
2063
|
readonly type: "array";
|
|
924
2064
|
readonly items: {
|
|
925
|
-
readonly
|
|
926
|
-
readonly type: "array";
|
|
927
|
-
}, {
|
|
928
|
-
readonly type: "boolean";
|
|
929
|
-
}, {
|
|
930
|
-
readonly type: "number";
|
|
931
|
-
}, {
|
|
932
|
-
readonly type: "object";
|
|
933
|
-
readonly additionalProperties: true;
|
|
934
|
-
}, {
|
|
935
|
-
readonly type: "string";
|
|
936
|
-
}];
|
|
2065
|
+
readonly type: "string";
|
|
937
2066
|
};
|
|
938
|
-
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"];
|
|
939
2069
|
};
|
|
940
2070
|
};
|
|
2071
|
+
readonly required: readonly ["name", "size"];
|
|
941
2072
|
readonly additionalProperties: false;
|
|
942
2073
|
};
|
|
943
|
-
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.";
|
|
944
2117
|
};
|
|
945
|
-
readonly
|
|
2118
|
+
readonly layers: {
|
|
946
2119
|
readonly type: "array";
|
|
947
2120
|
readonly items: {
|
|
948
2121
|
readonly type: "object";
|
|
949
2122
|
readonly properties: {
|
|
950
|
-
readonly
|
|
951
|
-
readonly type: "string";
|
|
952
|
-
readonly format: "uuid";
|
|
953
|
-
readonly description: "Unique identifier of the invoice item. UUID v4 string in canonical form";
|
|
954
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
955
|
-
};
|
|
956
|
-
readonly linkedInvoiceItemId: {
|
|
957
|
-
readonly type: "string";
|
|
958
|
-
readonly format: "uuid";
|
|
959
|
-
readonly description: "Unique identifier of the linked invoice item. UUID v4 string in canonical form";
|
|
960
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
961
|
-
};
|
|
962
|
-
readonly productName: {
|
|
963
|
-
readonly type: "string";
|
|
964
|
-
readonly description: "Name of the product";
|
|
965
|
-
readonly example: "Research team";
|
|
966
|
-
};
|
|
967
|
-
readonly planName: {
|
|
968
|
-
readonly type: "string";
|
|
969
|
-
readonly description: "Name of the plan";
|
|
970
|
-
readonly example: "Plan A";
|
|
971
|
-
};
|
|
972
|
-
readonly phaseName: {
|
|
973
|
-
readonly type: "string";
|
|
974
|
-
readonly description: "Name of the phase";
|
|
975
|
-
readonly example: "Phase A";
|
|
976
|
-
};
|
|
977
|
-
readonly usageName: {
|
|
978
|
-
readonly type: "string";
|
|
979
|
-
readonly description: "Name of the usage";
|
|
980
|
-
readonly example: "Usage A";
|
|
981
|
-
};
|
|
982
|
-
readonly prettyProductName: {
|
|
983
|
-
readonly type: "string";
|
|
984
|
-
readonly description: "Pretty name of the product";
|
|
985
|
-
readonly example: "Research team";
|
|
986
|
-
};
|
|
987
|
-
readonly prettyPlanName: {
|
|
988
|
-
readonly type: "string";
|
|
989
|
-
readonly description: "Pretty name of the plan";
|
|
990
|
-
readonly example: "Plan A";
|
|
991
|
-
};
|
|
992
|
-
readonly prettyPhaseName: {
|
|
993
|
-
readonly type: "string";
|
|
994
|
-
readonly description: "Pretty name of the phase";
|
|
995
|
-
readonly example: "Phase A";
|
|
996
|
-
};
|
|
997
|
-
readonly prettyUsageName: {
|
|
998
|
-
readonly type: "string";
|
|
999
|
-
readonly description: "Pretty name of the usage";
|
|
1000
|
-
readonly example: "Usage A";
|
|
1001
|
-
};
|
|
1002
|
-
readonly itemType: {
|
|
1003
|
-
readonly type: "string";
|
|
1004
|
-
readonly description: "Type of the invoice item";
|
|
1005
|
-
readonly example: "EXTERNAL_CHARGE";
|
|
1006
|
-
readonly enum: readonly ["EXTERNAL_CHARGE", "FIXED", "RECURRING", "REPAIR_ADJ", "CBA_ADJ", "CREDIT_ADJ", "ITEM_ADJ", "USAGE", "TAX", "PARENT_SUMMARY"];
|
|
1007
|
-
};
|
|
1008
|
-
readonly description: {
|
|
1009
|
-
readonly type: "string";
|
|
1010
|
-
readonly description: "Description of the invoice item";
|
|
1011
|
-
readonly example: "Description of the invoice item";
|
|
1012
|
-
};
|
|
1013
|
-
readonly startDate: {
|
|
1014
|
-
readonly type: "string";
|
|
1015
|
-
readonly description: "Start date of the invoice item";
|
|
1016
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
1017
|
-
};
|
|
1018
|
-
readonly endDate: {
|
|
1019
|
-
readonly type: "string";
|
|
1020
|
-
readonly description: "End date of the invoice item";
|
|
1021
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
1022
|
-
};
|
|
1023
|
-
readonly amount: {
|
|
1024
|
-
readonly type: "number";
|
|
1025
|
-
readonly format: "float";
|
|
1026
|
-
readonly description: "Amount of the invoice item";
|
|
1027
|
-
readonly example: 100;
|
|
1028
|
-
};
|
|
1029
|
-
readonly rate: {
|
|
1030
|
-
readonly type: "number";
|
|
1031
|
-
readonly format: "float";
|
|
1032
|
-
readonly description: "Rate of the invoice item";
|
|
1033
|
-
readonly example: 100;
|
|
1034
|
-
};
|
|
1035
|
-
readonly currency: {
|
|
2123
|
+
readonly digest: {
|
|
1036
2124
|
readonly type: "string";
|
|
1037
|
-
readonly description: "
|
|
1038
|
-
readonly example: "
|
|
1039
|
-
readonly enum: readonly ["AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD", "BTC"];
|
|
2125
|
+
readonly description: "Digest of the layer.";
|
|
2126
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1040
2127
|
};
|
|
1041
|
-
readonly
|
|
2128
|
+
readonly size: {
|
|
1042
2129
|
readonly type: "number";
|
|
1043
2130
|
readonly format: "float";
|
|
1044
|
-
readonly description: "
|
|
1045
|
-
readonly example:
|
|
2131
|
+
readonly description: "Size of the layer in bytes.";
|
|
2132
|
+
readonly example: 5678;
|
|
1046
2133
|
};
|
|
1047
|
-
|
|
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: {
|
|
1048
2146
|
readonly type: "string";
|
|
1049
|
-
readonly description: "
|
|
1050
|
-
readonly example: "
|
|
2147
|
+
readonly description: "Digest of the manifest.";
|
|
2148
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1051
2149
|
};
|
|
1052
|
-
readonly
|
|
1053
|
-
readonly type: "
|
|
1054
|
-
readonly
|
|
1055
|
-
|
|
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.";
|
|
1056
2172
|
};
|
|
1057
|
-
readonly
|
|
2173
|
+
readonly layers: {
|
|
1058
2174
|
readonly type: "array";
|
|
1059
2175
|
readonly items: {
|
|
1060
|
-
readonly
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
readonly
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
|
|
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;
|
|
1072
2192
|
};
|
|
1073
|
-
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;
|
|
1074
2200
|
};
|
|
1075
2201
|
};
|
|
2202
|
+
readonly required: readonly ["digest"];
|
|
1076
2203
|
readonly additionalProperties: false;
|
|
1077
2204
|
};
|
|
1078
|
-
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";
|
|
1079
2227
|
};
|
|
1080
2228
|
};
|
|
2229
|
+
readonly required: readonly ["name", "digest", "size", "region", "repository", "uri"];
|
|
1081
2230
|
readonly additionalProperties: false;
|
|
1082
2231
|
};
|
|
1083
|
-
export declare const
|
|
2232
|
+
export declare const RoadmapItemCreateInputSchema: {
|
|
1084
2233
|
readonly type: "object";
|
|
1085
2234
|
readonly properties: {
|
|
1086
|
-
readonly
|
|
2235
|
+
readonly text: {
|
|
1087
2236
|
readonly type: "string";
|
|
1088
|
-
readonly maxLength:
|
|
2237
|
+
readonly maxLength: 500;
|
|
1089
2238
|
readonly minLength: 1;
|
|
1090
|
-
readonly
|
|
1091
|
-
readonly
|
|
1092
|
-
readonly example: "portworx-enterprise-disaster-recovery-baremetal";
|
|
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.";
|
|
1093
2241
|
};
|
|
1094
|
-
|
|
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: {
|
|
1095
2250
|
readonly type: "string";
|
|
1096
|
-
readonly description: "
|
|
1097
|
-
readonly example: "
|
|
2251
|
+
readonly description: "Unique identifier of the roadmap item (Mongo ObjectId).";
|
|
2252
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
1098
2253
|
};
|
|
1099
|
-
readonly
|
|
2254
|
+
readonly text: {
|
|
1100
2255
|
readonly type: "string";
|
|
1101
|
-
readonly description: "
|
|
1102
|
-
readonly example: "
|
|
2256
|
+
readonly description: "Short description of the roadmap item.";
|
|
2257
|
+
readonly example: "Support for ARM nodes on Hetzner.";
|
|
1103
2258
|
};
|
|
1104
|
-
readonly
|
|
1105
|
-
readonly type: "
|
|
1106
|
-
readonly
|
|
1107
|
-
readonly
|
|
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];
|
|
1108
2265
|
};
|
|
1109
|
-
|
|
1110
|
-
|
|
1111
|
-
|
|
1112
|
-
|
|
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];
|
|
1113
2278
|
};
|
|
1114
|
-
|
|
2279
|
+
};
|
|
2280
|
+
readonly required: readonly ["value"];
|
|
2281
|
+
readonly additionalProperties: false;
|
|
2282
|
+
};
|
|
2283
|
+
export declare const TicketAttachmentSchema: {
|
|
2284
|
+
readonly type: "object";
|
|
2285
|
+
readonly properties: {
|
|
2286
|
+
readonly id: {
|
|
1115
2287
|
readonly type: "string";
|
|
1116
|
-
readonly description: "
|
|
1117
|
-
readonly example: "
|
|
2288
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2289
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1118
2290
|
};
|
|
1119
|
-
readonly
|
|
1120
|
-
readonly type: "
|
|
1121
|
-
readonly
|
|
1122
|
-
|
|
1123
|
-
readonly example: "AI & Machine Learning";
|
|
1124
|
-
};
|
|
1125
|
-
readonly description: "Tags of the chart";
|
|
2291
|
+
readonly filename: {
|
|
2292
|
+
readonly type: "string";
|
|
2293
|
+
readonly description: "Original filename as uploaded.";
|
|
2294
|
+
readonly example: "debug.log";
|
|
1126
2295
|
};
|
|
1127
|
-
readonly
|
|
1128
|
-
readonly type: "
|
|
1129
|
-
readonly
|
|
1130
|
-
|
|
1131
|
-
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-]+)*))?$";
|
|
1132
|
-
readonly description: "Version of the chart.";
|
|
1133
|
-
readonly example: "2.x.x-cfke.x";
|
|
1134
|
-
};
|
|
2296
|
+
readonly content_type: {
|
|
2297
|
+
readonly type: "string";
|
|
2298
|
+
readonly description: "MIME content type of the attachment.";
|
|
2299
|
+
readonly example: "text/plain";
|
|
1135
2300
|
};
|
|
1136
|
-
readonly
|
|
1137
|
-
readonly type: "
|
|
1138
|
-
readonly
|
|
1139
|
-
|
|
1140
|
-
readonly properties: {
|
|
1141
|
-
readonly version: {
|
|
1142
|
-
readonly type: "string";
|
|
1143
|
-
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-]+)*))?$";
|
|
1144
|
-
readonly description: "Version of the chart.";
|
|
1145
|
-
readonly example: "2.1.1-cfke.123";
|
|
1146
|
-
};
|
|
1147
|
-
readonly schema: {
|
|
1148
|
-
readonly type: "string";
|
|
1149
|
-
readonly description: "Schema of the chart values. JSON Schema as string";
|
|
1150
|
-
};
|
|
1151
|
-
readonly placeholder: {
|
|
1152
|
-
readonly type: "string";
|
|
1153
|
-
readonly description: "Schema of the chart values";
|
|
1154
|
-
readonly example: "foo: 1\nbar: example";
|
|
1155
|
-
};
|
|
1156
|
-
};
|
|
1157
|
-
readonly required: readonly ["version", "schema", "placeholder"];
|
|
1158
|
-
readonly additionalProperties: false;
|
|
1159
|
-
};
|
|
2301
|
+
readonly size: {
|
|
2302
|
+
readonly type: "integer";
|
|
2303
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2304
|
+
readonly example: 12345;
|
|
1160
2305
|
};
|
|
1161
2306
|
};
|
|
1162
|
-
readonly required: readonly ["id", "
|
|
2307
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
1163
2308
|
readonly additionalProperties: false;
|
|
1164
2309
|
};
|
|
1165
|
-
export declare const
|
|
2310
|
+
export declare const TicketCreateInputSchema: {
|
|
1166
2311
|
readonly type: "object";
|
|
1167
2312
|
readonly properties: {
|
|
1168
|
-
readonly
|
|
2313
|
+
readonly category: {
|
|
1169
2314
|
readonly type: "string";
|
|
1170
|
-
readonly
|
|
1171
|
-
readonly
|
|
1172
|
-
readonly
|
|
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"];
|
|
1173
2318
|
};
|
|
1174
|
-
readonly
|
|
2319
|
+
readonly body: {
|
|
1175
2320
|
readonly type: "string";
|
|
1176
|
-
readonly
|
|
1177
|
-
readonly
|
|
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.";
|
|
1178
2326
|
};
|
|
1179
|
-
readonly
|
|
1180
|
-
readonly type: "
|
|
1181
|
-
readonly
|
|
1182
|
-
readonly
|
|
2327
|
+
readonly properties: {
|
|
2328
|
+
readonly type: "object";
|
|
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
|
+
};
|
|
1183
2335
|
};
|
|
1184
|
-
readonly
|
|
1185
|
-
readonly type: "
|
|
1186
|
-
readonly
|
|
1187
|
-
readonly
|
|
1188
|
-
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,}$";
|
|
1189
|
-
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
1190
|
-
readonly example: "ACME Corp.";
|
|
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;
|
|
1191
2340
|
};
|
|
1192
|
-
|
|
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: {
|
|
1193
2349
|
readonly type: "string";
|
|
1194
|
-
readonly
|
|
1195
|
-
readonly
|
|
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.";
|
|
1196
2355
|
};
|
|
1197
2356
|
};
|
|
1198
|
-
readonly required: readonly ["
|
|
2357
|
+
readonly required: readonly ["body"];
|
|
1199
2358
|
readonly additionalProperties: false;
|
|
1200
2359
|
};
|
|
1201
|
-
export declare const
|
|
2360
|
+
export declare const TicketMessageSchema: {
|
|
1202
2361
|
readonly type: "object";
|
|
1203
2362
|
readonly properties: {
|
|
1204
2363
|
readonly id: {
|
|
1205
2364
|
readonly type: "string";
|
|
1206
|
-
readonly
|
|
1207
|
-
readonly
|
|
1208
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
2365
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2366
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
1209
2367
|
};
|
|
1210
|
-
readonly
|
|
2368
|
+
readonly type: {
|
|
1211
2369
|
readonly type: "string";
|
|
1212
|
-
readonly
|
|
1213
|
-
readonly
|
|
1214
|
-
readonly
|
|
1215
|
-
|
|
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.";
|
|
1216
2378
|
};
|
|
1217
|
-
readonly
|
|
2379
|
+
readonly author_first_name: {
|
|
1218
2380
|
readonly type: "string";
|
|
1219
|
-
readonly
|
|
1220
|
-
readonly description: "
|
|
1221
|
-
readonly example: "
|
|
2381
|
+
readonly nullable: true;
|
|
2382
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2383
|
+
readonly example: "Jane";
|
|
1222
2384
|
};
|
|
1223
|
-
readonly
|
|
1224
|
-
readonly type: "
|
|
1225
|
-
readonly
|
|
1226
|
-
|
|
1227
|
-
|
|
1228
|
-
|
|
1229
|
-
|
|
1230
|
-
|
|
1231
|
-
|
|
1232
|
-
readonly
|
|
1233
|
-
|
|
1234
|
-
readonly
|
|
1235
|
-
readonly example: 999;
|
|
1236
|
-
};
|
|
1237
|
-
readonly pro_clusters_max: {
|
|
1238
|
-
readonly type: "integer";
|
|
1239
|
-
readonly minimum: 0;
|
|
1240
|
-
readonly description: "Maximum number of Pro clusters that can be created.";
|
|
1241
|
-
readonly example: 999;
|
|
1242
|
-
};
|
|
1243
|
-
readonly pro_clusters_available: {
|
|
1244
|
-
readonly type: "integer";
|
|
1245
|
-
readonly description: "Available number of Pro clusters that can be created.";
|
|
1246
|
-
readonly example: 999;
|
|
1247
|
-
};
|
|
1248
|
-
readonly fleets_max: {
|
|
1249
|
-
readonly type: "integer";
|
|
1250
|
-
readonly minimum: 0;
|
|
1251
|
-
readonly description: "Maximum number of fleets that can be created per cluster.";
|
|
1252
|
-
readonly example: 999;
|
|
1253
|
-
};
|
|
1254
|
-
readonly cluster_tiers: {
|
|
1255
|
-
readonly type: "array";
|
|
1256
|
-
readonly items: {
|
|
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: {
|
|
1257
2397
|
readonly type: "string";
|
|
1258
|
-
readonly
|
|
2398
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2399
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1259
2400
|
};
|
|
1260
|
-
readonly
|
|
1261
|
-
readonly description: "List of Cloudfleet cluster tiers available for the organization.";
|
|
1262
|
-
};
|
|
1263
|
-
readonly regions: {
|
|
1264
|
-
readonly type: "array";
|
|
1265
|
-
readonly items: {
|
|
2401
|
+
readonly filename: {
|
|
1266
2402
|
readonly type: "string";
|
|
1267
|
-
readonly
|
|
2403
|
+
readonly description: "Original filename as uploaded.";
|
|
2404
|
+
readonly example: "debug.log";
|
|
1268
2405
|
};
|
|
1269
|
-
readonly
|
|
1270
|
-
|
|
1271
|
-
|
|
1272
|
-
|
|
1273
|
-
|
|
1274
|
-
readonly
|
|
1275
|
-
readonly type: "
|
|
1276
|
-
readonly
|
|
1277
|
-
|
|
1278
|
-
readonly type: "string";
|
|
1279
|
-
readonly description: "Id of the control plane version. Used in API calls.";
|
|
1280
|
-
readonly example: "1.29.x-cfke.x";
|
|
1281
|
-
};
|
|
1282
|
-
readonly label: {
|
|
1283
|
-
readonly type: "string";
|
|
1284
|
-
readonly description: "Label of the control plane version. Used in frontent UI.";
|
|
1285
|
-
readonly example: "1.29.x (Always latest 1.29 patch version)";
|
|
1286
|
-
};
|
|
1287
|
-
};
|
|
1288
|
-
readonly required: readonly ["id", "label"];
|
|
1289
|
-
readonly additionalProperties: false;
|
|
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;
|
|
1290
2415
|
};
|
|
1291
|
-
readonly minItems: 1;
|
|
1292
|
-
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1293
2416
|
};
|
|
2417
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2418
|
+
readonly additionalProperties: false;
|
|
1294
2419
|
};
|
|
1295
|
-
readonly
|
|
1296
|
-
readonly
|
|
1297
|
-
readonly description: "For security reasons, platform quota is controlled by Cloudfleet and can be updated only by Cloudfleet administrators. Please open a support ticket if you need to change the platform quota.";
|
|
2420
|
+
readonly description: "Attachments associated with this message.";
|
|
2421
|
+
readonly example: readonly [];
|
|
1298
2422
|
};
|
|
1299
|
-
readonly
|
|
2423
|
+
readonly date_created: {
|
|
1300
2424
|
readonly type: "string";
|
|
1301
|
-
readonly
|
|
1302
|
-
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";
|
|
1303
2428
|
};
|
|
1304
2429
|
};
|
|
1305
|
-
readonly required: readonly ["id", "
|
|
2430
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
1306
2431
|
readonly additionalProperties: false;
|
|
1307
2432
|
};
|
|
1308
|
-
export declare const
|
|
2433
|
+
export declare const TicketSchema: {
|
|
1309
2434
|
readonly type: "object";
|
|
1310
2435
|
readonly properties: {
|
|
1311
2436
|
readonly id: {
|
|
1312
2437
|
readonly type: "string";
|
|
1313
|
-
readonly
|
|
1314
|
-
readonly
|
|
1315
|
-
|
|
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.";
|
|
1316
2457
|
};
|
|
1317
|
-
readonly
|
|
2458
|
+
readonly support_access_granted: {
|
|
1318
2459
|
readonly type: "boolean";
|
|
1319
|
-
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.";
|
|
1320
2461
|
readonly example: true;
|
|
1321
2462
|
};
|
|
1322
|
-
readonly
|
|
2463
|
+
readonly support_access_granted_at: {
|
|
1323
2464
|
readonly type: "string";
|
|
2465
|
+
readonly format: "date-time";
|
|
1324
2466
|
readonly nullable: true;
|
|
1325
|
-
readonly description: "
|
|
1326
|
-
readonly example: "
|
|
1327
|
-
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";
|
|
1328
2469
|
};
|
|
1329
|
-
readonly
|
|
2470
|
+
readonly closed_at: {
|
|
1330
2471
|
readonly type: "string";
|
|
2472
|
+
readonly format: "date-time";
|
|
1331
2473
|
readonly nullable: true;
|
|
1332
|
-
readonly description: "
|
|
1333
|
-
readonly example: "
|
|
1334
|
-
};
|
|
1335
|
-
readonly exp_month: {
|
|
1336
|
-
readonly type: "integer";
|
|
1337
|
-
readonly minimum: 1;
|
|
1338
|
-
readonly maximum: 12;
|
|
1339
|
-
readonly nullable: true;
|
|
1340
|
-
readonly description: "Two-digit number representing the card's expiration month.";
|
|
1341
|
-
readonly example: "12";
|
|
2474
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
2475
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
1342
2476
|
};
|
|
1343
|
-
readonly
|
|
1344
|
-
readonly type: "
|
|
1345
|
-
readonly
|
|
1346
|
-
readonly
|
|
1347
|
-
readonly
|
|
1348
|
-
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";
|
|
1349
2482
|
};
|
|
1350
|
-
readonly
|
|
2483
|
+
readonly date_updated: {
|
|
1351
2484
|
readonly type: "string";
|
|
1352
|
-
readonly
|
|
1353
|
-
readonly description: "
|
|
1354
|
-
readonly example: "
|
|
1355
|
-
|
|
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.";
|
|
1356
2563
|
};
|
|
1357
2564
|
};
|
|
1358
|
-
readonly required: readonly ["id", "
|
|
2565
|
+
readonly required: readonly ["id", "status", "category", "summary", "support_access_granted", "support_access_granted_at", "date_created", "date_updated"];
|
|
1359
2566
|
readonly additionalProperties: false;
|
|
1360
2567
|
};
|
|
1361
2568
|
export declare const TokenCreateInputSchema: {
|
|
@@ -1436,6 +2643,104 @@ export declare const TokenUpdateInputSchema: {
|
|
|
1436
2643
|
};
|
|
1437
2644
|
readonly additionalProperties: false;
|
|
1438
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
|
+
};
|
|
1439
2744
|
export declare const UsageSchema: {
|
|
1440
2745
|
readonly type: "object";
|
|
1441
2746
|
readonly properties: {
|
|
@@ -1446,78 +2751,34 @@ export declare const UsageSchema: {
|
|
|
1446
2751
|
};
|
|
1447
2752
|
readonly cluster_id: {
|
|
1448
2753
|
readonly type: "string";
|
|
1449
|
-
readonly format: "uuid";
|
|
1450
2754
|
readonly description: "Unique identifier of the kubernetes cluster. UUID v4 string in canonical form";
|
|
1451
2755
|
readonly example: "6b5439b1-923a-4f2b-a371-d554e5ea23fa";
|
|
1452
2756
|
};
|
|
1453
|
-
readonly cluster_tier: {
|
|
1454
|
-
readonly type: "string";
|
|
1455
|
-
readonly description: "Tier of the cluster.";
|
|
1456
|
-
readonly example: "pro";
|
|
1457
|
-
readonly enum: readonly ["basic", "pro", ""];
|
|
1458
|
-
};
|
|
1459
2757
|
readonly product: {
|
|
1460
2758
|
readonly type: "string";
|
|
1461
2759
|
readonly description: "The product the usage is associated with";
|
|
1462
|
-
readonly example: "
|
|
1463
|
-
readonly enum: readonly ["
|
|
1464
|
-
};
|
|
1465
|
-
readonly node_name: {
|
|
1466
|
-
readonly type: "string";
|
|
1467
|
-
readonly description: "Name of the Kubernetes node";
|
|
1468
|
-
readonly example: "flexible-moth-956037384";
|
|
1469
|
-
};
|
|
1470
|
-
readonly sku: {
|
|
1471
|
-
readonly type: "string";
|
|
1472
|
-
readonly description: "SKU of the Kubernetes node";
|
|
1473
|
-
readonly example: "GCP-NORTHAMERICA-NORTHEAST1-A-G1-SMALL-SPOT";
|
|
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"];
|
|
1474
2762
|
};
|
|
1475
|
-
readonly
|
|
1476
|
-
readonly
|
|
1477
|
-
|
|
1478
|
-
|
|
1479
|
-
|
|
1480
|
-
readonly example: 4;
|
|
1481
|
-
}, {
|
|
1482
|
-
readonly type: "string";
|
|
1483
|
-
readonly enum: readonly [""];
|
|
1484
|
-
}];
|
|
2763
|
+
readonly value: {
|
|
2764
|
+
readonly type: "number";
|
|
2765
|
+
readonly format: "float";
|
|
2766
|
+
readonly description: "Consumption";
|
|
2767
|
+
readonly example: 4;
|
|
1485
2768
|
};
|
|
1486
2769
|
readonly price: {
|
|
1487
|
-
readonly
|
|
1488
|
-
|
|
1489
|
-
|
|
1490
|
-
|
|
1491
|
-
readonly example: 4;
|
|
1492
|
-
}, {
|
|
1493
|
-
readonly type: "string";
|
|
1494
|
-
readonly enum: readonly [""];
|
|
1495
|
-
}];
|
|
1496
|
-
};
|
|
1497
|
-
readonly value: {
|
|
1498
|
-
readonly anyOf: readonly [{
|
|
1499
|
-
readonly type: "number";
|
|
1500
|
-
readonly format: "float";
|
|
1501
|
-
readonly description: "Value";
|
|
1502
|
-
readonly example: 4;
|
|
1503
|
-
}, {
|
|
1504
|
-
readonly type: "string";
|
|
1505
|
-
readonly enum: readonly [""];
|
|
1506
|
-
}];
|
|
2770
|
+
readonly type: "number";
|
|
2771
|
+
readonly format: "float";
|
|
2772
|
+
readonly description: "Price per unit";
|
|
2773
|
+
readonly example: 0.01;
|
|
1507
2774
|
};
|
|
1508
2775
|
readonly total: {
|
|
1509
|
-
readonly
|
|
1510
|
-
|
|
1511
|
-
|
|
1512
|
-
readonly description: "Total";
|
|
1513
|
-
readonly example: 4;
|
|
1514
|
-
}, {
|
|
1515
|
-
readonly type: "string";
|
|
1516
|
-
readonly enum: readonly [""];
|
|
1517
|
-
}];
|
|
2776
|
+
readonly type: "number";
|
|
2777
|
+
readonly format: "float";
|
|
2778
|
+
readonly description: "Total cost";
|
|
1518
2779
|
};
|
|
1519
2780
|
};
|
|
1520
|
-
readonly required: readonly ["
|
|
2781
|
+
readonly required: readonly ["hour", "cluster_id", "product", "value", "price", "total"];
|
|
1521
2782
|
readonly additionalProperties: false;
|
|
1522
2783
|
};
|
|
1523
2784
|
export declare const UserCreateInputSchema: {
|
|
@@ -1554,18 +2815,6 @@ export declare const UserCreateInputSchema: {
|
|
|
1554
2815
|
readonly minLength: 8;
|
|
1555
2816
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
1556
2817
|
};
|
|
1557
|
-
readonly status: {
|
|
1558
|
-
readonly type: "string";
|
|
1559
|
-
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
1560
|
-
readonly example: "active";
|
|
1561
|
-
readonly enum: readonly ["active", "inactive"];
|
|
1562
|
-
};
|
|
1563
|
-
readonly role: {
|
|
1564
|
-
readonly type: "string";
|
|
1565
|
-
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
1566
|
-
readonly example: "User";
|
|
1567
|
-
readonly enum: readonly ["Administrator", "User"];
|
|
1568
|
-
};
|
|
1569
2818
|
};
|
|
1570
2819
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
1571
2820
|
readonly additionalProperties: false;
|