Integrating with third-party add-ons

Note: This guide only supports Cloud Service Mesh with Istio APIs and doesnot support Google Cloud APIs. For more information see,Cloud Service Mesh overview.

Cloud Service Mesh profiles don't includePrometheus,Kiali, andGrafana add-ons.

Note, however, you can install your own instance of Prometheus, Kiali, andGrafana dashboards according to the applicablethird-party documentation.

This document applies to the in-cluster control plane only.

Enabling metrics export to Prometheus

To use the Prometheus, Grafana, or Kiali dashboards, Cloud Service Mesh mustbe configured to export metrics to Prometheus.

Metrics export to Prometheus is enabled by default when you installCloud Service Mesh on Google Distributed Cloud (software only) for VMware or on bare metal. On theseplatforms, you are all set to install your own instance of the dashboards.

You can enable metrics export to Prometheus instead of Stackdriver (now calledGoogle Cloud Observability) on GKE on Google Cloud clusters.

Before you begin

Follow the steps inInstall dependent tools and validate clusterto:

• Install required tools
• Downloadasmcli
• Grant cluster admin permissions
• Validate your project and cluster

Enable metrics export to Prometheus

1. Follow the steps in theinstall andupgradeCloud Service Mesh guide to install or upgrade Cloud Service Mesh onGKE. When you runasmcli install, include the followingoption:

   --option prometheus

   For example:

   ./asmcliinstall\--project_idPROJECT_ID\--cluster_nameCLUSTER_NAME\--cluster_locationCLUSTER_LOCATION\--output_dirDIR_PATH\--enable_all\--camesh_ca\--optionprometheus

   Caution: Using--option prometheus will disable metrics exportto Stackdriver. You must export metrics to Stackdriver if you want or needto use the Cloud Service Mesh dashboard features. You can enable bothStackdriver and Prometheus by using--option prometheus-and-stackdriver.Warning: With installation on GKE Enterprise On-premises clustersconfigured withenableStackdriverForApplications=true, enablingPrometheus may incur extra Cloud Monitoring charges. For moreinformation and disablingenableStackdriverForApplications, seeGKE Enterprise clusters on-prem known issues.To disable Prometheus annotations during Cloud Service Mesh installation, seedisable Prometheus metrics merging feature.Note: By default, `asmcli` doesn't install an ingress gateway, which you can useto manage inbound traffic to applications running on your service mesh. Followthe steps inInstall gateways to install an ingress gateway.

   Be sure to specify any otheroverlay filesthat you need to configure Cloud Service Mesh.

2. Complete the Cloud Service Mesh installation to enable automatic sidecarproxy injection on your workloads. For new installations, seeDeploy and redeploy workloads.For upgrades, seeSwitch to the new control plane

Third-party documentation

You candeploy Prometheus and Grafana through the Cloud Marketplace orrefer to the following documentation for installation.

• Grafana:

  • Getting started

  • Import the dashboards into an existing Grafana deployment.

• Kiali:

  • Quick Start guide

  • Installation Guide

• Prometheus:

  • Getting started