From 3258eec1a62f012a41c01903925fe411fe65f22c Mon Sep 17 00:00:00 2001 From: scaleway-bot Date: Fri, 12 May 2023 15:01:15 +0000 Subject: [PATCH] feat: update generated APIs --- packages/clients/src/api/k8s/v1/api.gen.ts | 103 ++-- packages/clients/src/api/k8s/v1/types.gen.ts | 443 +++++++++--------- .../src/api/k8s/v1/types.private.gen.ts | 2 +- 3 files changed, 267 insertions(+), 281 deletions(-) diff --git a/packages/clients/src/api/k8s/v1/api.gen.ts b/packages/clients/src/api/k8s/v1/api.gen.ts index 871655444..f9360e1e8 100644 --- a/packages/clients/src/api/k8s/v1/api.gen.ts +++ b/packages/clients/src/api/k8s/v1/api.gen.ts @@ -106,8 +106,7 @@ export class API extends ParentAPI { ) /** - * List all clusters. List all the existing Kubernetes clusters in a specific - * Region. + * List Clusters. List all existing Kubernetes clusters in a specific region. * * @param request - The request {@link ListClustersRequest} * @returns A Promise of ListClustersResponse @@ -116,8 +115,7 @@ export class API extends ParentAPI { enrichForPagination('clusters', this.pageOfListClusters, request) /** - * Create a new cluster. Create a new Kubernetes cluster on a Scaleway - * account. + * Create a new Cluster. Create a new Kubernetes cluster in a Scaleway region. * * @param request - The request {@link CreateClusterRequest} * @returns A Promise of Cluster @@ -139,8 +137,7 @@ export class API extends ParentAPI { ) /** - * Get specific cluster information. Get details about a specific Kubernetes - * cluster. + * Get a Cluster. Retrieve information about a specific Kubernetes cluster. * * @param request - The request {@link GetClusterRequest} * @returns A Promise of Cluster @@ -178,10 +175,9 @@ export class API extends ParentAPI { ) /** - * Update a cluster. Update a specific Kubernetes cluster. Note that this - * method is designed to update details such as name, description, tags and - * configuration. However, you cannot upgrade a cluster with this method. To - * do so, use the dedicated endpoint. + * Update a Cluster. Update information on a specific Kubernetes cluster. You + * can update details such as its name, description, tags and configuration. + * To upgrade a cluster, you will need to use the dedicated endpoint. * * @param request - The request {@link UpdateClusterRequest} * @returns A Promise of Cluster @@ -203,9 +199,9 @@ export class API extends ParentAPI { ) /** - * Delete a cluster. Delete a specific cluster and all its associated pools - * and nodes. Note that this method will not delete any Load Balancers or - * Block Volumes that are associated with the cluster. + * Delete a Cluster. Delete a specific Kubernetes cluster and all its + * associated pools and nodes. Note that this method will not delete any Load + * Balancer or Block Volume that are associated with the cluster. * * @param request - The request {@link DeleteClusterRequest} * @returns A Promise of Cluster @@ -227,7 +223,7 @@ export class API extends ParentAPI { ) /** - * Upgrade a cluster. Upgrade a specific Kubernetes cluster and/or its + * Upgrade a Cluster. Upgrade a specific Kubernetes cluster and possibly its * associated pools to a specific and supported Kubernetes version. * * @param request - The request {@link UpgradeClusterRequest} @@ -253,7 +249,7 @@ export class API extends ParentAPI { ) /** - * Change type of a cluster. Change type of a specific Kubernetes cluster. + * Change the Cluster type. Change the type of a specific Kubernetes cluster. * * @param request - The request {@link SetClusterTypeRequest} * @returns A Promise of Cluster @@ -278,8 +274,8 @@ export class API extends ParentAPI { ) /** - * List available versions for a cluster. List the versions that a specific - * Kubernetes cluster is allowed to upgrade to. Results will comprise every + * List available versions for a Cluster. List the versions that a specific + * Kubernetes cluster is allowed to upgrade to. Results will include every * patch version greater than the current patch, as well as one minor version * ahead of the current version. Any upgrade skipping a minor version will not * work. @@ -321,10 +317,10 @@ export class API extends ParentAPI { }) /** - * Reset the admin token of a cluster. Reset the admin token for a specific - * Kubernetes cluster. This will invalidate the old admin token (which will - * not be usable afterwards) and create a new one. Note that you will need to - * redownload kubeconfig in order to keep interacting with the cluster. + * Reset the admin token of a Cluster. Reset the admin token for a specific + * Kubernetes cluster. This will revoke the old admin token (which will not be + * usable afterwards) and create a new one. Note that you will need to + * download kubeconfig again to keep interacting with the cluster. * * @param request - The request {@link ResetClusterAdminTokenRequest} */ @@ -365,7 +361,7 @@ export class API extends ParentAPI { ) /** - * List all the pools in a cluster. List all the existing pools for a specific + * List Pools in a Cluster. List all the existing pools for a specific * Kubernetes cluster. * * @param request - The request {@link ListPoolsRequest} @@ -375,7 +371,7 @@ export class API extends ParentAPI { enrichForPagination('pools', this.pageOfListPools, request) /** - * Create a new pool in a cluster. Create a new pool in a specific Kubernetes + * Create a new Pool in a Cluster. Create a new pool in a specific Kubernetes * cluster. * * @param request - The request {@link CreatePoolRequest} @@ -398,8 +394,8 @@ export class API extends ParentAPI { ) /** - * Get a pool in a cluster. Get details about a specific pool in a Kubernetes - * cluster. + * Get a Pool in a Cluster. Retrieve details about a specific pool in a + * Kubernetes cluster. * * @param request - The request {@link GetPoolRequest} * @returns A Promise of Pool @@ -436,9 +432,9 @@ export class API extends ParentAPI { ) /** - * Upgrade a pool in a cluster. Upgrade the Kubernetes version of a specific - * pool. Note that this will work when the targeted version is the same than - * the version of the cluster. + * Upgrade a Pool in a Cluster. Upgrade the Kubernetes version of a specific + * pool. Note that it only works if the targeted version matches the cluster's + * version. * * @param request - The request {@link UpgradePoolRequest} * @returns A Promise of Pool @@ -460,8 +456,8 @@ export class API extends ParentAPI { ) /** - * Update a pool in a cluster. Update attributes of a specific pool, such as - * size, autoscaling settings, and tags. + * Update a Pool in a Cluster. Update the attributes of a specific pool, such + * as its desired size, autoscaling settings, and tags. * * @param request - The request {@link UpdatePoolRequest} * @returns A Promise of Pool @@ -483,8 +479,8 @@ export class API extends ParentAPI { ) /** - * Delete a pool in a cluster. Delete a specific pool from a cluster. All of - * the pool's nodes will also be deleted. + * Delete a Pool in a Cluster. Delete a specific pool from a cluster. Note + * that all the pool's nodes will also be deleted. * * @param request - The request {@link DeletePoolRequest} * @returns A Promise of Pool @@ -502,8 +498,8 @@ export class API extends ParentAPI { ) /** - * Create a Kosmos node. Get metadata about a Kosmos node. This method is not - * intended to be directly called by end users, only by the + * Create a Kosmos node. Retrieve metadata for a Kosmos node. This method is + * not intended to be called by end users but rather programmatically by the * kapsule-node-agent. * * @param request - The request {@link CreateExternalNodeRequest} @@ -547,7 +543,7 @@ export class API extends ParentAPI { ) /** - * List all the nodes in a cluster. List all the existing nodes for a specific + * List Nodes in a Cluster. List all the existing nodes for a specific * Kubernetes cluster. * * @param request - The request {@link ListNodesRequest} @@ -557,7 +553,7 @@ export class API extends ParentAPI { enrichForPagination('nodes', this.pageOfListNodes, request) /** - * Get a node in a cluster. Get details about a specific Kubernetes node. + * Get a Node in a Cluster. Retrieve details about a specific Kubernetes Node. * * @param request - The request {@link GetNodeRequest} * @returns A Promise of Node @@ -594,13 +590,12 @@ export class API extends ParentAPI { ) /** - * Replace a node in a cluster. Replace a specific node. The node will be set - * cordoned, meaning that scheduling will be disabled. Then the existing pods - * on the node will be drained and reschedule onto another schedulable node. - * Then the node will be deleted, and a new one will be created after the - * deletion. Note that when there is not enough space to reschedule all the - * pods (in a one node cluster for instance), you may experience some - * disruption of your applications. + * Replace a Node in a Cluster. Replace a specific Node. The node will first + * be cordoned (scheduling will be disabled on it). The existing pods on the + * node will then be drained and rescheduled onto another schedulable node. + * Note that when there is not enough space to reschedule all the pods (such + * as in a one-node cluster), disruption of your applications can be + * expected. * * @deprecated * @param request - The request {@link ReplaceNodeRequest} @@ -621,12 +616,11 @@ export class API extends ParentAPI { ) /** - * Reboot a node in a cluster. Reboot a specific node. This node will first be - * cordoned, meaning that scheduling will be disabled. Then the existing pods - * on the node will be drained and rescheduled onto another schedulable node. - * Note that when there is not enough space to reschedule all the pods (in a - * one-node cluster, for instance), you may experience some disruption of your - * applications. + * Reboot a Node in a Cluster. Reboot a specific Node. The node will first be + * cordoned (scheduling will be disabled on it). The existing pods on the node + * will then be drained and rescheduled onto another schedulable node. Note + * that when there is not enough space to reschedule all the pods (such as in + * a one-node cluster), disruption of your applications can be expected. * * @param request - The request {@link RebootNodeRequest} * @returns A Promise of Node @@ -646,9 +640,9 @@ export class API extends ParentAPI { ) /** - * Delete a node in a cluster. Delete a specific node. Note that when there is - * not enough space to reschedule all the pods (in a one-node cluster for - * instance), you may experience some disruption of your applications. + * Delete a Node in a Cluster. Delete a specific Node. Note that when there is + * not enough space to reschedule all the pods (such as in a one-node + * cluster), disruption of your applications can be expected. * * @param request - The request {@link DeleteNodeRequest} * @returns A Promise of Node @@ -670,7 +664,7 @@ export class API extends ParentAPI { ) /** - * List all available versions. List all available versions for the creation + * List all available Versions. List all available versions for the creation * of a new Kubernetes cluster. * * @param request - The request {@link ListVersionsRequest} @@ -689,8 +683,7 @@ export class API extends ParentAPI { ) /** - * Get details about a specific version. Get a specific Kubernetes version and - * the details about the version. + * Get a Version. Retrieve a specific Kubernetes version and its details. * * @param request - The request {@link GetVersionRequest} * @returns A Promise of Version diff --git a/packages/clients/src/api/k8s/v1/types.gen.ts b/packages/clients/src/api/k8s/v1/types.gen.ts index f4ab5bedf..f2b181c59 100644 --- a/packages/clients/src/api/k8s/v1/types.gen.ts +++ b/packages/clients/src/api/k8s/v1/types.gen.ts @@ -103,11 +103,11 @@ export type Runtime = 'unknown_runtime' | 'docker' | 'containerd' | 'crio' /** Cluster. */ export interface Cluster { - /** ID of the cluster. */ + /** Cluster ID. */ id: string - /** Type of the cluster. */ + /** Cluster type. */ type: string - /** Name of the cluster. */ + /** Cluster name. */ name: string /** Status of the cluster. */ status: ClusterStatus @@ -115,23 +115,23 @@ export interface Cluster { version: string /** Region in which the cluster is deployed. */ region: Region - /** ID of the organization owning the cluster. */ + /** ID of the Organization owning the cluster. */ organizationId: string - /** ID of the project owning the cluster. */ + /** ID of the Project owning the cluster. */ projectId: string /** Tags associated with the cluster. */ tags: string[] /** Container Network Interface (CNI) plugin running in the cluster. */ cni: CNI - /** Description of the cluster. */ + /** Cluster description. */ description: string /** Kubernetes API server URL of the cluster. */ clusterUrl: string - /** DNS wildcard resovling all the ready nodes of the cluster. */ + /** Wildcard DNS resolving all the ready cluster nodes. */ dnsWildcard: string - /** Date at which the cluster was created. */ + /** Date on which the cluster was created. */ createdAt?: Date - /** Date at which the cluster was last updated. */ + /** Date on which the cluster was last updated. */ updatedAt?: Date /** Autoscaler config for the cluster. */ autoscalerConfig?: ClusterAutoscalerConfig @@ -140,7 +140,10 @@ export interface Cluster { * cluster. */ dashboardEnabled?: boolean - /** @deprecated Ingress controller used in the cluster. */ + /** + * @deprecated Managed Ingress controller used in the cluster (deprecated + * feature). + */ ingress?: Ingress /** Auto upgrade configuration of the cluster. */ autoUpgrade?: ClusterAutoUpgrade @@ -151,8 +154,8 @@ export interface Cluster { /** List of enabled admission plugins. */ admissionPlugins: string[] /** - * OpenID Connect configuration of the cluster. This configuration enables to - * update the OpenID Connect configuration of the Kubernetes API server. + * This configuration enables to update the OpenID Connect configuration of + * the Kubernetes API server. */ openIdConnectConfig?: ClusterOpenIDConnectConfig /** @@ -166,7 +169,7 @@ export interface Cluster { /** Cluster. auto upgrade. */ export interface ClusterAutoUpgrade { - /** Whether or not auto upgrade is enabled for the cluster. */ + /** Defines whether auto upgrade is enabled for the cluster. */ enabled: boolean /** Maintenance window of the cluster auto upgrades. */ maintenanceWindow?: MaintenanceWindow @@ -190,16 +193,15 @@ export interface ClusterAutoscalerConfig { /** Detect similar node groups and balance the number of nodes between them. */ balanceSimilarNodeGroups: boolean /** - * Pods with priority below cutoff will be expendable. Pods with priority - * below cutoff will be expendable. They can be killed without any - * consideration during scale down and they don't cause scale up. Pods with - * null priority (PodPriority disabled) are non expendable. + * 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. */ expendablePodsPriorityCutoff: number - /** How long a node should be unneeded before it is eligible for scale down. */ + /** How long a node should be unneeded before it is eligible to be scaled down. */ scaleDownUnneededTime: string /** - * Node utilization level, defined as sum of requested resources divided by + * Node utilization level, defined as a sum of requested resources divided by * capacity, below which a node can be considered for scale down. */ scaleDownUtilizationThreshold: number @@ -214,53 +216,49 @@ export interface ClusterAutoscalerConfig { export interface ClusterOpenIDConnectConfig { /** * URL of the provider which allows the API server to discover public signing - * keys. URL of the provider which allows the API server to discover public - * signing keys. Only URLs which use 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". This URL - * should point to the level below .well-known/openid-configuration. + * 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". */ issuerUrl: string - /** A client id that all tokens must be issued for. */ + /** A client ID that all tokens must be issued for. */ clientId: string /** - * JWT claim to use as the user name. JWT claim to use as the user name. By - * default `sub`, which is expected to be a unique identifier of the end user. - * 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 naming clashes with other plugins. + * 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. */ usernameClaim: string /** - * Prefix prepended to username. Prefix prepended to username claims to - * prevent clashes with existing names (such as `system:` users). For example, - * the value `oidc:` will create usernames like `oidc:jane.doe`. If this flag - * isn't 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. + * 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. */ usernamePrefix: string /** JWT claim to use as the user's group. */ groupsClaim: string[] /** - * Prefix prepended to group claims. Prefix prepended to group claims to - * prevent clashes with existing names (such as `system:` groups). For - * example, the value `oidc:` will create group names like `oidc:engineering` - * and `oidc:infra`. + * 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`. */ groupsPrefix: string /** - * Multiple key=value pairs that describes a required claim in the ID token. - * Multiple key=value pairs that describes a required claim in the ID token. - * If set, the claims are verified to be present in the ID token with a - * matching value. + * 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. */ requiredClaim: string[] } /** Create cluster request. auto upgrade. */ export interface CreateClusterRequestAutoUpgrade { - /** Whether or not auto upgrade is enabled for the cluster. */ + /** Defines whether auto upgrade is enabled for the cluster. */ enable: boolean /** Maintenance window of the cluster auto upgrades. */ maintenanceWindow?: MaintenanceWindow @@ -284,16 +282,15 @@ export interface CreateClusterRequestAutoscalerConfig { /** Detect similar node groups and balance the number of nodes between them. */ balanceSimilarNodeGroups?: boolean /** - * Pods with priority below cutoff will be expendable. Pods with priority - * below cutoff will be expendable. They can be killed without any - * consideration during scale down and they don't cause scale up. Pods with - * null priority (PodPriority disabled) are non expendable. + * 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. */ expendablePodsPriorityCutoff?: number - /** How long a node should be unneeded before it is eligible for scale down. */ + /** How long a node should be unneeded before it is eligible to be scaled down. */ scaleDownUnneededTime?: string /** - * Node utilization level, defined as sum of requested resources divided by + * Node utilization level, defined as a sum of requested resources divided by * capacity, below which a node can be considered for scale down. */ scaleDownUtilizationThreshold?: number @@ -308,46 +305,42 @@ export interface CreateClusterRequestAutoscalerConfig { export interface CreateClusterRequestOpenIDConnectConfig { /** * URL of the provider which allows the API server to discover public signing - * keys. URL of the provider which allows the API server to discover public - * signing keys. Only URLs which use 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". This URL - * should point to the level below .well-known/openid-configuration. + * 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". */ issuerUrl: string - /** A client id that all tokens must be issued for. */ + /** A client ID that all tokens must be issued for. */ clientId: string /** - * JWT claim to use as the user name. JWT claim to use as the user name. By - * default `sub`, which is expected to be a unique identifier of the end user. - * 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 naming clashes with other plugins. + * 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. */ usernameClaim?: string /** - * Prefix prepended to username. Prefix prepended to username claims to - * prevent clashes with existing names (such as `system:` users). For example, - * the value `oidc:` will create usernames like `oidc:jane.doe`. If this flag - * isn't 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. + * 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. */ usernamePrefix?: string /** JWT claim to use as the user's group. */ groupsClaim?: string[] /** - * Prefix prepended to group claims. Prefix prepended to group claims to - * prevent clashes with existing names (such as `system:` groups). For - * example, the value `oidc:` will create group names like `oidc:engineering` - * and `oidc:infra`. + * 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`. */ groupsPrefix?: string /** - * Multiple key=value pairs that describes a required claim in the ID token. - * Multiple key=value pairs that describes a required claim in the ID token. - * If set, the claims are verified to be present in the ID token with a - * matching value. + * 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. */ requiredClaim?: string[] } @@ -357,11 +350,10 @@ export interface CreateClusterRequestPoolConfig { /** Name of the pool. */ name: string /** - * Node type is the type of Scaleway Instance wanted for the pool. Node type - * is the type of Scaleway Instance wanted for the pool. Nodes with + * 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. + * cloud providers in a Kosmos Cluster. */ nodeType: string /** Placement group ID in which all the nodes of the pool will be created. */ @@ -371,19 +363,19 @@ export interface CreateClusterRequestPoolConfig { /** Size (number of nodes) of the pool. */ size: number /** - * Minimum size of the pool. Defines the minimum size of the pool. Note that - * this field will be used only when autoscaling is enabled. + * Defines the minimum size of the pool. Note that this field is only used + * when autoscaling is enabled on the pool. */ minSize?: number /** - * Maximum size of the pool. Defines the maximum size of the pool. Note that - * this field will be used only when autoscaling is enabled. + * Defines the maximum size of the pool. Note that this field is only used + * when autoscaling is enabled on the pool. */ maxSize?: number /** - * Container runtime for the nodes of the pool. Customization of the container - * runtime is available for each pool. Note that `docker` is deprecated since - * 1.20 and will be removed in 1.24. + * Customization of the container runtime is available for each pool. Note + * that `docker` has been deprecated since version 1.20 and will be removed by + * version 1.24. */ containerRuntime: Runtime /** Defines whether the autohealing feature is enabled for the pool. */ @@ -391,8 +383,8 @@ export interface CreateClusterRequestPoolConfig { /** Tags associated with the pool. */ tags: string[] /** - * Kubelet arguments to be used by this pool. Note that this feature is to be - * considered as experimental. + * Kubelet arguments to be used by this pool. Note that this feature is + * experimental. */ kubeletArgs: Record /** Pool upgrade policy. */ @@ -400,11 +392,11 @@ export interface CreateClusterRequestPoolConfig { /** Zone in which the pool's nodes will be spawned. */ zone: Zone /** - * System volume disk type. Defines the system volume disk type, we provide - * two different types of volume (`volume_type`): `l_ssd` is a local block - * storage: your system is stored locally on the hypervisor of your node. - * `b_ssd` is a remote block storage: your system is stored on a centralised - * and resilient cluster. + * Defines the system volume disk type. Two different types of volume + * (`volume_type`) are provided: `l_ssd` is a local block storage which means + * your system is stored locally on your node's hypervisor. `b_ssd` is a + * remote block storage which means your system is stored on a centralized and + * resilient cluster. */ rootVolumeType: PoolVolumeType /** System volume disk size. */ @@ -436,7 +428,7 @@ export interface ExternalNode { /** List cluster available versions response. */ export interface ListClusterAvailableVersionsResponse { - /** Available Kubernetes version for the cluster. */ + /** Available Kubernetes versions for the cluster. */ versions: Version[] } @@ -480,7 +472,7 @@ export interface MaintenanceWindow { /** Node. */ export interface Node { - /** ID of the node. */ + /** Node ID. */ id: string /** Pool ID of the node. */ poolId: string @@ -501,42 +493,41 @@ export interface Node { /** @deprecated Public IPv6 address of the node. */ publicIpV6?: string /** - * @deprecated Conditions of the node. These conditions contains the Node + * @deprecated Conditions of the node. These conditions contain the Node * Problem Detector conditions, as well as some in house conditions. */ conditions?: Record /** Status of the node. */ status: NodeStatus - /** Details of the error, if any occured when managing the node. */ + /** Details of the error, if any occurred when managing the node. */ errorMessage?: string /** Date on which the node was created. */ createdAt?: Date - /** Date at which the node was last updated. */ + /** Date on which the node was last updated. */ updatedAt?: Date } /** Pool. */ export interface Pool { - /** ID of the pool. */ + /** Pool ID. */ id: string /** Cluster ID of the pool. */ clusterId: string - /** Date at which the pool was created. */ + /** Date on which the pool was created. */ createdAt?: Date - /** Date at which the pool was last updated. */ + /** Date on which the pool was last updated. */ updatedAt?: Date - /** Name of the pool. */ + /** Pool name. */ name: string - /** Status of the pool. */ + /** Pool status. */ status: PoolStatus - /** Version of the pool. */ + /** Pool version. */ version: string /** - * Node type is the type of Scaleway Instance wanted for the pool. Node type - * is the type of Scaleway Instance wanted for the pool. Nodes with + * 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. + * cloud providers in a Kosmos Cluster. */ nodeType: string /** Defines whether the autoscaling feature is enabled for the pool. */ @@ -544,19 +535,19 @@ export interface Pool { /** Size (number of nodes) of the pool. */ size: number /** - * Minimum size of the pool. Defines the minimum size of the pool. Note that - * this field will be used only when autoscaling is enabled. + * Defines the minimum size of the pool. Note that this field is only used + * when autoscaling is enabled on the pool. */ minSize: number /** - * Maximum size of the pool. Defines the maximum size of the pool. Note that - * this field will be used only when autoscaling is enabled. + * Defines the maximum size of the pool. Note that this field is only used + * when autoscaling is enabled on the pool. */ maxSize: number /** - * Container runtime for the nodes of the pool. Customization of the container - * runtime is available for each pool. Note that `docker` is deprecated since - * 1.20 and will be removed in 1.24. + * Customization of the container runtime is available for each pool. Note + * that `docker` has been deprecated since version 1.20 and will be removed by + * version 1.24. */ containerRuntime: Runtime /** Defines whether the autohealing feature is enabled for the pool. */ @@ -566,8 +557,8 @@ export interface Pool { /** Placement group ID in which all the nodes of the pool will be created. */ placementGroupId?: string /** - * Kubelet arguments to be used by this pool. Note that this feature is to be - * considered as experimental. + * Kubelet arguments to be used by this pool. Note that this feature is + * experimental. */ kubeletArgs: Record /** Pool upgrade policy. */ @@ -575,11 +566,11 @@ export interface Pool { /** Zone in which the pool's nodes will be spawned. */ zone: Zone /** - * System volume disk type. Defines the system volume disk type, we provide - * two different types of volume (`volume_type`): `l_ssd` is a local block - * storage: your system is stored locally on the hypervisor of your node. - * `b_ssd` is a remote block storage: your system is stored on a centralised - * and resilient cluster. + * Defines the system volume disk type. Two different types of volume + * (`volume_type`) are provided: `l_ssd` is a local block storage which means + * your system is stored locally on your node's hypervisor. `b_ssd` is a + * remote block storage which means your system is stored on a centralized and + * resilient cluster. */ rootVolumeType: PoolVolumeType /** System volume disk size. */ @@ -595,7 +586,7 @@ export interface PoolUpgradePolicy { /** Update cluster request. auto upgrade. */ export interface UpdateClusterRequestAutoUpgrade { - /** Whether or not auto upgrade is enabled for the cluster. */ + /** Defines whether auto upgrade is enabled for the cluster. */ enable?: boolean /** Maintenance window of the cluster auto upgrades. */ maintenanceWindow?: MaintenanceWindow @@ -619,16 +610,15 @@ export interface UpdateClusterRequestAutoscalerConfig { /** Detect similar node groups and balance the number of nodes between them. */ balanceSimilarNodeGroups?: boolean /** - * Pods with priority below cutoff will be expendable. Pods with priority - * below cutoff will be expendable. They can be killed without any - * consideration during scale down and they don't cause scale up. Pods with - * null priority (PodPriority disabled) are non expendable. + * 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. */ expendablePodsPriorityCutoff?: number - /** How long a node should be unneeded before it is eligible for scale down. */ + /** How long a node should be unneeded before it is eligible to be scaled down. */ scaleDownUnneededTime?: string /** - * Node utilization level, defined as sum of requested resources divided by + * Node utilization level, defined as a sum of requested resources divided by * capacity, below which a node can be considered for scale down. */ scaleDownUtilizationThreshold?: number @@ -643,46 +633,42 @@ export interface UpdateClusterRequestAutoscalerConfig { export interface UpdateClusterRequestOpenIDConnectConfig { /** * URL of the provider which allows the API server to discover public signing - * keys. URL of the provider which allows the API server to discover public - * signing keys. Only URLs which use 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". This URL - * should point to the level below .well-known/openid-configuration. + * 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". */ issuerUrl?: string - /** A client id that all tokens must be issued for. */ + /** A client ID that all tokens must be issued for. */ clientId?: string /** - * JWT claim to use as the user name. JWT claim to use as the user name. By - * default `sub`, which is expected to be a unique identifier of the end user. - * 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 naming clashes with other plugins. + * 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. */ usernameClaim?: string /** - * Prefix prepended to username. Prefix prepended to username claims to - * prevent clashes with existing names (such as `system:` users). For example, - * the value `oidc:` will create usernames like `oidc:jane.doe`. If this flag - * isn't 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. + * 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. */ usernamePrefix?: string /** JWT claim to use as the user's group. */ groupsClaim?: string[] /** - * Prefix prepended to group claims. Prefix prepended to group claims to - * prevent clashes with existing names (such as `system:` groups). For - * example, the value `oidc:` will create group names like `oidc:engineering` - * and `oidc:infra`. + * 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`. */ groupsPrefix?: string /** - * Multiple key=value pairs that describes a required claim in the ID token. - * Multiple key=value pairs that describes a required claim in the ID token. - * If set, the claims are verified to be present in the ID token with a - * matching value. + * 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. */ requiredClaim?: string[] } @@ -724,17 +710,20 @@ export type ListClustersRequest = { organizationId?: string /** Project ID on which to filter the returned clusters. */ projectId?: string - /** Sort order of the returned clusters. */ + /** Sort order of returned clusters. */ orderBy?: ListClustersRequestOrderBy - /** Page number for the returned clusters. */ + /** Page number to return for clusters, from the paginated results. */ page?: number /** Maximum number of clusters per page. */ pageSize?: number - /** Name on which to filter the returned clusters. */ + /** + * Name to filter on, only clusters containing this substring in their name + * will be returned. + */ name?: string - /** Status on which to filter the returned clusters. */ + /** Status to filter on, only clusters with this status will be returned. */ status?: ClusterStatus - /** Type on which to filter the returned clusters. */ + /** Type to filter on, only clusters with this type will be returned. */ type?: string } @@ -758,35 +747,41 @@ export type CreateClusterRequest = { * could be set. */ projectId?: string - /** Type of the cluster (possible values are kapsule, multicloud). */ + /** + * Type of the cluster (possible values are kapsule, multicloud, + * kapsule-dedicated-8, kapsule-dedicated-16). + */ type: string - /** Name of the cluster. */ + /** Cluster name. */ name?: string - /** Description of the cluster. */ + /** Cluster description. */ description: string /** Tags associated with the cluster. */ tags?: string[] /** Kubernetes version of the cluster. */ version: string - /** Container Network Interface (CNI) plugin that will run in the cluster. */ + /** Container Network Interface (CNI) plugin running in the cluster. */ cni: CNI - /** @deprecated Defines if the Kubernetes Dashboard is enabled in the cluster. */ + /** + * @deprecated Defines whether the Kubernetes Dashboard is enabled in the + * cluster. + */ enableDashboard?: boolean - /** @deprecated Ingress Controller that will run in the cluster. */ + /** @deprecated Ingress Controller running in the cluster (deprecated feature). */ ingress?: Ingress - /** Pools to be created along with the cluster. */ + /** Pools created along with the cluster. */ pools?: CreateClusterRequestPoolConfig[] /** - * Autoscaler config for the cluster. This field allows to specify some - * configuration for the autoscaler, which is an implementation of the - * cluster-autoscaler + * 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/). */ autoscalerConfig?: CreateClusterRequestAutoscalerConfig /** * 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 in the current minor one. + * updated to the latest patch version. */ autoUpgrade?: CreateClusterRequestAutoUpgrade /** List of feature gates to enable. */ @@ -816,7 +811,7 @@ export type GetClusterRequest = { * config. */ region?: Region - /** The ID of the requested cluster. */ + /** ID of the requested cluster. */ clusterId: string } @@ -828,25 +823,21 @@ export type UpdateClusterRequest = { region?: Region /** ID of the cluster to update. */ clusterId: string - /** New external name of the cluster. */ + /** New external name for the cluster. */ name?: string - /** New description of the cluster. */ + /** New description for the cluster. */ description?: string /** New tags associated with the cluster. */ tags?: string[] - /** - * New autoscaler config for the cluster. Object defining the configuration - * for the autoscaler, which is an implementation of the - * [cluster-autoscaler](https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler/). - */ + /** New autoscaler config for the cluster. */ autoscalerConfig?: UpdateClusterRequestAutoscalerConfig - /** @deprecated New value of the Kubernetes Dashboard enablement. */ + /** @deprecated New value for the Kubernetes Dashboard enablement. */ enableDashboard?: boolean - /** @deprecated New Ingress Controller for the cluster. */ + /** @deprecated New Ingress Controller for the cluster (deprecated feature). */ ingress?: Ingress /** - * New auto upgrade configuration of the cluster. New auto upgrade - * configuration of the cluster. Note that all fields need to be set. + * New auto upgrade configuration for the cluster. Note that all fields need + * to be set. */ autoUpgrade?: UpdateClusterRequestAutoUpgrade /** List of feature gates to enable. */ @@ -874,8 +865,8 @@ export type DeleteClusterRequest = { /** ID of the cluster to delete. */ clusterId: string /** - * Set true if you want to delete all volumes (including retain volume type) - * and loadbalancers whose name start with cluster ID. + * Defines whether all volumes (including retain volume type) and Load + * Balancers with a name starting with the cluster ID will also be deleted. */ withAdditionalResources: boolean } @@ -889,14 +880,14 @@ export type UpgradeClusterRequest = { /** ID of the cluster to upgrade. */ clusterId: string /** - * New Kubernetes version of the cluster. New Kubernetes version of the - * cluster. Note that the version shoud either be a higher patch version of - * the same minor version or the direct minor version after the current one. + * 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. */ version: string /** - * Enablement of the pools upgrade. This field also trigger pools upgrade once - * the control plane is upgraded. + * Defines whether pools will also be upgraded once the control plane is + * upgraded. */ upgradePools: boolean } @@ -922,10 +913,7 @@ export type ListClusterAvailableVersionsRequest = { * config. */ region?: Region - /** - * ID of the cluster which the available Kuberentes versions will be listed - * from. - */ + /** Cluster ID for which the available Kubernetes versions will be listed. */ clusterId: string } @@ -935,7 +923,7 @@ export type ResetClusterAdminTokenRequest = { * config. */ region?: Region - /** ID of the cluster on which the admin token will be renewed. */ + /** Cluster ID on which the admin token will be renewed. */ clusterId: string } @@ -945,17 +933,20 @@ export type ListPoolsRequest = { * config. */ region?: Region - /** ID of the cluster from which the pools will be listed from. */ + /** ID of the cluster whose pools will be listed. */ clusterId: string - /** Sort order of the returned pools. */ + /** Sort order of returned pools. */ orderBy?: ListPoolsRequestOrderBy /** Page number for the returned pools. */ page?: number /** Maximum number of pools per page. */ pageSize?: number - /** Name on which to filter the returned pools. */ + /** + * Name to filter on, only pools containing this substring in their name will + * be returned. + */ name?: string - /** Status on which to filter the returned pools. */ + /** Status to filter on, only pools with this status will be returned. */ status?: PoolStatus } @@ -965,16 +956,15 @@ export type CreatePoolRequest = { * config. */ region?: Region - /** ID of the cluster in which the pool will be created. */ + /** Cluster ID to which the pool will be attached. */ clusterId: string - /** Name of the pool. */ + /** Pool name. */ name?: string /** - * Node type is the type of Scaleway Instance wanted for the pool. Node type - * is the type of Scaleway Instance wanted for the pool. Nodes with + * 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. + * cloud providers in a Kosmos Cluster. */ nodeType: string /** Placement group ID in which all the nodes of the pool will be created. */ @@ -984,19 +974,19 @@ export type CreatePoolRequest = { /** Size (number of nodes) of the pool. */ size: number /** - * Minimum size of the pool. Defines the minimum size of the pool. Note that - * this field will be used only when autoscaling is enabled. + * Defines the minimum size of the pool. Note that this field is only used + * when autoscaling is enabled on the pool. */ minSize?: number /** - * Maximum size of the pool. Defines the maximum size of the pool. Note that - * this field will be used only when autoscaling is enabled. + * Defines the maximum size of the pool. Note that this field is only used + * when autoscaling is enabled on the pool. */ maxSize?: number /** - * Container runtime for the nodes of the pool. Customization of the container - * runtime is available for each pool. Note that `docker` is deprecated since - * 1.20 and will be removed in 1.24. + * Customization of the container runtime is available for each pool. Note + * that `docker` has been deprecated since version 1.20 and will be removed by + * version 1.24. */ containerRuntime?: Runtime /** Defines whether the autohealing feature is enabled for the pool. */ @@ -1004,8 +994,8 @@ export type CreatePoolRequest = { /** Tags associated with the pool. */ tags?: string[] /** - * Kubelet arguments to be used by this pool. Note that this feature is to be - * considered as experimental. + * Kubelet arguments to be used by this pool. Note that this feature is + * experimental. */ kubeletArgs?: Record /** Pool upgrade policy. */ @@ -1013,11 +1003,11 @@ export type CreatePoolRequest = { /** Zone in which the pool's nodes will be spawned. */ zone?: Zone /** - * System volume disk type. Defines the system volume disk type, we provide - * two different types of volume (`volume_type`): `l_ssd` is a local block - * storage: your system is stored locally on the hypervisor of your node. - * `b_ssd` is a remote block storage: your system is stored on a centralised - * and resilient cluster. + * Defines the system volume disk type. Two different types of volume + * (`volume_type`) are provided: `l_ssd` is a local block storage which means + * your system is stored locally on your node's hypervisor. `b_ssd` is a + * remote block storage which means your system is stored on a centralized and + * resilient cluster. */ rootVolumeType?: PoolVolumeType /** System volume disk size. */ @@ -1054,24 +1044,24 @@ export type UpdatePoolRequest = { region?: Region /** ID of the pool to update. */ poolId: string - /** New value for the enablement of autoscaling for the pool. */ + /** New value for the pool autoscaling enablement. */ autoscaling?: boolean - /** New size for the pool. */ + /** New desired pool size. */ size?: number - /** New minimun size for the pool. */ + /** New minimum size for the pool. */ minSize?: number /** New maximum size for the pool. */ maxSize?: number - /** New value for the enablement of autohealing for the pool. */ + /** New value for the pool autohealing enablement. */ autohealing?: boolean /** New tags associated with the pool. */ tags?: string[] /** - * New Kubelet arguments to be used by this pool. Note that this feature is to - * be considered as experimental. + * New Kubelet arguments to be used by this pool. Note that this feature is + * experimental. */ kubeletArgs?: Record - /** Upgrade policy for the pool. */ + /** New upgrade policy for the pool. */ upgradePolicy?: UpdatePoolRequestUpgradePolicy } @@ -1110,9 +1100,12 @@ export type ListNodesRequest = { page?: number /** Maximum number of nodes per page. */ pageSize?: number - /** Name on which to filter the returned nodes. */ + /** + * Name to filter on, only nodes containing this substring in their name will + * be returned. + */ name?: string - /** Status on which to filter the returned nodes. */ + /** Status to filter on, only nodes with this status will be returned. */ status?: NodeStatus } diff --git a/packages/clients/src/api/k8s/v1/types.private.gen.ts b/packages/clients/src/api/k8s/v1/types.private.gen.ts index 5d5051421..7f065f87b 100644 --- a/packages/clients/src/api/k8s/v1/types.private.gen.ts +++ b/packages/clients/src/api/k8s/v1/types.private.gen.ts @@ -8,6 +8,6 @@ export type GetClusterKubeConfigRequest = { * config. */ region?: Region - /** ID of the cluster to download the kubeconfig from. */ + /** Cluster ID for which to download the kubeconfig. */ clusterId: string }