Class API

constructor

• new API(client: Client): K8s.v1.API

• Parameters

  • client: Client

  Returns K8s.v1.API

Static ReadonlyLOCALITIES

addClusterACLRules

• addClusterACLRules(
      request: Readonly<AddClusterACLRulesRequest>,
  ): Promise<AddClusterACLRulesResponse>

• Add new ACLs. Add new ACL rules for a specific cluster.

  Parameters

  • request: Readonly<AddClusterACLRulesRequest>

    The request AddClusterACLRulesRequest

  Returns Promise<AddClusterACLRulesResponse>

  A Promise of AddClusterACLRulesResponse

authExternalNode

• authExternalNode(
      request: Readonly<AuthExternalNodeRequest>,
  ): Promise<ExternalNodeAuth>

• Authenticate Kosmos external node. Creates a newer Kosmos node and returns its token. This method is not intended to be called by end users but rather programmatically by the node-installer.

  Parameters

  • request: Readonly<AuthExternalNodeRequest>

    The request AuthExternalNodeRequest

  Returns Promise<ExternalNodeAuth>

  A Promise of ExternalNodeAuth

createCluster

• createCluster(
      request: Readonly<K8s.v1.CreateClusterRequest>,
  ): Promise<K8s.v1.Cluster>

• Create a new Cluster. Create a new Kubernetes cluster in a Scaleway region.

  Parameters

  • request: Readonly<K8s.v1.CreateClusterRequest>

    The request CreateClusterRequest

  Returns Promise<K8s.v1.Cluster>

  A Promise of Cluster

createExternalNode

• createExternalNode(
      request: Readonly<CreateExternalNodeRequest>,
  ): Promise<ExternalNode>

• 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.

  Parameters

  • request: Readonly<CreateExternalNodeRequest>

    The request CreateExternalNodeRequest

  Returns Promise<ExternalNode>

  A Promise of ExternalNode

createPool

• createPool(request: Readonly<K8s.v1.CreatePoolRequest>): Promise<Pool>

• Create a new Pool in a Cluster. Create a new pool in a specific Kubernetes cluster.

  Parameters

  • request: Readonly<K8s.v1.CreatePoolRequest>

    The request CreatePoolRequest

  Returns Promise<Pool>

  A Promise of Pool

deleteACLRule

• deleteACLRule(request: Readonly<DeleteACLRuleRequest>): Promise<void>

• Delete an existing ACL.

  Parameters

  • request: Readonly<DeleteACLRuleRequest>

    The request DeleteACLRuleRequest

  Returns Promise<void>

deleteCluster

• deleteCluster(
      request: Readonly<K8s.v1.DeleteClusterRequest>,
  ): Promise<K8s.v1.Cluster>

• Delete a Cluster. Delete a specific Kubernetes cluster and all its associated pools and nodes, and possibly its associated Load Balancers or Block Volumes.

  Parameters

  • request: Readonly<K8s.v1.DeleteClusterRequest>

    The request DeleteClusterRequest

  Returns Promise<K8s.v1.Cluster>

  A Promise of Cluster

deleteNode

• deleteNode(request: Readonly<DeleteNodeRequest>): Promise<Node>

• Delete a Node in a Cluster. Delete a specific Node. The node will first be drained and pods will be rescheduled onto another node. Note that when there is not enough space to reschedule all the pods (such as in a one-node cluster, or with specific constraints), disruption of your applications may occur.

  Parameters

  • request: Readonly<DeleteNodeRequest>

    The request DeleteNodeRequest

  Returns Promise<Node>

  A Promise of Node

deletePool

• deletePool(request: Readonly<DeletePoolRequest>): Promise<Pool>

• Delete a Pool in a Cluster. Delete a specific pool from a cluster. Note that all the pool's nodes will also be deleted.

  Parameters

  • request: Readonly<DeletePoolRequest>

    The request DeletePoolRequest

  Returns Promise<Pool>

  A Promise of Pool

getCluster

• getCluster(request: Readonly<K8s.v1.GetClusterRequest>): Promise<K8s.v1.Cluster>

• Get a Cluster. Retrieve information about a specific Kubernetes cluster.

  Parameters

  • request: Readonly<K8s.v1.GetClusterRequest>

    The request GetClusterRequest

  Returns Promise<K8s.v1.Cluster>

  A Promise of Cluster

