Data Plane Provisioner

This API provides control over the data-planes provisioning. You may start by creating directly a data-plane on AWS or Azure using your cloud credentials, or register an existing Kubernetes cluster as a data-plane. You are able to manage your data-planes, i.e. list, update and delete/unregister them.

Endpoints

Global security

These security schemes apply to the entire API

Security scheme

This scheme can be referenced across the API

Public
Bearer authentication
Name Description
Format Bearer <jwt>

Update a data-plane

PUT /processing/data-planes/{id}
Required entitlement TMC_CLUSTER_MANAGEMENT

Request

Path variables
Name Description Type Attributes and examples
id The data-plane’s id string Required
Body
application/json
UpdateDataPlaneRequest

Response

200Status 200
OK
Body
application/json
DataPlaneDetailsResponse
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation
409Status 409
There is already an ongoing operation for this data-plane
Body
application/json
ApiError

Get a data-plane by its id

GET /processing/data-planes/{id}
Required entitlement TMC_CLUSTER_MANAGEMENT

Request

Path variables
Name Description Type Attributes and examples
id The data-plane’s id string Required

Response

200Status 200
OK
Body
application/json
DataPlaneDetailsResponse
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation
404Status 404
Not Found
Body
application/json
ApiError

Delete a data-plane

DELETE /processing/data-planes/{id}
Required entitlement TMC_CLUSTER_MANAGEMENT

Request

Path variables
Name Description Type Attributes and examples
id The data-plane’s id string Required

Response

200Status 200
OK
202Status 202
Accepted
Body
application/json
Object
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation

Create a new data-plane

POST /processing/data-planes
Required entitlement TMC_CLUSTER_MANAGEMENT

Request

Body
application/json
one of AKSCreateDataPlaneRequest , EKSCreateDataPlaneRequest , CustomCreateDataPlaneRequest , RegisterCreateDataPlaneRequest

Response

200Status 200
OK
Body
application/json
DataPlaneDetailsResponse
201Status 201
Created
Body
application/json
DataPlaneDetailsResponse
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation

Get all user's data-plane(s)

GET /processing/data-planes
Required entitlement TMC_CLUSTER_MANAGEMENT

Response

200Status 200
OK
Body
application/json
details
Name Description Type Attributes and examples
array of DataPlaneDetailsResponse
Datatype details
Type Description Attributes and examples
array
DataPlaneDetailsResponse
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation

List the data-plane's members

GET /processing/data-planes/{dataPlaneId}/members
Required entitlement TMC_CLUSTER_MANAGEMENT

Request

Path variables
Name Description Type Attributes and examples
dataPlaneId string Required

Response

200Status 200
OK
Body
application/json
details
Name Description Type Attributes and examples
array of DataPlaneMember
Datatype details
Type Description Attributes and examples
array
DataPlaneMember
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation

Create a member and add it to the data-plane

POST /processing/data-planes/{dataPlaneId}/members
Required entitlement TMC_CLUSTER_MANAGEMENT

Request

Path variables
Name Description Type Attributes and examples
dataPlaneId string Required
Body
application/json
AddMemberRequest

Response

201Status 201
Created
Body
application/json
DataPlaneMember
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation

List roles member can assume

GET /processing/data-planes/{dataPlaneId}/members/roles
Required entitlement TMC_CLUSTER_MANAGEMENT

Request

Path variables
Name Description Type Attributes and examples
dataPlaneId string Required

Response

200Status 200
OK
Body
application/json
details
Name Description Type Attributes and examples
array of DataPlaneRole
Datatype details
Type Description Attributes and examples
array
DataPlaneRole
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation

Get the cloud provider Kubernetes settings

GET /processing/data-planes/settings
Required entitlement TMC_CLUSTER_MANAGEMENT

Response

200Status 200
OK
Body
application/json
CloudProvidersProperties
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation

Remove the member

DELETE /processing/data-planes/{dataPlaneId}/members/{id}
Required entitlement TMC_CLUSTER_MANAGEMENT

Request

