Upgrading to version 1.6.9 overview.
The procedures for upgrading Apigee hybrid are organized in the following sections:
- Backup your hybrid installation.
- Check your Kubernetes version and upgrade as appropriate.
- Install hybrid runtime version 1.6.9.
- Upgrade ASM.
Prerequisite
These upgrade instructions assume you have Apigee hybrid 1.5 installed and wish to upgrade it to version 1.6.9. If you are updating from an earlier version see the instructions for Upgrading Apigee hybrid to version 1.5.
Upgrade to version 1.6
- These instructions use the environment variable $APIGEECTL_HOMEfor the directory in your file system where theapigeectlutility is installed. If needed,cdinto yourapigeectldirectory and define the variable with the following command:Linuxexport APIGEECTL_HOME=$PWD echo $APIGEECTL_HOME Mac OSexport APIGEECTL_HOME=$PWD echo $APIGEECTL_HOME Windowsset APIGEECTL_HOME=%CD% echo %APIGEECTL_HOME% 
- (Recommended) Make a backup copy of your version 1.5 $APIGEECTL_HOME/directory. For example:tar -czvf $APIGEECTL_HOME/../apigeectl-v1.5-backup.tar.gz $APIGEECTL_HOME
- (Recommended) Back up your Cassandra database following the instructions in Cassandra backup and recovery
- Upgrade your Kubernetes platform to the versions supported by hybrid 1.6. Follow your platform's documentation if you need help.
- If you are running a version of cert-managerprior to v1.5.4, you need to upgrade it to v1.5.4.- 
        Check the current cert-managerversion using the following command:kubectl -n cert-manager get deployment -o yaml | grep 'image:' Something similar to the following is returned: image: quay.io/jetstack/cert-manager-controller:v1.5.4 image: quay.io/jetstack/cert-manager-cainjector:v1.5.4 image: quay.io/jetstack/cert-manager-webhook:v1.5.4 
- 
        Remove the deployments using the following command:
$ kubectl delete -n cert-manager deployment cert-manager cert-manager-cainjector cert-manager-webhook 
- 
        Upgrade cert-managerto v1.5.4 version using the following command:$ kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.5.4/cert-manager.yaml 
 
- 
        
- Create the apigee-runtimeservice account required for use with Google OAUTH tokens. Use thecreate-service-accounttool:- Create the service account:
        ./tools/create-service-account --env prod --profile apigee-runtime 
- Add the new service account to your Apigee overrides.yamlfile:envs: - name: "environment-name" … … … serviceAccountPaths: runtime: "path-to-service-account-file" … … …
 
- Create the service account:
        
- Add the udca.serviceAccountPathproperty at the top level in your overrides file, in addition to the entry underenvs.udcamust appear in your overrides twice, once at the environment level and once at the organization level, parallel withconnectAgent,logger,mart,metrics, andwatcher.For example: … … … metrics: serviceAccountPath: "metrics-service-account-file" udca: serviceAccountPath: "udca-service-account-file" watcher: serviceAccountPath: "watcher-service-account-file" … … … 
- Optional: If plan to use Cloud trace ensure your
    apigee-runtimeservice account has the Cloud Trace Agent (roles/cloudtrace.agent) Google role. You can do so in the Cloud console > IAM & Admin > Service accounts UI or with the following commands:- Get the email address for your apigee-runtimeservice account with the following command:gcloud iam service-accounts list --filter "apigee-runtime" If it matches the pattern apigee-runtime@$ORG_NAME.iam.gserviceaccount.com, you can use that pattern in the next step.
- Assign the Cloud Trace Agent role to the service account:
        gcloud projects add-iam-policy-binding $PROJECT_ID \ --member="serviceAccount:apigee-runtime@$PROJECT_ID.iam.gserviceaccount.com" \ --role="roles/cloudtrace.agent"WWhere: $PROJECT_ID is the name of the Google Cloud project where Apigee hybrid is installed. 
 
- Get the email address for your 
Install the hybrid 1.6.9 runtime
- Be sure you are in the hybrid base directory (the parent of the directory where
    the apigeectlexecutable file is located):cd $APIGEECTL_HOME/.. 
- 
    Download the release package for your operating system using the following command. Be sure to select your platform in the following table: LinuxLinux 64 bit: curl -LO \ https://storage.googleapis.com/apigee-release/hybrid/apigee-hybrid-setup/1.6.9/apigeectl_linux_64.tar.gz Mac OSMac 64 bit: curl -LO \ https://storage.googleapis.com/apigee-release/hybrid/apigee-hybrid-setup/1.6.9/apigeectl_mac_64.tar.gz WindowsWindows 64 bit: curl -LO ^ https://storage.googleapis.com/apigee-release/hybrid/apigee-hybrid-setup/1.6.9/apigeectl_windows_64.zip 
- Rename your current apigeectl/directory to a backup directory name. For example:Linuxmv $APIGEECTL_HOME/ $APIGEECTL_HOME-v1.5/ Mac OSmv $APIGEECTL_HOME/ $APIGEECTL_HOME-v1.5/ Windowsrename %APIGEECTL_HOME% %APIGEECTL_HOME%-v1.5 
- 
    Extract the downloaded gzip file contents into your hybrid base directory. The hybrid base directory is the directory where the renamed apigeectl-v1.5directory is located:Linuxtar xvzf filename.tar.gz -C ./ Mac OStar xvzf filename.tar.gz -C ./ Windowstar xvzf filename.zip -C ./ 
- 
    The tar contents are, by default, expanded into a directory with the version and platform in its name. For example: ./apigeectl_1.6.9-d591b23_linux_64. Rename that directory toapigeectlusing the following command:Linuxmv directory-name-linux apigeectl Mac OSmv directory-name-mac apigeectl Windowsrename directory-name-windows apigeectl 
