Step 3: Install ASM

You are currently viewing version 1.4 of the Apigee hybrid documentation.This version is end of life. You should upgrade to a newer version. For more information, seeSupported versions.

Install ASM

Apigee hybrid uses the Istio distribution provided with Anthos Service Mesh (ASM). Follow these steps to install ASM in your cluster.

Supported ASM versions

  • For new hybrid version 1.4.4 installations, install ASM version 1.7.x.
  • For upgrades from previous versions of hybrid, install ASM version 1.6.x.

Perform ASM setup and configuration steps

To complete the ASM installation, you must first follow ASM-specific setup and configuration steps in the ASM documentation. Then, you must return here to complete the hybrid-specific configuration before applying the configuration to the cluster.

The instructions to install and configure ASM are different depending on your platform. Choose the steps your platform below.

The following configuration assumes that clients will be SNI enabled by default. If they are not, see the instructions toEnable non-SNI and HTTP clients.

GKE

  1. Follow the ASM setup and configuration steps:Important:When following the ASM documentation,do not install or apply the YAML configuration fileistio-operator.yaml when instructed to do so. At that time, we require you to return to this page to edit the file with further hybrid-specific configurations before installing/applying the configuration.
  2. When you have completed the ASM setup and config steps, go to the next section to complete the hybrid configuration and ASM installation steps.

Perform final hybrid configuration and install ASM

Finally, add hybrid-specific configurations to theistio-operator.yaml file and install ASM.

  1. Ensure that you're in the ASM installation's root directory. For example:1.7.3-asm.6.
  2. Open theistio-operator.yaml file in an editor.
    • InASM 1.7.x:./asm/istio/istio-operator.yaml
    • InASM 1.6.x:./asm/cluster/istio-operator.yaml
  3. Add (or update) thespec:components stanza in theistio-operator.yaml file below themeshConfig: section and immediately abovevalues:, wherereserved_static_ip is an IP address your runtime ingress gateway can use. If you do not have a reserved static IP address, for this Quick Start, you can leave theLoadBalancerIP property out.

    Text to copy

      components:    ingressGateways:    - name: istio-ingressgateway      enabled: true      k8s:        service:          type: LoadBalancer          loadBalancerIP: static_ip # If you do not have a reserved static IP, leave this out.          ports:          - name: status-port            port: 15021 # for ASM 1.7.x and above, else 15020            targetPort: 15021 # for ASM 1.7.x and above, else 15020          - name: http2            port: 80            targetPort: 8080          - name: https            port: 443            targetPort: 8443

    Example showing placement

    Line breaks inserted for readability

    apiVersion:install.istio.io/v1alpha1kind:IstioOperatormetadata:clusterName:"hybrid-example/us-central1/example-cluster"# {"$ref":"#/definitions/io.k8s.cli.substitutions.cluster-name"}spec:profile:asmhub:gcr.io/gke-release/asm# {"$ref":"#/definitions/io.k8s.cli.setters.anthos.servicemesh.hub"}tag:1.5.7-asm.0# {"$ref":"#/definitions/io.k8s.cli.setters.anthos.servicemesh.tag"}meshConfig:defaultConfig:proxyMetadata:GCP_METADATA:"hybrid-example|123456789123|example-cluster|us-central1"#{"$ref":"#/definitions/io.k8s.cli.substitutions.gke-metadata"}components:pilot:k8s:hpaSpec:maxReplicas:2ingressGateways:-name:istio-ingressgatewayenabled:truek8s:service:type:LoadBalancerloadBalancerIP:123.234.56.78ports:-name:status-portport:15021# for ASM 1.7.x and above, else 15020targetPort:15021# for ASM 1.7.x and above, else 15020-name:http2port:80targetPort:8080-name:httpsport:443targetPort:8443hpaSpec:maxReplicas:2values:...
  4. Return now to the ASM documentation you used previously, and complete ASM installation (install or apply theistio-operator.yaml file to the cluster). If you are on ASM 1.6 and given a choice, choosePERMISSIVE mTLS.Note:If you are on ASM 1.6, we recommend that you use theasmctl validate command to validate the configuration and health of the installed components. This command is described in the ASM documentation section on validating the installation. This command is only valid if you are on ASM 1.6.

GKE on-prem

Set up and download ASM

Use the ASM documentation to set up your environment and download ASM.

  1. Read the following steps carefully before you begin.We will ask you to perform some of the steps listed in the ASM documentation, then return here tocomplete the installation.
  2. Go toInstalling Anthos Service Mesh on premises and perform all of the ASM steps up to and includingCreate theistio-system namespace, then stop and go to the next sectionApply the manifest below.Important: After completing the steps in the sectionCreate theistio-system namespace, stop and continue with the steps listed in the next section. We recommend that you wait to apply the manifest file until instructed below.

Apply the manifest

When you have downloaded and unzipped the ASM installation file, continue with the following steps:

  1. Make sure you are in the Istio directory that you downloaded and unzipped. For example:1.7.3-asm.6.
  2. Execute the following command, whereyour_static_ip is a static IP address that the istio ingress component can use. If you do not have a static IP address reserved, leave the--set values.gateways.istio-ingressgateway.loadBalancerIP line out:
    ./bin/istioctl install --set profile=asm-multicloud \ --set values.gateways.istio-ingressgateway.loadBalancerIP=your_static_IP
  3. Finally, return to the ASM documentation toCheck the control plane components to validate your installation.

