This topic explains how to prepare Microsoft Azure for running Tanzu Kubernetes Grid.
If you are installing Tanzu Kubernetes Grid on Azure VMware Solution (AVS), you are installing to a vSphere environment. See Preparing Azure VMware Solution on Microsoft Azure in Prepare a vSphere Management as a Service Infrastructure to prepare your environment, and Deploy Management Clusters to vSphere to deploy management clusters.
prodplan (3 main nodes, 1 worker) 4 for
dev(1 main, one worker)
prodplan (3 main nodes, 3 worker); 4 for
dev(1 main, 1 worker)
Traffic is allowed between your local bootstrap machine and the image repositories listed in the management cluster Bill of Materials (BoM) file, over port 443, for TCP.*
~/.tkg/bom/and its name includes the Tanzu Kubernetes Grid version, for example
imageRepositoryvalues to find their CNAMEs, for example
registry.tkg.vmware.runrequires network access to
(Optional) A VNET with:
If you do not use an existing VNET, the installation process creates a new one.
The Azure CLI installed locally. See Install the Azure CLI in the Microsoft Azure documentation.
*Or see Deploying Tanzu Kubernetes Grid in an Internet-Restricted Environment for installing without external network access.
Tanzu Kubernetes Grid manages Azure resources as a registered application that accesses Azure via a service principal account. The following steps register your Tanzu Kubernetes Grid application with Azure Active Directory, create its service account, create a client secret for authenticating communications, and record information needed later to deploy a management cluster.
Log into the Azure Portal.
Record your Tenant ID by hovering over your account name at upper-right, or else browse to Azure Active Directory > <Your Azure Org> > Properties > Tenant ID. The value is a GUID, for example
Browse to Active Directory > App registrations and click + New registration.
Enter a display name for the app, such as
tkg, and select who else can use it. You can leave the Redirect URI (optional) field blank.
Click Register. This registers the app with Azure and also creates a service principal as described in How to: Use the portal to create an Azure AD application and service principal that can access resources in the Azure documentation.
An overview pane for the app appears. Record its Application (client) ID value, which is a GUID.
From the Azure Portal top level, browse to Subscriptions. At the bottom of the pane, select one of the subscriptions you have access to, and record its Subscription ID. Click the subscription listing to open its overview pane.
Select to Access control (IAM) and click Add a role assignment.
In the Add role assignment pane
tkg. It appears underneath under Selected Members
Click Save. A popup appears confirming that your app was added as an owner for your subscription.
From the Azure Portal > Azure Active Directory > App Registrations, select your
tkg app under Owned applications. The app overview pane opens.
From Certificates & secrets > Client secrets click + New client secret.
In the Add a client secret popup, enter a Description, choose an expiration period, and click Add.
Azure lists the new secret with its generated value under Client Secrets. Record the value.
To run management cluster VMs on Azure, accept the license for their base Kubernetes version and machine OS.
Sign in to the Azure CLI using the Client ID, Client Secret, and Tenant ID values recorded above:
az login --service-principal --username $AZURE_CLIENT_ID --password $AZURE_CLIENT_SECRET --tenant $AZURE_TENANT_ID
Record the management cluster image
--plan value, which is based on the Kubernetes version and machine OS:
az vm image terms accept command, specifying the
--plan and Subscription ID values recorded above:
az vm image terms accept --publisher vmware-inc --offer tkg-capi --plan PLAN --subscription SUBSCRIPTION-ID
Once you have accepted this license, you can skip this step in the future.
You deploy management clusters from a machine referred to as the bootstrap machine, using the Tanzu Kubernetes Grid CLI. To connect to Azure, the bootstrap machine must provide the public key part of an SSH key pair. If your bootstrap machine does not already have an SSH key pair, you can use a tool such as
ssh-keygen to generate one.
On your bootstrap machine, run the following
ssh-keygen -t rsa -b 4096 -C "firstname.lastname@example.org"
Enter file in which to save the key (/root/.ssh/id_rsa):press Enter to accept the default.
Add the private key to the SSH agent running on your machine, and enter the password you created in the previous step.
.ssh/id_rsa.pubin a text editor so that you can easily copy and paste it when you deploy a management cluster.
Your environment is now ready for you to deploy the management cluster to Azure.