Step 1: Create a cluster

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, seeSupported versions.
Upgrading:If you are upgrading to Apigee hybrid version 1.5.10, seeUpgrading Apigee hybrid 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_IDecho $CLUSTER_LOCATIONecho $ORG_NAMEecho $ENV_NAME

Click for descriptions and commands to define the variables.

These steps use the following environment variables:

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. Gather your cluster requirements for Apigee hybrid cluster:
  2. Check the version of GKE supported by this version of hybrid version 1.5.10:
  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 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.5.10:
  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 following requirements and prerequisites:

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.5.10:
  3. Use the following instructions 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:
  2. Check the version of AKS supported by this version of hybrid version 1.5.10:
  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:
  2. Check the version of EKS supported by this version of hybrid version 1.5.10:
  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:
  2. Check the version of GKE supported by this version of hybrid version 1.5.10:
  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:
  2. Check the version of GKE supported by this version of hybrid version 1.5.10:
  3. Use the following instructions to install Apigee on your OpenShift user cluster and register it with GKE Hub.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.
    1. Install and configure theoc CLI tool. SeeGetting started with the OpenShift CLI in the OpenShift documentation.
    2. Register with GKE Hub
      1. Create the a file namedgke-connect-scc.yaml with the following contents:
        # Connect Agent SCCapiVersion: v1kind: SecurityContextConstraintsmetadata:  name: gke-connect-sccallowPrivilegeEscalation: falserequiredDropCapabilities:- ALLrunAsUser:  type: MustRunAsNonRootseLinuxContext:  type: RunAsAnysupplementalGroups:  type: MustRunAs  ranges:  - min: 1    max: 65535fsGroup:  type: MustRunAs  ranges:  - min: 1    max: 65535volumes:- secretreadOnlyRootFilesystem: trueseccompProfiles:- docker/defaultusers:groups:  - system:serviceaccounts:gke-connect
      2. Create the component inoc 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 pathexport CONTEXT=admin
      4. Register with GKE Hub with the following command:
        gcloud --project=${PROJECT_ID} container hub memberships registerCLUSTER_NAME \  --kubeconfig=${KUBECONFIG} \  --context=${CONTEXT} \  --service-account-key-file=KEY_FILE_PATH

        Where:

        • PROJECT_ID is your Google Cloud project ID.
        • CLUSTER_NAME is the name of the cluster you just created.
        • KUBECONFIG is the path to your cluster kubeconfig file.
        • CONTEXT is the context under whichgcloud is registering the cluster.CONTEXT must beadmin for this command.
        • KEY_FILE_PATH 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(NEXT) Step 2: Install cert-manager3456789

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-15 UTC.