> [!CAUTION]
> You are currently viewing version 1.13 of the Apigee hybrid documentation. **This version is end of life.** You should upgrade to a newer version. For more information, see [Supported versions](https://docs.cloud.google.com/apigee/docs/hybrid/supported-platforms.md.txt#supported-versions).

<button class="button button-with-icon cloud-select-dropdown__button button-primary" aria-haspopup="true">Version 1.13 </button>

- Supported versions:
- [v1.17 (latest)](https://docs.cloud.google.com/apigee/docs/hybrid/v1.17/install-helm-charts.md.txt)
- [v1.16](https://docs.cloud.google.com/apigee/docs/hybrid/v1.16/install-helm-charts.md.txt)
- [v1.15](https://docs.cloud.google.com/apigee/docs/hybrid/v1.15/install-helm-charts.md.txt)
- [v1.14](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/install-helm-charts.md.txt)
- [List of supported versions](https://docs.cloud.google.com/apigee/docs/hybrid/supported-platforms.md.txt#supported-versions)
- Unsupported versions:
- [v1.13](https://docs.cloud.google.com/apigee/docs/hybrid/v1.13/install-helm-charts.md.txt)
- [v1.12](https://docs.cloud.google.com/apigee/docs/hybrid/v1.12/install-helm-charts.md.txt)
- [v1.11](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/install-helm-charts.html)
- [v1.10](https://docs.cloud.google.com/apigee/docs/hybrid/v1.10/install-helm-charts.html)
- [v1.9](https://docs.cloud.google.com/apigee/docs/hybrid/v1.9/install-helm-charts.html)
- [v1.8](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/install-helm-charts.html)
- [v1.7](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/install-helm-charts.html)
- [v1.6](https://docs.cloud.google.com/apigee/docs/hybrid/v1.6/install-helm-charts.html)
- [v1.5](https://docs.cloud.google.com/apigee/docs/hybrid/v1.5/install-helm-charts.html)
- [v1.4](https://docs.cloud.google.com/apigee/docs/hybrid/v1.4/install-helm-charts.html)
- [v1.3](https://docs.cloud.google.com/apigee/docs/hybrid/v1.3/install-helm-charts.html)
- [v1.2](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/install-helm-charts.html)
- [v1.1](https://docs.cloud.google.com/apigee/docs/hybrid/v1.1/install-helm-charts.html)

## Install the Apigee hybrid runtime components


In this step, you will use Helm to install the following Apigee hybrid components:

- Apigee operator
- Apigee datastore
- Apigee telemetry
- Apigee Redis
- Apigee ingress manager
- Apigee organization
- Your Apigee environment(s)


You will install the charts for each environment one at a time. The sequence in which you install the components matters.

### Pre-installation Notes

1. If you have not already installed Helm v3.14.2+, follow the instructions in [Installing Helm](https://helm.sh/docs/intro/install/).
2.
   Apigee hybrid uses Helm guardrails to verify the configuration
   before installing or upgrading a chart. You may see guardrail-specific information in the output
   of each of the commands in this section, for example:

   ```
   # Source: apigee-operator/templates/apigee-operators-guardrails.yaml
   apiVersion: v1
   kind: Pod
   metadata:
     name: apigee-hybrid-helm-guardrail-operator
     namespace:  APIGEE_NAMESPACE
     annotations:
       helm.sh/hook: pre-install,pre-upgrade
       helm.sh/hook-delete-policy: before-hook-creation,hook-succeeded
     labels:
       app: apigee-hybrid-helm-guardrail
   ```


   If any of the `helm upgrade` commands fail, you can use the guardrails output to help
   diagnose the cause. See [Diagnosing issues with guardrails](https://docs.cloud.google.com/apigee/docs/hybrid/v1.13/guardrails.md.txt).
3. Before executing any of the Helm upgrade/install commands, use the Helm dry-run feature by adding `--dry-run=server` at the end of the command. See `helm install --h` to list supported commands, options, and usage.

### Installation steps

1. If you have not, navigate into your `APIGEE_HELM_CHARTS_HOME` directory. Run the following commands from that directory.
2. Install Apigee Operator/Controller:

   > [!NOTE]
   > **Note:** This step requires elevated cluster permissions. Run `helm -h` or `helm install -h` for details

   Dry run:

   ```
   helm upgrade operator apigee-operator/ \
     --install \
     --namespace APIGEE_NAMESPACE \
     --atomic \
     -f overrides.yaml \
     --dry-run=server
   ```

   Install the chart:

   ```
   helm upgrade operator apigee-operator/ \
     --install \
     --namespace APIGEE_NAMESPACE \
     --atomic \
     -f overrides.yaml
   ```

   Verify Apigee Operator installation:

   ```
   helm ls -n APIGEE_NAMESPACE
   ```

   ```
   NAME       NAMESPACE       REVISION   UPDATED                                STATUS     CHART                                       APP VERSION
   operator   apigee   3          2023-06-26 00:42:44.492009 -0800 PST   deployed   apigee-operator-1.13.4   1.13.4
   ```

   Verify it is up and running by checking its availability:

   ```
   kubectl -n APIGEE_NAMESPACE get deploy apigee-controller-manager
   ```

   ```
   NAME                        READY   UP-TO-DATE   AVAILABLE   AGE
   apigee-controller-manager   1/1     1            1           7d20h
   ```
3. Install Apigee datastore:

   Dry run:

   ```
   helm upgrade datastore apigee-datastore/ \
     --install \
     --namespace APIGEE_NAMESPACE \
     --atomic \
     -f overrides.yaml \
     --dry-run=server
   ```

   Install the chart:

   ```
   helm upgrade datastore apigee-datastore/ \
     --install \
     --namespace APIGEE_NAMESPACE \
     --atomic \
     -f overrides.yaml
   ```

   Verify `apigeedatastore` is up and running by checking its state before
   proceeding to the next step:

   ```
   kubectl -n APIGEE_NAMESPACE get apigeedatastore default
   ```

   ```
   NAME      STATE       AGE
   default   running    2d
   ```
4. Install Apigee telemetry:

   Dry run:

   ```
   helm upgrade telemetry apigee-telemetry/ \
     --install \
     --namespace APIGEE_NAMESPACE \
     --atomic \
     -f overrides.yaml \
     --dry-run=server
   ```

   Install the chart:

   ```
   helm upgrade telemetry apigee-telemetry/ \
     --install \
     --namespace APIGEE_NAMESPACE \
     --atomic \
     -f overrides.yaml
   ```

   Verify it is up and running by checking its state:

   ```
   kubectl -n APIGEE_NAMESPACE get apigeetelemetry apigee-telemetry
   ```

   ```
   NAME               STATE     AGE
   apigee-telemetry   running   2d
   ```
5. Install Apigee Redis:

   Dry run:

   ```
   helm upgrade redis apigee-redis/ \
     --install \
     --namespace APIGEE_NAMESPACE \
     --atomic \
     -f overrides.yaml \
     --dry-run=server
   ```

   Install the chart:

   ```
   helm upgrade redis apigee-redis/ \
     --install \
     --namespace APIGEE_NAMESPACE \
     --atomic \
     -f overrides.yaml
   ```

   Verify it is up and running by checking its state:

   ```
   kubectl -n APIGEE_NAMESPACE get apigeeredis default
   ```

   ```
   NAME      STATE     AGE
   default   running   2d
   ```
6. Install Apigee ingress manager:

   Dry run:

   ```
   helm upgrade ingress-manager apigee-ingress-manager/ \
     --install \
     --namespace APIGEE_NAMESPACE \
     --atomic \
     -f overrides.yaml \
     --dry-run=server
   ```

   Install the chart:

   ```
   helm upgrade ingress-manager apigee-ingress-manager/ \
     --install \
     --namespace APIGEE_NAMESPACE \
     --atomic \
     -f overrides.yaml
   ```

   Verify it is up and running by checking its availability:

   ```
   kubectl -n APIGEE_NAMESPACE get deployment apigee-ingressgateway-manager
   ```

   ```
   NAME                            READY   UP-TO-DATE   AVAILABLE   AGE
   apigee-ingressgateway-manager   2/2     2            2           2d
   ```
7. Install Apigee organization. If you have set the
   <var translate="no">$ORG_NAME</var> environment variable in your shell, you can use that in the
   following commands:

   Dry run:

   ```
   helm upgrade $ORG_NAME apigee-org/ \
     --install \
     --namespace APIGEE_NAMESPACE \
     --atomic \
     -f overrides.yaml \
     --dry-run=server
   ```

   Install the chart:

   ```
   helm upgrade $ORG_NAME apigee-org/ \
     --install \
     --namespace APIGEE_NAMESPACE \
     --atomic \
     -f overrides.yaml
   ```

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

   ```
   kubectl -n APIGEE_NAMESPACE get apigeeorg
   ```

   ```
   NAME                      STATE     AGE
   apigee-org1-xxxxx          running   2d
   ```
8. Install the environment.

   You must install one environment at a time. Specify the environment with
   `--set env=`<var translate="no">ENV_NAME</var>. If you have set the
   <var translate="no">$ENV_NAME</var> environment variable in your shell, you can use that in the
   following commands:

   Dry run:

   ```
   helm upgrade ENV_RELEASE_NAME apigee-env/ \
     --install \
     --namespace APIGEE_NAMESPACE \
     --atomic \
     --set env=$ENV_NAME \
     -f overrides.yaml \
     --dry-run=server
   ```
   - <var translate="no">ENV_RELEASE_NAME</var> is a name used to keep track of installation and upgrades of the `apigee-env` chart. This name must be unique from the other Helm release names in your installation. Usually this is the same as `ENV_NAME`. However, if your environment has the same name as your environment group, you must use different release names for the environment and environment group, for example `dev-env-release` and `dev-envgroup-release`. For more information on releases in Helm, see [Three big concepts](https://helm.sh/docs/intro/using_helm/#three-big-concepts) in the Helm documentation.

   Install the chart:

   ```
   helm upgrade ENV_RELEASE_NAME apigee-env/ \
     --install \
     --namespace APIGEE_NAMESPACE \
     --atomic \
     --set env=$ENV_NAME \
     -f overrides.yaml
   ```

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

   ```
   kubectl -n APIGEE_NAMESPACE get apigeeenv
   ```

   ```
   NAME                          STATE       AGE   GATEWAYTYPE
   apigee-org1-dev-xxx            running     2d
   ```
9. Install the environment groups (`virtualhosts`).
   1. You must install one environment group (virtualhost) at a time. Specify the environment group with `--set envgroup=`<var translate="no">ENV_GROUP</var>. If you have set the <var translate="no">$ENV_GROUP</var> environment variable in your shell, you can use that in the following commands. Repeat the following commands for each env group mentioned in your `overrides.yaml` file:

      Dry run:

      ```
      helm upgrade ENV_GROUP_RELEASE_NAME apigee-virtualhost/ \
        --install \
        --namespace APIGEE_NAMESPACE \
        --atomic \
        --set envgroup=$ENV_GROUP \
        -f overrides.yaml \
        --dry-run=server
      ```
      - <var translate="no">ENV_GROUP_RELEASE_NAME</var> is a name used to keep track of installation and upgrades of the `apigee-virtualhosts` chart. This name must be unique from the other Helm release names in your installation. Usually this is the same as `ENV_GROUP`. However, if your environment group has the same name as an environment in your installation, you must use different release names for the environment group and environment, for example `dev-envgroup-release` and `dev-env-release`. For more information on releases in Helm, see [Three big concepts](https://helm.sh/docs/intro/using_helm/#three-big-concepts) in the Helm documentation.

      Install the chart:

      ```
      helm upgrade $ENV_GROUP_RELEASE_NAME apigee-virtualhost/ \
        --install \
        --namespace APIGEE_NAMESPACE \
        --atomic \
        --set envgroup=$ENV_GROUP \
        -f overrides.yaml
      ```

      > [!NOTE]
      > **Note:** <var translate="no">ENV_GROUP</var> must be unique within the `apigee` namespace. For example, if you have a `prod` env and envgroup, you should set this name to `prod-envgroup`. The later env group name should still be `prod`.

   2. Check the state of the ApigeeRoute (AR). Installing the `virtualhosts`
      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_NAMESPACE get arc
      ```

      ```
      NAME                                STATE   AGE
      apigee-org1-dev-egroup                       2d
      ```

      ```
      kubectl -n APIGEE_NAMESPACE get ar
      ```

      ```
      NAME                                        STATE     AGE
      apigee-org1-dev-egroup-xxxxxx                running   2d
      ```

> [!NOTE]
> **Congratulations!**
>
> You've successfully installed and configured the Apigee hybrid runtime plane.

## Next step

### Installations using Workload Identity

If you are installing Apigee hybrid on GKE and you are configuring Workload Identity to authenticate service accounts, in the next
step, you will configure the associations between the Kubernetes service accounts and the Google service accounts for your cluster.
[1](https://docs.cloud.google.com/apigee/docs/hybrid/v1.13/install-create-cluster.md.txt) [2](https://docs.cloud.google.com/apigee/docs/hybrid/v1.13/install-download-charts.md.txt) [3](https://docs.cloud.google.com/apigee/docs/hybrid/v1.13/install-create-namespace.md.txt) [4](https://docs.cloud.google.com/apigee/docs/hybrid/v1.13/install-service-accounts.md.txt) [5](https://docs.cloud.google.com/apigee/docs/hybrid/v1.13/install-create-tls-certificates.md.txt) [6](https://docs.cloud.google.com/apigee/docs/hybrid/v1.13/install-create-overrides.md.txt) [7](https://docs.cloud.google.com/apigee/docs/hybrid/v1.13/install-enable-synchronizer-access.md.txt) [8](https://docs.cloud.google.com/apigee/docs/hybrid/v1.13/install-cert-manager.md.txt) [9](https://docs.cloud.google.com/apigee/docs/hybrid/v1.13/install-crds.md.txt) [10](https://docs.cloud.google.com/apigee/docs/hybrid/v1.13/install-helm-charts.md.txt) [(NEXT) Step 11: Set up Workload Identity](https://docs.cloud.google.com/apigee/docs/hybrid/v1.13/install-workload-identity.md.txt)

<br />

### All other installations

In the next step, you will configure the Apigee ingress gateway and deploy a proxy to test your installation.
[(NEXT) Step 1: Expose Apigee ingress](https://docs.cloud.google.com/apigee/docs/hybrid/v1.13/install-expose-apigee-ingress.md.txt) [2](https://docs.cloud.google.com/apigee/docs/hybrid/v1.13/install-deploy-proxy.md.txt)

<br />