@scaleway/sdk 1.0.0 → 1.2.0

package/dist/api/k8s/v1/api.gen.js

@@ -23,43 +23,100 @@ class API extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? _this.client.settings.defaultRegion)}/clusters`,
-        urlParams: urlParams(['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId ?? _this.client.settings.defaultOrganizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId ?? _this.client.settings.defaultProjectId], ['status', request.status ?? 'unknown'], ['type', request.type])
+        urlParams: urlParams(['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId], ['status', request.status ?? 'unknown'], ['type', request.type])
       }, unmarshalListClustersResponse);
     };
+    /**
+     * This method allows to list all the existing Kubernetes clusters in an
+     * account.
+     *
+     * @param request - The request {@link ListClustersRequest}
+     * @returns A Promise of ListClustersResponse
+     */
     this.listClusters = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('clusters', _this.pageOfListClusters, request);
     };
+    /**
+     * This method allows to create a new Kubernetes cluster on an account.
+     *
+     * @param request - The request {@link CreateClusterRequest}
+     * @returns A Promise of Cluster
+     */
     this.createCluster = request => this.client.fetch({
       body: JSON.stringify(marshalCreateClusterRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/clusters`
     }, unmarshalCluster);
+    /**
+     * This method allows to get details about a specific Kubernetes cluster.
+     *
+     * @param request - The request {@link GetClusterRequest}
+     * @returns A Promise of Cluster
+     */
     this.getCluster = request => this.client.fetch({
       method: 'GET',
       path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/clusters/${validatePathParam('clusterId', request.clusterId)}`
     }, unmarshalCluster);
+    /**
+     * Waits for {@link Cluster} to be in a final state.
+     *
+     * @param request - The request {@link GetClusterRequest}
+     * @param options - The waiting options
+     * @returns A Promise of Cluster
+     */
     this.waitForCluster = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!CLUSTER_TRANSIENT_STATUSES.includes(res.status))), this.getCluster, request, options);
+    /**
+     * This method allows to update a specific Kubernetes cluster. Note that this
+     * method is not made to upgrade a Kubernetes cluster.
+     *
+     * @param request - The request {@link UpdateClusterRequest}
+     * @returns A Promise of Cluster
+     */
     this.updateCluster = request => this.client.fetch({
       body: JSON.stringify(marshalUpdateClusterRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PATCH',
       path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/clusters/${validatePathParam('clusterId', request.clusterId)}`
     }, unmarshalCluster);
+    /**
+     * This method allows to 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.
+     *
+     * @param request - The request {@link DeleteClusterRequest}
+     * @returns A Promise of Cluster
+     */
     this.deleteCluster = request => this.client.fetch({
       method: 'DELETE',
       path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/clusters/${validatePathParam('clusterId', request.clusterId)}`,
       urlParams: urlParams(['with_additional_resources', request.withAdditionalResources])
     }, unmarshalCluster);
+    /**
+     * This method allows to upgrade a specific Kubernetes cluster and/or its
+     * associated pools to a specific and supported Kubernetes version.
+     *
+     * @param request - The request {@link UpgradeClusterRequest}
+     * @returns A Promise of Cluster
+     */
     this.upgradeCluster = request => this.client.fetch({
       body: JSON.stringify(marshalUpgradeClusterRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/clusters/${validatePathParam('clusterId', request.clusterId)}/upgrade`
     }, unmarshalCluster);