getClusterKubeConfig

• getClusterKubeConfig(
      request: Readonly<GetClusterKubeConfigRequest>,
  ): Promise<Blob>

• Get configuration of a kube cluster.

  Parameters

  • request: Readonly<GetClusterKubeConfigRequest>

    The request GetClusterKubeConfigRequest

  Returns Promise<Blob>

  A Promise of Blob

getNode

• getNode(request: Readonly<GetNodeRequest>): Promise<Node>

• Get a Node in a Cluster. Retrieve details about a specific Kubernetes Node.

  Parameters

  • request: Readonly<GetNodeRequest>

    The request GetNodeRequest

  Returns Promise<Node>

  A Promise of Node

getNodeMetadata

• getNodeMetadata(
      request?: Readonly<GetNodeMetadataRequest>,
  ): Promise<NodeMetadata>

• Fetch node metadata. Rerieve metadata to instantiate a Kapsule/Kosmos node. This method is not intended to be called by end users but rather programmatically by the node-installer.

  Parameters

  • request: Readonly<GetNodeMetadataRequest> = {}

    The request GetNodeMetadataRequest

  Returns Promise<NodeMetadata>

  A Promise of NodeMetadata

getPool

• getPool(request: Readonly<GetPoolRequest>): Promise<Pool>

• Get a Pool in a Cluster. Retrieve details about a specific pool in a Kubernetes cluster.

  Parameters

  • request: Readonly<GetPoolRequest>

    The request GetPoolRequest

  Returns Promise<Pool>

  A Promise of Pool

getVersion

• getVersion(request: Readonly<K8s.v1.GetVersionRequest>): Promise<K8s.v1.Version>

• Get a Version. Retrieve a specific Kubernetes version and its details.

  Parameters

  • request: Readonly<K8s.v1.GetVersionRequest>

    The request GetVersionRequest

  Returns Promise<K8s.v1.Version>

  A Promise of Version

listClusterACLRules

• listClusterACLRules(
      request: Readonly<ListClusterACLRulesRequest>,
  ): Promise<ListClusterACLRulesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<K8s.v1.ACLRule[], void, void>;
      all: () => Promise<K8s.v1.ACLRule[]>;
  }

• List ACLs. List ACLs for a specific cluster.

  Parameters

  • request: Readonly<ListClusterACLRulesRequest>

    The request ListClusterACLRulesRequest

  Returns Promise<ListClusterACLRulesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<K8s.v1.ACLRule[], void, void>;
      all: () => Promise<K8s.v1.ACLRule[]>;
  }

  A Promise of ListClusterACLRulesResponse

listClusterAvailableTypes

• listClusterAvailableTypes(
      request: Readonly<ListClusterAvailableTypesRequest>,
  ): Promise<ListClusterAvailableTypesResponse>

• List available cluster types for a cluster. List the cluster types that a specific Kubernetes cluster is allowed to switch to.

  Parameters

  • request: Readonly<ListClusterAvailableTypesRequest>

    The request ListClusterAvailableTypesRequest

  Returns Promise<ListClusterAvailableTypesResponse>

  A Promise of ListClusterAvailableTypesResponse

listClusterAvailableVersions

• listClusterAvailableVersions(
      request: Readonly<ListClusterAvailableVersionsRequest>,
  ): Promise<ListClusterAvailableVersionsResponse>

• 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.

  Parameters

  • request: Readonly<ListClusterAvailableVersionsRequest>

    The request ListClusterAvailableVersionsRequest

  Returns Promise<ListClusterAvailableVersionsResponse>

  A Promise of ListClusterAvailableVersionsResponse

listClusters

• listClusters(
      request?: Readonly<K8s.v1.ListClustersRequest>,
  ): Promise<K8s.v1.ListClustersResponse> & {
      "[asyncIterator]": () => AsyncGenerator<K8s.v1.Cluster[], void, void>;
      all: () => Promise<K8s.v1.Cluster[]>;
  }

• List Clusters. List all existing Kubernetes clusters in a specific region.

  Parameters

  • request: Readonly<K8s.v1.ListClustersRequest> = {}

    The request ListClustersRequest

  Returns Promise<K8s.v1.ListClustersResponse> & {
      "[asyncIterator]": () => AsyncGenerator<K8s.v1.Cluster[], void, void>;
      all: () => Promise<K8s.v1.Cluster[]>;
  }

  A Promise of ListClustersResponse

