Skip to content

Commit 5794c86

Browse files
committed
remove nontenant from docs
Signed-off-by: Ruben Vargas <[email protected]>
1 parent 478c442 commit 5794c86

6 files changed

+52
-285
lines changed

modules/distr-tracing-tempo-config-multitenancy.adoc

Lines changed: 0 additions & 204 deletions
This file was deleted.

modules/distr-tracing-tempo-config-spanmetrics.adoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,12 +87,16 @@ spec:
8787
name: minio-test
8888
type: s3
8989
storageSize: 1Gi
90+
tenants:
91+
mode: openshift
92+
authentication:
93+
- tenantName: dev
94+
tenantId: "1610b0c3-c509-4592-a256-a1871353dbfa"
9095
template:
9196
gateway:
92-
enabled: false
97+
enabled: true
9398
queryFrontend:
9499
jaegerQuery:
95-
enabled: true
96100
monitorTab:
97101
enabled: true # <1>
98102
prometheusEndpoint: https://thanos-querier.openshift-monitoring.svc.cluster.local:9091 # <2>

modules/distr-tracing-tempo-install-gateway-permissions.adoc

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,17 @@
33
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
44

55
:_mod-docs-content-type: PROCEDURE
6-
[id="distr-tracing-tempo-install-tempostack-web-console_{context}"]
6+
[id="distr-tracing-tempo-install-gateway-permissions{context}"]
77
= Configure tenants and permissions
88

99
Authentication and authorization is provided in the Tempo Gateway service. The authentication uses OpenShift OAuth and the Kubernetes `TokenReview` API. The authorization uses the Kubernetes `SubjectAccessReview` API.
1010

11-
To properly define tenants and manage their read and write access, the distributed tracing stack—built on the Red Hat distribution of OpenTelemetry and Tempo—requires a well-configured authorization setup. This setup relies on Kubernetes Role-Based Access Control (RBAC) through ClusterRole and ClusterRoleBinding. By default, no users are granted read or write permissions, ensuring a secure baseline until explicit configurations are defined.
11+
To properly define tenants and manage their read and write access, the distributed tracing stack—built on the Red Hat distribution of OpenTelemetry and Tempo—requires a well-configured authorization setup.
1212

13+
This setup relies on Kubernetes Role-Based Access Control (RBAC) through ClusterRole and ClusterRoleBinding. By default, no users are granted read or write permissions, ensuring a secure baseline until explicit configurations are defined.
1314

14-
You can install a Configure thosep permissionns from the *Administrator* view of the web console.
15+
16+
You can install a Configure those permissionns from the *Administrator* view of the web console or using command line CLI.
1517

1618
.Prerequisites
1719

@@ -24,6 +26,7 @@ To grant users permission to read a specific tenant, follow these steps:
2426

2527
. Define desired tenant name and tenant Id.
2628
. Enable tenants to read traces by adding them to a `ClusterRole` and giving them read (get) permissions
29+
2730
.Sample of the read RBAC configuration that allows authenticated users to read the trace data of the `dev` and `prod` tenants
2831
[source,yaml]
2932
----
@@ -73,8 +76,9 @@ metadata:
7376
name: otel-collector # <1>
7477
namespace: otel
7578
----
76-
. Grant the OpenTelemetry Collector write permissions by defining a ClusterRoleBinding to the previously defined role and attaching it to the ServiceAccount
77-
the following is a sample on how to write RBAC configuration that allows the `otel-collector` service account to write the trace data for the `dev` tenant
79+
. Grant the OpenTelemetry Collector write permissions by defining a Role with write permissions and ClusterRoleBinding to attach the OpenTelemetry Collector ServiceAccount.
80+
81+
The following is a sample on how to write RBAC configuration that allows the `otel-collector` ServiceAccount to write the trace data for the `dev` tenant
7882
+
7983
[source,yaml]
8084
----
@@ -115,15 +119,15 @@ subjects:
115119
* Enable TLS with a valid certificate authority file.
116120