- 
    Change to the apigeectldirectory:cd ./apigeectl The apigeectlexecutable is in this directory.
- These instructions use the environment variable $APIGEECTL_HOMEfor the directory in your file system where theapigeectlutility is installed. If needed,cdinto yourapigeectldirectory and define the variable with the following command:Linuxexport APIGEECTL_HOME=$PWD echo $APIGEECTL_HOME Mac OSexport APIGEECTL_HOME=$PWD echo $APIGEECTL_HOME Windowsset APIGEECTL_HOME=%CD% echo %APIGEECTL_HOME% 
- Verify the version of apigeectlwith theversioncommand:./apigeectl version Version: 1.6.9 
- Move to the hybrid-base-directory/hybrid-filesdirectory. Thehybrid-filesdirectory is where configuration files such as the overrides file, certs, and service accounts are located. For example:cd $APIGEECTL_HOME/../hybrid-files 
- Verify that kubectlis set to the correct context using the following command. The current context should be set to the cluster in which you are upgrading Apigee hybrid.kubectl config get-contexts | grep \* 
- In the hybrid-filesdirectory:- 
    Update the following symbolic links to
    $APIGEECTL_HOME. These links allow you to run the newly installedapigeectlcommand from inside thehybrid-filesdirectory:ln -nfs $APIGEECTL_HOME/tools toolsln -nfs$APIGEECTL_HOME/config configln -nfs$APIGEECTL_HOME/templates templatesln -nfs$APIGEECTL_HOME/plugins plugins
- 
    To check that the symlinks were created correctly, execute the following command and make
    sure the link paths point to the correct locations:
    ls -l | grep ^l 
- Do a dry run initialization to check for errors:
      ${APIGEECTL_HOME}/apigeectl init -f ./overrides/OVERRIDES.yaml --dry-run=clientWhere OVERRIDES is the name of your overrides file. 
- If there are no errors, initialize hybrid 1.6.9:
      ${APIGEECTL_HOME}/apigeectl init -f ./overrides/OVERRIDES.yaml
- Check the initialization status:
      ${APIGEECTL_HOME}/apigeectl check-ready -f ./overrides/OVERRIDES.yaml
- Check for errors with a dry run of the applycommand:${APIGEECTL_HOME}/apigeectl apply -f ./overrides/OVERRIDES.yaml --dry-run=client
- If there are no errors, apply your overrides. Select and follow the instructions for production environments or
      demo/experimental environments, depending on your installation.
      
      ProductionFor production environments you should upgrade each hybrid component individually, and check the status of the upgraded component before proceeding to the next component. - Be sure you are in the hybrid-filesdirectory.
- Apply your overrides to upgrade Cassandra:
              ${APIGEECTL_HOME}/apigeectl apply -f ./overrides/OVERRIDES.yaml --datastore
- Check completion:
              ${APIGEECTL_HOME}/apigeectl check-ready -f ./overrides/OVERRIDES.yamlProceed to the next step only when the pods are ready. 
- Apply your overrides to upgrade Telemetry components and check completion:
              ${APIGEECTL_HOME}/apigeectl apply -f ./overrides/OVERRIDES.yaml --telemetry${APIGEECTL_HOME}/apigeectl check-ready -f ./overrides/OVERRIDES.yaml
- Bring up Redis components:
              ${APIGEECTL_HOME}/apigeectl apply -f ./overrides/OVERRIDES.yaml --redis
- Apply your overrides to upgrade the org-level components (MART, Watcher and Apigee
              Connect) and check completion:
              ${APIGEECTL_HOME}/apigeectl apply -f ./overrides/OVERRIDES.yaml --org${APIGEECTL_HOME}/apigeectl check-ready -f ./overrides/OVERRIDES.yaml
- Apply your overrides to upgrade your environments. You have two choices:
              - Environment by environment: Apply your overrides to one environment at a time and check completion. Repeat
                  this step for each environment:
                   ${APIGEECTL_HOME}/apigeectl apply -f ./overrides/OVERRIDES.yaml --env ENV_NAME${APIGEECTL_HOME}/apigeectl check-ready -f ./overrides/OVERRIDES.yamlWhere ENV_NAME is the name of the environment you are upgrading. 
- All environments at one time: Apply your overrides to all environments at once and check completion:
                 ${APIGEECTL_HOME}/apigeectl apply -f ./overrides/OVERRIDES.yaml --all-envs${APIGEECTL_HOME}/apigeectl check-ready -f ./overrides/OVERRIDES.yaml
 
- Environment by environment: Apply your overrides to one environment at a time and check completion. Repeat
                  this step for each environment:
                   
 Demo/ExperimentalIn most demo or experimental environments, you can apply the overrides to all components at once. If your demo/experimental environment large and complex or closely mimics a production environment, you may want to use the instructions for upgrading production environments - Be sure you are in the hybrid-filesdirectory.
- ${APIGEECTL_HOME}/apigeectl apply -f ./overrides/OVERRIDES.yaml
- Check the status:
              ${APIGEECTL_HOME}/apigeectl check-ready -f ./overrides/OVERRIDES.yaml
 
- Be sure you are in the 
 
- 
    Update the following symbolic links to
    
Upgrade ASM to version 1.27
Perform the upgrade using the ASM documentation appropriate for your platform:
The instructions to install and configure ASM are different depending on your platform. The platforms are divided into the following categories:
- GKE: Google Kubernetes Engine clusters running on Google Cloud.
- Outside Google Cloud: Anthos clusters running on:
  - Anthos clusters on VMware (GKE on-prem)
- Anthos on bare metal
- Anthos clusters on AWS
- Amazon EKS
 
