Skip to main content

Returns all the available node pools​

Returns all the available node pools

Path Parameters
    workspace stringrequired

    Workspace to use

Query Parameters
    owner string

    List node pools owned by specified owner

Responses​

A list of node pools

Schema
    apiVersion string
    items undefined[]
    apiVersion string
    kind string
    metadata

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

    annotations object

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

  • property name* string
    • clusterName string
    creationTimestamp string
    deletionGracePeriodSeconds int64
    deletionTimestamp string
    finalizers string[]
    generateName string
    generation int64
    labels object

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

  • property name* string
    • managedFields undefined[]

    ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

    apiVersion string
    fieldsType string
    fieldsV1 string
    manager string
    operation string
    subresource string
    time string
    name string
    namespace string
    ownerReferences undefined[]

    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

    apiVersion string
    blockOwnerDeletion boolean
    controller boolean
    kind string
    name string
    uid string
    resourceVersion string
    selfLink string
    uid string
    spec

    NodePool defines a node pool in kubernetes

    autoscaling

    Autoscaling indicates the node pool should autoscale

    enabled boolean
    maxSize int64
    minSize int64
    channel string
    cloudResourceName string
    defaultUpdateOptions

    DefaultUpdateOptions defines how this nodepool can be upgraded - Used by the cluster controller to generate NodePoolUpdates based on spec changes - Ignored when a NodePoolUpdate is created directly

    cloudUpdateStrategy string
    newReplacementConfig

    NewReplacementConfig specifies how to create a new node pool and migrate workloads to it

    nodeDrainTimeOut string
    replacementStrategy string
    description string
    diskSize int64
    expires string
    image string
    labels object

    Labels is a collection of label placed on to the nodepool

  • property name* string
    • logicalName string
    machine string
    maxPodsPerNode int64
    providerDetails

    ProviderDetails provides any cloud specific options for this nodepool

    aks

    AKS defines the cloud specific options for AKS clusters

    mode string
    eks

    EKS defines a cloud specific options for EKS clusters

    ami string
    eC2SSHKey string
    sshSourceSecurityGroups string[]
    userData string
    gke

    GKE is the provider specification for their clusters

    enableAutorepair boolean
    enableAutoupgrade boolean
    type string
    unmanaged
    size int64
    spot

    Spot if defines enables nodepool to use spot instances

    aks

    AKS defines the options for AKS spot instances

    maxSpotPrice string
    eks

    EKS provides additional options for EKS

    additionalInstanceTypes string[]
    enabled boolean
    taints undefined[]

    Taints defines a collection scheduling taints placed on the nodepool

    effect string
    key string
    value string
    version string
    zones string[]
    status
    cloudResourcesCreated boolean
    conditions undefined[]
    detail string
    lastTransitionTime string
    message string
    name string
    negativePolarity boolean
    observedGeneration int64
    reason string
    status string
    type string
    detail string
    details string
    lastReconcile
    generation int64
    time string
    lastSuccess
    generation int64
    time string
    message string
    name string
    nodeCount int32
    nodeCountReady int32
    obsoleteResources undefined[]
    kind string
    name string
    providerStatus string
    status string
    wayfinderVersion string
    kind string
    metadata

    ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

    continue string
    remainingItemCount int64
    resourceVersion string
    selfLink string
Loading...
Last updated on 28 Dec 2023