Create a cluster — Astro API Reference

Create a cluster in the Organization. An Astro cluster is a Kubernetes cluster that hosts the infrastructure required to run Deployments.

Path parameters

organizationIdstringRequired

The ID of the Organization to create the cluster in.

Request

This endpoint expects an object.

Create AWS Cluster Requestobject

Create Azure Cluster Requestobject

Create GCP Cluster Requestobject

Response

cloudProviderenum

Allowed values: AWSAZUREGCP

The name of the cluster’s cloud provider.

createdAtdatetime

The time when the cluster was created in UTC. formatted as YYYY-MM-DDTHH:MM:SSZ.

dbInstanceTypestring

The type of database instance that is used for the cluster.

idstring

The cluster’s ID.

namestring

The cluster’s name.

organizationIdstring

The ID of the Organization that the cluster belongs to.

regionstring

The region in which the cluster is created.

statusenum

The status of the cluster.

typeenum

Allowed values: DEDICATEDHYBRID

The type of the cluster.

updatedAtdatetime

The time when the cluster was last updated in UTC. formatted as YYYY-MM-DDTHH:MM:SSZ.

vpcSubnetRangestring

The VPC subnet range.

healthStatusobjectOptional

isLimitedbooleanOptional

Whether the cluster is limited.

metadataobjectOptional

nodePoolslist of objectsOptional

The list of node pools that are created in the cluster.

podSubnetRangestringOptional

The subnet range for Pods. For GCP clusters only.

providerAccountstringOptional

The provider account ID. For GCP clusters only.

servicePeeringRangestringOptional

The service peering range. For GCP clusters only.

serviceSubnetRangestringOptional

The service subnet range. For GCP clusters only.

tagslist of objectsOptional

The Kubernetes tags in the cluster. For AWS Hybrid clusters only.

tenantIdstringOptional

The tenant ID. For Azure clusters only.

workspaceIdslist of stringsOptional

The list of Workspaces that are authorized to the cluster.

1 curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/clusters \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "cloudProvider": "AWS", 6 "name": "My cluster", 7 "region": "us-east-1", 8 "type": "DEDICATED", 9 "vpcSubnetRange": "172.20.0.0/22" 10 }'

1 { 2 "cloudProvider": "AWS", 3 "createdAt": "2022-11-22T04:37:12Z", 4 "dbInstanceType": "db.t3.medium", 5 "id": "clm7k8tgw000008jz97i37y81", 6 "name": "my cluster", 7 "organizationId": "clm88r8hi000008jwhzxu5crg", 8 "region": "us-east-1", 9 "status": "CREATING", 10 "type": "DEDICATED", 11 "updatedAt": "2022-11-22T04:37:12Z", 12 "vpcSubnetRange": "172.20.0.0/22", 13 "healthStatus": { 14 "value": "HEALTHY", 15 "details": [ 16 { 17 "code": "code", 18 "description": "description", 19 "severity": "severity" 20 } 21 ] 22 }, 23 "isLimited": false, 24 "metadata": { 25 "externalIPs": [ 26 "35.100.100.1" 27 ], 28 "kubeDnsIp": "10.100.100.0", 29 "oidcIssuerUrl": "https://westus2.oic.prod-aks.azure.com/b84efac8-cfae-467a-b223-23b9aea1486d/3075f79e-abc2-4602-a691-28117197e83d/" 30 }, 31 "nodePools": [ 32 { 33 "cloudProvider": "AWS", 34 "clusterId": "clm891jb6000308jrc3vjdtde", 35 "createdAt": "2022-11-22T04:37:12Z", 36 "id": "clm890zhe000208jr39dd0ubs", 37 "isDefault": true, 38 "maxNodeCount": 1, 39 "name": "default", 40 "nodeInstanceType": "t3.medium", 41 "updatedAt": "2022-11-22T04:37:12Z", 42 "supportedAstroMachines": [ 43 "A5", 44 "A10" 45 ] 46 } 47 ], 48 "podSubnetRange": "172.21.0.0/19", 49 "providerAccount": "provider-account", 50 "servicePeeringRange": "172.23.0.0/20", 51 "serviceSubnetRange": "172.22.0.0/22", 52 "tags": [ 53 { 54 "key": "key1", 55 "value": "value1" 56 } 57 ], 58 "tenantId": "your-tenant-id", 59 "workspaceIds": [ 60 "clm88rddl000108jwgeka2div" 61 ] 62 }

1	curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/clusters \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"cloudProvider": "AWS",
6	"name": "My cluster",
7	"region": "us-east-1",
8	"type": "DEDICATED",
9	"vpcSubnetRange": "172.20.0.0/22"
10	}'

1	{
2	"cloudProvider": "AWS",
3	"createdAt": "2022-11-22T04:37:12Z",
4	"dbInstanceType": "db.t3.medium",
5	"id": "clm7k8tgw000008jz97i37y81",
6	"name": "my cluster",
7	"organizationId": "clm88r8hi000008jwhzxu5crg",
8	"region": "us-east-1",
9	"status": "CREATING",
10	"type": "DEDICATED",
11	"updatedAt": "2022-11-22T04:37:12Z",
12	"vpcSubnetRange": "172.20.0.0/22",
13	"healthStatus": {
14	"value": "HEALTHY",
15	"details": [
16	{
17	"code": "code",
18	"description": "description",
19	"severity": "severity"
20	}
21	]
22	},
23	"isLimited": false,
24	"metadata": {
25	"externalIPs": [
26	"35.100.100.1"
27	],
28	"kubeDnsIp": "10.100.100.0",
29	"oidcIssuerUrl": "https://westus2.oic.prod-aks.azure.com/b84efac8-cfae-467a-b223-23b9aea1486d/3075f79e-abc2-4602-a691-28117197e83d/"
30	},
31	"nodePools": [
32	{
33	"cloudProvider": "AWS",
34	"clusterId": "clm891jb6000308jrc3vjdtde",
35	"createdAt": "2022-11-22T04:37:12Z",
36	"id": "clm890zhe000208jr39dd0ubs",
37	"isDefault": true,
38	"maxNodeCount": 1,
39	"name": "default",
40	"nodeInstanceType": "t3.medium",
41	"updatedAt": "2022-11-22T04:37:12Z",
42	"supportedAstroMachines": [
43	"A5",
44	"A10"
45	]
46	}
47	],
48	"podSubnetRange": "172.21.0.0/19",
49	"providerAccount": "provider-account",
50	"servicePeeringRange": "172.23.0.0/20",
51	"serviceSubnetRange": "172.22.0.0/22",
52	"tags": [
53	{
54	"key": "key1",
55	"value": "value1"
56	}
57	],
58	"tenantId": "your-tenant-id",
59	"workspaceIds": [
60	"clm88rddl000108jwgeka2div"
61	]
62	}