- Other Kubernetes Platforms: Conformant clusters created and running on:
  - AKS
- EKS
- OpenShift
 
GKE
The sequence for upgrading to ASM version 1.27.2 for your hybrid installation is as follows:
- Prepare for the upgrade.
- Install the new version of ASM.
- Delete the previous ASM version's deployments, services, and webhooks from your current installation.
- Upgrade your gateways and configure the new webhooks.
To upgrade to ASM version 1.27.2 for hybrid on GKE:
- Review the requirements in Upgrade Anthos Service Mesh, but do not perform the upgrade yet.
- Before installing the new version, determine the current revision. You will need
                 this information to delete the previous ASM version's deployments, services, and
                 webhooks from your current installation. Use the following command to store the
                 current istiod revision to an environment variable:
export DELETE_REV=$(kubectl get deploy -n istio-system -l app=istiod -o jsonpath={.items[].metadata.labels.'istio\.io\/rev'}'{"\n"}') echo ${DELETE_REV}
- Create a new overlay.yamlfile or verify that your existingoverlay.yamlcontains the following contents:apiVersion: install.istio.io/v1alpha1 kind: IstioOperator spec: revision: asm-1272-1 components: ingressGateways: - name: istio-ingressgateway enabled: true k8s: nodeSelector: # default node selector, if different or not using node selectors, change accordingly. cloud.google.com/gke-nodepool: apigee-runtime resources: requests: cpu: 1000m service: type: LoadBalancer loadBalancerIP: STATIC_IP # If you do not have a reserved static IP, leave this out. ports: - name: http-status-port port: 15021 - name: http2 port: 80 targetPort: 8080 - name: https port: 443 targetPort: 8443 meshConfig: accessLogFormat: '{"start_time":"%START_TIME%","remote_address":"%DOWNSTREAM_DIRECT_REMOTE_ADDRESS%","user_agent":"%REQ(USER-AGENT)%","host":"%REQ(:AUTHORITY)%","request":"%REQ(:METHOD)% %REQ(X-ENVOY-ORIGINAL-PATH?:PATH)% %PROTOCOL%","request_time":"%DURATION%","status":"%RESPONSE_CODE%","status_details":"%RESPONSE_CODE_DETAILS%","bytes_received":"%BYTES_RECEIVED%","bytes_sent":"%BYTES_SENT%","upstream_address":"%UPSTREAM_HOST%","upstream_response_flags":"%RESPONSE_FLAGS%","upstream_response_time":"%RESPONSE_DURATION%","upstream_service_time":"%RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)%","upstream_cluster":"%UPSTREAM_CLUSTER%","x_forwarded_for":"%REQ(X-FORWARDED-FOR)%","request_method":"%REQ(:METHOD)%","request_path":"%REQ(X-ENVOY-ORIGINAL-PATH?:PATH)%","request_protocol":"%PROTOCOL%","tls_protocol":"%DOWNSTREAM_TLS_VERSION%","request_id":"%REQ(X-REQUEST-ID)%","sni_host":"%REQUESTED_SERVER_NAME%","apigee_dynamic_data":"%DYNAMIC_METADATA(envoy.lua)%"}' 
- Follow the instructions in the following sections in the ASM documentation:
                 
                 - Download asmcli
- Grant cluster admin permissions
- Validate project and cluster
- Upgrade with optional features. Stop before starting the "Upgrade Gateways section"
 
- Delete the mutating webhook and validating webhook:
                 - cdinto the directory where you installed- asmcli.
- Store the current new revision in an environment variable to use in the script
                     to delete the webhooks:
                   UPGRADE_REV="asm-1272-1" 
- create a shell script containing the following commands:
#!/bin/bash set -ex PROJECT_ID="YOUR_PROJECT_ID" CLUSTER_NAME="YOUR_CLUSTER_NAME" CLUSTER_LOCATION="YOUR_CLUSTER_LOCATION" kubectl label namespace istio-system istio.io/rev=${UPGRADE_REV} istio-injection- --overwrite kubectl rollout restart deployment -n istio-system kubectl apply -n istio-system -f PATH_TO_INGRESSGATEWAYistio-ingressgateway kubectl apply -n istio-system -f PATH_TO_INGRESSGATEWAY/istio-ingressgateway-connectors if [[ "${DELETE_REV}" != "${UPGRADE_REV}" ]]; then kubectl apply -f out/asm/istio/istiod-service.yaml kubectl delete deploy -l app=istio-ingressgateway,istio.io/rev=${DELETE_REV} -n istio-system --ignore-not-found=true kubectl delete deploy -l app=istio-ingressgateway-connectors,istio.io/rev=${DELETE_REV} -n istio-system --ignore-not-found=true kubectl delete ValidatingWebhookConfiguration -l app=istiod,istio.io/rev=${DELETE_REV} -n istio-system --ignore-not-found=true kubectl delete MutatingWebhookConfiguration -l app=sidecar-injector,istio.io/rev=${DELETE_REV} -n istio-system --ignore-not-found=true kubectl delete Service,Deployment,HorizontalPodAutoscaler,PodDisruptionBudget istiod-${DELETE_REV} -n istio-system --ignore-not-found=true kubectl delete IstioOperator installed-state-${DELETE_REV} -n istio-system --ignore-not-found=true fi
- Execute the script to delete the current webhooks.
 
