Returns the estimated cost of the supplied cluster plan
POST/api/v2/costestimates/cluster
Returns the estimated cost of the supplied cluster plan
Request
- application/json
Body
required
The specification for the plan you want estimating
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
ClusterPlanSpec defines the desired state of Plan
allocation
labels
object
policies
undefined[]
Summary provides a short title summary for the cluster plan It should describe a cluster in terms that are meaningful for developers: e.g. a cluster with very large nodes suitable for memory intensive applications
template
required
Template are the key+value pairs describing a cluster configuration
Channel describes the channel a cluster follows. On create, you must populate either channel or version, but not both.
clusterLabels
object
ClusterLabels provide a set of labels which will be set on any cluster built from this plan
Description provides a short summary to the use of the cluster
EnableAutoUpgrade indicates wayfinder should handle any upgrades for the clusters
EnablePrivateCluster indicates the cluster should be made private
Expires provides the duration (TTL) before automatic expiration of the cluster
maintenance
Maintenance provides the details around the maintenance window
WindowStart is the time we can perform updates and upgrades, represented in 24h format e.g. "15:00"
networking
Networking provides the details around the cluster networking options
AKSServicesNetwork is the CIDR to use as a service network on an Azure AKS cluster. This is not a routable 'real' network on Azure, but the value specified must not overlap with any IP ranges which may be routable in the network in which the cluster is created. It is valid for this range to be the same on multiple AKS clusters.
This will become required for AKS clusters in a future release.
authorizedMasterNetworks
undefined[]
AuthorizedMasterNetworks is a collection of authorized networks which is permitted to speak to the cloud kubernetes API, default to all if not provided.
CIDR is the network range associated to this network
Name provides a descriptive name for this network
authorizedNetworks
undefined[]
AuthorizedNetworks is a collection of authorized networks which is permitted to speak to our authentication proxy
CIDR is the network range associated to this network
Name provides a descriptive name for this network
NetworkPlan defines the network plan for the cluster If the network plan is not provided, a networkRef must be provided instead Required on cluster plans
NetworkProvider defines a network cni provider for the cluster
networkRef
NetworkRef is reference to a network where the cluster should reside
nodePools
undefined[]
NodePools is a collection of node pools associated to the cluster
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
Provider refers to the cluster type (e.g. AKS, GKE, EKS)
providerDetails
ProviderDetails defines cloud specific cluster options
aks
AKS defines the cloud specific options for AKS clusters
CreateUserAssignedIdentity will generate a new MSI for the cluster and grant it Contributor access to the cluster's resource group.
FEATURE STATUS: ALPHA This property is not yet fully tested/supported and may change or be removed.
InfraResourceGroupOverride will specify a resource group to use for nodes useful when we want to reclaim a cluster
linuxProfile
LinuxProfile is the configuration for Linux VMs
AdminUsername is the admin username for Linux VMs
SSHPublicKeys is a list of public SSH keys to allow to connect to the Linux VMs
NodeOSUpgradeChannel is the strategy for node level OS security updates
OutboundType defines the outbound connectivity for the cluster. N.B. only the values "loadBalancer" (default) and "userDefinedRouting" are supported
PrivatelinkDNSZoneVNetLinks are full Azure resource IDs of vNets to link the Azure-created privatelink DNS zone to.
This is only applicable when spec.enablePrivateCluster is true, and is ONLY required if you have configured custom DNS resolvers in your cluster network plan (spec.providerDetails.azure.dnsResolverIPAddresses).
When using custom DNS resolvers this MUST be set to a vNet where those resolvers can resolve the DNS. Without this, the cluster will not build successfully.
ResourceGroupOverride will specify a resource group when required
SKUTier is the Uptime SLA that should be used for the AKS cluster. "Free" or "Paid"
windowsProfile
WindowsProfile is the configuration for Windows VMs
AdminPassword is the admin password for Windows VMs
AdminUsername is the admin username for Windows VMs
eks
EKS defines a cloud specific options for EKS clusters
AdminARNs is the list of roles or users to be granted access to the EKS K8s API
cloudWatchLogging
CloudWatchLogging allows all control plane logging to be enabled
API will enable logging for the Kubernetes API server
Audit will enable logging for the Kubernetes audit
Authenticator will enable logging for the Kubernetes authentication
ControllerManager will enable logging for the Kubernetes controller manager
Scheduler will enable logging for the Kubernetes scheduler component
EnableEndpointPrivate indicates the EKS endpoint should be private and non-public facing
encryption
Encryption controls the encryption configuration of the cluster. ALPHA: This feature is under development
SecretsEncryptionEnabled will enable EKS secrets encryption. This will generate a new KMS key for the cluster and configure the cluster to use that KMS key for envelope encryption of secrets. ALPHA: This feature is under development
SecurityGroupIds is a list of security group IDs
gke
GKE is the provider specification for their clusters
EnableHTTPLoadBalancer indicates if the cluster should be configured with the GKE ingress controller. When enabled GKE will autodiscover your ingress resources and provision load balancer on your behalf.
The Horizontal Pod Autoscaler changes the shape of your Kubernetes workload by automatically increasing or decreasing the number of Pods in response to the workload's CPU or memory consumption, or in response to custom metrics reported from within Kubernetes or external metrics from sources outside of your cluster.
EnableShieldedNodes indicates we should enable the shielded nodes options in GKE. This protects against a variety of attacks by hardening the underlying GKE node against rootkits and bootkits.
EnableStackDriverLogging indicates if Stackdriver logging should be enabled for the cluster
EnableStackDriverMetrics indicates if Stackdriver metrics should be enabled for the cluster
MasterIPV4Cidr is network range used when private networking is enabled. This is the peering subnet used to to GKE master api layer. Note, this must be unique within the network.
Unmanaged provides the specification for unmanagement cluster
quotaLimits
QuotaLimits provide defaults for quotas and limits which are critical 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 neigbor 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 maximun 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.
TemplateName is the immutable name to track the tempate 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
security
Security contains security settings for the cluster
podSecurityStandard
PodSecurityStandard indicates we want to use the pod security standard
AllowedProfiles is a list of profiles that are allowed to be used in the cluster
DefaultProfile is the default profile to use for the cluster wayfinder managed namespaces
Enabled indicates the addons is enabled
Version is the kubernetes version to use. On create, you must populate either Channel or Version, but not both.
status
ClusterPlanStatus defines the observed state of Plan
clusterNetwork
ClusterNetwork describes the network that will be created from this plan
exampleNetwork
ExampleNetwork describes a cluster network that will be created from this plan
awsVPC
AWSVPC describes the next AWS VPC that would be created from this plan
CIDR is the cidr range in the A.B.C.D/N format
subnets
undefined[]
Subnets are the list of subnets that would be used by EKS
AvailabilityZone is an AWS availability zone. - In an example it is just a number but in reality it will be the actual ID
CIDR is the cidr range in the A.B.C.D/N format
NATGateway indicates whether a NAT gateway would be created for this subnet
Type is what the cidr block is used for
azureVirtualNetwork
AzureVirtualNetwork describes the next Azure Virtual Network that would be created from this plan
CIDR is the cidr range in the A.B.C.D/N format
subnets
undefined[]
Subnets are the list of subnets that would be used by AKS Only one subnet specified: - one of type azureSubnetNode, created as an Azure subnet and used by the nodes
CIDR is the cidr range in the A.B.C.D/N format
Type is what the cidr block is used for
gcpVPC
GCPVPC describes the next GCP VPC that would be created from this plan
CIDR is the cidr range in the A.B.C.D/N format
subnets
undefined[]
Subnets are the list of subnets that would be used by GKE Only two subnets are specified: - one of type gcpSubnetSecondaryService, created as a GCP secondary subnet in the GCP VPC - one of type gcpSubnetSecondaryPod, created as a GCP secondary subnet in the GCP VPC
CIDR is the cidr range in the A.B.C.D/N format
Type is what the cidr block is used for
networkCapacity
undefined[]
NetworkCapacity describes the capacity to build a network from this plan
Details will contain details about the capacity if there is no capacity, will include details about why
HasCapacity is true if there is capacity
Stage is the stage where there is capacity
conditions
undefined[]
lastReconcile
lastSuccess
obsoleteResources
undefined[]
Responses
- 200
- 400
- 401
- 403
- 500
An estimate of the costs for the cluster plan
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
costElements
undefined[]
{
"costElements": [
{
"maxCost": 0,
"minCost": 0,
"name": "string",
"typicalCost": 0
}
],
"maxCost": 0,
"minCost": 0,
"preparedAt": "string",
"typicalCost": 0
}
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"
}