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

Découvrez comment commencer Store 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 Store 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.
LICENSEAcceptation de la licence. Vous devez définir cette valeur sur accepter afin de confirmer avoir pris connaissance des termes des licences HCL Commerce.Variable d'environnement du conteneur. Elle peut être spécifiée dans le fichier de configuration values.yaml sous license.
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 Store 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.
ELASTICSEARCH_ENABLED Spécifiez si la solution de recherche basée sur Elasticsearch est utilisée pour l'environnement déployé.
Les valeurs admises sont :
  • true pour la solution de recherche basée sur Elasticsearch.
  • false pour la solution de recherche basée sur Solr.
La valeur par défaut est true.
Variable d'environnement du conteneur. Elle peut être spécifiée dans le fichier values.yaml sous common.searchEngine.
Note:
  • Lorsque la valeur de searchEngine est définie sur elastic, la variable d'environnement ELASTICSEARCH_ENABLED est définie sur true.
  • Lorsque la valeur de searchEngine est définie sur solr, la variable d'environnement ELASTICSEARCH_ENABLED est définie sur false.
La valeur par défaut est elastic.
HCL Commerce Version 9.1.14.0 or laterHYSTRIX_ENABLE Précisez si vous souhaitez activer Hystrix.

Pour plus d'informations sur Hystrix, voir Hystrix sur le Store server.

Les valeurs acceptées sont :
  • true pour activer Hystrix.
  • false pour laisser Hystrix désactivé.
La valeur par défaut est false.

Variables de configuration Vault obligatoires

Il s'agit des valeurs de clé Vault obligatoires que vous devez spécifier dans Vault pour configurer le Store 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

Variables de configuration Vault facultatives

Il s'agit des valeurs de clé Vault facultatives que vous pouvez spécifier dans Vault pour configurer le Store 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}/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}/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}/searchMasterHost (Pour l'environnement de création)
  • ${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/searchSlaveHost (Pour l'environnement opérationnel)
Le nom d'hôte Search server.

La valeur que vous définissez dans Vault dépend de la solution de recherche et du type d'environnement que vous configurez.

SEARCH_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/searchPort Le numéro de port Search server de la solution de recherche basée sur Solr. La valeur par défaut est 3738. SEARCH_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/searchScheme Le système Search server de la solution de recherche basée sur Solr. La valeur par défaut est https. SEARCH_SCHEME
HCL Commerce Version 9.1.12.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/queryHost Nom d'hôte du Search server pour la solution de recherche basée sur Elasticsearch. Spécifiez une valeur si vous souhaitez définir queryHost, au lieu d'utiliser la valeur par défaut. SEARCH_HOST
HCL Commerce Version 9.1.12.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/queryPort Numéro de port du Search server pour la solution de recherche basée sur Elasticsearch. Spécifiez une valeur si vous souhaitez définir queryPort, au lieu d'utiliser la valeur par défaut.

La valeur par défaut est 30901.

SEARCH_PORT
HCL Commerce Version 9.1.12.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/queryScheme Système du Search server pour la solution de recherche basée sur Elasticsearch. Spécifiez une valeur si vous souhaitez définir queryScheme, au lieu d'utiliser la valeur par défaut.

La valeur par défaut est https.

SEARCH_SCHEME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/crs-sslport Port de redirection sécurisé de la page de magasin distant. SSLPort
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/crs-nonsslport Port de redirection non sécurisé de la page de magasin distant. NONSSLPort
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/kafkaServers
Note: Les paramètres KAFKA SERVERS, ZOOKEEPER_SERVERS (supprimé à partir de la version 9.1.10.0), KAFKA_TOPIC_PREFIX, KAFKA_AUTHENTICATION_USERID et KAFKA_AUTHENTICATION_PASSWORD doivent être fournis ensemble.
Le serveur Kafka. Fonctionne avec ZOOKEEPER_SERVERS si vous souhaitez configurer le conteneur pour la validation du cache. KAFKA_SERVERS
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/zooKeeperServers
HCL Commerce Version 9.1.10.0 or laterNote: Supprimé de HCL Commerce et versions ultérieures.
Fonctionne avec KAFKA_SERVERS, si vous souhaitez configurer le conteneur pour la validation du cache. ZOOKEEPER_SERVERS
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/kafkaTopicPrefix KAFKA_TOPIC_PREFIX est utilisé pour composer le nom de la file d'attente pour l'invalidation du cache. KAFKA_TOPIC_PREFIX
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/kafkaAuthenticationUserId Nom d'utilisateur pour l'authentification Kafka. KAFKA_AUTHENTICATION_USERID
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/kafkaAuthenticationPassword Mot de passe de l'utilisateur pour l'authentification Kafka. KAFKA_AUTHENTICATION_PASSWORD
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/traceSpecification/crs-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/crs-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/crs-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
HCL Commerce Version 9.1.14.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/hystrixEnable Précisez si vous souhaitez activer Hystrix.

Pour plus d'informations sur Hystrix, voir Hystrix sur le Store server.

Les valeurs acceptées sont :
  • true pour activer Hystrix.
  • false pour laisser Hystrix désactivé.
La valeur par défaut est false.
HCL Commerce Version 9.1.14.0 or laterHYSTRIX_ENABLE