Variables d’environnement

L’orchestrateur est capable de lire des variables d’environnement qui modifient son fonctionnement. Il peut s’agir de :

• Variables d’environnement spécifiques à l’orchestrateur (normalement préfixées par MAVERICS_)
• Variables d’environnement diverses qui peuvent être référencées dans le fichier de configuration lui-même

Variables d’environnement de l’orchestrateur

Les variables d’environnement suivantes sont disponibles pour définir la configuration de l’orchestrateur :

• MAVERICS_CONFIG : configure le chemin d’accès à un fichier de configuration local.
• MAVERICS_LICENSE : configure le chemin d’accès à un fichier de licence local.
• MAVERICS_SECRET_PROVIDER : établit une connexion à un fournisseur de secrets.
• MAVERICS_DEBUG_MODE : définit le logging au niveau de débogage.
• MAVERICS_HTTP_ADDRESS : l’interface et le port du récepteur HTTP.
• MAVERICS_TLS_SERVER_CERT_FILE : le chemin d’accès au certificat utilisé pour le récepteur HTTP
• MAVERICS_TLS_SERVER_KEY_FILE : le chemin d’accès à la clé correspondante au certificat de récepteur HTTP.
• MAVERICS_TLS_SERVER_WINDOWS_THUMBPRINT : l’empreinte du certificat utilisée pour rechercher le certificat du récepteur HTTP dans le magasin de certificats de Windows.
• MAVERICS_TLS_SERVER_WINDOWS_SUBJECT : l’objet du certificat utilisé pour rechercher le certificat de du récepteur HTTP dans le magasin de certificats de Windows.
• MAVERICS_RELOAD_CONFIG : une valeur booléenne permettant de configurer l’orchestrateur pour qu’il recherche les mises à jour de la configuration. La valeur par défaut est false.
• MAVERICS_POLLING_INTERVAL_SECONDS : la fréquence de recherche des mises à jour de configuration. Si elle n’est pas définie, la valeur par défaut est de 30 secondes.
• MAVERICS_GCP_CONFIG : permet de configurer une connexion à Google Cloud Storage pour la configuration à distance.
• MAVERICS_AWS_CONFIG : permet de configurer une connexion à AWS S3 pour le paramétrage de la configuration à distance.
• MAVERICS_AZURE_CONFIG : permet de configurer une connexion à Azure Blob pour le paramétrage de la configuration à distance.
• MAVERICS_GITLAB_CONFIG : permet de configurer une connexion à un référentiel GitLab pour le paramétrage de la configuration à distance.
• MAVERICS_GITHUB_CONFIG : permet de configurer une connexion à un référentiel GitHub pour le paramétrage de la configuration à distance.
• MAVERICS_USER : définit l’utilisateur qui exécutera un service maverics dans une installation linux. Si elle n’est pas définie, la valeur par défaut est maverics.
• MAVERICS_GROUP : définit le groupe qui exécutera un service maverics dans une installation linux. Si elle n’est pas définie, la valeur par défaut est maverics.
• HTTPS_PROXY, HTTP_PROXY, NO_PROXY : configure les proxys réseau que maverics utilisera.
• MAVERICS_BUNDLE_PUBLIC_KEY_FILE : le chemin d’accès au fichier de clé publique utilisé pour vérifier un paquet de configuration signé.

Les options de la ligne de commande de maverics remplacent les variables d’environnement, qui à leur tour remplacent les paramètres du fichier de configuration. L’ordre de priorité est le suivant :

1. options de ligne de commande (par exemple, -verbose pour la journalisation du niveau de débogage)
2. variables d’environnement (par exemple, MAVERICS_DEBUG_MODE=true)
3. paramètres du fichier de configuration (par exemple, logger.level: debug)

Variables d’environnement diverses

Maverics permet de référencer les variables d’environnement dans les fichiers de configuration. Cela permet de définir dynamiquement des variables spécifiques au déploiement.

Pour exprimer les variables d’environnement dans les fichiers de configuration, utilisez la syntaxe {{ env.VAR_NAME }}. Remarque : le préfixe d’espace de nommage env. est requis.

Exemples

Définition des variables d’environnement sur Linux

Pour définir une variable d’environnement lors de l’utilisation du RPM, utilisez le fichier maverics.env disponible par défaut dans le répertoire /etc/maverics. Veuillez noter que les variables doivent être délimitées par une nouvelle ligne et doit utiliser le format VARIABLE_NAME=VARIABLE_VALUE.

/etc/maverics/maverics.env

MAVERICS_HTTP_ADDRESS=":443"
MAVERICS_TLS_SERVER_CERT_FILE="/etc/maverics/example.com.crt"
MAVERICS_TLS_SERVER_KEY_FILE="/etc/maverics/example.com.key"

Définition des variables d’environnement sur Windows

Pour les variables d’environnement standard (variables préfixées par MAVERICS) telles que la verbosité du journal, il convient d’utiliser le MSI. Pour mettre à jour les paramètres existants, réinstallez simplement le MSI.

Définition des variables d’environnement sur les conteneurs

Comme sous Linux, un moyen simple de fournir des variables d’environnement au conteneur consiste à utiliser un fichier de variables d’environnement. Les variables doivent être délimitées par une nouvelle ligne et doivent utiliser le format VARIABLE_NAME=VARIABLE_VALUE. Lors du démarrage du conteneur, utilisez l’indicateur --env-file.

maverics.env

MAVERICS_DEBUG_MODE=true

Référencement des variables d’environnement personnalisées

L’exemple suivant représente une utilisation simple de la manière dont les variables d’environnement peuvent être exploitées. L’exemple suppose que AZURE_METADATA_URL, AZURE_ACS_URLet AZURE _ENTITY_ID sont définis en tant que variables d’environnement sur la machine hôte.

connectors:
  - name: azure
    type: azure
    authType: saml
    samlMetadataURL: '{{ env.AZURE_METADATA_URL }}'
    samlConsumerServiceURL: '{{ env.AZURE_ACS_URL }}'
    samlEntityID: '{{ env.AZURE_ENTITY_ID }}'