1. These instructions use the environment variableAPIGEE_HELM_CHARTS_HOME for the directory in your file system where you have installed the Helm charts. If needed, change directory into this directory and define the variable with the following command:

   Linux

   export APIGEE_HELM_CHARTS_HOME=$PWDecho$APIGEE_HELM_CHARTS_HOME

   Mac OS

   export APIGEE_HELM_CHARTS_HOME=$PWDecho$APIGEE_HELM_CHARTS_HOME

   Windows

   set APIGEE_HELM_CHARTS_HOME=%CD%echo %APIGEE_HELM_CHARTS_HOME%

2. Make a backup copy of your version 1.10$APIGEE_HELM_CHARTS_HOME/ directory. You can use any backup process. For example, you can create atar file of your entire directory with:

   tar -czvf$APIGEE_HELM_CHARTS_HOME/../apigee-helm-charts-v1.10-backup.tar.gz$APIGEE_HELM_CHARTS_HOME

3. Back up your Cassandra database following the instructions inCassandra backup and recovery.
4. If you are using service cert files (.json) in your overrides to authenticate service accounts, make sure your service account cert files reside in the correct Helm chart directory. Helm charts cannot read files outside of each chart directory.

   This step is not needed if you are using Kubernetes secrets or Workload Identity to authenticate service accounts.

   The following table shows the destination for each service account file, depending on your type of installation:

   Prod

   Service account	Default filename	Helm chart directory
   apigee-cassandra	PROJECT_ID-apigee-cassandra.json	$APIGEE_HELM_CHARTS_HOME/apigee-datastore/
   apigee-logger	PROJECT_ID-apigee-logger.json	$APIGEE_HELM_CHARTS_HOME/apigee-telemetry/
   apigee-mart	PROJECT_ID-apigee-mart.json	$APIGEE_HELM_CHARTS_HOME/apigee-org/
   apigee-metrics	PROJECT_ID-apigee-metrics.json	$APIGEE_HELM_CHARTS_HOME/apigee-telemetry/
   apigee-runtime	PROJECT_ID-apigee-runtime.json	$APIGEE_HELM_CHARTS_HOME/apigee-env
   apigee-synchronizer	PROJECT_ID-apigee-synchronizer.json	$APIGEE_HELM_CHARTS_HOME/apigee-env/
   apigee-udca	PROJECT_ID-apigee-udca.json	$APIGEE_HELM_CHARTS_HOME/apigee-org/
   apigee-watcher	PROJECT_ID-apigee-watcher.json	$APIGEE_HELM_CHARTS_HOME/apigee-org/

   Non-prod

   Make a copy of theapigee-non-prod service account file in each of the following directories:

   Service account	Default filename	Helm chart directories
   apigee-non-prod	PROJECT_ID-apigee-non-prod.json	$APIGEE_HELM_CHARTS_HOME/apigee-datastore/ $APIGEE_HELM_CHARTS_HOME/apigee-telemetry/ $APIGEE_HELM_CHARTS_HOME/apigee-org/ $APIGEE_HELM_CHARTS_HOME/apigee-env/

5. Make sure that your TLS certificate and key files (.crt,.key, and/or.pem) reside in the$APIGEE_HELM_CHARTS_HOME/apigee-virtualhost/ directory.

apigeectl

The examples in these instructions use the following directory structure. Your installation may be different. Adjust the instructions to the structure of your installation.

hybrid-v1.11-root-directory/└── apigeectl/    └── config/    └── plugins/    └── templates/    └── tools/└── hybrid-files/    └── overrides/    └── service-accounts/    └── certs/hybrid-v1.10-root-directory/

1. These instructions use the environment variableAPIGEECTL_HOME for the directory in your file system where you have installedapigeectl. If needed, change directory into yourapigeectl directory and define the variable with the following command:

   Linux

   export APIGEECTL_HOME=$PWDecho$APIGEECTL_HOME

   Mac OS

   export APIGEECTL_HOME=$PWDecho$APIGEECTL_HOME

   Windows

   set APIGEECTL_HOME=%CD%echo %APIGEECTL_HOME%

2. Make a backup copy of your version 1.10$APIGEECTL_HOME/ directory. For example:

   tar -czvf$APIGEECTL_HOME/../apigeectl-v1.10-backup.tar.gz$APIGEECTL_HOME

3. Back up your Cassandra database following the instructions inCassandra backup and recovery.

Click to expand a list of supported platforms

	1.10(3)	1.11	1.12
GKE on Google Cloud	1.24.x 1.25.x 1.26.x 1.27.x(≥ 1.10.5) 1.28.x(≥ 1.10.5)	1.25.x 1.26.x 1.27.x 1.28.x(≥ 1.11.2) 1.29.x(≥ 1.11.2)	1.26.x 1.27.x 1.28.x 1.29.x(≥ 1.12.1)
GKE on AWS	1.13.x (K8s v1.24.x) 1.14.x (K8s v1.25.x) 1.26.x(12) 1.27.x(≥ 1.10.5) 1.28.x(≥ 1.10.5)	1.14.x (K8s v1.25.x) 1.26.x(12) 1.27.x 1.28.x(≥ 1.11.2) 1.29.x(≥ 1.11.2)	1.26.x(12) 1.27.x 1.28.x 1.29.x(≥ 1.12.1)
GKE on Azure	1.13.x 1.14.x 1.26.x(12) 1.27.x(≥ 1.10.5) 1.28.x(≥ 1.10.5)	1.14.x 1.26.x(12) 1.27.x 1.28.x(≥ 1.11.2) 1.29.x(≥ 1.11.2)	1.26.x(12) 1.27.x 1.28.x 1.29.x(≥ 1.12.1)
Google Distributed Cloud (software only) on VMware(1)(13)	1.13.x 1.14.x 1.15.x (K8s v1.26.x) 1.16.x (K8s v1.27.x) 1.27.x(≥ 1.10.5) 1.28.x(≥ 1.10.5)	1.14.x 1.15.x (K8s v1.26.x) 1.16.x (K8s v1.27.x) 1.28.x(≥ 1.11.2) 1.29.x(≥ 1.11.2)	1.15.x (K8s v1.26.x) 1.16.x (K8s v1.27.x) 1.28.x(12) 1.29.x(≥ 1.12.1)
Google Distributed Cloud (software only) on bare metal(1)	1.13.x 1.14.x (K8s v1.25.x) 1.15.x (K8s v1.26.x) 1.16.x (K8s v1.27.x) 1.27.x(12)(≥ 1.10.5) 1.28.x(≥ 1.10.5)	1.14.x 1.15.x (K8s v1.26.x) 1.16.x (K8s v1.27.x) 1.28.x(12)(≥ 1.11.2) 1.29.x(≥ 1.11.2)	1.15.x (K8s v1.26.x) 1.16.x (K8s v1.27.x) 1.28.x(12) 1.29.x(≥ 1.12.1)
EKS(7)	1.24.x 1.25.x 1.26.x 1.27.x(≥ 1.10.5) 1.28.x(≥ 1.10.5)	1.25.x 1.26.x 1.27.x 1.28.x(≥ 1.11.2) 1.29.x(≥ 1.11.2)	1.26.x 1.27.x 1.28.x 1.29.x(≥ 1.12.1)
AKS(7)	1.24.x 1.25.x 1.26.x 1.27.x(≥ 1.10.5) 1.28.x(≥ 1.10.5)	1.25.x 1.26.x 1.27.x 1.28.x(≥ 1.11.2) 1.29.x(≥ 1.11.2)	1.26.x 1.27.x 1.28.x 1.29.x(≥ 1.12.1)
OpenShift(7)	4.11 4.12 4.14(≥ 1.10.5) 4.15(≥ 1.10.5)	4.12 4.13 4.14 4.15(≥ 1.11.2) 4.16(≥ 1.11.2)	4.12 4.13 4.14 4.15 4.16(≥ 1.12.1)
Rancher Kubernetes Engine (RKE)	v1.26.2+rke2r1 1.27.x(≥ 1.10.5) 1.28.x(≥ 1.10.5)	v1.26.2+rke2r1 v1.27.x 1.28.x(≥ 1.11.2) 1.29.x(≥ 1.11.2)	v1.26.2+rke2r1 v1.27.x 1.28.x 1.29.x(≥ 1.12.1)
VMware Tanzu	N/A	N/A	v1.26.x
Components	1.10	1.11	1.12
Anthos Service Mesh	1.17.x(10)	1.18.x(10)	1.19.x(10)
JDK	JDK 11	JDK 11	JDK 11
cert-manager	1.10.x 1.11.x 1.12.x	1.11.x 1.12.x 1.13.x	1.11.x 1.12.x 1.13.x
Cassandra	3.11	3.11	4.0
Kubernetes	1.24.x 1.25.x 1.26.x	1.25.x 1.26.x 1.27.x	1.26.x 1.27.x 1.28.x
kubectl			1.27.x 1.28.x 1.29.x
Helm	3.10+	3.10+	3.14.2+
Secret Store CSI driver		1.3.4	1.4.1
Vault		1.13.x	1.15.2
(1) On Anthos on-premises (Google Distributed Cloud) version 1.13, follow these instructions to avoid conflict withcert-manager:Conflicting cert-manager installation (2) Support available with Apigee hybrid version 1.7.2 and newer. (3) The official EOL dates for Apigee hybrid versions 1.10 and older have been reached. Regular monthly patches are no longer available. These releases are no longer officially supported except for customers with explicit and official exceptions for continued support. Other customers must upgrade. (4)Anthos on-premises (Google Distributed Cloud) versions 1.12 and earlier are out of support. See the Distributed Cloud on bare metalVersion Support Policy and the Distributed Cloud on VMwaresupported versions list. (5)Google Distributed Cloud on bare metal or VMware requires Anthos Service Mesh 1.14 or later. We recommend that you upgrade to hybrid v1.8 and switch to Apigee ingress gateway which no longer requires you to install Anthos Service Mesh on your hybrid cluster. (6) Support available with Apigee hybrid version 1.8.4 and newer. (7) Not supported with Apigee hybrid version 1.8.4 and newer. (8) Support available with Apigee hybrid version 1.7.6 and newer. (9) Not supported with Apigee hybrid version 1.8.5 and newer. (10) Anthos Service Mesh is automatically installed with Apigee hybrid 1.9 and newer. (11) Support available with Apigee hybrid version 1.9.2 and newer. (12) GKE on AWS version numbers now reflect the Kubernetes versions. SeeGKE Enterprise version and upgrade support for version details and recommended patches. (13) Vault is not certified on Google Distributed Cloud for VMware. (14) Support available with Apigee hybrid version 1.10.5 and newer. (15) Support available with Apigee hybrid version 1.11.2 and newer. (16) Support available with Apigee hybrid version 1.12.1 and newer.

