Skip to main content

Get AKS cluster estimated rate information

POST 

/v1/spectroclusters/aks/rate

Get AKS cluster estimated rate information

Request

Query Parameters

    periodType string

    Possible values: [hourly, monthly, yearly]

    Default value: hourly

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Body

    cloudConfig

    object

    Cluster level configuration for Azure cloud and applicable for all the machine pools

    aadProfile

    object

    AADProfile - AAD integration is managed by AKS.

    adminGroupObjectIDsstring[]required

    AdminGroupObjectIDs - AAD group object IDs that will have admin role of the cluster.

    managedbooleanrequired

    Managed - Whether to enable managed AAD.

    apiServerAccessProfile

    object

    APIServerAccessProfile - access profile for AKS API server.

    authorizedIPRangesstring[]

    AuthorizedIPRanges - Authorized IP Ranges to kubernetes API server.

    enablePrivateClusterboolean

    EnablePrivateCluster - Whether to create the cluster as a private cluster or not.

    enablePrivateClusterPublicFQDNboolean

    EnablePrivateClusterPublicFQDN - Whether to create additional public FQDN for private cluster or not.

    privateDNSZonestring

    PrivateDNSZone - Private dns zone mode for private cluster.

    containerNamestring

    controlPlaneSubnet

    object

    cidrBlockstring

    CidrBlock is the CIDR block to be used when the provider creates a managed Vnet.

    namestring
    securityGroupNamestring

    Network Security Group(NSG) to be attached to subnet. NSG for a control plane subnet, should allow inbound to port 6443, as port 6443 is used by kubeadm to bootstrap the control planes

    enablePrivateClusterboolean

    Deprecated. use apiServerAccessProfile.enablePrivateCluster

    infraLBConfig

    object

    apiServerLB

    object

    LoadBalancerSpec defines an Azure load balancer.

    apiServerLBStaticIPstring
    ipAllocationMethodstring

    Possible values: [Static, Dynamic]

    Default value: Dynamic

    privateDNSNamestring
    typestring

    Possible values: [Internal, Public]

    Default value: Public

    Load Balancer type

    locationstringrequired

    Location is the Azure datacenter location

    resourceGroupstring
    sshKeystringrequired
    storageAccountNamestring
    subscriptionIdstringrequired

    Subscription ID is unique identifier for the subscription used to access Azure services

    vnetCidrBlockstring
    vnetNamestring

    VNETName is the virtual network in which the cluster is to be provisioned.

    vnetResourceGroupstring

    workerSubnet

    object

    cidrBlockstring

    CidrBlock is the CIDR block to be used when the provider creates a managed Vnet.

    namestring
    securityGroupNamestring

    Network Security Group(NSG) to be attached to subnet. NSG for a control plane subnet, should allow inbound to port 6443, as port 6443 is used by kubeadm to bootstrap the control planes

    machinepoolconfig

    object[]

  • Array [

  • cloudConfig

    object

    required

    azsstring[]
    instanceTypestring

    Instance type stands for VMSize in Azure

    isSystemNodePoolboolean

    whether this pool is for system node Pool

    osDisk

    object

    diskSizeGBint32

    managedDisk

    object

    storageAccountTypestring
    osTypestring

    Possible values: [Linux, Windows]

    Default value: Linux

    managedPoolConfig

    object

    isSystemNodePoolboolean

    whether this pool is for system node Pool

    osTypestring

    Possible values: [Linux, Windows]

    Default value: Linux

    poolConfig

    object

    Machine pool configuration for the cluster

    additionalLabels

    object

    Additional labels to be part of the machine pool

    property name*string

    additionalTags

    object

    AdditionalTags is an optional set of tags to add to resources managed by the provider, in addition to the ones added by default. For eg., tags for EKS nodeGroup or EKS NodegroupIAMRole

    property name*string
    isControlPlaneboolean

    Whether this pool is for control plane

    labelsstring[]required

    Labels for this machine pool, example: master/worker, gpu, windows

    machinePoolProperties

    object

    Machine pool specific properties

    archTypestring

    Possible values: [amd64, arm64]

    Default value: amd64

    maxSizeint32

    Max size of the pool, for scaling

    minSizeint32

    Min size of the pool, for scaling

    namestringrequired
    nodeRepaveIntervalint32

    Minimum number of seconds a node should be Ready, before the next node is selected for repave. Applicable only for workerpools in infrastructure cluster

    sizeint32required

    Size of the pool, number of nodes/machines

    taints

    object[]

    Master or worker taints

  • Array [

  • effectstring

    Possible values: [NoSchedule, PreferNoSchedule, NoExecute]

    keystring

    The taint key to be applied to a node

    timeAddeddate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    valuestring

    The taint value corresponding to the taint key.

  • ]

  • updateStrategy

    object

    UpdatesStrategy will be used to translate to RollingUpdateStrategy of a MachineDeployment We'll start with default values for the translation, can expose more details later Following is details of parameters translated from the type ScaleOut => maxSurge=1, maxUnavailable=0 ScaleIn => maxSurge=0, maxUnavailable=1

    typestring

    Possible values: [RollingUpdateScaleOut, RollingUpdateScaleIn]

    update strategy, either ScaleOut or ScaleIn if empty, will default to RollingUpdateScaleOut

    useControlPlaneAsWorkerboolean

    If IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools

  • ]