listClusterTypes

• listClusterTypes(
      request?: Readonly<K8s.v1.ListClusterTypesRequest>,
  ): Promise<ListClusterTypesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<ClusterType[], void, void>;
      all: () => Promise<ClusterType[]>;
  }

• List cluster types. List available cluster types and their technical details.

  Parameters

  • request: Readonly<K8s.v1.ListClusterTypesRequest> = {}

    The request ListClusterTypesRequest

  Returns Promise<ListClusterTypesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<ClusterType[], void, void>;
      all: () => Promise<ClusterType[]>;
  }

  A Promise of ListClusterTypesResponse

listNodes

• listNodes(
      request: Readonly<K8s.v1.ListNodesRequest>,
  ): Promise<ListNodesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<Node[], void, void>;
      all: () => Promise<Node[]>;
  }

• List Nodes in a Cluster. List all the existing nodes for a specific Kubernetes cluster.

  Parameters

  • request: Readonly<K8s.v1.ListNodesRequest>

    The request ListNodesRequest

  Returns Promise<ListNodesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<Node[], void, void>;
      all: () => Promise<Node[]>;
  }

  A Promise of ListNodesResponse

listPools

• listPools(
      request: Readonly<K8s.v1.ListPoolsRequest>,
  ): Promise<ListPoolsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<Pool[], void, void>;
      all: () => Promise<Pool[]>;
  }

• List Pools in a Cluster. List all the existing pools for a specific Kubernetes cluster.

  Parameters

  • request: Readonly<K8s.v1.ListPoolsRequest>

    The request ListPoolsRequest

  Returns Promise<ListPoolsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<Pool[], void, void>;
      all: () => Promise<Pool[]>;
  }

  A Promise of ListPoolsResponse

listVersions

• listVersions(
      request?: Readonly<K8s.v1.ListVersionsRequest>,
  ): Promise<K8s.v1.ListVersionsResponse>

• List all available Versions. List all available versions for the creation of a new Kubernetes cluster.

  Parameters

  • request: Readonly<K8s.v1.ListVersionsRequest> = {}

    The request ListVersionsRequest

  Returns Promise<K8s.v1.ListVersionsResponse>

  A Promise of ListVersionsResponse

migrateClusterToSBSCSI

• migrateClusterToSBSCSI(
      request: Readonly<MigrateClusterToSBSCSIRequest>,
  ): Promise<K8s.v1.Cluster>

• Migrate a cluster to SBS CSI. Enable the latest CSI compatible with Scaleway Block Storage (SBS) and migrate all existing PersistentVolumes/VolumeSnapshotContents to SBS. Make sure to have the necessary Quota before running this command.

  Parameters

  • request: Readonly<MigrateClusterToSBSCSIRequest>

    The request MigrateClusterToSBSCSIRequest

  Returns Promise<K8s.v1.Cluster>

  A Promise of Cluster

rebootNode

• rebootNode(request: Readonly<RebootNodeRequest>): Promise<Node>

• Reboot a Node in a Cluster. Reboot a specific Node. The node will first be drained and pods will be rescheduled onto another node. Note that when there is not enough space to reschedule all the pods (such as in a one-node cluster, or with specific constraints), disruption of your applications may occur.

  Parameters

  • request: Readonly<RebootNodeRequest>

    The request RebootNodeRequest

  Returns Promise<Node>

  A Promise of Node

replaceNode

• replaceNode(request: Readonly<ReplaceNodeRequest>): Promise<Node>

• Replace a Node in a Cluster. Replace a specific Node. The node will first be drained and pods will be rescheduled onto another node. Note that when there is not enough space to reschedule all the pods (such as in a one-node cluster, or with specific constraints), disruption of your applications may occur.

  Parameters

  • request: Readonly<ReplaceNodeRequest>

    The request ReplaceNodeRequest

  Returns Promise<Node>

  A Promise of Node

  Deprecated

resetClusterAdminToken

• resetClusterAdminToken(
      request: Readonly<ResetClusterAdminTokenRequest>,
  ): Promise<void>