About attached clusters

For Apigee hybrid versions 1.7.x and older, you must useGKE attached clusters if you want to run Apigee hybrid in a multi-cloud context on Elastic Kubernetes Service (EKS), Azure Kubernetes Service (AKS), or another supported third-party Kubernetes service provider. Cluster attachment allows Google to measure the usage of Anthos Service Mesh.

For Apigee hybrid version 1.8.x, GKE attached clusters are required if you are using Anthos Service Mesh for your ingress gateway. If you are using Apigee ingress gateway, attached clusters are optional.

1. Make the following change to youroverrides.yaml file to enable theapigee-operator andapigee-env charts ot use the correct tag,1.11.2-hotfix.3:

   ao:  image:    url: "gcr.io/apigee-release/hybrid/apigee-operators"    tag: "1.11.2-hotfix.3"runtime:  image:    url: "gcr.io/apigee-release/hybrid/apigee-runtime"    tag: "1.11.2-hotfix.3"

   SeeApigee 1.11.2-hotfix.3 release notes.

2. Pull the Apigee Helm charts.

   Apigee hybrid charts are hosted inGoogle Artifact Registry:

   oci://us-docker.pkg.dev/apigee-release/apigee-hybrid-helm-charts

   Using thepull command, copy all of the Apigee hybrid Helm charts to your local storage with the following command:

   exportCHART_REPO=oci://us-docker.pkg.dev/apigee-release/apigee-hybrid-helm-chartsexportCHART_VERSION=1.11.2helm pull$CHART_REPO/apigee-operator --version$CHART_VERSION --untarhelm pull$CHART_REPO/apigee-datastore --version$CHART_VERSION --untarhelm pull$CHART_REPO/apigee-env --version$CHART_VERSION --untarhelm pull$CHART_REPO/apigee-ingress-manager --version$CHART_VERSION --untarhelm pull$CHART_REPO/apigee-org --version$CHART_VERSION --untarhelm pull$CHART_REPO/apigee-redis --version$CHART_VERSION --untarhelm pull$CHART_REPO/apigee-telemetry --version$CHART_VERSION --untarhelm pull$CHART_REPO/apigee-virtualhost --version$CHART_VERSION --untar

