@akamai/openapi-ts
    Preparing search index...

    Type Alias PostLkeClusterPoolsData

    type PostLkeClusterPoolsData = {
        body: {
            autoscaler?: { enabled?: boolean; max?: number; min?: number };
            count: number;
            disk_encryption?: "enabled" | "disabled";
            disks?: { size?: number; type?: "raw" | "ext4" }[];
            k8s_version?: string;
            label?: string;
            labels?: { [key: string]: string };
            tags?: string[];
            taints?: {
                effect: "NoSchedule" | "PreferNoSchedule" | "NoExecute";
                key: string;
                value: string;
            }[];
            type: string;
            update_strategy?: "rolling_update"
            | "on_recycle";
        };
        path: { clusterId: number };
        query?: never;
        url: "lke/clusters/{clusterId}/pools";
    }
    Index

    Properties

    body path query? url

    Properties

    body

    body: {
        autoscaler?: { enabled?: boolean; max?: number; min?: number };
        count: number;
        disk_encryption?: "enabled" | "disabled";
        disks?: { size?: number; type?: "raw" | "ext4" }[];
        k8s_version?: string;
        label?: string;
        labels?: { [key: string]: string };
        tags?: string[];
        taints?: {
            effect: "NoSchedule" | "PreferNoSchedule" | "NoExecute";
            key: string;
            value: string;
        }[];
        type: string;
        update_strategy?: "rolling_update"
        | "on_recycle";
    }

    Specifies a collection of Linodes to serve as members of a Kubernetes cluster.

    Type Declaration

    • Optionalautoscaler?: { enabled?: boolean; max?: number; min?: number }

      When enabled, the number of nodes automatically scales within the defined minimum and maximum values. When making a request, max and min require each other.

      • Optionalenabled?: boolean

        Whether automatic scaling is enabled for this node pool. Defaults to false.

      • Optionalmax?: number

        The maximum number of nodes to automatically scale to. Defaults to the value provided by the count field.

      • Optionalmin?: number

        The minimum number of nodes to automatically scale to. Defaults to the node pool's count.

    • count: number

      The number of nodes in the node pool.

    • Optionaldisk_encryption?: "enabled" | "disabled"

      Local disk encryption setting for this LKE node pool. Defaults to disabled.

    • Optionaldisks?: { size?: number; type?: "raw" | "ext4" }[]

      This node pool's custom disk layout. Each item in this array will create a new disk partition for each node in this node pool.

      📘

      Omit this field, except for special use cases. The disks specified here are partitions in addition to the primary partition and reduce the size of the primary partition. This can lead to stability problems for the node.

      • The custom disk layout is applied to each node in this node pool.

      • The maximum number of custom disk partitions that can be configured is 7.

      • Once the requested disk partitions are allocated, the remaining disk space is allocated to the node's boot disk.

      • A node pool's custom disk layout is immutable over the lifetime of the node pool.

    • Optionalk8s_version?: string

      Beta, LKE Enterprise The LKE-specific Kubernetes version to use for the worker nodes within this node pool. This field is required when creating node pools on LKE Enterprise clusters.

      🚧

      This field is available as part of the beta API and can only be used with accounts that have been enrolled in the LKE Enterprise LA. Call the URL with the apiVersion path parameter set to v4beta.

    • Optionallabel?: string

      Beta An optional label for this node pool. Labels can be up to 32 characters long, containing lowercase alphanumeric characters optionally interspersed with dashes.

      A node pool's label also cascades down to its nodes (Linodes). If a label is defined on the node pool, the label for each node is <cluster-id>-<nodepool-label>-<hash>. If not, the label is <cluster-id>-<nodepool-id>-<hash>.

      🚧

      This field is available as part of the beta API and can only be used with accounts that have been enrolled in the LKE Enterprise LA. Call the URL with the apiVersion path parameter set to v4beta.

    • Optionallabels?: { [key: string]: string }

      Key-value pairs added as labels to nodes in the node pool. Labels help classify your nodes and easily select subsets of objects. To learn more, review Add Labels and Taints to your LKE node pools.

      Label key:

      • A key can contain alphanumeric characters, dashes (-), underscores (_), or dots (.). Start and end it with an alphanumeric character.

      • If the key begins with a DNS subdomain prefix followed by a single slash, for example example.com/my-app, the maximum total length of the label key is 128 characters. Domain labels can be up to 62 characters after the '/'. The prefix needs to adhere to RFC 1123 DNS subdomain restrictions.

      • If the key doesn't begin with a DNS subdomain prefix, the maximum key length is 63 characters.

      Specifying an empty object removes all previously set labels.

      Label value:

      • The label's value can contain alphanumeric characters, dashes (-), underscores (_), or dots (.). Start and end it with an alphanumeric character.

      • Can be specified as an empty string value with "".

    • Optionaltags?: string[]

      Filterable Organizational tags to apply to this node pool. When you apply tags to LKE Enterprise node pools, they also apply to the nodes (Linodes) within the node pool. Tags don't cascade down to nodes in non-Enterprise node pools.

    • Optionaltaints?: {
          effect: "NoSchedule" | "PreferNoSchedule" | "NoExecute";
          key: string;
          value: string;
      }[]

      Kubernetes taints to add to node pool nodes. Taints help control how pods are scheduled onto nodes, specifically allowing them to repel certain pods. To learn more, review Add labels and taints to your LKE node pools.

      Specifying an empty array ([]) removes all previously set taints.

    • type: string

      The Linode Type for all of the nodes in the node pool.

    • Optionalupdate_strategy?: "rolling_update" | "on_recycle"

      Beta, LKE Enterprise Determines when the worker nodes within this node pool upgrade to the latest selected Kubernetes version, after the cluster has been upgraded. This field is required when creating node pools on LKE Enterprise clusters.

      • rolling_update: Immediately triggers a recycle of this node pool when the Kubernetes version is updated.
      • on_recycle (default): Does not trigger any immediate recycle. New worker nodes are created with the new Kubernetes version. Existing worker nodes will be upgraded when a recycle is manually triggered.

      🚧

      This field is available as part of the beta API and can only be used with accounts that have been enrolled in the LKE Enterprise LA. Call the URL with the apiVersion path parameter set to v4beta.

    path: { clusterId: number }

    Type Declaration

    • clusterId: number

      ID of the Kubernetes cluster to look up.

    query?: never
    url: "lke/clusters/{clusterId}/pools"

    Settings

    Member Visibility

    On This Page

    Properties