Aller au contenu principal

HashiCorp Vault Rest API

HashiCorp Vault est une solution de stockage sécurisé de données sensibles, tels que des identifiants d'accès aux applications du SI.

Le connecteur de supervision Centreon HashiCorp Vault s'appuie sur les APIs Rest fournies par la solution pour collecter les statuts et statistiques relatifs au fonctionnement de Vault.

Contenu du pack​

Modèles​

Le connecteur de supervision HashiCorp Vault Rest API apporte un modèle d'hôte :

  • App-HashiCorp-Vault-Restapi-custom

Le connecteur apporte les modèles de service suivants (classés selon le modèle d'hôte auquel ils sont rattachés) :

AliasModèle de serviceDescription
HealthApp-HashiCorp-Vault-Health-Restapi-customContrôle la santé de l'instance HashiCorp Vault
Raft-StorageApp-HashiCorp-Vault-Raft-Storage-Restapi-customContrôle le statut du stockage Raft de l'instance HashiCorp Vault

Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte App-HashiCorp-Vault-Restapi-custom est utilisé.

Métriques & statuts collectés​

Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service.

MétriqueUnité
vault_cluster#seal-statusN/A
vault_cluster#init-statusN/A

Prérequis​

Un accès à l'API Rest de l'instance Vault doit être possible depuis le collecteur Centreon devant superviser la ressource. Le compte utilisé pour s'authentifier doit faire partie d'une politique d'accès Vault donnant droits en lecture au path /sys/.

Il est possible de s'authentifier à l'API en utilisant les méthodes suivantes:

  • token (méthode par défaut)
  • userpass
  • azure
  • cert
  • github
  • ldap
  • okta
  • radius

Suivant la méthode choisie, les options requises devront être renseignées dans la Macro EXTRAOPTIONS de l'hôte. Se référer à l'aide du Plugin disponible en ligne de commandes (paramètre --help) pour plus d'informations. Les options nécessaires à chaque méthode d'authentification sont détaillées dans la documentation officielle de l'éditeur: https://www.vaultproject.io/api-docs/auth .

Installer le connecteur de supervision​

Pack​

  1. Si la plateforme est configurée avec une licence online, l'installation d'un paquet n'est pas requise pour voir apparaître le connecteur dans le menu Configuration > Gestionnaire de connecteurs de supervision. Au contraire, si la plateforme utilise une licence offline, installez le paquet sur le serveur central via la commande correspondant au gestionnaire de paquets associé à sa distribution :
dnf install centreon-pack-applications-hashicorp-vault-restapi
  1. Quel que soit le type de la licence (online ou offline), installez le connecteur HashiCorp Vault Rest API depuis l'interface web et le menu Configuration > Gestionnaire de connecteurs de supervision.

Plugin​

À partir de Centreon 22.04, il est possible de demander le déploiement automatique du plugin lors de l'utilisation d'un connecteur. Si cette fonctionnalité est activée, et que vous ne souhaitez pas découvrir des éléments pour la première fois, alors cette étape n'est pas requise.

Plus d'informations dans la section Installer le plugin.

Utilisez les commandes ci-dessous en fonction du gestionnaire de paquets de votre système d'exploitation :

dnf install centreon-plugin-Applications-HashiCorp-Vault-Restapi

Utiliser le connecteur de supervision​

Utiliser un modèle d'hôte issu du connecteur​

  1. Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes.
  2. Complétez les champs Nom, Alias & IP Address/DNS correspondant à votre ressource.
  3. Appliquez le modèle d'hôte App-HashiCorp-Vault-Restapi-custom. Une liste de macros apparaît. Les macros vous permettent de définir comment le connecteur se connectera à la ressource, ainsi que de personnaliser le comportement du connecteur.
  4. Renseignez les macros désirées. Attention, certaines macros sont obligatoires.
MacroDescriptionValeur par défautObligatoire
VAULTTOKENSpecify the Vault access token (only for the 'token' authentication method)X
VAULTAPIPROTOCOLSpecify https if needed (default: 'http')http
VAULTAPIPORTPort used (default: 8200)8200
VAULTAPIAUTHMETHODSpecify the Vault authentication method (default: 'token'). Can be: 'azure', 'cert', 'github', 'ldap', 'okta', 'radius', 'userpass', 'token' If different from 'token' the "--auth-settings" options must be settoken
VAULTAPIAUTHPATHSpecify an authentication path for 'userpass'. Is an optional setting. More information here: https://developer.hashicorp.com/vault/docs/auth/userpass#configuration
VAULTAPIVERSIONSpecify the Vault API version (default: 'v1')v1
EXTRAOPTIONSAny extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées ici.
  1. Déployez la configuration. L'hôte apparaît dans la liste des hôtes supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros.

Utiliser un modèle de service issu du connecteur​

  1. Si vous avez utilisé un modèle d'hôte et coché la case Créer aussi les services liés aux modèles, les services associés au modèle ont été créés automatiquement, avec les modèles de services correspondants. Sinon, créez les services désirés manuellement et appliquez-leur un modèle de service.
  2. Renseignez les macros désirées (par exemple, ajustez les seuils d'alerte). Les macros indiquées ci-dessous comme requises (Obligatoire) doivent être renseignées.
MacroDescriptionValeur par défautObligatoire
CRITICALINITSTATUSSet critical threshold for initialization status (default: '%{init} ne "initialized"')%{init} ne "initialized"
WARNINGINITSTATUSSet warning threshold for initialization status (default: none)
CRITICALSEALSTATUSSet critical threshold for seal status (default: '%{sealed} ne "unsealed"')%{sealed} ne "unsealed"
WARNINGSEALSTATUSSet warning threshold for seal status (default: none)
EXTRAOPTIONSAny extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici.--verbose
  1. Déployez la configuration. Le service apparaît dans la liste des services supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails du service : celle-ci montre les valeurs des macros.

Comment puis-je tester le plugin et que signifient les options des commandes ?​

Une fois le plugin installé, vous pouvez tester celui-ci directement en ligne de commande depuis votre collecteur Centreon en vous connectant avec l'utilisateur centreon-engine (su - centreon-engine). Vous pouvez tester que le connecteur arrive bien à superviser une ressource en utilisant une commande telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) :

/usr/lib/centreon/plugins/centreon_hashicorp_vault_restapi.pl \
    --plugin=apps::hashicorp::vault::restapi::plugin \
    --mode=raft-storage \
    --hostname='10.0.0.1' \
    --port='8200' \
    --proto='http' \
    --api-version='v1' \
    --auth-method='token' \
    --vault-token='xxxxx'  \
    --warning-commit-time='' \
    --critical-commit-time='' \
    --warning-spill-time='' \
    --critical-spill-time='' \
    --warning-rebalance-time='' \
    --critical-rebalance-time='' \
    --warning-write-time='' \
    --critical-write-time='' \
    --verbose

La commande devrait retourner un message de sortie similaire à :

OK: commit time : 35 All Bolt Databases are ok | 'commit-time'=35ms;;;0;'*boltdb*#vault.raftstorage.spilltime.seconds'=ms;;;0;'*boltdb*#vault.raftstorage.rebalance_time.seconds'=ms;;;0;'*boltdb*#vault.raftstorage.write_time.seconds'=ms;;;0;

Diagnostic des erreurs communes​

Rendez-vous sur la documentation dédiée des plugins basés sur HTTP/API.

Modes disponibles​

Dans la plupart des cas, un mode correspond à un modèle de service. Le mode est renseigné dans la commande d'exécution du connecteur. Dans l'interface de Centreon, il n'est pas nécessaire de les spécifier explicitement, leur utilisation est implicite dès lors que vous utilisez un modèle de service. En revanche, vous devrez spécifier le mode correspondant à ce modèle si vous voulez tester la commande d'exécution du connecteur dans votre terminal.

Tous les modes disponibles peuvent être affichés en ajoutant le paramètre --list-mode à la commande :

/usr/lib/centreon/plugins/centreon_hashicorp_vault_restapi.pl \
    --plugin=apps::hashicorp::vault::restapi::plugin \
    --list-mode

Le plugin apporte les modes suivants :

ModeModèle de service associé
health [code]App-HashiCorp-Vault-Health-Restapi-custom
raft-storage [code]App-HashiCorp-Vault-Raft-Storage-Restapi-custom

Options disponibles​

Options génériques​

Les options génériques sont listées ci-dessous :

OptionDescription
--modeDefine the mode in which you want the plugin to be executed (see--list-mode).
--dyn-modeSpecify a mode with the module's path (advanced).
--list-modeList all available modes.
--mode-versionCheck minimal version of mode. If not, unknown error.
--versionReturn the version of the plugin.
--custommodeWhen a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this option.
--list-custommodeList all available custom modes.
--multipleMultiple custom mode objects. This may be required by some specific modes (advanced).
--pass-managerDefine the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass.
--verboseDisplay extended status information (long output).
--debugDisplay debug messages.
--filter-perfdataFilter perfdata that match the regexp. Example: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data.
--filter-perfdata-advFilter perfdata based on a "if" condition using the following variables: label, value, unit, warning, critical, min, max. Variables must be written either %{variable} or %(variable). Example: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' will remove all metrics whose value equals 0 and that don't have a maximum value.
--explode-perfdata-maxCreate a new metric for each metric that comes with a maximum limit. The new metric will be named identically with a '_max' suffix). Example: it will split 'used_prct'=26.93%;0:80;0:90;0;100 into 'used_prct'=26.93%;0:80;0:90;0;100 'used_prct_max'=100%;;;;
--change-perfdata --extend-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[m ax]] Common examples: Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic_in,,percent()'
--extend-perfdata-groupAdd new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,namesofnewmetrics,calculation[,[ne wuom],[min],[max]] regex: regular expression namesofnewmetrics: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated newuom (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets_wrong,sum(packets_(discard |error)_(in|out))' Sum traffic by interface: --extend-perfdata-group='traffic_in_(.*),traffic_$1,sum(traf fic_(in|out)_$1)'
--change-short-output --change-long-outputModify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--change-exitReplace an exit code with one of your choice. Example: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state.
--range-perfdataRewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata.
--filter-uomMask the units when they don't match the given regular expression.
--opt-exitReplace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown.
--output-ignore-perfdataRemove all the metrics from the service. The service will still have a status and an output.
--output-ignore-labelRemove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...'
--output-xmlReturn the output in XML format (to send to an XML API).
--output-jsonReturn the output in JSON format (to send to a JSON API).
--output-openmetricsReturn the output in OpenMetrics format (to send to a tool expecting this format).
--output-fileWrite output in file (can be combined with json, xml and openmetrics options). E.g.: --output-file=/tmp/output.txt will write the output in /tmp/output.txt.
--disco-formatApplies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML).
--disco-showApplies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery.
--float-precisionDefine the float precision for thresholds (default: 8).
--source-encodingDefine the character encoding of the response sent by the monitored resource Default: 'UTF-8'. HashiCorp Vault Rest API
--hostnameHashiCorp Vault hostname.
--portPort used (default: 8200)
--protoSpecify https if needed (default: 'http')
--api-versionSpecify the Vault API version (default: 'v1')
--vault-tokenSpecify the Vault access token (only for the 'token' authentication method)
--auth-methodSpecify the Vault authentication method (default: 'token'). Can be: 'azure', 'cert', 'github', 'ldap', 'okta', 'radius', 'userpass', 'token' If different from 'token' the "--auth-settings" options must be set.
--auth-settingsSpecify the Vault authentication specific settings. Syntax: --auth-settings='\<setting>=\<value>'.Example for the 'userpass' method: --auth-method='userpass' --auth-settings='username=my_account' --auth-settings='password=my_password'
--auth-pathAuthentication path for 'userpass'. Is an optional setting. More information here: https://developer.hashicorp.com/vault/docs/auth/userpass#configu ration
--timeoutSet timeout in seconds (default: 10).
--http-peer-addrSet the address you want to connect to. Useful if hostname is only a vhost, to avoid IP resolution.
--proxyurlProxy URL. Example: http://my.proxy:3128
--proxypacProxy pac file (can be a URL or a local file).
--insecureAccept insecure SSL connections.
--http-backendPerl library to use for HTTP transactions. Possible values are: lwp (default) and curl.
--ssl-optSet SSL Options (--ssl-opt="SSL_version => TLSv1" --ssl-opt="SSL_verify_mode => SSL_VERIFY_NONE").
--curl-optSet CURL Options (--curl-opt="CURLOPT_SSL_VERIFYPEER => 0" --curl-opt="CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_1" ).
--memcachedMemcached server to use (only one server).
--redis-serverRedis server to use (only one server). Syntax: address[:port]
--redis-attributeSet Redis Options (--redis-attribute="cnx_timeout=5").
--redis-dbSet Redis database index.
--failback-fileFailback on a local file if Redis connection fails.
--memexpirationTime to keep data in seconds (default: 86400).
--statefile-dirDefine the cache directory (default: '/var/lib/centreon/centplugins').
--statefile-suffixDefine a suffix to customize the statefile name (default: '').
--statefile-concat-cwdIf used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux.
--statefile-formatDefine the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default).
--statefile-keyDefine the key to encrypt/decrypt the cache.
--statefile-cipherDefine the cipher algorithm to encrypt the cache (default: 'AES').

Options des modes​

Les options disponibles pour chaque modèle de services sont listées ci-dessous :

OptionDescription
--warning-seal-statusSet warning threshold for seal status (default: none).
--critical-seal-statusSet critical threshold for seal status (default: '%{sealed} ne "unsealed"').
--warning-init-statusSet warning threshold for initialization status (default: none).
--critical-init-statusSet critical threshold for initialization status (default: '%{init} ne "initialized"').

Pour un mode, la liste de toutes les options disponibles et leur signification peut être affichée en ajoutant le paramètre --help à la commande :

/usr/lib/centreon/plugins/centreon_hashicorp_vault_restapi.pl \
    --plugin=apps::hashicorp::vault::restapi::plugin \
    --mode=raft-storage \
    --help