- Follow the steps in Upgrade gateways to create the new webhooks and switch traffic to the new gateways.
Outside Google Cloud
These instructions cover upgrading ASM on:
- Anthos clusters on VMware (GKE on-prem)
- Anthos on bare metal
- Anthos clusters on AWS
- Amazon EKS
The sequence for upgrading to ASM version 1.27.2 for your hybrid installation is as follows:
- Prepare for the upgrade.
- Install the new version of ASM.
- Delete the mutating webhook and validating webhook from your current installation.
- Upgrade your gateways and configure the new webhooks.
- Review the requirements in Upgrade Anthos Service Mesh, but do not perform the upgrade yet.
- Before installing the new version, determine the current revision. You will need
                 this information to delete the validating webhook and mutating webhook
                 from your current ASM installation. Use the following command to store the current
                 istiod revision to an environment variable:
export DELETE_REV=$(kubectl get deploy -n istio-system -l app=istiod -o jsonpath={.items[].metadata.labels.'istio\.io\/rev'}'{"\n"}') echo ${DELETE_REV}
- Create a new overlay.yamlfile or verify that your existingoverlay.yamlcontains the following contents:apiVersion: install.istio.io/v1alpha1 kind: IstioOperator spec: revision: asm-1272-1 components: ingressGateways: - name: istio-ingressgateway enabled: true k8s: nodeSelector: # default node selector, if different or not using node selectors, change accordingly. cloud.google.com/gke-nodepool: apigee-runtime resources: requests: cpu: 1000m service: type: LoadBalancer loadBalancerIP: STATIC_IP # If you do not have a reserved static IP, leave this out. ports: - name: http-status-port port: 15021 - name: http2 port: 80 targetPort: 8080 - name: https port: 443 targetPort: 8443 values: gateways: istio-ingressgateway: runAsRoot: true meshConfig: accessLogFormat: '{"start_time":"%START_TIME%","remote_address":"%DOWNSTREAM_DIRECT_REMOTE_ADDRESS%","user_agent":"%REQ(USER-AGENT)%","host":"%REQ(:AUTHORITY)%","request":"%REQ(:METHOD)% %REQ(X-ENVOY-ORIGINAL-PATH?:PATH)% %PROTOCOL%","request_time":"%DURATION%","status":"%RESPONSE_CODE%","status_details":"%RESPONSE_CODE_DETAILS%","bytes_received":"%BYTES_RECEIVED%","bytes_sent":"%BYTES_SENT%","upstream_address":"%UPSTREAM_HOST%","upstream_response_flags":"%RESPONSE_FLAGS%","upstream_response_time":"%RESPONSE_DURATION%","upstream_service_time":"%RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)%","upstream_cluster":"%UPSTREAM_CLUSTER%","x_forwarded_for":"%REQ(X-FORWARDED-FOR)%","request_method":"%REQ(:METHOD)%","request_path":"%REQ(X-ENVOY-ORIGINAL-PATH?:PATH)%","request_protocol":"%PROTOCOL%","tls_protocol":"%DOWNSTREAM_TLS_VERSION%","request_id":"%REQ(X-REQUEST-ID)%","sni_host":"%REQUESTED_SERVER_NAME%","apigee_dynamic_data":"%DYNAMIC_METADATA(envoy.lua)%"}' 
- Follow the instructions in the following sections in the ASM documentation:
                 
                 - Download asmcli
- Grant cluster admin permissions
- Validate project and cluster
- Upgrade with optional features. Stop before starting the "Upgrade Gateways section"
 
- Delete the mutating webhook and validating webhook:
                 - cdinto the directory where you installed- asmcli.
- Store the current new revision in an environment variable to use in the script
                     to delete the webhooks:
                   UPGRADE_REV="asm-1272-1" 
- create a shell script containing the following commands:
#!/bin/bash set -ex PROJECT_ID="YOUR_PROJECT_ID" CLUSTER_NAME="YOUR_CLUSTER_NAME" CLUSTER_LOCATION="YOUR_CLUSTER_LOCATION" gcloud config configurations activate ${PROJECT_ID} gcloud container clusters get-credentials ${CLUSTER_NAME} --region ${CLUSTER_LOCATION} --project ${PROJECT_ID} kubectl label namespace istio-system istio.io/rev=${UPGRADE_REV} istio-injection- --overwrite kubectl rollout restart deployment -n istio-system kubectl apply -n istio-system -f PATH_TO_INGRESSGATEWAYistio-ingressgateway kubectl apply -n istio-system -f PATH_TO_INGRESSGATEWAY/istio-ingressgateway-connectors if [[ "${DELETE_REV}" != "${UPGRADE_REV}" ]]; then kubectl apply -f out/asm/istio/istiod-service.yaml kubectl delete deploy -l app=istio-ingressgateway,istio.io/rev=${DELETE_REV} -n istio-system --ignore-not-found=true kubectl delete deploy -l app=istio-ingressgateway-connectors,istio.io/rev=${DELETE_REV} -n istio-system --ignore-not-found=true kubectl delete ValidatingWebhookConfiguration -l app=istiod,istio.io/rev=${DELETE_REV} -n istio-system --ignore-not-found=true kubectl delete MutatingWebhookConfiguration -l app=sidecar-injector,istio.io/rev=${DELETE_REV} -n istio-system --ignore-not-found=true kubectl delete Service,Deployment,HorizontalPodAutoscaler,PodDisruptionBudget istiod-${DELETE_REV} -n istio-system --ignore-not-found=true kubectl delete IstioOperator installed-state-${DELETE_REV} -n istio-system --ignore-not-found=true fi
- Execute the script to delete the current webhooks.
 
- Follow the steps in Upgrade gateways to create the new webhooks and switch traffic to the new gateways.
AKS / EKS
In these instructions the process of upgrading Anthos Service Mesh (ASM) version istio-1.27.2-asm.1 on Anthos attached clusters is the same as performing a fresh install.
Preparing to install Anthos Service Mesh
- Delete the mutating webhook and validating webhook:
       - cdinto the directory where you installed- asmcli.
- Store the current new revision in an environment variable to use in the script
                     to delete the webhooks:
          UPGRADE_REV="asm-1272-1" 
