Creates an AKS cluster

POST 
https://api.spectrocloud.com/v1/spectroclusters/aks

Creates an AKS cluster

Request

Header Parameters

ProjectUid string

Scope the request to the specified project uid

application/json

Body

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, other than that any input on annotations will be ignored

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

Labels or Tags (UI) are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag

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 of the resource

uidstring

UID is the unique identifier generated for the resource. This is not an input field for any request.

Populated by the system. Read-only.

spec

object

cloudAccountUidstringrequired

Cloud account uid to be used for cluster provisioning

cloudConfig

object

required

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

aadProfile

object

AadProfile is Azure Active Directory configuration to integrate with AKS for aad authentication.

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 is the 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

Subnet for Kubernetes control-plane node

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 is the configuration for the control-plane load balancer.

apiServerLB

object

APIServerLB is the configuration for the control-plane 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

Subnet for Kubernetes worker node

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

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

Represents the resource kind

namestring

Name of the resource

uidstring

Uid of the resource

hostCluster

object

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

kindstring

Represents the resource kind

namestring

Name of the resource

uidstring

Uid of the resource

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.

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

Name of the resource

uidstring

Populated by the system. Read-only.

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

Name of the resource

uidstring

Populated by the system. Read-only.

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

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

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

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

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 master 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

]

Responses

201

Created successfully

Response Headers

• AuditUid

  string

  Audit uid for the request

application/json

Schema

Schema

uidstringrequired

Example (from schema)

{
  "uid": "string"
}

• curl
• python
• go
• nodejs
• java

• CURL

