Cloud Service Mesh prerequisites

This page describes the prerequisites and the requirements for installing Cloud Service Mesh, such as GKE Enterprise licensing, cluster requirements, fleet requirements, and general requirements.

Cloud project

Before you begin:

GKE Enterprise licensing

GKE

Cloud Service Mesh is available with GKE Enterprise or as a standalone service. Google APIs are used to determine how you are billed. To use Cloud Service Mesh as a standalone service, don't enable the GKE Enterprise API in your project. The asmcli enables all of the other required Google APIs for you. For information about Cloud Service Mesh pricing, see Pricing.

  • GKE Enterprise subscribers, be sure to enable the GKE Enterprise API.

Enable the API

  • If you aren't an GKE Enterprise subscriber, you can still install Cloud Service Mesh, but certain UI elements and features in Google Cloud console are only available to GKE Enterprise subscribers. For information about what is available to subscribers and non-subscribers, see GKE Enterprise and Cloud Service Mesh UI differences.

  • If you enabled the GKE Enterprise API, but you want to use Cloud Service Mesh as a standalone service, disable the GKE Enterprise API.

Outside Google Cloud

To install Cloud Service Mesh on-premises, on GKE on AWS, on Amazon EKS, or on Microsoft AKS, you have to be an GKE Enterprise customer. GKE Enterprise customers are not billed separately for Cloud Service Mesh because it is already included in the GKE Enterprise pricing. For more information, see the GKE Enterprise Pricing guide.

General requirements

  • To be included in the service mesh, service ports must be named, and the name must include the port's protocol in the following syntax: name: protocol[-suffix] where the square brackets indicate an optional suffix that must start with a dash. For more information, see Naming service ports.

  • If you have created a service perimeter in your organization, you might need to add the Cloud Service Mesh certificate authority service to the perimeter. See Adding Cloud Service Mesh certificate authority to a service perimeter for more information.

  • If you want to change the default resource limits for the istio-proxy sidecar container, the new values must be greater than the default values to avoid out-of-memory (OOM) events.

  • A Google Cloud project can only have one mesh associated with it.

Cluster requirements

GKE

  • Verify that your cluster version is listed in Supported platforms.

  • Your GKE cluster must meet the following requirements:

    • The GKE cluster must be Standard. Autopilot clusters are only supported with managed Cloud Service Mesh.

    • A machine type that has at least 4 vCPUs, such as e2-standard-4. If the machine type for your cluster doesn't have at least 4 vCPUs, change the machine type as described in Migrating workloads to different machine types.

    • The minimum number of nodes depends on your machine type. Cloud Service Mesh requires at least 8 vCPUs. If the machine type has 4 vCPUs, your cluster must have at least 2 nodes. If the machine type has 8 vCPUs, the cluster only needs 1 node. If you need to add nodes, see Resizing a cluster.

  • GKE Workload Identity is required. We recommend that you enable Workload Identity before installing Cloud Service Mesh. Enabling Workload Identity changes the way calls from your workloads to Google APIs are secured, as described in Workload Identity limitations. Note that you do not need to enable the GKE Metadata Server on existing node pools.

  • Optional but recommended, enroll the cluster in a release channel. We recommend that you enroll in the Regular release channel because other channels might be based on a GKE version that isn't supported with Cloud Service Mesh 1.18.7. For more information, see Supported platforms. Follow the instructions in Enrolling an existing cluster in a release channel if you have a static GKE version.

  • If you are installing Cloud Service Mesh on a private cluster, you must open port 15017 in the firewall to get the webhooks used for automatic sidecar injection and configuration validation to work. For more information, see Opening a port on a private cluster.

  • Ensure that the client machine that you install Cloud Service Mesh from has network connectivity to the API server.

  • For Windows Server workloads, Cloud Service Mesh is not supported. If your cluster has both Linux and Windows Server node pools, you can still install Cloud Service Mesh and use it on your Linux workloads.

Outside Google Cloud

  • Ensure that the user cluster that you install Cloud Service Mesh on has at least 4 vCPUs, 15 GB memory, and 4 nodes.

  • Verify that your cluster version is listed in Supported platforms.

  • Ensure that the client machine that you install Cloud Service Mesh from has network connectivity to the API server.

  • If you are deploying sidecars in application pods where direct connectivity to CA services (such as meshca.googleapis.com and privateca.googleapis.com) is not available, you must configure an explicit CONNECT-based HTTPS proxy.

  • For public clusters with egress firewall rules set that are blocking implied rules, ensure you have configured HTTP/HTTPS and DNS rules to reach public Google APIs.

Fleet requirements

With Cloud Service Mesh 1.11 and later, all clusters must be registered to a fleet, and fleet workload identity must be enabled. You can either setup up the clusters yourself, or you can let asmcli register the clusters as long as they meet the following requirements:

  • GKE: (applies to in-cluster and managed Cloud Service Mesh) Enable GKE Workload Identity on your Google Kubernetes Engine cluster, if it is not already enabled. Additionally, you must register the cluster using fleet Workload Identity.

  • GKE clusters outside Google Cloud: (applies to in-cluster Cloud Service Mesh) Google Distributed Cloud, Google Distributed Cloud, GKE on AWS, and GKE on Azure are automatically registered to your project fleet at cluster creation time. As of GKE Enterprise 1.8, all these cluster types automatically enable fleet Workload Identity when registered. Existing registered clusters are updated to use fleet Workload Identity when they are upgraded to GKE Enterprise 1.8.

  • Amazon EKS clusters: (applies to in-cluster Cloud Service Mesh) The cluster must have a public IAM OIDC Identity Provider. Follow the instructions in Create an IAM OIDC provider for your cluster to check if a provider exists, and create a provider if necessary.

When you run asmcli install, you specify the project ID of the fleet host project. asmcli registers the cluster if it isn't already registered.

What's next?