- create a shell script containing the following commands:
            #!/bin/bash set -ex kubectl label namespace istio-system istio.io/rev=${UPGRADE_REV} istio-injection- --overwrite kubectl rollout restart deployment -n istio-system if [[ "${DELETE_REV}" != "${UPGRADE_REV}" ]]; then kubectl apply -f out/asm/istio/istiod-service.yaml kubectl apply -f ASMCLI_OUTPUT_DIR/asm/istio/istiod-service.yaml ASMCLI_OUTPUT_DIR/istioctl tag set default --revision ${UPGRADE_REV} kubectl delete deploy -l app=istio-ingressgateway,istio.io/rev=${DELETE_REV} -n istio-system --ignore-not-found=true kubectl delete ValidatingWebhookConfiguration -l app=istiod,istio.io/rev=${DELETE_REV} -n istio-system --ignore-not-found=true kubectl delete MutatingWebhookConfiguration -l app=sidecar-injector,istio.io/rev=${DELETE_REV} -n istio-system --ignore-not-found=true kubectl delete Service,Deployment,HorizontalPodAutoscaler,PodDisruptionBudget istiod-${DELETE_REV} -n istio-system --ignore-not-found=true kubectl delete IstioOperator installed-state-${DELETE_REV} -n istio-system --ignore-not-found=true fi
- Execute the script to delete the current webhooks.
 
- Download the Anthos Service Mesh installation file to your current working directory:
        curl -LO https://storage.googleapis.com/gke-release/asm/istio-1.27.2-asm.1-linux-amd64.tar.gz 
- Download the signature file and use openssl to verify the signature:
        curl -LO https://storage.googleapis.com/gke-release/asm/istio-1.27.2-asm.1-linux-amd64.tar.gz.1.sig openssl dgst -verify /dev/stdin -signature istio-1.27.2-asm.1-linux-amd64.tar.gz.1.sig istio-1.27.2-asm.1.tar.gz <<'EOF'-----BEGIN PUBLIC KEY----- MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEWZrGCUaJJr1H8a36sG4UUoXvlXvZ wQfk16sxprI2gOJ2vFFggdq3ixF2h4qNBt0kI7ciDhgpwS8t+/960IsIgw== -----END PUBLIC KEY----- EOF
- Extract the contents of the file to any location on your file system. For example,
        to extract the contents to the current working directory:
        tar xzf istio-1.27.2-asm.1-linux-amd64.tar.gz The command creates an installation directory in your current working directory named istio-1.27.2-asm.1that contains:- Sample applications in the samplesdirectory.
- The istioctlcommand-line tool that you use to install Anthos Service Mesh is in thebindirectory.
- The Anthos Service Mesh configuration profiles are in the
            manifests/profilesdirectory.
 
- Sample applications in the 
- Ensure that you're in the Anthos Service Mesh installation's root directory:
        cd istio-1.27.2-asm.1 
- For convenience, add the tools in the /bin directory to your PATH:
        export PATH=$PWD/bin:$PATH 
- Download the Anthos Service Mesh installation file to your current working directory:
        curl -LO https://storage.googleapis.com/gke-release/asm/istio-1.27.2-asm.1-osx.tar.gz 
- Download the signature file and use openssl to verify the signature:
        curl -LO https://storage.googleapis.com/gke-release/asm/istio-1.27.2-asm.1-osx.tar.gz.1.sig openssl dgst -sha256 -verify /dev/stdin -signature istio-1.27.2-asm.1-osx.tar.gz.1.sig istio-1.27.2-asm.1.tar.gz <<'EOF'-----BEGIN PUBLIC KEY----- MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEWZrGCUaJJr1H8a36sG4UUoXvlXvZ wQfk16sxprI2gOJ2vFFggdq3ixF2h4qNBt0kI7ciDhgpwS8t+/960IsIgw== -----END PUBLIC KEY----- EOF
- Extract the contents of the file to any location on your file system. For example,
        to extract the contents to the current working directory:
        tar xzf istio-1.27.2-asm.1-osx.tar.gz The command creates an installation directory in your current working directory named istio-1.27.2-asm.1that contains:- Sample applications in the samplesdirectory.
- The istioctlcommand-line tool that you use to install Anthos Service Mesh is in thebindirectory.
- The Anthos Service Mesh configuration profiles are in the
            manifests/profilesdirectory.
 
- Sample applications in the 
- Ensure that you're in the Anthos Service Mesh installation's root directory:
        cd istio-1.27.2-asm.1 
- For convenience, add the tools in the /bin directory to your PATH:
        export PATH=$PWD/bin:$PATH 
- Download the Anthos Service Mesh installation file to your current working directory:
        curl -LO https://storage.googleapis.com/gke-release/asm/istio-1.27.2-asm.1-win.zip 
- Download the signature file and use openssl to verify the signature:
        curl -LO https://storage.googleapis.com/gke-release/asm/istio-1.27.2-asm.1-win.zip.1.sig openssl dgst -verify - -signature istio-1.27.2-asm.1-win.zip.1.sig istio-1.27.2-asm.1.win.zip <<'EOF'-----BEGIN PUBLIC KEY----- MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEWZrGCUaJJr1H8a36sG4UUoXvlXvZ wQfk16sxprI2gOJ2vFFggdq3ixF2h4qNBt0kI7ciDhgpwS8t+/960IsIgw== -----END PUBLIC KEY----- EOF
- Extract the contents of the file to any location on your file system. For example,
        to extract the contents to the current working directory:
        tar xzf istio-1.27.2-asm.1-win.zip The command creates an installation directory in your current working directory named istio-1.27.2-asm.1that contains:- Sample applications in the samplesdirectory.
