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