+    /**
+     * This method allows to list the versions that a specific Kubernetes cluster
+     * is allowed to upgrade to. Note that it will be every patch version greater
+     * than the actual one as well a one minor version ahead of the actual one.
+     * Upgrades skipping a minor version will not work.
+     *
+     * @param request - The request {@link ListClusterAvailableVersionsRequest}
+     * @returns A Promise of ListClusterAvailableVersionsResponse
+     */
     this.listClusterAvailableVersions = request => this.client.fetch({
       method: 'GET',
       path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/clusters/${validatePathParam('clusterId', request.clusterId)}/available-versions`
@@ -70,6 +127,15 @@ class API extends API$1 {
       urlParams: urlParams(['dl', 1]),
       responseType: 'blob'
     });
+    /**
+     * This method allows to reset the admin token for a specific Kubernetes
+     * cluster. This will invalidate the old admin token (which will not be usable
+     * after) and create a new one. Note that the redownload of the kubeconfig
+     * will be necessary to keep interacting with the cluster (if the old admin
+     * token was used).
+     *
+     * @param request - The request {@link ResetClusterAdminTokenRequest}
+     */
     this.resetClusterAdminToken = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
@@ -81,34 +147,89 @@ class API extends API$1 {
       path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/clusters/${validatePathParam('clusterId', request.clusterId)}/pools`,
       urlParams: urlParams(['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['status', request.status ?? 'unknown'])
     }, unmarshalListPoolsResponse);
+    /**
+     * This method allows to list all the existing pools for a specific Kubernetes
+     * cluster.
+     *
+     * @param request - The request {@link ListPoolsRequest}
+     * @returns A Promise of ListPoolsResponse
+     */
     this.listPools = request => enrichForPagination('pools', this.pageOfListPools, request);
+    /**
+     * This method allows to create a new pool in a specific Kubernetes cluster.
+     *
+     * @param request - The request {@link CreatePoolRequest}
+     * @returns A Promise of Pool
+     */
     this.createPool = request => this.client.fetch({
       body: JSON.stringify(marshalCreatePoolRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/clusters/${validatePathParam('clusterId', request.clusterId)}/pools`
     }, unmarshalPool);
+    /**
+     * This method allows to get details about a specific pool.
+     *
+     * @param request - The request {@link GetPoolRequest}
+     * @returns A Promise of Pool
+     */
     this.getPool = request => this.client.fetch({
       method: 'GET',
       path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/pools/${validatePathParam('poolId', request.poolId)}`
     }, unmarshalPool);
+    /**
+     * Waits for {@link Pool} to be in a final state.
+     *
+     * @param request - The request {@link GetPoolRequest}
+     * @param options - The waiting options
+     * @returns A Promise of Pool
+     */
     this.waitForPool = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!POOL_TRANSIENT_STATUSES.includes(res.status))), this.getPool, request, options);
