Skip to content

Commit 6521d8b

Browse files
rubenvp8510max-cx
rubenvp8510
authored and
max-cx
committed
TRACING-5867 Document tempo operator config
Signed-off-by: Ruben Vargas <ruben.vp8510@gmail.com>
1 parent cfb594f commit 6521d8b

2 files changed

Lines changed: 196 additions & 0 deletions

File tree

‎modules/distr-tracing-tempo-config-operator.adoc‎

Lines changed: 194 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,194 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * observability/distr_tracing/distr-tracing-tempo-configuring.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="distr-tracing-tempo-config-operator_{context}"]
7+
= Configuring the {TempoOperator}
8+
9+
You can configure the {TempoOperator} by using the Operator Lifecycle Manager (OLM) Subscription custom resource (CR) to override default settings. This configuration method uses environment variables that take precedence over any ConfigMap-based configuration.
10+
11+
.Example Subscription CR with Operator configuration
12+
[source,yaml]
13+
----
14+
apiVersion: operators.coreos.com/v1alpha1
15+
kind: Subscription
16+
metadata:
17+
name: tempo-product
18+
namespace: openshift-tempo-operator
19+
spec:
20+
channel: stable
21+
name: tempo-product
22+
source: redhat-operators
23+
sourceNamespace: openshift-marketplace
24+
config:
25+
env:
26+
- name: FEATURE_GATES
27+
value: "openshift.route,openshift.servingCertsService"
28+
- name: TLS_PROFILE
29+
value: "Modern"
30+
----
31+
where:
32+
33+
`FEATURE_GATES`:: Specifies a comma-separated list of feature gates to enable or disable. Prefix a gate with `-` to disable it.
34+
`TLS_PROFILE`:: Specifies the TLS security profile for the Operator.
35+
36+
You can also configure these values from the {product-title} web console by editing the Subscription object under *Operators* > *Installed Operators* > *{TempoOperator}* > *Subscription*.
37+
38+
[id="tempo-operator-env-vars_{context}"]
39+
== {TempoOperator} environment variables
40+
41+
The following tables list the environment variables that you can use to configure the {TempoOperator}.
42+
43+
.Feature gates
44+
[options="header"]
45+
[cols="a, a"]
46+
|===
47+
|Feature gate |Description
48+
49+
|`openshift.route`
50+
|Enables {product-title} route creation for Tempo components.
51+
52+
|`openshift.servingCertsService`
53+
|Enables {product-title} service serving certificates.
54+
55+
|`openshift.oauthProxy`
56+
|Enables {product-title} OAuth proxy integration.
57+
58+
|`httpEncryption`
59+
|Enables HTTP encryption for Tempo components.
60+
61+
|`grpcEncryption`
62+
|Enables gRPC encryption for Tempo components.
63+
64+
|`prometheusOperator`
65+
|Enables Prometheus Operator integration for metrics.
66+
67+
|`grafanaOperator`
68+
|Enables Grafana Operator integration.
69+
70+
|`builtInCertManagement`
71+
|Enables built-in certificate management.
72+
73+
|`observability.metrics.createServiceMonitors`
74+
|Enables creation of `ServiceMonitor` resources for Prometheus.
75+
76+
|`observability.metrics.createPrometheusRules`
77+
|Enables creation of `PrometheusRule` resources for alerts.
78+
79+
|`networkPolicies`
80+
|Enables creation of `NetworkPolicy` resources.
81+
82+
|===
83+
84+
.General configuration environment variables
85+
[options="header"]
86+
[cols="a, a, a"]
87+
|===
88+
|Environment variable |Description |Example value
89+
90+
|`FEATURE_GATES`
91+
|Comma-separated list of feature gates to enable or disable. Prefix a gate with `-` to disable it.
92+
|`openshift.route,openshift.servingCertsService,-networkPolicies`
93+
94+
|`DISTRIBUTION`
95+
|Sets the distribution type.
96+
|`openshift`
97+
98+
|`TLS_PROFILE`
99+
|TLS security profile type.
100+
|`Old`, `Intermediate`, or `Modern`
101+
102+
|`OPENSHIFT_BASE_DOMAIN`
103+
|Sets the {product-title} base domain for route generation.
104+
|`apps.example.com`
105+
106+
|`DEFAULT_POD_SECURITY_CONTEXT`
107+
|Specifies the default `PodSecurityContext` object as JSON.
108+
|`{"runAsNonRoot": true}`
109+
110+
|===
111+
112+
.Built-in certificate management environment variables
113+
[options="header"]
114+
[cols="a, a, a"]
115+
|===
116+
|Environment variable |Description |Example value
117+
118+
|`BUILT_IN_CERT_MANAGEMENT_CA_VALIDITY`
119+
|CA certificate validity duration.
120+
|`8760h`
121+
122+
|`BUILT_IN_CERT_MANAGEMENT_CA_REFRESH`
123+
|CA certificate refresh interval.
124+
|`7008h`
125+
126+
|`BUILT_IN_CERT_MANAGEMENT_CERT_VALIDITY`
127+
|Certificate validity duration.
128+
|`2160h`
129+
130+
|`BUILT_IN_CERT_MANAGEMENT_CERT_REFRESH`
131+
|Certificate refresh interval.
132+
|`1728h`
133+
134+
|===
135+
136+
.Controller manager environment variables
137+
[options="header"]
138+
[cols="a, a, a"]
139+
|===
140+
|Environment variable |Description |Example value
141+
142+
|`METRICS_BIND_ADDRESS`
143+
|Metrics server bind address.
144+
|`:8080`
145+
146+
|`METRICS_SECURE`
147+
|Enables secure metrics serving.
148+
|`true`
149+
150+
|`HEALTH_PROBE_BIND_ADDRESS`
151+
|Health probe bind address.
152+
|`:8081`
153+
154+
|`WEBHOOK_PORT`
155+
|Webhook server port.
156+
|`9443`
157+
158+
|===
159+
160+
.Leader election environment variables
161+
[options="header"]
162+
[cols="a, a, a"]
163+
|===
164+
|Environment variable |Description |Example value
165+
166+
|`LEADER_ELECTION_ENABLED`
167+
|Enables or disables leader election.
168+
|`true`
169+
170+
|`LEADER_ELECTION_RESOURCE_LOCK`
171+
|Resource lock type.
172+
|`leases`
173+
174+
|`LEADER_ELECTION_RESOURCE_NAMESPACE`
175+
|Namespace for leader election resources.
176+
|`openshift-tempo-operator`
177+
178+
|`LEADER_ELECTION_RESOURCE_NAME`
179+
|Name of the leader election resource.
180+
|`tempo-operator-lock`
181+
182+
|`LEADER_ELECTION_LEASE_DURATION`
183+
|Leader election lease duration.
184+
|`15s`
185+
186+
|`LEADER_ELECTION_RENEW_DEADLINE`
187+
|Leader election renew deadline.
188+
|`10s`
189+
190+
|`LEADER_ELECTION_RETRY_PERIOD`
191+
|Leader election retry period.
192+
|`2s`
193+
194+
|===

‎observability/distr_tracing/distr-tracing-tempo-configuring.adoc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ toc::[]
88

99
The {TempoOperator} uses a custom resource definition (CRD) file that defines the architecture and configuration settings for creating and deploying the {TempoShortName} resources. You can install the default configuration or modify the file.
1010

11+
include::modules/distr-tracing-tempo-config-operator.adoc[leveloffset=+1]
12+
1113
ifdef::openshift-enterprise,openshift-dedicated[]
1214
[id="configuring-storages_{context}"]
1315
== Configuring back-end storage

0 commit comments

Comments
 (0)