Type Alias CreatePoolRequest

CreatePoolRequest: {
    autohealing: boolean;
    autoscaling: boolean;
    clusterId: string;
    containerRuntime?: K8s.v1.Runtime;
    kubeletArgs?: Record<string, string>;
    maxSize?: number;
    minSize?: number;
    name?: string;
    nodeType: string;
    placementGroupId?: string;
    publicIpDisabled: boolean;
    region?: Region;
    rootVolumeSize?: number;
    rootVolumeType?: PoolVolumeType;
    size: number;
    tags?: string[];
    upgradePolicy?: CreatePoolRequestUpgradePolicy;
    zone?: Zone;
}

Type declaration

  • autohealing: boolean

    Defines whether the autohealing feature is enabled for the pool.

  • autoscaling: boolean

    Defines whether the autoscaling feature is enabled for the pool.

  • clusterId: string

    Cluster ID to which the pool will be attached.

  • OptionalcontainerRuntime?: K8s.v1.Runtime

    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.

  • OptionalkubeletArgs?: Record<string, string>

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

  • OptionalmaxSize?: number

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

  • OptionalminSize?: number

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

  • Optionalname?: string

    Pool name.

  • 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?: string

    Placement group ID in which all the nodes of the pool will be created.

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

  • Optionalregion?: Region

    Region to target. If none is passed will use default region from the config.

  • OptionalrootVolumeSize?: number

    System volume disk size.

  • OptionalrootVolumeType?: PoolVolumeType

    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.

  • size: number

    Size (number of nodes) of the pool.

  • Optionaltags?: string[]

    Tags associated with the pool.

  • OptionalupgradePolicy?: CreatePoolRequestUpgradePolicy

    Pool upgrade policy.

  • Optionalzone?: Zone

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

Settings