Step 1: Create a cluster

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.

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.
  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:
  4. Use the following instructions to create a regional cluster with a minimum of 6 nodes:
    • Creating a regional cluster.
  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

  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.

  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}

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:
  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:
      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:
  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:
      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:
  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:
      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:
  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:
      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:
  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:
      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:
  3. Build the OpenShift cluster to deploy on the runtime plane and install Apigee on your OpenShift user cluster.

    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