3. Install cert-manager if needed.

   If you need to upgrade your cert-manager version, install the new version with the following command:

   kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.11.1/cert-manager.yaml

4. Install the updated Apigee CRDs:Note: From this step onwards, all commands should be run under the chart repo root directory.Note: This is the only supported method for installing Apigee CRDs. Do not usekubectl apply without-k, do not omit--server-side.Note: This step requires elevated cluster permissions.

   1. Use thekubectl dry-run feature by running the following command:

      kubectl apply -k  apigee-operator/etc/crds/default/ --server-side --force-conflicts --validate=false --dry-run

   2. After validating with the dry-run command, run the following command:

      kubectl apply -k  apigee-operator/etc/crds/default/ --server-side --force-conflicts --validate=false

   3. Validate the installation with thekubectl get crds command:

      kubectl get crds | grep apigee

      Your output should look something like the following:

      apigeedatastores.apigee.cloud.google.com                    2023-10-09T14:48:30Zapigeedeployments.apigee.cloud.google.com                   2023-10-09T14:48:30Zapigeeenvironments.apigee.cloud.google.com                  2023-10-09T14:48:31Zapigeeissues.apigee.cloud.google.com                        2023-10-09T14:48:31Zapigeeorganizations.apigee.cloud.google.com                 2023-10-09T14:48:32Zapigeeredis.apigee.cloud.google.com                         2023-10-09T14:48:33Zapigeerouteconfigs.apigee.cloud.google.com                  2023-10-09T14:48:33Zapigeeroutes.apigee.cloud.google.com                        2023-10-09T14:48:33Zapigeetelemetries.apigee.cloud.google.com                   2023-10-09T14:48:34Zcassandradatareplications.apigee.cloud.google.com           2023-10-09T14:48:35Z

5. Check the labels on the cluster nodes. By default, Apigee schedules data pods on nodes with the labelcloud.google.com/gke-nodepool=apigee-data and runtime pods are scheduled on nodes with the labelcloud.google.com/gke-nodepool=apigee-runtime. You can customize your node pool labels in theoverrides.yaml file.

   For more information, see Configuring dedicated node pools.

Install the Apigee hybrid Helm charts

1. If you have not, navigate into yourAPIGEE_HELM_CHARTS_HOME directory. Run the following commands from that directory.
2. Upgrade the Apigee Operator/Controller:Note: This step requires elevated cluster permissions. Runhelm -h orhelm upgrade -h for details

   Dry run:

   helm upgrade operator apigee-operator/ \  --install \  --create-namespace \  --namespace apigee-system \  -fOVERRIDES_FILE \  --dry-run

   Upgrade the chart:

   helm upgrade operator apigee-operator/ \  --install \  --create-namespace \  --namespace apigee-system \  -fOVERRIDES_FILE

   Note: For installations migrated fromapigeectlto Helm, use:

   helm upgrade operator apigee-operator/ \  --install \  --create-namespace \  --namespace apigee-system \  --force \  -fOVERRIDES_FILE

   Verify Apigee Operator installation:

   helm ls -n apigee-system

   NAME           NAMESPACE       REVISION        UPDATED                                 STATUS          CHART                   APP VERSIONoperator    apigee-system   3               2023-06-26 00:42:44.492009 -0800 PST    deployed        apigee-operator-1.11.2   1.11.2

   Verify it is up and running by checking its availability:

   kubectl -n apigee-system get deploy apigee-controller-manager

   NAME                        READY   UP-TO-DATE   AVAILABLE   AGEapigee-controller-manager   1/1     1            1           7d20h

