Skip to main content
logoTetrate Service BridgeVersion: 1.6.x

tsb.tetrate.io/v2

Cluster

↩ Parent

NameTypeDescriptionRequired
apiVersionstringtsb.tetrate.io/v2true
kindstringClustertrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the metadata field.true
specobject

A Kubernetes cluster managing both pods and VMs.

false
statusobject
false

Cluster.spec

↩ Parent

A Kubernetes cluster managing both pods and VMs.

NameTypeDescriptionRequired
descriptionstring

A description of the resource.

false
displayNamestring

User friendly name for the resource.

false
etagstring

The etag for the resource.

false
fqnstring

Fully-qualified name of the resource.

false
labelsmap[string]string
false
localityobject

Location information about the cluster which can be used for routing.

false
namespaceScopeobject

Configure the default scoping of namespaces in this cluster.

false
namespaces[]object
false
networkstring

The network (e.g., VPC) where this cluster is present.

false
stateobject
false
tier1Clusterboolean

Indicates whether this cluster is hosting a tier1 gateway or not.

false
tokenTtlstring

Lifetime of the tokens.

false
trustDomainstring

Trust domain for this cluster, used for multi-cluster routing.

false

Cluster.spec.locality

↩ Parent

Location information about the cluster which can be used for routing.

NameTypeDescriptionRequired
regionstring

The geographic location of the cluster.

false

Cluster.spec.namespaceScope

↩ Parent

Configure the default scoping of namespaces in this cluster.

NameTypeDescriptionRequired
exceptions[]string

Namespaces to be excluded form the default scope.

false
scopeenum

Enum: GLOBAL, LOCAL

false

Cluster.spec.namespaces[index]

↩ Parent

NameTypeDescriptionRequired
namestring
false
services[]object
false

Cluster.spec.namespaces[index].services[index]

↩ Parent

NameTypeDescriptionRequired
canonicalNamestring
false
gatewayHostboolean
false
hostnamestring

The hostname by which this service is accessed.

false
kubernetesExternalAddresses[]string
false
kubernetesServiceFqdnstring
false
kubernetesServiceIpstring
false
meshExternalboolean
false
namestring
false
namespacestring

namespace associated with the service.

false
numHopsinteger

Minimum: 0
Maximum: 4.294967295e+09

false
numKubernetesEndpointsinteger

The number of kubernetes pods providing this service.


Minimum: 0
Maximum: 4.294967295e+09

false
numVmEndpointsinteger

The number of VMs providing this service.


Minimum: 0
Maximum: 4.294967295e+09

false
ports[]object

The set of ports on which this service is exposed.

false
selectormap[string]string

label selectors associated with the service.

false
spiffeIds[]string

List of SPIFFE identities used by the workloads of the service.

false
subsets[]string
false
tier1GatewayHostboolean
false
workloads[]object

Workloads implementing the Service.

false

Cluster.spec.namespaces[index].services[index].ports[index]

↩ Parent

NameTypeDescriptionRequired
kubernetesNodePortinteger

Minimum: 0
Maximum: 4.294967295e+09

false
namestring

Name assigned to the port.

false
numberinteger

A valid non-negative integer port number.


Minimum: 0
Maximum: 4.294967295e+09

false

Cluster.spec.namespaces[index].services[index].workloads[index]

↩ Parent

NameTypeDescriptionRequired
addressstring

Routable address of the workload.

false
isVmboolean

Indicates whether the workload is kubernetes endpoint or vm.

false
namestring

Instance name of the workload.

false
proxyobject

Proxy details.

false

Cluster.spec.namespaces[index].services[index].workloads[index].proxy

↩ Parent

Proxy details.

NameTypeDescriptionRequired
controlPlaneAddressstring
false
envoyVersionstring

Envoy version of the proxy.

false
istioVersionstring

Istio version of the proxy.

false
statusmap[string]string

Sync status for each xDS component.

false

Cluster.spec.state

↩ Parent

NameTypeDescriptionRequired
istioVersions[]string

This shows currently running istio versions in the cluster.

false
lastSyncTimestring

Format: date-time

false
providerstring

cluster provider.

false
tsbCpVersionstring
false
xcpVersionstring
false