Creates a new cluster
POST/resources/compute.appvia.io/v2beta2/workspaces/:workspace/clusters
Creates a new cluster
Request
Path Parameters
Workspace to use
Query Parameters
Set to 'All' to perform a server-side dry run of creating this resource
Set an explicit owner for this resource
- application/json
Body
required
The specification for the cluster you are creating
Array [
]
Array [
]
Array [
Array [
]
]
Array [
Array [
]
Array [
]
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
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
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
ClusterSpec defines the desired state of a cluster
cloudAccessConfigRef
CloudAccessConfigRef is a reference to the cloud access configuration to use when building the cluster
CloudResourceName specifies the name of the cluster in the cloud Can be left blank so that the name is derived from the wayfinder workspace and resource name
clusterNetworkRef
ClusterNetworkRef is a reference to the network where the cluster should reside Other networking fields are provided indirectly by the cluster plan
Description provides a short summary to the use of the cluster
Expires is the duration after which the cluster should automatically be removed.
multitenancy
Multitenancy allows a cluster to be used by other workspaces.
nodePools
undefined[]
NodePools is a list of node pools for this cluster
autoscaling
Autoscaling indicates the node pool should auto-scale
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
CloudResourceName is the name of the node pool in the cloud provider. If unpopulated, a sensible default name will be auto-generated for this node pool.
DiskSize is the amount of disk space to assign to the nodes in MBs
Image is the image we should use on the instances of this pool
labels
object
Labels to be placed onto the node pool nodes to enable workloads to target this node pool selectively
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 node pools 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 pool
MaxPodsPerNode controls how many pods can be scheduled onto each node in this pool
providerDetails
ProviderDetails provides any cloud specific options for this node pool
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.
Size is initial size if autoscaling defined - or the effective size if no autoscaling is enabled
spot
Spot, if defined, enables the node pool 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 node pool
Effect is desired action on the taint
Key is a unique taint identifier
Value is the value that must be matched for the taint to apply
Zones defines a list of cloud specific availability zones where the nodes are permitted to run
planRef
PlanRef is a reference to the cluster plan values used to provision this cluster.
Provider refers to the cluster type (e.g. AKS, GKE, EKS)
providerDetails
ProviderDetails are the workload affecting, provider specific details for the cluster Note that this is NOT the same as the cluster provider settings provided by the cluster plan.
gke
maintenance
Maintenance provides the details for when a cluster can be maintained by GKE
WindowStart is the time we can perform updates and upgrades, represented in 24h format e.g. "15:00"
quotaLimits
QuotaLimits provide defaults for quotas and limits which are important for multi-tenancy
Default specifies the default template name to use e.g. "Small" A specific template can be specified with labels on NamespaceClaim objects Required if a cluster is allocated for any tenant workspaces
templates
undefined[]
Templates provide initial defaults for Quotas and Limits for allocated namespaces used when a cluster is allocated to other workspaces to control ResourceQuotas and LimitRanges These values will result in a one time creation of: - a new cluster workspace QuotaLimit object for "constraints" per workspace (with a namespace claim) - a tenant workspace QuotaLimit object for namespace defaults per workspace Required if a cluster is allocated for any tenant workspaces
constraints
Constraints are for providing management of resource constraints to workloads - Typically only managed by cluster owners to provide hard resource constraints - Used to prevent noisy neighbor issues in a multi-tenanted environment
hardQuota
object
QuotaHard are applied as ResourceQuota objects to all namespaces for a tenant of that type There are the maximum resource usage in total for a namespace e.g.: hardQuota: requests.cpu: "1" requests.memory: "1Gi" limit.cpu: "2"
limitRanges
undefined[]
required
LimitRanges (in the context of constraints) are applied as LimitRanges (using Max) These are the largest values that can be used by a single resource in a namespace They will prevent workloads from using up all resources on a single node
max
object
Max usage constraints on this kind by resource name.
maxLimitRequestRatio
object
MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource.
Type of resource that this limit applies to.
Name is the immutable name to track the template that was used Would normally specify a QuotaLimit "size" for a tenant
resourceDefaults
undefined[]
ResourceDefaults provide defaults for workloads (to prevent initial constraint violations) Not set directly or managed by owners (as only maximum values taken so should not conflict)
default
object
Default resource requirement limit value by resource name if resource limit is omitted.
defaultRequest
object
DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.
Type of resource that this limit applies to.
Region is the region you want the cluster to reside
Stage is the name of the stage for this cluster
status
ClusterStatus defines the observed state of a cluster
CaCertificate is the base64 encoded cluster certificate
clusterNetwork
ClusterNetwork contains the network configuration used by this cluster
aws
AWS contains the AWS-specific state for the network
AccoundID is the aws account id
AvailabilityZoneIDs is the list of AZ ids
AvailabilityZoneIDs is the list of AZ names
PublicIPV4EgressAddresses provides the source addresses for traffic coming from the cluster
PrivateIPV4Addresses provides the list of private subnet addresses
PrivateSubnetIDs is a list of subnet IDs to use for the worker nodes
PublicIPV4Addresses provides the list of public subnet addresses
PublicSubnetIDs is a list of subnet IDs to use for resources that need a public IP (e.g. load balancers)
SecurityGroupIDs is a list of security group IDs to use for a cluster
VpcID is the identifier of the VPC
azure
Azure contains the Azure-specific state for the network
SubnetIDs are the list of subnet IDs in the Virtual Network
VirtualNetworkID is the identifier of the Virtual Network
conditions
undefined[]
gcp
GCP contains the GCP-specific state for the network
gateways
undefined[]
Gateways provides a status on the gateways and any external addresses
Addresses is the external IP or self links references associated to the gateway
Location is location of where it resides
Name is name of the gateway
Name is the name of the network in GCP
NetworkRef is the cloud provider reference
lastReconcile
lastSuccess
obsoleteResources
undefined[]
ownedResources
cloudResources
undefined[]
wayfinderResources
undefined[]
pendingSince
conditions
undefined[]
deployedResourceHashes
undefined[]
DeployedResourceHashes is set to a hash of the resources deployed into the cluster so we can re-apply if the resources change but quickly no-op if they have not.
Errors from pods or events related to failed deployments
Hash is the computed hash of the resources last applied
LastApplied is the last time the resource was applied
Name is the name of the resource
DNSZones is a list of Wayfinder-managed DNS zones which are currently available in this cluster with ExternalDNS. This will be populated if the DNSReady condition is true.
Expires is the timestamp after which the cluster should automatically be removed. The populated value should be time at which the cluster is created, plus duration defined in Spec.Expires
KubeAPIEndpoint is the kubernetes API endpoint url
KubeProxyEndpoint is the endpoint of the kube proxy for this cluster
lastReconcile
LastReconciledPlanVersion is the version of the plan that was last used for reconciliation
lastSuccess
LastSuccessfulPlanVersion is the version of the plan that was last used for a reconciliation that completed successfully
metrics
Metrics is a list of metrics for this cluster
LastChecked identifies when the metrics of the cluster was last checked.
metrics
undefined[]
Metrics are the metrics of the cluster
CPU is the CPU usage
Memory is the memory usage
Name is the name of the metric
Pods is the number of pods
obsoleteResources
undefined[]
ownedResources
cloudResources
undefined[]
wayfinderResources
undefined[]
pendingSince
providerStatus
ProviderStatus is provider specific data with types
aks
AKS is the provider status for Azure
ClusterPrincipalID is the cluster principal in Azure This is required for assigning permission to the AKS cluster in Azure
InfraResourceGroupName is the resource group that AKS manages
ResourceGroupName is the resource group that this cluster is in
eks
EKS is the provider status for AWS
encryption
Encryption shows the status of the EKS secrets encryption for this cluster
KMSKeyAlias is the alias of the KMS key in use for EKS encryption
KMSKeyID is the ARN of the KMS key in use for EKS encryption
KMSKeyStatus describes the provisioning state of the KMS key used for EKS encryption
Ready indicates that secrets encryption has been enabled and is healthy
OIDC is the url for the OIDC endpoint
KubernetesVersion is the kubernetes version of the cluster
Responses
- 200
- 400
- 401
- 403
- 500
Contains the cluster definition
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Array [
Array [
]
]
Array [
Array [
]
Array [
]
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
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
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
ClusterSpec defines the desired state of a cluster
cloudAccessConfigRef
CloudAccessConfigRef is a reference to the cloud access configuration to use when building the cluster
CloudResourceName specifies the name of the cluster in the cloud Can be left blank so that the name is derived from the wayfinder workspace and resource name
clusterNetworkRef
ClusterNetworkRef is a reference to the network where the cluster should reside Other networking fields are provided indirectly by the cluster plan
Description provides a short summary to the use of the cluster
Expires is the duration after which the cluster should automatically be removed.
multitenancy
Multitenancy allows a cluster to be used by other workspaces.
nodePools
undefined[]
NodePools is a list of node pools for this cluster
autoscaling
Autoscaling indicates the node pool should auto-scale
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
CloudResourceName is the name of the node pool in the cloud provider. If unpopulated, a sensible default name will be auto-generated for this node pool.
DiskSize is the amount of disk space to assign to the nodes in MBs
Image is the image we should use on the instances of this pool
labels
object
Labels to be placed onto the node pool nodes to enable workloads to target this node pool selectively
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 node pools 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 pool
MaxPodsPerNode controls how many pods can be scheduled onto each node in this pool
providerDetails
ProviderDetails provides any cloud specific options for this node pool
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.
Size is initial size if autoscaling defined - or the effective size if no autoscaling is enabled
spot
Spot, if defined, enables the node pool 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 node pool
Effect is desired action on the taint
Key is a unique taint identifier
Value is the value that must be matched for the taint to apply
Zones defines a list of cloud specific availability zones where the nodes are permitted to run
planRef
PlanRef is a reference to the cluster plan values used to provision this cluster.
Provider refers to the cluster type (e.g. AKS, GKE, EKS)
providerDetails
ProviderDetails are the workload affecting, provider specific details for the cluster Note that this is NOT the same as the cluster provider settings provided by the cluster plan.
gke
maintenance
Maintenance provides the details for when a cluster can be maintained by GKE
WindowStart is the time we can perform updates and upgrades, represented in 24h format e.g. "15:00"
quotaLimits
QuotaLimits provide defaults for quotas and limits which are important for multi-tenancy
Default specifies the default template name to use e.g. "Small" A specific template can be specified with labels on NamespaceClaim objects Required if a cluster is allocated for any tenant workspaces
templates
undefined[]
Templates provide initial defaults for Quotas and Limits for allocated namespaces used when a cluster is allocated to other workspaces to control ResourceQuotas and LimitRanges These values will result in a one time creation of: - a new cluster workspace QuotaLimit object for "constraints" per workspace (with a namespace claim) - a tenant workspace QuotaLimit object for namespace defaults per workspace Required if a cluster is allocated for any tenant workspaces
constraints
Constraints are for providing management of resource constraints to workloads - Typically only managed by cluster owners to provide hard resource constraints - Used to prevent noisy neighbor issues in a multi-tenanted environment
hardQuota
object
QuotaHard are applied as ResourceQuota objects to all namespaces for a tenant of that type There are the maximum resource usage in total for a namespace e.g.: hardQuota: requests.cpu: "1" requests.memory: "1Gi" limit.cpu: "2"
limitRanges
undefined[]
required
LimitRanges (in the context of constraints) are applied as LimitRanges (using Max) These are the largest values that can be used by a single resource in a namespace They will prevent workloads from using up all resources on a single node
max
object
Max usage constraints on this kind by resource name.
maxLimitRequestRatio
object
MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource.
Type of resource that this limit applies to.
Name is the immutable name to track the template that was used Would normally specify a QuotaLimit "size" for a tenant
resourceDefaults
undefined[]
ResourceDefaults provide defaults for workloads (to prevent initial constraint violations) Not set directly or managed by owners (as only maximum values taken so should not conflict)
default
object
Default resource requirement limit value by resource name if resource limit is omitted.
defaultRequest
object
DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.
Type of resource that this limit applies to.
Region is the region you want the cluster to reside
Stage is the name of the stage for this cluster
status
ClusterStatus defines the observed state of a cluster
CaCertificate is the base64 encoded cluster certificate
clusterNetwork
ClusterNetwork contains the network configuration used by this cluster
aws
AWS contains the AWS-specific state for the network
AccoundID is the aws account id
AvailabilityZoneIDs is the list of AZ ids
AvailabilityZoneIDs is the list of AZ names
PublicIPV4EgressAddresses provides the source addresses for traffic coming from the cluster
PrivateIPV4Addresses provides the list of private subnet addresses
PrivateSubnetIDs is a list of subnet IDs to use for the worker nodes
PublicIPV4Addresses provides the list of public subnet addresses
PublicSubnetIDs is a list of subnet IDs to use for resources that need a public IP (e.g. load balancers)
SecurityGroupIDs is a list of security group IDs to use for a cluster
VpcID is the identifier of the VPC
azure
Azure contains the Azure-specific state for the network
SubnetIDs are the list of subnet IDs in the Virtual Network
VirtualNetworkID is the identifier of the Virtual Network
conditions
undefined[]
gcp
GCP contains the GCP-specific state for the network
gateways
undefined[]
Gateways provides a status on the gateways and any external addresses
Addresses is the external IP or self links references associated to the gateway
Location is location of where it resides
Name is name of the gateway
Name is the name of the network in GCP
NetworkRef is the cloud provider reference
lastReconcile
lastSuccess
obsoleteResources
undefined[]
ownedResources
cloudResources
undefined[]
wayfinderResources
undefined[]
pendingSince
conditions
undefined[]
deployedResourceHashes
undefined[]
DeployedResourceHashes is set to a hash of the resources deployed into the cluster so we can re-apply if the resources change but quickly no-op if they have not.
Errors from pods or events related to failed deployments
Hash is the computed hash of the resources last applied
LastApplied is the last time the resource was applied
Name is the name of the resource
DNSZones is a list of Wayfinder-managed DNS zones which are currently available in this cluster with ExternalDNS. This will be populated if the DNSReady condition is true.
Expires is the timestamp after which the cluster should automatically be removed. The populated value should be time at which the cluster is created, plus duration defined in Spec.Expires
KubeAPIEndpoint is the kubernetes API endpoint url
KubeProxyEndpoint is the endpoint of the kube proxy for this cluster
lastReconcile
LastReconciledPlanVersion is the version of the plan that was last used for reconciliation
lastSuccess
LastSuccessfulPlanVersion is the version of the plan that was last used for a reconciliation that completed successfully
metrics
Metrics is a list of metrics for this cluster
LastChecked identifies when the metrics of the cluster was last checked.
metrics
undefined[]
Metrics are the metrics of the cluster
CPU is the CPU usage
Memory is the memory usage
Name is the name of the metric
Pods is the number of pods
obsoleteResources
undefined[]
ownedResources
cloudResources
undefined[]
wayfinderResources
undefined[]
pendingSince
providerStatus
ProviderStatus is provider specific data with types
aks
AKS is the provider status for Azure
ClusterPrincipalID is the cluster principal in Azure This is required for assigning permission to the AKS cluster in Azure
InfraResourceGroupName is the resource group that AKS manages
ResourceGroupName is the resource group that this cluster is in
eks
EKS is the provider status for AWS
encryption
Encryption shows the status of the EKS secrets encryption for this cluster
KMSKeyAlias is the alias of the KMS key in use for EKS encryption
KMSKeyID is the ARN of the KMS key in use for EKS encryption
KMSKeyStatus describes the provisioning state of the KMS key used for EKS encryption
Ready indicates that secrets encryption has been enabled and is healthy
OIDC is the url for the OIDC endpoint
KubernetesVersion is the kubernetes version of the cluster
{
"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": {
"cloudAccessConfigRef": {
"name": "string",
"workspace": "string"
},
"cloudResourceName": "string",
"clusterNetworkRef": {
"name": "string",
"workspace": "string"
},
"description": "string",
"expires": "string",
"multitenancy": {
"allWorkspaces": true,
"allowedWorkspaces": [
"string"
]
},
"nodePools": [
{
"autoscaling": {
"enabled": true,
"maxSize": 0,
"minSize": 0
},
"cloudResourceName": "string",
"diskSize": 0,
"image": "string",
"labels": {},
"logicalName": "string",
"machine": "string",
"maxPodsPerNode": 0,
"providerDetails": {
"aks": {
"mode": "string"
}
},
"size": 0,
"spot": {
"aks": {
"maxSpotPrice": "string"
},
"eks": {
"additionalInstanceTypes": [
"string"
]
},
"enabled": true
},
"taints": [
{
"effect": "string",
"key": "string",
"value": "string"
}
],
"zones": [
"string"
]
}
],
"planRef": {
"followPublished": true,
"name": "string",
"version": "string"
},
"provider": "string",
"providerDetails": {
"gke": {
"maintenance": {
"windowStart": "string"
}
}
},
"quotaLimits": {
"default": "string",
"templates": [
{
"constraints": {
"hardQuota": {},
"limitRanges": [
{
"max": {},
"maxLimitRequestRatio": {},
"type": "string"
}
]
},
"name": "string",
"resourceDefaults": [
{
"default": {},
"defaultRequest": {},
"type": "string"
}
]
}
]
},
"region": "string",
"stage": "string"
},
"status": {
"caCertificate": "string",
"cloudResourcesCreated": true,
"clusterNetwork": {
"aws": {
"accountID": "string",
"availabilityZoneIDs": [
"string"
],
"availabilityZoneNames": [
"string"
],
"ipv4EgressAddresses": [
"string"
],
"privateIPV4Addresses": [
"string"
],
"privateSubnetIDs": [
"string"
],
"publicIPV4Addresses": [
"string"
],
"publicSubnetIDs": [
"string"
],
"securityGroupIDs": [
"string"
],
"vpcID": "string"
},
"azure": {
"subnetIDs": [
"string"
],
"virtualNetworkID": "string"
},
"cloudResourcesCreated": true,
"conditions": [
{
"detail": "string",
"lastTransitionTime": "string",
"message": "string",
"name": "string",
"negativePolarity": true,
"observedGeneration": 0,
"reason": "string",
"status": "string",
"type": "string"
}
],
"detail": "string",
"gcp": {
"gateways": [
{
"addresses": [
"string"
],
"location": "string",
"name": "string"
}
],
"name": "string",
"networkRef": "string"
},
"lastReconcile": {
"generation": 0,
"time": "string"
},
"lastSuccess": {
"generation": 0,
"time": "string"
},
"message": "string",
"obsoleteResources": [
{
"kind": "string",
"name": "string"
}
],
"ownedResources": {
"cloudResources": [
{
"cloud": "string",
"id": "string",
"name": "string",
"type": "string"
}
],
"wayfinderResources": [
{
"kind": "string",
"name": "string",
"workspace": "string"
}
]
},
"pendingSince": {
"generation": 0,
"time": "string"
},
"status": "string",
"wayfinderVersion": "string"
},
"conditions": [
{
"detail": "string",
"lastTransitionTime": "string",
"message": "string",
"name": "string",
"negativePolarity": true,
"observedGeneration": 0,
"reason": "string",
"status": "string",
"type": "string"
}
],
"deployedResourceHashes": [
{
"errors": [
"string"
],
"hash": "string",
"lastApplied": "string",
"name": "string"
}
],
"detail": "string",
"dnsZones": [
"string"
],
"expires": "string",
"kubeApiEndpoint": "string",
"kubeProxyEndpoint": "string",
"lastReconcile": {
"generation": 0,
"time": "string"
},
"lastReconciledPlanVersion": "string",
"lastSuccess": {
"generation": 0,
"time": "string"
},
"lastSuccessfulPlanVersion": "string",
"message": "string",
"metrics": {
"lastChecked": "string",
"metrics": [
{
"cpu": "string",
"memory": "string",
"name": "string",
"pods": "string"
}
]
},
"obsoleteResources": [
{
"kind": "string",
"name": "string"
}
],
"ownedResources": {
"cloudResources": [
{
"cloud": "string",
"id": "string",
"name": "string",
"type": "string"
}
],
"wayfinderResources": [
{
"kind": "string",
"name": "string",
"workspace": "string"
}
]
},
"pendingSince": {
"generation": 0,
"time": "string"
},
"providerStatus": {
"aks": {
"clusterPrincipalID": "string",
"infraResourceGroupName": "string",
"resourceGroupName": "string"
},
"eks": {
"encryption": {
"kmsKeyAlias": "string",
"kmsKeyID": "string",
"kmsKeyStatus": "string",
"ready": true
},
"oidc": "string"
}
},
"status": "string",
"version": "string",
"wayfinderVersion": "string"
}
}
Validation error of supplied parameters/body
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
fieldErrors
undefined[]
required
{
"code": 0,
"fieldErrors": [
{
"errCode": "string",
"field": "string",
"message": "string"
}
],
"message": "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"
}