> [!CAUTION]
> You are currently viewing version 1.7 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.7 (unsupported)</button>

- Supported versions:
- [v1.17 (latest)](https://docs.cloud.google.com/apigee/docs/hybrid/v1.17/install-create-cluster.md.txt)
- [v1.16](https://docs.cloud.google.com/apigee/docs/hybrid/v1.16/install-create-cluster.md.txt)
- [v1.15](https://docs.cloud.google.com/apigee/docs/hybrid/v1.15/install-create-cluster.md.txt)
- [v1.14](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/install-create-cluster.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-create-cluster.md.txt)
- [v1.12](https://docs.cloud.google.com/apigee/docs/hybrid/v1.12/install-create-cluster.md.txt)
- [v1.11](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/install-create-cluster.md.txt)
- [v1.10](https://docs.cloud.google.com/apigee/docs/hybrid/v1.10/install-create-cluster.md.txt)
- [v1.9](https://docs.cloud.google.com/apigee/docs/hybrid/v1.9/install-create-cluster.md.txt)
- [v1.8](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/install-create-cluster.md.txt)
- [v1.7](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/install-create-cluster.md.txt)
- [v1.6](https://docs.cloud.google.com/apigee/docs/hybrid/v1.6/install-create-cluster.md.txt)
- [v1.5](https://docs.cloud.google.com/apigee/docs/hybrid/v1.5/install-create-cluster.md.txt)
- [v1.4](https://docs.cloud.google.com/apigee/docs/hybrid/v1.4/install-create-cluster.html)
- [v1.3](https://docs.cloud.google.com/apigee/docs/hybrid/v1.3/install-create-cluster.md.txt)
- [v1.2](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/install-create-cluster.md.txt)
- [v1.1](https://docs.cloud.google.com/apigee/docs/hybrid/v1.1/install-create-cluster.md.txt)

> [!WARNING]
> **Upgrading:** If you are upgrading to Apigee hybrid version 1.7.6, see [Upgrading Apigee hybrid](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/upgrade.md.txt) for instructions. If you are performing a new installation, continue with the configurations described below.

## Before you begin:


These steps assume you have created environment variables in the previous steps. Check them with
the following commands:

    echo $PROJECT_ID
    echo $CLUSTER_LOCATION
    echo $ORG_NAME
    echo $ENV_NAME

### *Click for descriptions and commands to define the variables.*


These steps use the following environment variables:

- <var translate="no">PROJECT_ID</var>: The ID of your Google Cloud project. See [Hybrid
  quickstart - Step 2: Create a Google Cloud project](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/precog-gcpproject)

  ```
  export PROJECT_ID=your_project_ID
  ```
- <var translate="no">CLUSTER_LOCATION</var>: The region in which your you will create your cluster.

  ```
  export CLUSTER_LOCATION=cluster-region
  ```

  > [!NOTE]
  > **Note:** Apigee recommends you use a ***region*** name and not a zone name. A region is a specific geographical location where you can host your resources. Regions can have multiple zones. For example, the `us-west1` **region** denotes a region on the west coast of the United States that has three zones: `us-west1-a`, `us-west1-b`, `and us-west1-c`. The available regions are listed in [Available regions and
  > zones](https://docs.cloud.google.com/compute/docs/regions-zones#available). Just be aware that, for example, `us-west1` is a valid region name, while `us-west1-a` is a zone in the region. For most hybrid installations, use a region name for the `CLUSTER_LOCATION` variable.

- <var translate="no">ORG_NAME</var>: The name of your org. This must match your Google Cloud project ID. See [Hybrid
  quickstart - Step 4: Create an organization](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/precog-provision)

  ```
  export ORG_NAME=your_organization_name
  ```
- <var translate="no">ENV_NAME</var>: The name of your hybrid environment. See [Hybrid
  quickstart - Step 6: Create an environment group](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/precog-add-environment)

  ```
  export ENV_NAME=your_environment_name
  ```


This procedure explains how to set up the cluster in which you will run Apigee hybrid. The
instructions vary depending on the platform in which you are running hybrid. Select your
platform to see the instructions.

### GKE


This step explains how to set up your shell environment and create a GKE cluster
in your Google Cloud project.

> [!CAUTION]
> **Caution:** Apigee does not support [GKE
> Sandbox](https://cloud.google.com/kubernetes-engine/docs/concepts/sandbox-pods) or [gVisor for hybrid installations on GKE](https://github.com/google/gvisor).

## Creating a cluster

1. Gather your cluster requirements for Apigee hybrid cluster: The minimum configurations for your cluster are:

   | Configuration | Stateful node pool | Stateless node pool |
   |---|---|---|
   | Number of nodes | 3 (per region) | 3 (per region) |
   | CPU | 4 | 4 |
   | RAM | 15 | 15 |
   | Default label name | apigee-data | apigee-runtime |
   | Storage | dynamic | Managed with the [ApigeeDeployment](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/apigee-deployment-services.md.txt) CRD |


   For more details on minimum cluster configuration see:
   [Minimum cluster configurations](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/cluster-overview.md.txt)
2. Check the version of GKE supported by this version of hybrid version 1.7.6:
   - [Apigee hybrid: supported platforms](https://docs.cloud.google.com/apigee/docs/hybrid/supported-platforms.md.txt)
3. Use the following instructions to create a regional cluster with a minimum of 6 nodes:
   - [Creating a regional
     cluster](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/creating-a-regional-cluster).

     > [!TIP]
     > **Tip:** If you are using the Google Cloud console to create your cluster, add the node pools before clicking **Create** to create the cluster.

     > [!NOTE]
     > **Note:** Apigee recommends creating a regional cluster. If you prefer to create a zonal cluster, make sure to use the zone where the instructions ask for your location in subsequent steps.

     > [!TIP]
     > **Tip:** If you are not creating your cluster in the default network, follow the instructions in [Creating a cluster in an
     > existing subnet](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/alias-ips#creating_cluster)

4. Create a minimum of two node pools for your cluster. The minimum node pool requirements are:

   | Default node pool name | Description | Minimum nodes | Minimum CPUs per node pool | Minimum CPUs per node |
   |---|---|---|---|---|
   | `apigee-data` | A stateful node pool. | 3 | 4 | 4/number of nodes in the pool |
   | `apigee-runtime` | A stateless node pool. | 3 | 4 | 4/number of nodes in the pool |


   Follow the instructions in [Adding and
   managing node pools](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-pools).


   For more details about node pool configuration see:
   [Configure dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/configure-dedicated-nodes.md.txt)

   > [!TIP]
   > **Tip:** After you create the node pools, you can verify them with the following command:
   >
   > ```
   > gcloud container node-pools list \
   >   --cluster=${CLUSTER_NAME} \
   >   --region=${CLUSTER_LOCATION}
   > ```

5. After creating the cluster enable workload identity on the cluster with the following command:

   ```
   gcloud container clusters update ${CLUSTER_NAME} \
     --workload-pool=$PROJECT_ID.svc.id.goog \
     --region ${CLUSTER_LOCATION}
   ```


   For more information see
   [Enabling
   Workload Identity on a cluster](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/workload-identity#enable_on_cluster)

   > [!NOTE]
   > **Note:** If you created a zonal cluster instead of a regional cluster, use the `--zone` argument instead of `--region` as in the following command:
   >
   > ```
   > gcloud container clusters update ${CLUSTER_NAME} \
   >   --workload-pool=$PROJECT_ID.svc.id.goog \
   >   --zone ${CLUSTER_LOCATION}
   > ```

6. Get the `gcloud` credentials of the cluster you just created with the following command:

   ```
   gcloud container clusters get-credentials ${CLUSTER_NAME} \
     --region ${CLUSTER_LOCATION} \
     --project ${PROJECT_ID}
   ```

   > [!NOTE]
   > **Note:** If you created a zonal cluster instead of a regional cluster, get the credentials with the following command:
   >
   > ```
   > gcloud container clusters get-credentials ${CLUSTER_NAME} \
   >   --zone ${CLUSTER_LOCATION} \
   >   --project ${PROJECT_ID}
   > ```


When you have a cluster installed and running, go to the next step.

### GKE on prem

## Creating a cluster

1. Gather your cluster requirements for Apigee hybrid cluster:
   - The minimum configurations for your cluster are:

     | Configuration | Stateful node pool | Stateless node pool |
     |---|---|---|
     | Number of nodes | 3 (per region) | 3 (per region) |
     | CPU | 4 | 4 |
     | RAM | 15 | 15 |
     | Default label name | apigee-data | apigee-runtime |
     | Storage | dynamic | Managed with the [ApigeeDeployment](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/apigee-deployment-services.md.txt) CRD |


     For more details on minimum cluster configuration see:
     [Minimum cluster configurations](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/cluster-overview.md.txt)
   - Create a minimum of two node pools:

     | Default node pool name | Description |
     |---|---|
     | `apigee-data` | A stateful node pool. |
     | `apigee-runtime` | A stateless node pool. |


     For more details about node pool configuration see:
     [Configure dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/configure-dedicated-nodes.md.txt)
2. Check the version of GKE supported by this version of hybrid version 1.7.6:
   - [Apigee hybrid: supported platforms](https://docs.cloud.google.com/apigee/docs/hybrid/supported-platforms.md.txt)
3. Use the following instructions to create a user cluster:
   - [Create a user cluster (quickstart)](https://docs.cloud.google.com/anthos/clusters/docs/on-prem/1.10/how-to/user-cluster-quickstart.md.txt) in the GKE on-prem documentation.


When you have a cluster installed and running, go to the next step.

### Anthos on bare metal

## Requirements and prerequisites

Anthos clusters on bare metal lets you run Kubernetes clusters directly on your own machine
resources.

Review the following requirements and prerequisites:

- Hardware requirements: [Configuring hardware for
  Anthos clusters on bare metal](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.7/installing/hardware)
- [Installation
  prerequisites overview](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.7/installing/install-prereq)

## Creating a cluster

1. Gather your cluster requirements for Apigee hybrid cluster:
   - The minimum configurations for your cluster are:

     | Configuration | Stateful node pool | Stateless node pool |
     |---|---|---|
     | Number of nodes | 3 (per region) | 3 (per region) |
     | CPU | 4 | 4 |
     | RAM | 15 | 15 |
     | Default label name | apigee-data | apigee-runtime |
     | Storage | dynamic | Managed with the [ApigeeDeployment](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/apigee-deployment-services.md.txt) CRD |


     For more details on minimum cluster configuration see:
     [Minimum cluster configurations](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/cluster-overview.md.txt)
   - Create a minimum of two node pools:

     | Default node pool name | Description |
     |---|---|
     | `apigee-data` | A stateful node pool. |
     | `apigee-runtime` | A stateless node pool. |


     For more details about node pool configuration see:
     [Configure dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/configure-dedicated-nodes.md.txt)
2. Check the version of GKE supported by this version of hybrid version 1.7.6:
   - [Apigee hybrid: supported platforms](https://docs.cloud.google.com/apigee/docs/hybrid/supported-platforms.md.txt)
3. Use the following instructions in the Anthos clusters on bare metal documentation to create a user cluster:
   - [Creating
     clusters: overview](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.7/installing/creating-clusters/create-clusters-overview).
   - [Anthos clusters on bare metal
     quickstart](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.7/quickstart) in the Anthos clusters on bare metal documentation.


When you have a cluster installed and running, go to the next step.

### AKS

## Create an AKS cluster

1. Gather your cluster requirements for Apigee hybrid cluster:
   - The minimum configurations for your cluster are:

     | Configuration | Stateful node pool | Stateless node pool |
     |---|---|---|
     | Number of nodes | 3 (per region) | 3 (per region) |
     | CPU | 4 | 4 |
     | RAM | 15 | 15 |
     | Default label name | apigee-data | apigee-runtime |
     | Storage | dynamic | Managed with the [ApigeeDeployment](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/apigee-deployment-services.md.txt) CRD |


     For more details on minimum cluster configuration see:
     [Minimum cluster configurations](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/cluster-overview.md.txt)
   - Create a minimum of two node pools:

     | Default node pool name | Description |
     |---|---|
     | `apigee-data` | A stateful node pool. |
     | `apigee-runtime` | A stateless node pool. |


     For more details about node pool configuration see:
     [Configure dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/configure-dedicated-nodes.md.txt)
2. Check the version of AKS supported by this version of hybrid version 1.7.6:
   - [Apigee hybrid: supported platforms](https://docs.cloud.google.com/apigee/docs/hybrid/supported-platforms.md.txt)
3. Use one of the following sets of instructions to create a cluster:
   - Using the Azure CLI: [Quickstart: Deploy an Azure Kubernetes Service cluster using the Azure CLI](https://docs.microsoft.com/en-us/azure/aks/kubernetes-walkthrough).
   - Using the Azure Portal: [Quickstart: Deploy an Azure Kubernetes Service (AKS) cluster using the Azure portal](https://docs.microsoft.com/en-us/azure/aks/kubernetes-walkthrough-portal).

### EKS

## Creating a cluster

1. Gather your cluster requirements for Apigee hybrid cluster:
   - The minimum configurations for your cluster are:

     | Configuration | Stateful node pool | Stateless node pool |
     |---|---|---|
     | Number of nodes | 3 (per region) | 3 (per region) |
     | CPU | 4 | 4 |
     | RAM | 15 | 15 |
     | Default label name | apigee-data | apigee-runtime |
     | Storage | dynamic | Managed with the [ApigeeDeployment](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/apigee-deployment-services.md.txt) CRD |


     For more details on minimum cluster configuration see:
     [Minimum cluster configurations](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/cluster-overview.md.txt)
   - Create a minimum of two node pools:

     | Default node pool name | Description |
     |---|---|
     | `apigee-data` | A stateful node pool. |
     | `apigee-runtime` | A stateless node pool. |


     For more details about node pool configuration see:
     [Configure dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/configure-dedicated-nodes.md.txt)
2. Check the version of EKS supported by this version of hybrid version 1.7.6:
   - [Apigee hybrid: supported platforms](https://docs.cloud.google.com/apigee/docs/hybrid/supported-platforms.md.txt)
3. Use the following instructions to create a user cluster:
   - [EKS overview documentation](https://docs.aws.amazon.com/eks/latest/userguide/what-is-eks.html).
   - [Creating an Amazon EKS cluster](https://docs.aws.amazon.com/eks/latest/userguide/create-cluster.html).


When you have a cluster installed and running, go to the next step.

### GKE on AWS

## Creating a cluster

1. Gather your cluster requirements for Apigee hybrid cluster:
   - The minimum configurations for your cluster are:

     | Configuration | Stateful node pool | Stateless node pool |
     |---|---|---|
     | Number of nodes | 3 (per region) | 3 (per region) |
     | CPU | 4 | 4 |
     | RAM | 15 | 15 |
     | Default label name | apigee-data | apigee-runtime |
     | Storage | dynamic | Managed with the [ApigeeDeployment](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/apigee-deployment-services.md.txt) CRD |


     For more details on minimum cluster configuration see:
     [Minimum cluster configurations](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/cluster-overview.md.txt)
   - Create a minimum of two node pools:

     | Default node pool name | Description |
     |---|---|
     | `apigee-data` | A stateful node pool. |
     | `apigee-runtime` | A stateless node pool. |


     For more details about node pool configuration see:
     [Configure dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/configure-dedicated-nodes.md.txt)
2. Check the version of GKE supported by this version of hybrid version 1.7.6:
   - [Apigee hybrid: supported platforms](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/apigee/docs/hybrid/supported-platforms)
3. Use the following instructions to create a user cluster:
   - [GKE on AWS overview documentation](https://docs.cloud.google.com/anthos/gke/docs/aws).
   - [Anthos clusters on AWS
     installation overview](https://docs.cloud.google.com/anthos/clusters/docs/aws/how-to/installation-overview).


When you have a cluster installed and running, go to the next step.

### OpenShift

## Creating a cluster

1. Gather your cluster requirements for Apigee hybrid cluster:
   - The minimum configurations for your cluster are:

     | Configuration | Stateful node pool | Stateless node pool |
     |---|---|---|
     | Number of nodes | 3 (per region) | 3 (per region) |
     | CPU | 4 | 4 |
     | RAM | 15 | 15 |
     | Default label name | apigee-data | apigee-runtime |
     | Storage | dynamic | Managed with the [ApigeeDeployment](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/apigee-deployment-services.md.txt) CRD |


     For more details on minimum cluster configuration see:
     [Minimum cluster configurations](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/cluster-overview.md.txt)
   - Create a minimum of two node pools:

     | Default node pool name | Description |
     |---|---|
     | `apigee-data` | A stateful node pool. |
     | `apigee-runtime` | A stateless node pool. |


     For more details about node pool configuration see:
     [Configure dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/configure-dedicated-nodes.md.txt)
2. Check the version of OpenShift supported by this version of hybrid version 1.7.6:
   - [Apigee hybrid: supported platforms](https://docs.cloud.google.com/apigee/docs/hybrid/supported-platforms.md.txt)
3. Build the OpenShift cluster to deploy on the runtime plane and install Apigee on your OpenShift user cluster.

   > [!NOTE]
   > You can find additional information about OpenShift cluster creation and management on GCP in the OpenShift documentation, for example: [Installing
   > a cluster quickly on GCP](https://docs.openshift.com/container-platform/4.10/installing/installing_gcp/installing-gcp-default.html#installing-gcp-default).

   > [!NOTE]
   > For help setting up your OpenShift cluster on GCP VMs, see [How to Set Up Apigee hybrid on Openshift on GCP VMs](https://www.googlecloudcommunity.com/gc/Cloud-Product-Articles/How-to-Set-Up-Apigee-hybrid-on-Openshift-on-GCP-VMs/ta-p/480473).


   As part of the OpenShift install, install and configure the `oc`
   CLI tool. See [Getting
   started with the OpenShift CLI](https://docs.openshift.com/container-platform/4.10/cli_reference/openshift_cli/getting-started-cli.html#installing-openshift-cli) in the OpenShift documentation.


When you have installed a cluster, go to the next step.


[1](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/install-create-cluster.md.txt) [(NEXT) Step 2: Install cert-manager](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/install-cert-manager.md.txt) [3](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/install-asm.md.txt) [4](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/install-apigeectl.md.txt) [5](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/install-service-accounts.md.txt) [6](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/install-create-tls-certificates.md.txt) [7](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/install-configure-cluster.md.txt) [8](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/install-enable-synchronizer-access.md.txt) [9](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/install-hybrid-runtime.md.txt)

<br />