Deploy OneAgent on Azure VM Scale Set

DESK provides a VM Extension to install OneAgent on Azure VM Scale Set. This allows to leverage the native deployment automation features using Azure Resource Manager (ARM).

How the VM-Extension for OneAgent works

The extension doesn't include the OneAgent installer. Instead it uses the DESK REST API to download the latest version from the cluster, unless a OneAgent default version is configured.

Agent updates are provided automatically through the capabilities of OneAgent.

Prerequisites

To use the extension, you need the DESK Environment ID and API Token.

How to retrieve Environment ID and API Token

Environment ID

1. Login with your DESK account.

2. Select Deploy DESK from the navigation menu.

3. Click the Set up PaaS integration button. Your environment ID appears in the Environment ID text box.

4. Click Copy to copy the ID to the clipboard. You can do this at any time by revisiting this page.

API Token

The API token is used in combination with your environment ID to download OneAgent. Go to Deploy DESK > Set up PaaS integration to access the InstallerDownload token. For security reasons, it's recommended that you create a discrete token for each environment.

To generate a new token

1. Click the Generate new token button.

2. Type in a meaningful name for your token. A meaningful token name might be the name of the platform you want to monitor (for example, azure, cloud-foundry, or openshift). To view and manage your existing tokens, go to Settings -> Integration -> Platform as a Service.

3. Click Generate to create the token. The newly created token will appear in the list below.

4. Click Copy to copy the generated token to the clipboard. You can do this at any time by revisiting this page and clicking Show token next to the relevant PaaS token.

Additional configuration parameters

Server Url
If you are using DESK Managed or your cluster traffic should be routed through an Active Gate you need to configure the API endpoint used by the extension for downloading the OneAgent.

If you're using DESK Managed or your communication should be routed through a specific ActiveGate, you need to configure your custom communication endpoint.

The URL pattern for the API endpoint is as follows:

https://{Cluster-ActiveGate-IP-address-or-hostname}:9999/e/{your-environment-id}/api

Installation

Azure Resource Manager provides a consistent management layer to perform tasks through Azure PowerShell, Azure CLI, Azure portal, REST API, and client SDKs.

az vmss extension set
  --publisher desk.ruxit
  -n "<Extension-Type>"
  -g "<Resource-Group>"
  --vmss-name "<VMSS-Name>"
  --settings "{\"tenantId\":\"<Environment-ID>\",\"token\":\"<API-Token>\", \"server\":\"<Server-Url>\", \"enableLogAnalytics\":\"yes\", \"hostGroup\":\"<Host-Group>\"}"

--settings @'"{\"tenantId\":\"<Environment-ID>\",\"token\":\"<API-Token>\"}"'@

$vmss = Get-AzureRmVmss -ResourceGroupName "<Resource-Group>" -VMScaleSetName "<VMSS-Name>"

Add-AzureRmVmssExtension
  -VirtualMachineScaleSet $vmss
  -Name desk
  -Publisher desk.ruxit
  -Type "<Extension-Type>"
  -Settings @{ "tenantId"="<Environment-ID>"; "token"="<API Token>";"server"="<Server-Url>"; "enableLogAnalytics"="yes"; "hostGroup"="<Host-Group>"; }

Update-AzureRmVmss
  -VirtualMachineScaleSet $vmss
  -ResourceGroupName "<Resource-Group>"
  -Name "<VMSS-Name>"

{
  "name": "desk",
  "properties": {
    "publisher": "desk.ruxit",
    "type": "<Extension-Type>",
    "typeHandlerVersion": "<Extension-Version>",
    "autoUpgradeMinorVersion": true,
    "settings": {
        "tenantId": "<Environment-ID>",
        "token": "<API-Token>",
        "server": "<Server-Url>",
        "enableLogAnalytics": "yes",
        "hostGroup": "<Host-Group>"
    },
  }
}

{
  "type": "Microsoft.Compute/virtualMachineScaleSets",
  "sku": {...},
  "name": "<VMSS-Name>",
  "apiVersion": "2018-06-01",
  "location": "centralus",
  "properties": {
    "upgradePolicy": {...},
    "virtualMachineProfile": {
      "osProfile": {...},
      "storageProfile": {...},
      "networkProfile": {...},
      "extensionProfile": {
        "extensions": [
          {
            "name": "desk",
            "properties": {
              "publisher": "desk.ruxit",
              "type": "<Extension-Type>",
              "typeHandlerVersion": "<Extension-Version>",
              "autoUpgradeMinorVersion": true,
              "settings": {
                "tenantId": "<Environment-ID>",
                "token": "<API-Token>",
                "enableLogAnalytics": "yes"

              }
            }
          }
        ]
      }
    }
  }
}

"{...}" is used to minimize the example code for a better overview.

After OneAgent is installed, OneAgent immediately starts monitoring your virtual machine. You can check the deployment status within DESK.

VM-Extension Availability

• The DESK VM-Extension is available for Windows and Linux in all public Azure regions.
• Coming soon: Azure Sovereign Clouds such as Azure Government, Azure China as well as Azure Stack