OperatorConfig
config.airlock.com/v1alpha1
OperatorConfig is the schema for the Airlock Microgateway Operator configuration file
apiVersion: config.airlock.com/v1alpha1
kind: OperatorConfig
...
apiVersion: config.airlock.com/v1alpha1
kind: OperatorConfig
deployment:
sidecar:
engineContainerTemplate: "/sidecar/engine_container_template.yaml"
networkManagerContainerTemplate: "/sidecar/network_manager_container_template.yaml"
engine:
bootstrapConfigTemplate: "/engine_bootstrap_config_template.yaml"
xdsServer:
port: 13377
grpcSettings:
maxConcurrentStreams: 4294967295
keepaliveTime: "2h"
keepaliveTimeout: "20s"
keepaliveClientMinTime: "5m"
log:
level: info
licensing:
throughputCheckTimeout: "50ms"
OperatorConfig
Field | Type | Description | Required | Default | Allowed Values |
---|---|---|---|---|---|
deployment | object | Deployment defines the configuration for the deployment strategy. | no | ||
engine | object | Engine defines the configuration for the engine container. | no | ||
licensing | object | Licensing defines the licensing options of the operator and engine. | no | ||
log | object | Log defines the log configuration of the operator. | no | ||
xdsServer | object | XdsServer defines the configuration for the xDS server which communicates with the Airlock Microgateway Engine. | no |
OperatorConfig.deployment
Field | Type | Description | Required | Default | Allowed Values |
---|---|---|---|---|---|
sidecar | object | Sidecar defines the configuration for the sidecar deployment. | no |
OperatorConfig.deployment.sidecar
Field | Type | Description | Required | Default | Allowed Values |
---|---|---|---|---|---|
engineContainerTemplate |
string | Defines the container which will be injected as sidecar. Can be useful to adjust the image, imagePullPolicy, capabilities or other settings. For more information please visit the official Kubernetes documentation website. | no | /sidecar/engine_container_template.yaml |
|
networkManagerContainerTemplate |
string | Defines the init container which will be injected in Pod. Can be useful to adjust the image, imagePullPolicy, capabilities or other settings. For more information, please visit the official Kubernetes documentation website. | no | /sidecar/network_manager_container_template.yaml |
OperatorConfig.engine
Field | Type | Description | Required | Default | Allowed Values |
---|---|---|---|---|---|
bootstrapConfigTemplate |
string | Defines the Envoy bootstrap configuration. For more information, please visit the official Envoy documentation website. | no | /engine_bootstrap_config_template.yaml |
OperatorConfig.licensing
Field | Type | Description | Required | Default | Allowed Values |
---|---|---|---|---|---|
throughputCheckTimeout |
string (duration) | ThroughputCheckTimeout specifies the timeout for the license ratelimit RPCs. If the license guard does not respond within this window, the request will be blocked unless enforceThroughputLimit is disabled. | no | 50ms |
See link |
OperatorConfig.log
Field | Type | Description | Required | Default | Allowed Values |
---|---|---|---|---|---|
level |
enum | Level defines the log level of the operator. | no | info |
error , warn , info , debug |
OperatorConfig.xdsServer
Field | Type | Description | Required | Default | Allowed Values |
---|---|---|---|---|---|
grpcSettings | object | Defines the gRPC Settings which are used by the xDS Server for the gRPC connections with the Airlock Microgateway Engine containers. | no | ||
port |
int32 | Defines the port where the xDS server is listening. | no | 13377 |
[1, 65535] |
OperatorConfig.xdsServer.grpcSettings
Field | Type | Description | Required | Default | Allowed Values |
---|---|---|---|---|---|
keepaliveClientMinTime |
string (duration) | Defines the minimum amount of time an Airlock Microgateway Engine (xDS client) should wait before sending a keepalive ping. The Airlock Microgateway Operator (xDS server) will close connection with a client that violates this policy. | no | 5m |
See link |
keepaliveTime |
string (duration) | Defines the keep alive time. After this time without any activity from Airlock Microgateway Engine container a ping is sent to see if the transport is still alive. If set below 1s, a minimum value of 1s will be used instead. | no | 2h |
See link |
keepaliveTimeout |
string (duration) | Defines the keep alive timeout. Time to wait after keepalive check before closing the connection in case that there was no activity. | no | 20s |
See link |
maxConcurrentStreams |
uint32 | Defines the limit of max concurrent gRPC streams. | no | 4294967295 |
[0, 4294967295] |