tsb.tetrate.io/v2

Cluster

↩ Parent

Name	Type	Description	Required
apiVersion	string	tsb.tetrate.io/v2	true
kind	string	Cluster	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the metadata field.	true
spec	object	A Kubernetes cluster managing both pods and VMs.	false
status	object		false

Cluster.spec

↩ Parent

A Kubernetes cluster managing both pods and VMs.

Name	Type	Description	Required
description	string	A description of the resource.	false
displayName	string	User friendly name for the resource.	false
etag	string	The etag for the resource.	false
fqn	string	Fully-qualified name of the resource.	false
labels	map[string]string		false
locality	object	Location information about the cluster which can be used for routing.	false
namespaceScope	object	Configure the default scoping of namespaces in this cluster.	false
namespaces	[]object		false
network	string	The network (e.g., VPC) where this cluster is present.	false
state	object		false
tier1Cluster	boolean	Indicates whether this cluster is hosting a tier1 gateway or not.	false
tokenTtl	string	Lifetime of the tokens.	false
trustDomain	string	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.

Name	Type	Description	Required
region	string	The geographic location of the cluster.	false

Cluster.spec.namespaceScope

↩ Parent

Configure the default scoping of namespaces in this cluster.

Name	Type	Description	Required
exceptions	[]string	Namespaces to be excluded form the default scope.	false
scope	enum	Enum: GLOBAL, LOCAL	false

Cluster.spec.namespaces[index]

↩ Parent

Name	Type	Description	Required
name	string		false
services	[]object		false

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

↩ Parent

Name	Type	Description	Required
canonicalName	string		false
gatewayHost	boolean		false
hostname	string	The hostname by which this service is accessed.	false
kubernetesExternalAddresses	[]string		false
kubernetesServiceFqdn	string		false
kubernetesServiceIp	string		false
meshExternal	boolean		false
name	string		false
namespace	string	namespace associated with the service.	false
numHops	integer	Minimum: 0 Maximum: 4.294967295e+09	false
numKubernetesEndpoints	integer	The number of kubernetes pods providing this service. Minimum: 0 Maximum: 4.294967295e+09	false
numVmEndpoints	integer	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
selector	map[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
tier1GatewayHost	boolean		false
workloads	[]object	Workloads implementing the Service.	false

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

↩ Parent

Name	Type	Description	Required
kubernetesNodePort	integer	Minimum: 0 Maximum: 4.294967295e+09	false
name	string	Name assigned to the port.	false
number	integer	A valid non-negative integer port number. Minimum: 0 Maximum: 4.294967295e+09	false

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

↩ Parent

Name	Type	Description	Required
address	string	Routable address of the workload.	false
isVm	boolean	Indicates whether the workload is kubernetes endpoint or vm.	false
name	string	Instance name of the workload.	false
proxy	object	Proxy details.	false

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

↩ Parent

Proxy details.

Name	Type	Description	Required
controlPlaneAddress	string		false
envoyVersion	string	Envoy version of the proxy.	false
istioVersion	string	Istio version of the proxy.	false
status	map[string]string	Sync status for each xDS component.	false

Cluster.spec.state

↩ Parent

Name	Type	Description	Required
istioVersions	[]string	This shows currently running istio versions in the cluster.	false
lastSyncTime	string	Format: date-time	false
provider	string	cluster provider.	false
tsbCpVersion	string		false
xcpVersion	string		false