Skip to main content
Version: 1.5.x

Servive Registry Registration Service

Registration​

The service registration API allows to manage the services that exist in the catalog. It exposes methods to register and unregister individual services as well as methods to keep all the services in a given cluster in sync.

ListServices​

rpc ListServices (tetrateio.api.tsb.registry.v2.ListServicesRequest) returns (tetrateio.api.tsb.registry.v2.ListServicesResponse)

List the services that have been registered in an organization

GetService​

rpc GetService (tetrateio.api.tsb.registry.v2.GetServiceRequest) returns (tetrateio.api.tsb.registry.v2.Service)

Requires ReadRegisteredService

Get the details of a registered service

GetServiceRequest​

Request to retrieve a registered service.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the registered service.

string = {
  min_len: 1
}

ListServicesRequest​

Request to list registered services.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list registered services from.

string = {
  min_len: 1
}

ListServicesResponse​

Response with a list of registered services

FieldDescriptionValidation Rule

services

List of tetrateio.api.tsb.registry.v2.Service
The requested registered services

–

RegisterServiceRequest​

Request to register a service in a given parent (organization).

FieldDescriptionValidation Rule

parent

string
REQUIRED
Organization where the service will be registered

string = {
  min_len: 1
}

cluster

string
REQUIRED
Name of the cluster where the service belongs to. This will be used to load the deduplication settings that have been configured for the cluster where the service belongs.

string = {
  min_len: 1
}

shortName

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

string = {
  min_len: 1
}

namespace

string
REQUIRED
Namespace associated with the service. It will be used in deduplication logic.

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
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
}

source

string
REQUIRED
Source of the service: Kubernetes, Istio, Consul, etc.

string = {
  min_len: 1
}

canonicalName

string
optional canonical name that identify this service.

–

spiffeIds

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

–

UnregisterServiceRequest​

Request to unregister a service from the registry

FieldDescriptionValidation Rule

parent

string
REQUIRED
Organization from where the service will be unregistered

string = {
  min_len: 1
}

shortName

string
REQUIRED
Name attribute of the service

string = {
  min_len: 1
}

cluster

string
REQUIRED
Name of the cluster of the service.

string = {
  min_len: 1
}

namespace

string
REQUIRED
Namespace of the service.

string = {
  min_len: 1
}