Get AWS cluster estimated rate information
POST/v1/spectroclusters/aws/rate
Get AWS cluster estimated rate information
Request
Query Parameters
Possible values: [hourly, monthly, yearly]
Default value: hourly
Header Parameters
Scope the request to the specified project uid
- application/json
Body
Array [
Array [
Array [
]
]
Array [
]
Array [
]
]
cloudConfig
object
Cluster level configuration for aws cloud and applicable for all the machine pools
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
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"
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[]
cloudConfig
object
required
additionalSecurityGroups
object[]
Additional Security groups
ARN of resource
filters
object[]
Filters is a set of key/value pairs used to identify a resource
Name of the filter. Filter names are case-sensitive
Values includes one or more filter values. Filter values are case-sensitive
ID of resource
Possible values: [on-demand, spot]
Default value: on-demand
EC2 instance capacity type
instance type
Possible values: >= 1 and <= 2000
rootDeviceSize in GBs
spotMarketOptions
object
SpotMarketOptions allows users to configure instances to be run using AWS Spot instances.
MaxPrice defines the maximum price the user is willing to pay for Spot VM instances
subnets
undefined[]
poolConfig
object
Machine pool configuration for the cluster
additionalLabels
object
Additional labels to be part of the machine pool
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
Whether this pool is for control plane
Labels for this machine pool, example: master/worker, gpu, windows
machinePoolProperties
object
Machine pool specific properties
Possible values: [amd64, arm64]
Default value: amd64
Architecture type of the pool. Default value is 'amd64'
Max size of the pool, for scaling
Min size of the pool, for scaling
Minimum number of seconds a node should be Ready, before the next node is selected for repave. Applicable only for workerpools in infrastructure cluster
Size of the pool, number of nodes/machines
taints
object[]
Master or worker taints
Possible values: [NoSchedule, PreferNoSchedule, NoExecute]
The taint key to be applied to a node
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.
The taint value corresponding to the taint key.
updateStrategy
object
Rolling update strategy for this machine pool if not specified, will use ScaleOut
Possible values: [RollingUpdateScaleOut, RollingUpdateScaleIn]
update strategy, either ScaleOut or ScaleIn if empty, will default to RollingUpdateScaleOut
If IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools
Responses
- 200
Aws Cluster estimated rate response
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
Array [
]
Array [
]
Array [
]
Array [
]
machinePools
object[]
rate
object
Cloud estimated rate information
compute
object
Compute estimated rate information
storage
object[]
rate
object
Cluster total estimated rate information
resourceMetadata
object
Cloud resource metadata
instanceTypes
object
property name*
object
Cloud Instance type details
Category of instance type
cost
object
Instance cost entity
price
object[]
Array of cloud instance price
OnDemand price of instance
Possible values: [linux, windows]
Os associated with instance price. Allowed values - [linux, windows]
Spot price of instance
Cpu of instance type
Gpu of instance type
Memory of instance type
Non supported zones of the instance in a particular region
Price of instance type
Supported architecture of the instance
Type of instance type
storageTypes
object
property name*
object
Cloud cloud Storage type details
cost
object
Cloud storage cost
Cloud storage upper limit which is free.
price
object[]
Array of cloud storage range prices
Upper limit of cloud storage usage
Price of cloud storage type
iopsCost
object
Cloud storage cost
Cloud storage upper limit which is free.
price
object[]
Array of cloud storage range prices
Upper limit of cloud storage usage
Price of cloud storage type
kind of storage type
Name of the storage type
throughputCost
object
Cloud storage cost
Cloud storage upper limit which is free.
price
object[]
Array of cloud storage range prices
Upper limit of cloud storage usage
Price of cloud storage type
{
"machinePools": [
{
"name": "string",
"nodesCount": 0,
"rate": {
"compute": {
"rate": 0,
"type": "string"
},
"storage": [
{
"iops": 0,
"rate": 0,
"sizeGB": 0,
"throughput": 0,
"type": "string"
}
],
"total": 0
}
}
],
"name": "string",
"rate": {
"compute": 0,
"storage": 0,
"total": 0
},
"resourceMetadata": {
"instanceTypes": {},
"storageTypes": {}
}
}