Démarrage du conteneur Query Docker via l'extraction des paramètres à partir de Vault

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

Variables d'environnement obligatoires

Il s'agit des variables d'environnement obligatoires que vous devez spécifier pour configurer le conteneur Docker Query afin de récupérer des paramètres supplémentaires de Vault.

Nom de variable d'environnement Description Commentaires
TENANT Nom du groupe contenant votre ensemble d'environnements. Par exemple, MonEntreprise. Variable d'environnement du conteneur. Elle peut être spécifiée dans le fichier de configuration values.yaml sous common.tenant.
ENVIRONMENT Nom de l'environnement. Par exemple, Non-production. Variable d'environnement du conteneur. Elle peut être spécifiée dans le fichier de configuration values.yaml sous common.environmentName.
ENVTYPE Le type d'environnement. Les valeurs acceptées sont auth et live. Variable d'environnement du conteneur. Elle peut être spécifiée dans le fichier de configuration values.yaml sous common.environmentType.
VAULT_TOKEN Jeton Vault à utiliser pour se connecter à Vault et demander une certification à partir de l'infrastructure à clé publique Vault. Variable d'environnement du conteneur. Elle peut être spécifiée dans le fichier de configuration values.yaml sous common.vaultToken.
VAULT_URL URL de Vault à utiliser pour se connecter à Vault et demander la certification à Vault PKI. Variable d'environnement du conteneur. Elle peut être spécifiée dans le fichier de configuration values.yaml sous common.vaultUrl.
CONFIGURE_MODE Mode configuration.
Les valeurs acceptées sont :
  • Vault pour la configuration de Vault.
  • EnvVariables pour la configuration des variables d'environnement.
Définissez cette valeur sur Vault pour utiliser la configuration Vault et les configurations présentes dans cette référence.
 Variable d'environnement du conteneur. Elle peut être spécifiée dans le fichier de configuration values.yaml sous common.configureMode.

Variables d'environnement facultatives

Il s'agit des variables d'environnement facultatives que vous pouvez spécifier pour configurer le conteneur Docker Query.

Tous les paramètres que vous spécifiez en tant que variables d'environnement de conteneur ont la priorité par rapport aux valeurs stockées dans Vault.

Nom de variable d'environnement Description Commentaires
EXPOSE_METRICS Spécifiez si vous souhaitez activer les métriques pour l'environnement.
Les valeurs acceptées sont :
  • true pour activé.
  • false pour désactivé.
La valeur par défaut est définie sur true.
 Variable d'environnement du conteneur. Elle peut être spécifiée dans le fichier de configuration values.yaml sous metrics.enabled.

Variables de configuration Vault obligatoires

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

Chemin Vault Description Variable d'environnement de référence
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/elasticSearchHost Spécifiez une valeur elasticSearchHost. ELASTICSEARCH_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/zookeeperHost Spécifiez une valeur si vous souhaitez définir une valeur zookeeperHost, au lieu d'utiliser la valeur par défaut. ZOOKEEPER_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/sessionKeyEncrypt
HCL Commerce Version 9.1.12.0 or laterNote: Désormais obligatoire, cette valeur était facultative avant HCL Commerce 9.1.12.0.
 Clé de session chiffrée à l'aide de la clé de chiffrement de clé. Clé de session créée lorsque vous ou un administrateur avez chargé le schéma de base de données HCL Commerce.
Important: Vous devez spécifier vos propres valeurs de clé de commerçant et de clé de chiffrement de clé pour la sécurité de votre installation HCL Commerce. N'utilisez pas les valeurs par défaut contenues dans les exemples de fichier de configuration et les exemples de documentation fournis.
 SESSION_KEY_ENCRYPT

Variables de configuration Vault facultatives

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

Chemin Vault Description Variable d'environnement de référence
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/domainName Spécifiez le nom de domaine du service interne. Si l'environnement déployé se trouve sur un espace de noms spécial sur Kubernetes, alors le nom de domaine doit être .svc.cluster.local. Si aucune valeur n'est spécifiée, la valeur par défaut est utilisée.

