Step 1: Create a cluster

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:

PROJECT_ID: The ID of your Google Cloud project. See Hybrid quickstart - Step 2: Create a Google Cloud project
```
export PROJECT_ID=your_project_ID
```
CLUSTER_LOCATION: The region in which your you will create your cluster.
```
export CLUSTER_LOCATION=cluster-region
```
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.
ORG_NAME: The name of your org. This must match your Google Cloud project ID. See Hybrid quickstart - Step 4: Create an organization
```
export ORG_NAME=your_organization_name
```
ENV_NAME: The name of your hybrid environment. See Hybrid quickstart - Step 6: Create an environment group
```
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.

Creating a cluster

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

Check the version of GKE supported by this version of hybrid version 1.6.9:
- Apigee hybrid: supported platforms
Use the following instructions to create a regional cluster with a minimum of 6 nodes:
- Creating a regional cluster.
  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

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

After creating the cluster enable workload identity on the cluster with the following command:
```
gcloud container clusters update ${CLUSTER_NAME} \
  --workload-pool=$PROJECT_ID.svc.id.goog \
  --region ${CLUSTER_LOCATION}
```
For more information see Enabling Workload Identity on a cluster
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}
```

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

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

Check the version of GKE supported by this version of hybrid version 1.6.9:
- Apigee hybrid: supported platforms
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 following requirements and prerequisites:

Hardware requirements: Configuring hardware for Anthos clusters on bare metal
Installation prerequisites overview

Creating a cluster

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

Check the version of GKE supported by this version of hybrid version 1.6.9:
- Apigee hybrid: supported platforms
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

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

Check the version of AKS supported by this version of hybrid version 1.6.9:
- Apigee hybrid: supported platforms
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

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

Check the version of EKS supported by this version of hybrid version 1.6.9:
- Apigee hybrid: supported platforms
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

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

Check the version of GKE supported by this version of hybrid version 1.6.9:
- Apigee hybrid: supported platforms
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

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

Check the version of GKE supported by this version of hybrid version 1.6.9:
- Apigee hybrid: supported platforms
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 the oc CLI tool. See Getting started with the 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 the 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:
    - 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 which gcloud is registering the cluster. CONTEXT must be admin 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-manager 3 4 5 6 7 8 9