Updates the node pool

Updates the node pool

Path Parameters

workspace stringrequired

Workspace to use

name stringrequired

The name of the node pool you wish or update

Query Parameters

dryRun string

Set to 'All' to perform a server-side dry run of updating this resource

force string

Set to 'true' to override read-only (has no effect unless used by Wayfinder admin)

owner string

Use an explicit owner for this resource - this must match the owner used on create, if set

apply string

Use server-side apply for this update instead of overwriting the whole object

application/json

Request Body required

The specification for the node pool you are updating

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 stringrequired
blockOwnerDeletion boolean
controller boolean
kind stringrequired
name stringrequired
uid stringrequired
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 stringrequired
newReplacementConfig
NewReplacementConfig specifies how to create a new node pool and migrate workloads to it
nodeDrainTimeOut string
replacementStrategy stringrequired
description string
diskSize int64required
expires string
image stringrequired
labels object
Labels is a collection of label placed on to the nodepool
property name* string
logicalName stringrequired
machine stringrequired
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 stringrequired
unmanaged
size int64required
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 stringrequired
message string
name stringrequired
negativePolarity boolean
observedGeneration int64
reason stringrequired
status stringrequired
type stringrequired
detail string
details string
lastReconcile
generation int64required
time stringrequired
lastSuccess
generation int64required
time stringrequired
message string
name string
nodeCount int32
nodeCountReady int32
obsoleteResources undefined[]
kind stringrequired
name stringrequired
providerStatus string
status stringrequired
wayfinderVersion string

Responses

200

Contains the node pool definition

application/json

Schema

Schema

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

Example (from schema)

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": {},
    "clusterName": "string",
    "creationTimestamp": "string",
    "deletionGracePeriodSeconds": 0,
    "deletionTimestamp": "string",
    "finalizers": [
      "string"
    ],
    "generateName": "string",
    "generation": 0,
    "labels": {},
    "managedFields": [
      {
        "apiVersion": "string",
        "fieldsType": "string",
        "fieldsV1": "string",
        "manager": "string",
        "operation": "string",
        "subresource": "string",
        "time": "string"
      }
    ],
    "name": "string",
    "namespace": "string",
    "ownerReferences": [
      {
        "apiVersion": "string",
        "blockOwnerDeletion": true,
        "controller": true,
        "kind": "string",
        "name": "string",
        "uid": "string"
      }
    ],
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "autoscaling": {
      "enabled": true,
      "maxSize": 0,
      "minSize": 0
    },
    "channel": "string",
    "cloudResourceName": "string",
    "defaultUpdateOptions": {
      "cloudUpdateStrategy": "string",
      "newReplacementConfig": {
        "nodeDrainTimeOut": "string"
      },
      "replacementStrategy": "string"
    },
    "description": "string",
    "diskSize": 0,
    "expires": "string",
    "image": "string",
    "labels": {},
    "logicalName": "string",
    "machine": "string",
    "maxPodsPerNode": 0,
    "providerDetails": {
      "aks": {
        "mode": "string"
      },
      "eks": {
        "ami": "string",
        "eC2SSHKey": "string",
        "sshSourceSecurityGroups": [
          "string"
        ],
        "userData": "string"
      },
      "gke": {
        "enableAutorepair": true,
        "enableAutoupgrade": true
      },
      "type": "string"
    },
    "size": 0,
    "spot": {
      "aks": {
        "maxSpotPrice": "string"
      },
      "eks": {
        "additionalInstanceTypes": [
          "string"
        ]
      },
      "enabled": true
    },
    "taints": [
      {
        "effect": "string",
        "key": "string",
        "value": "string"
      }
    ],
    "version": "string",
    "zones": [
      "string"
    ]
  },
  "status": {
    "cloudResourcesCreated": true,
    "conditions": [
      {
        "detail": "string",
        "lastTransitionTime": "string",
        "message": "string",
        "name": "string",
        "negativePolarity": true,
        "observedGeneration": 0,
        "reason": "string",
        "status": "string",
        "type": "string"
      }
    ],
    "detail": "string",
    "details": "string",
    "lastReconcile": {
      "generation": 0,
      "time": "string"
    },
    "lastSuccess": {
      "generation": 0,
      "time": "string"
    },
    "message": "string",
    "name": "string",
    "nodeCount": 0,
    "nodeCountReady": 0,
    "obsoleteResources": [
      {
        "kind": "string",
        "name": "string"
      }
    ],
    "providerStatus": "string",
    "status": "string",
    "wayfinderVersion": "string"
  }
}

400

Validation error of supplied parameters/body

application/json

Schema

Schema

code int32
fieldErrors undefined[]
errCode string
field string
message string
message string

Example (from schema)

{
  "code": 0,
  "fieldErrors": [
    {
      "errCode": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "message": "string"
}

401

If not authenticated

403

If authenticated but not authorized

500

A generic API error containing the cause of the error

application/json

Schema

Schema

code int32
detail string
message string
uri string
verb string

Example (from schema)

{
  "code": 0,
  "detail": "string",
  "message": "string",
  "uri": "string",
  "verb": "string"
}

Loading...