Azure Health Check (Enterprise Only)

Available in Rundeck Enterprise

Overview

The Azure Health Check plugin checks the status of Azure VMs. If the host is running the plugin will return a "healthy" status.

Preparation

To configure this plugin some information will be needed from the Azure system.

• Tenant ID
• Client ID
• Subscription ID
• Client Key

Configuration

Node Filter: This is the Node Filter used to determine which nodes the Health Check is run against in this project.

Label: Name to reference this instance of the HealthCheck

Tenant ID: This is the ID for the trust relationship between the Azure subscription and Azure Active Directory.

1. Sign in to the Azure portal (opens new window).
2. Select Azure Active Directory.
3. Select Properties.
4. Then, scroll down to the Tenant ID field. Your Tenant ID will be in the box.

Client ID: This is also referred to as the Application ID

1. Sign in to the Azure portal (opens new window).
2. Select Azure Active Directory in the left sidebar.
3. Click Enterprise Applications.
4. Click All Applications.
5. Select the application which you have created.
6. Click Properties.
7. Copy the Application ID .

Subscription ID:

1. Sign in to the Azure portal (opens new window).
2. Select Subscriptions in the left sidebar.
3. Select whichever subscription is needed.
4. Click on Overview.
5. Copy the Subscription ID.

Generating Azure Client Key

1. Sign in to the Azure portal (opens new window).
2. Select Azure Active Directory in the left sidebar.
3. Click App Registrations.
4. Select the application which you have created. (or create one)
5. Click on Certificates and Secrets.
6. Add a new Client Secret.
7. Provide a memorable Key Description and choose an Expiration.
8. Click Add.
9. Copy and store the key value in a temporary location

   Note: You won't be able to see this value again after you leave this page.

Add the Client Key Key to the Key Storage.

To use key storage path, you need to enable health-check access control by adding two configuration options in Configuration Management. rundeck.healthcheck.access.username=system and rundeck.healthcheck.access.role=system.

API Key Path: Select the Key Storage entry containing the key material.

It is also possible to save the certificate as a file on the local server.

Certificate Path: Path to certificate file on local Rundeck server. /home/rundeck/certs/file.name

Certificate Password: If the certificate is encrypted provide the password to unlock it.