3. Upgrade the Apigee datastore:

   Dry run:

   helm upgrade datastore apigee-datastore/ \  --install \  --namespaceapigee \  -fOVERRIDES_FILE \  --dry-run

   Upgrade the chart:

   helm upgrade datastore apigee-datastore/ \  --install \  --namespaceapigee \  -fOVERRIDES_FILE

   Note: For installations migrated fromapigeectl to Helm, use:

   helm upgrade datastore apigee-datastore/ \  --install \  --namespaceapigee \  --force \  -fOVERRIDES_FILE

   Verifyapigeedatastore is up and running by checking its state:

   kubectl -n apigee get apigeedatastore default

   NAME      STATE       AGEdefault   running    2d

4. Upgrade Apigee telemetry:

   Dry run:

   helm upgrade telemetry apigee-telemetry/ \  --install \  --namespaceapigee \  -fOVERRIDES_FILE \  --dry-run

   Upgrade the chart:

   helm upgrade telemetry apigee-telemetry/ \  --install \  --namespaceapigee \  -fOVERRIDES_FILE

   Note: For installations migrated fromapigeectl to Helm, use:

   helm upgrade telemetry apigee-telemetry/ \  --install \  --namespaceapigee \  --force \  -fOVERRIDES_FILE

   Verify it is up and running by checking its state:

   kubectl -n apigee get apigeetelemetry apigee-telemetry

   NAME               STATE     AGEapigee-telemetry   running   2d

5. Upgrade Apigee Redis:

   Dry run:

   helm upgrade redis apigee-redis/ \  --install \  --namespaceapigee \  -fOVERRIDES_FILE \  --dry-run

   Upgrade the chart:

   helm upgrade redis apigee-redis/ \  --install \  --namespaceapigee \  -fOVERRIDES_FILE

   Note: For installations migrated fromapigeectl to Helm, use:

   helm upgrade redis apigee-redis/ \  --install \  --namespaceapigee \  --force \  -fOVERRIDES_FILE

   Verify it is up and running by checking its state:

   kubectl -n apigee get apigeeredis default

   NAME      STATE     AGEdefault   running   2d

6. Upgrade Apigee ingress manager:

   Dry run:

   helm upgrade ingress-manager apigee-ingress-manager/ \  --install \  --namespaceapigee \  -fOVERRIDES_FILE \  --dry-run

   Upgrade the chart:

   helm upgrade ingress-manager apigee-ingress-manager/ \  --install \  --namespaceapigee \  -fOVERRIDES_FILE

   Note: For installations migrated fromapigeectl to Helm, use:

   helm upgrade ingress-manager apigee-ingress-manager/ \  --install \  --namespaceapigee \  --force \  -fOVERRIDES_FILE

   Verify it is up and running by checking its availability:

   kubectl -n apigee get deployment apigee-ingressgateway-manager

   NAME                            READY   UP-TO-DATE   AVAILABLE   AGEapigee-ingressgateway-manager   2/2     2            2           2d

7. Upgrade the Apigee organization:

   Dry run:

   helm upgradeORG_NAME apigee-org/ \  --install \  --namespaceapigee \  -fOVERRIDES_FILE \  --dry-run

   Upgrade the chart:

   helm upgradeORG_NAME apigee-org/ \  --install \  --namespaceapigee \  -fOVERRIDES_FILE

   Note: For installations migrated fromapigeectl to Helm, use:

   helm upgradeORG_NAME apigee-org/ \  --install \  --namespaceapigee \  --force \  -fOVERRIDES_FILE

   Verify it is up and running by checking the state of the respective org:

   kubectl -n apigee get apigeeorg

   NAME                      STATE     AGEapigee-org1-xxxxx          running   2d

8. Upgrade the environment.

   You must install one environment at a time. Specify the environment with--set env=ENV_NAME:

   Dry run:

   helm upgradeENV_RELEASE_NAME apigee-env/ \  --install \  --namespaceapigee \  --set env=ENV_NAME \  -fOVERRIDES_FILE \  --dry-run

   • ENV_RELEASE_NAME is the name with which you previously installed theapigee-env chart. In hybrid v1.10, it is usuallyapigee-env-ENV_NAME. In Hybrid v1.11 and newer it is usuallyENV_NAME.
   • ENV_NAME is the name of the environment you are upgrading.
   • OVERRIDES_FILE is your new overrides file for v.1.11.2

   Upgrade the chart:

   helm upgradeENV_RELEASE_NAME apigee-env/ \  --install \  --namespaceapigee \  --set env=ENV_NAME \  -fOVERRIDES_FILE

   Note: For installations migrated fromapigeectl to Helm, use:

   helm upgradeENV_RELEASE_NAME apigee-env/ \  --install \  --namespaceapigee \  --set env=ENV_NAME \  --force \  -fOVERRIDES_FILE

   Verify it is up and running by checking the state of the respective env:

   kubectl -n apigee get apigeeenv

   NAME                          STATE       AGE   GATEWAYTYPEapigee-org1-dev-xxx            running     2d

