Set up your project and cluster yourself

When you install Cloud Service Mesh using asmcli, it can configure your project and your cluster for you if you include the --enable_all flag or the more granular enablement flags. If you prefer to do the setup yourself rather than having asmcli make the changes, follow the steps on this page.

If you already have a previous version of Cloud Service Mesh installed, you don't need to make any changes to your project or cluster before using asmcli to upgrade to the latest Cloud Service Mesh version.

By default, asmcli doesn't install the istio-ingressgateway. We recommend that you deploy and manage the control plane and gateways separately. Cloud Service Mesh supports auto-injection for gateway deployments, which makes Cloud Service Mesh upgrades easier. After upgrading Cloud Service Mesh, you restart the gateways just like your services to pick up the new control plane configuration. For more information, see Installing and upgrading gateways.

Before you begin

Set up your project

  1. Get the project ID for the project that the cluster was created in.


    Run the following command:

    gcloud projects list


    1. Go to the Dashboard page in the Google Cloud console.

      Go to the Dashboard page

    2. Click the drop-down list at the top of the page. In the Select from window that appears, select your project.

      The project ID is displayed on the project Dashboard Project info card.

  2. Create an environment variable for the workload pool using the project ID:

  3. Set the required Identity and Access Management (IAM) roles. If you are a Project Owner, you have all the necessary permissions to complete the installation. If you aren't a Project Owner, you need someone who is to grant you the following specific IAM roles. In the following command, replace PROJECT_ID with the project ID from the previous step and GCP_EMAIL_ADDRESS with the account that you use to sign in to Google Cloud.

    'roles/servicemanagement.admin' \
    'roles/serviceusage.serviceUsageAdmin' \
    'roles/meshconfig.admin' \
    'roles/compute.admin' \
    'roles/container.admin' \
    'roles/resourcemanager.projectIamAdmin' \
    'roles/iam.serviceAccountAdmin' \
    'roles/iam.serviceAccountKeyAdmin' \
    for role in "${ROLES[@]}"
      gcloud projects add-iam-policy-binding PROJECT_ID \
        --member "user:GCP_EMAIL_ADDRESS" \

    If you include the --enable_all or --enable_gcp_iam_roles flag when you run asmcli, it sets the required IAM roles for you.

  4. Enable the required Google APIs:

    gcloud services enable \
        --project=PROJECT_ID \

    In addition to, this command also enables the following APIs:

    API Purpose Can Be Disabled Cloud Service Mesh uses the Mesh Configuration API to relay configuration data from your mesh to Google Cloud. Additionally, enabling the Mesh Configuration API lets you access the Cloud Service Mesh pages in the Google Cloud console and to use the Cloud Service Mesh certificate authority. No Related to Cloud Service Mesh certificate authority used by managed Cloud Service Mesh. No Required to create Google Kubernetes Engine (GKE) clusters. No Required to manage the mesh as a fleet. No Required to capture telemetry for mesh workloads. No Required to use the Services UI. No Required to use the Services UI for off-Google Cloud clusters. No Required so that the managed Cloud Service Mesh control plane can access mesh workloads. Yes* Enables a highly available and scalable managed control plane. Yes* Enables a highly available and scalable managed control plane. Yes* Enables a highly available and scalable managed control plane. Yes*

    Enabling the APIs can take a minute or more to complete. When the APIs are enabled, you see output similar to the following:

    Operation "operations/acf.601db672-88e6-4f98-8ceb-aa3b5725533c" finished

    If you include the --enable_all or --enable_apis flag when you run asmcli, it enables the required APIs for you.

Set up your cluster

If you include the --enable_all flag, or one of the more granular enablement flags, asmcli sets up your cluster for you.

  1. Register the cluster to the fleet.

  2. Initialize your project to ready it for installation. Among other things, this command creates a service account to let data plane components, such as the sidecar proxy, securely access your project's data and resources. In the following command replace FLEET_PROJECT_ID with the fleet host project:

    curl --request POST  \
     --header "Authorization: Bearer $(gcloud auth print-access-token)" \
     --header "Content-Type: application/json" \
     --data '{"workloadIdentityPools":["","",""]}' \

    The command responds with empty curly braces: {}

  3. For GKE on Google Cloud clusters, set the default zone or region for the Google Cloud CLI. If you don't set the default here, be sure to specify either the --zone or --region option in the gcloud container clusters commands on this page.

    • If you have a single-zone cluster, set the default zone:

      gcloud config set compute/zone CLUSTER_LOCATION
    • If you have a regional cluster, set the default region:

      gcloud config set compute/region CLUSTER_LOCATION
  4. For GKE on Google Cloud clusters, enable Workload Identity:

    gcloud container clusters update CLUSTER_NAME \
        --project=PROJECT_ID \

    Enabling Workload Identity can take up to 10 to 15 minutes.

  5. For GKE on Google Cloud clusters, enable Cloud Monitoring and Cloud Logging on GKE:

    gcloud container clusters update CLUSTER_NAME \
        --project=PROJECT_ID \

Your project and cluster are now ready for a new installation using asmcli.

What's next