Deploy an Azure-based regional cluster

Caution

This feature is available starting from the Container Cloud release 2.11.0.

You can deploy an additional regional Azure-based cluster to create managed clusters of several provider types or with different configurations.

To deploy an Azure-based regional cluster:

  1. Log in to the node where you bootstrapped a management cluster.

  2. Prepare the Azure configuration for the new regional cluster:

    1. Create an Azure service principal. Skip this step to use an existing Azure service principal.

      1. Create a Microsoft Azure account.

      2. Install Azure CLI.

      3. Log in to the Azure CLI:

        az login
        
      4. List your Azure accounts:

        az account list -o table
        
      5. If more than one account exists, select the account dedicated for Container Cloud:

        az account set -s <subscriptionID>
        
      6. Create an Azure service principal:

        Caution

        The owner role is required for creation of role assignments.

        az ad sp create-for-rbac --role contributor
        

        Example of system response:

        {
           "appId": "0c87aM5a-e172-182b-a91a-a9b8d39ddbcd",
           "displayName": "azure-cli-2021-08-04-15-25-16",
           "name": "1359ac72-5794-494d-b787-1d7309b7f8bc",
           "password": "Q1jB2-7Uz6Cka7xos6vL-Ddb4BQx2vgMl",
           "tenant": "6d498697-7anvd-4172-a7v0-4e5b2e25f280"
        }
        
    2. Change the directory to kaas-bootstrap.

    3. Export the following parameter:

      export KAAS_AZURE_ENABLED=true
      
    4. In templates/azure/azure-config.yaml.template, modify the following parameters using credentials obtained in the previous steps or using credentials of an existing Azure service principal obtained from the subscription owner:

      • spec:subscriptionID is the subscription ID of your Azure account

      • spec:tenantID is the value of "tenant"

      • spec:clientID is the value of "appId"

      • spec:clientSecret:value is the value of "password"

      For example:

      spec:
        subscriptionID: b8bea78f-zf7s-s7vk-s8f0-642a6v7a39c1
        tenantID: 6d498697-7anvd-4172-a7v0-4e5b2e25f280
        clientID: 0c87aM5a-e172-182b-a91a-a9b8d39ddbcd
        clientSecret:
          value: Q1jB2-7Uz6Cka7xos6vL-Ddb4BQx2vgMl
      
    5. In templates/azure/cluster.yaml.template, modify the default configuration of the Azure cluster location. This is an Azure region that your subscription has quota for.

      To obtain the list of available locations, run:

      az account list-locations -o=table
      

      For example:

      providerSpec:
        value:
        ...
          location: southcentralus
      

      Also, modify other parameters as required.

  3. If you require Internet access to go through a proxy server, in bootstrap.env, add the following environment variables to bootstrap the regional cluster using proxy:

    • HTTP_PROXY

    • HTTPS_PROXY

    • NO_PROXY

    Example snippet:

    export HTTP_PROXY=http://proxy.example.com:3128
    export HTTPS_PROXY=http://user:pass@proxy.example.com:3128
    export NO_PROXY=172.18.10.0,registry.internal.lan
    

    The following variables formats are accepted:

    Proxy configuration data

    Variable

    Format

    • HTTP_PROXY

    • HTTPS_PROXY

    • http://proxy.example.com:port - for anonymous access

    • http://user:password@proxy.example.com:port - for restricted access

    • NO_PROXY

    Comma-separated list of IP addresses or domain names

    For the list of Mirantis resources and IP addresses to be accessible from the Container Cloud clusters, see Requirements for an Azure-based cluster.

  4. Optional. Configure the regional NTP server parameters to be applied to all machines of regional and managed clusters in the specified region.

    In templates/azure/cluster.yaml.template, add the ntp:servers section with the list of required servers names:

    spec:
      ...
      providerSpec:
        value:
          kaas:
          ...
            regional:
              - helmReleases:
                - name: azure-provider
                  values:
                    config:
                      lcm:
                        ...
                        ntp:
                          servers:
                          - 0.pool.ntp.org
                          ...
                provider: azure
                ...
    
  5. Export the following parameters:

    export KUBECONFIG=<pathToMgmtClusterKubeconfig>
    export REGIONAL_CLUSTER_NAME=<newRegionalClusterName>
    export REGION=<NewRegionName>
    

    Substitute the parameters enclosed in angle brackets with the corresponding values of your cluster.

    Caution

    The REGION and REGIONAL_CLUSTER_NAME parameters values must contain only lowercase alphanumeric characters, hyphens, or periods.

    Note

    If the bootstrap node for the regional cluster deployment is not the same where you bootstrapped the management cluster, also export SSH_KEY_NAME. It is required for the management cluster to create a publicKey Kubernetes CRD with the public part of your newly generated ssh_key for the regional cluster.

    export SSH_KEY_NAME=<newRegionalClusterSshKeyName>
    
  6. Run the regional cluster bootstrap script:

    ./bootstrap.sh deploy_regional
    

    Note

    When the bootstrap is complete, obtain and save in a secure location the kubeconfig-<regionalClusterName> file located in the same directory as the bootstrap script. This file contains the admin credentials for the regional cluster.

    If the bootstrap node for the regional cluster deployment is not the same where you bootstrapped the management cluster, a new regional ssh_key will be generated. Make sure to save this key in a secure location as well.

    The workflow of the regional cluster bootstrap script

    #

    Description

    1

    Prepare the bootstrap cluster for the new regional cluster.

    2

    Load the updated Container Cloud CRDs for Credentials, Cluster, and Machines with information about the new regional cluster to the management cluster.

    3

    Connect to each machine of the management cluster through SSH.

    4

    Wait for the Machines and Cluster objects of the new regional cluster to be ready on the management cluster.

    5

    Load the following objects to the new regional cluster: Secret with the management cluster kubeconfig and ClusterRole for the Container Cloud provider.

    6

    Forward the bootstrap cluster endpoint to helm-controller.

    7

    Wait for all CRDs to be available and verify the objects created using these CRDs.

    8

    Pivot the cluster API stack to the regional cluster.

    9

    Switch the LCM agent from the bootstrap cluster to the regional one.

    10

    Wait for the Container Cloud components to start on the regional cluster.

Now, you can proceed with deploying the managed clusters of supported provider types as described in Create and operate managed clusters.