curl -L -X POST 'https://api.spectrocloud.com/v1/spectroclusters/aks' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'ApiKey: <API_KEY_VALUE>' \
--data-raw '{
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-07-02T12:24:49.859Z",
    "deletionTimestamp": "2024-07-02T12:24:49.859Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-07-02T12:24:49.859Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "cloudAccountUid": "string",
    "cloudConfig": {
      "aadProfile": {
        "adminGroupObjectIDs": [
          "string"
        ],
        "managed": true
      },
      "apiServerAccessProfile": {
        "authorizedIPRanges": [
          "string"
        ],
        "enablePrivateCluster": true,
        "enablePrivateClusterPublicFQDN": true,
        "privateDNSZone": "string"
      },
      "containerName": "string",
      "controlPlaneSubnet": {
        "cidrBlock": "string",
        "name": "string",
        "securityGroupName": "string"
      },
      "enablePrivateCluster": true,
      "infraLBConfig": {
        "apiServerLB": {
          "apiServerLBStaticIP": "string",
          "ipAllocationMethod": "Dynamic",
          "privateDNSName": "string",
          "type": "Public"
        }
      },
      "location": "string",
      "resourceGroup": "string",
      "sshKey": "string",
      "storageAccountName": "string",
      "subscriptionId": "string",
      "vnetCidrBlock": "string",
      "vnetName": "string",
      "vnetResourceGroup": "string",
      "workerSubnet": {
        "cidrBlock": "string",
        "name": "string",
        "securityGroupName": "string"
      }
    },
    "clusterConfig": {
      "clusterMetaAttribute": "string",
      "controlPlaneHealthCheckTimeout": "string",
      "hostClusterConfig": {
        "clusterEndpoint": {
          "config": {
            "ingressConfig": {
              "host": "string",
              "port": 0
            },
            "loadBalancerConfig": {
              "externalIPs": [
                "string"
              ],
              "externalTrafficPolicy": "string",
              "loadBalancerSourceRanges": [
                "string"
              ]
            }
          },
          "type": "Ingress"
        },
        "clusterGroup": {
          "kind": "string",
          "name": "string",
          "uid": "string"
        },
        "hostCluster": {
          "kind": "string",
          "name": "string",
          "uid": "string"
        },
        "isHostCluster": false
      },
      "lifecycleConfig": {
        "pause": false
      },
      "location": {
        "countryCode": "string",
        "countryName": "string",
        "geoLoc": {
          "latitude": 0,
          "longitude": 0
        },
        "regionCode": "string",
        "regionName": "string"
      },
      "machineManagementConfig": {
        "osPatchConfig": {
          "onDemandPatchAfter": "2024-07-02T12:24:49.860Z",
          "patchOnBoot": true,
          "rebootIfRequired": true,
          "schedule": "string"
        }
      },
      "resources": {
        "namespaces": [
          {
            "metadata": {
              "annotations": {},
              "labels": {},
              "name": "string",
              "uid": "string"
            },
            "spec": {
              "isRegex": true,
              "relatedObject": {
                "kind": "spectrocluster",
                "name": "string",
                "uid": "string"
              },
              "resourceAllocation": {
                "cpuCores": 0,
                "memoryMiB": 0
              }
            }
          }
        ],
        "rbacs": [
          {
            "metadata": {
              "annotations": {},
              "labels": {},
              "name": "string",
              "uid": "string"
            },
            "spec": {
              "bindings": [
                {
                  "namespace": "string",
                  "role": {
                    "kind": "Role",
                    "name": "string"
                  },
                  "subjects": [
                    {
                      "name": "string",
                      "namespace": "string",
                      "type": "User"
                    }
                  ],
                  "type": "RoleBinding"
                }
              ],
              "relatedObject": {
                "kind": "spectrocluster",
                "name": "string",
                "uid": "string"
              }
            }
          }
        ]
      },
      "updateWorkerPoolsInParallel": true
    },
    "machinepoolconfig": [
      {
        "cloudConfig": {
          "azs": [
            "string"
          ],
          "instanceType": "string",
          "isSystemNodePool": true,
          "osDisk": {
            "diskSizeGB": 0,
            "managedDisk": {
              "storageAccountType": "string"
            },
            "osType": "Linux"
          }
        },
        "managedPoolConfig": {
          "isSystemNodePool": true,
          "osType": "Linux"
        },
        "poolConfig": {
          "additionalLabels": {},
          "additionalTags": {},
          "isControlPlane": true,
          "labels": [
            "string"
          ],
          "machinePoolProperties": {
            "archType": "amd64"
          },
          "maxSize": 0,
          "minSize": 0,
          "name": "string",
          "nodeRepaveInterval": 0,
          "size": 0,
          "taints": [
            {
              "effect": "NoSchedule",
              "key": "string",
              "timeAdded": "2024-07-02T12:24:49.860Z",
              "value": "string"
            }
          ],
          "updateStrategy": {
            "type": "RollingUpdateScaleOut"
          },
          "useControlPlaneAsWorker": true
        }
      }
    ],
    "policies": {
      "backupPolicy": {
        "backupLocationName": "string",
        "backupLocationUid": "string",
        "backupName": "string",
        "backupPrefix": "string",
        "durationInHours": 0,
        "includeAllDisks": true,
        "includeClusterResources": true,
        "locationType": "string",
        "namespaces": [
          "string"
        ],
        "schedule": {
          "scheduledRunTime": "string"
        }
      },
      "scanPolicy": {
        "kubeBench": {
          "schedule": {
            "scheduledRunTime": "string"
          }
        },
        "kubeHunter": {
          "schedule": {
            "scheduledRunTime": "string"
          }
        },
        "sonobuoy": {
          "schedule": {
            "scheduledRunTime": "string"
          }
        }
      }
    },
    "profiles": [
      {
        "packValues": [
          {
            "manifests": [
              {
                "content": "string",
                "name": "string",
                "uid": "string"
              }
            ],
            "name": "string",
            "tag": "string",
            "type": "spectro",
            "values": "string"
          }
        ],
        "replaceWithProfile": "string",
        "uid": "string"
      }
    ]
  }
}'

Request Collapse all

Base URL

https://api.spectrocloud.com

Auth

Security Scheme

ApiKeyAuthorization

ApiKey

Parameters

ProjectUid — header

Body

