From 7819a3108486fa2582575998a48eafee71ce4926 Mon Sep 17 00:00:00 2001 From: Josune Cordoba <49480155+josunect@users.noreply.github.com> Date: Thu, 12 Sep 2024 15:41:19 +0100 Subject: [PATCH] Add auth section for each external service page (#814) * Add auth section for each external services --- .../p8s-jaeger-grafana/grafana.md | 21 ++++++++++++++++ .../p8s-jaeger-grafana/prometheus.md | 20 ++++++++++++++++ .../p8s-jaeger-grafana/tracing/jaeger.md | 21 ++++++++++++++++ .../p8s-jaeger-grafana/tracing/tempo.md | 24 ++++++++++++++++++- content/en/docs/FAQ/authentication.md | 1 - 5 files changed, 85 insertions(+), 2 deletions(-) diff --git a/content/en/docs/Configuration/p8s-jaeger-grafana/grafana.md b/content/en/docs/Configuration/p8s-jaeger-grafana/grafana.md index d65b57236..eabc0f626 100644 --- a/content/en/docs/Configuration/p8s-jaeger-grafana/grafana.md +++ b/content/en/docs/Configuration/p8s-jaeger-grafana/grafana.md @@ -57,3 +57,24 @@ spec: The described configuration is done in the Kiali CR when Kiali is installed using the Kiali Operator. If Kiali is installed with the Helm chart then the correct way to configure this is via regular --set flags. {{% /alert %}} +### Grafana authentication configuration + +The Kiali CR provides authentication configuration that will be used to connect to your grafana instance and for detecting your grafana version in the Mesh graph. + +```yaml +spec: + external_services: + grafana: + enabled: true + auth: + ca_file: "" + insecure_skip_verify: false + password: "pwd" + token: "" + type: "basic" + use_kiali_token: false + username: "user" + health_check_url: "" +``` + +To configure a secret to be used as a password, see this [FAQ entry]({{< relref "../../FAQ/installation#how-can-i-use-a-secret-to-pass-external-service-credentials-to-the-kiali-server" >}}) \ No newline at end of file diff --git a/content/en/docs/Configuration/p8s-jaeger-grafana/prometheus.md b/content/en/docs/Configuration/p8s-jaeger-grafana/prometheus.md index 0eda98a89..f313c8189 100644 --- a/content/en/docs/Configuration/p8s-jaeger-grafana/prometheus.md +++ b/content/en/docs/Configuration/p8s-jaeger-grafana/prometheus.md @@ -169,4 +169,24 @@ The recommendation for Kiali is to set the shortest retention time that meets yo For more information, see the [Prometheus documentation](https://prometheus.io/docs/prometheus/latest/storage/#operational-aspects). +### Prometheus authentication configuration +The Kiali CR provides authentication configuration that will be used also for querying the version check to provide information in the Mesh graph. + +```yaml +spec: + external_services: + prometheus: + enabled: true + auth: + ca_file: "" + insecure_skip_verify: false + password: "pwd" + token: "" + type: "basic" + use_kiali_token: false + username: "user" + health_check_url: "" +``` + +To configure a secret to be used as a password, see this [FAQ entry]({{< relref "../../FAQ/installation#how-can-i-use-a-secret-to-pass-external-service-credentials-to-the-kiali-server" >}}) \ No newline at end of file diff --git a/content/en/docs/Configuration/p8s-jaeger-grafana/tracing/jaeger.md b/content/en/docs/Configuration/p8s-jaeger-grafana/tracing/jaeger.md index b7934c301..c316d4f29 100644 --- a/content/en/docs/Configuration/p8s-jaeger-grafana/tracing/jaeger.md +++ b/content/en/docs/Configuration/p8s-jaeger-grafana/tracing/jaeger.md @@ -52,3 +52,24 @@ If your Jaeger setup differs significantly from the sample add-ons, make sure that Istio is also properly configured to push traces to the right URL. {{% /alert %}} +### Jaeger authentication configuration + +The Kiali CR provides authentication configuration that will be used also for querying the version check to provide information in the Mesh graph. + +```yaml +spec: + external_services: + tracing: + enabled: true + auth: + ca_file: "" + insecure_skip_verify: false + password: "pwd" + token: "" + type: "basic" + use_kiali_token: false + username: "user" + health_check_url: "" +``` + +To configure a secret to be used as a password, see this [FAQ entry]({{< relref "../../../FAQ/installation#how-can-i-use-a-secret-to-pass-external-service-credentials-to-the-kiali-server" >}}) \ No newline at end of file diff --git a/content/en/docs/Configuration/p8s-jaeger-grafana/tracing/tempo.md b/content/en/docs/Configuration/p8s-jaeger-grafana/tracing/tempo.md index 2dfaeba92..c08da4597 100644 --- a/content/en/docs/Configuration/p8s-jaeger-grafana/tracing/tempo.md +++ b/content/en/docs/Configuration/p8s-jaeger-grafana/tracing/tempo.md @@ -231,4 +231,26 @@ In `external_services.tracing` | |
http
|
grpc
| |--------|-------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Jaeger | `.in_cluster_url = 'http://jaeger_service_url:16686/jaeger'`
`.use_grpc = false`
| `.in_cluster_url = 'http://jaeger_service_url:16685/jaeger'`
`.use_grpc = true (Not required: by default)`

| -| Tempo |
`in_cluster_url = 'http://query_frontend_url:3200'`
`.use_grpc = false`
`.provider = 'tempo'`

| `.in_cluster_url = 'http://query_frontend_url:3200'`
`.grpc_port: 9095`
`.provider: 'tempo'`
`.use_grpc = true (Not required: by default)`
| \ No newline at end of file +| Tempo |
`in_cluster_url = 'http://query_frontend_url:3200'`
`.use_grpc = false`
`.provider = 'tempo'`

| `.in_cluster_url = 'http://query_frontend_url:3200'`
`.grpc_port: 9095`
`.provider: 'tempo'`
`.use_grpc = true (Not required: by default)`
| + +### Tempo authentication configuration + +The Kiali CR provides authentication configuration that will be used also for querying the version check to provide information in the Mesh graph. + +```yaml +spec: + external_services: + tracing: + enabled: true + auth: + ca_file: "" + insecure_skip_verify: false + password: "pwd" + token: "" + type: "basic" + use_kiali_token: false + username: "user" + health_check_url: "" +``` + +To configure a secret to be used as a password, see this [FAQ entry]({{< relref "../../../FAQ/installation#how-can-i-use-a-secret-to-pass-external-service-credentials-to-the-kiali-server" >}}) \ No newline at end of file diff --git a/content/en/docs/FAQ/authentication.md b/content/en/docs/FAQ/authentication.md index 325b3ea28..cb4ade1e7 100644 --- a/content/en/docs/FAQ/authentication.md +++ b/content/en/docs/FAQ/authentication.md @@ -58,4 +58,3 @@ spec: port: number: 20001 ``` -