@scaleway/sdk 2.59.0 → 2.61.0

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.
Files changed (77) hide show
  1. package/dist/api/applesilicon/v1alpha1/api.gen.cjs +117 -0
  2. package/dist/api/applesilicon/v1alpha1/api.gen.d.ts +54 -1
  3. package/dist/api/applesilicon/v1alpha1/api.gen.js +120 -3
  4. package/dist/api/applesilicon/v1alpha1/content.gen.cjs +4 -0
  5. package/dist/api/applesilicon/v1alpha1/content.gen.d.ts +5 -1
  6. package/dist/api/applesilicon/v1alpha1/content.gen.js +4 -0
  7. package/dist/api/applesilicon/v1alpha1/index.gen.cjs +3 -0
  8. package/dist/api/applesilicon/v1alpha1/index.gen.d.ts +2 -2
  9. package/dist/api/applesilicon/v1alpha1/index.gen.js +5 -2
  10. package/dist/api/applesilicon/v1alpha1/marshalling.gen.cjs +60 -0
  11. package/dist/api/applesilicon/v1alpha1/marshalling.gen.d.ts +6 -1
  12. package/dist/api/applesilicon/v1alpha1/marshalling.gen.js +60 -0
  13. package/dist/api/applesilicon/v1alpha1/types.gen.d.ts +100 -0
  14. package/dist/api/container/v1beta1/api.gen.cjs +6 -8
  15. package/dist/api/container/v1beta1/api.gen.d.ts +6 -8
  16. package/dist/api/container/v1beta1/api.gen.js +6 -8
  17. package/dist/api/edge_services/v1alpha1/types.gen.d.ts +4 -4
  18. package/dist/api/index.gen.d.ts +2 -1
  19. package/dist/api/interlink/index.gen.cjs +4 -0
  20. package/dist/api/interlink/index.gen.d.ts +5 -0
  21. package/dist/api/interlink/index.gen.js +4 -0
  22. package/dist/api/interlink/v1beta1/api.gen.cjs +405 -0
  23. package/dist/api/interlink/v1beta1/api.gen.d.ts +208 -0
  24. package/dist/api/interlink/v1beta1/api.gen.js +405 -0
  25. package/dist/api/interlink/v1beta1/index.gen.cjs +6 -0
  26. package/dist/api/interlink/v1beta1/index.gen.d.ts +3 -0
  27. package/dist/api/interlink/v1beta1/index.gen.js +6 -0
  28. package/dist/api/interlink/v1beta1/marshalling.gen.cjs +180 -0
  29. package/dist/api/interlink/v1beta1/marshalling.gen.d.ts +16 -0
  30. package/dist/api/interlink/v1beta1/marshalling.gen.js +180 -0
  31. package/dist/api/interlink/v1beta1/types.gen.d.ts +455 -0
  32. package/dist/api/interlink/v1beta1/validation-rules.gen.cjs +107 -0
  33. package/dist/api/interlink/v1beta1/validation-rules.gen.d.ts +93 -0
  34. package/dist/api/interlink/v1beta1/validation-rules.gen.js +107 -0
  35. package/dist/api/ipam/v1/api.gen.cjs +1 -0
  36. package/dist/api/ipam/v1/api.gen.js +1 -0
  37. package/dist/api/ipam/v1/types.gen.d.ts +12 -10
  38. package/dist/api/k8s/v1/api.gen.cjs +22 -20
  39. package/dist/api/k8s/v1/api.gen.d.ts +22 -20
  40. package/dist/api/k8s/v1/api.gen.js +22 -20
  41. package/dist/api/k8s/v1/marshalling.gen.cjs +2 -5
  42. package/dist/api/k8s/v1/marshalling.gen.js +2 -5
  43. package/dist/api/k8s/v1/types.gen.d.ts +65 -49
  44. package/dist/api/lb/v1/types.gen.d.ts +6 -6
  45. package/dist/api/mongodb/v1alpha1/api.gen.cjs +13 -1
  46. package/dist/api/mongodb/v1alpha1/api.gen.d.ts +8 -1
  47. package/dist/api/mongodb/v1alpha1/api.gen.js +13 -1
  48. package/dist/api/mongodb/v1alpha1/index.gen.d.ts +1 -1
  49. package/dist/api/mongodb/v1alpha1/types.gen.d.ts +11 -0
  50. package/dist/api/mongodb/v1alpha1/validation-rules.gen.cjs +8 -0
  51. package/dist/api/mongodb/v1alpha1/validation-rules.gen.d.ts +7 -0
  52. package/dist/api/mongodb/v1alpha1/validation-rules.gen.js +8 -0
  53. package/dist/api/secret/v1beta1/marshalling.gen.cjs +1 -0
  54. package/dist/api/secret/v1beta1/marshalling.gen.js +1 -0
  55. package/dist/api/secret/v1beta1/types.gen.d.ts +2 -0
  56. package/dist/api/vpcgw/v2/api.gen.cjs +49 -1
  57. package/dist/api/vpcgw/v2/api.gen.d.ts +25 -1
  58. package/dist/api/vpcgw/v2/api.gen.js +50 -2
  59. package/dist/api/vpcgw/v2/index.gen.d.ts +1 -1
  60. package/dist/api/vpcgw/v2/marshalling.gen.cjs +31 -0
  61. package/dist/api/vpcgw/v2/marshalling.gen.d.ts +5 -1
  62. package/dist/api/vpcgw/v2/marshalling.gen.js +31 -0
  63. package/dist/api/vpcgw/v2/types.gen.d.ts +39 -0
  64. package/dist/api/webhosting/v1/api.gen.cjs +20 -0
  65. package/dist/api/webhosting/v1/api.gen.d.ts +8 -1
  66. package/dist/api/webhosting/v1/api.gen.js +21 -1
  67. package/dist/api/webhosting/v1/index.gen.d.ts +1 -1
  68. package/dist/api/webhosting/v1/marshalling.gen.cjs +16 -1
  69. package/dist/api/webhosting/v1/marshalling.gen.d.ts +2 -1
  70. package/dist/api/webhosting/v1/marshalling.gen.js +16 -1
  71. package/dist/api/webhosting/v1/types.gen.d.ts +30 -2
  72. package/dist/index.cjs +26 -24
  73. package/dist/index.js +26 -24
  74. package/dist/scw/constants.cjs +1 -1
  75. package/dist/scw/constants.d.ts +2 -2
  76. package/dist/scw/constants.js +1 -1
  77. package/package.json +2 -2