Responses

Aks Cluster estimated rate response

Schema

    machinePools

    object[]

  • Array [

  • namestring
    nodesCountint32

    rate

    object

    Cloud estimated rate information

    compute

    object

    Compute estimated rate information

    ratefloat64
    typestring

    storage

    object[]

  • Array [

  • iopsfloat64
    ratefloat64
    sizeGBfloat64
    throughputfloat64
    typestring
  • ]

  • totalfloat64
  • ]

  • namestring

    rate

    object

    Cluster total estimated rate information

    computefloat64
    storagefloat64
    totalfloat64

    resourceMetadata

    object

    Cloud resource metadata

    instanceTypes

    object

    property name*

    object

    Cloud Instance type details

    categorystring

    Category of instance type

    cost

    object

    Instance cost entity

    price

    object[]

    Array of cloud instance price

  • Array [

  • onDemanddouble

    OnDemand price of instance

    osstring

    Possible values: [linux, windows]

    Os associated with instance price. Allowed values - [linux, windows]

    spotdouble

    Spot price of instance

  • ]

  • cpudouble

    Cpu of instance type

    gpudouble

    Gpu of instance type

    memorydouble

    Memory of instance type

    nonSupportedZonesstring[]

    Non supported zones of the instance in a particular region

    pricedouble

    Price of instance type

    supportedArchitecturesstring[]

    Supported architecture of the instance

    typestring

    Type of instance type

    storageTypes

    object

    property name*

    object

    Cloud cloud Storage type details

    cost

    object

    Cloud storage cost

    discountedUsagestring

    Cloud storage upper limit which is free.

    price

    object[]

    Array of cloud storage range prices

  • Array [

  • limitstring

    Upper limit of cloud storage usage

    pricestring

    Price of cloud storage type

  • ]

  • iopsCost

    object

    Cloud storage cost

    discountedUsagestring

    Cloud storage upper limit which is free.

    price

    object[]

    Array of cloud storage range prices

  • Array [

  • limitstring

    Upper limit of cloud storage usage

    pricestring

    Price of cloud storage type

  • ]

  • kindstring

    kind of storage type

    namestring

    Name of the storage type

    throughputCost

    object

    Cloud storage cost

    discountedUsagestring

    Cloud storage upper limit which is free.

    price

    object[]

    Array of cloud storage range prices

  • Array [

  • limitstring

    Upper limit of cloud storage usage

    pricestring

    Price of cloud storage type

  • ]

Loading...