@scaleway/sdk 2.72.0 → 2.73.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 (146) hide show
  1. package/dist/api/account/v3/api.gen.cjs +13 -32
  2. package/dist/api/account/v3/api.gen.d.ts +17 -36
  3. package/dist/api/account/v3/api.gen.js +13 -32
  4. package/dist/api/account/v3/types.gen.d.ts +187 -85
  5. package/dist/api/applesilicon/v1alpha1/api.gen.cjs +19 -46
  6. package/dist/api/applesilicon/v1alpha1/api.gen.d.ts +24 -49
  7. package/dist/api/applesilicon/v1alpha1/api.gen.js +19 -46
  8. package/dist/api/applesilicon/v1alpha1/types.gen.d.ts +310 -135
  9. package/dist/api/audit_trail/v1alpha1/api.gen.cjs +2 -5
  10. package/dist/api/audit_trail/v1alpha1/api.gen.d.ts +4 -8
  11. package/dist/api/audit_trail/v1alpha1/api.gen.js +2 -5
  12. package/dist/api/audit_trail/v1alpha1/types.gen.d.ts +110 -82
  13. package/dist/api/baremetal/v1/api.gen.cjs +28 -61
  14. package/dist/api/baremetal/v1/api.gen.d.ts +29 -60
  15. package/dist/api/baremetal/v1/api.gen.js +28 -61
  16. package/dist/api/baremetal/v1/types.gen.d.ts +802 -315
  17. package/dist/api/baremetal/v3/api.gen.cjs +7 -14
  18. package/dist/api/baremetal/v3/api.gen.d.ts +10 -15
  19. package/dist/api/baremetal/v3/api.gen.js +7 -14
  20. package/dist/api/baremetal/v3/types.gen.d.ts +82 -32
  21. package/dist/api/billing/v2beta1/api.gen.cjs +11 -20
  22. package/dist/api/billing/v2beta1/api.gen.d.ts +9 -19
  23. package/dist/api/billing/v2beta1/api.gen.js +11 -20
  24. package/dist/api/billing/v2beta1/types.gen.d.ts +231 -102
  25. package/dist/api/block/v1/api.gen.cjs +37 -55
  26. package/dist/api/block/v1/api.gen.d.ts +19 -37
  27. package/dist/api/block/v1/api.gen.js +37 -55
  28. package/dist/api/block/v1/types.gen.d.ts +306 -125
  29. package/dist/api/block/v1alpha1/api.gen.cjs +45 -64
  30. package/dist/api/block/v1alpha1/api.gen.d.ts +22 -41
  31. package/dist/api/block/v1alpha1/api.gen.js +45 -64
  32. package/dist/api/block/v1alpha1/types.gen.d.ts +327 -132
  33. package/dist/api/cockpit/v1/api.gen.cjs +100 -156
  34. package/dist/api/cockpit/v1/api.gen.d.ts +53 -112
  35. package/dist/api/cockpit/v1/api.gen.js +100 -156
  36. package/dist/api/cockpit/v1/types.gen.d.ts +567 -246
  37. package/dist/api/container/v1beta1/api.gen.cjs +7 -14
  38. package/dist/api/container/v1beta1/api.gen.d.ts +9 -16
  39. package/dist/api/container/v1beta1/api.gen.js +7 -14
  40. package/dist/api/container/v1beta1/types.gen.d.ts +648 -322
  41. package/dist/api/dedibox/v1/api.gen.cjs +45 -69
  42. package/dist/api/dedibox/v1/api.gen.d.ts +52 -62
  43. package/dist/api/dedibox/v1/api.gen.js +45 -69
  44. package/dist/api/dedibox/v1/types.gen.d.ts +1765 -645
  45. package/dist/api/domain/v2beta1/api.gen.cjs +119 -178
  46. package/dist/api/domain/v2beta1/api.gen.d.ts +71 -130
  47. package/dist/api/domain/v2beta1/api.gen.js +119 -178
  48. package/dist/api/domain/v2beta1/content.gen.d.ts +1 -4
  49. package/dist/api/domain/v2beta1/types.gen.d.ts +411 -199
  50. package/dist/api/flexibleip/v1alpha1/api.gen.cjs +10 -25
  51. package/dist/api/flexibleip/v1alpha1/api.gen.d.ts +12 -28
  52. package/dist/api/flexibleip/v1alpha1/api.gen.js +10 -25
  53. package/dist/api/flexibleip/v1alpha1/types.gen.d.ts +186 -78
  54. package/dist/api/inference/v1/api.gen.cjs +8 -11
  55. package/dist/api/inference/v1/api.gen.d.ts +6 -9
  56. package/dist/api/inference/v1/api.gen.js +8 -11
  57. package/dist/api/inference/v1/types.gen.d.ts +330 -150
  58. package/dist/api/inference/v1beta1/api.gen.cjs +8 -11
  59. package/dist/api/inference/v1beta1/api.gen.d.ts +6 -9
  60. package/dist/api/inference/v1beta1/api.gen.js +8 -11
  61. package/dist/api/inference/v1beta1/types.gen.d.ts +341 -154
  62. package/dist/api/instance/v1/api.gen.cjs +64 -113
  63. package/dist/api/instance/v1/api.gen.d.ts +54 -103
  64. package/dist/api/instance/v1/api.gen.js +64 -113
  65. package/dist/api/instance/v1/types.gen.d.ts +1351 -598
  66. package/dist/api/instance/v1/types.private.gen.d.ts +131 -59
  67. package/dist/api/interlink/v1beta1/api.gen.cjs +21 -67
  68. package/dist/api/interlink/v1beta1/api.gen.d.ts +23 -70
  69. package/dist/api/interlink/v1beta1/api.gen.js +21 -67
  70. package/dist/api/interlink/v1beta1/marshalling.gen.cjs +2 -0
  71. package/dist/api/interlink/v1beta1/marshalling.gen.js +2 -0
  72. package/dist/api/interlink/v1beta1/types.gen.d.ts +464 -216
  73. package/dist/api/interlink/v1beta1/validation-rules.gen.cjs +8 -0
  74. package/dist/api/interlink/v1beta1/validation-rules.gen.d.ts +8 -0
  75. package/dist/api/interlink/v1beta1/validation-rules.gen.js +8 -0
  76. package/dist/api/iot/v1/api.gen.cjs +37 -70
  77. package/dist/api/iot/v1/api.gen.d.ts +34 -67
  78. package/dist/api/iot/v1/api.gen.js +37 -70
  79. package/dist/api/iot/v1/types.gen.d.ts +566 -321
  80. package/dist/api/ipam/v1/api.gen.cjs +6 -26
  81. package/dist/api/ipam/v1/api.gen.d.ts +8 -29
  82. package/dist/api/ipam/v1/api.gen.js +6 -26
  83. package/dist/api/ipam/v1/types.gen.d.ts +146 -105
  84. package/dist/api/jobs/v1alpha1/api.gen.cjs +2 -4
  85. package/dist/api/jobs/v1alpha1/api.gen.d.ts +4 -6
  86. package/dist/api/jobs/v1alpha1/api.gen.js +2 -4
  87. package/dist/api/jobs/v1alpha1/types.gen.d.ts +165 -91
  88. package/dist/api/k8s/v1/api.gen.cjs +33 -78
  89. package/dist/api/k8s/v1/api.gen.d.ts +27 -72
  90. package/dist/api/k8s/v1/api.gen.js +33 -78
  91. package/dist/api/k8s/v1/types.gen.d.ts +743 -506
  92. package/dist/api/key_manager/v1alpha1/api.gen.cjs +21 -57
  93. package/dist/api/key_manager/v1alpha1/api.gen.d.ts +19 -56
  94. package/dist/api/key_manager/v1alpha1/api.gen.js +21 -57
  95. package/dist/api/key_manager/v1alpha1/types.gen.d.ts +196 -114
  96. package/dist/api/marketplace/v2/api.gen.cjs +8 -21
  97. package/dist/api/marketplace/v2/api.gen.d.ts +10 -24
  98. package/dist/api/marketplace/v2/api.gen.js +8 -21
  99. package/dist/api/marketplace/v2/types.gen.d.ts +94 -41
  100. package/dist/api/mnq/v1beta1/api.gen.cjs +24 -76
  101. package/dist/api/mnq/v1beta1/api.gen.d.ts +30 -82
  102. package/dist/api/mnq/v1beta1/api.gen.js +24 -76
  103. package/dist/api/mnq/v1beta1/types.gen.d.ts +342 -169
  104. package/dist/api/mongodb/v1alpha1/api.gen.cjs +19 -62
  105. package/dist/api/mongodb/v1alpha1/api.gen.d.ts +21 -64
  106. package/dist/api/mongodb/v1alpha1/api.gen.js +19 -62
  107. package/dist/api/mongodb/v1alpha1/types.gen.d.ts +443 -189
  108. package/dist/api/qaas/v1alpha1/api.gen.cjs +17 -34
  109. package/dist/api/qaas/v1alpha1/api.gen.d.ts +19 -36
  110. package/dist/api/qaas/v1alpha1/api.gen.js +17 -34
  111. package/dist/api/qaas/v1alpha1/types.gen.d.ts +502 -174
  112. package/dist/api/rdb/v1/api.gen.cjs +62 -202
  113. package/dist/api/rdb/v1/api.gen.d.ts +60 -201
  114. package/dist/api/rdb/v1/api.gen.js +62 -202
  115. package/dist/api/rdb/v1/types.gen.d.ts +1005 -524
  116. package/dist/api/redis/v1/api.gen.cjs +23 -83
  117. package/dist/api/redis/v1/api.gen.d.ts +25 -85
  118. package/dist/api/redis/v1/api.gen.js +23 -83
  119. package/dist/api/redis/v1/types.gen.d.ts +447 -170
  120. package/dist/api/registry/v1/api.gen.cjs +12 -40
  121. package/dist/api/registry/v1/api.gen.d.ts +14 -42
  122. package/dist/api/registry/v1/api.gen.js +12 -40
  123. package/dist/api/registry/v1/types.gen.d.ts +200 -116
  124. package/dist/api/secret/v1beta1/api.gen.cjs +19 -47
  125. package/dist/api/secret/v1beta1/api.gen.d.ts +21 -51
  126. package/dist/api/secret/v1beta1/api.gen.js +19 -47
  127. package/dist/api/secret/v1beta1/types.gen.d.ts +359 -224
  128. package/dist/api/serverless_sqldb/v1alpha1/api.gen.cjs +9 -27
  129. package/dist/api/serverless_sqldb/v1alpha1/api.gen.d.ts +11 -29
  130. package/dist/api/serverless_sqldb/v1alpha1/api.gen.js +9 -27
  131. package/dist/api/serverless_sqldb/v1alpha1/types.gen.d.ts +168 -76
  132. package/dist/api/tem/v1alpha1/api.gen.cjs +22 -58
  133. package/dist/api/tem/v1alpha1/api.gen.d.ts +24 -60
  134. package/dist/api/tem/v1alpha1/api.gen.js +22 -58
  135. package/dist/api/tem/v1alpha1/types.gen.d.ts +761 -338
  136. package/dist/api/test/v1/api.gen.cjs +8 -11
  137. package/dist/api/test/v1/api.gen.d.ts +6 -9
  138. package/dist/api/test/v1/api.gen.js +8 -11
  139. package/dist/api/test/v1/types.gen.d.ts +21 -10
  140. package/dist/client/dist/package.json.cjs +1 -1
  141. package/dist/client/dist/package.json.js +1 -1
  142. package/node_modules/@scaleway/sdk-client/dist/package.json.cjs +1 -1
  143. package/node_modules/@scaleway/sdk-client/dist/package.json.js +1 -1
  144. package/node_modules/@scaleway/sdk-client/package.json +1 -2
  145. package/package.json +2 -2
  146. package/node_modules/@scaleway/sdk-client/LICENSE +0 -191
@@ -14,9 +14,13 @@ export type PoolStatus = 'unknown' | 'ready' | 'deleting' | 'deleted' | 'scaling
14
14
  export type PoolVolumeType = 'default_volume_type' | 'l_ssd' | 'b_ssd' | 'sbs_5k' | 'sbs_15k';
15
15
  export type Runtime = 'unknown_runtime' | 'docker' | 'containerd' | 'crio';
16
16
  export interface MaintenanceWindow {
17
- /** Start time of the two-hour maintenance window. */
17
+ /**
18
+ * Start time of the two-hour maintenance window.
19
+ */
18
20
  startHour: number;
19
- /** Day of the week for the maintenance window. */
21
+ /**
22
+ * Day of the week for the maintenance window.
23
+ */
20
24
  day: MaintenanceWindowDayOfTheWeek;
21
25
  }
22
26
  export interface PoolUpgradePolicy {
@@ -24,174 +28,192 @@ export interface PoolUpgradePolicy {
24
28
  maxSurge: number;
25
29
  }
26
30
  export interface CreateClusterRequestPoolConfigUpgradePolicy {
27
- /** The maximum number of nodes that can be not ready at the same time. */
31
+ /**
32
+ * The maximum number of nodes that can be not ready at the same time.
33
+ */
28
34
  maxUnavailable?: number;
29
- /** The maximum number of nodes to be created during the upgrade. */
35
+ /**
36
+ * The maximum number of nodes to be created during the upgrade.
37
+ */
30
38
  maxSurge?: number;
31
39
  }
32
40
  export interface ClusterAutoUpgrade {
33
- /** Defines whether auto upgrade is enabled for the cluster. */
41
+ /**
42
+ * Defines whether auto upgrade is enabled for the cluster.
43
+ */
34
44
  enabled: boolean;
35
- /** Maintenance window of the cluster auto upgrades. */
45
+ /**
46
+ * Maintenance window of the cluster auto upgrades.
47
+ */
36
48
  maintenanceWindow?: MaintenanceWindow;
37
49
  }
38
50
  export interface ClusterAutoscalerConfig {
39
- /** Disable the cluster autoscaler. */
51
+ /**
52
+ * Disable the cluster autoscaler.
53
+ */
40
54
  scaleDownDisabled: boolean;
41
- /** How long after scale up the scale down evaluation resumes. */
55
+ /**
56
+ * How long after scale up the scale down evaluation resumes.
57
+ */
42
58
  scaleDownDelayAfterAdd: string;
43
- /** Type of resource estimator to be used in scale up. */
59
+ /**
60
+ * Type of resource estimator to be used in scale up.
61
+ */
44
62
  estimator: AutoscalerEstimator;
45
- /** Type of node group expander to be used in scale up. */
63
+ /**
64
+ * Type of node group expander to be used in scale up.
65
+ */
46
66
  expander: AutoscalerExpander;
47
67
  /**
48
- * Ignore DaemonSet pods when calculating resource utilization for scaling
49
- * down.
68
+ * Ignore DaemonSet pods when calculating resource utilization for scaling down.
50
69
  */
51
70
  ignoreDaemonsetsUtilization: boolean;
52
- /** Detect similar node groups and balance the number of nodes between them. */
71
+ /**
72
+ * Detect similar node groups and balance the number of nodes between them.
73
+ */
53
74
  balanceSimilarNodeGroups: boolean;
54
75
  /**
55
- * Pods with priority below cutoff will be expendable. They can be killed
56
- * without any consideration during scale down and they won't cause scale up.
57
- * Pods with null priority (PodPriority disabled) are non expendable.
76
+ * Pods with priority below cutoff will be expendable. They can be killed without any consideration during scale down and they won't cause scale up. Pods with null priority (PodPriority disabled) are non expendable.
58
77
  */
59
78
  expendablePodsPriorityCutoff: number;
60
- /** How long a node should be unneeded before it is eligible to be scaled down. */
79
+ /**
80
+ * How long a node should be unneeded before it is eligible to be scaled down.
81
+ */
61
82
  scaleDownUnneededTime: string;
62
83
  /**
63
- * Node utilization level, defined as a sum of requested resources divided by
64
- * capacity, below which a node can be considered for scale down.
84
+ * Node utilization level, defined as a sum of requested resources divided by capacity, below which a node can be considered for scale down.
65
85
  */
66
86
  scaleDownUtilizationThreshold: number;
67
87
  /**
68
- * Maximum number of seconds the cluster autoscaler waits for pod termination
69
- * when trying to scale down a node.
88
+ * Maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node.
70
89
  */
71
90
  maxGracefulTerminationSec: number;
72
91
  }
73
92
  export interface ClusterOpenIDConnectConfig {
74
93
  /**
75
- * URL of the provider which allows the API server to discover public signing
76
- * keys. Only URLs using the `https://` scheme are accepted. This is typically
77
- * the provider's discovery URL without a path, for example
78
- * "https://accounts.google.com" or "https://login.salesforce.com".
94
+ * URL of the provider which allows the API server to discover public signing keys. Only URLs using the `https://` scheme are accepted. This is typically the provider's discovery URL without a path, for example "https://accounts.google.com" or "https://login.salesforce.com".
79
95
  */
80
96
  issuerUrl: string;
81
- /** A client ID that all tokens must be issued for. */
97
+ /**
98
+ * A client ID that all tokens must be issued for.
99
+ */
82
100
  clientId: string;
83
101
  /**
84
- * JWT claim to use as the user name. The default is `sub`, which is expected
85
- * to be the end user's unique identifier. Admins can choose other claims,
86
- * such as `email` or `name`, depending on their provider. However, claims
87
- * other than `email` will be prefixed with the issuer URL to prevent name
88
- * collision.
102
+ * JWT claim to use as the user name. The default is `sub`, which is expected to be the end user's unique identifier. Admins can choose other claims, such as `email` or `name`, depending on their provider. However, claims other than `email` will be prefixed with the issuer URL to prevent name collision.
89
103
  */
90
104
  usernameClaim: string;
91
105
  /**
92
- * Prefix prepended to username claims to prevent name collision (such as
93
- * `system:` users). For example, the value `oidc:` will create usernames like
94
- * `oidc:jane.doe`. If this flag is not provided and `username_claim` is a
95
- * value other than `email`, the prefix defaults to `( Issuer URL )#` where `(
96
- * Issuer URL )` is the value of `issuer_url`. The value `-` can be used to
97
- * disable all prefixing.
106
+ * Prefix prepended to username claims to prevent name collision (such as `system:` users). For example, the value `oidc:` will create usernames like `oidc:jane.doe`. If this flag is not provided and `username_claim` is a value other than `email`, the prefix defaults to `( Issuer URL )#` where `( Issuer URL )` is the value of `issuer_url`. The value `-` can be used to disable all prefixing.
98
107
  */
99
108
  usernamePrefix: string;
100
- /** JWT claim to use as the user's group. */
109
+ /**
110
+ * JWT claim to use as the user's group.
111
+ */
101
112
  groupsClaim: string[];
102
113
  /**
103
- * Prefix prepended to group claims to prevent name collision (such as
104
- * `system:` groups). For example, the value `oidc:` will create group names
105
- * like `oidc:engineering` and `oidc:infra`.
114
+ * Prefix prepended to group claims to prevent name collision (such as `system:` groups). For example, the value `oidc:` will create group names like `oidc:engineering` and `oidc:infra`.
106
115
  */
107
116
  groupsPrefix: string;
108
117
  /**
109
- * Multiple key=value pairs describing a required claim in the ID token. If
110
- * set, the claims are verified to be present in the ID token with a matching
111
- * value.
118
+ * Multiple key=value pairs describing a required claim in the ID token. If set, the claims are verified to be present in the ID token with a matching value.
112
119
  */
113
120
  requiredClaim: string[];
114
121
  }
115
122
  export interface Pool {
116
- /** Pool ID. */
123
+ /**
124
+ * Pool ID.
125
+ */
117
126
  id: string;
118
- /** Cluster ID of the pool. */
127
+ /**
128
+ * Cluster ID of the pool.
129
+ */
119
130
  clusterId: string;
120
- /** Date on which the pool was created. */
131
+ /**
132
+ * Date on which the pool was created.
133
+ */
121
134
  createdAt?: Date;
122
- /** Date on which the pool was last updated. */
135
+ /**
136
+ * Date on which the pool was last updated.
137
+ */
123
138
  updatedAt?: Date;
124
- /** Pool name. */
139
+ /**
140
+ * Pool name.
141
+ */
125
142
  name: string;
126
- /** Pool status. */
143
+ /**
144
+ * Pool status.
145
+ */
127
146
  status: PoolStatus;
128
- /** Pool version. */
147
+ /**
148
+ * Pool version.
149
+ */
129
150
  version: string;
130
151
  /**
131
- * Node type is the type of Scaleway Instance wanted for the pool. Nodes with
132
- * insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST).
133
- * 'external' is a special node type used to provision instances from other
134
- * cloud providers in a Kosmos Cluster.
152
+ * Node type is the type of Scaleway Instance wanted for the pool. Nodes with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). 'external' is a special node type used to provision instances from other cloud providers in a Kosmos Cluster.
135
153
  */
136
154
  nodeType: string;
137
- /** Defines whether the autoscaling feature is enabled for the pool. */
155
+ /**
156
+ * Defines whether the autoscaling feature is enabled for the pool.
157
+ */
138
158
  autoscaling: boolean;
139
- /** Size (number of nodes) of the pool. */
159
+ /**
160
+ * Size (number of nodes) of the pool.
161
+ */
140
162
  size: number;
141
163
  /**
142
- * Defines the minimum size of the pool. Note that this field is only used
143
- * when autoscaling is enabled on the pool.
164
+ * Defines the minimum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.
144
165
  */
145
166
  minSize: number;
146
167
  /**
147
- * Defines the maximum size of the pool. Note that this field is only used
148
- * when autoscaling is enabled on the pool.
168
+ * Defines the maximum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.
149
169
  */
150
170
  maxSize: number;
151
- /** Customization of the container runtime is available for each pool. */
171
+ /**
172
+ * Customization of the container runtime is available for each pool.
173
+ */
152
174
  containerRuntime: Runtime;
153
- /** Defines whether the autohealing feature is enabled for the pool. */
175
+ /**
176
+ * Defines whether the autohealing feature is enabled for the pool.
177
+ */
154
178
  autohealing: boolean;
155
179
  /**
156
- * Tags associated with the pool, see [managing
157
- * tags](https://www.scaleway.com/en/docs/containers/kubernetes/api-cli/managing-tags).
180
+ * Tags associated with the pool, see [managing tags](https://www.scaleway.com/en/docs/containers/kubernetes/api-cli/managing-tags).
158
181
  */
159
182
  tags: string[];
160
183
  /**
161
- * Placement group ID in which all the nodes of the pool will be created,
162
- * placement groups are limited to 20 instances.
184
+ * Placement group ID in which all the nodes of the pool will be created, placement groups are limited to 20 instances.
163
185
  */
164
186
  placementGroupId?: string;
165
187
  /**
166
- * Kubelet arguments to be used by this pool. Note that this feature is
167
- * experimental.
188
+ * Kubelet arguments to be used by this pool. Note that this feature is experimental.
168
189
  */
169
190
  kubeletArgs: Record<string, string>;
170
- /** Pool upgrade policy. */
191
+ /**
192
+ * Pool upgrade policy.
193
+ */
171
194
  upgradePolicy?: PoolUpgradePolicy;
172
- /** Zone in which the pool's nodes will be spawned. */
195
+ /**
196
+ * Zone in which the pool's nodes will be spawned.
197
+ */
173
198
  zone: ScwZone;
174
199
  /**
175
- * - `l_ssd` is a local block storage which means your system is stored locally
176
- * on your node's hypervisor. This type is not available for all node types
177
- * `sbs-5k` is a remote block storage which means your system is stored on a
178
- * centralized and resilient cluster with 5k IOPS limits `sbs-15k` is a
179
- * faster remote block storage which means your system is stored on a
180
- * centralized and resilient cluster with 15k IOPS limits `b_ssd` is the
181
- * legacy remote block storage which means your system is stored on a
182
- * centralized and resilient cluster. Consider using `sbs-5k` or `sbs-15k`
183
- * instead.
200
+ * * `l_ssd` is a local block storage which means your system is stored locally on your node's hypervisor. This type is not available for all node types
201
+ * `sbs-5k` is a remote block storage which means your system is stored on a centralized and resilient cluster with 5k IOPS limits
202
+ * `sbs-15k` is a faster remote block storage which means your system is stored on a centralized and resilient cluster with 15k IOPS limits
203
+ * `b_ssd` is the legacy remote block storage which means your system is stored on a centralized and resilient cluster. Consider using `sbs-5k` or `sbs-15k` instead.
184
204
  */
185
205
  rootVolumeType: PoolVolumeType;
186
- /** System volume disk size. */
206
+ /**
207
+ * System volume disk size.
208
+ */
187
209
  rootVolumeSize?: number;
188
210
  /**
189
- * Defines if the public IP should be removed from Nodes. To use this feature,
190
- * your Cluster must have an attached Private Network set up with a Public
191
- * Gateway.
211
+ * Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.
192
212
  */
193
213
  publicIpDisabled: boolean;
194
- /** Cluster region of the pool. */
214
+ /**
215
+ * Cluster region of the pool.
216
+ */
195
217
  region: ScwRegion;
196
218
  }
197
219
  export interface ACLRuleRequest {
@@ -207,11 +229,15 @@ export interface ACLRuleRequest {
207
229
  * One-of ('allowed'): at most one of 'ip', 'scalewayRanges' could be set.
208
230
  */
209
231
  scalewayRanges?: boolean;
210
- /** Description of the ACL. */
232
+ /**
233
+ * Description of the ACL.
234
+ */
211
235
  description: string;
212
236
  }
213
237
  export interface ACLRule {
214
- /** ID of the ACL rule. */
238
+ /**
239
+ * ID of the ACL rule.
240
+ */
215
241
  id: string;
216
242
  /**
217
243
  * IP subnet to allow.
@@ -225,157 +251,159 @@ export interface ACLRule {
225
251
  * One-of ('allowed'): at most one of 'ip', 'scalewayRanges' could be set.
226
252
  */
227
253
  scalewayRanges?: boolean;
228
- /** Description of the ACL. */
254
+ /**
255
+ * Description of the ACL.
256
+ */
229
257
  description: string;
230
258
  }
231
259
  export interface CreateClusterRequestAutoUpgrade {
232
- /** Defines whether auto upgrade is enabled for the cluster. */
260
+ /**
261
+ * Defines whether auto upgrade is enabled for the cluster.
262
+ */
233
263
  enable: boolean;
234
- /** Maintenance window of the cluster auto upgrades. */
264
+ /**
265
+ * Maintenance window of the cluster auto upgrades.
266
+ */
235
267
  maintenanceWindow?: MaintenanceWindow;
236
268
  }
237
269
  export interface CreateClusterRequestAutoscalerConfig {
238
- /** Disable the cluster autoscaler. */
270
+ /**
271
+ * Disable the cluster autoscaler.
272
+ */
239
273
  scaleDownDisabled?: boolean;
240
- /** How long after scale up the scale down evaluation resumes. */
274
+ /**
275
+ * How long after scale up the scale down evaluation resumes.
276
+ */
241
277
  scaleDownDelayAfterAdd?: string;
242
- /** Type of resource estimator to be used in scale up. */
278
+ /**
279
+ * Type of resource estimator to be used in scale up.
280
+ */
243
281
  estimator: AutoscalerEstimator;
244
- /** Type of node group expander to be used in scale up. */
282
+ /**
283
+ * Type of node group expander to be used in scale up.
284
+ */
245
285
  expander: AutoscalerExpander;
246
286
  /**
247
- * Ignore DaemonSet pods when calculating resource utilization for scaling
248
- * down.
287
+ * Ignore DaemonSet pods when calculating resource utilization for scaling down.
249
288
  */
250
289
  ignoreDaemonsetsUtilization?: boolean;
251
- /** Detect similar node groups and balance the number of nodes between them. */
290
+ /**
291
+ * Detect similar node groups and balance the number of nodes between them.
292
+ */
252
293
  balanceSimilarNodeGroups?: boolean;
253
294
  /**
254
- * Pods with priority below cutoff will be expendable. They can be killed
255
- * without any consideration during scale down and they won't cause scale up.
256
- * Pods with null priority (PodPriority disabled) are non expendable.
295
+ * Pods with priority below cutoff will be expendable. They can be killed without any consideration during scale down and they won't cause scale up. Pods with null priority (PodPriority disabled) are non expendable.
257
296
  */
258
297
  expendablePodsPriorityCutoff?: number;
259
- /** How long a node should be unneeded before it is eligible to be scaled down. */
298
+ /**
299
+ * How long a node should be unneeded before it is eligible to be scaled down.
300
+ */
260
301
  scaleDownUnneededTime?: string;
261
302
  /**
262
- * Node utilization level, defined as a sum of requested resources divided by
263
- * capacity, below which a node can be considered for scale down.
303
+ * Node utilization level, defined as a sum of requested resources divided by capacity, below which a node can be considered for scale down.
264
304
  */
265
305
  scaleDownUtilizationThreshold?: number;
266
306
  /**
267
- * Maximum number of seconds the cluster autoscaler waits for pod termination
268
- * when trying to scale down a node.
307
+ * Maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node.
269
308
  */
270
309
  maxGracefulTerminationSec?: number;
271
310
  }
272
311
  export interface CreateClusterRequestOpenIDConnectConfig {
273
312
  /**
274
- * URL of the provider which allows the API server to discover public signing
275
- * keys. Only URLs using the `https://` scheme are accepted. This is typically
276
- * the provider's discovery URL without a path, for example
277
- * "https://accounts.google.com" or "https://login.salesforce.com".
313
+ * URL of the provider which allows the API server to discover public signing keys. Only URLs using the `https://` scheme are accepted. This is typically the provider's discovery URL without a path, for example "https://accounts.google.com" or "https://login.salesforce.com".
278
314
  */
279
315
  issuerUrl: string;
280
- /** A client ID that all tokens must be issued for. */
316
+ /**
317
+ * A client ID that all tokens must be issued for.
318
+ */
281
319
  clientId: string;
282
320
  /**
283
- * JWT claim to use as the user name. The default is `sub`, which is expected
284
- * to be the end user's unique identifier. Admins can choose other claims,
285
- * such as `email` or `name`, depending on their provider. However, claims
286
- * other than `email` will be prefixed with the issuer URL to prevent name
287
- * collision.
321
+ * JWT claim to use as the user name. The default is `sub`, which is expected to be the end user's unique identifier. Admins can choose other claims, such as `email` or `name`, depending on their provider. However, claims other than `email` will be prefixed with the issuer URL to prevent name collision.
288
322
  */
289
323
  usernameClaim?: string;
290
324
  /**
291
- * Prefix prepended to username claims to prevent name collision (such as
292
- * `system:` users). For example, the value `oidc:` will create usernames like
293
- * `oidc:jane.doe`. If this flag is not provided and `username_claim` is a
294
- * value other than `email`, the prefix defaults to `( Issuer URL )#` where `(
295
- * Issuer URL )` is the value of `issuer_url`. The value `-` can be used to
296
- * disable all prefixing.
325
+ * Prefix prepended to username claims to prevent name collision (such as `system:` users). For example, the value `oidc:` will create usernames like `oidc:jane.doe`. If this flag is not provided and `username_claim` is a value other than `email`, the prefix defaults to `( Issuer URL )#` where `( Issuer URL )` is the value of `issuer_url`. The value `-` can be used to disable all prefixing.
297
326
  */
298
327
  usernamePrefix?: string;
299
- /** JWT claim to use as the user's group. */
328
+ /**
329
+ * JWT claim to use as the user's group.
330
+ */
300
331
  groupsClaim?: string[];
301
332
  /**
302
- * Prefix prepended to group claims to prevent name collision (such as
303
- * `system:` groups). For example, the value `oidc:` will create group names
304
- * like `oidc:engineering` and `oidc:infra`.
333
+ * Prefix prepended to group claims to prevent name collision (such as `system:` groups). For example, the value `oidc:` will create group names like `oidc:engineering` and `oidc:infra`.
305
334
  */
306
335
  groupsPrefix?: string;
307
336
  /**
308
- * Multiple key=value pairs describing a required claim in the ID token. If
309
- * set, the claims are verified to be present in the ID token with a matching
310
- * value.
337
+ * Multiple key=value pairs describing a required claim in the ID token. If set, the claims are verified to be present in the ID token with a matching value.
311
338
  */
312
339
  requiredClaim?: string[];
313
340
  }
314
341
  export interface CreateClusterRequestPoolConfig {
315
- /** Name of the pool. */
342
+ /**
343
+ * Name of the pool.
344
+ */
316
345
  name: string;
317
346
  /**
318
- * Node type is the type of Scaleway Instance wanted for the pool. Nodes with
319
- * insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST).
320
- * 'external' is a special node type used to provision instances from other
321
- * cloud providers in a Kosmos Cluster.
347
+ * Node type is the type of Scaleway Instance wanted for the pool. Nodes with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). 'external' is a special node type used to provision instances from other cloud providers in a Kosmos Cluster.
322
348
  */
323
349
  nodeType: string;
324
350
  /**
325
- * Placement group ID in which all the nodes of the pool will be created,
326
- * placement groups are limited to 20 instances.
351
+ * Placement group ID in which all the nodes of the pool will be created, placement groups are limited to 20 instances.
327
352
  */
328
353
  placementGroupId?: string;
329
- /** Defines whether the autoscaling feature is enabled for the pool. */
354
+ /**
355
+ * Defines whether the autoscaling feature is enabled for the pool.
356
+ */
330
357
  autoscaling: boolean;
331
- /** Size (number of nodes) of the pool. */
358
+ /**
359
+ * Size (number of nodes) of the pool.
360
+ */
332
361
  size: number;
333
362
  /**
334
- * Defines the minimum size of the pool. Note that this field is only used
335
- * when autoscaling is enabled on the pool.
363
+ * Defines the minimum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.
336
364
  */
337
365
  minSize?: number;
338
366
  /**
339
- * Defines the maximum size of the pool. Note that this field is only used
340
- * when autoscaling is enabled on the pool.
367
+ * Defines the maximum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.
341
368
  */
342
369
  maxSize?: number;
343
- /** Customization of the container runtime is available for each pool. */
370
+ /**
371
+ * Customization of the container runtime is available for each pool.
372
+ */
344
373
  containerRuntime: Runtime;
345
- /** Defines whether the autohealing feature is enabled for the pool. */
374
+ /**
375
+ * Defines whether the autohealing feature is enabled for the pool.
376
+ */
346
377
  autohealing: boolean;
347
378
  /**
348
- * Tags associated with the pool, see [managing
349
- * tags](https://www.scaleway.com/en/docs/containers/kubernetes/api-cli/managing-tags).
379
+ * Tags associated with the pool, see [managing tags](https://www.scaleway.com/en/docs/containers/kubernetes/api-cli/managing-tags).
350
380
  */
351
381
  tags: string[];
352
382
  /**
353
- * Kubelet arguments to be used by this pool. Note that this feature is
354
- * experimental.
383
+ * Kubelet arguments to be used by this pool. Note that this feature is experimental.
355
384
  */
356
385
  kubeletArgs: Record<string, string>;
357
- /** Pool upgrade policy. */
386
+ /**
387
+ * Pool upgrade policy.
388
+ */
358
389
  upgradePolicy?: CreateClusterRequestPoolConfigUpgradePolicy;
359
- /** Zone in which the pool's nodes will be spawned. */
390
+ /**
391
+ * Zone in which the pool's nodes will be spawned.
392
+ */
360
393
  zone: ScwZone;
361
394
  /**
362
- * - `l_ssd` is a local block storage which means your system is stored locally
363
- * on your node's hypervisor. This type is not available for all node types
364
- * `sbs-5k` is a remote block storage which means your system is stored on a
365
- * centralized and resilient cluster with 5k IOPS limits `sbs-15k` is a
366
- * faster remote block storage which means your system is stored on a
367
- * centralized and resilient cluster with 15k IOPS limits `b_ssd` is the
368
- * legacy remote block storage which means your system is stored on a
369
- * centralized and resilient cluster. Consider using `sbs-5k` or `sbs-15k`
370
- * instead.
395
+ * * `l_ssd` is a local block storage which means your system is stored locally on your node's hypervisor. This type is not available for all node types
396
+ * `sbs-5k` is a remote block storage which means your system is stored on a centralized and resilient cluster with 5k IOPS limits
397
+ * `sbs-15k` is a faster remote block storage which means your system is stored on a centralized and resilient cluster with 15k IOPS limits
398
+ * `b_ssd` is the legacy remote block storage which means your system is stored on a centralized and resilient cluster. Consider using `sbs-5k` or `sbs-15k` instead.
371
399
  */
372
400
  rootVolumeType: PoolVolumeType;
373
- /** System volume disk size. */
401
+ /**
402
+ * System volume disk size.
403
+ */
374
404
  rootVolumeSize?: number;
375
405
  /**
376
- * Defines if the public IP should be removed from Nodes. To use this feature,
377
- * your Cluster must have an attached Private Network set up with a Public
378
- * Gateway.
406
+ * Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.
379
407
  */
380
408
  publicIpDisabled: boolean;
381
409
  }
@@ -389,149 +417,243 @@ export interface ExternalNodeCoreV1Taint {
389
417
  effect: string;
390
418
  }
391
419
  export interface ClusterType {
392
- /** Cluster type name. */
420
+ /**
421
+ * Cluster type name.
422
+ */
393
423
  name: string;
394
- /** Cluster type availability. */
424
+ /**
425
+ * Cluster type availability.
426
+ */
395
427
  availability: ClusterTypeAvailability;
396
- /** Maximum number of nodes supported by the offer. */
428
+ /**
429
+ * Maximum number of nodes supported by the offer.
430
+ */
397
431
  maxNodes: number;
398
- /** Time period during which you can no longer switch to a lower offer. */
432
+ /**
433
+ * Time period during which you can no longer switch to a lower offer.
434
+ */
399
435
  commitmentDelay?: string;
400
- /** Value of the Service Level Agreement of the offer. */
436
+ /**
437
+ * Value of the Service Level Agreement of the offer.
438
+ */
401
439
  sla: number;
402
- /** Resiliency offered by the offer. */
440
+ /**
441
+ * Resiliency offered by the offer.
442
+ */
403
443
  resiliency: ClusterTypeResiliency;
404
- /** Max RAM allowed for the control plane. */
444
+ /**
445
+ * Max RAM allowed for the control plane.
446
+ */
405
447
  memory: number;
406
- /** Returns information if this offer uses dedicated resources. */
448
+ /**
449
+ * Returns information if this offer uses dedicated resources.
450
+ */
407
451
  dedicated: boolean;
408
452
  /**
409
- * True if the offer allows activation of the audit log functionality. Please
410
- * note that audit logs are sent to Cockpit.
453
+ * True if the offer allows activation of the audit log functionality. Please note that audit logs are sent to Cockpit.
411
454
  */
412
455
  auditLogsSupported: boolean;
413
- /** Maximum amount of data that can be stored in etcd for the offer. */
456
+ /**
457
+ * Maximum amount of data that can be stored in etcd for the offer.
458
+ */
414
459
  maxEtcdSize: number;
415
460
  }
416
461
  export interface Version {
417
- /** Name of the Kubernetes version. */
462
+ /**
463
+ * Name of the Kubernetes version.
464
+ */
418
465
  name: string;
419
- /** Label of the Kubernetes version. */
466
+ /**
467
+ * Label of the Kubernetes version.
468
+ */
420
469
  label: string;
421
- /** Region in which this version is available. */
470
+ /**
471
+ * Region in which this version is available.
472
+ */
422
473
  region: ScwRegion;
423
- /** Supported Container Network Interface (CNI) plugins for this version. */
474
+ /**
475
+ * Supported Container Network Interface (CNI) plugins for this version.
476
+ */
424
477
  availableCnis: CNI[];
425
- /** Supported container runtimes for this version. */
478
+ /**
479
+ * Supported container runtimes for this version.
480
+ */
426
481
  availableContainerRuntimes: Runtime[];
427
- /** Supported feature gates for this version. */
482
+ /**
483
+ * Supported feature gates for this version.
484
+ */
428
485
  availableFeatureGates: string[];
429
- /** Supported admission plugins for this version. */
486
+ /**
487
+ * Supported admission plugins for this version.
488
+ */
430
489
  availableAdmissionPlugins: string[];
431
- /** Supported kubelet arguments for this version. */
490
+ /**
491
+ * Supported kubelet arguments for this version.
492
+ */
432
493
  availableKubeletArgs: Record<string, string>;
433
494
  }
434
495
  export interface Cluster {
435
- /** Cluster ID. */
496
+ /**
497
+ * Cluster ID.
498
+ */
436
499
  id: string;
437
- /** Cluster type. */
500
+ /**
501
+ * Cluster type.
502
+ */
438
503
  type: string;
439
- /** Cluster name. */
504
+ /**
505
+ * Cluster name.
506
+ */
440
507
  name: string;
441
- /** Status of the cluster. */
508
+ /**
509
+ * Status of the cluster.
510
+ */
442
511
  status: ClusterStatus;
443
- /** Kubernetes version of the cluster. */
512
+ /**
513
+ * Kubernetes version of the cluster.
514
+ */
444
515
  version: string;
445
- /** Region in which the cluster is deployed. */
516
+ /**
517
+ * Region in which the cluster is deployed.
518
+ */
446
519
  region: ScwRegion;
447
- /** ID of the Organization owning the cluster. */
520
+ /**
521
+ * ID of the Organization owning the cluster.
522
+ */
448
523
  organizationId: string;
449
- /** ID of the Project owning the cluster. */
524
+ /**
525
+ * ID of the Project owning the cluster.
526
+ */
450
527
  projectId: string;
451
- /** Tags associated with the cluster. */
528
+ /**
529
+ * Tags associated with the cluster.
530
+ */
452
531
  tags: string[];
453
- /** Container Network Interface (CNI) plugin running in the cluster. */
532
+ /**
533
+ * Container Network Interface (CNI) plugin running in the cluster.
534
+ */
454
535
  cni: CNI;
455
- /** Cluster description. */
536
+ /**
537
+ * Cluster description.
538
+ */
456
539
  description: string;
457
- /** Kubernetes API server URL of the cluster. */
540
+ /**
541
+ * Kubernetes API server URL of the cluster.
542
+ */
458
543
  clusterUrl: string;
459
- /** Wildcard DNS resolving all the ready cluster nodes. */
544
+ /**
545
+ * Wildcard DNS resolving all the ready cluster nodes.
546
+ */
460
547
  dnsWildcard: string;
461
- /** Date on which the cluster was created. */
548
+ /**
549
+ * Date on which the cluster was created.
550
+ */
462
551
  createdAt?: Date;
463
- /** Date on which the cluster was last updated. */
552
+ /**
553
+ * Date on which the cluster was last updated.
554
+ */
464
555
  updatedAt?: Date;
465
- /** Autoscaler config for the cluster. */
556
+ /**
557
+ * Autoscaler config for the cluster.
558
+ */
466
559
  autoscalerConfig?: ClusterAutoscalerConfig;
467
- /** Auto upgrade Kubernetes version of the cluster. */
560
+ /**
561
+ * Auto upgrade Kubernetes version of the cluster.
562
+ */
468
563
  autoUpgrade?: ClusterAutoUpgrade;
469
- /** Defines whether a new Kubernetes version is available. */
564
+ /**
565
+ * Defines whether a new Kubernetes version is available.
566
+ */
470
567
  upgradeAvailable: boolean;
471
- /** List of enabled feature gates. */
568
+ /**
569
+ * List of enabled feature gates.
570
+ */
472
571
  featureGates: string[];
473
- /** List of enabled admission plugins. */
572
+ /**
573
+ * List of enabled admission plugins.
574
+ */
474
575
  admissionPlugins: string[];
475
576
  /**
476
- * This configuration enables to update the OpenID Connect configuration of
477
- * the Kubernetes API server.
577
+ * This configuration enables to update the OpenID Connect configuration of the Kubernetes API server.
478
578
  */
479
579
  openIdConnectConfig?: ClusterOpenIDConnectConfig;
480
580
  /**
481
- * Additional Subject Alternative Names for the Kubernetes API server
482
- * certificate.
581
+ * Additional Subject Alternative Names for the Kubernetes API server certificate.
483
582
  */
484
583
  apiserverCertSans: string[];
485
- /** Private network ID for internal cluster communication. */
584
+ /**
585
+ * Private network ID for internal cluster communication.
586
+ */
486
587
  privateNetworkId?: string;
487
- /** Date on which it will be possible to switch to a smaller offer. */
588
+ /**
589
+ * Date on which it will be possible to switch to a smaller offer.
590
+ */
488
591
  commitmentEndsAt?: Date;
489
592
  /**
490
- * @deprecated Defines whether the SBS-enabled CSI starting from v0.3 is
491
- * installed on the cluster.
593
+ * @deprecated Defines whether the SBS-enabled CSI starting from v0.3 is installed on the cluster.
492
594
  */
493
595
  sbsCsiEnabled?: boolean;
494
- /** @deprecated Defines whether ACL is available on the cluster. */
596
+ /**
597
+ * @deprecated Defines whether ACL is available on the cluster.
598
+ */
495
599
  aclAvailable?: boolean;
496
600
  /**
497
- * IAM group that nodes are members of (this field might be empty during early
498
- * stage of cluster creation).
601
+ * IAM group that nodes are members of (this field might be empty during early stage of cluster creation).
499
602
  */
500
603
  iamNodesGroupId: string;
501
604
  }
502
605
  export interface Node {
503
- /** Node ID. */
606
+ /**
607
+ * Node ID.
608
+ */
504
609
  id: string;
505
- /** Pool ID of the node. */
610
+ /**
611
+ * Pool ID of the node.
612
+ */
506
613
  poolId: string;
507
- /** Cluster ID of the node. */
614
+ /**
615
+ * Cluster ID of the node.
616
+ */
508
617
  clusterId: string;
509
618
  /**
510
- * Underlying instance ID. It is prefixed by instance type and location
511
- * information (see
512
- * https://pkg.go.dev/k8s.io/api/core/v1#NodeSpec.ProviderID).
619
+ * Underlying instance ID. It is prefixed by instance type and location information (see https://pkg.go.dev/k8s.io/api/core/v1#NodeSpec.ProviderID).
513
620
  */
514
621
  providerId: string;
515
- /** Cluster region of the node. */
622
+ /**
623
+ * Cluster region of the node.
624
+ */
516
625
  region: ScwRegion;
517
- /** Name of the node. */
626
+ /**
627
+ * Name of the node.
628
+ */
518
629
  name: string;
519
- /** @deprecated Public IPv4 address of the node. */
630
+ /**
631
+ * @deprecated Public IPv4 address of the node.
632
+ */
520
633
  publicIpV4?: string;
521
- /** @deprecated Public IPv6 address of the node. */
634
+ /**
635
+ * @deprecated Public IPv6 address of the node.
636
+ */
522
637
  publicIpV6?: string;
523
638
  /**
524
- * @deprecated Conditions of the node. These conditions contain the Node
525
- * Problem Detector conditions, as well as some in house conditions.
639
+ * @deprecated Conditions of the node. These conditions contain the Node Problem Detector conditions, as well as some in house conditions.
526
640
  */
527
641
  conditions?: Record<string, string>;
528
- /** Status of the node. */
642
+ /**
643
+ * Status of the node.
644
+ */
529
645
  status: NodeStatus;
530
- /** Details of the error, if any occurred when managing the node. */
646
+ /**
647
+ * Details of the error, if any occurred when managing the node.
648
+ */
531
649
  errorMessage?: string;
532
- /** Date on which the node was created. */
650
+ /**
651
+ * Date on which the node was created.
652
+ */
533
653
  createdAt?: Date;
534
- /** Date on which the node was last updated. */
654
+ /**
655
+ * Date on which the node was last updated.
656
+ */
535
657
  updatedAt?: Date;
536
658
  }
537
659
  export interface NodeMetadataCoreV1Taint {
@@ -540,85 +662,84 @@ export interface NodeMetadataCoreV1Taint {
540
662
  effect: string;
541
663
  }
542
664
  export interface UpdateClusterRequestAutoUpgrade {
543
- /** Defines whether auto upgrade is enabled for the cluster. */
665
+ /**
666
+ * Defines whether auto upgrade is enabled for the cluster.
667
+ */
544
668
  enable?: boolean;
545
- /** Maintenance window of the cluster auto upgrades. */
669
+ /**
670
+ * Maintenance window of the cluster auto upgrades.
671
+ */
546
672
  maintenanceWindow?: MaintenanceWindow;
547
673
  }
548
674
  export interface UpdateClusterRequestAutoscalerConfig {
549
- /** Disable the cluster autoscaler. */
675
+ /**
676
+ * Disable the cluster autoscaler.
677
+ */
550
678
  scaleDownDisabled?: boolean;
551
- /** How long after scale up the scale down evaluation resumes. */
679
+ /**
680
+ * How long after scale up the scale down evaluation resumes.
681
+ */
552
682
  scaleDownDelayAfterAdd?: string;
553
- /** Type of resource estimator to be used in scale up. */
683
+ /**
684
+ * Type of resource estimator to be used in scale up.
685
+ */
554
686
  estimator: AutoscalerEstimator;
555
- /** Type of node group expander to be used in scale up. */
687
+ /**
688
+ * Type of node group expander to be used in scale up.
689
+ */
556
690
  expander: AutoscalerExpander;
557
691
  /**
558
- * Ignore DaemonSet pods when calculating resource utilization for scaling
559
- * down.
692
+ * Ignore DaemonSet pods when calculating resource utilization for scaling down.
560
693
  */
561
694
  ignoreDaemonsetsUtilization?: boolean;
562
- /** Detect similar node groups and balance the number of nodes between them. */
695
+ /**
696
+ * Detect similar node groups and balance the number of nodes between them.
697
+ */
563
698
  balanceSimilarNodeGroups?: boolean;
564
699
  /**
565
- * Pods with priority below cutoff will be expendable. They can be killed
566
- * without any consideration during scale down and they won't cause scale up.
567
- * Pods with null priority (PodPriority disabled) are non expendable.
700
+ * Pods with priority below cutoff will be expendable. They can be killed without any consideration during scale down and they won't cause scale up. Pods with null priority (PodPriority disabled) are non expendable.
568
701
  */
569
702
  expendablePodsPriorityCutoff?: number;
570
- /** How long a node should be unneeded before it is eligible to be scaled down. */
703
+ /**
704
+ * How long a node should be unneeded before it is eligible to be scaled down.
705
+ */
571
706
  scaleDownUnneededTime?: string;
572
707
  /**
573
- * Node utilization level, defined as a sum of requested resources divided by
574
- * capacity, below which a node can be considered for scale down.
708
+ * Node utilization level, defined as a sum of requested resources divided by capacity, below which a node can be considered for scale down.
575
709
  */
576
710
  scaleDownUtilizationThreshold?: number;
577
711
  /**
578
- * Maximum number of seconds the cluster autoscaler waits for pod termination
579
- * when trying to scale down a node.
712
+ * Maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node.
580
713
  */
581
714
  maxGracefulTerminationSec?: number;
582
715
  }
583
716
  export interface UpdateClusterRequestOpenIDConnectConfig {
584
717
  /**
585
- * URL of the provider which allows the API server to discover public signing
586
- * keys. Only URLs using the `https://` scheme are accepted. This is typically
587
- * the provider's discovery URL without a path, for example
588
- * "https://accounts.google.com" or "https://login.salesforce.com".
718
+ * URL of the provider which allows the API server to discover public signing keys. Only URLs using the `https://` scheme are accepted. This is typically the provider's discovery URL without a path, for example "https://accounts.google.com" or "https://login.salesforce.com".
589
719
  */
590
720
  issuerUrl?: string;
591
- /** A client ID that all tokens must be issued for. */
721
+ /**
722
+ * A client ID that all tokens must be issued for.
723
+ */
592
724
  clientId?: string;
593
725
  /**
594
- * JWT claim to use as the user name. The default is `sub`, which is expected
595
- * to be the end user's unique identifier. Admins can choose other claims,
596
- * such as `email` or `name`, depending on their provider. However, claims
597
- * other than `email` will be prefixed with the issuer URL to prevent name
598
- * collision.
726
+ * JWT claim to use as the user name. The default is `sub`, which is expected to be the end user's unique identifier. Admins can choose other claims, such as `email` or `name`, depending on their provider. However, claims other than `email` will be prefixed with the issuer URL to prevent name collision.
599
727
  */
600
728
  usernameClaim?: string;
601
729
  /**
602
- * Prefix prepended to username claims to prevent name collision (such as
603
- * `system:` users). For example, the value `oidc:` will create usernames like
604
- * `oidc:jane.doe`. If this flag is not provided and `username_claim` is a
605
- * value other than `email`, the prefix defaults to `( Issuer URL )#` where `(
606
- * Issuer URL )` is the value of `issuer_url`. The value `-` can be used to
607
- * disable all prefixing.
730
+ * Prefix prepended to username claims to prevent name collision (such as `system:` users). For example, the value `oidc:` will create usernames like `oidc:jane.doe`. If this flag is not provided and `username_claim` is a value other than `email`, the prefix defaults to `( Issuer URL )#` where `( Issuer URL )` is the value of `issuer_url`. The value `-` can be used to disable all prefixing.
608
731
  */
609
732
  usernamePrefix?: string;
610
- /** JWT claim to use as the user's group. */
733
+ /**
734
+ * JWT claim to use as the user's group.
735
+ */
611
736
  groupsClaim?: string[];
612
737
  /**
613
- * Prefix prepended to group claims to prevent name collision (such as
614
- * `system:` groups). For example, the value `oidc:` will create group names
615
- * like `oidc:engineering` and `oidc:infra`.
738
+ * Prefix prepended to group claims to prevent name collision (such as `system:` groups). For example, the value `oidc:` will create group names like `oidc:engineering` and `oidc:infra`.
616
739
  */
617
740
  groupsPrefix?: string;
618
741
  /**
619
- * Multiple key=value pairs describing a required claim in the ID token. If
620
- * set, the claims are verified to be present in the ID token with a matching
621
- * value.
742
+ * Multiple key=value pairs describing a required claim in the ID token. If set, the claims are verified to be present in the ID token with a matching value.
622
743
  */
623
744
  requiredClaim?: string[];
624
745
  }
@@ -628,229 +749,242 @@ export interface UpdatePoolRequestUpgradePolicy {
628
749
  }
629
750
  export type AddClusterACLRulesRequest = {
630
751
  /**
631
- * Region to target. If none is passed will use default region from the
632
- * config.
752
+ * Region to target. If none is passed will use default region from the config.
633
753
  */
634
754
  region?: ScwRegion;
635
- /** ID of the cluster whose ACLs will be added. */
755
+ /**
756
+ * ID of the cluster whose ACLs will be added.
757
+ */
636
758
  clusterId: string;
637
- /** ACLs to add. */
759
+ /**
760
+ * ACLs to add.
761
+ */
638
762
  acls?: ACLRuleRequest[];
639
763
  };
640
764
  export interface AddClusterACLRulesResponse {
641
- /** ACLs that were added. */
765
+ /**
766
+ * ACLs that were added.
767
+ */
642
768
  rules: ACLRule[];
643
769
  }
644
770
  export type AuthExternalNodeRequest = {
645
771
  /**
646
- * Region to target. If none is passed will use default region from the
647
- * config.
772
+ * Region to target. If none is passed will use default region from the config.
648
773
  */
649
774
  region?: ScwRegion;
650
- /** Pool the node will be attached to. */
775
+ /**
776
+ * Pool the node will be attached to.
777
+ */
651
778
  poolId: string;
652
779
  };
653
780
  export type CreateClusterRequest = {
654
781
  /**
655
- * Region to target. If none is passed will use default region from the
656
- * config.
782
+ * Region to target. If none is passed will use default region from the config.
657
783
  */
658
784
  region?: ScwRegion;
659
785
  /**
660
786
  * @deprecated Organization ID in which the cluster will be created.
661
787
  *
662
- * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId'
663
- * could be set.
788
+ * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
664
789
  */
665
790
  organizationId?: string;
666
791
  /**
667
792
  * Project ID in which the cluster will be created.
668
793
  *
669
- * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId'
670
- * could be set.
794
+ * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
671
795
  */
672
796
  projectId?: string;
673
797
  /**
674
- * Type of the cluster. See [list available cluster
675
- * types](#list-available-cluster-types-for-a-cluster) for a list of valid
676
- * types.
798
+ * Type of the cluster. See [list available cluster types](#list-available-cluster-types-for-a-cluster) for a list of valid types.
677
799
  */
678
800
  type: string;
679
- /** Cluster name. */
801
+ /**
802
+ * Cluster name.
803
+ */
680
804
  name?: string;
681
- /** Cluster description. */
805
+ /**
806
+ * Cluster description.
807
+ */
682
808
  description: string;
683
- /** Tags associated with the cluster. */
809
+ /**
810
+ * Tags associated with the cluster.
811
+ */
684
812
  tags?: string[];
685
- /** Kubernetes version of the cluster. */
813
+ /**
814
+ * Kubernetes version of the cluster.
815
+ */
686
816
  version: string;
687
- /** Container Network Interface (CNI) plugin running in the cluster. */
817
+ /**
818
+ * Container Network Interface (CNI) plugin running in the cluster.
819
+ */
688
820
  cni: CNI;
689
- /** Pools created along with the cluster. */
821
+ /**
822
+ * Pools created along with the cluster.
823
+ */
690
824
  pools?: CreateClusterRequestPoolConfig[];
691
825
  /**
692
- * Autoscaler configuration for the cluster. It allows you to set (to an
693
- * extent) your preferred autoscaler configuration, which is an implementation
694
- * of the cluster-autoscaler
695
- * (https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler/).
826
+ * Autoscaler configuration for the cluster. It allows you to set (to an extent) your preferred autoscaler configuration, which is an implementation of the cluster-autoscaler (https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler/).
696
827
  */
697
828
  autoscalerConfig?: CreateClusterRequestAutoscalerConfig;
698
829
  /**
699
- * Auto upgrade configuration of the cluster. This configuration enables to
700
- * set a specific 2-hour time window in which the cluster can be automatically
701
- * updated to the latest patch version.
830
+ * Auto upgrade configuration of the cluster. This configuration enables to set a specific 2-hour time window in which the cluster can be automatically updated to the latest patch version.
702
831
  */
703
832
  autoUpgrade?: CreateClusterRequestAutoUpgrade;
704
- /** List of feature gates to enable. */
833
+ /**
834
+ * List of feature gates to enable.
835
+ */
705
836
  featureGates?: string[];
706
- /** List of admission plugins to enable. */
837
+ /**
838
+ * List of admission plugins to enable.
839
+ */
707
840
  admissionPlugins?: string[];
708
841
  /**
709
- * OpenID Connect configuration of the cluster. This configuration enables to
710
- * update the OpenID Connect configuration of the Kubernetes API server.
842
+ * OpenID Connect configuration of the cluster. This configuration enables to update the OpenID Connect configuration of the Kubernetes API server.
711
843
  */
712
844
  openIdConnectConfig?: CreateClusterRequestOpenIDConnectConfig;
713
845
  /**
714
- * Additional Subject Alternative Names for the Kubernetes API server
715
- * certificate.
846
+ * Additional Subject Alternative Names for the Kubernetes API server certificate.
716
847
  */
717
848
  apiserverCertSans?: string[];
718
849
  /**
719
- * Private network ID for internal cluster communication (cannot be changed
720
- * later).
850
+ * Private network ID for internal cluster communication (cannot be changed later).
721
851
  */
722
852
  privateNetworkId?: string;
723
853
  };
724
854
  export type CreateExternalNodeRequest = {
725
855
  /**
726
- * Region to target. If none is passed will use default region from the
727
- * config.
856
+ * Region to target. If none is passed will use default region from the config.
728
857
  */
729
858
  region?: ScwRegion;
730
859
  poolId: string;
731
860
  };
732
861
  export type CreatePoolRequest = {
733
862
  /**
734
- * Region to target. If none is passed will use default region from the
735
- * config.
863
+ * Region to target. If none is passed will use default region from the config.
736
864
  */
737
865
  region?: ScwRegion;
738
- /** Cluster ID to which the pool will be attached. */
866
+ /**
867
+ * Cluster ID to which the pool will be attached.
868
+ */
739
869
  clusterId: string;
740
- /** Pool name. */
870
+ /**
871
+ * Pool name.
872
+ */
741
873
  name?: string;
742
874
  /**
743
- * Node type is the type of Scaleway Instance wanted for the pool. Nodes with
744
- * insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST).
745
- * 'external' is a special node type used to provision instances from other
746
- * cloud providers in a Kosmos Cluster.
875
+ * Node type is the type of Scaleway Instance wanted for the pool. Nodes with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). 'external' is a special node type used to provision instances from other cloud providers in a Kosmos Cluster.
747
876
  */
748
877
  nodeType: string;
749
878
  /**
750
- * Placement group ID in which all the nodes of the pool will be created,
751
- * placement groups are limited to 20 instances.
879
+ * Placement group ID in which all the nodes of the pool will be created, placement groups are limited to 20 instances.
752
880
  */
753
881
  placementGroupId?: string;
754
- /** Defines whether the autoscaling feature is enabled for the pool. */
882
+ /**
883
+ * Defines whether the autoscaling feature is enabled for the pool.
884
+ */
755
885
  autoscaling: boolean;
756
- /** Size (number of nodes) of the pool. */
886
+ /**
887
+ * Size (number of nodes) of the pool.
888
+ */
757
889
  size: number;
758
890
  /**
759
- * Defines the minimum size of the pool. Note that this field is only used
760
- * when autoscaling is enabled on the pool.
891
+ * Defines the minimum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.
761
892
  */
762
893
  minSize?: number;
763
894
  /**
764
- * Defines the maximum size of the pool. Note that this field is only used
765
- * when autoscaling is enabled on the pool.
895
+ * Defines the maximum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.
766
896
  */
767
897
  maxSize?: number;
768
- /** Customization of the container runtime is available for each pool. */
898
+ /**
899
+ * Customization of the container runtime is available for each pool.
900
+ */
769
901
  containerRuntime?: Runtime;
770
- /** Defines whether the autohealing feature is enabled for the pool. */
902
+ /**
903
+ * Defines whether the autohealing feature is enabled for the pool.
904
+ */
771
905
  autohealing: boolean;
772
906
  /**
773
- * Tags associated with the pool, see [managing
774
- * tags](https://www.scaleway.com/en/docs/containers/kubernetes/api-cli/managing-tags).
907
+ * Tags associated with the pool, see [managing tags](https://www.scaleway.com/en/docs/containers/kubernetes/api-cli/managing-tags).
775
908
  */
776
909
  tags?: string[];
777
910
  /**
778
- * Kubelet arguments to be used by this pool. Note that this feature is
779
- * experimental.
911
+ * Kubelet arguments to be used by this pool. Note that this feature is experimental.
780
912
  */
781
913
  kubeletArgs?: Record<string, string>;
782
- /** Pool upgrade policy. */
914
+ /**
915
+ * Pool upgrade policy.
916
+ */
783
917
  upgradePolicy?: CreatePoolRequestUpgradePolicy;
784
- /** Zone in which the pool's nodes will be spawned. */
918
+ /**
919
+ * Zone in which the pool's nodes will be spawned.
920
+ */
785
921
  zone?: ScwZone;
786
922
  /**
787
- * - `l_ssd` is a local block storage which means your system is stored locally
788
- * on your node's hypervisor. This type is not available for all node types
789
- * `sbs-5k` is a remote block storage which means your system is stored on a
790
- * centralized and resilient cluster with 5k IOPS limits `sbs-15k` is a
791
- * faster remote block storage which means your system is stored on a
792
- * centralized and resilient cluster with 15k IOPS limits `b_ssd` is the
793
- * legacy remote block storage which means your system is stored on a
794
- * centralized and resilient cluster. Consider using `sbs-5k` or `sbs-15k`
795
- * instead.
923
+ * * `l_ssd` is a local block storage which means your system is stored locally on your node's hypervisor. This type is not available for all node types
924
+ * `sbs-5k` is a remote block storage which means your system is stored on a centralized and resilient cluster with 5k IOPS limits
925
+ * `sbs-15k` is a faster remote block storage which means your system is stored on a centralized and resilient cluster with 15k IOPS limits
926
+ * `b_ssd` is the legacy remote block storage which means your system is stored on a centralized and resilient cluster. Consider using `sbs-5k` or `sbs-15k` instead.
796
927
  */
797
928
  rootVolumeType?: PoolVolumeType;
798
- /** System volume disk size. */
929
+ /**
930
+ * System volume disk size.
931
+ */
799
932
  rootVolumeSize?: number;
800
933
  /**
801
- * Defines if the public IP should be removed from Nodes. To use this feature,
802
- * your Cluster must have an attached Private Network set up with a Public
803
- * Gateway.
934
+ * Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.
804
935
  */
805
936
  publicIpDisabled: boolean;
806
937
  };
807
938
  export type DeleteACLRuleRequest = {
808
939
  /**
809
- * Region to target. If none is passed will use default region from the
810
- * config.
940
+ * Region to target. If none is passed will use default region from the config.
811
941
  */
812
942
  region?: ScwRegion;
813
- /** ID of the ACL rule to delete. */
943
+ /**
944
+ * ID of the ACL rule to delete.
945
+ */
814
946
  aclId: string;
815
947
  };
816
948
  export type DeleteClusterRequest = {
817
949
  /**
818
- * Region to target. If none is passed will use default region from the
819
- * config.
950
+ * Region to target. If none is passed will use default region from the config.
820
951
  */
821
952
  region?: ScwRegion;
822
- /** ID of the cluster to delete. */
953
+ /**
954
+ * ID of the cluster to delete.
955
+ */
823
956
  clusterId: string;
824
957
  /**
825
- * Defines whether all volumes (including retain volume type), empty Private
826
- * Networks and Load Balancers with a name starting with the cluster ID will
827
- * also be deleted.
958
+ * Defines whether all volumes (including retain volume type), empty Private Networks and Load Balancers with a name starting with the cluster ID will also be deleted.
828
959
  */
829
960
  withAdditionalResources: boolean;
830
961
  };
831
962
  export type DeleteNodeRequest = {
832
963
  /**
833
- * Region to target. If none is passed will use default region from the
834
- * config.
964
+ * Region to target. If none is passed will use default region from the config.
835
965
  */
836
966
  region?: ScwRegion;
837
- /** ID of the node to replace. */
967
+ /**
968
+ * ID of the node to replace.
969
+ */
838
970
  nodeId: string;
839
971
  /**
840
- * Skip draining node from its workload (Note: this parameter is currently
841
- * inactive).
972
+ * Skip draining node from its workload (Note: this parameter is currently inactive).
842
973
  */
843
974
  skipDrain: boolean;
844
- /** Add a new node after the deletion of this node. */
975
+ /**
976
+ * Add a new node after the deletion of this node.
977
+ */
845
978
  replace: boolean;
846
979
  };
847
980
  export type DeletePoolRequest = {
848
981
  /**
849
- * Region to target. If none is passed will use default region from the
850
- * config.
982
+ * Region to target. If none is passed will use default region from the config.
851
983
  */
852
984
  region?: ScwRegion;
853
- /** ID of the pool to delete. */
985
+ /**
986
+ * ID of the pool to delete.
987
+ */
854
988
  poolId: string;
855
989
  };
856
990
  export interface ExternalNode {
@@ -875,237 +1009,307 @@ export interface ExternalNodeAuth {
875
1009
  }
876
1010
  export type GetClusterKubeConfigRequest = {
877
1011
  /**
878
- * Region to target. If none is passed will use default region from the
879
- * config.
1012
+ * Region to target. If none is passed will use default region from the config.
880
1013
  */
881
1014
  region?: ScwRegion;
882
- /** Cluster ID for which to download the kubeconfig. */
1015
+ /**
1016
+ * Cluster ID for which to download the kubeconfig.
1017
+ */
883
1018
  clusterId: string;
884
- /** Hide the legacy token from the kubeconfig. */
1019
+ /**
1020
+ * Hide the legacy token from the kubeconfig.
1021
+ */
885
1022
  redacted?: boolean;
886
1023
  };
887
1024
  export type GetClusterRequest = {
888
1025
  /**
889
- * Region to target. If none is passed will use default region from the
890
- * config.
1026
+ * Region to target. If none is passed will use default region from the config.
891
1027
  */
892
1028
  region?: ScwRegion;
893
- /** ID of the requested cluster. */
1029
+ /**
1030
+ * ID of the requested cluster.
1031
+ */
894
1032
  clusterId: string;
895
1033
  };
896
1034
  export type GetNodeMetadataRequest = {
897
1035
  /**
898
- * Region to target. If none is passed will use default region from the
899
- * config.
1036
+ * Region to target. If none is passed will use default region from the config.
900
1037
  */
901
1038
  region?: ScwRegion;
902
1039
  };
903
1040
  export type GetNodeRequest = {
904
1041
  /**
905
- * Region to target. If none is passed will use default region from the
906
- * config.
1042
+ * Region to target. If none is passed will use default region from the config.
907
1043
  */
908
1044
  region?: ScwRegion;
909
- /** ID of the requested node. */
1045
+ /**
1046
+ * ID of the requested node.
1047
+ */
910
1048
  nodeId: string;
911
1049
  };
912
1050
  export type GetPoolRequest = {
913
1051
  /**
914
- * Region to target. If none is passed will use default region from the
915
- * config.
1052
+ * Region to target. If none is passed will use default region from the config.
916
1053
  */
917
1054
  region?: ScwRegion;
918
- /** ID of the requested pool. */
1055
+ /**
1056
+ * ID of the requested pool.
1057
+ */
919
1058
  poolId: string;
920
1059
  };
921
1060
  export type GetVersionRequest = {
922
1061
  /**
923
- * Region to target. If none is passed will use default region from the
924
- * config.
1062
+ * Region to target. If none is passed will use default region from the config.
925
1063
  */
926
1064
  region?: ScwRegion;
927
- /** Requested version name. */
1065
+ /**
1066
+ * Requested version name.
1067
+ */
928
1068
  versionName: string;
929
1069
  };
930
1070
  export type ListClusterACLRulesRequest = {
931
1071
  /**
932
- * Region to target. If none is passed will use default region from the
933
- * config.
1072
+ * Region to target. If none is passed will use default region from the config.
934
1073
  */
935
1074
  region?: ScwRegion;
936
- /** ID of the cluster whose ACLs will be listed. */
1075
+ /**
1076
+ * ID of the cluster whose ACLs will be listed.
1077
+ */
937
1078
  clusterId: string;
938
- /** Page number for the returned ACLs. */
1079
+ /**
1080
+ * Page number for the returned ACLs.
1081
+ */
939
1082
  page?: number;
940
- /** Maximum number of ACLs per page. */
1083
+ /**
1084
+ * Maximum number of ACLs per page.
1085
+ */
941
1086
  pageSize?: number;
942
1087
  };
943
1088
  export interface ListClusterACLRulesResponse {
944
- /** Total number of ACLs that exist for the cluster. */
1089
+ /**
1090
+ * Total number of ACLs that exist for the cluster.
1091
+ */
945
1092
  totalCount: number;
946
- /** Paginated returned ACLs. */
1093
+ /**
1094
+ * Paginated returned ACLs.
1095
+ */
947
1096
  rules: ACLRule[];
948
1097
  }
949
1098
  export type ListClusterAvailableTypesRequest = {
950
1099
  /**
951
- * Region to target. If none is passed will use default region from the
952
- * config.
1100
+ * Region to target. If none is passed will use default region from the config.
953
1101
  */
954
1102
  region?: ScwRegion;
955
- /** Cluster ID for which the available Kubernetes types will be listed. */
1103
+ /**
1104
+ * Cluster ID for which the available Kubernetes types will be listed.
1105
+ */
956
1106
  clusterId: string;
957
1107
  };
958
1108
  export interface ListClusterAvailableTypesResponse {
959
- /** Available cluster types for the cluster. */
1109
+ /**
1110
+ * Available cluster types for the cluster.
1111
+ */
960
1112
  clusterTypes: ClusterType[];
961
- /** Total number of types. */
1113
+ /**
1114
+ * Total number of types.
1115
+ */
962
1116
  totalCount: number;
963
1117
  }
964
1118
  export type ListClusterAvailableVersionsRequest = {
965
1119
  /**
966
- * Region to target. If none is passed will use default region from the
967
- * config.
1120
+ * Region to target. If none is passed will use default region from the config.
968
1121
  */
969
1122
  region?: ScwRegion;
970
- /** Cluster ID for which the available Kubernetes versions will be listed. */
1123
+ /**
1124
+ * Cluster ID for which the available Kubernetes versions will be listed.
1125
+ */
971
1126
  clusterId: string;
972
1127
  };
973
1128
  export interface ListClusterAvailableVersionsResponse {
974
- /** Available Kubernetes versions for the cluster. */
1129
+ /**
1130
+ * Available Kubernetes versions for the cluster.
1131
+ */
975
1132
  versions: Version[];
976
1133
  }
977
1134
  export type ListClusterTypesRequest = {
978
1135
  /**
979
- * Region to target. If none is passed will use default region from the
980
- * config.
1136
+ * Region to target. If none is passed will use default region from the config.
981
1137
  */
982
1138
  region?: ScwRegion;
983
- /** Page number, from the paginated results, to return for cluster-types. */
1139
+ /**
1140
+ * Page number, from the paginated results, to return for cluster-types.
1141
+ */
984
1142
  page?: number;
985
- /** Maximum number of clusters per page. */
1143
+ /**
1144
+ * Maximum number of clusters per page.
1145
+ */
986
1146
  pageSize?: number;
987
1147
  };
988
1148
  export interface ListClusterTypesResponse {
989
- /** Total number of cluster-types. */
1149
+ /**
1150
+ * Total number of cluster-types.
1151
+ */
990
1152
  totalCount: number;
991
- /** Paginated returned cluster-types. */
1153
+ /**
1154
+ * Paginated returned cluster-types.
1155
+ */
992
1156
  clusterTypes: ClusterType[];
993
1157
  }
994
1158
  export type ListClustersRequest = {
995
1159
  /**
996
- * Region to target. If none is passed will use default region from the
997
- * config.
1160
+ * Region to target. If none is passed will use default region from the config.
998
1161
  */
999
1162
  region?: ScwRegion;
1000
- /** Organization ID on which to filter the returned clusters. */
1163
+ /**
1164
+ * Organization ID on which to filter the returned clusters.
1165
+ */
1001
1166
  organizationId?: string;
1002
- /** Project ID on which to filter the returned clusters. */
1167
+ /**
1168
+ * Project ID on which to filter the returned clusters.
1169
+ */
1003
1170
  projectId?: string;
1004
- /** Sort order of returned clusters. */
1171
+ /**
1172
+ * Sort order of returned clusters.
1173
+ */
1005
1174
  orderBy?: ListClustersRequestOrderBy;
1006
- /** Page number to return for clusters, from the paginated results. */
1175
+ /**
1176
+ * Page number to return for clusters, from the paginated results.
1177
+ */
1007
1178
  page?: number;
1008
- /** Maximum number of clusters per page. */
1179
+ /**
1180
+ * Maximum number of clusters per page.
1181
+ */
1009
1182
  pageSize?: number;
1010
1183
  /**
1011
- * Name to filter on, only clusters containing this substring in their name
1012
- * will be returned.
1184
+ * Name to filter on, only clusters containing this substring in their name will be returned.
1013
1185
  */
1014
1186
  name?: string;
1015
- /** Status to filter on, only clusters with this status will be returned. */
1187
+ /**
1188
+ * Status to filter on, only clusters with this status will be returned.
1189
+ */
1016
1190
  status?: ClusterStatus;
1017
- /** Type to filter on, only clusters with this type will be returned. */
1191
+ /**
1192
+ * Type to filter on, only clusters with this type will be returned.
1193
+ */
1018
1194
  type?: string;
1019
1195
  /**
1020
- * Private Network ID to filter on, only clusters within this Private Network
1021
- * will be returned.
1196
+ * Private Network ID to filter on, only clusters within this Private Network will be returned.
1022
1197
  */
1023
1198
  privateNetworkId?: string;
1024
1199
  };
1025
1200
  export interface ListClustersResponse {
1026
- /** Total number of clusters. */
1201
+ /**
1202
+ * Total number of clusters.
1203
+ */
1027
1204
  totalCount: number;
1028
- /** Paginated returned clusters. */
1205
+ /**
1206
+ * Paginated returned clusters.
1207
+ */
1029
1208
  clusters: Cluster[];
1030
1209
  }
1031
1210
  export type ListNodesRequest = {
1032
1211
  /**
1033
- * Region to target. If none is passed will use default region from the
1034
- * config.
1212
+ * Region to target. If none is passed will use default region from the config.
1035
1213
  */
1036
1214
  region?: ScwRegion;
1037
- /** Cluster ID from which the nodes will be listed from. */
1215
+ /**
1216
+ * Cluster ID from which the nodes will be listed from.
1217
+ */
1038
1218
  clusterId: string;
1039
- /** Pool ID on which to filter the returned nodes. */
1219
+ /**
1220
+ * Pool ID on which to filter the returned nodes.
1221
+ */
1040
1222
  poolId?: string;
1041
- /** Sort order of the returned nodes. */
1223
+ /**
1224
+ * Sort order of the returned nodes.
1225
+ */
1042
1226
  orderBy?: ListNodesRequestOrderBy;
1043
- /** Page number for the returned nodes. */
1227
+ /**
1228
+ * Page number for the returned nodes.
1229
+ */
1044
1230
  page?: number;
1045
- /** Maximum number of nodes per page. */
1231
+ /**
1232
+ * Maximum number of nodes per page.
1233
+ */
1046
1234
  pageSize?: number;
1047
1235
  /**
1048
- * Name to filter on, only nodes containing this substring in their name will
1049
- * be returned.
1236
+ * Name to filter on, only nodes containing this substring in their name will be returned.
1050
1237
  */
1051
1238
  name?: string;
1052
- /** Status to filter on, only nodes with this status will be returned. */
1239
+ /**
1240
+ * Status to filter on, only nodes with this status will be returned.
1241
+ */
1053
1242
  status?: NodeStatus;
1054
1243
  };
1055
1244
  export interface ListNodesResponse {
1056
- /** Total number of nodes. */
1245
+ /**
1246
+ * Total number of nodes.
1247
+ */
1057
1248
  totalCount: number;
1058
- /** Paginated returned nodes. */
1249
+ /**
1250
+ * Paginated returned nodes.
1251
+ */
1059
1252
  nodes: Node[];
1060
1253
  }
1061
1254
  export type ListPoolsRequest = {
1062
1255
  /**
1063
- * Region to target. If none is passed will use default region from the
1064
- * config.
1256
+ * Region to target. If none is passed will use default region from the config.
1065
1257
  */
1066
1258
  region?: ScwRegion;
1067
- /** ID of the cluster whose pools will be listed. */
1259
+ /**
1260
+ * ID of the cluster whose pools will be listed.
1261
+ */
1068
1262
  clusterId: string;
1069
- /** Sort order of returned pools. */
1263
+ /**
1264
+ * Sort order of returned pools.
1265
+ */
1070
1266
  orderBy?: ListPoolsRequestOrderBy;
1071
- /** Page number for the returned pools. */
1267
+ /**
1268
+ * Page number for the returned pools.
1269
+ */
1072
1270
  page?: number;
1073
- /** Maximum number of pools per page. */
1271
+ /**
1272
+ * Maximum number of pools per page.
1273
+ */
1074
1274
  pageSize?: number;
1075
1275
  /**
1076
- * Name to filter on, only pools containing this substring in their name will
1077
- * be returned.
1276
+ * Name to filter on, only pools containing this substring in their name will be returned.
1078
1277
  */
1079
1278
  name?: string;
1080
- /** Status to filter on, only pools with this status will be returned. */
1279
+ /**
1280
+ * Status to filter on, only pools with this status will be returned.
1281
+ */
1081
1282
  status?: PoolStatus;
1082
1283
  };
1083
1284
  export interface ListPoolsResponse {
1084
- /** Total number of pools that exists for the cluster. */
1285
+ /**
1286
+ * Total number of pools that exists for the cluster.
1287
+ */
1085
1288
  totalCount: number;
1086
- /** Paginated returned pools. */
1289
+ /**
1290
+ * Paginated returned pools.
1291
+ */
1087
1292
  pools: Pool[];
1088
1293
  }
1089
1294
  export type ListVersionsRequest = {
1090
1295
  /**
1091
- * Region to target. If none is passed will use default region from the
1092
- * config.
1296
+ * Region to target. If none is passed will use default region from the config.
1093
1297
  */
1094
1298
  region?: ScwRegion;
1095
1299
  };
1096
1300
  export interface ListVersionsResponse {
1097
- /** Available Kubernetes versions. */
1301
+ /**
1302
+ * Available Kubernetes versions.
1303
+ */
1098
1304
  versions: Version[];
1099
1305
  }
1100
1306
  export type MigrateClusterToSBSCSIRequest = {
1101
1307
  /**
1102
- * Region to target. If none is passed will use default region from the
1103
- * config.
1308
+ * Region to target. If none is passed will use default region from the config.
1104
1309
  */
1105
1310
  region?: ScwRegion;
1106
1311
  /**
1107
- * Cluster ID for which the latest CSI compatible with Scaleway Block Storage
1108
- * will be enabled.
1312
+ * Cluster ID for which the latest CSI compatible with Scaleway Block Storage will be enabled.
1109
1313
  */
1110
1314
  clusterId: string;
1111
1315
  };
@@ -1125,152 +1329,185 @@ export interface NodeMetadata {
1125
1329
  }
1126
1330
  export type RebootNodeRequest = {
1127
1331
  /**
1128
- * Region to target. If none is passed will use default region from the
1129
- * config.
1332
+ * Region to target. If none is passed will use default region from the config.
1130
1333
  */
1131
1334
  region?: ScwRegion;
1132
- /** ID of the node to reboot. */
1335
+ /**
1336
+ * ID of the node to reboot.
1337
+ */
1133
1338
  nodeId: string;
1134
1339
  };
1135
1340
  export type ReplaceNodeRequest = {
1136
1341
  /**
1137
- * Region to target. If none is passed will use default region from the
1138
- * config.
1342
+ * Region to target. If none is passed will use default region from the config.
1139
1343
  */
1140
1344
  region?: ScwRegion;
1141
- /** ID of the node to replace. */
1345
+ /**
1346
+ * ID of the node to replace.
1347
+ */
1142
1348
  nodeId: string;
1143
1349
  };
1144
1350
  export type ResetClusterAdminTokenRequest = {
1145
1351
  /**
1146
- * Region to target. If none is passed will use default region from the
1147
- * config.
1352
+ * Region to target. If none is passed will use default region from the config.
1148
1353
  */
1149
1354
  region?: ScwRegion;
1150
- /** Cluster ID on which the admin token will be renewed. */
1355
+ /**
1356
+ * Cluster ID on which the admin token will be renewed.
1357
+ */
1151
1358
  clusterId: string;
1152
1359
  };
1153
1360
  export type SetClusterACLRulesRequest = {
1154
1361
  /**
1155
- * Region to target. If none is passed will use default region from the
1156
- * config.
1362
+ * Region to target. If none is passed will use default region from the config.
1157
1363
  */
1158
1364
  region?: ScwRegion;
1159
- /** ID of the cluster whose ACLs will be set. */
1365
+ /**
1366
+ * ID of the cluster whose ACLs will be set.
1367
+ */
1160
1368
  clusterId: string;
1161
- /** ACLs to set. */
1369
+ /**
1370
+ * ACLs to set.
1371
+ */
1162
1372
  acls?: ACLRuleRequest[];
1163
1373
  };
1164
1374
  export interface SetClusterACLRulesResponse {
1165
- /** ACLs that were set. */
1375
+ /**
1376
+ * ACLs that were set.
1377
+ */
1166
1378
  rules: ACLRule[];
1167
1379
  }
1168
1380
  export type SetClusterTypeRequest = {
1169
1381
  /**
1170
- * Region to target. If none is passed will use default region from the
1171
- * config.
1382
+ * Region to target. If none is passed will use default region from the config.
1172
1383
  */
1173
1384
  region?: ScwRegion;
1174
- /** ID of the cluster to migrate from one type to another. */
1385
+ /**
1386
+ * ID of the cluster to migrate from one type to another.
1387
+ */
1175
1388
  clusterId: string;
1176
1389
  /**
1177
- * Type of the cluster. Note that some migrations are not possible (please
1178
- * refer to product documentation).
1390
+ * Type of the cluster. Note that some migrations are not possible (please refer to product documentation).
1179
1391
  */
1180
1392
  type: string;
1181
1393
  };
1182
1394
  export type UpdateClusterRequest = {
1183
1395
  /**
1184
- * Region to target. If none is passed will use default region from the
1185
- * config.
1396
+ * Region to target. If none is passed will use default region from the config.
1186
1397
  */
1187
1398
  region?: ScwRegion;
1188
- /** ID of the cluster to update. */
1399
+ /**
1400
+ * ID of the cluster to update.
1401
+ */
1189
1402
  clusterId: string;
1190
- /** New external name for the cluster. */
1403
+ /**
1404
+ * New external name for the cluster.
1405
+ */
1191
1406
  name?: string;
1192
- /** New description for the cluster. */
1407
+ /**
1408
+ * New description for the cluster.
1409
+ */
1193
1410
  description?: string;
1194
- /** New tags associated with the cluster. */
1411
+ /**
1412
+ * New tags associated with the cluster.
1413
+ */
1195
1414
  tags?: string[];
1196
- /** New autoscaler config for the cluster. */
1415
+ /**
1416
+ * New autoscaler config for the cluster.
1417
+ */
1197
1418
  autoscalerConfig?: UpdateClusterRequestAutoscalerConfig;
1198
1419
  /**
1199
- * New auto upgrade configuration for the cluster. Note that all fields needs
1200
- * to be set.
1420
+ * New auto upgrade configuration for the cluster. Note that all fields needs to be set.
1201
1421
  */
1202
1422
  autoUpgrade?: UpdateClusterRequestAutoUpgrade;
1203
- /** List of feature gates to enable. */
1423
+ /**
1424
+ * List of feature gates to enable.
1425
+ */
1204
1426
  featureGates?: string[];
1205
- /** List of admission plugins to enable. */
1427
+ /**
1428
+ * List of admission plugins to enable.
1429
+ */
1206
1430
  admissionPlugins?: string[];
1207
1431
  /**
1208
- * OpenID Connect configuration of the cluster. This configuration enables to
1209
- * update the OpenID Connect configuration of the Kubernetes API server.
1432
+ * OpenID Connect configuration of the cluster. This configuration enables to update the OpenID Connect configuration of the Kubernetes API server.
1210
1433
  */
1211
1434
  openIdConnectConfig?: UpdateClusterRequestOpenIDConnectConfig;
1212
1435
  /**
1213
- * Additional Subject Alternative Names for the Kubernetes API server
1214
- * certificate.
1436
+ * Additional Subject Alternative Names for the Kubernetes API server certificate.
1215
1437
  */
1216
1438
  apiserverCertSans?: string[];
1217
1439
  };
1218
1440
  export type UpdatePoolRequest = {
1219
1441
  /**
1220
- * Region to target. If none is passed will use default region from the
1221
- * config.
1442
+ * Region to target. If none is passed will use default region from the config.
1222
1443
  */
1223
1444
  region?: ScwRegion;
1224
- /** ID of the pool to update. */
1445
+ /**
1446
+ * ID of the pool to update.
1447
+ */
1225
1448
  poolId: string;
1226
- /** New value for the pool autoscaling enablement. */
1449
+ /**
1450
+ * New value for the pool autoscaling enablement.
1451
+ */
1227
1452
  autoscaling?: boolean;
1228
- /** New desired pool size. */
1453
+ /**
1454
+ * New desired pool size.
1455
+ */
1229
1456
  size?: number;
1230
- /** New minimum size for the pool. */
1457
+ /**
1458
+ * New minimum size for the pool.
1459
+ */
1231
1460
  minSize?: number;
1232
- /** New maximum size for the pool. */
1461
+ /**
1462
+ * New maximum size for the pool.
1463
+ */
1233
1464
  maxSize?: number;
1234
- /** New value for the pool autohealing enablement. */
1465
+ /**
1466
+ * New value for the pool autohealing enablement.
1467
+ */
1235
1468
  autohealing?: boolean;
1236
- /** New tags associated with the pool. */
1469
+ /**
1470
+ * New tags associated with the pool.
1471
+ */
1237
1472
  tags?: string[];
1238
1473
  /**
1239
- * New Kubelet arguments to be used by this pool. Note that this feature is
1240
- * experimental.
1474
+ * New Kubelet arguments to be used by this pool. Note that this feature is experimental.
1241
1475
  */
1242
1476
  kubeletArgs?: Record<string, string>;
1243
- /** New upgrade policy for the pool. */
1477
+ /**
1478
+ * New upgrade policy for the pool.
1479
+ */
1244
1480
  upgradePolicy?: UpdatePoolRequestUpgradePolicy;
1245
1481
  };
1246
1482
  export type UpgradeClusterRequest = {
1247
1483
  /**
1248
- * Region to target. If none is passed will use default region from the
1249
- * config.
1484
+ * Region to target. If none is passed will use default region from the config.
1250
1485
  */
1251
1486
  region?: ScwRegion;
1252
- /** ID of the cluster to upgrade. */
1487
+ /**
1488
+ * ID of the cluster to upgrade.
1489
+ */
1253
1490
  clusterId: string;
1254
1491
  /**
1255
- * New Kubernetes version of the cluster. Note that the version should either
1256
- * be a higher patch version of the same minor version or the direct minor
1257
- * version after the current one.
1492
+ * New Kubernetes version of the cluster. Note that the version should either be a higher patch version of the same minor version or the direct minor version after the current one.
1258
1493
  */
1259
1494
  version: string;
1260
1495
  /**
1261
- * Defines whether pools will also be upgraded once the control plane is
1262
- * upgraded.
1496
+ * Defines whether pools will also be upgraded once the control plane is upgraded.
1263
1497
  */
1264
1498
  upgradePools: boolean;
1265
1499
  };
1266
1500
  export type UpgradePoolRequest = {
1267
1501
  /**
1268
- * Region to target. If none is passed will use default region from the
1269
- * config.
1502
+ * Region to target. If none is passed will use default region from the config.
1270
1503
  */
1271
1504
  region?: ScwRegion;
1272
- /** ID of the pool to upgrade. */
1505
+ /**
1506
+ * ID of the pool to upgrade.
1507
+ */
1273
1508
  poolId: string;
1274
- /** New Kubernetes version for the pool. */
1509
+ /**
1510
+ * New Kubernetes version for the pool.
1511
+ */
1275
1512
  version: string;
1276
1513
  };