@@ -0,0 +1,107 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
3
+ const CreateLinkRequest = {
4
+ bandwidthMbps: {
5
+ greaterThanOrEqual: 1,
6
+ lessThanOrEqual: 1e8
7
+ },
8
+ name: {
9
+ maxLength: 255,
10
+ minLength: 1
11
+ }
12
+ };
13
+ const CreateRoutingPolicyRequest = {
14
+ name: {
15
+ maxLength: 255,
16
+ minLength: 1
17
+ }
18
+ };
19
+ const Link = {
20
+ name: {
21
+ minLength: 1
22
+ }
23
+ };
24
+ const ListLinksRequest = {
25
+ page: {
26
+ greaterThanOrEqual: 1
27
+ },
28
+ pageSize: {
29
+ greaterThanOrEqual: 1,
30
+ lessThanOrEqual: 1e3
31
+ }
32
+ };
33
+ const ListPartnersRequest = {
34
+ page: {
35
+ greaterThanOrEqual: 1
36
+ },
37
+ pageSize: {
38
+ greaterThanOrEqual: 1,
39
+ lessThanOrEqual: 1e3
40
+ }
41
+ };
42
+ const ListPopsRequest = {
43
+ page: {
44
+ greaterThanOrEqual: 1
45
+ },
46
+ pageSize: {
47
+ greaterThanOrEqual: 1,
48
+ lessThanOrEqual: 1e3
49
+ }
50
+ };
51
+ const ListRoutingPoliciesRequest = {
52
+ page: {
53
+ greaterThanOrEqual: 1
54
+ },
55
+ pageSize: {
56
+ greaterThanOrEqual: 1,
57
+ lessThanOrEqual: 1e3
58
+ }
59
+ };
60
+ const Partner = {
61
+ name: {
62
+ minLength: 1
63
+ }
64
+ };
65
+ const Pop = {
66
+ address: {
67
+ minLength: 1
68
+ },
69
+ city: {
70
+ minLength: 1
71
+ },
72
+ hostingProviderName: {
73
+ minLength: 1
74
+ },
75
+ name: {
76
+ minLength: 1
77
+ }
78
+ };
79
+ const RoutingPolicy = {
80
+ name: {
81
+ minLength: 1
82
+ }
83
+ };
84
+ const UpdateLinkRequest = {
85
+ name: {
86
+ maxLength: 255,
87
+ minLength: 1
88
+ }
89
+ };
90
+ const UpdateRoutingPolicyRequest = {
91
+ name: {
92
+ maxLength: 255,
93
+ minLength: 1
94
+ }
95
+ };
96
+ exports.CreateLinkRequest = CreateLinkRequest;
97
+ exports.CreateRoutingPolicyRequest = CreateRoutingPolicyRequest;
98
+ exports.Link = Link;
99
+ exports.ListLinksRequest = ListLinksRequest;
100
+ exports.ListPartnersRequest = ListPartnersRequest;
101
+ exports.ListPopsRequest = ListPopsRequest;
102
+ exports.ListRoutingPoliciesRequest = ListRoutingPoliciesRequest;
103
+ exports.Partner = Partner;
104
+ exports.Pop = Pop;
105
+ exports.RoutingPolicy = RoutingPolicy;
106
+ exports.UpdateLinkRequest = UpdateLinkRequest;
107
+ exports.UpdateRoutingPolicyRequest = UpdateRoutingPolicyRequest;
@@ -0,0 +1,93 @@
1
+ export declare const CreateLinkRequest: {
2
+ bandwidthMbps: {
3
+ greaterThanOrEqual: number;
4
+ lessThanOrEqual: number;
5
+ };
6
+ name: {
7
+ maxLength: number;
8
+ minLength: number;
9
+ };
10
+ };
11
+ export declare const CreateRoutingPolicyRequest: {
12
+ name: {
13
+ maxLength: number;
14
+ minLength: number;
15
+ };
16
+ };
17
+ export declare const Link: {
18
+ name: {
19
+ minLength: number;
20
+ };
21
+ };
22
+ export declare const ListLinksRequest: {
23
+ page: {
24
+ greaterThanOrEqual: number;
25
+ };
26
+ pageSize: {
27
+ greaterThanOrEqual: number;
28
+ lessThanOrEqual: number;
29
+ };
30
+ };
31
+ export declare const ListPartnersRequest: {
32
+ page: {
33
+ greaterThanOrEqual: number;
34
+ };
35
+ pageSize: {
36
+ greaterThanOrEqual: number;
37
+ lessThanOrEqual: number;
38
+ };
39
+ };
40
+ export declare const ListPopsRequest: {
41
+ page: {
42
+ greaterThanOrEqual: number;
43
+ };
44
+ pageSize: {
45
+ greaterThanOrEqual: number;
46
+ lessThanOrEqual: number;
47
+ };
48
+ };
49
+ export declare const ListRoutingPoliciesRequest: {
50
+ page: {
51
+ greaterThanOrEqual: number;
52
+ };
53
+ pageSize: {
54
+ greaterThanOrEqual: number;
55
+ lessThanOrEqual: number;
56
+ };
57
+ };
58
+ export declare const Partner: {
59
+ name: {
60
+ minLength: number;
61
+ };
62
+ };
63
+ export declare const Pop: {
64
+ address: {
65
+ minLength: number;
66
+ };
67
+ city: {
68
+ minLength: number;
69
+ };
70
+ hostingProviderName: {
71
+ minLength: number;
72
+ };
73
+ name: {
74
+ minLength: number;
75
+ };
76
+ };
77
+ export declare const RoutingPolicy: {
78
+ name: {
79
+ minLength: number;
80
+ };
81
+ };
82
+ export declare const UpdateLinkRequest: {
83
+ name: {
84
+ maxLength: number;
85
+ minLength: number;
86
+ };
87
+ };
88
+ export declare const UpdateRoutingPolicyRequest: {
89
+ name: {
90
+ maxLength: number;
91
+ minLength: number;
92
+ };
93
+ };
@@ -0,0 +1,107 @@
1
+ const CreateLinkRequest = {
2
+ bandwidthMbps: {
3
+ greaterThanOrEqual: 1,
4
+ lessThanOrEqual: 1e8
5
+ },
6
+ name: {
7
+ maxLength: 255,
8
+ minLength: 1
9
+ }
10
+ };
11
+ const CreateRoutingPolicyRequest = {
12
+ name: {
13
+ maxLength: 255,
14
+ minLength: 1
15
+ }
16
+ };
17
+ const Link = {
18
+ name: {
19
+ minLength: 1
20
+ }
21
+ };
22
+ const ListLinksRequest = {
23
+ page: {
24
+ greaterThanOrEqual: 1
25
+ },
26
+ pageSize: {
27
+ greaterThanOrEqual: 1,
28
+ lessThanOrEqual: 1e3
29
+ }
30
+ };
31
+ const ListPartnersRequest = {
32
+ page: {
33
+ greaterThanOrEqual: 1
34
+ },
35
+ pageSize: {
36
+ greaterThanOrEqual: 1,
37
+ lessThanOrEqual: 1e3
38
+ }
39
+ };
40
+ const ListPopsRequest = {
41
+ page: {
42
+ greaterThanOrEqual: 1
43
+ },
44
+ pageSize: {
45
+ greaterThanOrEqual: 1,
46
+ lessThanOrEqual: 1e3
47
+ }
48
+ };
49
+ const ListRoutingPoliciesRequest = {
50
+ page: {
51
+ greaterThanOrEqual: 1
52
+ },
53
+ pageSize: {
54
+ greaterThanOrEqual: 1,
55
+ lessThanOrEqual: 1e3
56
+ }
57
+ };
58
+ const Partner = {
59
+ name: {
60
+ minLength: 1
61
+ }
62
+ };
63
+ const Pop = {
64
+ address: {
65
+ minLength: 1
66
+ },
67
+ city: {
68
+ minLength: 1
69
+ },
70
+ hostingProviderName: {
71
+ minLength: 1
72
+ },
73
+ name: {
74
+ minLength: 1
75
+ }
76
+ };
77
+ const RoutingPolicy = {
78
+ name: {
79
+ minLength: 1
80
+ }
81
+ };
82
+ const UpdateLinkRequest = {
83
+ name: {
84
+ maxLength: 255,
85
+ minLength: 1
86
+ }
87
+ };
88
+ const UpdateRoutingPolicyRequest = {
89
+ name: {
90
+ maxLength: 255,
91
+ minLength: 1
92
+ }
93
+ };
94
+ export {
95
+ CreateLinkRequest,
96
+ CreateRoutingPolicyRequest,
97
+ Link,
98
+ ListLinksRequest,
99
+ ListPartnersRequest,
100
+ ListPopsRequest,
101
+ ListRoutingPoliciesRequest,
102
+ Partner,
103
+ Pop,
104
+ RoutingPolicy,
105
+ UpdateLinkRequest,
106
+ UpdateRoutingPolicyRequest
107
+ };
@@ -85,6 +85,7 @@ class API extends api.API {
85
85
  path: `/ipam/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/ips`,
86
86
  urlParams: marshalling.urlParams(
87
87
  ["attached", request.attached],
88
+ ["ip_ids", request.ipIds],
88
89
  ["is_ipv6", request.isIpv6],
89
90
  ["mac_address", request.macAddress],
90
91
  ["order_by", request.orderBy],
@@ -83,6 +83,7 @@ class API extends API$1 {
83
83
  path: `/ipam/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/ips`,
84
84
  urlParams: urlParams(
85
85
  ["attached", request.attached],
86
+ ["ip_ids", request.ipIds],
86
87
  ["is_ipv6", request.isIpv6],
87
88
  ["mac_address", request.macAddress],
88
89
  ["order_by", request.orderBy],
@@ -186,6 +186,11 @@ export type ListIPsRequest = {
186
186
  vpcId?: string;
187
187
  /** Defines whether to filter only for IPs which are attached to a resource. */
188
188
  attached?: boolean;
189
+ /**
190
+ * Attached resource name to filter for, only IPs attached to a resource with
191
+ * this string within their name will be returned.
192
+ */
193
+ resourceName?: string;
189
194
  /**
190
195
  * Resource ID to filter for. Only IPs attached to this resource will be
191
196
  * returned.
@@ -201,6 +206,11 @@ export type ListIPsRequest = {
201
206
  * will be returned.
202
207
  */
203
208
  resourceType?: ResourceType;
209
+ /**
210
+ * Resource types to filter for. Only IPs attached to these types of resources
211
+ * will be returned.
212
+ */
213
+ resourceTypes?: ResourceType[];
204
214
  /**
205
215
  * MAC address to filter for. Only IPs attached to a resource with this MAC
206
216
  * address will be returned.
@@ -218,16 +228,8 @@ export type ListIPsRequest = {
218
228
  organizationId?: string;
219
229
  /** Defines whether to filter only for IPv4s or IPv6s. */
220
230
  isIpv6?: boolean;
221
- /**
222
- * Attached resource name to filter for, only IPs attached to a resource with
223
- * this string within their name will be returned.
224
- */
225
- resourceName?: string;
226
- /**
227
- * Resource types to filter for. Only IPs attached to these types of resources
228
- * will be returned.
229
- */
230
- resourceTypes?: ResourceType[];
231
+ /** IP IDs to filter for. Only IPs with these UUIDs will be returned. */
232
+ ipIds?: string[];
231
233
  };
232
234
  export interface ListIPsResponse {
233
235
  totalCount: number;
@@ -105,8 +105,8 @@ class API extends api.API {
105
105
  );
106
106
  /**
107
107
  * Delete a Cluster. Delete a specific Kubernetes cluster and all its
108
- * associated pools and nodes. Note that this method will not delete any Load
109
- * Balancer or Block Volume that are associated with the cluster.
108
+ * associated pools and nodes, and possibly its associated Load Balancers or
109
+ * Block Volumes.
110
110
  *
111
111
  * @param request - The request {@link DeleteClusterRequest}
112
112
  * @returns A Promise of Cluster
@@ -143,8 +143,7 @@ class API extends api.API {
143
143
  /**
144
144
  * Change the Cluster type. Change the type of a specific Kubernetes cluster.
145
145
  * To see the possible values you can enter for the `type` field, [list
146
- * available cluster
147
- * types](#path-clusters-list-available-cluster-types-for-a-cluster).
146
+ * available cluster types](#list-available-cluster-types-for-a-cluster).
148
147
  *
149
148
  * @param request - The request {@link SetClusterTypeRequest}
150
149
  * @returns A Promise of Cluster
@@ -201,7 +200,7 @@ class API extends api.API {
201
200
  * Reset the admin token of a Cluster. Reset the admin token for a specific
202
201
  * Kubernetes cluster. This will revoke the old admin token (which will not be
203
202
  * usable afterwards) and create a new one. Note that you will need to
204
- * download kubeconfig again to keep interacting with the cluster.
203
+ * download the kubeconfig again to keep interacting with the cluster.
205
204
  *
206
205
  * @param request - The request {@link ResetClusterAdminTokenRequest}
207
206
  */
@@ -214,7 +213,8 @@ class API extends api.API {
214
213
  /**
215
214
  * Migrate a cluster to SBS CSI. Enable the latest CSI compatible with
216
215
  * Scaleway Block Storage (SBS) and migrate all existing
217
- * PersistentVolumes/VolumeSnapshotContents to SBS.
216
+ * PersistentVolumes/VolumeSnapshotContents to SBS. Make sure to have the
217
+ * necessary Quota before running this command.
218
218
  *
219
219
  * @param request - The request {@link MigrateClusterToSBSCSIRequest}
220
220
  * @returns A Promise of Cluster
@@ -365,7 +365,7 @@ class API extends api.API {
365
365
  /**
366
366
  * Upgrade a Pool in a Cluster. Upgrade the Kubernetes version of a specific
367
367
  * pool. Note that it only works if the targeted version matches the cluster's
368
- * version.
368
+ * version. This will drain and replace the nodes in that pool.
369
369
  *
370
370
  * @param request - The request {@link UpgradePoolRequest}
371
371
  * @returns A Promise of Pool
@@ -383,7 +383,8 @@ class API extends api.API {
383
383
  );
384
384
  /**
385
385
  * Update a Pool in a Cluster. Update the attributes of a specific pool, such
386
- * as its desired size, autoscaling settings, and tags.
386
+ * as its desired size, autoscaling settings, and tags. To upgrade a pool, you
387
+ * will need to use the dedicated endpoint.
387
388
  *
388
389
  * @param request - The request {@link UpdatePoolRequest}
389
390
  * @returns A Promise of Pool
@@ -516,11 +517,10 @@ class API extends api.API {
516
517
  );
517
518
  /**
518
519
  * Replace a Node in a Cluster. Replace a specific Node. The node will first
519
- * be cordoned (scheduling will be disabled on it). The existing pods on the
520
- * node will then be drained and rescheduled onto another schedulable node.
521
- * Note that when there is not enough space to reschedule all the pods (such
522
- * as in a one-node cluster), disruption of your applications can be
523
- * expected.
520
+ * be drained and pods will be rescheduled onto another node. Note that when
521
+ * there is not enough space to reschedule all the pods (such as in a one-node
522
+ * cluster, or with specific constraints), disruption of your applications may
523
+ * occur.
524
524
  *
525
525
  * @deprecated
526
526
  * @param request - The request {@link ReplaceNodeRequest}
@@ -537,10 +537,10 @@ class API extends api.API {
537
537
  );
538
538
  /**
539
539
  * Reboot a Node in a Cluster. Reboot a specific Node. The node will first be
540
- * cordoned (scheduling will be disabled on it). The existing pods on the node
541
- * will then be drained and rescheduled onto another schedulable node. Note
542
- * that when there is not enough space to reschedule all the pods (such as in
543
- * a one-node cluster), disruption of your applications can be expected.
540
+ * drained and pods will be rescheduled onto another node. Note that when
541
+ * there is not enough space to reschedule all the pods (such as in a one-node
542
+ * cluster, or with specific constraints), disruption of your applications may
543
+ * occur.
544
544
  *
545
545
  * @param request - The request {@link RebootNodeRequest}
546
546
  * @returns A Promise of Node
@@ -555,9 +555,11 @@ class API extends api.API {
555
555
  marshalling_gen.unmarshalNode
556
556
  );
557
557
  /**
558
- * Delete a Node in a Cluster. Delete a specific Node. Note that when there is
559
- * not enough space to reschedule all the pods (such as in a one-node
560
- * cluster), disruption of your applications can be expected.
558
+ * Delete a Node in a Cluster. Delete a specific Node. The node will first be
559
+ * drained and pods will be rescheduled onto another node. Note that when
560
+ * there is not enough space to reschedule all the pods (such as in a one-node
561
+ * cluster, or with specific constraints), disruption of your applications may
562
+ * occur.
561
563
  *
562
564
  * @param request - The request {@link DeleteNodeRequest}
563
565
  * @returns A Promise of Node
@@ -53,8 +53,8 @@ export declare class API extends ParentAPI {
53
53
  updateCluster: (request: Readonly<UpdateClusterRequest>) => Promise<Cluster>;
54
54
  /**
55
55
  * Delete a Cluster. Delete a specific Kubernetes cluster and all its
56
- * associated pools and nodes. Note that this method will not delete any Load
57
- * Balancer or Block Volume that are associated with the cluster.
56
+ * associated pools and nodes, and possibly its associated Load Balancers or
57
+ * Block Volumes.
58
58
  *
59
59
  * @param request - The request {@link DeleteClusterRequest}
60
60
  * @returns A Promise of Cluster
@@ -71,8 +71,7 @@ export declare class API extends ParentAPI {
71
71
  /**
72
72
  * Change the Cluster type. Change the type of a specific Kubernetes cluster.
73
73
  * To see the possible values you can enter for the `type` field, [list
74
- * available cluster
75
- * types](#path-clusters-list-available-cluster-types-for-a-cluster).
74
+ * available cluster types](#list-available-cluster-types-for-a-cluster).
76
75
  *
77
76
  * @param request - The request {@link SetClusterTypeRequest}
78
77
  * @returns A Promise of Cluster
@@ -102,7 +101,7 @@ export declare class API extends ParentAPI {
102
101
  * Reset the admin token of a Cluster. Reset the admin token for a specific
103
102
  * Kubernetes cluster. This will revoke the old admin token (which will not be
104
103
  * usable afterwards) and create a new one. Note that you will need to
105
- * download kubeconfig again to keep interacting with the cluster.
104
+ * download the kubeconfig again to keep interacting with the cluster.
106
105
  *
107
106
  * @param request - The request {@link ResetClusterAdminTokenRequest}
108
107
  */
@@ -110,7 +109,8 @@ export declare class API extends ParentAPI {
110
109
  /**
111
110
  * Migrate a cluster to SBS CSI. Enable the latest CSI compatible with
112
111
  * Scaleway Block Storage (SBS) and migrate all existing
113
- * PersistentVolumes/VolumeSnapshotContents to SBS.
112
+ * PersistentVolumes/VolumeSnapshotContents to SBS. Make sure to have the
113
+ * necessary Quota before running this command.
114
114
  *
115
115
  * @param request - The request {@link MigrateClusterToSBSCSIRequest}
116
116
  * @returns A Promise of Cluster
@@ -186,7 +186,7 @@ export declare class API extends ParentAPI {
186
186
  /**
187
187
  * Upgrade a Pool in a Cluster. Upgrade the Kubernetes version of a specific
188
188
  * pool. Note that it only works if the targeted version matches the cluster's
189
- * version.
189
+ * version. This will drain and replace the nodes in that pool.
190
190
  *
191
191
  * @param request - The request {@link UpgradePoolRequest}
192
192
  * @returns A Promise of Pool
@@ -194,7 +194,8 @@ export declare class API extends ParentAPI {
194
194
  upgradePool: (request: Readonly<UpgradePoolRequest>) => Promise<Pool>;
195
195
  /**
196
196
  * Update a Pool in a Cluster. Update the attributes of a specific pool, such
197
- * as its desired size, autoscaling settings, and tags.
197
+ * as its desired size, autoscaling settings, and tags. To upgrade a pool, you
198
+ * will need to use the dedicated endpoint.
198
199
  *
199
200
  * @param request - The request {@link UpdatePoolRequest}
200
201
  * @returns A Promise of Pool
@@ -264,11 +265,10 @@ export declare class API extends ParentAPI {
264
265
  waitForNode: (request: Readonly<GetNodeRequest>, options?: Readonly<WaitForOptions<Node>>) => Promise<Node>;
265
266
  /**
266
267
  * Replace a Node in a Cluster. Replace a specific Node. The node will first
267
- * be cordoned (scheduling will be disabled on it). The existing pods on the
268
- * node will then be drained and rescheduled onto another schedulable node.
269
- * Note that when there is not enough space to reschedule all the pods (such
270
- * as in a one-node cluster), disruption of your applications can be
271
- * expected.
268
+ * be drained and pods will be rescheduled onto another node. Note that when
269
+ * there is not enough space to reschedule all the pods (such as in a one-node
270
+ * cluster, or with specific constraints), disruption of your applications may
271
+ * occur.
272
272
  *
273
273
  * @deprecated
274
274
  * @param request - The request {@link ReplaceNodeRequest}
@@ -277,19 +277,21 @@ export declare class API extends ParentAPI {
277
277
  replaceNode: (request: Readonly<ReplaceNodeRequest>) => Promise<Node>;
278
278
  /**
279
279
  * Reboot a Node in a Cluster. Reboot a specific Node. The node will first be
280
- * cordoned (scheduling will be disabled on it). The existing pods on the node
281
- * will then be drained and rescheduled onto another schedulable node. Note
282
- * that when there is not enough space to reschedule all the pods (such as in
283
- * a one-node cluster), disruption of your applications can be expected.
280
+ * drained and pods will be rescheduled onto another node. Note that when
281
+ * there is not enough space to reschedule all the pods (such as in a one-node
282
+ * cluster, or with specific constraints), disruption of your applications may
283
+ * occur.
284
284
  *
285
285
  * @param request - The request {@link RebootNodeRequest}
286
286
  * @returns A Promise of Node
287
287
  */
288
288
  rebootNode: (request: Readonly<RebootNodeRequest>) => Promise<Node>;
289
289
  /**
290
- * Delete a Node in a Cluster. Delete a specific Node. Note that when there is
291
- * not enough space to reschedule all the pods (such as in a one-node
292
- * cluster), disruption of your applications can be expected.
290
+ * Delete a Node in a Cluster. Delete a specific Node. The node will first be
291
+ * drained and pods will be rescheduled onto another node. Note that when
292
+ * there is not enough space to reschedule all the pods (such as in a one-node
293
+ * cluster, or with specific constraints), disruption of your applications may
294
+ * occur.
293
295
  *
294
296
  * @param request - The request {@link DeleteNodeRequest}
295
297
  * @returns A Promise of Node
@@ -103,8 +103,8 @@ class API extends API$1 {
103
103
  );
104
104
  /**
105
105
  * Delete a Cluster. Delete a specific Kubernetes cluster and all its
106
- * associated pools and nodes. Note that this method will not delete any Load
107
- * Balancer or Block Volume that are associated with the cluster.
106
+ * associated pools and nodes, and possibly its associated Load Balancers or
107
+ * Block Volumes.
108
108
  *
109
109
  * @param request - The request {@link DeleteClusterRequest}
110
110
  * @returns A Promise of Cluster
@@ -141,8 +141,7 @@ class API extends API$1 {
141
141
  /**
142
142
  * Change the Cluster type. Change the type of a specific Kubernetes cluster.
143
143
  * To see the possible values you can enter for the `type` field, [list
144
- * available cluster
145
- * types](#path-clusters-list-available-cluster-types-for-a-cluster).
144
+ * available cluster types](#list-available-cluster-types-for-a-cluster).
146
145
  *
147
146
  * @param request - The request {@link SetClusterTypeRequest}
148
147
  * @returns A Promise of Cluster
@@ -199,7 +198,7 @@ class API extends API$1 {
199
198
  * Reset the admin token of a Cluster. Reset the admin token for a specific
200
199
  * Kubernetes cluster. This will revoke the old admin token (which will not be
201
200
  * usable afterwards) and create a new one. Note that you will need to
202
- * download kubeconfig again to keep interacting with the cluster.
201
+ * download the kubeconfig again to keep interacting with the cluster.
203
202
  *
204
203
  * @param request - The request {@link ResetClusterAdminTokenRequest}
205
204
  */
@@ -212,7 +211,8 @@ class API extends API$1 {
212
211
  /**
213
212
  * Migrate a cluster to SBS CSI. Enable the latest CSI compatible with
214
213
  * Scaleway Block Storage (SBS) and migrate all existing
215
- * PersistentVolumes/VolumeSnapshotContents to SBS.
214
+ * PersistentVolumes/VolumeSnapshotContents to SBS. Make sure to have the
215
+ * necessary Quota before running this command.
216
216
  *
217
217
  * @param request - The request {@link MigrateClusterToSBSCSIRequest}
218
218
  * @returns A Promise of Cluster
@@ -363,7 +363,7 @@ class API extends API$1 {
363
363
  /**
364
364
  * Upgrade a Pool in a Cluster. Upgrade the Kubernetes version of a specific
365
365
  * pool. Note that it only works if the targeted version matches the cluster's
366
- * version.
366
+ * version. This will drain and replace the nodes in that pool.
367
367
  *
368
368
  * @param request - The request {@link UpgradePoolRequest}
369
369
  * @returns A Promise of Pool
@@ -381,7 +381,8 @@ class API extends API$1 {
381
381
  );
382
382
  /**
383
383
  * Update a Pool in a Cluster. Update the attributes of a specific pool, such
384
- * as its desired size, autoscaling settings, and tags.
384
+ * as its desired size, autoscaling settings, and tags. To upgrade a pool, you
385
+ * will need to use the dedicated endpoint.
385
386
  *
386
387
  * @param request - The request {@link UpdatePoolRequest}
387
388
  * @returns A Promise of Pool
@@ -514,11 +515,10 @@ class API extends API$1 {
514
515
  );
515
516
  /**
516
517
  * Replace a Node in a Cluster. Replace a specific Node. The node will first
517
- * be cordoned (scheduling will be disabled on it). The existing pods on the
518
- * node will then be drained and rescheduled onto another schedulable node.
519
- * Note that when there is not enough space to reschedule all the pods (such
520
- * as in a one-node cluster), disruption of your applications can be
521
- * expected.
518
+ * be drained and pods will be rescheduled onto another node. Note that when
519
+ * there is not enough space to reschedule all the pods (such as in a one-node
520
+ * cluster, or with specific constraints), disruption of your applications may
521
+ * occur.
522
522
  *
523
523
  * @deprecated
524
524
  * @param request - The request {@link ReplaceNodeRequest}
@@ -535,10 +535,10 @@ class API extends API$1 {
535
535
  );
536
536
  /**
537
537
  * Reboot a Node in a Cluster. Reboot a specific Node. The node will first be
538
- * cordoned (scheduling will be disabled on it). The existing pods on the node
539
- * will then be drained and rescheduled onto another schedulable node. Note
540
- * that when there is not enough space to reschedule all the pods (such as in
541
- * a one-node cluster), disruption of your applications can be expected.
538
+ * drained and pods will be rescheduled onto another node. Note that when
539
+ * there is not enough space to reschedule all the pods (such as in a one-node
540
+ * cluster, or with specific constraints), disruption of your applications may
541
+ * occur.
542
542
  *
543
543
  * @param request - The request {@link RebootNodeRequest}
544
544
  * @returns A Promise of Node
@@ -553,9 +553,11 @@ class API extends API$1 {
553
553
  unmarshalNode
554
554
  );
555
555
  /**
556
- * Delete a Node in a Cluster. Delete a specific Node. Note that when there is
557
- * not enough space to reschedule all the pods (such as in a one-node
558
- * cluster), disruption of your applications can be expected.
556
+ * Delete a Node in a Cluster. Delete a specific Node. The node will first be
557
+ * drained and pods will be rescheduled onto another node. Note that when
558
+ * there is not enough space to reschedule all the pods (such as in a one-node
559
+ * cluster, or with specific constraints), disruption of your applications may
560
+ * occur.
559
561
  *
560
562
  * @param request - The request {@link DeleteNodeRequest}
561
563
  * @returns A Promise of Node