Skip to main content
logoTetrate Service BridgeVersion: 1.11.x

Sidecar Configuration

Sidecar Configuration represents boot configuration required to start a sidecar, e.g. Istio Sidecar.

Dir

Dir specifies a directory.

FieldDescriptionValidation Rule

path

string
REQUIRED
File path.

mode

int32
REQUIRED
File mode.

EnvVar

EnvVar specifies a single environment variable.

FieldDescriptionValidation Rule

name

string
REQUIRED
Name of the environment variable.

value

string
Value of the environment variable.

valueEquality

tetrateio.api.onboarding.private.types.sidecar.v1alpha1.ContentEquality
Strategy to compare two values for equality, e.g. old and new values of a environment variable.

File

File specifies a configuration file.

FieldDescriptionValidation Rule

path

string
REQUIRED
File path.

mode

int32
REQUIRED
File mode.

content

bytes
File content.

contentEquality

tetrateio.api.onboarding.private.types.sidecar.v1alpha1.ContentEquality
Strategy to compare two values for equality, e.g. old and new content of a configuration file.

reloadable

bool
Reloadable file.

SidecarConfiguration

SidecarConfiguration represents boot configuration of a sidecar, e.g. Istio Sidecar.

FieldDescriptionValidation Rule

seed

tetrateio.api.onboarding.private.types.sidecar.v1alpha1.SidecarConfigurationSeed oneof _kind
Seed configuration for the sidecar, e.g. Istio Sidecar.

update

tetrateio.api.onboarding.private.types.sidecar.v1alpha1.SidecarConfigurationUpdate oneof _kind
Update to the already known seed configuration that can be applied without a full restart of the sidecar, e.g. Istio Sidecar.

SidecarConfigurationSeed

SidecarConfigurationSeed represents seed configuration required to start a sidecar, e.g. Istio Sidecar.

FieldDescriptionValidation Rule

command

string
REQUIRED
Path to the sidecar executable, i.e. pilot-agent binary of the Istio Sidecar.

Notice that Workload Onboarding Agent is not expected to run this command "as is". Instead, Workload Onboarding Agent should use this value to identify which of (potentially many) executables comprising a sidecar it needs to run.

E.g., Istio Sidecar comes with pilot-agent, envoy and istio-start.sh executables. To clarify that Workload Onboarding Agent must use pilot-agent binary to start the sidecar, Workload Onboarding Plane will use a command value /usr/local/bin/pilot-agent.

args

List of string
Arguments to the sidecar command, e.g. Istio pilot-agent.

env

List of tetrateio.api.onboarding.private.types.sidecar.v1alpha1.EnvVar
Environment variables of the sidecar command, e.g. Istio pilot-agent.

files

List of tetrateio.api.onboarding.private.types.sidecar.v1alpha1.File
Configuration files of the sidecar, e.g. Istio pilot-agent.

dirs

List of tetrateio.api.onboarding.private.types.sidecar.v1alpha1.Dir
Directories required by the sidecar, e.g. Istio pilot-agent.

SidecarConfigurationUpdate

SidecarConfigurationUpdate represents an update to the already known seed configuration that can be applied without full restart of the sidecar.

FieldDescriptionValidation Rule

files

List of tetrateio.api.onboarding.private.types.sidecar.v1alpha1.File
Reloadable configuration files of the sidecar, e.g. Istio token file reloadable by the Istio pilot-agent.

ContentEquality

ContentEquality specifies a strategy to compare two text-like values for equality, e.g. old and new values of a certain configuration property.

FieldNumberDescription

BYTES

0

Compares two values as opaque byte arrays.

JSON

1

Compares two values as JSON values.