- The istioctlcommand-line tool that you use to install Anthos Service Mesh is in thebindirectory.
- The Anthos Service Mesh configuration profiles are in the
            manifests\profilesdirectory.
 
- Sample applications in the 
- Ensure that you're in the Anthos Service Mesh installation's root directory:
        cd istio-1.27.2-asm.1 
- For convenience, add the tools in the \bin directory to your PATH:
        set PATH=%CD%\bin:%PATH% 
- Now that ASM Istio is installed, check the version of istioctl:istioctl version 
- Create a namespace called istio-system for the control plane components:
  kubectl create namespace istio-system 
Linux
Mac OS
Windows
Installing Anthos Service Mesh
- Edit your overlay.yamlfile or create a new one with the following contents:apiVersion: install.istio.io/v1alpha1 kind: IstioOperator spec: meshConfig: accessLogFile: /dev/stdout enableTracing: true accessLogFormat: '{"start_time":"%START_TIME%","remote_address":"%DOWNSTREAM_DIRECT_REMOTE_ADDRESS%","user_agent":"%REQ(USER-AGENT)%","host":"%REQ(:AUTHORITY)%","request":"%REQ(:METHOD)% %REQ(X-ENVOY-ORIGINAL-PATH?:PATH)% %PROTOCOL%","request_time":"%DURATION%","status":"%RESPONSE_CODE%","status_details":"%RESPONSE_CODE_DETAILS%","bytes_received":"%BYTES_RECEIVED%","bytes_sent":"%BYTES_SENT%","upstream_address":"%UPSTREAM_HOST%","upstream_response_flags":"%RESPONSE_FLAGS%","upstream_response_time":"%RESPONSE_DURATION%","upstream_service_time":"%RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)%","upstream_cluster":"%UPSTREAM_CLUSTER%","x_forwarded_for":"%REQ(X-FORWARDED-FOR)%","request_method":"%REQ(:METHOD)%","request_path":"%REQ(X-ENVOY-ORIGINAL-PATH?:PATH)%","request_protocol":"%PROTOCOL%","tls_protocol":"%DOWNSTREAM_TLS_VERSION%","request_id":"%REQ(X-REQUEST-ID)%","sni_host":"%REQUESTED_SERVER_NAME%","apigee_dynamic_data":"%DYNAMIC_METADATA(envoy.lua)%"}' components: - enabled: true name: istio-ingressgateway k8s: service: type: LoadBalancer ports: - name: status-port port: 15021 targetPort: 15021 - name: http2 port: 80 targetPort: 8080 - name: https port: 443 targetPort: 8443
- Install Anthos Service Mesh with istioctlusing theasm-multicloudprofile:istioctl install \ --set profile=asm-multicloud \ --set revision="asm-1272-1" \ --filename overlayfile.yamlYour output should look something like: kubectl get pods -n istio-system NAME READY STATUS RESTARTS AGE istio-ingressgateway-88b6fd976-flgp2 1/1 Running 0 3m13s istio-ingressgateway-88b6fd976-p5dl9 1/1 Running 0 2m57s istiod-asm-1272-1-798ffb964-2ls88 1/1 Running 0 3m21s istiod-asm-1272-1-798ffb964-fnj8c 1/1 Running 1 3m21s The --set revisionargument adds a revision label in the formatistio.io/rev=asm-1272-1to istiod. The revision label is used by the automatic sidecar injector webhook to associate injected sidecars with a particular istiod revision. To enable sidecar auto-injection for a namespace, you must label it with a revision that matches the label on istiod.
- Verify that your install completed:
  kubectl get svc -n istio-system Your output should look something like: NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE istio-ingressgateway LoadBalancer 172.200.48.52 34.74.177.168 15021:30479/TCP,80:30030/TCP,443:32200/TCP,15012:32297/TCP,15443:30244/TCP 3m35s istiod ClusterIP 172.200.18.133 <none> 15010/TCP,15012/TCP,443/TCP,15014/TCP 4m46s istiod-asm-1272-1 ClusterIP 172.200.63.220 <none> 15010/TCP,15012/TCP,443/TCP,15014/TCP 3m43s 
OpenShift
In these instructions the process of upgrading Anthos Service Mesh (ASM) version istio-1.27.2-asm.1 on Anthos attached clusters is the same as performing a fresh install.
Preparing to install Anthos Service Mesh
- Delete the mutating webhook and validating webhook:
       - cdinto the directory where you installed- asmcli.
- Store the current new revision in an environment variable to use in the script
                     to delete the webhooks:
          UPGRADE_REV="asm-1272-1" 
- create a shell script containing the following commands:
            #!/bin/bash set -ex kubectl label namespace istio-system istio.io/rev=${UPGRADE_REV} istio-injection- --overwrite kubectl rollout restart deployment -n istio-system kubectl apply -n istio-system -f PATH_TO_INGRESSGATEWAYistio-ingressgateway if [[ "${DELETE_REV}" != "${UPGRADE_REV}" ]]; then kubectl apply -f out/asm/istio/istiod-service.yaml kubectl delete deploy -l app=istio-ingressgateway,istio.io/rev=${DELETE_REV} -n istio-system --ignore-not-found=true kubectl delete deploy -l app=istio-ingressgateway-connectors,istio.io/rev=${DELETE_REV} -n istio-system --ignore-not-found=true kubectl delete ValidatingWebhookConfiguration -l app=istiod,istio.io/rev=${DELETE_REV} -n istio-system --ignore-not-found=true kubectl delete MutatingWebhookConfiguration -l app=sidecar-injector,istio.io/rev=${DELETE_REV} -n istio-system --ignore-not-found=true kubectl delete Service,Deployment,HorizontalPodAutoscaler,PodDisruptionBudget istiod-${DELETE_REV} -n istio-system --ignore-not-found=true kubectl delete IstioOperator installed-state-${DELETE_REV} -n istio-system --ignore-not-found=true fi
