Démarrage du Approval Server Docker container via l'extraction des paramètres à partir de Vault

Découvrez comment démarrer le conteneur Approval Server Docker container en spécifiant CONFIGURE_MODE=Vault.

Variables d'environnement obligatoires

Ce sont les paramètres obligatoires que vous devez spécifier pour configurer le conteneur afin de récupérer plus de paramètres à partir de Vault. Vous ne pouvez transmettre ces paramètres que sous forme de variables d'environnement de conteneur.

Nom de variable d'environnement Description
TENANT Nom du groupe contenant votre ensemble d'environnements. Par exemple, MonEntreprise.
ENVIRONMENT Nom de l'environnement. Par exemple, Non-production.
ENVTYPE Le type d'environnement. Les valeurs acceptées sont auth et live.
VAULT_TOKEN Jeton Vault à utiliser pour se connecter à Vault et demander une certification à partir de l'infrastructure à clé publique Vault.
VAULT_URL URL de Vault à utiliser pour se connecter à Vault et demander la certification à Vault PKI.

Valeurs de clé Vault obligatoires

Il s'agit des valeurs de clé Vault obligatoires que vous devez spécifier dans Vault pour configurer le conteneur Approval Server Docker container de manière à utiliser le mode de configuration Vault.

Nom de la clé Valeur
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/auth/toolingOrigin ou ${VAULT_URL}/${TENANT}/${ENVIRONMENT}/auth/toolingBaseUrl L’URL Web des outils d’authentification.
L'exemple de format est le suivant :
  • https://www.${TENANT}${ENVIRONMENT}auth.{{ include "external.domain" $ }}.
  • https://www.${TENANT}${ENVIRONMENT}auth.{{ include "external.domain" $ }}/tooling
Note:
  • Si toolingOrigin n'est pas spécifié et que toolingBaseUrl l'est, la valeur d'origine de l'outil sera dérivée de l'URL de base de l'outil (tous les caractères avant la première barre oblique).
  • Facultatif pour une charte Helm d'environnement SoFy.
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/live/toolingOrigin ou ${VAULT_URL}/${TENANT}/${ENVIRONMENT}/live/toolingBaseUrl URL Web de l'outil opérationnel.
L'exemple de format est le suivant :
  • https://www.${TENANT}${ENVIRONMENT}live.{{ include "external.domain" $ }}.
  • https://www.${TENANT}${ENVIRONMENT}live.{{ include "external.domain" $ }}/tooling
Note: Facultatif pour une charte Helm d'environnement SoFy.
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/spiUserPwd Mot de passe chiffré pour le spiuser. Pour plus d'informations, voir Définition du mot de passe spiuser dans vos images Docker.
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/sessionKeyEncrypt

La clé de session chiffrée.

Note: Ce paramètre était facultatif dans toutes les versions antérieures à HCL Commerce version 9.1.12.0.
HCL Commerce Version 9.1.14.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/authJWKS Jeu de clés Web JSON (JWKS) contenant la clé Web JSON (JWK) utilisée pour valider le jeton Web JSON (JWT) émis par leTransaction server.

Le Approval server a uniquement besoin des informations relatives à la clé publique du JWT. Dans l'éventualité où le JWKS inclurait également les informations de clé privée, le Approval server supprimera les informations de clé privée et configurera uniquement la clé publique pour une utilisation avec l'application.

Valeurs de clé Vault facultatives

Il s'agit des valeurs de clé Vault facultatives que vous pouvez spécifier dans Vault pour configurer le conteneur Approval Server Docker container lors d'une utilisation avec le mode de configuration Vault.

Nom de la clé Valeur
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/domainName Nom de domaine de service interne. La valeur par défaut est default.svc.cluster.local. Si l'environnement déployé se trouve sur un espace de noms spécial sur Kubernetes, le nom de domaine doit alors être .svc.cluster.local.
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/externalDomainName Le nom du domaine externe spécifie le nom de domaine externe Web du Store server, qui peut être reconnu par votre navigateur. Par exemple, dans le nom d'hôte store.demo4qaauth.hcl.com, hcl.com est le nom de domaine externe.
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/auth/txToolingHost Nom d'hôte Web de l'outil de création. La valeur par défaut est ${TENANT}${ENVIRONMENT}authts-web.$DOMAIN_NAME.
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/auth/txToolingPort Port Web de l'outil de création. La valeur par défaut est 8000.
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/live/txToolingHost Nom d'hôte Web de l'outil opérationnel. La valeur par défaut est ${TENANT}${ENVIRONMENT}livets-web.$DOMAIN_NAME.
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/live/txToolingPort Port Web de l'outil opérationnel. La valeur par défaut est 8000.
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/auth/reactStoreHost Nom d'hôte Web de Store server de création. La valeur par défaut est www.${TENANT}${ENVIRONMENT}auth${EXTERNAL_DOMAIN_NAME}.
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/auth/reactStorePort Port Web de Store server de création. La valeur par défaut est 443.
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/live/reactStoreHost Nom d'hôte Web de Store server opérationnel. La valeur par défaut est www.${TENANT}${ENVIRONMENT}live${EXTERNAL_DOMAIN_NAME}.
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/live/reactStorePort Port Web de Store server opérationnel. La valeur par défaut est 443.
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/spiUserName Nom de SPIUSER. La valeur par défaut est spiuser.
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/extraAllowedOrigins/approval Origines supplémentaires autorisées pour le Approval server.
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/adminUser Nom d'utilisateur de sécurité Spring.
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/adminPassword Mot de passe de l'utilisateur de sécurité Spring.
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/traceSpecification/approval-app Niveau de journalisation utilisé à des fins d'identification et de résolution des incidents.
Les niveaux de journalisation disponibles sont les suivants :
  • trace
  • debug
  • info
  • warn
  • error
  • fatal
Note:
  • Lorsqu'il est configuré en tant que trace, tous les messages s'affichent.
  • Lorsqu'il est configuré en tant que debug, tous les messages sont affichés, à l'exception de ceux étiquetés comme trace.
  • Lorsqu'il est configuré en tant que info, tous les messages de niveau info à fatal sont affichés.
Par défaut, les messages du journal du client API côté serveur s'affichent au niveau :
  • HCL Commerce Version 9.1.14.0info
  • HCL Commerce Version 9.1.13.0trace
.