From 9a004cb2a01fabb8371dd2766df639757905d507 Mon Sep 17 00:00:00 2001 From: John Mazzitelli Date: Mon, 23 Sep 2024 12:01:31 -0400 Subject: [PATCH] rename in_cluster_url to internal_url; rename url to external_url (#820) * rename in_cluster_url to internal_url; rename url to external_url part of: https://github.com/kiali/kiali/issues/7745 * contrib guide config.yaml changes --- .../p8s-jaeger-grafana/grafana.md | 6 ++--- .../p8s-jaeger-grafana/tracing/jaeger.md | 10 +++---- .../p8s-jaeger-grafana/tracing/tempo.md | 26 +++++++++---------- content/en/docs/FAQ/distributed-tracing.md | 22 ++++++++-------- .../tempo/02-kiali-tempo-integration.md | 6 ++--- static/files/contribution_guide/config.yaml | 8 +++--- 6 files changed, 39 insertions(+), 39 deletions(-) diff --git a/content/en/docs/Configuration/p8s-jaeger-grafana/grafana.md b/content/en/docs/Configuration/p8s-jaeger-grafana/grafana.md index eabc0f626..74b433d33 100644 --- a/content/en/docs/Configuration/p8s-jaeger-grafana/grafana.md +++ b/content/en/docs/Configuration/p8s-jaeger-grafana/grafana.md @@ -35,9 +35,9 @@ spec: grafana: enabled: true # Grafana service name is "grafana" and is in the "telemetry" namespace. - in_cluster_url: 'http://grafana.telemetry:3000/' + internal_url: 'http://grafana.telemetry:3000/' # Public facing URL of Grafana - url: 'http://my-ingress-host/grafana' + external_url: 'http://my-ingress-host/grafana' dashboards: - name: "Istio Service Dashboard" variables: @@ -77,4 +77,4 @@ spec: 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 +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" >}}) 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 c316d4f29..d9ea06ba2 100644 --- a/content/en/docs/Configuration/p8s-jaeger-grafana/tracing/jaeger.md +++ b/content/en/docs/Configuration/p8s-jaeger-grafana/tracing/jaeger.md @@ -32,17 +32,17 @@ spec: # Jaeger service name is "tracing" and is in the "telemetry" namespace. # Make sure the URL you provide corresponds to the non-GRPC enabled endpoint # if you set "use_grpc" to false. - in_cluster_url: "http://tracing.telemetry:16685/jaeger" + internal_url: "http://tracing.telemetry:16685/jaeger" use_grpc: true # Public facing URL of Jaeger - url: "http://my-jaeger-host/jaeger" + external_url: "http://my-jaeger-host/jaeger" ``` -Minimally, you must provide `spec.external_services.tracing.in_cluster_url` to +Minimally, you must provide `spec.external_services.tracing.internal_url` to enable Kiali features that use distributed tracing data. However, Kiali can provide contextual links that users can use to jump to the Jaeger console to inspect tracing data more in depth. For these links to be available you need to -set the `spec.external_services.tracing.url` to the URL where you +set the `spec.external_services.tracing.external_url` to the URL where you expose Jaeger outside the cluster. {{% alert color="success" %}} @@ -72,4 +72,4 @@ spec: 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 +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" >}}) 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 c08da4597..e6348df4a 100644 --- a/content/en/docs/Configuration/p8s-jaeger-grafana/tracing/tempo.md +++ b/content/en/docs/Configuration/p8s-jaeger-grafana/tracing/tempo.md @@ -35,14 +35,14 @@ spec: # Tempo service name is "query-frontend" and is in the "tempo" namespace. # Make sure the URL you provide corresponds to the non-GRPC enabled endpoint # It does not support grpc yet, so make sure "use_grpc" is set to false. - in_cluster_url: "http://tempo-tempo-query-frontend.tempo.svc.cluster.local:3200/" + internal_url: "http://tempo-tempo-query-frontend.tempo.svc.cluster.local:3200/" provider: "tempo" tempo_config: org_id: "1" datasource_uid: "a8d2ef1c-d31c-4de5-a90b-e7bc5252cd00" use_grpc: false # Public facing URL of Tempo - url: "https://tempo-tempo-query-frontend-tempo.apps-crc.testing/" + external_url: "https://tempo-tempo-query-frontend-tempo.apps-crc.testing/" ``` The default UI for Grafana Tempo is Grafana, so we should also set the Grafana URL in the Kiali configuration, such as this example: @@ -51,8 +51,8 @@ The default UI for Grafana Tempo is Grafana, so we should also set the Grafana U spec: external_services: grafana: - in_cluster_url: http://grafana.istio-system:3000 - url: https://grafana.apps-crc.testing/ + internal_url: http://grafana.istio-system:3000 + external_url: https://grafana.apps-crc.testing/ ``` #### Set up a Tempo Datasource in Grafana @@ -85,10 +85,10 @@ spec: enabled: true # grpc port defaults to 9095 grpc_port: 9095 - in_cluster_url: "http://query-frontend.tempo:3200" + internal_url: "http://query-frontend.tempo:3200" provider: "tempo" use_grpc: true - url: "http://my-tempo-host:3200" + external_url: "http://my-tempo-host:3200" ``` ##### Service check URL @@ -147,7 +147,7 @@ set from Istio to the Tempo Distributor service and the Zipkin port. Tanka will deploy the service in `distributor.tempo.svc.cluster.local:9411`. -The `external_services.tracing.in_cluster_url` Kiali option needs to be set to: +The `external_services.tracing.internal_url` Kiali option needs to be set to: `http://query-frontend.tempo.svc.cluster.local:16685`. #### Tempo Operator @@ -197,7 +197,7 @@ field in your Istio installation. It needs to be set to the `9411` port of the Tempo Distributor service. For the previous example, this value will be `tempo-smm-distributor.tempo.svc.cluster.local:9411`. -Now, you need to configure the `in_cluster_url` setting from Kiali to access +Now, you need to configure the `internal_url` setting from Kiali to access the Jaeger API. You can point to the `16685` port to use GRPC or `16686` if not. For the given example, the value would be `http://tempo-ssm-query-frontend.tempo.svc.cluster.local:16685`. @@ -221,8 +221,8 @@ 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:16686'`
`.use_grpc = false`
| `.in_cluster_url = 'http://query_frontend_url:16685'`
`.use_grpc = true (Not required: by default)`
| +| Jaeger | `.internal_url = 'http://jaeger_service_url:16686/jaeger'`
`.use_grpc = false`
| `.internal_url = 'http://jaeger_service_url:16685/jaeger'`
`.use_grpc = true (Not required: by default)`
| +| Tempo | `.internal_url = 'http://query_frontend_url:16686'`
`.use_grpc = false`
| `.internal_url = 'http://query_frontend_url:16685'`
`.use_grpc = true (Not required: by default)`
|
@@ -230,8 +230,8 @@ 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)`
| +| Jaeger | `.internal_url = 'http://jaeger_service_url:16686/jaeger'`
`.use_grpc = false`
| `.internal_url = 'http://jaeger_service_url:16685/jaeger'`
`.use_grpc = true (Not required: by default)`
| +| Tempo |
`internal_url = 'http://query_frontend_url:3200'`
`.use_grpc = false`
`.provider = 'tempo'`
| `.internal_url = 'http://query_frontend_url:3200'`
`.grpc_port: 9095`
`.provider: 'tempo'`
`.use_grpc = true (Not required: by default)`
| ### Tempo authentication configuration @@ -253,4 +253,4 @@ spec: 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 +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" >}}) diff --git a/content/en/docs/FAQ/distributed-tracing.md b/content/en/docs/FAQ/distributed-tracing.md index cd6dd3851..8e5eb12a3 100644 --- a/content/en/docs/FAQ/distributed-tracing.md +++ b/content/en/docs/FAQ/distributed-tracing.md @@ -20,12 +20,12 @@ Apparently, Kiali is unable to connect to Jaeger. Make sure [tracing is correctl auth: type: none enabled: true - in_cluster_url: 'http://tracing.istio-system/jaeger' - url: 'http://jaeger.example.com/' + internal_url: 'http://tracing.istio-system/jaeger' + external_url: 'http://jaeger.example.com/' use_grpc: true ``` -You need especially to pay attention to the `in_cluster_url` field, which is how Kiali backend contacts the Jaeger service. In general, this URL is written using Kubernetes domain names in the form of `http://service.namespace`, plus a path. +You need especially to pay attention to the `internal_url` field, which is how Kiali backend contacts the Jaeger service. In general, this URL is written using Kubernetes domain names in the form of `http://service.namespace`, plus a path. If you're not sure about this URL, try to find your Jaeger service and its exposed ports: @@ -50,7 +50,7 @@ If instead of that you see some blocks of mixed HTML/Javascript mentioning Jaege A common mistake is to forget the `/jaeger` suffix, which is often used in Jaeger deployments. -It may also happen that you have a service named `jaeger-query`, exposing port `16686`, instead of the more common `tracing` service on port `80`. In that situation, set `in_cluster_url` to `http://jaeger-query.istio-system:16686/jaeger`. +It may also happen that you have a service named `jaeger-query`, exposing port `16686`, instead of the more common `tracing` service on port `80`. In that situation, set `internal_url` to `http://jaeger-query.istio-system:16686/jaeger`. If Jaeger needs an authentication, make sure to correctly configure the `auth` section. @@ -61,12 +61,12 @@ If for some reason the GRPC connection fails and you think it shouldn't (e.g. yo ### Why can't I see any external link to Jaeger? -In addition to the embedded integration that Kiali provides with Jaeger, it is possible to show external links to the Jaeger UI. To do so, the external URL must be configured in the [Kiali CR](/docs/configuration/kialis.kiali.io/#.spec.external_services.tracing.url). +In addition to the embedded integration that Kiali provides with Jaeger, it is possible to show external links to the Jaeger UI. To do so, the external URL must be configured in the [Kiali CR](/docs/configuration/kialis.kiali.io/#.spec.external_services.tracing.external_url). ```yaml tracing: # ... - url: "http://jaeger.example.com/" + external_url: "http://jaeger.example.com/" ``` When configured, this URL will be used to generate a couple of links to Jaeger within Kiali. It's also visible in the About modal: @@ -80,9 +80,9 @@ When configured, this URL will be used to generate a couple of links to Jaeger w ![Jaeger integration disabled](/images/documentation/faq/tracing/traces-external-link.png) -On the Application detail page, the Traces tab might redirect to Jaeger via an external link instead of showing the Kiali Tracing view. It happens when you have the `url` field configured, but not `in_cluster_url`, which means the Kiali backend will not be able to connect to Jaeger. +On the Application detail page, the Traces tab might redirect to Jaeger via an external link instead of showing the Kiali Tracing view. It happens when you have the `external_url` field configured, but not `internal_url`, which means the Kiali backend will not be able to connect to Jaeger. -To fix it, configure `in_cluster_url` in the [Kiali CR](/docs/configuration/kialis.kiali.io/#.spec.external_services.tracing.in_cluster_url). +To fix it, configure `internal_url` in the [Kiali CR](/docs/configuration/kialis.kiali.io/#.spec.external_services.tracing.internal_url). ### Why do I see "Missing root span" for the root span of some span details on Traces tab? @@ -93,11 +93,11 @@ In Traces tab, while clicking on a trace, it shows the details of that trace and ### Why do I see "error reading server preface: http2: frame too large" error when Kiali is not able to fetch Traces? -Sometimes this error can occur when there is a problem in the configuration and there is an http url configured but Kiali is configured to use grpc. For example: +Sometimes this error can occur when there is a problem in the configuration and there is an http URL configured but Kiali is configured to use grpc. For example: ```yaml use_grpc: true -in_cluster_url: "http://jaeger_url:16686/jaeger" +internal_url: "http://jaeger_url:16686/jaeger" ``` -That should be solved when `use_grpc: false` or using the grpc port `in_cluster_url: "http://jaeger_url:16685/jaeger"` \ No newline at end of file +That should be solved when `use_grpc: false` or using the grpc port `internal_url: "http://jaeger_url:16685/jaeger"` diff --git a/content/en/docs/Tutorials/tempo/02-kiali-tempo-integration.md b/content/en/docs/Tutorials/tempo/02-kiali-tempo-integration.md index 4c4d357bc..b2e39a3b6 100644 --- a/content/en/docs/Tutorials/tempo/02-kiali-tempo-integration.md +++ b/content/en/docs/Tutorials/tempo/02-kiali-tempo-integration.md @@ -222,8 +222,8 @@ Install kiali: ``` helm install \ --namespace istio-system \ - --set external_services.tracing.in_cluster_url=http://tempo-smm-query-frontend.tempo:16685 \ - --set external_services.tracing.url=http://localhost:16686 \ + --set external_services.tracing.internal_url=http://tempo-smm-query-frontend.tempo:16685 \ + --set external_services.tracing.external_url=http://localhost:16686 \ --set auth.strategy=anonymous \ kiali-server \ kiali/kiali-server @@ -241,4 +241,4 @@ And access Kiali: ``` kubectl port-forward svc/kiali 20001:20001 -n istio-system ``` -![Kiali Tempo Traces](/images/tutorial/tempo/kiali-tempo-traces.png "Kiali Tempo traces") \ No newline at end of file +![Kiali Tempo Traces](/images/tutorial/tempo/kiali-tempo-traces.png "Kiali Tempo traces") diff --git a/static/files/contribution_guide/config.yaml b/static/files/contribution_guide/config.yaml index de833863d..0e832480d 100644 --- a/static/files/contribution_guide/config.yaml +++ b/static/files/contribution_guide/config.yaml @@ -30,8 +30,8 @@ external_services: cache_enabled: true tracing: enabled: true - in_cluster_url: http://localhost:16685/jaeger - url: http://localhost:16686/jaeger + internal_url: http://localhost:16685/jaeger + external_url: http://localhost:16686/jaeger use_grpc: false whitelist_istio_system: - jaeger-query @@ -46,8 +46,8 @@ external_services: use_kiali_token: false username: internal grafana: - in_cluster_url: http://localhost:13000 - url: http://localhost:13000 + internal_url: http://localhost:13000 + external_url: http://localhost:13000 dashboards: - name: "Istio Service Dashboard" variables: