Skip to content

Commit 84792e3

Browse files
alaudazzithbkrkr
authored andcommitted
Improve operator config docs (#1980)
1 parent d664405 commit 84792e3

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

docs/operator-config.asciidoc

+18-18
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,31 @@ link:https://www.elastic.co/guide/en/cloud-on-k8s/master/k8s-operator-config.htm
44
****
55
endif::[]
66
[id="{p}-operator-config"]
7-
== Operator configuration
7+
== Configuring the operator
88

9-
The operator exposes several configuration options. Unless otherwise noted, they can be set as environment variables or command line flags.
9+
You can use several options to configure the operator. Unless otherwise noted, these options can be set as environment variables or command line flags.
1010

1111

1212
[width="70%",valign="middle",halign="center",options="header"]
1313
|==========================
1414
|Flag |Type|Default|Description
1515

16-
|log-verbosity |int |0 |Verbosity level of logs. -2=Error, -1=Warn, 0=Info, >0=Debug
17-
|enable-debug-logs |bool |false |Enables debug logs. Equivalent to `log-verbosity=1`
18-
|metrics-port |int |0 |Port to use for exposing metrics in the Prometheus format. Set 0 to disable
19-
|operator-roles |[]string |all |Roles this operator should assume. Valid values are namespace, global, webhook or all. Accepts multiple comma separated values. See <<{p}-ns-config>> for more information
20-
|namespace |string |`""` |Namespace in which this operator should manage resources. Defaults to all namespaces. See <<{p}-ns-config>> for more information
21-
|ca-cert-validity |duration (string) |1y |Duration representing how long before a newly created CA cert expires
22-
|ca-cert-rotate-before |duration (string) |1d |Duration representing how long before expiration CA certificates should be reissued
23-
|cert-validity |duration (string) |1y |Duration representing how long before a newly created TLS certificate expires
24-
|cert-rotate-before |duration (string) |1d |Duration representing how long before expiration TLS certificates should be reissued
25-
|auto-install-webhooks |bool |true |Enables automatic webhook installation
26-
|operator-namespace |string |`""` |K8s namespace the operator runs in
27-
|webhook-secret |string |`""` |K8s secret name mounted into /tmp/cert to be used for webhook certificates
28-
|webhook-pods-label |string |`""` |K8s label to select pods running the operator
29-
|development |bool |false |Enable developmenet mode. Only available as a CLI flag, not an environment variable
30-
|debug-http-listen |string |localhost:6060 |Listen address for the debug HTTP server. Only available in development mode
31-
|auto-port-forward |bool |false |Enables automatic port forwarding to allow running the operator outside the cluster. For dev use only as it exposes k8s resources on ephemeral ports to localhost
16+
|`log-verbosity` |int |0 |Verbosity level of logs. -2=Error, -1=Warn, 0=Info, >0=Debug
17+
|`enable-debug-logs` |bool |false |Enables debug logs. Equivalent to `log-verbosity=1`
18+
|`metrics-port` |int |0 |Port to use for exposing metrics in the Prometheus format. Set 0 to disable
19+
|`operator-roles` |[]string |all |Roles this operator should assume. Valid values are namespace, global, webhook or all. Accepts multiple comma separated values. See <<{p}-ns-config>> for more information
20+
|`namespace` |string |`""` |Namespace in which this operator should manage resources. Defaults to all namespaces. See <<{p}-ns-config>> for more information
21+
|`ca-cert-validity` |duration (string) |1y |Duration representing how long before a newly created CA cert expires
22+
|`ca-cert-rotate-before` |duration (string) |1d |Duration representing how long before expiration CA certificates should be reissued
23+
|`cert-validity` |duration (string) |1y |Duration representing how long before a newly created TLS certificate expires
24+
|`cert-rotate-before` |duration (string) |1d |Duration representing how long before expiration TLS certificates should be reissued
25+
|`auto-install-webhooks` |bool |true |Enables automatic webhook installation
26+
|`operator-namespace` |string |`""` |K8s namespace the operator runs in
27+
|`webhook-secret` |string |`""` |K8s secret name mounted into /tmp/cert to be used for webhook certificates
28+
|`webhook-pods-label` |string |`""` |K8s label to select pods running the operator
29+
|`development` |bool |false |Enable developmenet mode. Only available as a CLI flag, not an environment variable
30+
|`debug-http-listen` |string |localhost:6060 |Listen address for the debug HTTP server. Only available in development mode
31+
|`auto-port-forward` |bool |false |Enables automatic port forwarding to allow running the operator outside the cluster. For dev use only as it exposes k8s resources on ephemeral ports to localhost
3232
|==========================
3333

3434

0 commit comments

Comments
 (0)