> [!CAUTION]
> You are currently viewing version 1.5 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.5 (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.5.10, see [Upgrading Apigee hybrid](https://docs.cloud.google.com/apigee/docs/hybrid/v1.5/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.5/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.5/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.5/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:
   - [Minimum cluster configurations](https://docs.cloud.google.com/apigee/docs/hybrid/v1.5/cluster-overview.md.txt)
   - [Configure dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.5/configure-dedicated-nodes.md.txt)
2. Check the version of GKE supported by this version of hybrid version 1.5.10:
   - [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:
   - [Creating a regional
     cluster](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/creating-a-regional-cluster).

     > [!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.


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:
   - [Minimum cluster configurations](https://docs.cloud.google.com/apigee/docs/hybrid/v1.5/cluster-overview.md.txt)
   - [Configure dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.5/configure-dedicated-nodes.md.txt)
2. Check the version of GKE supported by this version of hybrid version 1.5.10:
   - [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:
   - [GKE on-prem installation overview](https://cloud.google.com/gke-on-prem/docs/how-to/install-overview-basic) 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.6/installing/hardware)
- [Installation
  prerequisites overview](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.6/installing/install-prereq)

## Creating a cluster

1. Gather your cluster requirements for Apigee hybrid cluster:
   - [Minimum cluster configurations](https://docs.cloud.google.com/apigee/docs/hybrid/v1.5/cluster-overview.md.txt)
   - [Configure dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.5/configure-dedicated-nodes.md.txt)
2. Check the version of GKE supported by this version of hybrid version 1.5.10:
   - [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:
   - [Creating
     user clusters in a multi-cluster setup](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.6/installing/creating-clusters/user-cluster-creation) 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:
   - [Minimum cluster configurations](https://docs.cloud.google.com/apigee/docs/hybrid/v1.5/cluster-overview.md.txt)
   - [Configure dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.5/configure-dedicated-nodes.md.txt)
2. Check the version of AKS supported by this version of hybrid version 1.5.10:
   - [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:
   - [Minimum cluster configurations](https://docs.cloud.google.com/apigee/docs/hybrid/v1.5/cluster-overview.md.txt)
   - [Configure dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.5/configure-dedicated-nodes.md.txt)
2. Check the version of EKS supported by this version of hybrid version 1.5.10:
   - [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:
   - [Minimum cluster configurations](https://docs.cloud.google.com/apigee/docs/hybrid/v1.5/cluster-overview.md.txt)
   - [Configure dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.5/configure-dedicated-nodes.md.txt)
2. Check the version of GKE supported by this version of hybrid version 1.5.10:
   - [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:
   - [GKE on AWS overview documentation](https://cloud.google.com/anthos/gke/docs/aws).
   - [Installing GKE on AWS](https://cloud.google.com/anthos/gke/docs/aws/how-to#installing-gke-on-aws).


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:
   - [Minimum cluster configurations](https://docs.cloud.google.com/apigee/docs/hybrid/v1.5/cluster-overview.md.txt)
   - [Configure dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.5/configure-dedicated-nodes.md.txt)
2. Check the version of GKE supported by this version of hybrid version 1.5.10:
   - [Apigee hybrid: supported platforms](https://docs.cloud.google.com/apigee/docs/hybrid/supported-platforms.md.txt)
3. Use the following instructions to install Apigee on your OpenShift user cluster and register it with GKE Hub.

   > [!NOTE]
   > If you do not have an openshift cluster ready to use with Apigee, see the the instructions in the OpenShift documentation, for example: [Installing
   > a cluster quickly on Google Cloud](https://docs.openshift.com/container-platform/4.6/installing/installing_gcp/installing-gcp-default.html#installing-gcp-default).

   1. Install and configure the `oc` CLI tool. See [Getting
      started with the OpenShift CLI](https://docs.openshift.com/container-platform/4.6/cli_reference/openshift_cli/getting-started-cli.html#installing-openshift-cli) in the OpenShift documentation.
   2. Register with GKE Hub
      1. Create the a file named `gke-connect-scc.yaml` with the following contents:

         ```
         # Connect Agent SCC
         apiVersion: v1
         kind: SecurityContextConstraints
         metadata:
           name: gke-connect-scc
         allowPrivilegeEscalation: false
         requiredDropCapabilities:
         - ALL
         runAsUser:
           type: MustRunAsNonRoot
         seLinuxContext:
           type: RunAsAny
         supplementalGroups:
           type: MustRunAs
           ranges:
           - min: 1
             max: 65535
         fsGroup:
           type: MustRunAs
           ranges:
           - min: 1
             max: 65535
         volumes:
         - secret
         readOnlyRootFilesystem: true
         seccompProfiles:
         - docker/default
         users:
         groups:
           - system:serviceaccounts:gke-connect
                 
         ```
      2. Create the component in `oc` with hte following command:

         ```
         oc create -f gke-connect-scc.yaml
         ```
      3. Create the environment variables for the context with the following commands:

             export KUBECONFIG=<> # Cluster kubeconfig file path
             export CONTEXT=admin

      4. Register with GKE Hub with the following command:

         ```
         gcloud --project=${PROJECT_ID} container hub memberships register CLUSTER_NAME \
           --kubeconfig=${KUBECONFIG} \
           --context=${CONTEXT} \
           --service-account-key-file=KEY_FILE_PATH
         ```


         Where:
         - <var translate="no">PROJECT_ID</var> is your Google Cloud project ID.
         - <var translate="no">CLUSTER_NAME</var> is the name of the cluster you just created.
         - <var translate="no">KUBECONFIG</var> is the path to your cluster kubeconfig file.
         - <var translate="no">CONTEXT</var> is the context under which `gcloud` is registering the cluster. <var translate="no">CONTEXT</var> must be `admin` for this command.
         - <var translate="no">KEY_FILE_PATH</var> is the path to your service account key file, for example `./dist/apigee-my-project-ro-sa.json`. The service account must have the the following two IAM roles:
           - GKE Hub Admin
           - GKE Connect Agent


When you have a cluster installed and registered with GKE Hub, go to the next step.


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

<br />