9. Upgrade the environment groups (virtualhosts).
   1. You must upgrade one environment group (virtualhost) at a time. Specify the environment group with--set envgroup=ENV_GROUP_NAME. Repeat the following commands for each env group mentioned in the overrides.yaml file:

      Dry run:

      helm upgradeENV_GROUP_RELEASE_NAME apigee-virtualhost/ \  --install \  --namespaceapigee \  --set envgroup=ENV_GROUP_NAME \  -fOVERRIDES_FILE \  --dry-run

      ENV_GROUP_RELEASE_NAME is the name with which you previously installed theapigee-virtualhost chart. In hybrid v1.10, it is usuallyapigee-virtualhost-ENV_GROUP_NAME. In Hybrid v1.11 and newer it is usuallyENV_GROUP_NAME.

      Upgrade the chart:

      helm upgradeENV_GROUP_RELEASE_NAME apigee-virtualhost/ \  --install \  --namespaceapigee \  --set envgroup=ENV_GROUP_NAME \  -fOVERRIDES_FILE

      Note: For installations migrated fromapigeectl to Helm, use:

      helm upgradeENV_GROUP_RELEASE_NAME apigee-virtualhost/ \  --install \  --namespaceapigee \  --set envgroup=ENV_GROUP_NAME \  --force \  -fOVERRIDES_FILE

      Note:ENV_GROUP_RELEASE_NAME must be unique within theapigee namespace.

      For example, if you have a anenvironment namedprod and anenvironment group namedprod, set the value ofENV_GROUP_RELEASE_NAME to something unique, likeprod-envgroup.

   2. Check the state of the ApigeeRoute (AR).

      Installing thevirtualhosts creates ApigeeRouteConfig (ARC) which internally creates ApigeeRoute (AR) once the Apigee watcher pulls env group related details from the control plane. Therefore, check that the corresponding AR's state is running:

      kubectl -n apigee get arc

      NAME                                STATE   AGEapigee-org1-dev-egroup                       2d

      kubectl -n apigee get ar

      NAME                                        STATE     AGEapigee-org1-dev-egroup-xxxxxx                running   2d

Install 1.11.2-hotfix.3

1. Make the following change to youroverrides.yaml file to enableruntime to use the correct tag,1.11.2-hotfix.3:

   runtime:  image:    url: "gcr.io/apigee-release/hybrid/apigee-runtime"    tag: "1.11.2-hotfix.3"

   SeeApigee 1.11.2-hotfix.3 release notes.

2. Update theapigee-env chart with thehelm upgrade command and your current overrides file.

   Repeat this for every environment.

   helm upgradeENV_RELEASE_NAME apigee-env/ \  --namespaceAPIGEE_NAMESPACE \  --set envENV_NAME \  --atomic \  -fOVERRIDES_FILE

apigeectl

