Skip to main content
Version: latest

Creates an AWS cluster

POST 

/v1/spectroclusters/aws

Creates an AWS cluster

Request

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Body

    metadata

    object

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

    annotations

    object

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

    property name*string
    creationTimestampdate-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.

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

    labels

    object

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

    property name*string
    lastModifiedTimestampdate-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.

    namestring

    Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

    uidstring

    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

    Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

    spec

    object

    cloudAccountUidstringrequired

    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

    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

    clusterConfig

    object

    General cluster configuration like health, patching settings, namespace resource allocation, rbac

    clusterMetaAttributestring

    ClusterMetaAttribute can be used to set additional cluster metadata information.

    controlPlaneHealthCheckTimeoutstring

    hostClusterConfig

    clusterEndpoint

    host cluster configuration

    config

    ingressConfig

    Ingress configuration for exposing the virtual cluster's kube-apiserver

    hoststring
    portint64

    loadBalancerConfig

    Load balancer configuration for exposing the virtual cluster's kube-apiserver

    externalIPsstring[]
    externalTrafficPolicystring
    loadBalancerSourceRangesstring[]
    typestring

    Possible values: [Ingress, LoadBalancer]

    is enabled as host cluster

    clusterGroup

    object

    ObjectReference contains enough information to let you inspect or modify the referred object.

    kindstring

    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    uidstring

    UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

    hostCluster

    object

    ObjectReference contains enough information to let you inspect or modify the referred object.

    kindstring

    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    uidstring

    UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

    isHostClusterboolean

    Default value: false

    is enabled as host cluster

    lifecycleConfig

    pauseboolean

    Default value: false

    enable pause life cycle config

    location

    object

    Cluster location information

    countryCodestring

    country code for cluster location

    countryNamestring

    country name for cluster location

    geoLoc

    object

    Geolocation Latlong entity

    latitudefloat64

    Latitude of a resource

    longitudefloat64

    Longitude of a resource

    regionCodestring

    region code for cluster location

    regionNamestring

    region name for cluster location

    machineManagementConfig

    object

    osPatchConfig

    object

    OS patch config contains properties to patch node os with latest security packages. If OsPatchConfig is not provided then node os will not be patched with latest security updates. Note: For edge based cluster (like edge-native type) the osPatchConfig is NOT applicable, the values will be ignored.

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

    patchOnBootboolean

    PatchOnBoot indicates need to do patch when node first boot up, only once

    rebootIfRequiredboolean

    Reboot once the OS patch is applied

    schedulestring

    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[]

  • Array [

  • metadata

    object

    ObjectMeta update entity with uid as input

    annotations

    object

    property name*string

    labels

    object

    property name*string
    namestring
    uidstring

    spec

    Cluster namespace spec

    isRegexboolean

    relatedObject

    object

    Object for which the resource is related

    kindstring

    Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]

    namestring
    uidstring

    resourceAllocation

    Cluster namespace resource allocation

    cpuCoresnumber
    memoryMiBnumber
  • ]

  • rbacs

    object[]

  • Array [

  • metadata

    object

    ObjectMeta update entity with uid as input

    annotations

    object

    property name*string

    labels

    object

    property name*string
    namestring
    uidstring

    spec

    object

    Cluster RBAC spec

    bindings

    object[]

  • Array [

  • namespacestring

    role

    object

    Cluster role ref

    kindstring

    Possible values: [Role, ClusterRole]

    namestring

    subjects

    object[]

  • Array [

  • namestring
    namespacestring
    typestring

    Possible values: [User, Group, ServiceAccount]

  • ]

  • typestring

    Possible values: [RoleBinding, ClusterRoleBinding]

  • ]

  • relatedObject

    object

    Object for which the resource is related

    kindstring

    Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]

    namestring
    uidstring
  • ]

  • updateWorkerPoolsInParallelboolean

    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

  • ]

  • policies

    object

    Cluster policies

    backupPolicy

    Cluster backup config

    backupLocationNamestring
    backupLocationUidstring
    backupNamestring
    backupPrefixstring
    durationInHoursint64
    includeAllDisksboolean
    includeClusterResourcesboolean
    locationTypestring
    namespacesstring[]

    schedule

    Cluster feature schedule

    scheduledRunTimestring

    scanPolicy

    Cluster compliance scan schedule configuration

    kubeBench

    Cluster compliance scan schedule config for kube bench driver

    schedule

    Cluster feature schedule

    scheduledRunTimestring

    kubeHunter

    Cluster compliance scan schedule config for kube hunter driver

    schedule

    Cluster feature schedule

    scheduledRunTimestring

    sonobuoy

    Cluster compliance scan schedule config for sonobuoy driver

    schedule

    Cluster feature schedule

    scheduledRunTimestring

    profiles

    object[]

  • Array [

  • packValues

    object[]

    Cluster profile packs array

  • Array [

  • manifests

    undefined[]

    Pack manifests are additional content as part of the profile

  • Array [

  • contentstring

    Manifest content in yaml

    namestringrequired

    Manifest name

    uidstring

    Manifest uid

  • ]

  • namestringrequired

    Pack name

    tagstring

    Pack version tag

    typestring

    Possible values: [spectro, helm, manifest, oci]

    Default value: spectro

    valuesstring

    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

  • ]

  • replaceWithProfilestring

    Cluster profile uid to be replaced with new profile

    uidstring

    Cluster profile uid

    variables

    object[]

  • Array [

  • namestringrequired

    Variable name

    valuestring

    Actual value of the variable to be used within the cluster

  • ]

  • ]

Responses

Created successfully

Response Headers

  • AuditUid

    string

    Audit uid for the request

Schema

    uidstringrequired
Loading...