You are browsing documentation for an older version. See the latest documentation here.

CLI Arguments

Learn about the various settings and configurations of the controller can be tweaked using CLI flags.

Environment variables

Each flag defined in the table below can also be configured using an environment variable. The name of the environment variable is GATEWAY_OPERATOR_ string followed by the name of flag in uppercase.

For example, --enable-gateway-controller can be configured using the following environment variable:

GATEWAY_OPERATOR_ENABLE_GATEWAY_CONTROLLER=false

It is recommended that all the configuration is done through environment variables and not CLI flags.

Flags

Flag	Type	Description	Default
`--anonymous-reports`	`bool`	Send anonymized usage data to help improve Kong.	`true`
`--apiserver-host`	`string`	The Kubernetes API server URL. If not set, the operator will use cluster config discovery.	`""`
`--cluster-ca-secret`	`string`	Name of the Secret containing the cluster CA certificate.	`kong-operator-ca`
`--cluster-ca-secret-namespace`	`string`	Name of the namespace for Secret containing the cluster CA certificate.	`""`
`--controller-name`	`string`	Controller name to use if other than the default, only needed for multi-tenancy.	`""`
`--enable-controller-aigateway`	`bool`	Enable the AIGateway controller. (Experimental).	`false`
`--enable-controller-controlplane`	`bool`	Enable the ControlPlane controller.	`true`
`--enable-controller-controlplaneextensions`	`bool`	Enable the ControlPlane extensions controller.	`true`
`--enable-controller-dataplane`	`bool`	Enable the DataPlane controller.	`true`
`--enable-controller-dataplane-bluegreen`	`bool`	Enable the DataPlane BlueGreen controller. Mutually exclusive with DataPlane controller.	`true`
`--enable-controller-gateway`	`bool`	Enable the Gateway controller.	`true`
`--enable-controller-konglicense`	`bool`	Enable the Kong License controller.	`true`
`--enable-validating-webhook`	`bool`	Enable the validating webhook.	`true`
`--health-probe-bind-address`	`string`	The address the probe endpoint binds to.	`:8081`
`--kubeconfig`	`string`	Path to the kubeconfig file.	`""`
`--metrics-bind-address`	`string`	The address the metric endpoint binds to.	`:8080`
`--no-leader-election`	`bool`	Disable leader election for controller manager. Disabling this will not ensure there is only one active controller manager.	`false`
`--version`	`bool`	Print version information.	`false`
`--zap-devel`	`bool`	Development Mode defaults(encoder=consoleEncoder,logLevel=Debug,stackTraceLevel=Warn). Production Mode defaults(encoder=jsonEncoder,logLevel=Info,stackTraceLevel=Error).	`false`
`--zap-encoder`	`string`	Zap log encoding (one of ‘json’ or ‘console’).	`""`
`--zap-log-level`	`string`	Zap Level to configure the verbosity of logging. Can be one of ‘debug’, ‘info’, ‘error’, or any integer value > 0 which corresponds to custom debug levels of increasing verbosity.	`""`
`--zap-stacktrace-level`	`string`	Zap Level at and above which stacktraces are captured (one of ‘info’, ‘error’, ‘panic’).	`""`
`--zap-time-encoding`	`string`	Zap time encoding (one of ‘epoch’, ‘millis’, ‘nano’, ‘iso8601’, ‘rfc3339’ or ‘rfc3339nano’). Defaults to ‘epoch’.	`""`