Step 1: Create a cluster Stay organized with collections Save and categorize content based on your preferences.
This step explains how to set up your shell environment and create a Microsoft® Azure Kubernetes Service (AKS) cluster suitable for testing Apigee hybrid.
Note: There are many variations on how to create clusters in AKS. This topic walks through a basic scenario to help get you started with hybrid. For more detailed information about creating clusters on AKS, seeQuickstart: Deploy an Azure Kubernetes Service cluster using the Azure CLI andQuickstart: Deploy an Azure Kubernetes Service (AKS) cluster using the Azure portalSet up your terminal shell
Be sure you have the Azure CLI (az) andkubectl tool installed in your local shell. The Azure CLI tool provides the primary command-line interface for Azure, andkubectl provides the primary command-line interface for running commands against Kubernetes clusters.
Create a resource group
Create a resource group either using Azure console or with the Azure CLI using the following command:
az group create --name my-hybrid-rg --location eastus
Create a virtual network
Create a virtual network with a non-conflicting CIDR range.
For example:
Syntax
az network vnet create \ --namevnet-name \ --resource-groupmy-hybrid-rg \ --address-prefixesvnet-address-range \ --subnet-namevnet-subnet-name \ --subnet-prefixsubnet-address-range
Example
az network vnet create \ --name my-hybrid-rg-vnet \ --resource-group my-hybrid-rg \ --address-prefixes 120.38.1.0/14 \ --subnet-name my-hybrid-rg-vnet-subnet \ --subnet-prefix 120.38.1.0/16
Where:
my-hybrid-rgis the name of the virtual network.vnet-address-rangeis a list of address blocks reserved for this virtual network in CIDR notation.vnet-subnet-nameis the name of the subnet within the virtual network.subnet-address-rangeis a list of address blocks reserved for this subnet in CIDR notation.
Create an AKS cluster
Caution:Apigee does not supportGKE Sandbox orgVisor.In this step, you will create an AKS cluster.
- Open theMicrosoft® Azure Portal.
- ClickKubernetes services.
- Create a cluster with the following minimum configuration settings.Note: The configuration values shown below are for example purposes only. They are generally the default values and are suitable for testing purposes. It is up to you to decide how to configure your cluster to suit your requirements.
Recommended minimum storage: Review the AKS disk specifications and choose a storage volume size based on your IOPs and cost requirements.
You can see cluster configuration guidelines for Apigee hybrid inConfigure Cassandra for production andStorageClass configuration.
Tab Attribute Value Basics Subscription Your subscription name Resource group The resource group you created previously Region The region you specified previously. For example: (US) East US Kubernetes cluster name The name of the cluster. For example: my-hybrid-aks-clusterKubernetes version Choose version 1.16.x or a later version DNS name prefix The DNS name prefix. For example: my-hybrid-aks-cluster-dnsNode count 3 Node size DS3 StandardNote: Using virtual CPUs less than 4 may result in the failure of Cassandra pod creation due to not enough CPUs. Storage will be provisioned using Kubernetes stateful dynamic provisioner Scale Virtual nodes Disabled VM scale sets Enabled Authentication Enable RBAC Yes Service principal Default Networking HTTP application routing No Load balancer Standard Network configuration Azure CNINote: For more information about planning your networking setup seePlan IP addressing for your cluster in the Azure documentation. Virtual network The virtual network name. You can select the virtual network you created previously, or create a new one by clicking theCreate new link. For example: my-hybrid-rg-vnetCluster subnet Example: default (10.240.0.0/16)Kubernetes service address range The service address range. Be sure to use a non-competing address range. For example: 10.0.0.0/16Kubernetes DNS service IP address For example: 10.0.0.10Docker Bridge address For example: 172.17.0.1/16Monitoring Enable container monitoring Yes Log Analytics workspace For example: DefaultWorkspace-66f9d75c-2cd9-47dd-ad0f-c43d888e9cef-EUSTags None - ClickReview and Create.
- When the cluster creation completes, go to the next step.
Set cluster credentials
Add the Kubernetes cluster credentials for the newly created cluster using the following command if not already added:
az aks get-credentials --resource-group my-hybrid-rg --name my-hybrid-aks-cluster
Set the current context
Acontext is a group of access parameters. Each context contains a Kubernetes cluster, a user, and a namespace. The current context is the cluster that is currently the default forkubectl: allkubectl commands run against that cluster.
Make sure the current context is set to the cluster you just created using the following command:
kubectl config current-context my-hybrid-aks-cluster-context
If the context is not set to your cluster as expected, follow these steps to change it:
- List all the contexts to determine which is thecurrent context. In the following example, the context is set to the
my-hybrid-aks-ext01:kubectl config get-contextsCURRENT NAME CLUSTER AUTHINFO my-hybrid-aks-cluster my-hybrid-aks-cluster clusterUser_my-hybrid-rg2_myhybrid-aks-cluster* my-hybrid-aks-ext01 my-hybrid-aks-ext01 clusterUser_my-hybrid-rg_my-hybrid-aks-ext01
- If necessary, set the current context to the cluster you just created (the cluster into which you intend to install Apigee hybrid). Assuming the previous
get-contextsoutput, if the cluster name you created weremy-hybrid-aks-cluster, you would switch to themy-hybrid-aks-clustercontext, as follows:kubectl config use-contextmy-hybrid-aks-cluster
Where
my-hybrid-aks-clusteris the name of the cluster context to switch to.
Summary
You now have a Kubernetes cluster running in AKS. Your shell environment is set up, and you are ready to install the Apigee hybrid runtime software on your local machine.
1(NEXT) Step 2: Install cert-manager and ASM345Except 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-17 UTC.