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

Découvrez comment commencer Search server Docker container 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 Search server Docker container afin de récupérer des paramètres supplémentaires de Vault.
Nom de variable d'environnementDescriptionCommentaires
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.
SOLR_MASTER_SERVER_URLL'URL Vault de l'URL du serveur maître Solr.

Elle est obligatoire pour l'esclave Solr et le répéteur Solr.

Variable d'environnement du conteneur.
Elle est générée en fonction du contenu de values.yaml.
solr esclave : { common.tenant }{common.environmentName}}livesearch-app-repeater.{ Namespace }.svc.cluster.local:3738 répéteur solr : { common.tenant }{common.environmentName}}livesearch-app-master.{ Namespace }.svc.cluster.local:3738
  • SOLR_MASTER
  • SOLR_SLAVE
SOLR_MASTER et SOLR_SLAVE sont utilisés conjointement pour déterminer le type de nœud de recherche.
Pour configurer le conteneur Search server en tant que :
  • Nœud de recherche maître.
    • SOLR_MASTER=true
    • SOLR_SLAVE=false
  • Nœud de répéteur de recherche.
    • SOLR_MASTER=true
    • SOLR_SLAVE=true
  • Nœud de subordonné de recherche.
    • SOLR_MASTER=false
    • SOLR_SLAVE=true
SOLR_MASTER et SOLR_SLAVE sont gérés par le modèle de chart Helm.
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 Search server Docker container.

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.
SOLR_REPLICATION_POLLINTERVAL Intervalle d'interrogation de la réplication pour les serveurs subordonnés de recherche au sein de l'environnement opérationnel.
WORKAREA

Le chemin de l'index de recherche dans le Search server Docker container.

Par exemple, /search.

Variables de configuration Vault obligatoires

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

Chemin Vault Description Variable d'environnement de référence
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/spiUserName
HCL Commerce Version 9.1.7.0 or laterNote: Cette valeur est facultative à partir de HCL Commerce 9.1.7.0.
 Nom d'utilisateur de spiuser.

HCL Commerce Version 9.1.7.0 or laterSi la valeur n'est pas définie, alors spiuser est utilisé.

 SPIUSER_NAME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/spiUserPwd Mot de passe de l'utilisateur spiuser chiffré ASCII.

Pour définir le mot de passe dans vos conteneurs Docker personnalisés, voir Définition du mot de passe spiuser dans vos images Docker.

 SPIUSER_PWD
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/adminSpiUserPwd Mot de passe de l'utilisateur spiuser en texte en clair.

La valeur ADMIN_SPIUSER_PWD doit être la même que SPIUSER_PWD, mais conserve le texte normal.

Pour définir le mot de passe dans vos conteneurs Docker personnalisés, voir Définition du mot de passe spiuser dans vos images Docker.

 ADMIN_SPIUSER_PWD
${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}/${ENVTYPE}/dbHost Nom d'hôte de la base de données pour l'environnement.
Note: Cette valeur n'est obligatoire que dans l'environnement d'authentification pour WCPublishDataSource.
 DBHOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbPort Numéro de port de la base de données.
Note: Cette valeur n'est obligatoire que dans l'environnement d'authentification pour WCPublishDataSource.
 DBPORT
${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 Search server Docker container lors d'une utilisation avec le mode de configuration Vault.

Chemin Vault Description Variable d'environnement de référence
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbSSLEnable Indiquez si la connexion de base de données utilise SSL.
Valeurs admises :
  • true pour une connexion SSL.
  • false pour une connexion non chiffrée.
La valeur par défaut est false.
Note: Vous pouvez également spécifier les données d'identification de la source de données via la commande de démarrage si vous ne souhaitez pas récupérer les valeurs de la source de données à partir de Vault.
 DB_SSLENABLE
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbType Type de base de données.
Les valeurs admises sont :
  • db2 pour IBM Db2 Database.
  • oracle pour Oracle Database.
La valeur par défaut est db2.
 DBTYPE
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbXA Spécifiez si la fonction XA est activée pour la base de données.
Valeurs admises :
  • true pour activé.
  • false pour désactivé.
La valeur par défaut est false.
Note: Vous pouvez également spécifier les données d'identification de la source de données via la commande de démarrage si vous ne souhaitez pas récupérer les valeurs de la source de données à partir de Vault.
 DB_XA
${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}/${ENVTYPE}/xcHost Spécifiez une valeur si vous souhaitez définir un nom d'hôte pour le Customization server, au lieu d'utiliser la valeur par défaut. XC_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/xcPort Spécifiez une valeur si vous souhaitez définir un numéro de port pour le Customization server, au lieu d'utiliser la valeur par défaut. XC_PORT
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
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/traceSpecification/search-app Si vous souhaitez modifier la spécification de trace pour Search server, spécifiez une valeur. TRACE_SPEC
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/healthCenterEnable/search-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-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
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/redisPasswordEncrypt Mot de passe Redis chiffré. REDIS_PASSWORD_ENCRYPT