coreos/prometheus-operator
1
0
Fork 0
mirror of https://github.com/coreos/prometheus-operator.git synced 2026-02-05 06:45:27 +01:00
Code Issues Releases Wiki Activity
Files
34941afa1a70f1819df92fd78b97c429f2ef58d1
prometheus-operator/Documentation/operator.md
Simon Pasquier 5e9eed43e4 chore: reduce code duplication in components 
* Share parsing for the logging flags across all binaries.
* Refactor and share the web server implementation between the operator
  and the admission webhook.
* Refactor controller configuration structs to include only the required
  parameters.
* Parse label and field selector arguments early instead of doing it in
  each controller.

Signed-off-by: Simon Pasquier <spasquie@redhat.com>
2023-11-16 14:42:28 +01:00

107 lines
6.2 KiB
Markdown
Raw Blame History

---
weight: 212
toc: false
title: CLI reference
menu:
docs:
parent: operator
lead: Command line arguments for the operator binary
images: []
draft: false
description: Command line arguments for the operator binary
---
> Note this document is automatically generated from the `cmd/operator/main.go` file and shouldn't be edited directly.
```console mdox-exec="./operator --help"
Usage of ./operator:
-alertmanager-config-namespaces value
Namespaces where AlertmanagerConfig custom resources and corresponding Secrets are watched/created. If set this takes precedence over --namespaces or --deny-namespaces for AlertmanagerConfig custom resources.
-alertmanager-default-base-image string
Alertmanager default base image (path without tag/version) (default "quay.io/prometheus/alertmanager")
-alertmanager-instance-namespaces value
Namespaces where Alertmanager custom resources and corresponding StatefulSets are watched/created. If set this takes precedence over --namespaces or --deny-namespaces for Alertmanager custom resources.
-alertmanager-instance-selector value
Label selector to filter Alertmanager Custom Resources to watch.
-annotations value
Annotations to be add to all resources created by the operator
-apiserver string
API Server addr, e.g. ' - NOT RECOMMENDED FOR PRODUCTION - http://127.0.0.1:8080'. Omit parameter to run in on-cluster mode and utilize the service account token.
-as string
Username to impersonate. User could be a regular user or a service account in a namespace.
-ca-file string
- NOT RECOMMENDED FOR PRODUCTION - Path to TLS CA file.
-cert-file string
- NOT RECOMMENDED FOR PRODUCTION - Path to public TLS certificate file.
-cluster-domain string
The domain of the cluster. This is used to generate service FQDNs. If this is not specified, DNS search domain expansion is used instead.
-config-reloader-cpu-limit value
Config Reloader CPU limits. Value "0" disables it and causes no limit to be configured. (default 10m)
-config-reloader-cpu-request value
Config Reloader CPU requests. Value "0" disables it and causes no request to be configured. (default 10m)
-config-reloader-memory-limit value
Config Reloader memory limits. Value "0" disables it and causes no limit to be configured. (default 50Mi)
-config-reloader-memory-request value
Config Reloader memory requests. Value "0" disables it and causes no request to be configured. (default 50Mi)
-deny-namespaces value
Namespaces not to scope the interaction of the Prometheus Operator (deny list). This is mutually exclusive with --namespaces.
-enable-config-reloader-probes
Enable liveness and readiness for the config-reloader container. Default: false
-key-file string
- NOT RECOMMENDED FOR PRODUCTION - Path to private TLS certificate file.
-kubelet-selector value
Label selector to filter nodes.
-kubelet-service string
Service/Endpoints object to write kubelets into in format "namespace/name"
-labels value
Labels to be add to all resources created by the operator
-localhost string
EXPERIMENTAL (could be removed in future releases) - Host used to communicate between local services on a pod. Fixes issues where localhost resolves incorrectly. (default "localhost")
-log-format string
Log format to use. Possible values: logfmt, json (default "logfmt")
-log-level string
Log level to use. Possible values: all, debug, info, warn, error, none (default "info")
-namespaces value
Namespaces to scope the interaction of the Prometheus Operator and the apiserver (allow list). This is mutually exclusive with --deny-namespaces.
-prometheus-config-reloader string
Prometheus config reloader image (default "quay.io/prometheus-operator/prometheus-config-reloader:v0.69.1")
-prometheus-default-base-image string
Prometheus default base image (path without tag/version) (default "quay.io/prometheus/prometheus")
-prometheus-instance-namespaces value
Namespaces where Prometheus and PrometheusAgent custom resources and corresponding Secrets, Configmaps and StatefulSets are watched/created. If set this takes precedence over --namespaces or --deny-namespaces for Prometheus custom resources.
-prometheus-instance-selector value
Label selector to filter Prometheus and PrometheusAgent Custom Resources to watch.
-secret-field-selector value
Field selector to filter Secrets to watch
-short-version
Print just the version number.
-thanos-default-base-image string
Thanos default base image (path without tag/version) (default "quay.io/thanos/thanos")
-thanos-ruler-instance-namespaces value
Namespaces where ThanosRuler custom resources and corresponding StatefulSets are watched/created. If set this takes precedence over --namespaces or --deny-namespaces for ThanosRuler custom resources.
-thanos-ruler-instance-selector value
Label selector to filter ThanosRuler Custom Resources to watch.
-tls-insecure
- NOT RECOMMENDED FOR PRODUCTION - Don't verify API server's CA certificate.
-version
Prints current version.
-web.cert-file string
Certficate file to be used for the web server. (default "/etc/tls/private/tls.crt")
-web.client-ca-file string
Client CA certificate file to be used for the web server. (default "/etc/tls/private/tls-ca.crt")
-web.enable-http2
Enable HTTP2 connections.
-web.enable-tls
Enable TLS for the web server.
-web.key-file string
Private key matching the cert file to be used for the web server. (default "/etc/tls/private/tls.key")
-web.listen-address string
Address on which to expose metrics and web interface. (default ":8080")
-web.tls-cipher-suites value
Comma-separated list of cipher suites for the server. Values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants).If omitted, the default Go cipher suites will be used. Note that TLS 1.3 ciphersuites are not configurable.
-web.tls-min-version string
Minimum TLS version supported. Value must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants. (default "VersionTLS13")
-web.tls-reload-interval duration
The interval at which to watch for TLS certificate changes, by default set to 1 minute. (default 1m0s). (default 1m0s)
```
View Git Blame Copy Permalink