• 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 the kubeconfig again to keep interacting with the cluster.

  Parameters

  • request: Readonly<ResetClusterAdminTokenRequest>

    The request ResetClusterAdminTokenRequest

  Returns Promise<void>

setClusterACLRules

• setClusterACLRules(
      request: Readonly<SetClusterACLRulesRequest>,
  ): Promise<SetClusterACLRulesResponse>

• Set new ACLs. Set new ACL rules for a specific cluster.

  Parameters

  • request: Readonly<SetClusterACLRulesRequest>

    The request SetClusterACLRulesRequest

  Returns Promise<SetClusterACLRulesResponse>

  A Promise of SetClusterACLRulesResponse

setClusterType

• setClusterType(
      request: Readonly<K8s.v1.SetClusterTypeRequest>,
  ): Promise<K8s.v1.Cluster>

• Change the Cluster type. Change the type of a specific Kubernetes cluster. To see the possible values you can enter for the type field, list available cluster types.

  Parameters

  • request: Readonly<K8s.v1.SetClusterTypeRequest>

    The request SetClusterTypeRequest

  Returns Promise<K8s.v1.Cluster>

  A Promise of Cluster

updateCluster

• updateCluster(
      request: Readonly<K8s.v1.UpdateClusterRequest>,
  ): Promise<K8s.v1.Cluster>

• 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.

  Parameters

  • request: Readonly<K8s.v1.UpdateClusterRequest>

    The request UpdateClusterRequest

  Returns Promise<K8s.v1.Cluster>

  A Promise of Cluster

updatePool

• updatePool(request: Readonly<UpdatePoolRequest>): Promise<Pool>

• Update a Pool in a Cluster. Update the attributes of a specific pool, such as its desired size, autoscaling settings, and tags. To upgrade a pool, you will need to use the dedicated endpoint.

  Parameters

  • request: Readonly<UpdatePoolRequest>

    The request UpdatePoolRequest

  Returns Promise<Pool>

  A Promise of Pool

upgradeCluster

• upgradeCluster(
      request: Readonly<K8s.v1.UpgradeClusterRequest>,
  ): Promise<K8s.v1.Cluster>

• Upgrade a Cluster. Upgrade a specific Kubernetes cluster and possibly its associated pools to a specific and supported Kubernetes version.

  Parameters

  • request: Readonly<K8s.v1.UpgradeClusterRequest>

    The request UpgradeClusterRequest

  Returns Promise<K8s.v1.Cluster>

  A Promise of Cluster

upgradePool

• upgradePool(request: Readonly<UpgradePoolRequest>): Promise<Pool>

• 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. This will drain and replace the nodes in that pool.

  Parameters

  • request: Readonly<UpgradePoolRequest>

    The request UpgradePoolRequest

  Returns Promise<Pool>

  A Promise of Pool

waitForCluster

• waitForCluster(
      request: Readonly<K8s.v1.GetClusterRequest>,
      options?: Readonly<WaitForOptions<K8s.v1.Cluster>>,
  ): Promise<K8s.v1.Cluster>

• Waits for Cluster to be in a final state.

  Parameters

  • request: Readonly<K8s.v1.GetClusterRequest>

    The request GetClusterRequest
  • Optionaloptions: Readonly<WaitForOptions<K8s.v1.Cluster>>

    The waiting options

  Returns Promise<K8s.v1.Cluster>

  A Promise of Cluster

waitForNode

• waitForNode(
      request: Readonly<GetNodeRequest>,
      options?: Readonly<WaitForOptions<Node>>,
  ): Promise<Node>

• Waits for Node to be in a final state.

  Parameters

  • request: Readonly<GetNodeRequest>

    The request GetNodeRequest
  • Optionaloptions: Readonly<WaitForOptions<Node>>

    The waiting options

  Returns Promise<Node>

  A Promise of Node

waitForPool

• waitForPool(
      request: Readonly<GetPoolRequest>,
      options?: Readonly<WaitForOptions<Pool>>,
  ): Promise<Pool>

• Waits for Pool to be in a final state.

  Parameters

  • request: Readonly<GetPoolRequest>

    The request GetPoolRequest
  • Optionaloptions: Readonly<WaitForOptions<Pool>>

    The waiting options

  Returns Promise<Pool>

  A Promise of Pool