Uploaded image for project: 'OpenShift Service Mesh'
  1. OpenShift Service Mesh
  2. OSSM-8669

[Docs] Document url_format parameter (tracing)

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Unresolved
    • Icon: Blocker Blocker
    • OSSM 3.0.0
    • OSSM 3.0-TP2
    • Documentation
    • None
    • 5
    • False
    • None
    • False
    • Documentation (Ref Guide, User Guide, etc.)

      Update Kiali tracing section to add new configuration: https://docs.openshift.com/service-mesh/3.0.0tp1/observability/kiali/ossm-kiali-assembly.html

      spec:
        external_services:
          tracing:
            enabled: true (1)
            provider: tempo (2)
            use_grpc: false
            internal_url: https://tempo-sample-gateway.tempo.svc.cluster.local:8080/api/traces/v1/default/tempo (3)
            external_url: https://tempo-sample-gateway-tempo.apps-crc.testing/api/traces/v1/default/search (4)
            health_check_url: https://tempo-sample-gateway-tempo.apps-crc.testing/api/traces/v1/north/tempo/api/echo (5) 
            auth: (6)
              ca_file: /var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt
              insecure_skip_verify: false
              type: bearer
              use_kiali_token: true
            tempo_config:
               url_format: "jaeger" (7)
      

      (1) Enable tracing
      (2) tempo or jaeger. Tempo can expose a Jaeger or tempo API.
      (3) The internal url for the Tempo API. When Tempo is deployed in multi tenant, the tenant name must be specified https://tempo-sample-gateway.tempo.svc.cluster.local:8080/api/traces/v1/

      {tenantName}

      /tempo
      (4) The OpenShift route for Jaeger UI is created by the gateway when deployed in multi tenant. Otherwise, it must be created in the Tempo namespace. You can either manually create it for the tempo-sample-query-frontend service, or update the Tempo custom resource with .spec.template.queryFrontend.jaegerQuery.ingress.type: route
      (5) Not required. When deployed Tempo in multi tenant, the default heath check url used by Kiali is not exposed. This is an example of a valid health URL.
      (6) Not required. Used if the access url is HTTPS or authenticated.
      (7) Not required. Defaults to "grafana". Change to "jaeger" if the Kiali "View in tracing" link should redirect to the Jaeger console UI.

              rhn-support-ssiddhar Shreya Siddhartha
              rh-ee-jcordoba Josune Cordoba Torrecilla
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated: