Creates an AWS cluster
POST/v1/spectroclusters/aws
Creates an AWS cluster
Request
Header Parameters
Scope the request to the specified project uid
- application/json
Body
Array [
]
Array [
Array [
Array [
]
]
]
Array [
Array [
Array [
]
]
Array [
]
Array [
]
]
Array [
Array [
Array [
]
]
]
metadata
object
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
annotations
object
Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set.
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.
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.
labels
object
Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag
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.
Name of the resource.
UID is the unique identifier generated for the resource. This is not an input field for any request.
spec
object
Cloud account uid to be used for cluster provisioning
cloudConfig
object
required
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
clusterConfig
object
ClusterMetaAttribute can be used to set additional cluster metadata information.
hostClusterConfig
clusterEndpoint
config
ingressConfig
Ingress configuration for exposing the virtual cluster's kube-apiserver
loadBalancerConfig
Load balancer configuration for exposing the virtual cluster's kube-apiserver
Possible values: [Ingress, LoadBalancer]
is enabled as host cluster
clusterGroup
object
ObjectReference contains enough information to let you inspect or modify the referred object.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Name of the referent.
UID of the referent.
hostCluster
object
ObjectReference contains enough information to let you inspect or modify the referred object.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Name of the referent.
UID of the referent.
Default value: false
is enabled as host cluster
lifecycleConfig
Default value: false
enable pause life cycle config
location
object
Cluster location information
country code for cluster location
country name for cluster location
geoLoc
object
Geolocation Latlong entity
Latitude of a resource
Longitude of a resource
region code for cluster location
region name for cluster location
machineManagementConfig
object
osPatchConfig
object
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.
PatchOnBoot indicates need to do patch when node first boot up, only once
Reboot once the OS patch is applied
The schedule at which security patches will be applied to OS. Schedule should be in Cron format, see https://en.wikipedia.org/wiki/Cron for more help.
resources
object
namespaces
object[]
metadata
object
ObjectMeta update entity with uid as input
annotations
object
labels
object
spec
Cluster namespace spec
relatedObject
object
Object for which the resource is related
Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]
resourceAllocation
Cluster namespace resource allocation
rbacs
object[]
metadata
object
ObjectMeta update entity with uid as input
annotations
object
labels
object
spec
object
Cluster RBAC spec
bindings
object[]
role
object
Cluster role ref
Possible values: [Role, ClusterRole]
subjects
object[]
Possible values: [User, Group, ServiceAccount]
Possible values: [RoleBinding, ClusterRoleBinding]
relatedObject
object
Object for which the resource is related
Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]
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 defines the options available to a user when configuring Machines to run on Spot instances. Most users should provide an empty struct.
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
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
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
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
policies
object
Cluster policies
backupPolicy
Cluster backup config
schedule
Cluster feature schedule
scanPolicy
Cluster compliance scan schedule configuration
kubeBench
Cluster compliance scan schedule config for kube bench driver
schedule
Cluster feature schedule
kubeHunter
Cluster compliance scan schedule config for kube hunter driver
schedule
Cluster feature schedule
sonobuoy
Cluster compliance scan schedule config for sonobuoy driver
schedule
Cluster feature schedule
profiles
object[]
packValues
object[]
Cluster profile packs array
manifests
undefined[]
Pack manifests are additional content as part of the profile
Manifest content in yaml
Manifest name
Manifest uid
Pack name
Pack version tag
Possible values: [spectro, helm, manifest, oci]
Default value: spectro
Pack values represents the values.yaml used as input parameters either Params OR Values should be used, not both If both applied at the same time, will only use Values
Cluster profile uid to be replaced with new profile
Cluster profile uid
Responses
- 201
Created successfully
Response Headers
AuditUid
string
Audit uid for the request
- application/json
- Schema
- Example (from schema)
Schema
{
"uid": "string"
}