1. Store the latest version number in a variable using the following command:

   Linux

   export VERSION=$(curl -s \  https://storage.googleapis.com/apigee-release/hybrid/apigee-hybrid-setup/current-version.txt?ignoreCache=1)

   Mac OS

   export VERSION=$(curl -s \  https://storage.googleapis.com/apigee-release/hybrid/apigee-hybrid-setup/current-version.txt)

   Windows

   for /f "tokens=*" %a in ('curl -s ^  https://storage.googleapis.com/apigee-release/hybrid/apigee-hybrid-setup/current-version.txt') ^do set VERSION=%a

2. Check that the variable was populated with a version number using the following command. If you want to use a different version, you can save that in an environment variable instead.

   echo $VERSION

   You should see the latest Apigee hybrid version:

     1.11.2

3. Be sure you are in the hybrid base directory (the parent of the directory where theapigeectl executable file is located):

   cd$APIGEECTL_HOME/..

4. Download the release package for your operating system using the following command. Be sure to select your platform in the following table:

   Linux

   Linux 64 bit:

   curl -LO \  https://storage.googleapis.com/apigee-release/hybrid/apigee-hybrid-setup/$VERSION/apigeectl_linux_64.tar.gz

   Mac OS

   Mac 64 bit:

   curl -LO \  https://storage.googleapis.com/apigee-release/hybrid/apigee-hybrid-setup/$VERSION/apigeectl_mac_64.tar.gz

   Windows

   Windows 64 bit:

   curl -LO ^  https://storage.googleapis.com/apigee-release/hybrid/apigee-hybrid-setup/%VERSION%/apigeectl_windows_64.zip

5. Rename your currentapigeectl/ directory to a backup directory name. For example:

   Linux

   mv $APIGEECTL_HOME/ $APIGEECTL_HOME-v1.10/

   Mac OS

   mv $APIGEECTL_HOME/ $APIGEECTL_HOME-v1.10/

   Windows

   rename %APIGEECTL_HOME% %APIGEECTL_HOME%-v1.10

6. Extract the downloaded gzip file contents into your hybrid base directory. The hybrid base directory is the directory where the renamedapigeectl-v1.10 directory is located:

   Linux

   tar xvzffilename.tar.gz -C ./

   Mac OS

   tar xvzffilename.tar.gz -C ./

   Windows

   tar xvzffilename.zip -C ./

7. The tar contents are, by default, expanded into a directory with the version and platform in its name. For example:./apigeectl_1.11.2-xxxxxxx_linux_64. Rename that directory toapigeectl using the following command:

   Linux

   mvapigeectl_1.11.2-xxxxxxx_linux_64 apigeectl

   Mac OS

   mvapigeectl_1.11.2-xxxxxxx_mac_64 apigeectl

   Windows

   renameapigeectl_1.11.2-xxxxxxx_windows_64 apigeectl

8. Change to theapigeectl directory:

   cd ./apigeectl

   This directory is theapigeectl home directory. It is where theapigeectl executable command is located.

9. These instructions use the environment variable$APIGEECTL_HOME for the directory in your file system where theapigeectl utility is installed. If needed, change directory into yourapigeectl directory and define the variable with the following command:

   Linux

   export APIGEECTL_HOME=$PWD

   echo $APIGEECTL_HOME

   Mac OS

   export APIGEECTL_HOME=$PWD

   echo $APIGEECTL_HOME

   Windows

   set APIGEECTL_HOME=%CD%

   echo %APIGEECTL_HOME%

10. Verify the version ofapigeectl with theversion command:

    ./apigeectl version

    Version:1.11.2

11. Create ahybrid-base-directory/hybrid-files directory, and then move into it. Thehybrid-filesdirectory is where configuration files such as the overrides file, certs, and service accounts are located. For example:

    Linux

    mkdir$APIGEECTL_HOME/../hybrid-files

    cd$APIGEECTL_HOME/../hybrid-files

    Mac OS

    mkdir$APIGEECTL_HOME/../hybrid-files

    cd$APIGEECTL_HOME/../hybrid-files

    Windows

    mkdir%APIGEECTL_HOME%/../hybrid-files

    cd%APIGEECTL_HOME%/../hybrid-files

12. Verify thatkubectl is 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 \*

13. In thehybrid-files directory:
    1. Update the following symbolic links to$APIGEECTL_HOME. These links allow you to run the newly installedapigeectl command from inside thehybrid-files directory:

       ln -nfs$APIGEECTL_HOME/tools toolsln -nfs$APIGEECTL_HOME/config configln -nfs$APIGEECTL_HOME/templates templatesln -nfs$APIGEECTL_HOME/plugins plugins

    2. 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

14. Do a dry run initialization to check for errors:

    ${APIGEECTL_HOME}/apigeectl init -fOVERRIDES_FILE --dry-run=client

    WhereOVERRIDES_FILE is the name of your overrides file, for example./overrides/overrides.yaml.

    Tip: You can replaceOVERRIDES_FILE in the code sample above with the name and path to your overrides file, and every instance on this page will be replaced.
15. If there are no errors, initialize hybrid 1.11.2:

    $APIGEECTL_HOME/apigeectl init -fOVERRIDES_FILE

    Note:apigeectl installs and configures Apigee ingress gateway when you runapigeectl init.
16. Check the initialization status:

    $APIGEECTL_HOME/apigeectl check-ready -fOVERRIDES_FILE

    On success, the output says:All containers ready.

    kubectl describe apigeeds -n apigee

    In the output, look forState: running.

17. Check for errors with a dry run of theapply command using the--dry-run flag:

    $APIGEECTL_HOME/apigeectl apply -fOVERRIDES_FILE --dry-run=client

18. If there are no errors, apply your overrides. Select and follow the instructions for production environments or non-prod environments, depending on your installation.

    Production

    For production environments, upgrade each hybrid component individually, and check the status of the upgraded component before proceeding to the next component.

    1. Be sure you are in thehybrid-files directory.
    2. Apply your overrides to upgrade Cassandra:

       $APIGEECTL_HOME/apigeectl apply -fOVERRIDES_FILE --datastore

    3. Check completion:

       $APIGEECTL_HOME/apigeectl check-ready -fOVERRIDES_FILE

       Tip: Ifcheck-ready fails, you can get more information about your pods with:

       kubectl -nNAMESPACE get pods

       WhereNAMESPACE is your Apigee hybrid namespace.

       Proceed to the next step only when the pods are ready.

    4. Apply your overrides to upgrade Telemetry components and check completion:

       $APIGEECTL_HOME/apigeectl apply -fOVERRIDES_FILE --telemetry

       $APIGEECTL_HOME/apigeectl check-ready -fOVERRIDES_FILE

    5. Bring up Redis components:

       $APIGEECTL_HOME/apigeectl apply -fOVERRIDES_FILE --redis

    6. Apply your overrides to upgrade the org-level components (MART, Watcher and Apigee Connect) and check completion:

       $APIGEECTL_HOME/apigeectl apply -fOVERRIDES_FILE --org

       $APIGEECTL_HOME/apigeectl check-ready -fOVERRIDES_FILE

    7. 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 -fOVERRIDES_FILE --envENV_NAME

         $APIGEECTL_HOME/apigeectl check-ready -fOVERRIDES_FILE

         WhereENV_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 -fOVERRIDES_FILE --all-envs

         $APIGEECTL_HOME/apigeectl check-ready -fOVERRIDES_FILE

    8. Apply your overrides to upgrade thevirtualhosts components and check completion:

       $APIGEECTL_HOME/apigeectl apply -fOVERRIDES_FILE --settings virtualhosts

       $APIGEECTL_HOME/apigeectl check-ready -fOVERRIDES_FILE

    Non-prod

    In most non-production, demo, or experimental environments, you can apply the overrides to all components at once. If your non-production environment is large and complex or closely mimics a production environment, you may want to use the instructions for upgrading production environments.

    1. Be sure you are in thehybrid-files directory.
    2. $APIGEECTL_HOME/apigeectl apply -fOVERRIDES_FILE

    3. Check the status:

       $APIGEECTL_HOME/apigeectl check-ready -fOVERRIDES_FILE

Install 1.11.2-hotfix.3

1. Make the following change to youroverrides.yaml file to enableruntime to use the correct tag,1.11.2-hotfix.3:

   runtime:  image:    url: "gcr.io/apigee-release/hybrid/apigee-runtime"    tag: "1.11.2-hotfix.3"

   SeeApigee 1.11.2-hotfix.3 release notes.

2. Install the hotfix withapigeectl init using your updated overrides file.

   Dry run:

   ${APIGEECTL_HOME}/apigeectl init -fOVERRIDES_FILE --dry-run=client

   Initialize:

   ${APIGEECTL_HOME}/apigeectl init -fOVERRIDES_FILE

3. Apply the hotfix withapigeectl apply.

   Dry run:

   ${APIGEECTL_HOME}/apigeectl apply -fOVERRIDES_FILE --all-envs --dry-run=client

   Apply:

   ${APIGEECTL_HOME}/apigeectl apply -fOVERRIDES_FILE --all-envs