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