Skip to main content

Get AWS cluster estimated rate information

POST 

/v1/spectroclusters/aws/rate

Get AWS 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 aws cloud and applicable for all the machine pools

    bastionDisabledboolean

    Create bastion node option we have earlier supported creation of bastion by default capa seems to favour session manager against bastion node https://github.com/kubernetes-sigs/cluster-api-provider-aws/issues/947

    controlPlaneLoadBalancerstring

    ControlPlaneLoadBalancer specifies how API server elb will be configured, this field is optional, not provided, "", default => "Internet-facing" "Internet-facing" => "Internet-facing" "internal" => "internal" For spectro saas setup we require to talk to the apiserver from our cluster so ControlPlaneLoadBalancer should be "", not provided or "Internet-facing"

    regionstringrequired
    sshKeyNamestring
    vpcIdstring

    VPC Id to deploy cluster into should have one public and one private subnet for the the cluster creation, this field is optional, If VPC Id is not provided a fully managed VPC will be created

    machinepoolconfig

    object[]

  • Array [

  • cloudConfig

    object

    required

    additionalSecurityGroups

    object[]

    Additional Security groups

  • Array [

  • arnstring

    ARN of resource

    filters

    object[]

    Filters is a set of key/value pairs used to identify a resource

  • Array [

  • namestring

    Name of the filter. Filter names are case-sensitive

    valuesstring[]

    Values includes one or more filter values. Filter values are case-sensitive

  • ]

  • idstring

    ID of resource

  • ]

  • azsstring[]
    capacityTypestring

    Possible values: [on-demand, spot]

    Default value: on-demand

    EC2 instance capacity type

    instanceTypestringrequired

    instance type

    rootDeviceSizeint64

    Possible values: >= 1 and <= 2000

    rootDeviceSize in GBs

    spotMarketOptions

    object

    SpotMarketOptions allows users to configure instances to be run using AWS Spot instances.

    maxPricestring

    MaxPrice defines the maximum price the user is willing to pay for Spot VM instances

    subnets

    undefined[]

  • Array [

  • azstring
    idstring
  • ]

  • 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: control-plane/worker, gpu, windows

    machinePoolProperties

    object

    Machine pool specific properties

    archTypestring

    Possible values: [amd64, arm64]

    Default value: amd64

    Architecture type of the pool. Default value is '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[]

    control plane 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

    Rolling update strategy for this machine pool if not specified, will use ScaleOut

    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 control plane taint this will not be used for worker pools

  • ]

Responses

Aws 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...