Tanzu Community Edition

Documentation

Preparing to Deploy Clusters to Microsoft Azure

This topic explains how to prepare your environment before you deploy a management cluster on Microsoft Azure.

General Requirements

Register Tanzu Community Edition as a Microsoft Azure Client App

Tanzu Community Edition manages Microsoft Azure resources as a registered client application that accesses Azure through a service principal account. The following steps register your Tanzu Community Edition application with Microsoft Azure Active Directory, create its account, create a client secret for authenticating communications, and record information needed later to deploy a management cluster.

  1. Log in to the Azure Portal.

  2. 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 b39138ca-3cee-4b4a-a4d6-cd83d9dd62f0.

  3. Browse to Active Directory > App registrations and click + New registration.

  4. Enter a display name for the app, such as tce, and select who else can use it. You can leave the Redirect URI (optional) field blank.

  5. Click Register. This registers the application with an Microsoft Azure service principal account as described in How to: Use the portal to create an Azure AD application and service principal that can access resources in the Microsoft Azure documentation.

  6. An overview pane for the app appears. Record its Application (client) ID value, which is a GUID.

  7. From the Microsoft Azure Portal, 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.

  8. Select to Access control (IAM) and click Add a role assignment.

  9. In the Add role assignment pane

    • Select the Owner role
    • Leave Assign access to selection as “Azure AD user, group, or service principal”
    • Under Select enter the name of your app, tce. It appears underneath under Selected Members
  10. Click Save. A popup appears confirming that your app was added as an owner for your subscription.

  11. From the Microsoft Azure Portal > Azure Active Directory > App Registrations, select your tce app under Owned applications. The app overview pane opens.

  12. From Certificates & secrets > Client secrets click + New client secret.

  13. In the Add a client secret popup, enter a Description, choose an expiration period, and click Add.

  14. The new secret is listed with its generated value under Client Secrets. Record the value.

Accept the Base Image License

To run management cluster VMs on Microsoft Azure, accept the license for their base Kubernetes version and machine OS.

  1. Sign in to the Azure CLI as your tce client application.

    az login --service-principal --username AZURE_CLIENT_ID --password AZURE_CLIENT_SECRET --tenant AZURE_TENANT_ID
    

    Where AZURE_CLIENT_ID, AZURE_CLIENT_SECRET, and AZURE_TENANT_ID are your tce app’s client ID and secret and your tenant ID, as recorded in Register Tanzu Community Edition as an Azure Client App.

  2. Run the az vm image terms accept command, specifying the --plan and your Subscription ID.

    In Tanzu Community Edition 0.12.0, the default cluster image --plan value is k8s-1dot21dot5-ubuntu-2004, based on Kubernetes version 1.21 and the machine OS, Ubuntu 20.04. Run the following command:

    az vm image terms accept --publisher vmware-inc --offer tkg-capi --plan k8s-1dot21dot5-ubuntu-2004 --subscription AZURE_SUBSCRIPTION_ID
    

    Where AZURE_SUBSCRIPTION_ID is your Azure subscription ID.

You must repeat this to accept the base image license for every version of Kubernetes or OS that you want to use when you deploy clusters, and every time that you upgrade to a new version of Tanzu Community Edition.

Create an SSH Key Pair (Optional)

You will need OpenSSL installed locally, to create a new keypair or validate the download package thumbprint. See OpenSSL.

You deploy management clusters from a machine referred to as the bootstrap machine, using the Tanzu CLI. To connect to Microsoft 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.

  1. On your bootstrap machine, run the following ssh-keygen command.

    ssh-keygen -t rsa -b 4096 -C "email@example.com"
    
  2. At the prompt Enter file in which to save the key (/root/.ssh/id_rsa): press Enter to accept the default.

  3. Enter and repeat a password for the key pair.

  4. Add the private key to the SSH agent running on your machine, and enter the password you created in the previous step.

    ssh-add ~/.ssh/id_rsa
    
  5. Open the file .ssh/id_rsa.pub in a text editor so that you can easily copy and paste it when you deploy a management cluster.

Join us!

Our open community welcomes all users and contributors

Community