Integrate Azure Monitor for Containers with GKE as an Azure Arc Connected Cluster

The following README will guide you on how to enable Azure Monitor for Containers for a Google Kubernetes Engine (GKE) cluster that is projected as an Azure Arc connected cluster.

In this guide, you will hook the GKE cluster to Azure Monitor by deploying the OMS agent on your Kubernetes cluster in order to start collecting telemetry.

Note: This guide assumes you already deployed a GKE cluster and connected it to Azure Arc. If you haven’t, this repository offers you a way to do so in an automated fashion using Terraform.

Prerequisites

  • Clone the Azure Arc Jumpstart repository

    git clone https://github.com/microsoft/azure_arc.git
    
  • Install or update Azure CLI to version 2.15.0 and above. Use the below command to check your current installed version.

    az --version
    
  • Create Azure service principal (SP)

    To be able to complete the scenario and its related automation, Azure service principal assigned with the “Contributor” role is required. To create it, login to your Azure account run the below command (this can also be done in Azure Cloud Shell).

    az login
    az ad sp create-for-rbac -n "<Unique SP Name>" --role contributor
    

    For example:

    az ad sp create-for-rbac -n "http://AzureArcK8s" --role contributor
    

    Output should look like this:

    {
    "appId": "XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "displayName": "AzureArcK8s",
    "name": "http://AzureArcK8s",
    "password": "XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "tenant": "XXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    }
    

    Note: The Jumpstart scenarios are designed with as much ease of use in-mind and adhering to security-related best practices whenever possible. It is optional but highly recommended to scope the service principal to a specific Azure subscription and resource group as well considering using a less privileged service principal account

Azure Monitor for Containers Integration

  • In order to keep your local environment clean and untouched, we will use Google Cloud Shell to run the gke_monitor_onboarding shell script against the GKE connected cluster.

  • Before integrating the cluster with Azure Monitor for Containers, click on the “Insights (preview)” blade for the connected Arc cluster to show how the cluster is not currently being monitored.

    Screenshot showing Azure Portal with Azure Arc-enabled Kubernetes resource

    Screenshot showing Azure Portal with Azure Arc-enabled Kubernetes resource Insights

  • Edit the environment variables in the script to match your environment parameters, upload it to the Cloud Shell environment and run it using the . ./gke_monitor_onboarding.sh command.

    Note: The extra dot is due to the shell script has an export function and needs to have the vars exported in the same shell session as the rest of the commands.

    Screenshot showing GKE cluster in GCP console

    Screenshot showing connection to GKE cluster in GCP console

    Screenshot showing GKE cluster in GCP console

    Screenshot showing GKE cluster in GCP console

    Screenshot showing GKE cluster in GCP console

    The script will:

    • Login to your Azure subscription using the SPN credentials
    • Download the OMS script
    • Retrieve cluster Azure resource ID as well as the cluster credentials (KUBECONFIG)
    • Execute the script which will create Azure Log Analytics workspace, deploy the OMS agent on the Kubernetes cluster and tag the cluster
    • Delete the downloaded script
  • Once the script will complete it’s run, you will have an Azure Arc connected cluster integrated with Azure Monitor for Containers. At the end of it’s run, the script generates URL for you to click on. This URL will open a new browser tab leading to the Azure Monitor for Containers Insights page.a

    Note: As the OMS start collecting telemetry from the cluster nodes and pods, it will take 5-10min for data to start show up in the Azure Portal.

    Screenshot showing script being run

    Screenshot showing deployment

  • Click the “Connected Clusters” tab and see the Azure Arc connected cluster was added. Now that your cluster is being monitored, navigate through the different tabs and sections and watch the monitoring telemetry for the cluster nodes and pods.

    Screenshot showing Azure Portal with connected cluster detail

    Screenshot showing Azure Portal with connected cluster detail

    Screenshot showing Azure Portal with connected cluster detail

    Screenshot showing Azure Portal with connected cluster detail

    Screenshot showing Azure Portal with connected cluster detail