- Execute the script to delete the current webhooks.
 
- Grant the anyuidsecurity context constraint (SCC) to the istio-system with the following OpenShift CLI (oc) command:oc adm policy add-scc-to-group anyuid system:serviceaccounts:istio-system 
- Download the Anthos Service Mesh installation file to your current working directory:
        curl -LO https://storage.googleapis.com/gke-release/asm/istio-1.27.2-asm.1-linux-amd64.tar.gz 
- Download the signature file and use openssl to verify the signature:
        curl -LO https://storage.googleapis.com/gke-release/asm/istio-1.27.2-asm.1-linux-amd64.tar.gz.1.sig openssl dgst -verify /dev/stdin -signature istio-1.27.2-asm.1-linux-amd64.tar.gz.1.sig istio-1.27.2-asm.1.tar.gz <<'EOF'-----BEGIN PUBLIC KEY----- MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEWZrGCUaJJr1H8a36sG4UUoXvlXvZ wQfk16sxprI2gOJ2vFFggdq3ixF2h4qNBt0kI7ciDhgpwS8t+/960IsIgw== -----END PUBLIC KEY----- EOF
- Extract the contents of the file to any location on your file system. For example,
        to extract the contents to the current working directory:
        tar xzf istio-1.27.2-asm.1-linux-amd64.tar.gz The command creates an installation directory in your current working directory named istio-1.27.2-asm.1that contains:- Sample applications in the samplesdirectory.
- The istioctlcommand-line tool that you use to install Anthos Service Mesh is in thebindirectory.
- The Anthos Service Mesh configuration profiles are in the
            manifests/profilesdirectory.
 
- Sample applications in the 
- Ensure that you're in the Anthos Service Mesh installation's root directory:
        cd istio-1.27.2-asm.1 
- For convenience, add the tools in the /bin directory to your PATH:
        export PATH=$PWD/bin:$PATH 
- Grant the anyuidsecurity context constraint (SCC) to the istio-system with the following OpenShift CLI (oc) command:oc adm policy add-scc-to-group anyuid system:serviceaccounts:istio-system 
- Download the Anthos Service Mesh installation file to your current working directory:
        curl -LO https://storage.googleapis.com/gke-release/asm/istio-1.27.2-asm.1-osx.tar.gz 
- Download the signature file and use openssl to verify the signature:
        curl -LO https://storage.googleapis.com/gke-release/asm/istio-1.27.2-asm.1-osx.tar.gz.1.sig openssl dgst -sha256 -verify /dev/stdin -signature istio-1.27.2-asm.1-osx.tar.gz.1.sig istio-1.27.2-asm.1.tar.gz <<'EOF'-----BEGIN PUBLIC KEY----- MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEWZrGCUaJJr1H8a36sG4UUoXvlXvZ wQfk16sxprI2gOJ2vFFggdq3ixF2h4qNBt0kI7ciDhgpwS8t+/960IsIgw== -----END PUBLIC KEY----- EOF
- Extract the contents of the file to any location on your file system. For example,
        to extract the contents to the current working directory:
        tar xzf istio-1.27.2-asm.1-osx.tar.gz The command creates an installation directory in your current working directory named istio-1.27.2-asm.1that contains:- Sample applications in the samplesdirectory.
- The istioctlcommand-line tool that you use to install Anthos Service Mesh is in thebindirectory.
- The Anthos Service Mesh configuration profiles are in the
            manifests/profilesdirectory.
 
- Sample applications in the 
- Ensure that you're in the Anthos Service Mesh installation's root directory:
        cd istio-1.27.2-asm.1 
- For convenience, add the tools in the /bin directory to your PATH:
        export PATH=$PWD/bin:$PATH 
- Grant the anyuidsecurity context constraint (SCC) to the istio-system with the following OpenShift CLI (oc) command:oc adm policy add-scc-to-group anyuid system:serviceaccounts:istio-system 
- Download the Anthos Service Mesh installation file to your current working directory:
        curl -LO https://storage.googleapis.com/gke-release/asm/istio-1.27.2-asm.1-win.zip 
- Download the signature file and use openssl to verify the signature:
        curl -LO https://storage.googleapis.com/gke-release/asm/istio-1.27.2-asm.1-win.zip.1.sig openssl dgst -verify - -signature istio-1.27.2-asm.1-win.zip.1.sig istio-1.27.2-asm.1.win.zip <<'EOF'-----BEGIN PUBLIC KEY----- MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEWZrGCUaJJr1H8a36sG4UUoXvlXvZ wQfk16sxprI2gOJ2vFFggdq3ixF2h4qNBt0kI7ciDhgpwS8t+/960IsIgw== -----END PUBLIC KEY----- EOF
- Extract the contents of the file to any location on your file system. For example,
        to extract the contents to the current working directory:
        tar xzf istio-1.27.2-asm.1-win.zip The command creates an installation directory in your current working directory named istio-1.27.2-asm.1that contains:- Sample applications in the samplesdirectory.
- The istioctlcommand-line tool that you use to install Anthos Service Mesh is in thebindirectory.
- The Anthos Service Mesh configuration profiles are in the
            manifests\profilesdirectory.
 
- Sample applications in the 
- Ensure that you're in the Anthos Service Mesh installation's root directory:
        cd istio-1.27.2-asm.1 
- For convenience, add the tools in the \bin directory to your PATH:
        set PATH=%CD%\bin:%PATH% 
- Now that ASM Istio is installed, check the version of istioctl:istioctl version 
- Create a namespace called istio-system for the control plane components:
  kubectl create namespace istio-system 
