Add operator config reference #1798
Conversation
| |Flag |Type|Default|Description | ||
|
|
||
| |log-verbosity |int |0 |Verbosity level of logs. -2=Error, -1=Warn, 0=Info, >0=Debug | ||
| |enable-debug-logs |bool |false |Enables debug logs. Equivalent to `log-verbosity=1` |
There was a problem hiding this comment.
Unrelated to that PR: that 2nd option and the first one feel weird. Looks like the first option would be enough? I don't remember if this is something we discussed @charith-elastic?
There was a problem hiding this comment.
@david-kow raised it in the original PR but we didn't really go into detail, might be worth revisiting
#1699 (comment)
docs/operator-config.asciidoc
Outdated
| |log-verbosity |int |0 |Verbosity level of logs. -2=Error, -1=Warn, 0=Info, >0=Debug | ||
| |enable-debug-logs |bool |false |Enables debug logs. Equivalent to `log-verbosity=1` | ||
| |metrics-port |int |0 |Port to use for exposing metrics in the Prometheus format. Set 0 to disable | ||
| |operator-roles |[]string |all |Roles this operator should assume. Valid values are namespace, global, webhook or all |
There was a problem hiding this comment.
I think this needs a bit more explanation, maybe in a separate paragraph outside of this table. E.g. its important to note that namespace is not the same as a setting --namespace=my-ns and global will not give you a fully working operator (unless combined with another instance running with --operator-roles=namespace.
Even more counterintuitively if you want to restrict the operator to one namespace you have to run it with --operator-roles=global,namespace --namespace=my-namespace (excluding the webhook role because I assume in single namespace mode the operator won't have permissions to register webhooks)
Finally in all likelyhood for the next release webhook will be effectively a NOOP (unless we fix the webhooks in #1769 )
There was a problem hiding this comment.
Finally in all likelyhood for the next release webhook will be effectively a NOOP (unless we fix the webhooks in #1769 )
I figured I would at least document it as our desired state and we can modify it as needed
docs/operator-config.asciidoc
Outdated
| |log-verbosity |int |0 |Verbosity level of logs. -2=Error, -1=Warn, 0=Info, >0=Debug | ||
| |enable-debug-logs |bool |false |Enables debug logs. Equivalent to `log-verbosity=1` | ||
| |metrics-port |int |0 |Port to use for exposing metrics in the Prometheus format. Set 0 to disable | ||
| |operator-roles |[]string |all |Roles this operator should assume. Valid values are namespace, global, webhook or all |
There was a problem hiding this comment.
nit: not sure that it's obvious for everyone that it could be some comma separated values (e.g. --operator-roles=global,namespace)
docs/operator-config.asciidoc
Outdated
|
|
||
| |log-verbosity |int |0 |Verbosity level of logs. -2=Error, -1=Warn, 0=Info, >0=Debug | ||
| |enable-debug-logs |bool |false |Enables debug logs. Equivalent to `log-verbosity=1` | ||
| |metrics-port |int |0 |Port to use for exposing metrics in the Prometheus format. Set 0 to disable |
There was a problem hiding this comment.
Default metric port is 8080, it means that it is enabled by default:
cloud-on-k8s/cmd/manager/main.go
Line 48 in 8f7265b
|
@pebrc can you take a look at the extra paragraph? It might need even more information |
Related: #1379
Adds reference documentation for operator configuration options. Deeeeefinitely open to presentation and wording feedback