Step 1: Create a cluster

You are currently viewing version 1.8 of the Apigee hybrid documentation.This version is end of life. You should upgrade to a newer version. For more information, seeSupported versions.
Upgrading:If you are upgrading to Apigee hybrid version 1.8.8, seeUpgrading Apigee hybrid for instructions. If you are performing a new installation, continue with the configurations described below.

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:Apigee does not supportGKE Sandbox orgVisor for hybrid installations on GKE.

Creating a cluster

  1. Create the following environment variables:

    Linux / MacOS

    export CLUSTER_NAME="YOUR_CLUSTER_NAME"export CLUSTER_LOCATION="YOUR_CLUSTER_LOCATION"

    Windows

    set CLUSTER_NAME="YOUR_CLUSTER_NAME"set CLUSTER_LOCATION=YOUR_CLUSTER_LOCATION

    Where:

  2. Gather your cluster requirements for Apigee hybrid cluster: The minimum configurations for your cluster are:
    ConfigurationStateful node poolStateless node pool
    Number of nodes3 (per region)3 (per region)
    CPU44
    RAM1515
    Default label nameapigee-dataapigee-runtime
    StoragedynamicManaged with theApigeeDeployment CRD

    For more details on minimum cluster configuration see:Minimum cluster configurations

  3. Check the version of GKE supported by this version of hybrid version 1.8.8:
  4. Use the following instructions to create a regional cluster with a minimum of 6 nodes:
  5. Create a minimum of two node pools for your cluster. The minimum node pool requirements are:
    Default node pool nameDescriptionMinimum nodesMinimum CPUs per node poolMinimum CPUs per node
    apigee-dataA stateful node pool.344/number of nodes in the pool
    apigee-runtimeA stateless node pool.344/number of nodes in the pool

    Follow the instructions inAdding and managing node pools.

    For more details about node pool configuration see:Configure dedicated node pools

    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} \  --project=${PROJECT_ID}
  6. After the cluster is created, enable workload identity on the cluster. This operation can take up to 30 minutes:
    gcloud container clusters update${CLUSTER_NAME} \  --workload-pool=${PROJECT_ID}.svc.id.goog \  --project${PROJECT_ID} \  --region${CLUSTER_LOCATION}

    For more information, seeEnable Workload Identity.

    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} \  --project${PROJECT_ID}
  7. Get thegcloud 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: 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:
  2. Check the version of GKE supported by this version of hybrid version 1.8.8:
  3. Use the following instructions to create a user cluster:

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 Installation prerequisites overview.

Creating a cluster

  1. Gather your cluster requirements for Apigee hybrid cluster:
    • The minimum configurations for your cluster are:
      ConfigurationStateful node poolStateless node pool
      Number of nodes3 (per region)3 (per region)
      CPU44
      RAM1515
      Default label nameapigee-dataapigee-runtime
      StoragedynamicManaged with theApigeeDeployment CRD

      For more details on minimum cluster configuration see:Minimum cluster configurations

    • Create a minimum of two node pools:
      Default node pool nameDescription
      apigee-dataA stateful node pool.
      apigee-runtimeA stateless node pool.

      For more details about node pool configuration see:Configure dedicated node pools

  2. Check the version of GKE supported by this version of hybrid version 1.8.8:
  3. Use the following instructions in the Anthos clusters on bare metal documentation to create a user cluster:

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:
      ConfigurationStateful node poolStateless node pool
      Number of nodes3 (per region)3 (per region)
      CPU44
      RAM1515
      Default label nameapigee-dataapigee-runtime
      StoragedynamicManaged with theApigeeDeployment CRD

      For more details on minimum cluster configuration see:Minimum cluster configurations

    • Create a minimum of two node pools:
      Default node pool nameDescription
      apigee-dataA stateful node pool.
      apigee-runtimeA stateless node pool.

      For more details about node pool configuration see:Configure dedicated node pools

  2. Check the version of AKS supported by this version of hybrid version 1.8.8:
  3. Use one of the following sets of instructions to create a cluster:

EKS

Creating a cluster

  1. Gather your cluster requirements for Apigee hybrid cluster:
    • The minimum configurations for your cluster are:
      ConfigurationStateful node poolStateless node pool
      Number of nodes3 (per region)3 (per region)
      CPU44
      RAM1515
      Default label nameapigee-dataapigee-runtime
      StoragedynamicManaged with theApigeeDeployment CRD

      For more details on minimum cluster configuration see:Minimum cluster configurations

    • Create a minimum of two node pools:
      Default node pool nameDescription
      apigee-dataA stateful node pool.
      apigee-runtimeA stateless node pool.

      For more details about node pool configuration see:Configure dedicated node pools

  2. Check the version of EKS supported by this version of hybrid version 1.8.8:
  3. Use the following instructions to create a user cluster:

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:
      ConfigurationStateful node poolStateless node pool
      Number of nodes3 (per region)3 (per region)
      CPU44
      RAM1515
      Default label nameapigee-dataapigee-runtime
      StoragedynamicManaged with theApigeeDeployment CRD

      For more details on minimum cluster configuration see:Minimum cluster configurations

    • Create a minimum of two node pools:
      Default node pool nameDescription
      apigee-dataA stateful node pool.
      apigee-runtimeA stateless node pool.

      For more details about node pool configuration see:Configure dedicated node pools

  2. Check the version of GKE supported by this version of hybrid version 1.8.8:
  3. Use the following instructions to create a user cluster:

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:
      ConfigurationStateful node poolStateless node pool
      Number of nodes3 (per region)3 (per region)
      CPU44
      RAM1515
      Default label nameapigee-dataapigee-runtime
      StoragedynamicManaged with theApigeeDeployment CRD

      For more details on minimum cluster configuration see:Minimum cluster configurations

    • Create a minimum of two node pools:
      Default node pool nameDescription
      apigee-dataA stateful node pool.
      apigee-runtimeA stateless node pool.

      For more details about node pool configuration see:Configure dedicated node pools

  2. Check the version of OpenShift supported by this version of hybrid version 1.8.8:
  3. Build the OpenShift cluster to deploy on the runtime plane and install Apigee on your OpenShift user cluster.You can find additional information about OpenShift cluster creation and management on Google Cloud in the OpenShift documentation, for example:Installing a cluster quickly on Google Cloud.For help setting up your OpenShift cluster on Google Cloud VMs, seeHow to Set Up Apigee hybrid on Openshift on GCP VMs.

    As part of the OpenShift install, install and configure theoc CLI tool. SeeGetting started with the OpenShift CLI in the OpenShift documentation.

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

 

1(NEXT) Step 2: Install cert-manager345678910

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-17 UTC.