Linux
Mac OS
Windows
Installing Anthos Service Mesh
- Edit your overlay.yamlfile or create a new one with the following contents:apiVersion: install.istio.io/v1alpha1 kind: IstioOperator spec: meshConfig: accessLogFile: /dev/stdout enableTracing: true accessLogFormat: '{"start_time":"%START_TIME%","remote_address":"%DOWNSTREAM_DIRECT_REMOTE_ADDRESS%","user_agent":"%REQ(USER-AGENT)%","host":"%REQ(:AUTHORITY)%","request":"%REQ(:METHOD)% %REQ(X-ENVOY-ORIGINAL-PATH?:PATH)% %PROTOCOL%","request_time":"%DURATION%","status":"%RESPONSE_CODE%","status_details":"%RESPONSE_CODE_DETAILS%","bytes_received":"%BYTES_RECEIVED%","bytes_sent":"%BYTES_SENT%","upstream_address":"%UPSTREAM_HOST%","upstream_response_flags":"%RESPONSE_FLAGS%","upstream_response_time":"%RESPONSE_DURATION%","upstream_service_time":"%RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)%","upstream_cluster":"%UPSTREAM_CLUSTER%","x_forwarded_for":"%REQ(X-FORWARDED-FOR)%","request_method":"%REQ(:METHOD)%","request_path":"%REQ(X-ENVOY-ORIGINAL-PATH?:PATH)%","request_protocol":"%PROTOCOL%","tls_protocol":"%DOWNSTREAM_TLS_VERSION%","request_id":"%REQ(X-REQUEST-ID)%","sni_host":"%REQUESTED_SERVER_NAME%","apigee_dynamic_data":"%DYNAMIC_METADATA(envoy.lua)%"}' components: - enabled: true name: istio-ingressgateway k8s: service: type: LoadBalancer ports: - name: status-port port: 15021 targetPort: 15021 - name: http2 port: 80 targetPort: 8080 - name: https port: 443 targetPort: 8443
- Install Anthos Service Mesh with istioctlusing theasm-multicloudprofile:istioctl install \ --set profile=asm-multicloud \ --set revision="asm-1272-1" \ --filename overlayfile.yamlYour output should look something like: kubectl get pods -n istio-system NAME READY STATUS RESTARTS AGE istio-ingressgateway-88b6fd976-flgp2 1/1 Running 0 3m13s istio-ingressgateway-88b6fd976-p5dl9 1/1 Running 0 2m57s istiod-asm-1272-1-798ffb964-2ls88 1/1 Running 0 3m21s istiod-asm-1272-1-798ffb964-fnj8c 1/1 Running 1 3m21s The --set revisionargument adds a revision label in the formatistio.io/rev=1.6.11-asm.1to istiod. The revision label is used by the automatic sidecar injector webhook to associate injected sidecars with a particular istiod revision. To enable sidecar auto-injection for a namespace, you must label it with a revision that matches the label on istiod.
- Verify that your install completed:
  kubectl get svc -n istio-system Your output should look something like: NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE istio-ingressgateway LoadBalancer 172.200.48.52 34.74.177.168 15021:30479/TCP,80:30030/TCP,443:32200/TCP,15012:32297/TCP,15443:30244/TCP 3m35s istiod ClusterIP 172.200.18.133 <none> 15010/TCP,15012/TCP,443/TCP,15014/TCP 4m46s istiod-asm-1272-1 ClusterIP 172.200.63.220 <none> 15010/TCP,15012/TCP,443/TCP,15014/TCP 3m43s 
Rolling back an upgrade
Follow these steps to roll back a previous upgrade:
- Clean up completed jobs for the hybrid runtime namespace, where NAMESPACE is the
    namespace specified in your overrides file, if you specified a namespace. If not, the default namespace
    is apigee:kubectl delete job -n NAMESPACE \ $(kubectl get job -n NAMESPACE \ -o=jsonpath='{.items[?(@.status.succeeded==1)].metadata.name}')
- Clean up completed jobs for the apigee-systemnamespace:kubectl delete job -n apigee-system \ $(kubectl get job -n apigee-system \ -o=jsonpath='{.items[?(@.status.succeeded==1)].metadata.name}')
- Change the APIGEECTL_HOMEvariable to point to the directory that contains the previous version ofapigeectl. For example:export APIGEECTL_HOME=PATH_TO_PREVIOUS_APIGEECTL_DIRECTORY 
- In the root directory of the installation you want to roll back to, run
    ${APIGEECTL_HOME}/apigeectl apply, check the status of your pods, and then run${APIGEECTL_HOME}/apigeectl init. Be sure to use the original overrides file for the version you wish to roll back to:- In the hybrid-filesdirectory, run${APIGEECTL_HOME}/apigeectl apply:${APIGEECTL_HOME}/apigeectl apply -f ./overrides/ORIGINAL_OVERRIDES.yaml
- Check the status of your pods:
        kubectl -n NAMESPACE get pods Where NAMESPACE is your Apigee hybrid namespace. 
- Check the status of apigeeds:kubectl describe apigeeds -n apigee Your output should look something like: Status: Cassandra Data Replication: Cassandra Pod Ips: 10.8.2.204 Cassandra Ready Replicas: 1 Components: Cassandra: Last Successfully Released Version: Revision: v1-f8aa9a82b9f69613 Version: v1 Replicas: Available: 1 Ready: 1 Total: 1 Updated: 1 State: running Scaling: In Progress: false Operation: Requested Replicas: 0 State: running Proceed to the next step only when the apigeedsßpod is running.
- Run apigeectl init:${APIGEECTL_HOME}/apigeectl init -f ./overrides/ORIGINAL_OVERRIDES.yaml
 
- In the