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:
- Creating the cluster object so the platform knows about it.
- 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
CreateClusterRequest #
Request to create a cluster and register it in the management plane so configuration can be generated for it.
Field | Description | Validation Rule |
---|---|---|
parent | string | string = { |
name | string | string = { |
cluster | tetrateio.api.tsb.v2.Cluster | message = { |
DeleteClusterRequest #
Request to delete a cluster.
Field | Description | Validation Rule |
---|---|---|
fqn | string | string = { |
GenerateTokensRequest #
Request to generate the cluster agent tokens.
Field | Description | Validation Rule |
---|---|---|
fqn | string | string = { |
GetClusterRequest #
Request to retrieve a cluster.
Field | Description | Validation Rule |
---|---|---|
fqn | string | string = { |
fetchWorkloads | bool | – |
includeInstallTemplate | bool | – |
ListClustersRequest #
Request to list clusters.
Field | Description | Validation Rule |
---|---|---|
parent | string | string = { |
fetchWorkloads | bool | – |
ListClustersResponse #
List of clusters that are registered in the platform.
Field | Description | Validation Rule |
---|---|---|
clusters | List of tetrateio.api.tsb.v2.Cluster | – |