EnvoyConfiguration

microgateway.airlock.com/v1alpha1


EnvoyConfiguration represents the raw configuration of an Airlock Microgateway Engine.

Warning

EnvoyConfiguration resources may contain sensitive information and thus RBAC permissions should be granted with care.

Note

This CRD is used for internal purposes. EnvoyConfiguration resources are not intended to be manually created, modified or deleted by the user.

EnvoyConfiguration

Field Description Type Required Default Allowed Values
metadata defines the resource’s metadata ObjectMeta yes
spec defines the envoy configuration. object no
status describes the current status of the EnvoyConfiguration. object no

EnvoyConfiguration.spec

Field Description Type Required Default Allowed Values
envoyResourcesRaw defines the desired state for each resource type. The resources are stored as zstd compressed JSON bytes.
For debugging purposes, the resources can be inspected with the following command: kubectl get envoyconfiguration <name> -ojsonpath='{.spec.envoyResourcesRaw}' | base64 -d | zstd -d | jq
string no

EnvoyConfiguration.status

Field Description Type Required Default Allowed Values
conditions describe the status of the EnvoyConfiguration. Condition[] no
status indicates the overall status of the EnvoyConfiguration. enum no Active, Error, Warning
xds describes the current xDS status for this EnvoyConfiguration. object no

EnvoyConfiguration.status.xds

Field Description Type Required Default Allowed Values
resourceTypes describes the synchronization status for each resource type. map[string]object no
version indicates the xDS snapshot version. int64 yes [-9223372036854775808, 9223372036854775807]

EnvoyConfiguration.status.xds.resourceTypes{}

Field Description Type Required Default Allowed Values
errorMessage indicates the error message provided by the Airlock Microgateway Engine in case the currently served resource version has been rejected. string no
resources which are currently served for this resource type. map[string]object yes
status describes the synchronization status for this resource type. string yes Accepted, NotRequested, Pending, Rejected, Sent
version which is currently served for this resource type. string yes

EnvoyConfiguration.status.xds.resourceTypes{}.resources{}

Field Description Type Required Default Allowed Values
version defines the version which is currently served for this resource. string yes