Path variables
Name Description Type Attributes and examples
dataPlaneId string Required
id string Required

Response

200Status 200
OK
Body
application/json
Object
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation

ApiError

Describe an API error
Object
Name Description Type Attributes and examples
status HTTP status code integer Optional
FormatINT32
Example
400
title The error’s title string Optional
Example
Bad request
details The error’s details string Optional
Example
Invalid parameter
data The error’s data ObjectOptional
instance The error’s instance string Optional
Example
https://api.talend.com/errors/data-plane-not-found
type The error’s type string Optional
Example
https://api.talend.com/errors/error-code
code The error’s code string Optional
Example
DP_ERR_001

AksLoggingConf

The audit logs configuration for Azure
Object
Name Description Type Attributes and examples
monitoring Activate Azure Log Analytics boolean Optional
logAnalyticsWorkspaceGroup Resource Group for Log Analytics workspace string Optional
logAnalyticsWorkspaceName Workspace Name for Log Analytics string Optional

LoggingType

The list of audit logs types for AWS
string

UpdateDataPlaneRequest

The request payload to update a data-plane
Object
Name Description Type Attributes and examples
name The name string Required
Max length255
Example
dpe-data-plane
description The description string Required
Max length1024
Example
data-plane for QA
tags The tags ObjectOptional
aksAuditLoggingConf AksLoggingConf Optional
eksLoggingTypes array of LoggingType Optional
Datatype details
Type Description Attributes and examples
array The list of audit logs type for AWS
LoggingType

BootstrapCommand

The information to bootstrap a data-plane
Object
Name Description Type Attributes and examples
token The token string Optional
command The command to execute for custom and register data-plane to connect them to the control-plane string Optional
Example
command':'curl -fL https://controlplane.us.cloud.talend.com/system-agent-install.sh | sudo  sh -s - --server https://controlplane.us.cloud.talend.com/system-agent-install.sh--label 'cattle.io/os=linux' --token <some-token> --ca-checksum <some-checksum-value>

DataPlaneDetailsResponse

Describe a data-plane
Object
Name Description Type Attributes and examples
id The id string Required
name The name string Required
description The description string Optional
provider Provider Required
projectId The rancher project id string Optional
oneNodeDemo The demo flag to use single node boolean Optional
Defaulttrue
version The current version string Optional
Example
v1.21.5-3+83e2bb7ee39726
state The current state string Required
Enum
  • CREATING
  • CONNECTED
  • DISCONNECTED
  • ERROR
  • DELETED
statusDetails The details for the current status string Optional
bootstrapCommand BootstrapCommand Optional
tags The tags ObjectOptional
nodes array of DataPlaneNodeResponse Optional
Datatype details
Type Description Attributes and examples
array The list of nodes in the data-plane
DataPlaneNodeResponse
aksLoggingConf AksLoggingConf Optional
eksLoggingTypes array of LoggingType Optional
Datatype details
Type Description Attributes and examples
array The list of audit logs types for AWS
LoggingType
creationDate The creation date datetime Required
FormatRFC3339
lastModifiedDate The last modified date datetime Required
FormatRFC3339
lastModifiedStateDate The last state modified date datetime Required
FormatRFC3339
createdBy The user that created this data-plane string Required
lastModifiedBy The last user that modified this data-plane string Required

DataPlaneNodeResponse

The list of nodes in the data-plane
Object
Name Description Type Attributes and examples
name The name string Required
Example
c-pbcjh:m-4d3016ac4ea
roles array of string Required
Datatype details
Type Description Attributes and examples
array The roles
string The roles
address The internal address string Required
Example
127.0.0.0

Provider

The provider
string

AKSCreateDataPlaneRequest

The request payload to create an AKS data-plane on Azure
Object
Name Description Type Attributes and examples
name The name string Required
Max length255
Example
dpe-data-plane
provider Provider Required
description The description string Optional
Max length1024
tags The tags ObjectOptional
instanceType The type of instance string Required
Example
Standard_DS4_v2
nodeConfig NodeConfig Required
region The region of the cloud provider string Required
Example
us-west-1
credentialConfig AzureCredentialConfig Required
resourceGroupName The name of the resource group string Required
auditLoggingConf AksLoggingConf Optional
autoscalingEnabled The flag to enable autoscaling boolean Optional

