Azure Key Vault · Centreon documentation

Overview

Azure Key Vault is a cloud service for securely storing and accessing secrets. A secret is anything that you want to tightly control access to, such as API keys, passwords, certificates, or cryptographic keys. Key Vault service supports two types of containers: vaults and managed HSM pools. Vaults support storing software and HSM-backed keys, secrets, and certificates. Managed HSM pools only support HSM-backed keys.

The Centreon Plugin-Pack Azure Key Vault can rely on Azure API or Azure CLI to collect the metrics related to the Key Vault service.

Plugin Pack Assets

Monitored Objects

Azure Key Vault instances

Discovery rules

The Centreon Plugin-Pack Azure Key Vault includes a Host Discovery provider to automatically discover the Azure instances of a given subscription and add them to the Centreon configuration. This provider is named Microsoft Azure Key Vault:

This discovery feature is only compatible with the 'api' custom mode. 'azcli' is not supported yet.

More information about the Host Discovery module is available in the Centreon documentation: Host Discovery

Collected Metrics

ServiceAPI

Vault-Availability

Vault-Capacity

Metric name	Description	Unit
keyvault.serviceapi.hits.count	Total Service Api Hits	Count
keyvault.serviceapi.latency.milliseconds	Overall Service Api Latency	B
keyvault.serviceapi.results.count	Total Service Api Results	Count

Metric name	Description	Unit
keyvault.vault.availability.percentage	Overall Vault Availability	%

Metric name	Description	Unit
keyvault.vault.saturation.percentage	Overall Vault Saturation	%

Prerequisites

To get data from Azure Services, following methods are available: * Azure API ('api') * Azure CLI ('azcli')

Centreon recommends to use the API instead of the CLI for the following reasons: * API is much more efficient by avoiding CLI binary execution * API supports application authentication while CLI does not (yet)

Azure Monitor API

Azure AZ CLI

To use the 'api' custom mode, make sure to obtain the required information using the how-to below. Keep it safe until including it in a Host or Host Template definition.

Create an application in Azure Active Directory:
- Log in to your Azure account.
- Select Azure Active directory in the left sidebar.
- Click on App registrations.
- Click on + Add.
- Enter Centreon as the application name (or any name of your choice), select application type(api) and sign-on-url.
- Click on the Create button.
Get Subscription ID
- Log in to your Azure account.
- Select Subscriptions in the left sidebar.
- Select whichever subscription is needed.
- Click on Overview.
- Copy the Subscription ID.
Get Tenant ID
- Log in to your Azure account.
- Select Azure Active directory in the left sidebar.
- Click on Properties.
- Copy the directory ID.
Get Client ID
- Log in to your Azure account.
- Select Azure Active directory in the left sidebar.
- Click on Enterprise applications.
- Click on All applications.
- Select the application previously created.
- Click on Properties.
- Copy the Application ID.
Get Client secret
- Log in to your Azure account.
- Select Azure Active directory in the left sidebar.
- Click on App registrations.
- Select the application previously created.
- Click on All settings.
- Click on Keys.
- Enter the key description and select the duration.
- Click on Save.
- Copy and store the key value. You won't be able to retrieve it after you leave this page.

To use the 'azcli' custom mode, install the required packages on every Centreon poller expected to monitor Azure Resources using CLI:

