Returns all the available node pool updates
GET/resources/compute.appvia.io/v2beta1/workspaces/:workspace/nodepoolupdates
Returns all the available node pool updates
Request
Path Parameters
Workspace to use
Query Parameters
List node pool updates owned by specified owner
Responses
- 200
- 401
- 403
- 500
A list of node pool updates
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
]
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
items
undefined[]
required
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
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: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
If this field is specified and the generated name exists, the server will return a 409.
Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
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: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
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 defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
Manager is an identifier of the workflow managing these fields.
Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.
Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
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.
API version of the referent.
If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
If true, this reference points to the managing controller.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
spec
NodePoolUpdateSpec defines a node pool update or replacement in kubernetes
newSpec
required
NodePool defines a node pool in kubernetes
autoscaling
Autoscaling indicates the node pool should autoscale
Enabled indicates the node pool to use autoscaling
MaxSize is the maximum number of nodes if autoscaling is enabled
MinSize is minimum number of nodes if autoscaling is enabled
Channel describes the channel a NodePool follows If specified on a cluster, must be identical to the channel on the cluster
CloudResourceName is the name of the cloud resource - should not be set by the client - set by the NodePool mutate if empty - set by the NodePoolUpdate controller depending on the update type
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 is how the cloud provider can update the node pool (if at all)
newReplacementConfig
NewReplacementConfig specifies how to create a new node pool and migrate workloads to it
NodeDrainTimeOut is the delay to wait for a node to drain before force deleting it After this delay and then the node will be force deleted
ReplacementStrategy is how node pools can get replaced when required
Description provides an optional description to the node pool
DiskSize is the amount of disk space to assign to the nodes in MBs
Expires provides a time for automatic expiration of the cluster
Image is the image we should use on the instances of this pool
labels
object
Labels is a collection of label placed on to the nodepool
LogicalName is the internally unique name of the NodePool (not in cloud) - Should always be consistent with a single name entry in a Cluster or NodePoolUpdate - Has to be unique across all nodepools on the Cluster spec - Will NOT always match the name of the NodePool in cloud - Should be treated as an immutable field
Machine is the instance type of the nodes in the poll
MaxPodsPerNode controls how many pods can be scheduled onto each node in this pool
providerDetails
ProviderDetails provides any cloud specific options for this nodepool
aks
AKS defines the cloud specific options for AKS clusters
Mode is the type of the node pool. System node pools serve the primary purpose of hosting critical system pods such as CoreDNS and tunnelfront. User node pools serve the primary purpose of hosting your application pods.
eks
EKS defines a cloud specific options for EKS clusters
AMI is a custom image we should use for this nodepool
EC2SSHKey is the Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html
SSHSourceSecurityGroups is the security groups that are allowed SSH access (port 22) to the worker nodes
UserData for the launch configuration
gke
GKE is the provider specification for their clusters
EnableAutorepair indicates if the node pool should automatically repair failed nodes
EnableAutoUpgrade indicates if the node group should be configured with auto-upgrading enabled. This must be true if the cluster has ReleaseChannel set.
Unmanaged provides the specification for unmanaged cluster
Size is initial size if autoscaling defined - or the effective size if no autoscaling is enabled
spot
Spot if defines enables nodepool to use spot instances
aks
AKS defines the options for AKS spot instances
MaxSpotPrice is the maximum price willing to pay for an spot instance billed in microdollars. The figure is optional and needless to say only relevant when the nodepool is made of spot instances
eks
EKS provides additional options for EKS
AdditionalInstanceTypes provides an additional list of instances to use when spot instances is enabled
Enabled indicates the node pool should use spots
taints
undefined[]
Taints defines a collection scheduling taints placed on the nodepool
Effect is desired action on the taint
Key provides the key definition for this tainer
Value is arbitrary value for this taint to compare
Version is the specified version of kubernetes on the node pool This cannot be set by a client if a channel is also specified Will be set by the NodePoolUpdate controller on actual nodepools if a channel is specified
Zones defines a list of cloud specific availability zones where the nodes are permitted to run
nextSteps
owner
required
NodePoolToUpdate is the reference to the NodePool metadata.Name to be updated / replaced
options
required
Options are the options for the update or replacement strategy
CloudUpdateStrategy is how the cloud provider can update the node pool (if at all)
newReplacementConfig
NewReplacementConfig specifies how to create a new node pool and migrate workloads to it
NodeDrainTimeOut is the delay to wait for a node to drain before force deleting it After this delay and then the node will be force deleted
ReplacementStrategy is how node pools can get replaced when required
preRequisite
owner
required
TargetKubernetesVersion is the specific Kubernetes version to use for the new node pool spec - Only valid when a channel is also specified - Normally be an increment of the current, existing NodePool version - Not be greater than the cluster version
status
NodePoolUpdateStatus defines the observed state of NodePoolUpdate
conditions
undefined[]
EstimatedPercentageComplete is the estimated percentage complete of the node pool update This will vary per provider and update strategy and cluster usage
lastReconcile
lastSuccess
obsoleteResources
undefined[]
originalNodePool
OriginalNodePool is the status of the node pool being updated / replaced
AutoscalingDisabled is true if the autoscaling has been disabled
Cordoned indicates if the NodePool has been cordoned yet
Deleted indicates if the old node pool has been deleted
DrainStartTime is the time the node pool started draining
Migrated indicates if the Workloads have been migrated to the new node pool
MigratedNodes is the number of old nodes migrated to the new node pool
nodes
object
Nodes provide the information about the nodes to migrate stored by name
originalAutoScalingOptions
OriginalAutoScalingOptions are the auto scaling options for the node pool before we started migrating
Enabled indicates the node pool to use autoscaling
MaxSize is the maximum number of nodes if autoscaling is enabled
MinSize is minimum number of nodes if autoscaling is enabled
Size is the size of the old NodePool
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
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 may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.
remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.
String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
{
"apiVersion": "string",
"items": [
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"annotations": {},
"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": {
"awaitingApproval": true,
"newSpec": {
"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"
]
},
"nextSteps": {
"owner": {
"group": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"version": "string"
}
},
"nodePoolToUpdate": "string",
"options": {
"cloudUpdateStrategy": "string",
"newReplacementConfig": {
"nodeDrainTimeOut": "string"
},
"replacementStrategy": "string"
},
"preRequisite": {
"owner": {
"group": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"version": "string"
}
},
"targetKubernetesVersion": "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",
"estimatedPercentageComplete": 0,
"lastReconcile": {
"generation": 0,
"time": "string"
},
"lastSuccess": {
"generation": 0,
"time": "string"
},
"message": "string",
"obsoleteResources": [
{
"kind": "string",
"name": "string"
}
],
"originalNodePool": {
"autoscalingDisabled": true,
"cordoned": true,
"deleted": true,
"drainStartTime": "string",
"migrated": true,
"migratedNodes": 0,
"nodes": {},
"originalAutoScalingOptions": {
"enabled": true,
"maxSize": 0,
"minSize": 0
},
"size": 0
},
"status": "string",
"wayfinderVersion": "string"
}
}
],
"kind": "string",
"metadata": {
"continue": "string",
"remainingItemCount": 0,
"resourceVersion": "string",
"selfLink": "string"
}
}
If not authenticated
If authenticated but not authorized
A generic API error containing the cause of the error
- application/json
- Schema
- Example (from schema)
Schema
{
"code": 0,
"detail": "string",
"message": "string",
"uri": "string",
"verb": "string"
}