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

    Type Alias PostLkeClusterPoolsResponses

    type PostLkeClusterPoolsResponses = {
        "200": {
            autoscaler: { enabled: boolean; max: number; min: number };
            count: number;
            disk_encryption: "enabled" | "disabled";
            disks: { size: number; type: "raw" | "ext4" }[];
            id: number;
            k8s_version: string;
            label: string;
            labels: { [key: string]: string };
            nodes: {
                id: string;
                instance_id: number | null;
                status: "ready" | "not_ready";
            }[];
            tags: string[];
            taints: {
                effect?: "NoSchedule"
                | "PreferNoSchedule"
                | "NoExecute";
                key?: string;
                value?: string;
            }[];
            type: string;
            update_strategy: "rolling_update"
            | "on_recycle";
        };
    }
    Index

    Properties

    200

    Properties

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

    The set of node pools that are members of the Kubernetes cluster. Node pools consist of a Linode type, the number of Linodes to deploy of that type, and additional status information.

    Type Declaration

    • autoscaler: { enabled: boolean; max: number; min: number }

      When enabled, the number of nodes autoscales within the defined minimum and maximum values.

      • enabled: boolean

        Whether autoscaling is enabled for this node pool. Defaults to false.

      • max: number

        The maximum number of nodes to autoscale to. Defaults to the node pool's count.

      • min: number

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

    • count: number

      The number of nodes in the node pool.

    • disk_encryption: "enabled" | "disabled"

      Indicates the local disk encryption setting for this LKE node pool.

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

      This node pool's custom disk layout.

    • id: number

      Filterable This node pool's unique ID.

    • k8s_version: string

      Beta The Kubernetes version used for the worker nodes within this node pool.

      🚧

      This field is available as part of the beta API and is only returned for accounts that have been enrolled in the LKE Enterprise LA.

    • label: string

      Beta The optional label defined for this node Pool.

      🚧

      This field is available as part of the beta API and is only returned for accounts that have been enrolled in the LKE Enterprise LA.

    • labels: { [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.

    • nodes: { id: string; instance_id: number | null; status: "ready" | "not_ready" }[]

      Status information for the nodes that are members of this node pool. If a Linode has not been provisioned for a given node slot, the instance_id is null.

    • tags: string[]

      Filterable An array of tags applied to this object. Tags are for organizational purposes only.

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

      Kubernetes taints added to nodes in the node pool. Taints help control how pods are scheduled onto nodes, specifically allowing them to repel certain pods.

    • type: string

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

    • update_strategy: "rolling_update" | "on_recycle"

      Beta 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 for LKE Enterprise clusters but should not be used for non-enterprise LKE clusters.

    Settings

    Member Visibility

    On This Page

    Properties