Skip to main content
logoTetrate Service BridgeVersion: 1.11.x

Cluster Service

Service to manage clusters onboarded in TSB.

Clusters​

The Clusters service exposes methods to manage the registration of clusters that are managed by TSB. Before TSB can takeover networking for a given cluster, it must be onboarded in the platform. This onboarding process usually involves two steps:

  1. Creating the cluster object so the platform knows about it.
  2. Generate the agent tokens for the cluster, so the TSB agents installed in the actual cluster can talk to TSB.

Once a cluster has been onboarded into TSB, it will start receiving configuration updates from the management plane, and the agents will keep the management updated with the status of the cluster.

CreateCluster​

GetCluster​

UpdateCluster​

ListClusters​

DeleteCluster​

GenerateTokens​

CreateClusterOnboardingConfig​

GetClusterOnboardingConfig​

ListClusterOnboardingConfigs​

UpdateClusterOnboardingConfig​

DeleteClusterOnboardingConfig​

GetClusterOnboardingStatus​

CreateClusterOnboardingConfigRequest​

Request to create the cluster onboarding configuration for a cluster.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Fully-qualified name of the cluster.

string = {
  min_len: 1
}

name

string
REQUIRED
The short name for the cluster onboarding config to be created.

string = {
  min_len: 1
  max_len: 63
  pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
}

config

tetrateio.api.tsb.v2.ClusterOnboardingConfig
REQUIRED
the cluster onboarding configuration to be created.

message = {
  required: true
}

CreateClusterRequest​

Request to create a cluster and register it in the management plane so configuration can be generated for it.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource where the cluster will be created. This is the FQN of the organization or the tenant.

string = {
  min_len: 1
}

name

string
REQUIRED
The short name for the resource to be created.

string = {
  min_len: 1
  max_len: 63
  pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
}

cluster

tetrateio.api.tsb.v2.Cluster
REQUIRED
Details of the cluster to be created.

message = {
  required: true
}

DeleteClusterOnboardingConfigRequest​

Request to delete the cluster onboarding configuration for a cluster.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the cluster onboarding config.

string = {
  min_len: 1
}

DeleteClusterRequest​

Request to delete a cluster.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the cluster.

string = {
  min_len: 1
}

GenerateTokensRequest​

Request to generate the cluster agent tokens.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the cluster.

string = {
  min_len: 1
}

GetClusterOnboardingConfigRequest​

Request to get the cluster onboarding configuration for a cluster.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the cluster.

string = {
  min_len: 1
}

GetClusterOnboardingStatusRequest​

Request to get the onboarding status for a cluster.

FieldDescriptionValidation Rule

cluster

string
REQUIRED
Fully-qualified name of the cluster.

string = {
  min_len: 1
}

GetClusterRequest​

Request to retrieve a cluster.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the cluster.

string = {
  min_len: 1
}

fetchWorkloads

bool
Flag to fetch the workload information as well. Note that by default workload information is not returned as it may be expensive to retrieve.

–

includeInstallTemplate

bool
Flag to return the install template required to install this cluster. This will generate a new API key pair for the cluster service account.

–

ListClusterOnboardingConfigsRequest​

Request to list the cluster onboarding configurations for a cluster.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Fully-qualified name of the cluster.

string = {
  min_len: 1
}

ListClusterOnboardingConfigsResponse​

List of onboarding configurations for a cluster.

FieldDescriptionValidation Rule

configs

List of tetrateio.api.tsb.v2.ClusterOnboardingConfig
The list of onboarding configurations for the cluster.

–

ListClustersRequest​

Request to list clusters.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list clusters from. This is the FQN of the organization or the tenant.

string = {
  min_len: 1
}

fetchWorkloads

bool
Flag to fetch the workload information for all the clusters as well. Note that by default workload information is not returned as it may be expensive to retrieve.

–

ListClustersResponse​

List of clusters that are registered in the platform.

FieldDescriptionValidation Rule

clusters

List of tetrateio.api.tsb.v2.Cluster
The list of clusters that are registered in the platform.

–