The CLI needs at least Python version 2.7 (https://github.com/Azure/azure-cli/blob/dev/doc/install_linux_prerequisites.md).

On RPM-Based distributions, use the command below to install it using root or 'sudo':

sudo rpm --import https://packages.microsoft.com/keys/microsoft.asc
sudo echo -e "[azure-cli]\nname=Azure CLI\nbaseurl=https://packages.microsoft.com/yumrepos/azure-cli\nenabled=1\ngpgcheck=1\ngpgkey=https://packages.microsoft.com/keys/microsoft.asc" > /etc/yum.repos.d/azure-cli.repo
sudo yum install azure-cli

Then, use the centreon-engine account to obtain a token using command below:

su - centreon-engine
az login

The shell will output this message including an authentication code:

*To sign in, use a web browser to open the page https://microsoft.com/devicelogin* 
*and enter the code CWT4WQZAD to authenticate.*

Go to https://microsoft.com/devicelogin and enter the code.

Connect using a monitoring service account, as a result, the shell should prompt information below:

    [
      {
        "cloudName": "AzureCloud",
        "id": "0ef83f3a-d83e-2039-d930-309df93acd93d",
        "isDefault": true,
        "name": "N/A(tenant level account)",
        "state": "Enabled",
        "tenantId": "0ef83f3a-03cd-2039-d930-90fd39ecd048",
        "user": {
          "name": "email@mycompany.onmicrosoft.com",
          "type": "user"
        }
      }
    ]

Credentials are now stored locally in the .accessTokens.json file so the Plugin can use it.

Setup

Online IMP Licence & IT-100 Editions

Offline IMP License

Install the Centreon Plugin package on every Centreon poller expected to monitor Azure Key Vault resources:

yum install centreon-plugin-Cloud-Azure-Security-KeyVault-Api

On the Centreon Web interface, install the Azure Key Vault Centreon Plugin-Pack on the "Configuration > Plugin Packs > Manager" page

Install the Centreon Plugin package on every Centreon poller expected to monitor Azure Key Vault resources:

yum install centreon-plugin-Cloud-Azure-Security-KeyVault-Api

Install the Centreon Plugin-Pack RPM on the Centreon Central server:

yum install centreon-pack-cloud-azure-security-keyvault.noarch

On the Centreon Web interface, install the Azure Key Vault Centreon Plugin-Pack on the "Configuration > Plugin Packs > Manager" page

Configuration

Host

Log into Centreon and add a new Host through "Configuration > Hosts".
In the IP Address/FQDN field, set the following IP address: '127.0.0.1'.
Select the Cloud-Azure-Security-KeyVault-custom template to apply to the Host.
Once the template applied, some Macros marked as 'Mandatory' hereafter have to be configured. These mandatory Macros differ regarding the custom mode used:

Azure Monitor API

Azure AZ CLI

Mandatory	Nom	Description
X	AZURECUSTOMMODE	Custom mode 'api'
X	AZURESUBSCRIPTION	Subscription ID
X	AZURETENANT	Tenant ID
X	AZURECLIENTID	Client ID
X	AZURECLIENTSECRET	Client secret
X	AZURERESOURCE	Id of the Key Vault instance

Mandatory	Nom	Description
X	AZURECUSTOMMODE	Custom mode 'azcli'
X	AZURESUBSCRIPTION	Subscription ID
X	AZURERESOURCE	Id of the Key Vault instance

FAQ

How to check in the CLI that the configuration is OK and what are the main options for ?

Once the Plugin installed, log into your Centreon Poller CLI using the centreon-engine user account and test the Plugin by running the following command:

/usr/lib/centreon/plugins/centreon_azure_security_keyvault_api.pl \
    --plugin=cloud::azure::security::keyvault::plugin \
    --mode=vault-availability \
    --custommode=api \
    --subscription='xxxxxxxxx' \
    --tenant='xxxxxxxxx' \
    --client-id='xxxxxxxxx' \
    --client-secret='xxxxxxxxx' \
    --resource='KEY001ABCD' \
    --timeframe='900' \
    --interval='PT5M' \
    --aggregation='average' \
    --warning-vault-availability-percentage='100:' \
    --critical-vault-availability-percentage='50:'

Expected command output is shown below:

OK: Instance 'KEY001ABCD' Statistic 'average' Metrics Overall Vault Availability: 100.00% |
'KEY001ABCD~average#keyvault.vault.availability.percentage'=100.00%;100:;50:;0;100

The command above checks the availability of an Azure Key Vault instance using the 'api' custom-mode (--plugin=cloud::azure::security::keyvault::plugin --mode=vault-availability --custommode=api). This Key Vault is identified by its id (--resource='KEY001ABCD') and the authentication parameters to be used with the custom mode are specified in the options (--subscription='xxxxxxxxx' --tenant='xxxxxxx' --client-id='xxxxxxxx' --client-secret='xxxxxxxxxx').

The calculated metrics are an average (--aggregation='average') of values on a 900 secondes / 15 min period (--timeframe='900') with one sample per 5 minutes (--interval='PT5M').

This command would trigger a WARNING alarm if the availability of the Key Vault instance is reported as less then 100% (--warning-vault-availability-percentage) and a CRITICAL alarm if less than 50% (--critical-vault-availability-percentage='50:').

All the available options for a given mode can be displayed by adding the --help parameter to the command:

/usr/lib/centreon/plugins/centreon_azure_security_keyvault_api.pl \
    --plugin=cloud::azure::security::keyvault::plugin \
    --mode=datapath \
    --help

Troubleshooting

The Azure credentials have changed and the Plugin does not work anymore

The Plugin is using a cache file to keep connection information and avoid an authentication at each call. If some of the authentication parameters change, you must delete the cache file.

The cache file can be found within /var/lib/centreon/centplugins/ folder with a name similar to azure_api__.

`UNKNOWN: Login endpoint API returns error code 'ERROR_NAME' (add --debug option for detailed message)`

When I run my command I obtain the following error message: UNKNOWN: Login endpoint API returns error code 'ERROR_NAME' (add --debug option for detailed message).

It means that some parameters used to authenticate the API request are wrong. The 'ERROR_NAME' string gives some hints about where the problem stands.

As an example, if my Client ID or Client Secret are wrong, 'ERROR_DESC' value will be 'invalid_client'.

`UNKNOWN: 500 Can't connect to login.microsoftonline.com:443`

This error message means that the Centreon Plugin couldn't successfully connect to the Azure Login API. Check that no third party device (such as a firewall) is blocking the request. A proxy connection may also be necessary to connect to the API. This can be done by using this option in the command: --proxyurl='http://proxy.mycompany:8080'.

`UNKNOWN: No metrics. Check your options or use --zeroed option to set 0 on undefined values`

This command result means that Azure does not have any value for the requested period. This result can be overriden by adding the --zeroed option in the command. This will force a value of 0 when no metric has been collected and will prevent the UNKNOWN error message.