Part 2: Hybrid runtime setup

You are currently viewing version 1.7 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.7 (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                                         

Supported platforms

See Apigee hybrid: supported platforms.

Minimum cluster configurations

Your cluster must meet minimum configuration requirements. For details, see Minimum cluster configurations.

Cluster permissions

Each supported platform has its own permission requirements for creating a cluster. After the cluster is created. As cluster owner, you can proceed to install the Apigee-specific components (including Apigee, ASM, and cert-manager) into the cluster. However, if you want to delegate to another user the installation of the runtime components into the cluster, you can manage the necessary permissions through Kubernetes authn-authz.

To install the hybrid runtime components into the cluster, a non-cluster-owner user should have CRUD permission on these resources:

• ClusterRole
• Webhooks (ValidatingWebhookConfiguration and MutatingWebhookConfiguration)
• PriorityClass
• ClusterIssuer
• CustomerResourceDefinitions
• StorageClass (Optional, if the default StorageClass is not used. For information on changing the default and creating a custom storage class, see StorageClass configuration.)

Prerequisites

This section describes tasks you must accomplish before you begin the runtime plane quickstart install.

Complete the following tasks to ensure that you can successfully begin the runtime installation (as described in this section):
Complete the Google Cloud and UI setup steps in Configure Google Cloud services and hybrid UI.
Have a domain name you can use for your Apigee hybrid installation. This should be a domain you have management access to. If you need to register a domain, see a domain registrar like Google Domains.

Note about clusters: You can create a new separate cluster for Apigee hybrid or you can install it in a cluster that is running other workloads.

• Shared cluster: If you install Apigee hybrid in a cluster running other workloads, you need to upgrade and maintain your GKE/AKS cluster at the versions and features required in common for Apigee hybrid and for your other workloads. You may want to develop a plan to migrate one or more workloads in case conflicts arise between supported versions and requirements.
• Separate cluster: Creating a dedicated cluster for Apigee hybrid adds isolation. It also adds the operational effort of maintaining the new cluster.

Both options are valid.

Note about VPC Service Controls: If you plan to enable Google Cloud Virtual Private Cloud (VPC) Service Controls with your Apigee hybrid installation, see Using VPC Service Controls with Apigee and Apigee hybrid for instructions before you proceed.

After you have satisfied the above prerequisites, go to the quickstart for your platform:

Let's get started and create a cluster