Chapter 4. Kiali Operator provided by Red Hat

Procedure

1. Update the Kiali resource spec configuration for tracing:

   Example Kiali resource spec configuration for tracing:

   spec:
     external_services:
       tracing:
         enabled: true
         provider: tempo
         use_grpc: false
         internal_url: https://tempo-sample-gateway.tempo.svc.cluster.local:8080/api/traces/v1/default/tempo
         external_url: https://tempo-sample-gateway-tempo.apps-crc.testing/api/traces/v1/default/search 

   1

   
         health_check_url: https://tempo-sample-gateway-tempo.apps-crc.testing/api/traces/v1/default/tempo/api/echo
         auth: 

   2

   
           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"

   • spec.external_services.tracing.enabled specifies whether you have enabled tracing.
   • spec.external_services.tracing.provider specifies either distributed tracing platform (Tempo) or distributed tracing platform (Jaeger). The distributed tracing platform can expose a Jaeger API or a Tempo API.
   • spec.external_services.tracing.internal_url specifies the internal URL for the Tempo API. When you deploy the distributed tracing platform in multitenancy, include the tenant name in the URL path of the internal_url parameter. In this example, default represents the tenant name.
   • spec.external_services.tracing.external_url specifies the external URL for the Jaeger UI. When you deploy the distributed tracing platform in multitenancy, the gateway creates the route. Otherwise, you must create the route in the Tempo namespace. You can manually create the route for the tempo-sample-query-frontend service or update the Tempo custom resource with .spec.template.queryFrontend.jaegerQuery.ingress.type: route.
   • spec.external_services.tracing.health_check_url specifies the health check URL. Not required by default. When you deploy the distributed tracing platform in multitenancy, it does not expose the default health check URL. This is an example of a valid health URL.
   • spec.external_services.tracing.auth specifies the configuration used when the access URL is HTTPS or requires authentication. Not required by default.
   • spec.external_services.tracing.tempo_config.url_format specifies the configuration that defaults to grafana. Not required by default. Change to jaeger if the Kiali View in tracing link redirects to the Jaeger console UI.
2. Save the updated spec in kiali_cr.yaml.

3. Run the following command to apply the configuration:

   $ oc patch -n istio-system kiali kiali --type merge -p "$(cat kiali_cr.yaml)"

   Example output:

    kiali.kiali.io/kiali patched

Verification

1. Run the following command to get the Kiali route:

   $ oc get route kiali ns istio-system

2. Navigate to the Kiali UI.
3. Navigate to Workload Traces tab to see traces in the Kiali UI.

Procedure

1. Deploy the Kiali Operator on all clusters using the procedure "Installing Kiali in a multi-cluster mesh".

2. For clusters where Kiali is not deployed, configure the Kiali CR to create only the remote cluster resources by setting the spec.deployment.remote_cluster_resources_only field to true, similar to the following example:

   apiVersion: kiali.io/v1alpha1
   kind: Kiali
   metadata:
     name: kiali
     namespace: istio-system
   spec:
     version: default
     auth:
     deployment:
       remote_cluster_resources_only: true

3. Ensure the Kiali namespace and instance name are consistent across all clusters. If you change the default namespace (istio-system) or instance name (kiali), you must apply the same values to the following Kiali CR settings on every cluster:

   • spec.deployment.namespace
   • spec.deployment.instance_name

Procedure

1. Navigate to Installed Operators.
2. Click Kiali Operator provided by Red Hat.
3. Click Create instance on the Red Hat OpenShift Service Mesh Console tile. You can also click Create OSSMConsole button under the OpenShift Service Mesh Console tab.

4. Use the Create OSSMConsole form to create an instance of the OSSMConsole custom resource (CR). Name and Version are the required fields.

   Note

   The Version field must match with the spec.version field in your Kiali custom resource (CR). If Version value is the string default, the Kiali Operator installs OpenShift Service Mesh Console (OSSMC) with the same version as the operator. The spec.version field requires the v prefix in the version number. The version number must only include the major and minor version numbers (not the patch number); for example: v1.73.

5. Click Create.

Verification

1. Wait for the web console to confirm the OSSMC plugin installation and prompt you to refresh.
2. Verify that the Service Mesh category shows up in the main OpenShift Container Platform web console navigation.

Procedure

1. Create a OSSMConsole custom resource (CR) to install the plugin by running the following command:

   $ cat <<EOM | oc apply -f -
   apiVersion: kiali.io/v1alpha1
   kind: OSSMConsole
   metadata:
     namespace: openshift-operators
     name: ossmconsole
   spec:
     version: default
   EOM

   Note

   The OpenShift Service Mesh Console (OSSMC) version must match with the Kiali Server version. If spec.version field value is the string default or is not specified, the Kiali Operator installs OSSMC with the same version as the operator. The spec.version field requires the v prefix in the version number. The version number must only include the major and minor version numbers (not the patch number); for example: v1.73.

   The plugin resources deploy in the same namespace as the OSSMConsole CR.

2. Optional: If you installed more than one Kiali Server in the cluster, specify the spec.kiali setting in the OSSMConsole CR similar to the following example:

   $ cat <<EOM | oc apply -f -
   apiVersion: kiali.io/v1alpha1
   kind: OSSMConsole
   metadata:
     namespace: openshift-operators
     name: ossmconsole
   spec:
     kiali:
       serviceName: kiali
       serviceNamespace: istio-system-two
       servicePort: 20001
   EOM

Verification

1. Go to the OpenShift Container Platform web console.
2. Verify that the Service Mesh category shows up in the main OpenShift Container Platform web console navigation.
3. Wait for the web console to confirm the OSSMC plugin installation and prompt you to refresh.

Procedure

1. Navigate to Installed Operators.
2. Click Kiali Operator.
3. Select the OpenShift Service Mesh Console tab.
4. Click Delete OSSMConsole option from the entry menu.
5. Confirm that you want to delete the plugin.