@scaleway/sdk 1.10.1 → 1.11.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 (80) hide show
  1. package/dist/api/account/v2/api.gen.js +1 -0
  2. package/dist/api/account/v2/index.gen.js +1 -0
  3. package/dist/api/account/v2/marshalling.gen.js +1 -0
  4. package/dist/api/applesilicon/v1alpha1/api.gen.js +1 -0
  5. package/dist/api/applesilicon/v1alpha1/index.gen.js +1 -0
  6. package/dist/api/applesilicon/v1alpha1/marshalling.gen.js +1 -0
  7. package/dist/api/baremetal/v1/api.gen.js +1 -0
  8. package/dist/api/baremetal/v1/marshalling.gen.js +1 -0
  9. package/dist/api/billing/v2alpha1/api.gen.js +1 -0
  10. package/dist/api/billing/v2alpha1/index.gen.js +1 -0
  11. package/dist/api/billing/v2alpha1/marshalling.gen.js +1 -0
  12. package/dist/api/cockpit/v1beta1/api.gen.js +1 -0
  13. package/dist/api/cockpit/v1beta1/index.gen.js +1 -0
  14. package/dist/api/cockpit/v1beta1/marshalling.gen.js +1 -0
  15. package/dist/api/container/v1beta1/api.gen.js +1 -0
  16. package/dist/api/container/v1beta1/index.gen.js +1 -0
  17. package/dist/api/container/v1beta1/marshalling.gen.js +1 -0
  18. package/dist/api/domain/v2beta1/api.gen.js +3 -2
  19. package/dist/api/domain/v2beta1/index.gen.js +1 -0
  20. package/dist/api/domain/v2beta1/marshalling.gen.js +1 -0
  21. package/dist/api/flexibleip/v1alpha1/api.gen.js +1 -0
  22. package/dist/api/flexibleip/v1alpha1/index.gen.js +1 -0
  23. package/dist/api/flexibleip/v1alpha1/marshalling.gen.js +1 -0
  24. package/dist/api/function/v1beta1/api.gen.js +1 -0
  25. package/dist/api/function/v1beta1/index.gen.js +1 -0
  26. package/dist/api/function/v1beta1/marshalling.gen.js +1 -0
  27. package/dist/api/iam/v1alpha1/api.gen.js +1 -0
  28. package/dist/api/iam/v1alpha1/index.gen.js +1 -0
  29. package/dist/api/iam/v1alpha1/marshalling.gen.js +1 -0
  30. package/dist/api/instance/v1/api.gen.js +1 -0
  31. package/dist/api/instance/v1/marshalling.gen.js +1 -0
  32. package/dist/api/iot/v1/api.gen.js +1 -0
  33. package/dist/api/iot/v1/index.gen.js +1 -0
  34. package/dist/api/iot/v1/marshalling.gen.js +1 -0
  35. package/dist/api/k8s/v1/api.gen.js +49 -55
  36. package/dist/api/k8s/v1/marshalling.gen.js +1 -0
  37. package/dist/api/lb/v1/api.gen.js +1 -0
  38. package/dist/api/lb/v1/marshalling.gen.js +11 -0
  39. package/dist/api/marketplace/v1/api.gen.js +1 -0
  40. package/dist/api/marketplace/v1/index.gen.js +1 -0
  41. package/dist/api/marketplace/v1/marshalling.gen.js +1 -0
  42. package/dist/api/marketplace/v2/api.gen.js +1 -0
  43. package/dist/api/marketplace/v2/index.gen.js +1 -0
  44. package/dist/api/marketplace/v2/marshalling.gen.js +1 -0
  45. package/dist/api/mnq/v1alpha1/api.gen.js +1 -0
  46. package/dist/api/mnq/v1alpha1/index.gen.js +1 -0
  47. package/dist/api/mnq/v1alpha1/marshalling.gen.js +1 -0
  48. package/dist/api/rdb/v1/api.gen.js +1 -0
  49. package/dist/api/rdb/v1/index.gen.js +1 -0
  50. package/dist/api/rdb/v1/marshalling.gen.js +1 -0
  51. package/dist/api/redis/v1/api.gen.js +1 -0
  52. package/dist/api/redis/v1/index.gen.js +1 -0
  53. package/dist/api/redis/v1/marshalling.gen.js +1 -0
  54. package/dist/api/registry/v1/api.gen.js +1 -0
  55. package/dist/api/registry/v1/index.gen.js +1 -0
  56. package/dist/api/registry/v1/marshalling.gen.js +1 -0
  57. package/dist/api/secret/v1alpha1/api.gen.js +1 -0
  58. package/dist/api/secret/v1alpha1/index.gen.js +1 -0
  59. package/dist/api/secret/v1alpha1/marshalling.gen.js +1 -0
  60. package/dist/api/tem/v1alpha1/api.gen.js +1 -0
  61. package/dist/api/tem/v1alpha1/index.gen.js +1 -0
  62. package/dist/api/tem/v1alpha1/marshalling.gen.js +1 -0
  63. package/dist/api/test/v1/api.gen.js +1 -0
  64. package/dist/api/test/v1/index.gen.js +1 -0
  65. package/dist/api/test/v1/marshalling.gen.js +1 -0
  66. package/dist/api/vpc/v1/api.gen.js +1 -0
  67. package/dist/api/vpc/v1/index.gen.js +1 -0
  68. package/dist/api/vpc/v1/marshalling.gen.js +1 -0
  69. package/dist/api/vpcgw/v1/api.gen.js +1 -0
  70. package/dist/api/vpcgw/v1/index.gen.js +1 -0
  71. package/dist/api/vpcgw/v1/marshalling.gen.js +1 -0
  72. package/dist/api/webhosting/v1alpha1/api.gen.js +1 -0
  73. package/dist/api/webhosting/v1alpha1/index.gen.js +1 -0
  74. package/dist/api/webhosting/v1alpha1/marshalling.gen.js +1 -0
  75. package/dist/index.cjs +142 -59
  76. package/dist/index.d.ts +311 -284
  77. package/dist/scw/constants.js +1 -1
  78. package/dist/scw/custom-marshalling.js +5 -1
  79. package/dist/scw/fetch/resource-paginator.js +2 -0
  80. package/package.json +2 -2
