Interface Pool

interface Pool {
    autohealing: boolean;
    autoscaling: boolean;
    clusterId: string;
    containerRuntime: K8s.v1.Runtime;
    createdAt?: Date;
    id: string;
    kubeletArgs: Record<string, string>;
    maxSize: number;
    minSize: number;
    name: string;
    nodeType: string;
    placementGroupId?: string;
    publicIpDisabled: boolean;
    region: Region;
    rootVolumeSize?: number;
    rootVolumeType: PoolVolumeType;
    size: number;
    status: PoolStatus;
    tags: string[];
    updatedAt?: Date;
    upgradePolicy?: PoolUpgradePolicy;
    version: string;
    zone: Zone;
}

Properties

autohealing autoscaling clusterId containerRuntime createdAt? id kubeletArgs maxSize minSize name nodeType placementGroupId? publicIpDisabled region rootVolumeSize? rootVolumeType size status tags updatedAt? upgradePolicy? version zone

Properties

autohealing

autohealing: boolean

Defines whether the autohealing feature is enabled for the pool.

autoscaling

autoscaling: boolean

Defines whether the autoscaling feature is enabled for the pool.

clusterId

clusterId: string

Cluster ID of the pool.

containerRuntime

containerRuntime: K8s.v1.Runtime

Customization of the container runtime is available for each pool.

OptionalcreatedAt

createdAt?: Date

Date on which the pool was created.

id

id: string

Pool ID.

kubeletArgs

kubeletArgs: Record<string, string>

Kubelet arguments to be used by this pool. Note that this feature is experimental.

maxSize

maxSize: number

Defines the maximum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.

minSize

minSize: number

Defines the minimum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.

name

name: string

Pool name.

nodeType

nodeType: string

Node type is the type of Scaleway Instance wanted for the pool. Nodes with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). 'external' is a special node type used to provision instances from other cloud providers in a Kosmos Cluster.

OptionalplacementGroupId

placementGroupId?: string

Placement group ID in which all the nodes of the pool will be created, placement groups are limited to 20 instances.

publicIpDisabled

publicIpDisabled: boolean

Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.

region

region: Region

Cluster region of the pool.

OptionalrootVolumeSize

rootVolumeSize?: number

System volume disk size.

rootVolumeType

rootVolumeType: PoolVolumeType
  • l_ssd is a local block storage which means your system is stored locally on your node's hypervisor. This type is not available for all node types sbs-5k is a remote block storage which means your system is stored on a centralized and resilient cluster with 5k IOPS limits sbs-15k is a faster remote block storage which means your system is stored on a centralized and resilient cluster with 15k IOPS limits b_ssd is the legacy remote block storage which means your system is stored on a centralized and resilient cluster. Consider using sbs-5k or sbs-15k instead.

size

size: number

Size (number of nodes) of the pool.

status

status: PoolStatus

Pool status.

tags

tags: string[]

Tags associated with the pool, see managing tags.

OptionalupdatedAt

updatedAt?: Date

Date on which the pool was last updated.

OptionalupgradePolicy

upgradePolicy?: PoolUpgradePolicy

Pool upgrade policy.

version

version: string

Pool version.

zone

zone: Zone

Zone in which the pool's nodes will be spawned.

Settings

On This Page

Properties