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