117121
Trace data can be sent to the Tempo instance from the OpenTelemetry Collector that uses the service account with RBAC for writing the data.
118-
122+
+
119123
.Sample OpenTelemetry CR configuration
120124
[source,yaml]
121125
----
122126
apiVersion: opentelemetry.io/v1alpha1
123127
kind: OpenTelemetryCollector
124128
metadata:
125129
name: cluster-collector
126-
namespace: tracing-system
130+
namespace: <project_of_tempostack_instance>
127131
spec:
128132
mode: deployment
129133
serviceAccount: otel-collector # <1>
@@ -133,7 +137,7 @@ spec:
133137
filename: "/var/run/secrets/kubernetes.io/serviceaccount/token"
134138
exporters:
135139
otlp/dev: # <3>
136-
endpoint: tempo-simplest-gateway.tempo.svc.cluster.local:8090
140+
endpoint: sample-gateway.tempo.svc.cluster.local:8090
137141
tls:
138142
insecure: false
139143
ca_file: "/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt" # <4>
@@ -142,7 +146,7 @@ spec:
142146
headers:
143147
X-Scope-OrgID: "dev" <5>
144148
otlphttp/dev: # <6>
145-
endpoint: https://tempo-simplest-gateway.chainsaw-multitenancy.svc.cluster.local:8080/api/traces/v1/dev
149+
endpoint: https://sample-gateway.<project_of_tempostack_instance>.svc.cluster.local:8080/api/traces/v1/dev
146150
tls:
147151
insecure: false
148152
ca_file: "/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt"

modules/distr-tracing-tempo-install-tempostack-cli.adoc

Lines changed: 0 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -73,48 +73,6 @@ You can create multiple TempoStack instances in separate projects on the same cl
7373
include::snippets/distr-tracing-tempo-tempostack-custom-resource.adoc[]
7474
--
7575
+
76-
.Example of a `TempoStack` CR for AWS S3 and MinIO storage and tenants `dev` and `prod`
77-
[source,yaml]
78-
----
79-
apiVersion: tempo.grafana.com/v1alpha1
80-
kind: TempoStack
81-
metadata:
82-
name: simplest
83-
namespace: chainsaw-multitenancy
84-
spec:
85-
storage:
86-
secret: # <1>
87-
name: minio
88-
type: s3
89-
storageSize: 1Gi
90-
resources:
91-
total:
92-
limits:
93-
memory: 2Gi
94-
cpu: 2000m
95-
tenants:
96-
mode: openshift # <2>
97-
authentication: # <3>
98-
- tenantName: dev # <4>
99-
tenantId: "1610b0c3-c509-4592-a256-a1871353dbfa" # <5>
100-
- tenantName: prod
101-
tenantId: "1610b0c3-c509-4592-a256-a1871353dbfb"
102-
template:
103-
gateway:
104-
enabled: true # <6>
105-
queryFrontend:
106-
jaegerQuery:
107-
enabled: true # <7>
108-
----
109-
<1> In this example, the object storage was set up as one of the prerequisites, and the object storage secret was created in step 2.
110-
<2> Tenant mode must be set to `openshift`.
111-
<3> The list of tenants.
112-
<4> The tenant name. Must be provided in the `X-Scope-OrgId` header when ingesting the data.
113-
<5> Defines a universally unique identifier of the tenant. Unlike the tenantName, which must be unique at a given time, the tenantId must be unique over the entire lifetime of the Tempo deployment. Tempo uses this ID to prefix objects in the object storage. This could be a UUID, or can match the tempoName
114-
<6> Enables a gateway that performs authentication and authorization. The Jaeger UI is exposed at `http://<gateway-ingress>/api/traces/v1/<tenant-name>/search`.
115-
<7> The stack deployed in this example is configured to receive Jaeger Thrift over HTTP and OpenTelemetry Protocol (OTLP), which permits visualizing the data with the Jaeger UI.
116-
117-
11876
.. Apply the customized CR by running the following command:
11977
+
12078
[source,terminal]

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,6 @@ include::modules/distr-tracing-tempo-config-receiver-tls-for-tempomonolithic.ado
5151
* xref:../../../security/certificates/service-serving-certificate.adoc#understanding-service-serving_service-serving-certificate[Understanding service serving certificates]
5252
* xref:../../../security/certificate_types_descriptions/service-ca-certificates.adoc#cert-types-service-ca-certificates[Service CA certificates]
5353

54-
include::modules/distr-tracing-tempo-config-multitenancy.adoc[leveloffset=+1]
55-
5654
[id="taints-and-tolerations_{context}"]
5755
== Using taints and tolerations
5856

0 commit comments

Comments
 (0)