Skip to main content

Returns the estimated cost of the supplied cluster

POST 

/api/v2/costestimates/clusterv2

Returns the estimated cost of the supplied cluster

Request

Body

required

The specification for the V2 cluster you want estimating

    cloudAccessConfigRef

    CloudAccessConfigRef is a reference to the cloud access configuration to use when building the cluster

    namestringrequired
    workspacestring
    cloudResourceNamestring

    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

    namestringrequired
    workspacestring
    descriptionstring

    Description provides a short summary to the use of the cluster

    expiresstring

    Expires is the duration after which the cluster should automatically be removed.

    multitenancy

    Multitenancy allows a cluster to be used by other workspaces.

    allWorkspacesboolean
    allowedWorkspacesstring[]

    nodePools

    undefined[]

    NodePools is a list of node pools for this cluster

  • Array [

  • autoscaling

    Autoscaling indicates the node pool should auto-scale

    enabledboolean

    Enabled indicates the node pool to use autoscaling

    maxSizeint64

    MaxSize is the maximum number of nodes if autoscaling is enabled

    minSizeint64

    MinSize is minimum number of nodes if autoscaling is enabled

    cloudResourceNamestring

    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.

    diskSizeint64required

    DiskSize is the amount of disk space to assign to the nodes in MBs

    imagestringrequired

    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

    property name*string
    logicalNamestringrequired

    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

    machinestringrequired

    Machine is the instance type of the nodes in the pool

    maxPodsPerNodeint64

    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

    modestring

    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.

    sizeint64required

    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

    maxSpotPricestring

    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

    additionalInstanceTypesstring[]

    AdditionalInstanceTypes provides an additional list of instances to use when spot instances is enabled

    enabledboolean

    Enabled indicates the node pool should use spots

    taints

    undefined[]

    Taints defines a collection scheduling taints placed on the node pool

  • Array [

  • effectstring

    Effect is desired action on the taint

    keystring

    Key is a unique taint identifier

    valuestring

    Value is the value that must be matched for the taint to apply

  • ]

  • zonesstring[]

    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.

    followPublishedboolean
    namestringrequired
    versionstringrequired
    providerstringrequired

    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

    windowStartstring

    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

    defaultstring

    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

  • Array [

  • 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"

    property name*string

    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

  • Array [

  • max

    object

    Max usage constraints on this kind by resource name.

    property name*string

    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.

    property name*string
    typestringrequired

    Type of resource that this limit applies to.

  • ]

  • namestringrequired

    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)

  • Array [

  • default

    object

    Default resource requirement limit value by resource name if resource limit is omitted.

    property name*string

    defaultRequest

    object

    DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.

    property name*string
    typestringrequired

    Type of resource that this limit applies to.

  • ]

  • ]

  • regionstring

    Region is the region you want the cluster to reside

    stagestringrequired

    Stage is the name of the stage for this cluster

Responses

An estimate of the costs for the cluster

Schema

    costElements

    undefined[]

  • Array [

  • maxCostint64required
    minCostint64required
    namestring
    typicalCostint64required
  • ]

  • maxCostint64required
    minCostint64required
    preparedAtstring
    typicalCostint64required