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, see Supported versions.

Version 1.8 (unsupported)

   Supported versions:

• v1.13 (latest)                        
• v1.12                         
• v1.11                         
• List of supported versions

   Unsupported versions:

• v1.10                                      
• v1.9                                         
• v1.8                                         
• v1.7                                         
• v1.6                                         
• v1.5                                         
• v1.4                                         
• v1.3                                         
• v1.2                                         
• v1.1                                         

Upgrading: If you are upgrading to Apigee hybrid version 1.8.8, see Upgrading 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 support GKE Sandbox or gVisor 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:

   • CLUSTER_NAME (Required): The name of your new cluster.
   • CLUSTER_LOCATION: The region in which you will create your cluster.
     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. 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.
2. 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 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:
   • Apigee hybrid: supported platforms
4. Use the following instructions to create a regional cluster with a minimum of 6 nodes:
   • Creating a regional cluster.
     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: 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: If you are not creating your cluster in the default network, follow the instructions in Creating a cluster in an existing subnet
5. 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.

   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, see Enable 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 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: 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 CRD

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

   • 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

2. Check the version of GKE supported by this version of hybrid version 1.8.8:
   • Apigee hybrid: supported platforms
3. Use the following instructions to create a user cluster:
   • Create a user cluster (quickstart) 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 Installation prerequisites overview.

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 CRD

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

   • 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

2. Check the version of GKE supported by this version of hybrid version 1.8.8:
   • Apigee hybrid: supported platforms
3. Use the following instructions in the Anthos clusters on bare metal documentation to create a user cluster:
   • Creating clusters: overview.
   • Anthos clusters on bare metal 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 CRD

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

   • 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

2. Check the version of AKS supported by this version of hybrid version 1.8.8:
   • Apigee hybrid: supported platforms
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.
   • Using the Azure Portal: Quickstart: Deploy an Azure Kubernetes Service (AKS) cluster using the Azure 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 CRD

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

   • 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

2. Check the version of EKS supported by this version of hybrid version 1.8.8:
   • Apigee hybrid: supported platforms
3. Use the following instructions to create a user cluster:
   • EKS overview documentation.
   • Creating an Amazon EKS 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:

     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 CRD

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

   • 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

2. Check the version of GKE supported by this version of hybrid version 1.8.8:
   • Apigee hybrid: supported platforms
3. Use the following instructions to create a user cluster:
   • GKE on AWS overview documentation.
   • Anthos clusters on AWS 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 CRD

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

   • 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

2. Check the version of OpenShift supported by this version of hybrid version 1.8.8:
   • Apigee hybrid: supported platforms
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, see How to Set Up Apigee hybrid on Openshift on GCP VMs.

   As part of the OpenShift install, install and configure the oc CLI tool. See Getting 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-manager 3 4 5 6 7 8 9 10