AzureCredentialConfig

The cloud-credentials
Object
Name Description Type Attributes and examples
clientId The service principal id string Required
clientSecret The service principal secret string Required
subscriptionId The subscription id string Required

NodeConfig

The data-plane nodes configuration
Object
Name Description Type Attributes and examples
minSize The minimum number of nodes required in the Kubernetes cluster integer Optional
FormatINT32
maxSize The maximum number of nodes allowed in the Kubernetes cluster integer Optional
FormatINT32
diskSize The disk size in gigabytes to provision on each node integer Optional
FormatINT32

AWSCredentialConfig

The cloud-credentials
Object
Name Description Type Attributes and examples
accessKey The access key id string Required
secretKey The access key secret string Required

EKSCreateDataPlaneRequest

The request payload to create an EKS data-plane on AWS
Object
Name Description Type Attributes and examples
name The name string Required
Max length255
Example
dpe-data-plane
provider Provider Required
description The description string Optional
Max length1024
tags The tags ObjectOptional
instanceType The type of instance string Required
Example
t2.xlarge
nodeConfig NodeConfig Required
region The region of the cloud provider string Required
Example
us-west-1
credentialConfig AWSCredentialConfig Required
vpcConfig VpcConfig Required
eksLoggingTypes array of LoggingType Optional
Datatype details
Type Description Attributes and examples
array The list of audit logs type
LoggingType

VpcConfig

The virtual private cloud configuration
Object
Name Description Type Attributes and examples
subnetIds array of string Optional
Datatype details
Type Description Attributes and examples
array The subnets Ids as declared on AWS
Example
[
 "subnet-009923d802b73731b",
 "subnet-090afe49a5ea6b244",
]
string The subnets Ids as declared on AWS
Example
[
 "subnet-009923d802b73731b",
 "subnet-090afe49a5ea6b244",
]
securityGroupIds array of string Optional
Datatype details
Type Description Attributes and examples
array The security groups Ids as declared on AWS
string The security groups Ids as declared on AWS

CustomCreateDataPlaneRequest

The request payload to create a custom data-plane
Object
Name Description Type Attributes and examples
name The name string Required
Max length255
Example
dpe-data-plane
provider Provider Required
description The description string Optional
Max length1024
tags The tags ObjectOptional
distribution The distribution string Optional
Defaultrke2
Enum
  • rke2
  • k3s
oneNodeDemo The flag to enable one node demo mode boolean Optional
Defaulttrue

RegisterCreateDataPlaneRequest

The request payload to create a register data-plane
Object
Name Description Type Attributes and examples
name The name string Required
Max length255
Example
dpe-data-plane
provider Provider Required
description The description string Optional
Max length1024
tags The tags ObjectOptional

AddMemberRequest

Describe a request to add data-plane’s member
Object
Name Description Type Attributes and examples
duration The time in hour(s) before the member expire and get deleted integer Optional
Minimum1Maximum48
FormatINT32
Example
4
roleId The role the member will have on the data-plane string Required
description An optional description string Optional
Max length255
username An optional username, else one will be generated string Optional
Min length1Max length100

DataPlaneMember

Describe a member of a data-plane
Object
Name Description Type Attributes and examples
id The id string Required
username The username string Required
password The password string Optional
description The description string Optional
role The role string Required
expireAt The expiration date datetime Optional
FormatRFC3339

DataPlaneRole

The data-plane role a member can assume
Object
Name Description Type Attributes and examples
id The id string Optional
description The description string Optional

CloudProvidersProperties

Object
Name Description Type Attributes and examples
awsEks ProviderProperties Optional
azureAks ProviderProperties Optional
rke2 ProviderProperties Optional

ProviderProperties

Object
Name Description Type Attributes and examples
kubernetesVersion string Required
servicesDisabled array of string Optional
Datatype details
Type Description Attributes and examples
array
string
back to top↑