Registered Service

number

uint32
REQUIRED
A valid non-negative integer port number.

uint32 = {
  lte: 65535
  gte: 1
}

name

string
Name assigned to the port.

–

serviceDeployments

List of string
OUTPUT_ONLY
The list of FQNs of the instances that expose this port

–

fqn

string
OUTPUT_ONLY
Fully-qualified name of the resource. This field is read-only.

–

displayName

string
User friendly name for the resource.

–

etag

string
The etag for the resource. This field is automatically computed and must be sent on every update to the resource to prevent concurrent modifications.

–

description

string
A description of the resource.

–

shortName

string
REQUIRED
Short name for the service, used to uniquely identify it within the organization.

string = {
  min_len: 1
}

hostnames

List of string
The hostnames by which this service is accessed. Can correspond to the hostname of an internal service or that ones of a virtual host on a gateway.

–

ports

List of tetrateio.api.tsb.registry.v2.Port
The set of ports on which this service is exposed.

–

subsets

List of string
OUTPUT_ONLY
Deprecated. Use subset_deployments instead. Subset denotes a specific version of a service. By default the ‘version’ label is used to designate subsets of a workload. Known subsets for the service.

–

serviceType

tetrateio.api.tsb.registry.v2.ServiceType
REQUIRED
Internal/external/load balancer service.

enum = {
  defined_only: true
}

externalAddresses

List of string
For kubernetes services of type load balancer, this field contains the list of lb hostnames or IPs assigned to the service.

–

state

tetrateio.api.tsb.registry.v2.State
REQUIRED
State of the service (registered/observed/controlled)

enum = {
  defined_only: true
}

metrics

List of tetrateio.api.tsb.registry.v2.Service.MetricConfig
OUTPUT_ONLY
Services may expose different metrics. For example, a regular service may expose the usual red metrics for incoming requests. Services running in multiple clusters, may provide different aggregation levels, such as aggregation by cluster, by subset, etc. This list provides a complete list of all the aggregation keys that are available for this particular service. For example, a service that has instances in multiple clusters could provide the following metrics:

• global: |productpage|bookinfo||*
• v1: v1|productpage|bookinfo||
• v1 (cluster1): v1|productpage|bookinfo|cluster1|*

This is only available for Observed and Controlled services.

–

serviceDeployments

List of tetrateio.api.tsb.registry.v2.Service.ServiceDeployment
OUTPUT_ONLY
List of the existing deployments for this service. This is only available for internal and load balancer services and correspond to physical services in the onboarded clusters. This field is read-only.

–

subsetDeployments

List of tetrateio.api.tsb.registry.v2.Subset
OUTPUT_ONLY
Subset denotes a specific version of a service. By default the ‘version’ label is used to designate subsets of a workload. Known subsets for the service.

–

canonicalName

string
The canonical name of the service defined by user

–

spiffeIds

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

–

name

string
A user friendly name for this metric.

–

description

string
A helpful description of what this metric represents.

–

aggregationKey

string
An aggregation key that can be queried to get metrics for this service.

–

type

tetrateio.api.tsb.registry.v2.Service.MetricConfig.MetricType
Type of the metric (single_instance/aggregated).

–

serviceDeployment

string
The FQN of the service deployment related with this metric. Will be empty for group metrics.

–

parentMetric

string
The name of the metric config that aggregates this one in a higher level. For example, for a subset in a cluster metric, this field has the name of the metric of the same subset across the clusters

–

fqn

string
OUTPUT_ONLY
Fully-qualified name of the instance. This field is read-only.

–

source

string
OUTPUT_ONLY
Source of the instance. This field is read-only.

–

name

string
A valid subset name of a service.

–

serviceDeployments

List of string
OUTPUT_ONLY
The list of FQNs of the service deployments that expose this subset

–

INVALID

0

SINGLE_INSTANCE

1

A single instance metric config belongs to an specific physical service instance.

SUBSET

2

A subset metric config represents subsets across clusters or hostnames across clusters.

GLOBAL

3

A global metric config represents all the physical services.

ENDPOINT

4

An endpoint metric config represents an endpoint across clusters.

ENDPOINT_INSTANCE

5

An endpoint instance metric config represents an endpoint in a specific cluster.

INVALID_TYPE

0

INTERNAL

1

A regular service that is not directly exposed to the outside world.

LOADBALANCER

2

A load balancer service running only the proxy as the workload.

MESH_EXTERNAL

3

A mesh external service.

INVALID_STATE

0

EXTERNAL

1

An external service is a service that is known, but that cannot be observed (we can't get metrics for it) and cannot be controlled.

OBSERVED

2

An observed service is a known service that we can have metrics for. For example, a service running the Skywalking agents.

CONTROLLED

3

A controlled service is a service that is part of the mesh and has a proxy we can configure.