Step 1: Create an AKS cluster

You are currently viewing version 1.1 of the Apigee hybrid documentation.This version is end of life. You should upgrade to a newer version. For more information, seeSupported versions.

This step explains how to set up your shell environment and create a Microsoft® Azure Kubernetes Service (AKS) cluster suitable for testing Apigee hybrid.

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 create clusters on AKS, see alsoQuickstart: Deploy an Azure Kubernetes Service cluster using the Azure CLI andQuickstart: Deploy an Azure Kubernetes Service (AKS) cluster using the Azure portal

Set up your terminal shell

Be sure you have the Azure CLI (az) andkubectl 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. For example:

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:

az network vnet create \ --name my-hybrid-rg-vnet \ --resource-group my-hybrid-rg \ --address-prefixes 120.38.1.0/24 \ --subnet-name my-hybrid-rg-vnet-subnet \ --subnet-prefix 120.38.1.0/26

Create an AKS cluster

Note:Apigee does not supportGKE Sandbox orgVisor.

In this step, you will create an AKS cluster.

  1. Open theMicrosoft® Azure Portal.
  2. ClickKubernetes services.
  3. Create a cluster with the following minimum configuration settings.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.
    TabAttributeValue
    BasicsSubscriptionYour subscription name
    Resource groupThe resource group you created previously
    RegionThe region you specified previously. For example: (US) East US
    Kubernetes cluster nameThe name of the cluster. For example:my-hybrid-aks-cluster
    Kubernetes versionChoose version 1.13 or a later version
    DNS name prefixThe DNS name prefix. For example:my-hybrid-aks-cluster-dns
    Node count3
    Node sizeDS3 StandardUsing 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
    ScaleVirtual nodesDisabled
    VM scale setsEnabled
    AuthenticationEnable RBACYes
    Service principalDefault
    NetworkingHTTP application routingNo
    Load balancerStandard
    Network configurationAdvanced
    Virtual networkThe 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-vnet
    Cluster subnetExample:default (10.240.0.0/16)
    Kubernetes service address rangeThe service address range. Be sure to use a non-competing address range. For example:10.0.0.0/16
    Kubernetes DNS service IP addressFor example:10.0.0.10
    Docker Bridge addressFor example:172.17.0.1/16
    MonitoringEnable container monitoringYes
    Log Analytics workspaceFor example:DefaultWorkspace-66f9d75c-2cd9-47dd-ad0f-c43d888e9cef-EUS
    TagsNone
  4. ClickReview and Create.
  5. 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. For example:

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. For example:

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:

  1. List all the contexts to determine which is thecurrent context. In the following example, the context is set to themy-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
  2. If necessary, set the current context to the cluster you just created (the cluster into which you intend to install Apigee hybrid). Assuming the previousget-contexts output, if the cluster name you created weremy-hybrid-aks-cluster, you would switch to themy-hybrid-aks-cluster context, as follows:
    kubectl config use-contextmy-hybrid-aks-cluster

    Wheremy-hybrid-aks-cluster is 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 apigeectl34

Except 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 2026-02-19 UTC.