default.svc.cluster.local

 DOMAIN_NAME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/elasticSearchPort Spécifiez une valeur si vous souhaitez définir une valeur elasticSearchPort, au lieu d'utiliser la valeur par défaut. ELASTICSEARCH_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/elasticSearchScheme Spécifiez une valeur si vous souhaitez définir une valeur elasticSearchScheme, au lieu d'utiliser la valeur par défaut. ELASTICSEARCH_SCHEME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/zookeeperPort Spécifiez une valeur si vous souhaitez définir une valeur zookeeperPort, au lieu d'utiliser la valeur par défaut.

La valeur par défaut est 2181.

 ZOOKEEPER_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/zookeeperScheme Spécifiez une valeur si vous souhaitez définir une valeur zookeeperScheme au lieu d'utiliser la valeur par défaut.

La valeur par défaut est http.

 ZOOKEEPER_SCHEME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/txHost Nom d'hôte du Transaction server.

La valeur par défaut est app.

 TX_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/txPort Numéro de port du Transaction server.

La valeur par défaut est 5443.

 TX_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nlpEnableLanguageCode La fonction de code de langue pour le traitement du langage naturel (NLP). Spécifiez une liste séparée par des virgules des codes de langue pour le traitement du langage naturel. Par exemple, en,es. Dans cet exemple, le NLP est activé à la fois pour l'anglais et l'espagnol.
  • HCL Commerce Version 9.1.11.0 or laterPour HCL Commerce 9.1.11.0 et les versions ultérieures, il n’y a pas de valeur par défaut. Vous devez spécifier une valeur si vous souhaitez activer le NLP. Si vous ne définissez pas cette valeur ou si vous la laissez vide, le NLP reste désactivé.
  • Pour HCL Commerce versions 9.1.0.0 à 9.1.10.0, la valeur par défaut est définie sur en, ce qui active la fonctionnalité de NLP pour la langue anglaise.
 NLP_ENABLE_LANGUAGE_CODE
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nlpLemmatizationFeature Spécifiez si vous souhaitez ou non activer la fonctionnalité de lemmatisation pour le traitement du langage naturel.
Les valeurs acceptées sont :
  • true pour activer la fonctionnalité de lemmatisation.
  • false pour désactiver la fonctionnalité de lemmatisation.
Par défaut, la valeur est définie sur false.
 NLP_LEMMATIZATION_FEATURE
Deprecated feature${VAULT_URL}/${TENANT}/${ENVIRONMENT}/enableFeatureNlp
Note: fonctionnalité supprimée dans HCL Commerce 9.1.2.0 et versions ultérieures.
 Activer le traitement du langage naturel. Ceci est codé en dur sur false pour data-query. ENABLE_FEATURE_NLP
${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.
  • TOOLING_ORIGIN
  • TOOLING_BASE_URL
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/redisPasswordEncrypt Mot de passe Redis chiffré. REDIS_PASSWORD_ENCRYPT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/traceSpecification/search-query-app Si vous souhaitez modifier la spécification de trace pour Transaction server, spécifiez une valeur. TRACE_SPEC
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/healthCenterEnable/search-query-app Indiquez une valeur si vous souhaitez activer le Centre de santé.
Valeurs admises :
  • true pour activer le Centre de santé.
  • false pour ne pas activer le Centre De centre.
La valeur par défaut est false.
 HEALTH_CENTER_ENABLED
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/threadMonitorEnable/search-query-app Spécifiez une valeur si vous souhaitez activer Thread Monitor.
Valeurs admises :
  • true pour activer Thread Monitor.
  • false pour ne pas activer Thread Monitor.
La valeur par défaut est false.
 THREAD_MONITOR_ENABLED
HCL Commerce Version 9.1.6.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/enableJsonLogging Activez la journalisation JSON.
Les valeurs acceptées sont
  • true pour activer la journalisation JSON.
  • false pour désactiver la journalisation JSON.

La valeur par défaut est false.

 ENABLE_JSON_LOGGING