Skip to main content
logoTetrate Service BridgeVersion: 1.4.x

Workload Registration

Workload Registration specifies information sent by the Workload Onboarding Agent to the Workload Onboarding Plane to register the workload in the mesh.

Address

Address specifies network address.

FieldDescriptionValidation Rule

ip

string
REQUIRED
IP address.

string = {
  ip: true
}

type

tetrateio.api.onboarding.config.types.registration.v1alpha1.AddressType
REQUIRED
Address type.

enum = {
  not_in: 0
}

AgentInfo

AgentInfo specifies information about the Workload Onboarding Agent installed alongside the workload.

FieldDescriptionValidation Rule

version

string
REQUIRED
Version of the Workload Onboarding Agent.

string = {
  min_len: 1
}

HostInfo

HostInfo specifies information about the host the workload is running on.

FieldDescriptionValidation Rule

addresses

List of tetrateio.api.onboarding.config.types.registration.v1alpha1.Address
REQUIRED
Network addresses of the host the workload is running on.

repeated = {
  min_items: 1
  items: {message:{required:true}}
}

IstioSidecarInfo

IstioInfo specifies information about the Istio Sidecar installed alongside the workload.

FieldDescriptionValidation Rule

version

string
REQUIRED
Version of the Istio Sidecar.

string = {
  min_len: 1
}

Registration

Registration specifies information sent by the Workload Onboarding Agent to the Workload Onboarding Plane to register the workload in the mesh.

FieldDescriptionValidation Rule

agent

tetrateio.api.onboarding.config.types.registration.v1alpha1.AgentInfo
REQUIRED
Information about the Workload Onboarding Agent installed alongside the workload.

message = {
  required: true
}

sidecar

tetrateio.api.onboarding.config.types.registration.v1alpha1.SidecarInfo
REQUIRED
Information about the sidecar installed alongside the workload.

message = {
  required: true
}

host

tetrateio.api.onboarding.config.types.registration.v1alpha1.HostInfo
REQUIRED
Information about the host the workload is running on.

message = {
  required: true
}

workload

tetrateio.api.onboarding.config.types.registration.v1alpha1.WorkloadInfo
Information about the workload.

settings

tetrateio.api.onboarding.config.types.registration.v1alpha1.Settings
Registration settings.

Settings

Settings specifies registration settings.

FieldDescriptionValidation Rule

connectedOver

tetrateio.api.onboarding.config.types.registration.v1alpha1.AddressType
ConnectedOver specifies how the workload is connected to the mesh, i.e. over VPC or over Internet. When unspecified, workload is assumed connected to the mesh over VPC.

SidecarInfo

SidecarInfo specifies information about the sidecar installed alongside the workload.

FieldDescriptionValidation Rule

istio

tetrateio.api.onboarding.config.types.registration.v1alpha1.IstioSidecarInfo oneof kind
Information about the Istio Sidecar installed alongside the workload.

WorkloadInfo

WorkloadInfo specifies information about the workload.

FieldDescriptionValidation Rule

labels

map<string, string>
Labels associated with the workload.

AddressType

AddressType specifies type of a network address associated with the workload.

FieldNumberDescription

UNSPECIFIED

0

Not specified.

VPC

1

IP address from the VPC range. Commonly referred to as Private IP or Internal IP.

INTERNET

2

IP address from the Internet range. Commonly referred to as Public IP or External IP.