Skip to content

TRACING-6707: clarify feature gates environment variable #118785

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andreasgerstmayr wants to merge 1 commit into
base: standalone-distributed-tracing-docs-main
Choose a base branch
from
Open

TRACING-6707: clarify feature gates environment variable #118785

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions modules/distr-tracing-tempo-config-operator.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,9 @@ The following table shows the feature gates:
|`openshift.oauthProxy`
|Enables {ocp-product-title} OAuth proxy integration.

|`openshift.clusterTLSPolicy`
|Enables inheriting the TLS configuration from the {ocp-product-title} `APIServer` CR.

|`httpEncryption`
|Enables HTTP encryption for Tempo components.

Expand Down
7 changes: 4 additions & 3 deletions modules/distr-tracing-tempo-tls-profile.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,11 @@
[role="_abstract"]
The {TempoOperator} inherits the TLS configuration defined in the {ocp-product-title} `APIServer` custom resource (CR). The Operator and its operands inherit TLS settings like minimum TLS version and TLS cipher suites from the `APIServer` CR for all TLS communications.

You can configure the TLS cluster profile by using the following environment variables:
The `FEATURE_GATES` environment variable of the {TempoOperator} contains a comma-separated list of feature gates. The `openshift.clusterTLSPolicy` feature gate, which enables inheriting the TLS configuration from the `APIServer` CR, is included in the default list.
For the full list of feature gates, see xref:distr-tracing-tempo-config-operator_{context}[Configuring the {TempoOperator}].

`FEATURE_GATE=openshift.clusterTLSPolicy`:: Enables inheriting the TLS configuration from the `APIServer` CR, and is enabled by default.
To disable the `openshift.clusterTLSPolicy` feature gate, remove it from the comma-separated `FEATURE_GATES` list. Do not replace the entire variable value, because doing so disables all other default feature gates.

If the `openshift.clusterTLSPolicy` environment variable is disabled, you can manually set the TLS profile by using the following environment variable:
If the `openshift.clusterTLSPolicy` feature gate is disabled, you can manually set the TLS profile by using the following environment variable:

`TLS_PROFILE`:: The TLS profile environment variable. Supported values are: `Old`, `Intermediate`, and `Modern`. For more information, see "Security/Server Side TLS" in Mozilla documentation.