{
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-07-02T12:24:49.859Z",
    "deletionTimestamp": "2024-07-02T12:24:49.859Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-07-02T12:24:49.859Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "cloudAccountUid": "string",
    "cloudConfig": {
      "aadProfile": {
        "adminGroupObjectIDs": [
          "string"
        ],
        "managed": true
      },
      "apiServerAccessProfile": {
        "authorizedIPRanges": [
          "string"
        ],
        "enablePrivateCluster": true,
        "enablePrivateClusterPublicFQDN": true,
        "privateDNSZone": "string"
      },
      "containerName": "string",
      "controlPlaneSubnet": {
        "cidrBlock": "string",
        "name": "string",
        "securityGroupName": "string"
      },
      "enablePrivateCluster": true,
      "infraLBConfig": {
        "apiServerLB": {
          "apiServerLBStaticIP": "string",
          "ipAllocationMethod": "Dynamic",
          "privateDNSName": "string",
          "type": "Public"
        }
      },
      "location": "string",
      "resourceGroup": "string",
      "sshKey": "string",
      "storageAccountName": "string",
      "subscriptionId": "string",
      "vnetCidrBlock": "string",
      "vnetName": "string",
      "vnetResourceGroup": "string",
      "workerSubnet": {
        "cidrBlock": "string",
        "name": "string",
        "securityGroupName": "string"
      }
    },
    "clusterConfig": {
      "clusterMetaAttribute": "string",
      "controlPlaneHealthCheckTimeout": "string",
      "hostClusterConfig": {
        "clusterEndpoint": {
          "config": {
            "ingressConfig": {
              "host": "string",
              "port": 0
            },
            "loadBalancerConfig": {
              "externalIPs": [
                "string"
              ],
              "externalTrafficPolicy": "string",
              "loadBalancerSourceRanges": [
                "string"
              ]
            }
          },
          "type": "Ingress"
        },
        "clusterGroup": {
          "kind": "string",
          "name": "string",
          "uid": "string"
        },
        "hostCluster": {
          "kind": "string",
          "name": "string",
          "uid": "string"
        },
        "isHostCluster": false
      },
      "lifecycleConfig": {
        "pause": false
      },
      "location": {
        "countryCode": "string",
        "countryName": "string",
        "geoLoc": {
          "latitude": 0,
          "longitude": 0
        },
        "regionCode": "string",
        "regionName": "string"
      },
      "machineManagementConfig": {
        "osPatchConfig": {
          "onDemandPatchAfter": "2024-07-02T12:24:49.860Z",
          "patchOnBoot": true,
          "rebootIfRequired": true,
          "schedule": "string"
        }
      },
      "resources": {
        "namespaces": [
          {
            "metadata": {
              "annotations": {},
              "labels": {},
              "name": "string",
              "uid": "string"
            },
            "spec": {
              "isRegex": true,
              "relatedObject": {
                "kind": "spectrocluster",
                "name": "string",
                "uid": "string"
              },
              "resourceAllocation": {
                "cpuCores": 0,
                "memoryMiB": 0
              }
            }
          }
        ],
        "rbacs": [
          {
            "metadata": {
              "annotations": {},
              "labels": {},
              "name": "string",
              "uid": "string"
            },
            "spec": {
              "bindings": [
                {
                  "namespace": "string",
                  "role": {
                    "kind": "Role",
                    "name": "string"
                  },
                  "subjects": [
                    {
                      "name": "string",
                      "namespace": "string",
                      "type": "User"
                    }
                  ],
                  "type": "RoleBinding"
                }
              ],
              "relatedObject": {
                "kind": "spectrocluster",
                "name": "string",
                "uid": "string"
              }
            }
          }
        ]
      },
      "updateWorkerPoolsInParallel": true
    },
    "machinepoolconfig": [
      {
        "cloudConfig": {
          "azs": [
            "string"
          ],
          "instanceType": "string",
          "isSystemNodePool": true,
          "osDisk": {
            "diskSizeGB": 0,
            "managedDisk": {
              "storageAccountType": "string"
            },
            "osType": "Linux"
          }
        },
        "managedPoolConfig": {
          "isSystemNodePool": true,
          "osType": "Linux"
        },
        "poolConfig": {
          "additionalLabels": {},
          "additionalTags": {},
          "isControlPlane": true,
          "labels": [
            "string"
          ],
          "machinePoolProperties": {
            "archType": "amd64"
          },
          "maxSize": 0,
          "minSize": 0,
          "name": "string",
          "nodeRepaveInterval": 0,
          "size": 0,
          "taints": [
            {
              "effect": "NoSchedule",
              "key": "string",
              "timeAdded": "2024-07-02T12:24:49.860Z",
              "value": "string"
            }
          ],
          "updateStrategy": {
            "type": "RollingUpdateScaleOut"
          },
          "useControlPlaneAsWorker": true
        }
      }
    ],
    "policies": {
      "backupPolicy": {
        "backupLocationName": "string",
        "backupLocationUid": "string",
        "backupName": "string",
        "backupPrefix": "string",
        "durationInHours": 0,
        "includeAllDisks": true,
        "includeClusterResources": true,
        "locationType": "string",
        "namespaces": [
          "string"
        ],
        "schedule": {
          "scheduledRunTime": "string"
        }
      },
      "scanPolicy": {
        "kubeBench": {
          "schedule": {
            "scheduledRunTime": "string"
          }
        },
        "kubeHunter": {
          "schedule": {
            "scheduledRunTime": "string"
          }
        },
        "sonobuoy": {
          "schedule": {
            "scheduledRunTime": "string"
          }
        }
      }
    },
    "profiles": [
      {
        "packValues": [
          {
            "manifests": [
              {
                "content": "string",
                "name": "string",
                "uid": "string"
              }
            ],
            "name": "string",
            "tag": "string",
            "type": "spectro",
            "values": "string"
          }
        ],
        "replaceWithProfile": "string",
        "uid": "string"
      }
    ]
  }
}