Get Cluster
Get cluster associated with provided id
curl --request GET \
--url https://{controlPlaneURL}/api/svc/v1/clusters/{id} \
--header 'Authorization: Bearer <token>'{
"data": {
"id": "<string>",
"fqn": "<string>",
"name": "<string>",
"manifest": {
"type": "cluster",
"name": "<string>",
"cluster_type": "aws-eks",
"environment_names": [
"<string>"
],
"base_domains": [
"<string>"
],
"monitoring": {
"loki_url": "<string>",
"prometheus_url": "<string>",
"kubecost_url": "<string>"
},
"default_registry_fqn": "<string>",
"workbench_config": {
"notebook_config": {
"base_domain": "<string>"
},
"ssh_server_config": {
"base_domain": "<string>",
"port": 123
},
"default_storage_class": "<string>"
},
"cluster_integration_fqn": "<string>",
"workflow_storage_integration_fqn": "<string>",
"supported_nodepools": [
{
"name": "<string>",
"description": "<string>",
"capacityType": "on-demand",
"deviceTypeToMaxCountMap": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "<string>"
}
],
"instanceResources": {
"cpu": 123,
"memoryMB": 123,
"ephemeralStorageMB": 123,
"devices": [
{
"type": "nvidia_gpu",
"gpuType": "P4",
"count": 123,
"configuration": [
{
"type": "nvidia_gpu",
"count": 123,
"deviceIdentifier": "<string>",
"migProfile": "<string>",
"perInstanceGpuMemory": 123,
"slicesPerFullGpu": 123,
"nvidiaDevicePluginConfig": "<string>"
}
]
}
],
"gpuCount": 123,
"gpuType": "<string>"
}
}
],
"node_label_keys": {
"nodepool_selector_label": "<string>"
},
"collaborators": [
{
"subject": "<string>",
"role_id": "<string>"
}
]
},
"tenantName": "<string>",
"createdBySubject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Cluster id of the cluster
Response
Cluster
+value=cluster
cluster +label=Name +icon=fa-desktop:#black +sort=10 +message=3 to 35 lower case characters long alphanumeric word, may contain - in between, cannot start with a number
+label=Cluster Type +icon=fa-cloud:#7EC8E3 +sort=20 +usage=The cluster type of this cluster
aws-eks, gcp-gke-standard, azure-aks, generic, civo-talos +label=Environments +icon=fa-tags:#black +usage=Tag the environment like dev, staging or production. You will need to create environments if you don't have already. +sort=30
+label=Collaborators +usage=Collaborators who can access this cluster +sort=110
+label=Base Domain URLs
+placeholder=Enter Base Domain URL eg. devtest.mydomain.com or *.mydomain.com
+usage=One or more base URLs, which can be either a wildcard domain (resulting in app URLs like <app-name>-<workspace-name>.<base-domain-URL>) or a non-wildcard domain (resulting in app URLs like <base-domain-URL>/<app-name>-<workspace-name>)
Read more about routing here and about 'A' record and domain mapping here +icon=fa-globe:#68BBE3 +sort=40 +message=Domain URL should be valid domain or IP address
+label=Cluster Default Registry +sort=60
+label=Workbench Config +sort=70
+label=Notebook Base Domain +usage=The base domain for the cluster with which you can access your Notebooks
+label=SSH Base Domain +usage=The base domain for the cluster with which you can access your SSH containers +sort=1000
+label=SSH Port +usage=The port for the cluster with which you can access your SSH containers +sort=2000
+label=Default Storage Class +usage=The default storage class for the home directory of workbench
+label=Cluster Integration FQN +sort=75 +uiType=IntegrationSelect +uiProps={"descriptionKey": "cluster_name","integrationType": "cluster"}
+label=Workflow Storage Integration +sort=80 +uiType=IntegrationSelect +uiProps={"descriptionKey": "cluster_name","integrationType": "blob-storage"}
+label=Nodepools +usage=Add nodepools that are already created in your cluster. When deploying, applications can choose to schedule from these nodepools. +sort=90
on-demand, spot +label=Node Label Keys
+usage=The node label keys that this cluster supports.
Note: You will additionally need to add truefoundry.com/gpu_type label for GPU-supported node pools.
For more information, check out this documentation.
+sort=100
+label=Nodepool Selector Label +usage=The nodepool selector label that this cluster supports
curl --request GET \
--url https://{controlPlaneURL}/api/svc/v1/clusters/{id} \
--header 'Authorization: Bearer <token>'{
"data": {
"id": "<string>",
"fqn": "<string>",
"name": "<string>",
"manifest": {
"type": "cluster",
"name": "<string>",
"cluster_type": "aws-eks",
"environment_names": [
"<string>"
],
"base_domains": [
"<string>"
],
"monitoring": {
"loki_url": "<string>",
"prometheus_url": "<string>",
"kubecost_url": "<string>"
},
"default_registry_fqn": "<string>",
"workbench_config": {
"notebook_config": {
"base_domain": "<string>"
},
"ssh_server_config": {
"base_domain": "<string>",
"port": 123
},
"default_storage_class": "<string>"
},
"cluster_integration_fqn": "<string>",
"workflow_storage_integration_fqn": "<string>",
"supported_nodepools": [
{
"name": "<string>",
"description": "<string>",
"capacityType": "on-demand",
"deviceTypeToMaxCountMap": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "<string>"
}
],
"instanceResources": {
"cpu": 123,
"memoryMB": 123,
"ephemeralStorageMB": 123,
"devices": [
{
"type": "nvidia_gpu",
"gpuType": "P4",
"count": 123,
"configuration": [
{
"type": "nvidia_gpu",
"count": 123,
"deviceIdentifier": "<string>",
"migProfile": "<string>",
"perInstanceGpuMemory": 123,
"slicesPerFullGpu": 123,
"nvidiaDevicePluginConfig": "<string>"
}
]
}
],
"gpuCount": 123,
"gpuType": "<string>"
}
}
],
"node_label_keys": {
"nodepool_selector_label": "<string>"
},
"collaborators": [
{
"subject": "<string>",
"role_id": "<string>"
}
]
},
"tenantName": "<string>",
"createdBySubject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>"
}
}