Customizing the ASM installation

The ASM installation you just performed is a minimal installation, sufficient to test and use Apigee hybrid for basic use cases. For information on addressing more advanced use cases, such as adding, removing, or modifying load balancer port numbers, seeEnabling optional features.

Summary

You now have cert-manager and ASM installed, and you are ready to install the Apigee hybrid command line tool on your local machine.

AKS

Set up and download ASM

Use the ASM documentation to set up your environment and download ASM.

  1. Read the following steps carefully before you begin.We will ask you to perform some of the steps listed in the ASM documentation, then return here tocomplete the installation.
  2. Go toInstalling Anthos Service Mesh on attached clusters and perform all of the ASM steps up to and includingCreate theistio-system namespace, then stop and go to the next sectionApply the manifest below.Important: After completing the steps in the sectionCreate theistio-system namespace, stop and continue with the steps listed in the next section. We recommend that you wait to apply the manifest file until instructed below.

Apply the manifest

When you have downloaded and unzipped the ASM installation file, continue with the following steps:

  1. Make sure you are in the Istio directory that you downloaded and unzipped. For example:1.7.3-asm.6.
  2. Execute the following command, whereyour_static_ip is a static IP address that the istio ingress component can use. If you do not have a static IP address reserved, leave the--set values.gateways.istio-ingressgateway.loadBalancerIP line out:
    ./bin/istioctl install --set profile=asm-multicloud \ --set values.gateways.istio-ingressgateway.loadBalancerIP=your_static_IP
  3. Finally, return to the ASM documentation toCheck the control plane components to validate your installation.

Customizing the ASM installation

The ASM installation you just performed is a minimal installation, sufficient to test and use Apigee hybrid for basic use cases. For information on addressing more advanced use cases, such as adding, removing, or modifying load balancer port numbers, seeEnabling optional features.

Summary

You now have cert-manager and ASM installed, and you are ready to install the Apigee hybrid command line tool on your local machine.

GKE on AWS

Set up and download ASM

Use the ASM documentation to set up your environment and download ASM.

  1. Read the following steps carefully before you begin.We will ask you to perform some of the steps listed in the ASM documentation, then return here tocomplete the installation.
  2. Go toInstalling Anthos Service Mesh on GKE on AWS and perform all of the ASM steps up to and includingDownload the installation file, then stop and go to the next sectionApply the manifest below.Important: After completing the steps in the sectionDownload the installation file, stop and continue with the steps listed in the next section. We recommend that you wait to apply the manifest file until instructed below.

Apply the manifest

When you have downloaded and unzipped the ASM installation file, continue with the following steps:

  1. Make sure you are in the Istio directory that you downloaded and unzipped. For example:1.7.3-asm.6.
  2. Execute the following command, whereyour_static_ip is a static IP address that the istio ingress component can use. If you do not have a static IP address reserved, leave the--set values.gateways.istio-ingressgateway.loadBalancerIP line out:
    ./bin/istioctl install --set profile=asm-multicloud \ --set values.gateways.istio-ingressgateway.loadBalancerIP=your_static_IP
  3. Finally, return to the ASM documentation toCheck the control plane components to validate your installation.

Customizing the ASM installation

The ASM installation you just performed is a minimal installation, sufficient to test and use Apigee hybrid for basic use cases. For information on addressing more advanced use cases, such as adding, removing, or modifying load balancer port numbers, seeEnabling optional features.

Summary

You now have cert-manager and ASM installed, and you are ready to install the Apigee hybrid command line tool on your local machine.

EKS

Set up and download ASM

Use the ASM documentation to set up your environment and download ASM.

  1. Read the following steps carefully before you begin.We will ask you to perform some of the steps listed in the ASM documentation, then return here tocomplete the installation.
  2. Go toInstalling Anthos Service Mesh on attached clusters and perform all of the ASM steps up to and includingCreate theistio-system namespace, then stop and go to the next sectionApply the manifest below.Important: After completing the steps in the sectionCreate theistio-system namespace, stop and continue with the steps listed in the next section. We recommend that you wait to apply the manifest file until instructed below.

Apply the manifest

When you have downloaded and unzipped the ASM installation file, continue with the following steps:

  1. Make sure you are in the Istio directory that you downloaded and unzipped. For example:1.7.3-asm.6.
  2. Execute the following command, whereyour_static_ip is a static IP address that the istio ingress component can use. If you do not have a static IP address reserved, leave the--set values.gateways.istio-ingressgateway.loadBalancerIP line out:
    ./bin/istioctl install --set profile=asm-multicloud \ --set values.gateways.istio-ingressgateway.loadBalancerIP=your_static_IP
  3. Finally, return to the ASM documentation toCheck the control plane components to validate your installation.

Customizing the ASM installation

The ASM installation you just performed is a minimal installation, sufficient to test and use Apigee hybrid for basic use cases. For information on addressing more advanced use cases, such as adding, removing, or modifying load balancer port numbers, seeEnabling optional features.

Summary

You now have cert-manager and ASM installed, and you are ready to install the Apigee hybrid command line tool on your local machine.

Summary

You now have cert-manager and ASM installed, and you are ready to install the Apigee hybrid command line tool on your local machine.

123(NEXT) Step 4: Install apigeectl567

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-19 UTC.