package/dist/index.d.ts CHANGED
@@ -910,7 +910,11 @@ interface TokenAccessor {
910
910
  */
911
911
  declare const authenticateWithSessionToken: (getToken: TokenAccessor) => RequestInterceptor;
912
912
 
913
- /** Unmarshals {@link Money} */
913
+ /**
914
+ * Unmarshals {@link Money}
915
+ *
916
+ * @internal
917
+ */
914
918
  declare const unmarshalMoney: (data: unknown) => Money;
915
919
  /**
916
920
  * Unmarshals {@link ServiceInfo}.
@@ -1040,6 +1044,8 @@ type PaginatedContent<K extends string, T = unknown> = PaginatedResponse & {
1040
1044
  * @param fetcher - The method to retrieve paginated resources
1041
1045
  * @param request - A request with pagination options
1042
1046
  * @returns A resource Promise with the pagination helpers
1047
+ *
1048
+ * @internal
1043
1049
  */
1044
1050
  declare const enrichForPagination: <K extends string, T extends PaginatedContent<K, unknown>, R extends PaginationOptions>(key: K, fetcher: PaginatedFetcher<T, R>, request: R) => Promise<T> & {
1045
1051
  all: () => Promise<(Awaited<T[K]> extends infer T_1 ? T_1 extends Awaited<T[K]> ? T_1 extends readonly (infer InnerArr)[] ? InnerArr : T_1 : never : never)[]>;
@@ -5783,9 +5789,9 @@ declare class API$j extends API$q {
5783
5789
  deleteDNSZoneTsigKey: (request: Readonly<DeleteDNSZoneTsigKeyRequest>) => Promise<void>;
5784
5790
  }
5785
5791
  /**
5786
- * Domains registrar API.
5792
+ * Domains and DNS - Registrar API.
5787
5793
  *
5788
- * Domains registrar API. Manage your domains and contacts.
5794
+ * Domains and DNS - Registrar API. Manage your domains and contacts.
5789
5795
  */
5790
5796
  declare class RegistrarAPI extends API$q {
5791
5797
  protected pageOfListTasks: (request?: Readonly<RegistrarApiListTasksRequest>) => Promise<ListTasksResponse>;
@@ -13926,11 +13932,11 @@ type PoolVolumeType = 'default_volume_type' | 'l_ssd' | 'b_ssd';
13926
13932
  type Runtime = 'unknown_runtime' | 'docker' | 'containerd' | 'crio';
13927
13933
  /** Cluster. */
13928
13934
  interface Cluster$1 {
13929
- /** ID of the cluster. */
13935
+ /** Cluster ID. */
13930
13936
  id: string;
13931
- /** Type of the cluster. */
13937
+ /** Cluster type. */
13932
13938
  type: string;
13933
- /** Name of the cluster. */
13939
+ /** Cluster name. */
13934
13940
  name: string;
13935
13941
  /** Status of the cluster. */
13936
13942
  status: ClusterStatus$1;
@@ -13938,23 +13944,23 @@ interface Cluster$1 {
13938
13944
  version: string;
13939
13945
  /** Region in which the cluster is deployed. */
13940
13946
  region: Region;
13941
- /** ID of the organization owning the cluster. */
13947
+ /** ID of the Organization owning the cluster. */
13942
13948
  organizationId: string;
13943
- /** ID of the project owning the cluster. */
13949
+ /** ID of the Project owning the cluster. */
13944
13950
  projectId: string;
13945
13951
  /** Tags associated with the cluster. */
13946
13952
  tags: string[];
13947
13953
  /** Container Network Interface (CNI) plugin running in the cluster. */
13948
13954
  cni: CNI;
13949
- /** Description of the cluster. */
13955
+ /** Cluster description. */
13950
13956
  description: string;
13951
13957
  /** Kubernetes API server URL of the cluster. */
13952
13958
  clusterUrl: string;
13953
- /** DNS wildcard resovling all the ready nodes of the cluster. */
13959
+ /** Wildcard DNS resolving all the ready cluster nodes. */
13954
13960
  dnsWildcard: string;
13955
- /** Date at which the cluster was created. */
13961
+ /** Date on which the cluster was created. */
13956
13962
  createdAt?: Date;
13957
- /** Date at which the cluster was last updated. */
13963
+ /** Date on which the cluster was last updated. */
13958
13964
  updatedAt?: Date;
13959
13965
  /** Autoscaler config for the cluster. */
13960
13966
  autoscalerConfig?: ClusterAutoscalerConfig;
@@ -13963,7 +13969,10 @@ interface Cluster$1 {
13963
13969
  * cluster.
13964
13970
  */
13965
13971
  dashboardEnabled?: boolean;
13966
- /** @deprecated Ingress controller used in the cluster. */
13972
+ /**
13973
+ * @deprecated Managed Ingress controller used in the cluster (deprecated
13974
+ * feature).
13975
+ */
13967
13976
  ingress?: Ingress;
13968
13977
  /** Auto upgrade configuration of the cluster. */
13969
13978
  autoUpgrade?: ClusterAutoUpgrade;
@@ -13974,8 +13983,8 @@ interface Cluster$1 {
13974
13983
  /** List of enabled admission plugins. */
13975
13984
  admissionPlugins: string[];
13976
13985
  /**
13977
- * OpenID Connect configuration of the cluster. This configuration enables to
13978
- * update the OpenID Connect configuration of the Kubernetes API server.
13986
+ * This configuration enables to update the OpenID Connect configuration of
13987
+ * the Kubernetes API server.
13979
13988
  */
13980
13989
  openIdConnectConfig?: ClusterOpenIDConnectConfig;
13981
13990
  /**
@@ -13988,7 +13997,7 @@ interface Cluster$1 {
13988
13997
  }
13989
13998
  /** Cluster. auto upgrade. */
13990
13999
  interface ClusterAutoUpgrade {
13991
- /** Whether or not auto upgrade is enabled for the cluster. */
14000
+ /** Defines whether auto upgrade is enabled for the cluster. */
13992
14001
  enabled: boolean;
13993
14002
  /** Maintenance window of the cluster auto upgrades. */
13994
14003
  maintenanceWindow?: MaintenanceWindow$1;
@@ -14011,16 +14020,15 @@ interface ClusterAutoscalerConfig {
14011
14020
  /** Detect similar node groups and balance the number of nodes between them. */
14012
14021
  balanceSimilarNodeGroups: boolean;
14013
14022
  /**
14014
- * Pods with priority below cutoff will be expendable. Pods with priority
14015
- * below cutoff will be expendable. They can be killed without any
14016
- * consideration during scale down and they don't cause scale up. Pods with
14017
- * null priority (PodPriority disabled) are non expendable.
14023
+ * Pods with priority below cutoff will be expendable. They can be killed
14024
+ * without any consideration during scale down and they won't cause scale up.
14025
+ * Pods with null priority (PodPriority disabled) are non expendable.
14018
14026
  */
14019
14027
  expendablePodsPriorityCutoff: number;
14020
- /** How long a node should be unneeded before it is eligible for scale down. */
14028
+ /** How long a node should be unneeded before it is eligible to be scaled down. */
14021
14029
  scaleDownUnneededTime: string;
14022
14030
  /**
14023
- * Node utilization level, defined as sum of requested resources divided by
14031
+ * Node utilization level, defined as a sum of requested resources divided by
14024
14032
  * capacity, below which a node can be considered for scale down.
14025
14033
  */
14026
14034
  scaleDownUtilizationThreshold: number;
@@ -14034,52 +14042,48 @@ interface ClusterAutoscalerConfig {
14034
14042
  interface ClusterOpenIDConnectConfig {
14035
14043
  /**
14036
14044
  * URL of the provider which allows the API server to discover public signing
14037
- * keys. URL of the provider which allows the API server to discover public
14038
- * signing keys. Only URLs which use the `https://` scheme are accepted. This
14039
- * is typically the provider's discovery URL without a path, for example
14040
- * "https://accounts.google.com" or "https://login.salesforce.com". This URL
14041
- * should point to the level below .well-known/openid-configuration.
14045
+ * keys. Only URLs using the `https://` scheme are accepted. This is typically
14046
+ * the provider's discovery URL without a path, for example
14047
+ * "https://accounts.google.com" or "https://login.salesforce.com".
14042
14048
  */
14043
14049
  issuerUrl: string;
14044
- /** A client id that all tokens must be issued for. */
14050
+ /** A client ID that all tokens must be issued for. */
14045
14051
  clientId: string;
14046
14052
  /**
14047
- * JWT claim to use as the user name. JWT claim to use as the user name. By
14048
- * default `sub`, which is expected to be a unique identifier of the end user.
14049
- * Admins can choose other claims, such as `email` or `name`, depending on
14050
- * their provider. However, claims other than `email` will be prefixed with
14051
- * the issuer URL to prevent naming clashes with other plugins.
14053
+ * JWT claim to use as the user name. The default is `sub`, which is expected
14054
+ * to be the end user's unique identifier. Admins can choose other claims,
14055
+ * such as `email` or `name`, depending on their provider. However, claims
14056
+ * other than `email` will be prefixed with the issuer URL to prevent name
14057
+ * collision.
14052
14058
  */
14053
14059
  usernameClaim: string;
14054
14060
  /**
14055
- * Prefix prepended to username. Prefix prepended to username claims to
14056
- * prevent clashes with existing names (such as `system:` users). For example,
14057
- * the value `oidc:` will create usernames like `oidc:jane.doe`. If this flag
14058
- * isn't provided and `username_claim` is a value other than `email` the
14059
- * prefix defaults to `( Issuer URL )#` where `( Issuer URL )` is the value of
14060
- * `issuer_url`. The value `-` can be used to disable all prefixing.
14061
+ * Prefix prepended to username claims to prevent name collision (such as
14062
+ * `system:` users). For example, the value `oidc:` will create usernames like
14063
+ * `oidc:jane.doe`. If this flag is not provided and `username_claim` is a
14064
+ * value other than `email`, the prefix defaults to `( Issuer URL )#` where `(
14065
+ * Issuer URL )` is the value of `issuer_url`. The value `-` can be used to
14066
+ * disable all prefixing.
14061
14067
  */
14062
14068
  usernamePrefix: string;
14063
14069
  /** JWT claim to use as the user's group. */
14064
14070
  groupsClaim: string[];
14065
14071
  /**
14066
- * Prefix prepended to group claims. Prefix prepended to group claims to
14067
- * prevent clashes with existing names (such as `system:` groups). For
14068
- * example, the value `oidc:` will create group names like `oidc:engineering`
14069
- * and `oidc:infra`.
14072
+ * Prefix prepended to group claims to prevent name collision (such as
14073
+ * `system:` groups). For example, the value `oidc:` will create group names
14074
+ * like `oidc:engineering` and `oidc:infra`.
14070
14075
  */
14071
14076
  groupsPrefix: string;
14072
14077
  /**
14073
- * Multiple key=value pairs that describes a required claim in the ID token.
14074
- * Multiple key=value pairs that describes a required claim in the ID token.
14075
- * If set, the claims are verified to be present in the ID token with a
14076
- * matching value.
14078
+ * Multiple key=value pairs describing a required claim in the ID token. If
14079
+ * set, the claims are verified to be present in the ID token with a matching
14080
+ * value.
14077
14081
  */
14078
14082
  requiredClaim: string[];
14079
14083
  }
14080
14084
  /** Create cluster request. auto upgrade. */
14081
14085
  interface CreateClusterRequestAutoUpgrade {
14082
- /** Whether or not auto upgrade is enabled for the cluster. */
14086
+ /** Defines whether auto upgrade is enabled for the cluster. */
14083
14087
  enable: boolean;
14084
14088
  /** Maintenance window of the cluster auto upgrades. */
14085
14089
  maintenanceWindow?: MaintenanceWindow$1;
@@ -14102,16 +14106,15 @@ interface CreateClusterRequestAutoscalerConfig$1 {
14102
14106
  /** Detect similar node groups and balance the number of nodes between them. */
14103
14107
  balanceSimilarNodeGroups?: boolean;
14104
14108
  /**
14105
- * Pods with priority below cutoff will be expendable. Pods with priority
14106
- * below cutoff will be expendable. They can be killed without any
14107
- * consideration during scale down and they don't cause scale up. Pods with
14108
- * null priority (PodPriority disabled) are non expendable.
14109
+ * Pods with priority below cutoff will be expendable. They can be killed
14110
+ * without any consideration during scale down and they won't cause scale up.
14111
+ * Pods with null priority (PodPriority disabled) are non expendable.
14109
14112
  */
14110
14113
  expendablePodsPriorityCutoff?: number;
14111
- /** How long a node should be unneeded before it is eligible for scale down. */
14114
+ /** How long a node should be unneeded before it is eligible to be scaled down. */
14112
14115
  scaleDownUnneededTime?: string;
14113
14116
  /**
14114
- * Node utilization level, defined as sum of requested resources divided by
14117
+ * Node utilization level, defined as a sum of requested resources divided by
14115
14118
  * capacity, below which a node can be considered for scale down.
14116
14119
  */
14117
14120
  scaleDownUtilizationThreshold?: number;
@@ -14125,46 +14128,42 @@ interface CreateClusterRequestAutoscalerConfig$1 {
14125
14128
  interface CreateClusterRequestOpenIDConnectConfig$1 {
14126
14129
  /**
14127
14130
  * URL of the provider which allows the API server to discover public signing
14128
- * keys. URL of the provider which allows the API server to discover public
14129
- * signing keys. Only URLs which use the `https://` scheme are accepted. This
14130
- * is typically the provider's discovery URL without a path, for example
14131
- * "https://accounts.google.com" or "https://login.salesforce.com". This URL
14132
- * should point to the level below .well-known/openid-configuration.
14131
+ * keys. Only URLs using the `https://` scheme are accepted. This is typically
14132
+ * the provider's discovery URL without a path, for example
14133
+ * "https://accounts.google.com" or "https://login.salesforce.com".
14133
14134
  */
14134
14135
  issuerUrl: string;
14135
- /** A client id that all tokens must be issued for. */
14136
+ /** A client ID that all tokens must be issued for. */
14136
14137
  clientId: string;
14137
14138
  /**
14138
- * JWT claim to use as the user name. JWT claim to use as the user name. By
14139
- * default `sub`, which is expected to be a unique identifier of the end user.
14140
- * Admins can choose other claims, such as `email` or `name`, depending on
14141
- * their provider. However, claims other than `email` will be prefixed with
14142
- * the issuer URL to prevent naming clashes with other plugins.
14139
+ * JWT claim to use as the user name. The default is `sub`, which is expected
14140
+ * to be the end user's unique identifier. Admins can choose other claims,
14141
+ * such as `email` or `name`, depending on their provider. However, claims
14142
+ * other than `email` will be prefixed with the issuer URL to prevent name
14143
+ * collision.
14143
14144
  */
14144
14145
  usernameClaim?: string;
14145
14146
  /**
14146
- * Prefix prepended to username. Prefix prepended to username claims to
14147
- * prevent clashes with existing names (such as `system:` users). For example,
14148
- * the value `oidc:` will create usernames like `oidc:jane.doe`. If this flag
14149
- * isn't provided and `username_claim` is a value other than `email` the
14150
- * prefix defaults to `( Issuer URL )#` where `( Issuer URL )` is the value of
14151
- * `issuer_url`. The value `-` can be used to disable all prefixing.
14147
+ * Prefix prepended to username claims to prevent name collision (such as
14148
+ * `system:` users). For example, the value `oidc:` will create usernames like
14149
+ * `oidc:jane.doe`. If this flag is not provided and `username_claim` is a
14150
+ * value other than `email`, the prefix defaults to `( Issuer URL )#` where `(
14151
+ * Issuer URL )` is the value of `issuer_url`. The value `-` can be used to
14152
+ * disable all prefixing.
14152
14153
  */
14153
14154
  usernamePrefix?: string;
14154
14155
  /** JWT claim to use as the user's group. */
14155
14156
  groupsClaim?: string[];
14156
14157
  /**
14157
- * Prefix prepended to group claims. Prefix prepended to group claims to
14158
- * prevent clashes with existing names (such as `system:` groups). For
14159
- * example, the value `oidc:` will create group names like `oidc:engineering`
14160
- * and `oidc:infra`.
14158
+ * Prefix prepended to group claims to prevent name collision (such as
14159
+ * `system:` groups). For example, the value `oidc:` will create group names
14160
+ * like `oidc:engineering` and `oidc:infra`.
14161
14161
  */
14162
14162
  groupsPrefix?: string;
14163
14163
  /**
14164
- * Multiple key=value pairs that describes a required claim in the ID token.
14165
- * Multiple key=value pairs that describes a required claim in the ID token.
14166
- * If set, the claims are verified to be present in the ID token with a
14167
- * matching value.
14164
+ * Multiple key=value pairs describing a required claim in the ID token. If
14165
+ * set, the claims are verified to be present in the ID token with a matching
14166
+ * value.
14168
14167
  */
14169
14168
  requiredClaim?: string[];
14170
14169
  }
@@ -14173,11 +14172,10 @@ interface CreateClusterRequestPoolConfig$1 {
14173
14172
  /** Name of the pool. */
14174
14173
  name: string;
14175
14174
  /**
14176
- * Node type is the type of Scaleway Instance wanted for the pool. Node type
14177
- * is the type of Scaleway Instance wanted for the pool. Nodes with
14175
+ * Node type is the type of Scaleway Instance wanted for the pool. Nodes with
14178
14176
  * insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST).
14179
14177
  * 'external' is a special node type used to provision instances from other
14180
- * cloud providers.
14178
+ * cloud providers in a Kosmos Cluster.
14181
14179
  */
14182
14180
  nodeType: string;
14183
14181
  /** Placement group ID in which all the nodes of the pool will be created. */
@@ -14187,19 +14185,19 @@ interface CreateClusterRequestPoolConfig$1 {
14187
14185
  /** Size (number of nodes) of the pool. */
14188
14186
  size: number;
14189
14187
  /**
14190
- * Minimum size of the pool. Defines the minimum size of the pool. Note that
14191
- * this field will be used only when autoscaling is enabled.
14188
+ * Defines the minimum size of the pool. Note that this field is only used
14189
+ * when autoscaling is enabled on the pool.
14192
14190
  */
14193
14191
  minSize?: number;
14194
14192
  /**
14195
- * Maximum size of the pool. Defines the maximum size of the pool. Note that
14196
- * this field will be used only when autoscaling is enabled.
14193
+ * Defines the maximum size of the pool. Note that this field is only used
14194
+ * when autoscaling is enabled on the pool.
14197
14195
  */
14198
14196
  maxSize?: number;
14199
14197
  /**
14200
- * Container runtime for the nodes of the pool. Customization of the container
14201
- * runtime is available for each pool. Note that `docker` is deprecated since
14202
- * 1.20 and will be removed in 1.24.
14198
+ * Customization of the container runtime is available for each pool. Note
14199
+ * that `docker` has been deprecated since version 1.20 and will be removed by
14200
+ * version 1.24.
14203
14201
  */
14204
14202
  containerRuntime: Runtime;
14205
14203
  /** Defines whether the autohealing feature is enabled for the pool. */
@@ -14207,8 +14205,8 @@ interface CreateClusterRequestPoolConfig$1 {
14207
14205
  /** Tags associated with the pool. */
14208
14206
  tags: string[];
14209
14207
  /**
14210
- * Kubelet arguments to be used by this pool. Note that this feature is to be
14211
- * considered as experimental.
14208
+ * Kubelet arguments to be used by this pool. Note that this feature is
14209
+ * experimental.
14212
14210
  */
14213
14211
  kubeletArgs: Record<string, string>;
14214
14212
  /** Pool upgrade policy. */
@@ -14216,11 +14214,11 @@ interface CreateClusterRequestPoolConfig$1 {
14216
14214
  /** Zone in which the pool's nodes will be spawned. */
14217
14215
  zone: Zone;
14218
14216
  /**
14219
- * System volume disk type. Defines the system volume disk type, we provide
14220
- * two different types of volume (`volume_type`): `l_ssd` is a local block
14221
- * storage: your system is stored locally on the hypervisor of your node.
14222
- * `b_ssd` is a remote block storage: your system is stored on a centralised
14223
- * and resilient cluster.
14217
+ * Defines the system volume disk type. Two different types of volume
14218
+ * (`volume_type`) are provided: `l_ssd` is a local block storage which means
14219
+ * your system is stored locally on your node's hypervisor. `b_ssd` is a
14220
+ * remote block storage which means your system is stored on a centralized and
14221
+ * resilient cluster.
14224
14222
  */
14225
14223
  rootVolumeType: PoolVolumeType;
14226
14224
  /** System volume disk size. */
@@ -14248,7 +14246,7 @@ interface ExternalNode {
14248
14246
  }
14249
14247
  /** List cluster available versions response. */
14250
14248
  interface ListClusterAvailableVersionsResponse {
14251
- /** Available Kubernetes version for the cluster. */
14249
+ /** Available Kubernetes versions for the cluster. */
14252
14250
  versions: Version$2[];
14253
14251
  }
14254
14252
  /** List clusters response. */
@@ -14286,7 +14284,7 @@ interface MaintenanceWindow$1 {
14286
14284
  }
14287
14285
  /** Node. */
14288
14286
  interface Node {
14289
- /** ID of the node. */
14287
+ /** Node ID. */
14290
14288
  id: string;
14291
14289
  /** Pool ID of the node. */
14292
14290
  poolId: string;
@@ -14307,41 +14305,40 @@ interface Node {
14307
14305
  /** @deprecated Public IPv6 address of the node. */
14308
14306
  publicIpV6?: string;
14309
14307
  /**
14310
- * @deprecated Conditions of the node. These conditions contains the Node
14308
+ * @deprecated Conditions of the node. These conditions contain the Node
14311
14309
  * Problem Detector conditions, as well as some in house conditions.
14312
14310
  */
14313
14311
  conditions?: Record<string, string>;
14314
14312
  /** Status of the node. */
14315
14313
  status: NodeStatus;
14316
- /** Details of the error, if any occured when managing the node. */
14314
+ /** Details of the error, if any occurred when managing the node. */
14317
14315
  errorMessage?: string;
14318
14316
  /** Date on which the node was created. */
14319
14317
  createdAt?: Date;
14320
- /** Date at which the node was last updated. */
14318
+ /** Date on which the node was last updated. */
14321
14319
  updatedAt?: Date;
14322
14320
  }
14323
14321
  /** Pool. */
14324
14322
  interface Pool {
14325
- /** ID of the pool. */
14323
+ /** Pool ID. */
14326
14324
  id: string;
14327
14325
  /** Cluster ID of the pool. */
14328
14326
  clusterId: string;
14329
- /** Date at which the pool was created. */
14327
+ /** Date on which the pool was created. */
14330
14328
  createdAt?: Date;
14331
- /** Date at which the pool was last updated. */
14329
+ /** Date on which the pool was last updated. */
14332
14330
  updatedAt?: Date;
14333
- /** Name of the pool. */
14331
+ /** Pool name. */
14334
14332
  name: string;
14335
- /** Status of the pool. */
14333
+ /** Pool status. */
14336
14334
  status: PoolStatus;
14337
- /** Version of the pool. */
14335
+ /** Pool version. */
14338
14336
  version: string;
14339
14337
  /**
14340
- * Node type is the type of Scaleway Instance wanted for the pool. Node type
14341
- * is the type of Scaleway Instance wanted for the pool. Nodes with
14338
+ * Node type is the type of Scaleway Instance wanted for the pool. Nodes with
14342
14339
  * insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST).
14343
14340
  * 'external' is a special node type used to provision instances from other
14344
- * cloud providers.
14341
+ * cloud providers in a Kosmos Cluster.
14345
14342
  */
14346
14343
  nodeType: string;
14347
14344
  /** Defines whether the autoscaling feature is enabled for the pool. */
@@ -14349,19 +14346,19 @@ interface Pool {
14349
14346
  /** Size (number of nodes) of the pool. */
14350
14347
  size: number;
14351
14348
  /**
14352
- * Minimum size of the pool. Defines the minimum size of the pool. Note that
14353
- * this field will be used only when autoscaling is enabled.
14349
+ * Defines the minimum size of the pool. Note that this field is only used
14350
+ * when autoscaling is enabled on the pool.
14354
14351
  */
14355
14352
  minSize: number;
14356
14353
  /**
14357
- * Maximum size of the pool. Defines the maximum size of the pool. Note that
14358
- * this field will be used only when autoscaling is enabled.
14354
+ * Defines the maximum size of the pool. Note that this field is only used
14355
+ * when autoscaling is enabled on the pool.
14359
14356
  */
14360
14357
  maxSize: number;
14361
14358
  /**
14362
- * Container runtime for the nodes of the pool. Customization of the container
14363
- * runtime is available for each pool. Note that `docker` is deprecated since
14364
- * 1.20 and will be removed in 1.24.
14359
+ * Customization of the container runtime is available for each pool. Note
14360
+ * that `docker` has been deprecated since version 1.20 and will be removed by
14361
+ * version 1.24.
14365
14362
  */
14366
14363
  containerRuntime: Runtime;
14367
14364
  /** Defines whether the autohealing feature is enabled for the pool. */
@@ -14371,8 +14368,8 @@ interface Pool {
14371
14368
  /** Placement group ID in which all the nodes of the pool will be created. */
14372
14369
  placementGroupId?: string;
14373
14370
  /**
14374
- * Kubelet arguments to be used by this pool. Note that this feature is to be
14375
- * considered as experimental.
14371
+ * Kubelet arguments to be used by this pool. Note that this feature is
14372
+ * experimental.
14376
14373
  */
14377
14374
  kubeletArgs: Record<string, string>;
14378
14375
  /** Pool upgrade policy. */
@@ -14380,11 +14377,11 @@ interface Pool {
14380
14377
  /** Zone in which the pool's nodes will be spawned. */
14381
14378
  zone: Zone;
14382
14379
  /**
14383
- * System volume disk type. Defines the system volume disk type, we provide
14384
- * two different types of volume (`volume_type`): `l_ssd` is a local block
14385
- * storage: your system is stored locally on the hypervisor of your node.
14386
- * `b_ssd` is a remote block storage: your system is stored on a centralised
14387
- * and resilient cluster.
14380
+ * Defines the system volume disk type. Two different types of volume
14381
+ * (`volume_type`) are provided: `l_ssd` is a local block storage which means
14382
+ * your system is stored locally on your node's hypervisor. `b_ssd` is a
14383
+ * remote block storage which means your system is stored on a centralized and
14384
+ * resilient cluster.
14388
14385
  */
14389
14386
  rootVolumeType: PoolVolumeType;
14390
14387
  /** System volume disk size. */
@@ -14398,7 +14395,7 @@ interface PoolUpgradePolicy {
14398
14395
  }
14399
14396
  /** Update cluster request. auto upgrade. */
14400
14397
  interface UpdateClusterRequestAutoUpgrade {
14401
- /** Whether or not auto upgrade is enabled for the cluster. */
14398
+ /** Defines whether auto upgrade is enabled for the cluster. */
14402
14399
  enable?: boolean;
14403
14400
  /** Maintenance window of the cluster auto upgrades. */
14404
14401
  maintenanceWindow?: MaintenanceWindow$1;
@@ -14421,16 +14418,15 @@ interface UpdateClusterRequestAutoscalerConfig$1 {
14421
14418
  /** Detect similar node groups and balance the number of nodes between them. */
14422
14419
  balanceSimilarNodeGroups?: boolean;
14423
14420
  /**
14424
- * Pods with priority below cutoff will be expendable. Pods with priority
14425
- * below cutoff will be expendable. They can be killed without any
14426
- * consideration during scale down and they don't cause scale up. Pods with
14427
- * null priority (PodPriority disabled) are non expendable.
14421
+ * Pods with priority below cutoff will be expendable. They can be killed
14422
+ * without any consideration during scale down and they won't cause scale up.
14423
+ * Pods with null priority (PodPriority disabled) are non expendable.
14428
14424
  */
14429
14425
  expendablePodsPriorityCutoff?: number;
14430
- /** How long a node should be unneeded before it is eligible for scale down. */
14426
+ /** How long a node should be unneeded before it is eligible to be scaled down. */
14431
14427
  scaleDownUnneededTime?: string;
14432
14428
  /**
14433
- * Node utilization level, defined as sum of requested resources divided by
14429
+ * Node utilization level, defined as a sum of requested resources divided by
14434
14430
  * capacity, below which a node can be considered for scale down.
14435
14431
  */
14436
14432
  scaleDownUtilizationThreshold?: number;
@@ -14444,46 +14440,42 @@ interface UpdateClusterRequestAutoscalerConfig$1 {
14444
14440
  interface UpdateClusterRequestOpenIDConnectConfig {
14445
14441
  /**
14446
14442
  * URL of the provider which allows the API server to discover public signing
14447
- * keys. URL of the provider which allows the API server to discover public
14448
- * signing keys. Only URLs which use the `https://` scheme are accepted. This
14449
- * is typically the provider's discovery URL without a path, for example
14450
- * "https://accounts.google.com" or "https://login.salesforce.com". This URL
14451
- * should point to the level below .well-known/openid-configuration.
14443
+ * keys. Only URLs using the `https://` scheme are accepted. This is typically
14444
+ * the provider's discovery URL without a path, for example
14445
+ * "https://accounts.google.com" or "https://login.salesforce.com".
14452
14446
  */
14453
14447
  issuerUrl?: string;
14454
- /** A client id that all tokens must be issued for. */
14448
+ /** A client ID that all tokens must be issued for. */
14455
14449
  clientId?: string;
14456
14450
  /**
14457
- * JWT claim to use as the user name. JWT claim to use as the user name. By
14458
- * default `sub`, which is expected to be a unique identifier of the end user.
14459
- * Admins can choose other claims, such as `email` or `name`, depending on
14460
- * their provider. However, claims other than `email` will be prefixed with
14461
- * the issuer URL to prevent naming clashes with other plugins.
14451
+ * JWT claim to use as the user name. The default is `sub`, which is expected
14452
+ * to be the end user's unique identifier. Admins can choose other claims,
14453
+ * such as `email` or `name`, depending on their provider. However, claims
14454
+ * other than `email` will be prefixed with the issuer URL to prevent name
14455
+ * collision.
14462
14456
  */
14463
14457
  usernameClaim?: string;
14464
14458
  /**
14465
- * Prefix prepended to username. Prefix prepended to username claims to
14466
- * prevent clashes with existing names (such as `system:` users). For example,
14467
- * the value `oidc:` will create usernames like `oidc:jane.doe`. If this flag
14468
- * isn't provided and `username_claim` is a value other than `email` the
14469
- * prefix defaults to `( Issuer URL )#` where `( Issuer URL )` is the value of
14470
- * `issuer_url`. The value `-` can be used to disable all prefixing.
14459
+ * Prefix prepended to username claims to prevent name collision (such as
14460
+ * `system:` users). For example, the value `oidc:` will create usernames like
14461
+ * `oidc:jane.doe`. If this flag is not provided and `username_claim` is a
14462
+ * value other than `email`, the prefix defaults to `( Issuer URL )#` where `(
14463
+ * Issuer URL )` is the value of `issuer_url`. The value `-` can be used to
14464
+ * disable all prefixing.
14471
14465
  */
14472
14466
  usernamePrefix?: string;
14473
14467
  /** JWT claim to use as the user's group. */
14474
14468
  groupsClaim?: string[];
14475
14469
  /**
14476
- * Prefix prepended to group claims. Prefix prepended to group claims to
14477
- * prevent clashes with existing names (such as `system:` groups). For
14478
- * example, the value `oidc:` will create group names like `oidc:engineering`
14479
- * and `oidc:infra`.
14470
+ * Prefix prepended to group claims to prevent name collision (such as
14471
+ * `system:` groups). For example, the value `oidc:` will create group names
14472
+ * like `oidc:engineering` and `oidc:infra`.
14480
14473
  */
14481
14474
  groupsPrefix?: string;
14482
14475
  /**
14483
- * Multiple key=value pairs that describes a required claim in the ID token.
14484
- * Multiple key=value pairs that describes a required claim in the ID token.
14485
- * If set, the claims are verified to be present in the ID token with a
14486
- * matching value.
14476
+ * Multiple key=value pairs describing a required claim in the ID token. If
14477
+ * set, the claims are verified to be present in the ID token with a matching
14478
+ * value.
14487
14479
  */
14488
14480
  requiredClaim?: string[];
14489
14481
  }
@@ -14522,17 +14514,20 @@ type ListClustersRequest$2 = {
14522
14514
  organizationId?: string;
14523
14515
  /** Project ID on which to filter the returned clusters. */
14524
14516
  projectId?: string;
14525
- /** Sort order of the returned clusters. */
14517
+ /** Sort order of returned clusters. */
14526
14518
  orderBy?: ListClustersRequestOrderBy$1;
14527
- /** Page number for the returned clusters. */
14519
+ /** Page number to return for clusters, from the paginated results. */
14528
14520
  page?: number;
14529
14521
  /** Maximum number of clusters per page. */
14530
14522
  pageSize?: number;
14531
- /** Name on which to filter the returned clusters. */
14523
+ /**
14524
+ * Name to filter on, only clusters containing this substring in their name
14525
+ * will be returned.
14526
+ */
14532
14527
  name?: string;
14533
- /** Status on which to filter the returned clusters. */
14528
+ /** Status to filter on, only clusters with this status will be returned. */
14534
14529
  status?: ClusterStatus$1;
14535
- /** Type on which to filter the returned clusters. */
14530
+ /** Type to filter on, only clusters with this type will be returned. */
14536
14531
  type?: string;
14537
14532
  };
14538
14533
  type CreateClusterRequest$2 = {
@@ -14555,35 +14550,41 @@ type CreateClusterRequest$2 = {
14555
14550
  * could be set.
14556
14551
  */
14557
14552
  projectId?: string;
14558
- /** Type of the cluster (possible values are kapsule, multicloud). */
14553
+ /**
14554
+ * Type of the cluster (possible values are kapsule, multicloud,
14555
+ * kapsule-dedicated-8, kapsule-dedicated-16).
14556
+ */
14559
14557
  type: string;
14560
- /** Name of the cluster. */
14558
+ /** Cluster name. */
14561
14559
  name?: string;
14562
- /** Description of the cluster. */
14560
+ /** Cluster description. */
14563
14561
  description: string;
14564
14562
  /** Tags associated with the cluster. */
14565
14563
  tags?: string[];
14566
14564
  /** Kubernetes version of the cluster. */
14567
14565
  version: string;
14568
- /** Container Network Interface (CNI) plugin that will run in the cluster. */
14566
+ /** Container Network Interface (CNI) plugin running in the cluster. */
14569
14567
  cni: CNI;
14570
- /** @deprecated Defines if the Kubernetes Dashboard is enabled in the cluster. */
14568
+ /**
14569
+ * @deprecated Defines whether the Kubernetes Dashboard is enabled in the
14570
+ * cluster.
14571
+ */
14571
14572
  enableDashboard?: boolean;
14572
- /** @deprecated Ingress Controller that will run in the cluster. */
14573
+ /** @deprecated Ingress Controller running in the cluster (deprecated feature). */
14573
14574
  ingress?: Ingress;
14574
- /** Pools to be created along with the cluster. */
14575
+ /** Pools created along with the cluster. */
14575
14576
  pools?: CreateClusterRequestPoolConfig$1[];
14576
14577
  /**
14577
- * Autoscaler config for the cluster. This field allows to specify some
14578
- * configuration for the autoscaler, which is an implementation of the
14579
- * cluster-autoscaler
14578
+ * Autoscaler configuration for the cluster. It allows you to set (to an
14579
+ * extent) your preferred autoscaler configuration, which is an implementation
14580
+ * of the cluster-autoscaler
14580
14581
  * (https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler/).
14581
14582
  */
14582
14583
  autoscalerConfig?: CreateClusterRequestAutoscalerConfig$1;
14583
14584
  /**
14584
14585
  * Auto upgrade configuration of the cluster. This configuration enables to
14585
14586
  * set a specific 2-hour time window in which the cluster can be automatically
14586
- * updated to the latest patch version in the current minor one.
14587
+ * updated to the latest patch version.
14587
14588
  */
14588
14589
  autoUpgrade?: CreateClusterRequestAutoUpgrade;
14589
14590
  /** List of feature gates to enable. */
@@ -14612,7 +14613,7 @@ type GetClusterRequest$1 = {
14612
14613
  * config.
14613
14614
  */
14614
14615
  region?: Region;
14615
- /** The ID of the requested cluster. */
14616
+ /** ID of the requested cluster. */
14616
14617
  clusterId: string;
14617
14618
  };
14618
14619
  type UpdateClusterRequest$2 = {
@@ -14623,25 +14624,21 @@ type UpdateClusterRequest$2 = {
14623
14624
  region?: Region;
14624
14625
  /** ID of the cluster to update. */
14625
14626
  clusterId: string;
14626
- /** New external name of the cluster. */
14627
+ /** New external name for the cluster. */
14627
14628
  name?: string;
14628
- /** New description of the cluster. */
14629
+ /** New description for the cluster. */
14629
14630
  description?: string;
14630
14631
  /** New tags associated with the cluster. */
14631
14632
  tags?: string[];
14632
- /**
14633
- * New autoscaler config for the cluster. Object defining the configuration
14634
- * for the autoscaler, which is an implementation of the
14635
- * [cluster-autoscaler](https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler/).
14636
- */
14633
+ /** New autoscaler config for the cluster. */
14637
14634
  autoscalerConfig?: UpdateClusterRequestAutoscalerConfig$1;
14638
- /** @deprecated New value of the Kubernetes Dashboard enablement. */
14635
+ /** @deprecated New value for the Kubernetes Dashboard enablement. */
14639
14636
  enableDashboard?: boolean;
14640
- /** @deprecated New Ingress Controller for the cluster. */
14637
+ /** @deprecated New Ingress Controller for the cluster (deprecated feature). */
14641
14638
  ingress?: Ingress;
14642
14639
  /**
14643
- * New auto upgrade configuration of the cluster. New auto upgrade
14644
- * configuration of the cluster. Note that all fields need to be set.
14640
+ * New auto upgrade configuration for the cluster. Note that all fields need
14641
+ * to be set.
14645
14642
  */
14646
14643
  autoUpgrade?: UpdateClusterRequestAutoUpgrade;
14647
14644
  /** List of feature gates to enable. */
@@ -14668,8 +14665,8 @@ type DeleteClusterRequest$1 = {
14668
14665
  /** ID of the cluster to delete. */
14669
14666
  clusterId: string;
14670
14667
  /**
14671
- * Set true if you want to delete all volumes (including retain volume type)
14672
- * and loadbalancers whose name start with cluster ID.
14668
+ * Defines whether all volumes (including retain volume type) and Load
14669
+ * Balancers with a name starting with the cluster ID will also be deleted.
14673
14670
  */
14674
14671
  withAdditionalResources: boolean;
14675
14672
  };
@@ -14682,14 +14679,14 @@ type UpgradeClusterRequest = {
14682
14679
  /** ID of the cluster to upgrade. */
14683
14680
  clusterId: string;
14684
14681
  /**
14685
- * New Kubernetes version of the cluster. New Kubernetes version of the
14686
- * cluster. Note that the version shoud either be a higher patch version of
14687
- * the same minor version or the direct minor version after the current one.
14682
+ * New Kubernetes version of the cluster. Note that the version should either
14683
+ * be a higher patch version of the same minor version or the direct minor
14684
+ * version after the current one.
14688
14685
  */
14689
14686
  version: string;
14690
14687
  /**
14691
- * Enablement of the pools upgrade. This field also trigger pools upgrade once
14692
- * the control plane is upgraded.
14688
+ * Defines whether pools will also be upgraded once the control plane is
14689
+ * upgraded.
14693
14690
  */
14694
14691
  upgradePools: boolean;
14695
14692
  };
@@ -14713,10 +14710,7 @@ type ListClusterAvailableVersionsRequest = {
14713
14710
  * config.
14714
14711
  */
14715
14712
  region?: Region;
14716
- /**
14717
- * ID of the cluster which the available Kuberentes versions will be listed
14718
- * from.
14719
- */
14713
+ /** Cluster ID for which the available Kubernetes versions will be listed. */
14720
14714
  clusterId: string;
14721
14715
  };
14722
14716
  type ResetClusterAdminTokenRequest = {
@@ -14725,7 +14719,7 @@ type ResetClusterAdminTokenRequest = {
14725
14719
  * config.
14726
14720
  */
14727
14721
  region?: Region;
14728
- /** ID of the cluster on which the admin token will be renewed. */
14722
+ /** Cluster ID on which the admin token will be renewed. */
14729
14723
  clusterId: string;
14730
14724
  };
14731
14725
  type ListPoolsRequest$1 = {
@@ -14734,17 +14728,20 @@ type ListPoolsRequest$1 = {
14734
14728
  * config.
14735
14729
  */
14736
14730
  region?: Region;
14737
- /** ID of the cluster from which the pools will be listed from. */
14731
+ /** ID of the cluster whose pools will be listed. */
14738
14732
  clusterId: string;
14739
- /** Sort order of the returned pools. */
14733
+ /** Sort order of returned pools. */
14740
14734
  orderBy?: ListPoolsRequestOrderBy;
14741
14735
  /** Page number for the returned pools. */
14742
14736
  page?: number;
14743
14737
  /** Maximum number of pools per page. */
14744
14738
  pageSize?: number;
14745
- /** Name on which to filter the returned pools. */
14739
+ /**
14740
+ * Name to filter on, only pools containing this substring in their name will
14741
+ * be returned.
14742
+ */
14746
14743
  name?: string;
14747
- /** Status on which to filter the returned pools. */
14744
+ /** Status to filter on, only pools with this status will be returned. */
14748
14745
  status?: PoolStatus;
14749
14746
  };
14750
14747
  type CreatePoolRequest$1 = {
@@ -14753,16 +14750,15 @@ type CreatePoolRequest$1 = {
14753
14750
  * config.
14754
14751
  */
14755
14752
  region?: Region;
14756
- /** ID of the cluster in which the pool will be created. */
14753
+ /** Cluster ID to which the pool will be attached. */
14757
14754
  clusterId: string;
14758
- /** Name of the pool. */
14755
+ /** Pool name. */
14759
14756
  name?: string;
14760
14757
  /**
14761
- * Node type is the type of Scaleway Instance wanted for the pool. Node type
14762
- * is the type of Scaleway Instance wanted for the pool. Nodes with
14758
+ * Node type is the type of Scaleway Instance wanted for the pool. Nodes with
14763
14759
  * insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST).
14764
14760
  * 'external' is a special node type used to provision instances from other
14765
- * cloud providers.
14761
+ * cloud providers in a Kosmos Cluster.
14766
14762
  */
14767
14763
  nodeType: string;
14768
14764
  /** Placement group ID in which all the nodes of the pool will be created. */
@@ -14772,19 +14768,19 @@ type CreatePoolRequest$1 = {
14772
14768
  /** Size (number of nodes) of the pool. */
14773
14769
  size: number;
14774
14770
  /**
14775
- * Minimum size of the pool. Defines the minimum size of the pool. Note that
14776
- * this field will be used only when autoscaling is enabled.
14771
+ * Defines the minimum size of the pool. Note that this field is only used
14772
+ * when autoscaling is enabled on the pool.
14777
14773
  */
14778
14774
  minSize?: number;
14779
14775
  /**
14780
- * Maximum size of the pool. Defines the maximum size of the pool. Note that
14781
- * this field will be used only when autoscaling is enabled.
14776
+ * Defines the maximum size of the pool. Note that this field is only used
14777
+ * when autoscaling is enabled on the pool.
14782
14778
  */
14783
14779
  maxSize?: number;
14784
14780
  /**
14785
- * Container runtime for the nodes of the pool. Customization of the container
14786
- * runtime is available for each pool. Note that `docker` is deprecated since
14787
- * 1.20 and will be removed in 1.24.
14781
+ * Customization of the container runtime is available for each pool. Note
14782
+ * that `docker` has been deprecated since version 1.20 and will be removed by
14783
+ * version 1.24.
14788
14784
  */
14789
14785
  containerRuntime?: Runtime;
14790
14786
  /** Defines whether the autohealing feature is enabled for the pool. */
@@ -14792,8 +14788,8 @@ type CreatePoolRequest$1 = {
14792
14788
  /** Tags associated with the pool. */
14793
14789
  tags?: string[];
14794
14790
  /**
14795
- * Kubelet arguments to be used by this pool. Note that this feature is to be
14796
- * considered as experimental.
14791
+ * Kubelet arguments to be used by this pool. Note that this feature is
14792
+ * experimental.
14797
14793
  */
14798
14794
  kubeletArgs?: Record<string, string>;
14799
14795
  /** Pool upgrade policy. */
@@ -14801,11 +14797,11 @@ type CreatePoolRequest$1 = {
14801
14797
  /** Zone in which the pool's nodes will be spawned. */
14802
14798
  zone?: Zone;
14803
14799
  /**
14804
- * System volume disk type. Defines the system volume disk type, we provide
14805
- * two different types of volume (`volume_type`): `l_ssd` is a local block
14806
- * storage: your system is stored locally on the hypervisor of your node.
14807
- * `b_ssd` is a remote block storage: your system is stored on a centralised
14808
- * and resilient cluster.
14800
+ * Defines the system volume disk type. Two different types of volume
14801
+ * (`volume_type`) are provided: `l_ssd` is a local block storage which means
14802
+ * your system is stored locally on your node's hypervisor. `b_ssd` is a
14803
+ * remote block storage which means your system is stored on a centralized and
14804
+ * resilient cluster.
14809
14805
  */
14810
14806
  rootVolumeType?: PoolVolumeType;
14811
14807
  /** System volume disk size. */
@@ -14839,24 +14835,24 @@ type UpdatePoolRequest = {
14839
14835
  region?: Region;
14840
14836
  /** ID of the pool to update. */
14841
14837
  poolId: string;
14842
- /** New value for the enablement of autoscaling for the pool. */
14838
+ /** New value for the pool autoscaling enablement. */
14843
14839
  autoscaling?: boolean;
14844
- /** New size for the pool. */
14840
+ /** New desired pool size. */
14845
14841
  size?: number;
14846
- /** New minimun size for the pool. */
14842
+ /** New minimum size for the pool. */
14847
14843
  minSize?: number;
14848
14844
  /** New maximum size for the pool. */
14849
14845
  maxSize?: number;
14850
- /** New value for the enablement of autohealing for the pool. */
14846
+ /** New value for the pool autohealing enablement. */
14851
14847
  autohealing?: boolean;
14852
14848
  /** New tags associated with the pool. */
14853
14849
  tags?: string[];
14854
14850
  /**
14855
- * New Kubelet arguments to be used by this pool. Note that this feature is to
14856
- * be considered as experimental.
14851
+ * New Kubelet arguments to be used by this pool. Note that this feature is
14852
+ * experimental.
14857
14853
  */
14858
14854
  kubeletArgs?: Record<string, string>;
14859
- /** Upgrade policy for the pool. */
14855
+ /** New upgrade policy for the pool. */
14860
14856
  upgradePolicy?: UpdatePoolRequestUpgradePolicy;
14861
14857
  };
14862
14858
  type DeletePoolRequest = {
@@ -14892,9 +14888,12 @@ type ListNodesRequest$1 = {
14892
14888
  page?: number;
14893
14889
  /** Maximum number of nodes per page. */
14894
14890
  pageSize?: number;
14895
- /** Name on which to filter the returned nodes. */
14891
+ /**
14892
+ * Name to filter on, only nodes containing this substring in their name will
14893
+ * be returned.
14894
+ */
14896
14895
  name?: string;
14897
- /** Status on which to filter the returned nodes. */
14896
+ /** Status to filter on, only nodes with this status will be returned. */
14898
14897
  status?: NodeStatus;
14899
14898
  };
14900
14899
  type GetNodeRequest = {
@@ -14960,7 +14959,7 @@ type GetClusterKubeConfigRequest = {
14960
14959
  * config.
14961
14960
  */
14962
14961
  region?: Region;
14963
- /** ID of the cluster to download the kubeconfig from. */
14962
+ /** Cluster ID for which to download the kubeconfig. */
14964
14963
  clusterId: string;
14965
14964
  };
14966
14965
 
@@ -14970,8 +14969,7 @@ declare class API$d extends API$q {
14970
14969
  static readonly LOCALITIES: Region[];
14971
14970
  protected pageOfListClusters: (request?: Readonly<ListClustersRequest$2>) => Promise<ListClustersResponse$1>;
14972
14971
  /**
14973
- * List all clusters. List all the existing Kubernetes clusters in a specific
14974
- * Region.
14972
+ * List Clusters. List all existing Kubernetes clusters in a specific region.
14975
14973
  *
14976
14974
  * @param request - The request {@link ListClustersRequest}
14977
14975
  * @returns A Promise of ListClustersResponse
@@ -14981,16 +14979,14 @@ declare class API$d extends API$q {
14981
14979
  [Symbol.asyncIterator]: () => AsyncGenerator<Cluster$1[], void, void>;
14982
14980
  };
14983
14981
  /**
14984
- * Create a new cluster. Create a new Kubernetes cluster on a Scaleway
14985
- * account.
14982
+ * Create a new Cluster. Create a new Kubernetes cluster in a Scaleway region.
14986
14983
  *
14987
14984
  * @param request - The request {@link CreateClusterRequest}
14988
14985
  * @returns A Promise of Cluster
14989
14986
  */
14990
14987
  createCluster: (request: Readonly<CreateClusterRequest$2>) => Promise<Cluster$1>;
14991
14988
  /**
14992
- * Get specific cluster information. Get details about a specific Kubernetes
14993
- * cluster.
14989
+ * Get a Cluster. Retrieve information about a specific Kubernetes cluster.
14994
14990
  *
14995
14991
  * @param request - The request {@link GetClusterRequest}
14996
14992
  * @returns A Promise of Cluster
@@ -15005,26 +15001,25 @@ declare class API$d extends API$q {
15005
15001
  */
15006
15002
  waitForCluster: (request: Readonly<GetClusterRequest$1>, options?: Readonly<WaitForOptions<Cluster$1>>) => Promise<Cluster$1>;
15007
15003
  /**
15008
- * Update a cluster. Update a specific Kubernetes cluster. Note that this
15009
- * method is designed to update details such as name, description, tags and
15010
- * configuration. However, you cannot upgrade a cluster with this method. To
15011
- * do so, use the dedicated endpoint.
15004
+ * Update a Cluster. Update information on a specific Kubernetes cluster. You
15005
+ * can update details such as its name, description, tags and configuration.
15006
+ * To upgrade a cluster, you will need to use the dedicated endpoint.
15012
15007
  *
15013
15008
  * @param request - The request {@link UpdateClusterRequest}
15014
15009
  * @returns A Promise of Cluster
15015
15010
  */
15016
15011
  updateCluster: (request: Readonly<UpdateClusterRequest$2>) => Promise<Cluster$1>;
15017
15012
  /**
15018
- * Delete a cluster. Delete a specific cluster and all its associated pools
15019
- * and nodes. Note that this method will not delete any Load Balancers or
15020
- * Block Volumes that are associated with the cluster.
15013
+ * Delete a Cluster. Delete a specific Kubernetes cluster and all its
15014
+ * associated pools and nodes. Note that this method will not delete any Load
15015
+ * Balancer or Block Volume that are associated with the cluster.
15021
15016
  *
15022
15017
  * @param request - The request {@link DeleteClusterRequest}
15023
15018
  * @returns A Promise of Cluster
15024
15019
  */
15025
15020
  deleteCluster: (request: Readonly<DeleteClusterRequest$1>) => Promise<Cluster$1>;
15026
15021
  /**
15027
- * Upgrade a cluster. Upgrade a specific Kubernetes cluster and/or its
15022
+ * Upgrade a Cluster. Upgrade a specific Kubernetes cluster and possibly its
15028
15023
  * associated pools to a specific and supported Kubernetes version.
15029
15024
  *
15030
15025
  * @param request - The request {@link UpgradeClusterRequest}
@@ -15032,15 +15027,15 @@ declare class API$d extends API$q {
15032
15027
  */
15033
15028
  upgradeCluster: (request: Readonly<UpgradeClusterRequest>) => Promise<Cluster$1>;
15034
15029
  /**
15035
- * Change type of a cluster. Change type of a specific Kubernetes cluster.
15030
+ * Change the Cluster type. Change the type of a specific Kubernetes cluster.
15036
15031
  *
15037
15032
  * @param request - The request {@link SetClusterTypeRequest}
15038
15033
  * @returns A Promise of Cluster
15039
15034
  */
15040
15035
  setClusterType: (request: Readonly<SetClusterTypeRequest>) => Promise<Cluster$1>;
15041
15036
  /**
15042
- * List available versions for a cluster. List the versions that a specific
15043
- * Kubernetes cluster is allowed to upgrade to. Results will comprise every
15037
+ * List available versions for a Cluster. List the versions that a specific
15038
+ * Kubernetes cluster is allowed to upgrade to. Results will include every
15044
15039
  * patch version greater than the current patch, as well as one minor version
15045
15040
  * ahead of the current version. Any upgrade skipping a minor version will not
15046
15041
  * work.
@@ -15051,17 +15046,17 @@ declare class API$d extends API$q {
15051
15046
  listClusterAvailableVersions: (request: Readonly<ListClusterAvailableVersionsRequest>) => Promise<ListClusterAvailableVersionsResponse>;
15052
15047
  protected _getClusterKubeConfig: (request: Readonly<GetClusterKubeConfigRequest>) => Promise<Blob>;
15053
15048
  /**
15054
- * Reset the admin token of a cluster. Reset the admin token for a specific
15055
- * Kubernetes cluster. This will invalidate the old admin token (which will
15056
- * not be usable afterwards) and create a new one. Note that you will need to
15057
- * redownload kubeconfig in order to keep interacting with the cluster.
15049
+ * Reset the admin token of a Cluster. Reset the admin token for a specific
15050
+ * Kubernetes cluster. This will revoke the old admin token (which will not be
15051
+ * usable afterwards) and create a new one. Note that you will need to
15052
+ * download kubeconfig again to keep interacting with the cluster.
15058
15053
  *
15059
15054
  * @param request - The request {@link ResetClusterAdminTokenRequest}
15060
15055
  */
15061
15056
  resetClusterAdminToken: (request: Readonly<ResetClusterAdminTokenRequest>) => Promise<void>;
15062
15057
  protected pageOfListPools: (request: Readonly<ListPoolsRequest$1>) => Promise<ListPoolsResponse>;
15063
15058
  /**
15064
- * List all the pools in a cluster. List all the existing pools for a specific
15059
+ * List Pools in a Cluster. List all the existing pools for a specific
15065
15060
  * Kubernetes cluster.
15066
15061
  *
15067
15062
  * @param request - The request {@link ListPoolsRequest}
@@ -15072,7 +15067,7 @@ declare class API$d extends API$q {
15072
15067
  [Symbol.asyncIterator]: () => AsyncGenerator<Pool[], void, void>;
15073
15068
  };
15074
15069
  /**
15075
- * Create a new pool in a cluster. Create a new pool in a specific Kubernetes
15070
+ * Create a new Pool in a Cluster. Create a new pool in a specific Kubernetes
15076
15071
  * cluster.
15077
15072
  *
15078
15073
  * @param request - The request {@link CreatePoolRequest}
@@ -15080,8 +15075,8 @@ declare class API$d extends API$q {
15080
15075
  */
15081
15076
  createPool: (request: Readonly<CreatePoolRequest$1>) => Promise<Pool>;
15082
15077
  /**
15083
- * Get a pool in a cluster. Get details about a specific pool in a Kubernetes
15084
- * cluster.
15078
+ * Get a Pool in a Cluster. Retrieve details about a specific pool in a
15079
+ * Kubernetes cluster.
15085
15080
  *
15086
15081
  * @param request - The request {@link GetPoolRequest}
15087
15082
  * @returns A Promise of Pool
@@ -15096,33 +15091,33 @@ declare class API$d extends API$q {
15096
15091
  */
15097
15092
  waitForPool: (request: Readonly<GetPoolRequest>, options?: Readonly<WaitForOptions<Pool>>) => Promise<Pool>;
15098
15093
  /**
15099
- * Upgrade a pool in a cluster. Upgrade the Kubernetes version of a specific
15100
- * pool. Note that this will work when the targeted version is the same than
15101
- * the version of the cluster.
15094
+ * Upgrade a Pool in a Cluster. Upgrade the Kubernetes version of a specific
15095
+ * pool. Note that it only works if the targeted version matches the cluster's
15096
+ * version.
15102
15097
  *
15103
15098
  * @param request - The request {@link UpgradePoolRequest}
15104
15099
  * @returns A Promise of Pool
15105
15100
  */
15106
15101
  upgradePool: (request: Readonly<UpgradePoolRequest>) => Promise<Pool>;
15107
15102
  /**
15108
- * Update a pool in a cluster. Update attributes of a specific pool, such as
15109
- * size, autoscaling settings, and tags.
15103
+ * Update a Pool in a Cluster. Update the attributes of a specific pool, such
15104
+ * as its desired size, autoscaling settings, and tags.
15110
15105
  *
15111
15106
  * @param request - The request {@link UpdatePoolRequest}
15112
15107
  * @returns A Promise of Pool
15113
15108
  */
15114
15109
  updatePool: (request: Readonly<UpdatePoolRequest>) => Promise<Pool>;
15115
15110
  /**
15116
- * Delete a pool in a cluster. Delete a specific pool from a cluster. All of
15117
- * the pool's nodes will also be deleted.
15111
+ * Delete a Pool in a Cluster. Delete a specific pool from a cluster. Note
15112
+ * that all the pool's nodes will also be deleted.
15118
15113
  *
15119
15114
  * @param request - The request {@link DeletePoolRequest}
15120
15115
  * @returns A Promise of Pool
15121
15116
  */
15122
15117
  deletePool: (request: Readonly<DeletePoolRequest>) => Promise<Pool>;
15123
15118
  /**
15124
- * Create a Kosmos node. Get metadata about a Kosmos node. This method is not
15125
- * intended to be directly called by end users, only by the
15119
+ * Create a Kosmos node. Retrieve metadata for a Kosmos node. This method is
15120
+ * not intended to be called by end users but rather programmatically by the
15126
15121
  * kapsule-node-agent.
15127
15122
  *
15128
15123
  * @param request - The request {@link CreateExternalNodeRequest}
@@ -15131,7 +15126,7 @@ declare class API$d extends API$q {
15131
15126
  createExternalNode: (request: Readonly<CreateExternalNodeRequest>) => Promise<ExternalNode>;
15132
15127
  protected pageOfListNodes: (request: Readonly<ListNodesRequest$1>) => Promise<ListNodesResponse>;
15133
15128
  /**
15134
- * List all the nodes in a cluster. List all the existing nodes for a specific
15129
+ * List Nodes in a Cluster. List all the existing nodes for a specific
15135
15130
  * Kubernetes cluster.
15136
15131
  *
15137
15132
  * @param request - The request {@link ListNodesRequest}
@@ -15142,7 +15137,7 @@ declare class API$d extends API$q {
15142
15137
  [Symbol.asyncIterator]: () => AsyncGenerator<Node[], void, void>;
15143
15138
  };
15144
15139
  /**
15145
- * Get a node in a cluster. Get details about a specific Kubernetes node.
15140
+ * Get a Node in a Cluster. Retrieve details about a specific Kubernetes Node.
15146
15141
  *
15147
15142
  * @param request - The request {@link GetNodeRequest}
15148
15143
  * @returns A Promise of Node
@@ -15157,13 +15152,12 @@ declare class API$d extends API$q {
15157
15152
  */
15158
15153
  waitForNode: (request: Readonly<GetNodeRequest>, options?: Readonly<WaitForOptions<Node>>) => Promise<Node>;
15159
15154
  /**
15160
- * Replace a node in a cluster. Replace a specific node. The node will be set
15161
- * cordoned, meaning that scheduling will be disabled. Then the existing pods
15162
- * on the node will be drained and reschedule onto another schedulable node.
15163
- * Then the node will be deleted, and a new one will be created after the
15164
- * deletion. Note that when there is not enough space to reschedule all the
15165
- * pods (in a one node cluster for instance), you may experience some
15166
- * disruption of your applications.
15155
+ * Replace a Node in a Cluster. Replace a specific Node. The node will first
15156
+ * be cordoned (scheduling will be disabled on it). The existing pods on the
15157
+ * node will then be drained and rescheduled onto another schedulable node.
15158
+ * Note that when there is not enough space to reschedule all the pods (such
15159
+ * as in a one-node cluster), disruption of your applications can be
15160
+ * expected.
15167
15161
  *
15168
15162
  * @deprecated
15169
15163
  * @param request - The request {@link ReplaceNodeRequest}
@@ -15171,28 +15165,27 @@ declare class API$d extends API$q {
15171
15165
  */
15172
15166
  replaceNode: (request: Readonly<ReplaceNodeRequest>) => Promise<Node>;
15173
15167
  /**
15174
- * Reboot a node in a cluster. Reboot a specific node. This node will first be
15175
- * cordoned, meaning that scheduling will be disabled. Then the existing pods
15176
- * on the node will be drained and rescheduled onto another schedulable node.
15177
- * Note that when there is not enough space to reschedule all the pods (in a
15178
- * one-node cluster, for instance), you may experience some disruption of your
15179
- * applications.
15168
+ * Reboot a Node in a Cluster. Reboot a specific Node. The node will first be
15169
+ * cordoned (scheduling will be disabled on it). The existing pods on the node
15170
+ * will then be drained and rescheduled onto another schedulable node. Note
15171
+ * that when there is not enough space to reschedule all the pods (such as in
15172
+ * a one-node cluster), disruption of your applications can be expected.
15180
15173
  *
15181
15174
  * @param request - The request {@link RebootNodeRequest}
15182
15175
  * @returns A Promise of Node
15183
15176
  */
15184
15177
  rebootNode: (request: Readonly<RebootNodeRequest>) => Promise<Node>;
15185
15178
  /**
15186
- * Delete a node in a cluster. Delete a specific node. Note that when there is
15187
- * not enough space to reschedule all the pods (in a one-node cluster for
15188
- * instance), you may experience some disruption of your applications.
15179
+ * Delete a Node in a Cluster. Delete a specific Node. Note that when there is
15180
+ * not enough space to reschedule all the pods (such as in a one-node
15181
+ * cluster), disruption of your applications can be expected.
15189
15182
  *
15190
15183
  * @param request - The request {@link DeleteNodeRequest}
15191
15184
  * @returns A Promise of Node
15192
15185
  */
15193
15186
  deleteNode: (request: Readonly<DeleteNodeRequest>) => Promise<Node>;
15194
15187
  /**
15195
- * List all available versions. List all available versions for the creation
15188
+ * List all available Versions. List all available versions for the creation
15196
15189
  * of a new Kubernetes cluster.
15197
15190
  *
15198
15191
  * @param request - The request {@link ListVersionsRequest}
@@ -15200,8 +15193,7 @@ declare class API$d extends API$q {
15200
15193
  */
15201
15194
  listVersions: (request?: Readonly<ListVersionsRequest$2>) => Promise<ListVersionsResponse$2>;
15202
15195
  /**
15203
- * Get details about a specific version. Get a specific Kubernetes version and
15204
- * the details about the version.
15196
+ * Get a Version. Retrieve a specific Kubernetes version and its details.
15205
15197
  *
15206
15198
  * @param request - The request {@link GetVersionRequest}
15207
15199
  * @returns A Promise of Version
@@ -15661,6 +15653,13 @@ interface Backend {
15661
15653
  redispatchAttemptCount?: number;
15662
15654
  /** Number of retries when a backend server connection failed. */
15663
15655
  maxRetries?: number;
15656
+ /** Maximum number of connections allowed per backend server. */
15657
+ maxConnections?: number;
15658
+ /**
15659
+ * Maximum time for a request to be left pending in queue when
15660
+ * `max_connections` is reached.
15661
+ */
15662
+ timeoutQueue?: string;
15664
15663
  }
15665
15664
  /** Backend server stats. */
15666
15665
  interface BackendServerStats {
@@ -16504,6 +16503,13 @@ type CreateBackendRequest = {
16504
16503
  redispatchAttemptCount?: number;
16505
16504
  /** Number of retries when a backend server connection failed. */
16506
16505
  maxRetries?: number;
16506
+ /** Maximum number of connections allowed per backend server. */
16507
+ maxConnections?: number;
16508
+ /**
16509
+ * Maximum time for a request to be left pending in queue when
16510
+ * `max_connections` is reached.
16511
+ */
16512
+ timeoutQueue?: string;
16507
16513
  };
16508
16514
  type GetBackendRequest = {
16509
16515
  /**
@@ -16581,6 +16587,13 @@ type UpdateBackendRequest = {
16581
16587
  redispatchAttemptCount?: number;
16582
16588
  /** Number of retries when a backend server connection failed. */
16583
16589
  maxRetries?: number;
16590
+ /** Maximum number of connections allowed per backend server. */
16591
+ maxConnections?: number;
16592
+ /**
16593
+ * Maximum time for a request to be left pending in queue when
16594
+ * `max_connections` is reached.
16595
+ */
16596
+ timeoutQueue?: string;
16584
16597
  };
16585
16598
  type DeleteBackendRequest = {
16586
16599
  /**
@@ -17497,6 +17510,13 @@ type ZonedApiCreateBackendRequest = {
17497
17510
  redispatchAttemptCount?: number;
17498
17511
  /** Number of retries when a backend server connection failed. */
17499
17512
  maxRetries?: number;
17513
+ /** Maximum number of connections allowed per backend server. */
17514
+ maxConnections?: number;
17515
+ /**
17516
+ * Maximum time for a request to be left pending in queue when
17517
+ * `max_connections` is reached.
17518
+ */
17519
+ timeoutQueue?: string;
17500
17520
  };
17501
17521
  type ZonedApiGetBackendRequest = {
17502
17522
  /** Zone to target. If none is passed will use default zone from the config. */
@@ -17568,6 +17588,13 @@ type ZonedApiUpdateBackendRequest = {
17568
17588
  redispatchAttemptCount?: number;
17569
17589
  /** Number of retries when a backend server connection failed. */
17570
17590
  maxRetries?: number;
17591
+ /** Maximum number of connections allowed per backend server. */
17592
+ maxConnections?: number;
17593
+ /**
17594
+ * Maximum time for a request to be left pending in queue when
17595
+ * `max_connections` is reached.
17596
+ */
17597
+ timeoutQueue?: string;
17571
17598
  };
17572
17599
  type ZonedApiDeleteBackendRequest = {
17573
17600
  /** Zone to target. If none is passed will use default zone from the config. */