Skip to main content
logoTetrate Service BridgeVersion: 1.9.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.

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
}

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
}

revision

string
Istio revision the pre-installed Istio Sidecar corresponds to.

E.g., canary, alpha, etc.

If omitted, it is assumed that the pre-installed Istio Sidecar corresponds to the default Istio revision.

Notice that the value constraints here are stricter than the ones in Istio. Apparently, Istio validation rules allow values that lead to internal failures at runtime, e.g. values with capital letters or values longer than 56 characters. Stricter validation rules here are meant to prevent those hidden pitfalls.

string = {
  min_len: 1
  max_len: 56
  pattern: ^[a-z0-9](?:[-a-z0-9]*[a-z0-9])?$
  ignore_empty: true
}

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.