+    /**
+     * This method allows to 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.
+     *
+     * @param request - The request {@link UpgradePoolRequest}
+     * @returns A Promise of Pool
+     */
     this.upgradePool = request => this.client.fetch({
       body: JSON.stringify(marshalUpgradePoolRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/pools/${validatePathParam('poolId', request.poolId)}/upgrade`
     }, unmarshalPool);
+    /**
+     * This method allows to update some attributes of a specific pool such as the
+     * size, the autoscaling enablement, the tags, ...
+     *
+     * @param request - The request {@link UpdatePoolRequest}
+     * @returns A Promise of Pool
+     */
     this.updatePool = request => this.client.fetch({
       body: JSON.stringify(marshalUpdatePoolRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PATCH',
       path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/pools/${validatePathParam('poolId', request.poolId)}`
     }, unmarshalPool);
+    /**
+     * This method allows to delete a specific pool from a cluster, deleting all
+     * the nodes associated with it.
+     *
+     * @param request - The request {@link DeletePoolRequest}
+     * @returns A Promise of Pool
+     */
     this.deletePool = request => this.client.fetch({
       method: 'DELETE',
       path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/pools/${validatePathParam('poolId', request.poolId)}`
     }, unmarshalPool);
+    /**
+     * This method returns metadata about a Kosmos node, it is not intended to be
+     * directly called by end users, rather by kapsule-node-agent.
+     *
+     * @param request - The request {@link CreateExternalNodeRequest}
+     * @returns A Promise of ExternalNode
+     */
     this.createExternalNode = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
@@ -120,29 +241,88 @@ class API extends API$1 {
       path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/clusters/${validatePathParam('clusterId', request.clusterId)}/nodes`,
       urlParams: urlParams(['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['pool_id', request.poolId], ['status', request.status ?? 'unknown'])
     }, unmarshalListNodesResponse);
+    /**
+     * This method allows to list all the existing nodes for a specific Kubernetes
+     * cluster.
+     *
+     * @param request - The request {@link ListNodesRequest}
+     * @returns A Promise of ListNodesResponse
+     */
     this.listNodes = request => enrichForPagination('nodes', this.pageOfListNodes, request);
+    /**
+     * This method allows to get details about a specific Kubernetes node.
+     *
+     * @param request - The request {@link GetNodeRequest}
+     * @returns A Promise of Node
+     */
     this.getNode = request => this.client.fetch({
       method: 'GET',
       path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/nodes/${validatePathParam('nodeId', request.nodeId)}`
     }, unmarshalNode);
+    /**
+     * Waits for {@link Node} to be in a final state.
+     *
+     * @param request - The request {@link GetNodeRequest}
+     * @param options - The waiting options
+     * @returns A Promise of Node
+     */
     this.waitForNode = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!NODE_TRANSIENT_STATUSES.includes(res.status))), this.getNode, request, options);
+    /**
+     * This method allows to 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.
+     *
+     * @deprecated
+     * @param request - The request {@link ReplaceNodeRequest}
+     * @returns A Promise of Node
+     */
     this.replaceNode = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/nodes/${validatePathParam('nodeId', request.nodeId)}/replace`
     }, unmarshalNode);
+    /**
+     * This method allows to reboot a specific node. This node will frist be
+     * cordoned, meaning that scheduling will be disabled. Then the existing pods
+     * on the node will be drained and reschedule 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.
+     *
+     * @param request - The request {@link RebootNodeRequest}
+     * @returns A Promise of Node
+     */
     this.rebootNode = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/nodes/${validatePathParam('nodeId', request.nodeId)}/reboot`
     }, unmarshalNode);
+    /**
+     * This method allows to 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.
+     *
+     * @param request - The request {@link DeleteNodeRequest}
+     * @returns A Promise of Node
+     */
     this.deleteNode = request => this.client.fetch({
       method: 'DELETE',
       path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/nodes/${validatePathParam('nodeId', request.nodeId)}`,
       urlParams: urlParams(['replace', request.replace], ['skip_drain', request.skipDrain])
     }, unmarshalNode);
+    /**
+     * This method allows to list all available versions for the creation of a new
+     * Kubernetes cluster.
+     *
+     * @param request - The request {@link ListVersionsRequest}
+     * @returns A Promise of ListVersionsResponse
+     */
     this.listVersions = function (request) {
       if (request === void 0) {
         request = {};
@@ -152,12 +332,20 @@ class API extends API$1 {
         path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? _this.client.settings.defaultRegion)}/versions`
       }, unmarshalListVersionsResponse);
     };
+    /**
+     * This method allows to get a specific Kubernetes version and the details
+     * about the version.
+     *
+     * @param request - The request {@link GetVersionRequest}
+     * @returns A Promise of Version
+     */
     this.getVersion = request => this.client.fetch({
       method: 'GET',
       path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/versions/${validatePathParam('versionName', request.versionName)}`
     }, unmarshalVersion);
   }
 }
+/** Lists the available regions of the API. */
 API.LOCALITIES = ['fr-par', 'nl-ams', 'pl-waw'];
 
 export { API };

package/dist/api/k8s/v1/api.utils.js

@@ -0,0 +1,16 @@
+import { API } from './api.gen.js';
+
+class K8SUtilsAPI extends API {
+  constructor() {
+    super(...arguments);
+    /**
+     * Get configuration of a kube cluster.
+     *
+     * @param request - The request {@link GetClusterKubeConfigRequest}
+     * @returns A Promise of Blob
+     */
+    this.getClusterKubeConfig = request => this._getClusterKubeConfig(request);
+  }
+}
+
+export { K8SUtilsAPI };

package/dist/api/k8s/v1/{index.gen.js → index.js}

@@ -1,6 +1,4 @@
-export { API } from './api.gen.js';
+export { K8SUtilsAPI as API } from './api.utils.js';
 export { CLUSTER_TRANSIENT_STATUSES, NODE_TRANSIENT_STATUSES, POOL_TRANSIENT_STATUSES } from './content.gen.js';
 import * as validationRules_gen from './validation-rules.gen.js';
 export { validationRules_gen as ValidationRules };
-
-// This file was automatically generated. DO NOT EDIT.