Données d'environnement dans Vault
Vault est pris en charge pour stocker des paires clé-valeur sensibles pour la configuration Docker. Si vous souhaitez utiliser cette méthode de configuration d'environnement, définissez CONFIGURE_MODE sur Vault. Avec ce paramètre, les scripts de démarrage récupèrent des données liées à l'environnement à partir de Vault lorsque vous démarrez un conteneur Docker.
EnvironmentName (par exemple, Non-production) et EnvironmentType (par exemple, auth).
Note: Consul et toutes les configurations associées ont été supprimés de HCL Commerce versions 9.1.9.0 et ultérieures. Toutefois, le nom de fichier de la charte Helm de Vault fournie reste le même.Stockage de paires clé-valeur dans Vault
Pour configurer Vault, consultez le site Web de Vault. Lorsque vous avez un coffre prêt à l'emploi, vous pouvez effectuer les étapes suivantes pour stocker et récupérer des paires clé-valeur.- Créez un point de montage basé sur {Tenant}.Par exemple,
init_json='json_data={"type":"generic","description":"description","config":{"max_lease_ttl":"876000"}}' header="X-Vault-Token:vaultToken"curl -X POST -H $header -H "Content-Type:application/json" -d '{"type":"generic","description":"description","config":{"max_lease_ttl":"876000"}}' http://vaultIP:vaultPort/v1/sys/mounts/tenant - Stockez les données de paire clé-valeur à l'aide de la commande suivante.
Par exemple, pour stocker la valeur "mall" pour un nom de clé "dbName" sous le chemin MyCompany/Non-production/auth/dbName :curl -X POST -H "X-Vault-Token:vaultToken" -d '{"value":"value"}' http://vaultIP:vaultPort/v1/tenant/environmentName/enviromentType/targetKeycurl -X POST -H "X-Vault-Token:7f47efbb-b162-619b-0ced-448079d91b77" -d '{"value":"mall"}' http://myhostname.com:8200/v1/MyCompany/Non-production/auth/dbName
Extraction de paires clé-valeur dans Vault
Extrayez les données de paire clé-valeur à l'aide de la commande suivante.curl -X GET -H "X-Vault-Token:vaultToken" http://VaultIP:VaultPort/v1/tenant/environmentName/enviromentType/targetKey | jq -r .data.valueStructure de données de valeur clé dans Consul/Vault
Les tableaux suivants listent tous les chemins clé-valeur par défaut sur Consul/Vault.
Les valeurs EnvType par défaut sont auth et live. La seule exception concerne l'EnvType supplémentaire nommé data pour l’application search-query-app.
Vous pouvez ajouter vos chemins clé-valeur en fonction des exigences de votre entreprise et définir la logique personnalisée pour les récupérer.
- Configurations de déploiement de base
- Configurations de nom, de port, de schéma de sécurité et de certificat
- Configurations de base de données
- Search - Configurations
Configurations d'outils
Configurations de magasins, commandes et stocks
Nextjs Ruby store configuration- Configurations en matière de journalisation et d'intégrité
- Intégration et autres configurations diverses
HCL Digital Experience intégration
Journalisation Must-Gather
Intégration LDAP
Intégration IBM MQ
| Chemin Vault | Exigence | Description |
|---|---|---|
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/domainName
|
Facultatif | 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.
|
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/externalDomainName
|
Facultatif | Cette valeur spécifie le nom de domaine externe Web du magasin, 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. |
|
Facultatif |
Cette valeur spécifie le mappage du nom de magasin vers le nom de domaine. L'utilisation de cette valeur permet de mapper un magasin vers plusieurs noms de domaine. Le format utilisé est : Par exemple, |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/zookeeperHost
|
Obligatoire | Spécifiez une valeur si vous souhaitez définir une valeur zookeeperHost, au lieu d'utiliser la valeur par défaut. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/zookeeperPort
|
Facultatif | 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 |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/zookeeperScheme
|
Facultatif | 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 |
|
Obligatoire | Spécifiez le nom d'hôte Redis à qui NiFi se connectera pour les messages d'événement. |
|
Facultatif | Spécifiez le numéro de port Redis auquel NiFi se connectera pour les messages d'événements. La valeur par défaut est |
|
Facultatif | Le mot de passe chiffré du serveur Redis. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/kafkaServers
|
Facultatif | Spécifiez une valeur si vous souhaitez activer ZooKeeper et Kafka. Le format de cette paire clé-valeur est : |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/kafkaTopicPrefix
|
Facultatif | Spécifiez une valeur si vous souhaitez configurer ZooKeeper et Kafka. Si aucune valeur n'est spécifiée, la valeur par défaut suivante est appliquée :
|
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/kafkaTopicPrefix
|
Facultatif | ID utilisateur pour l'authentification Kafka. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/kafkaTopicPrefix
|
Facultatif | Mot de passe de l'utilisateur pour l'authentification Kafka. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/zooKeeperServers
Note: Obsolète et supprimé dans HCL Commerce 9.1.12.0. |
Facultatif Supprimé dans 9.1.12.0+ |
Spécifiez une valeur si vous souhaitez activer ZooKeeper et Kafka. Le format de cette paire clé-valeur est : |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/txnHost
|
Facultatif | Spécifiez une valeur si vous souhaitez définir txnHost, au lieu d'utiliser la valeur par défaut. Note: cette valeur est utilisée pour le Transaction server Docker container seulement. La valeur txHost est utilisée pour tous les autres conteneurs. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/txnPort
|
Facultatif | Spécifiez une valeur si vous souhaitez définir txnPort, au lieu d'utiliser la valeur par défaut. Note: cette valeur est utilisée pour le Transaction server Docker container seulement. La valeur txPort est utilisée pour tous les autres conteneurs. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/txHost
|
Facultatif | Spécifiez une valeur si vous souhaitez définir txHost, au lieu d'utiliser la valeur par défaut. Note: Cette valeur est utilisée pour tous les conteneurs autres que leTransaction server Docker container. Pour définir la valeur du Transaction server Docker container, utilisez la valeur txnHost. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/txPort
|
Facultatif | Spécifiez une valeur si vous souhaitez définir txPort, au lieu d'utiliser la valeur par défaut. Note: Cette valeur est utilisée pour tous les conteneurs autres que leTransaction server Docker container. Pour définir la valeur duTransaction server Docker container , utilisez la valeur txnPort. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/xcHost
|
Facultatif | 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. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/xcPort
|
Facultatif | 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. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/storeHost
|
Facultatif | Spécifiez une valeur si vous souhaitez en définir une pour l'hôte de magasin Store server Commerce Remote Store (CRS), au lieu d'utiliser la valeur par défaut. La valeur par défaut est le nom du service |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/storePort
|
Facultatif | Spécifiez une valeur si vous souhaitez en définir une pour le port de magasin Store server Commerce Remote Store (CRS), au lieu d'utiliser la valeur par défaut. La valeur par défaut est |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/previewPort
|
Spécifiez une valeur si vous souhaitez définir previewPort, au lieu d'utiliser la valeur par défaut. La valeur par défaut est |
|
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/storeWebHost
|
Facultatif | Spécifiez une valeur si vous souhaitez définir storeWebHost, au lieu d'utiliser la valeur par défaut. La valeur par défaut est store.${TENANT}${ENVIRONMENT}${ENVTYPE}${EXTERNAL_DOMAIN_NAME}. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/storeWebPort
|
Facultatif | Spécifiez une valeur si vous souhaitez définir storeWebPort, au lieu d'utiliser la valeur par défaut. La valeur par défaut est |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/reactStoreHost
|
Facultatif | Spécifiez une valeur si vous souhaitez définir reactStoreHost, au lieu d'utiliser la valeur par défaut. La valeur par défaut est www.${TENANT}${ENVIRONMENT}${ENVTYPE}${EXTERNAL_DOMAIN_NAME}. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/reactStorePort
|
Facultatif | Spécifiez une valeur si vous souhaitez définir reactStorePort, au lieu d'utiliser la valeur par défaut. La valeur par défaut est |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/reactStoreServiceHost
|
Facultatif | Spécifiez une valeur si vous souhaitez définir reactStoreServiceHost, au lieu d'utiliser la valeur par défaut. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/reactStoreServicePort
|
Facultatif | Spécifiez une valeur si vous souhaitez définir reactStoreServicePort, au lieu d'utiliser la valeur par défaut. La valeur par défaut est |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/reactStorePreviewHost
|
Facultatif | Spécifiez une valeur si vous souhaitez définir reactStorePreviewHost, au lieu d'utiliser la valeur par défaut. La valeur par défaut est store-preview.${TENANT}${ENVIRONMENT}${ENVTYPE}${EXTERNAL_DOMAIN_NAME. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/reactStorePreviewPort
|
Facultatif | Spécifiez une valeur si vous souhaitez définir reactStorePreviewPort, au lieu d'utiliser la valeur par défaut. La valeur par défaut est |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/crs-sslport
|
Facultatif | Indiquez si vous souhaitez définir le port de sécurité d'accès au magasin sur SSLPort. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/crs-nonsslport
|
Facultatif | Indiquez si vous souhaitez définir le port non sécurisé d'accès au magasin sur NONSSLPort. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/searchPort
|
Facultatif | Spécifiez une valeur si vous souhaitez définir searchPort, au lieu d'utiliser la valeur par défaut. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/searchScheme
|
Facultatif | Spécifiez une valeur si vous souhaitez définir searchScheme, au lieu d'utiliser la valeur par défaut. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/searchMasterHost
|
Facultatif | Nom d'hôte du Search server. Note: Ce paramètre n'est requis qu'avec l'environnement d'authentification de la solution de recherche basée sur Solr. La valeur par défaut correspond au nom du service principal de recherche solr. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/searchSlaveHost
|
Facultatif | Nom d'hôte du Search server. Note: Ce paramètre doit uniquement être défini dans l’environnement opérationnel. La valeur par défaut correspond au nom du service esclave de recherche solr. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/searchRepeaterHost
|
Facultatif | Nom d'hôte du Search server. Note: Ce paramètre doit uniquement être défini dans l’environnement opérationnel. La valeur par défaut correspond au nom du service de répéteur de recherche Solr. |
|
Facultatif | 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. |
|
Facultatif | 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 |
|
Facultatif | 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 |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nifiHost
|
Facultatif | Spécifiez une valeur si vous souhaitez définir une valeur nifiHost, au lieu d'utiliser la valeur par défaut. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nifiPort
|
Facultatif | Spécifiez une valeur si vous souhaitez définir une valeur nifiPort, au lieu d'utiliser la valeur par défaut. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nifiScheme
|
Facultatif | Spécifiez une valeur si vous souhaitez définir une valeur nifiScheme, au lieu d'utiliser la valeur par défaut. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nifiWebHttpPort
|
Facultatif | Spécifiez une valeur si vous souhaitez définir une valeur nifiWebHttpPort, au lieu d'utiliser la valeur par défaut. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/registryHost
|
Facultatif | Spécifiez une valeur si vous souhaitez définir une valeur RegistryHost, au lieu d'utiliser la valeur par défaut. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/registryPort
|
Facultatif | Spécifiez une valeur si vous souhaitez définir une valeur RegistryPort, au lieu d'utiliser la valeur par défaut. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/registryScheme
|
Facultatif | Spécifiez une valeur si vous souhaitez définir une valeur RegistryScheme, au lieu d'utiliser la valeur par défaut. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/queryHost
|
Facultatif Supprimé dans 9.1.12.0+ |
Spécifiez une valeur si vous souhaitez définir une valeur queryHost, au lieu d'utiliser la valeur par défaut. Note: Cette paire de clés a été remplacée par queryHost à partir de HCL Commerce 9.1.12.0 et dans toutes les versions ultérieures. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/queryPort
|
Facultatif Supprimé dans 9.1.12.0+ |
Spécifiez une valeur si vous souhaitez définir une valeur queryPort, au lieu d'utiliser la valeur par défaut. Note: Cette paire de clés a été remplacée par queryPort à partir de HCL Commerce 9.1.12.0 et dans toutes les versions ultérieures. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/queryScheme
|
Facultatif Supprimé dans 9.1.12.0+ |
Spécifiez une valeur si vous souhaitez définir une valeur queryScheme, au lieu d'utiliser la valeur par défaut. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/ingestHost
|
Facultatif | Spécifiez une valeur si vous souhaitez définir une valeur ingestHost, au lieu d'utiliser la valeur par défaut. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/ingestPort
|
Facultatif | Spécifiez une valeur si vous souhaitez définir une valeur ingestPort, au lieu d'utiliser la valeur par défaut. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/ingestScheme
|
Facultatif | Spécifiez une valeur si vous souhaitez définir une valeur ingestScheme, au lieu d'utiliser la valeur par défaut. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/elasticSearchHost
Note: Obligatoire lors de l'utilisation de la solution de recherche basée sur Elasticsearch (ELASTICSEARCH_ENABLED est défini sur true).
|
Facultatif | Spécifiez une valeur elasticSearchHost. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/elasticSearchPort
|
Facultatif | Spécifiez une valeur si vous souhaitez définir une valeur elasticSearchPort, au lieu d'utiliser la valeur par défaut. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/elasticSearchScheme
|
Facultatif | Spécifiez une valeur si vous souhaitez définir une valeur elasticSearchScheme, au lieu d'utiliser la valeur par défaut. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/toolingBaseUrl
|
Facultatif | Cette valeur est utilisée par Management Center pour charger l'application d'outils à page unique (SPA) à partir du serveur Web d'outils.
Note: Si vous utilisez le magasin sans tête Sapphire B2B et que vous devez lancer les outils en magasin pour approbation, il est nécessaire de configurer l'entrée afin que le serveur Web d'outils puisse être atteint via le domaine du magasin. Par exemple, www.mycompany.com/tooling. Une fois l'entrée activée, vous devez configurer toolingBaseUrl pour utiliser le domaine de magasin. |
|
Facultatif | URL de base de Approval server utilisée par le Tooling Web Docker container. Format de l'URL de base d'approbation https://cmc-domain:port Par exemple, https://cmc.mycompanyauth.com:443. Si cette valeur n'est pas spécifiée, l'URL de base de Approval server est obtenue à partir de la racine de Tooling, c'est-à-dire tous les caractères avant la première barre oblique. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/certs/CertName
|
Facultatif | Indiquez des enregistrements de certificats tiers.
|
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/certsBundle
|
Facultatif |
Spécifiez les enregistrements de certificats tiers.
|
|
Facultatif | Indiquez des noms d'hôte sur liste blanche pour un nom de module associé. Les noms d'hôte sont délimités par une virgule, tandis que les modules sont délimités par un point-virgule.
|
|
Facultatif | Indiquez des noms de domaine sur liste blanche pour un nom de module associé. Les noms de domaine sont délimités par une virgule, tandis que les modules sont délimités par un point-virgule.
|
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/authJWKS
|
Obligatoire | Spécifiez une valeur pour définir le jeu de clés Web JSON (JWKS) et la clé ID sur le Transaction server. Elle est utilisée pour signer et valider le jeton Web JSON (JWT). Pour générer un JWKS, voir Utilitaire generateJWKS. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/spiUserName
|
|
Nom d'utilisateur de spiuser.
|
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/spiUserPwd
|
Obligatoire | 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. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/adminSpiUserPwd
|
Obligatoire | 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. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/merchantKeyEncrypted
|
Obligatoire | Clé de commerçant chiffrée à l'aide de la clé de chiffrement de clé. Clé de marchand créée lorsque vous ou un administrateur avez chargé le schéma de base de données HCL Commerce. Pour plus d'informations, voir :
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. |
|
Facultatif | La clé en texte brut utilisée pour chiffrer la clé de commerçant. La clé de chiffrement de clé doit comporter 32 caractères. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/sessionKeyEncrypt
|
|
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. |
| Chemin Vault | Exigence | Description |
|---|---|---|
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/jdbcUrl
|
Facultatif | Spécifiez l'URL de connexion à la base de données. L'URL est construite selon le type de base de données et l'activation ou non de SSL. ![]()
![]()
|
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/jdbcDriver
|
Facultatif |
Spécifiez une valeur si vous souhaitez modifier l'emplacement du pilote de base de données par défaut pour NiFi. Les valeurs par défaut sont les suivantes :
|
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/jdbcDriverClass
|
Facultatif |
Spécifiez une valeur si vous souhaitez modifier la classe du pilote de base de données par défaut pour NiFi. Les valeurs par défaut sont les suivantes :
|
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbSSLEnable
|
Facultatif | Indiquez si la connexion de base de données utilise SSL. Valeurs admises :
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. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbHost
|
Obligatoire | 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. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbName
|
Obligatoire | Nom de la base de données. Note: Cette valeur n'est obligatoire que dans l'environnement d'authentification pour WCPublishDataSource. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbPort
|
Obligatoire | Numéro de port de la base de données. Note: Cette valeur n'est obligatoire que dans l'environnement d'authentification pour WCPublishDataSource. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbUser
|
Obligatoire | Nom d'utilisateur de la base de données HCL Commerce. Note: Cette valeur n'est obligatoire que dans l'environnement d'authentification pour WCPublishDataSource. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbPassword
|
Obligatoire | Mot de passe utilisateur de la base de données de HCL Commerce. Note: Cette valeur n'est obligatoire que dans l'environnement d'authentification pour WCPublishDataSource. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbPassEncrypt
|
Obligatoire | Mot de passe de l'utilisateur de base de données HCL Commerce chiffré. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbaUser
|
Obligatoire | Nom d'utilisateur administrateur de base de données. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbaPassEncrypt
|
Obligatoire | Mot de passe de l'administrateur de base de données chiffré. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbType
|
Facultatif | Type de base de données. Les valeurs admises sont :
|
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbSchema
|
Facultatif | Schéma de la base de données. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbXA
|
Facultatif | Spécifiez si la fonction XA est activée pour la base de données. Valeurs admises :
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. |
| Chemin Vault | Exigence | Description |
|---|---|---|
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/elasticSearchEnabled
|
Obligatoire | Spécifiez si l'environnement utilise la recherche basée sur Elasticsearch ou la recherche basée sur Solr. Valeurs admises :
|
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/searchQueryBaseUrl
|
Facultatif | Spécifiez le serveur Search Query à utiliser par Tooling. Le format de l'URL de base Search Query est https://query-domain:port. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/searchDataQueryBaseUrl
|
Facultatif | Spécifiez le serveur Search Data Query à utiliser par Tooling. Le format de l'URL de base Search Data Query est https://data-query-domain:port. |
|
Facultatif | Spécifiez une liste séparée par des virgules supplémentaire de noms de packages de Java que le service de requête doit examiner pour traitement. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/enableFeatureNlp
|
Facultatif | Spécifiez une valeur si vous souhaitez définir la fonctionnalité de traitement du langage naturel. Note: Cette fonction requiert la solution de recherche basée sur Elasticsearch. Valeurs admises :
Note: Cette fonction est obsolète dans HCL Commerce 9.1.2.0. Le NLP est désormais spécifié à l'aide de nlpEnableLanguageCode. |
|
Facultatif | 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.
|
|
Facultatif | Indiquez si la fonctionnalité de lemmatisation doit être activée ou non pour le traitement du langage naturel. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nifiClusterIsNode
|
Facultatif | Indiquez si l'installation NiFi est autonome. Valeurs admises :
false. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nifiClusterNodeProtocalPort
|
Facultatif | Spécifiez une valeur pour le port du nœud du cluster NiFi. La valeur par défaut est 8082. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nifiElectionMaxWait
|
Facultatif | Spécifiez une valeur si vous le souhaitez pour définir le temps d'attente maximal pour le service de nœud d'élection NiFi. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nifiJvmHeapInit
|
Facultatif | Spécifiez une valeur si vous souhaitez définir une valeur nifiJvmHeapInit, au lieu d'utiliser la valeur par défaut. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nifiJvmHeapMax
|
Facultatif | Spécifiez une valeur pour la taille maximale du segment JVM pour NiFi. La valeur par défaut est 4096m. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/elasticSearchShardCount
|
Facultatif | Spécifiez le nombre de partitions aux fins du stockage des index de cet environnement, au sein du service Elasticsearch. La valeur par défaut est 1. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/elasticSearchReplicaCount
|
Facultatif | Spécifiez le nombre de réplicas pour les index de cet environnement, au sein du service Elasticsearch. La valeur par défaut est 0. |
Configuration d'outils
| Chemin Vault | Exigence | Description |
|---|---|---|
|
Obligatoire |
Management Center for HCL Commerce 9.1.12.0 et toutes les versions supérieures établissent désormais des rapports sur les données d'analyse des utilisateurs professionnels et les transmettent à HCL. Ces informations aident HCL à développer de nouvelles fonctionnalités et à améliorer les outils existants à usage des utilisateurs professionnels.
Valeurs admises :
La valeur par défaut est yes. Si cette option est activée, le paramètre deploymentType doit être spécifié. |
|
Obligatoire | Type de déploiement. Cette valeur est requise lorsque la valeur allowTelemetry est yes, mais elle est ignorée si la valeur allowTelemetry est définie sur no. Valeurs admises :
Important: Au démarrage du Tooling Web Docker container dans les versions 9.1.12.0 à 9.1.14.0, vous devez définir le type de déploiement de conteneur. A défaut, le conteneur ne pourra pas démarrer. Assurez-vous de définir le type de déploiement via la variable d'environnement du conteneur DEPLOYMENT_TYPE, ou dans Vault à l'aide du chemin suivant : ${VAULT_URL}/${TENANT}/${ENVIRONMENT}/deploymentType. Les valeurs acceptées sont development, staging ou production. |
Configuration de magasins, commandes et stocks
| Chemin Vault | Exigence | Description |
|---|---|---|
|
Facultatif | Spécifiez une liste de sources de stratégie de sécurité de contenu pour le conteneur Store-Web.Par exemple, |
|
Facultatif | Spécifiez une liste de sources de stratégie de sécurité de contenu pour le Web server Docker container (ts-web).Par exemple, |
|
Facultatif | Précisez si vous souhaitez activer Hystrix. Pour plus d'informations sur Hystrix, voir Hystrix sur le Store server. Les valeurs acceptées sont :
|
|
Facultatif | Activez ou désactivez le programme d'écoute d'événement de commentaire de commande automatique. Par défaut, cette valeur est définie sur false. |
|
Facultatif | Activez ou désactivez l'utilisation d'un point-virgule ";" comme délimiteur de fichier CSV de la place de marché. Par défaut, cette valeur est définie sur false. |
|
Facultatif | Dans un système de stock non-ATP avec le paramètre noCheck défini pour un stock catentry (valeur de 2 dans la base de données), l'API renvoie 1.0 comme quantité. Pour afficher la quantité réelle, définissez cette valeur sur true. Par défaut, cette valeur est définie sur false. |
Nextjs Ruby store configuration
| Chemin Vault | Exigence | Description |
|---|---|---|
|
Facultatif | Définit le nombre maximal de processus Node simultanés pouvant être exécutés par l'API du cluster Node.js. Note: La valeur spécifiée dans Vault est prioritaire sur les autres méthodes de configuration. |
|
Obligatoire | Clé d'API Google Maps utilisée par le magasin React. |
|
Facultatif | Niveau de journalisation utilisé à des fins d'identification et de résolution des incidents. Les niveaux de journalisation disponibles sont les suivants :
Note:
|
|
Facultatif | Définit la chaîne de masquage utilisée dans les journaux pour masquer des informations sensibles, par exemple des messages avec du contenu lié au RGPD. L'ensemble de valeurs à masquer est identifié par leurs clés dans le fichier de configuration logging/core/redactionKeys.ts. Pour plus d'informations, voir https://getpino.io/#/docs/redaction. La valeur par défaut indiquée dans le modèle est **GDPR COMPLIANT**. Si la valeur est vide ou non définie, la chaîne de censure utilisée est ****. |
| Chemin Vault | Exigence | Description |
|---|---|---|
|
Activez la journalisation JSON. Les valeurs acceptées sont
La valeur par défaut est false. |
|
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/jdbcMonitorEnable/ts-app
|
Facultatif | Spécifiez s'il faut ou non activer le moniteur JDBC. Valeurs admises :
La valeur par défaut est false. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/healthCenterEnable/ts-app
|
Facultatif | Indiquez une valeur si vous souhaitez activer le Centre de santé. Valeurs admises :
false. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/healthCenterEnable/search-app
|
Facultatif | Indiquez une valeur si vous souhaitez activer le Centre de santé. Valeurs admises :
false. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/healthCenterEnable/xc-app
|
Facultatif | Indiquez une valeur si vous souhaitez activer le Centre de santé. Valeurs admises :
false. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/healthCenterEnable/crs-app
|
Facultatif | Indiquez une valeur si vous souhaitez activer le Centre de santé. Valeurs admises :
false. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/healthCenterEnable/search-query-app
|
Facultatif | Indiquez une valeur si vous souhaitez activer le Centre de santé. Valeurs admises :
false. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/healthCenterEnable/search-ingest-app
|
Facultatif | Indiquez une valeur si vous souhaitez activer le Centre de santé. Valeurs admises :
false. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/traceSpecification/ts-app
|
Facultatif | Si vous souhaitez modifier la spécification de trace pour Transaction server, spécifiez une valeur. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/traceSpecification/search-app
|
Facultatif | Si vous souhaitez modifier la spécification de trace pour Search server, spécifiez une valeur. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/traceSpecification/crs-app
|
Facultatif | Si vous souhaitez modifier la spécification de trace pour Store server, spécifiez une valeur. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/traceSpecification/xc-app
|
Facultatif | Si vous souhaitez modifier la spécification de trace pour Customization server, spécifiez une valeur. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/traceSpecification/search-ingest-app
|
Facultatif | Si vous souhaitez modifier la spécification de trace pour le serveur Ingest, spécifiez une valeur. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/traceSpecification/search-query-app
|
Facultatif | Si vous souhaitez modifier la spécification de trace pour le serveur Query, spécifiez une valeur. |
|
Facultatif | Si vous souhaitez modifier la spécification de trace pour l'application Gestionnaire de cache, spécifiez une valeur. |
|
Facultatif | Si vous souhaitez modifier la spécification de trace pour l'application Must-Gather, spécifiez une valeur. |
|
Facultatif | Définit les méthodes d'API qui sont consignées. Les fonctions peuvent être filtrées à l'aide d'une liste séparée par des virgules. Cette spécification affiche uniquement les messages de journal provenant des fonctions findProducts et getV2CategoryResources.Par défaut, cette valeur reste vide. Cela implique que toutes les fonctions sont consignées. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/threadMonitorEnable/ts-app
|
Facultatif | Spécifiez une valeur si vous souhaitez activer Thread Monitor. Valeurs admises :
false. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/threadMonitorEnable/xc-app
|
Facultatif | Spécifiez une valeur si vous souhaitez activer Thread Monitor. Valeurs admises :
false. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/threadMonitorEnable/search-app
|
Facultatif | Spécifiez une valeur si vous souhaitez activer Thread Monitor. Valeurs admises :
false. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/threadMonitorEnable/crs-app
|
Facultatif | Spécifiez une valeur si vous souhaitez activer Thread Monitor. Valeurs admises :
false. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/threadMonitorEnable/search-ingest-app
|
Facultatif | Spécifiez une valeur si vous souhaitez activer Thread Monitor. Valeurs admises :
false. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/threadMonitorEnable/search-query-app
|
Facultatif | Spécifiez une valeur si vous souhaitez activer Thread Monitor. Valeurs admises :
false. |
| Chemin Vault | Exigence | Description |
|---|---|---|
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/jvmContainerSupport
|
Facultatif | |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/marketingEventListenerEnabled
|
Facultatif | Activez le programme d'écoute d’événements marketing. Valeurs admises :
La valeur par défaut est false. |
|
Facultatif | Indiquez si la connexion unique (SSO) doit être activée ou désactivée. Valeurs admises :
La valeur par défaut est false. Pour plus d'informations, voir Activation de la connexion unique. |
|
Facultatif (obligatoire si ssoEnable est défini sur true.) | Indiquez le nom de domaine qui contient un ensemble d'hôtes auquel s'applique la connexion unique. Valeurs admises :
La valeur par défaut est false. Cette valeur de clé doit être définie si ssoEnable est défini sur true. Pour plus d'informations, voir Activation de la connexion unique. |
|
Facultatif (obligatoire si ssoEnable est défini sur true.) | Indiquez si une connexion SSL est utilisée pour les requêtes de connexion unique. Valeurs admises :
Cette valeur de clé doit être définie si ssoEnable est défini sur true. Pour plus d'informations, voir Activation de la connexion unique. |
|
Facultatif | Indiquez si vous souhaitez activer ou désactiver la fonction de connexion unique (SSO) keepAliveSession sur le Transaction server. Valeurs admises :
La valeur par défaut est false. Pour plus d'informations, voir Activation de la connexion unique. |
HCL Digital Experience intégration
| Chemin Vault | Exigence | Description |
|---|---|---|
|
Facultatif | Les noms d'hôte pour les instances auth ou live de HCL Digital Experience (DX). Ils sont requis pour l'intégration de HCL Commerce à DX.Note:
|
|
Facultatif | Numéro de port de l'instance HCL Digital Experience (DX) auth ou live. La valeur par défaut est définie sur 443 si le nom d'hôte DX a été spécifié et si aucune valeur personnalisée n'est spécifiée. |
|
Facultatif | Schéma pour l'instance HCL Digital Experience (DX) auth ou live. La valeur par défaut est définie sur https si le nom d'hôte DX a été spécifié et si aucune valeur personnalisée n'est spécifiée. |
Journalisation Must-Gather
| Chemin Vault | Exigence | Description |
|---|---|---|
|
Obligatoire | Nom d'hôte du journal Elasticsearch utilisé par Must-Gather. |
|
Obligatoire | Numéro de port du journal Elasticsearch utilisé par Must-Gather. |
|
Facultatif | Nombre maximal de documents à extraire du journal Elasticsearch. |
Intégration LDAP
| Chemin Vault | Exigence | Description |
|---|---|---|
|
Obligatoire (lorsque LDAP est activé) | Type de serveur LDAP. Valeurs admises :
|
|
Obligatoire (lorsque LDAP est activé) | Nom d'hôte qualifié complet du serveur LDAP |
|
Obligatoire (lorsque LDAP est activé) | Numéro de port du serveur LDAP. |
|
Facultatif | Indiquez si le serveur LDAP requiert une connexion SSL. Valeurs admises :
|
|
Obligatoire (lorsque LDAP est activé) | Noms des propriétés LDAP utilisées pour se connecter au serveur d'applications. |
|
Obligatoire (lorsque LDAP est activé) | Spécifiez une valeur pour le nom de domaine, au lieu d'utiliser la valeur par défaut. La valeur par défaut est Note: Si vous intégrez à HCL Digital Experience, vous devez utiliser le même nom de domaine pour les deux. |
|
Obligatoire (lorsque LDAP est activé) | Filtre de recherche d'utilisateur LDAP. Utilisé uniquement pour le type LDAP personnalisé. |
|
Obligatoire (lorsque LDAP est activé) | Préfixe de l'utilisateur LDAP. |
|
Obligatoire (lorsque LDAP est activé) | Mot de passe de liaison LDAP XOR codé par l'utilitaire WebSphere Application Server V8.5.5 LibertysecurityUtility. Par exemple : Pour plus d'informations sur l'utilitaire securityUtility, voir commande securityUtility dans la documentation WebSphere Application Server V8.5.5 Liberty. |
|
Obligatoire (lorsque LDAP est activé) | Nom distinctif (DN) de liaison LDAP. La valeur doit être en minuscules. |
|
Obligatoire (lorsque LDAP est activé) | Nom distinctif (DN) de la base de recherche LDAP. La valeur doit être en minuscules. |
|
Obligatoire (lorsque LDAP est activé) | Nom distinctif (DN) complet qui mappe marque à l'organisation racine HCL Commerce. La valeur doit être en minuscules. |
|
Obligatoire (lorsque LDAP est activé) | Nom distinctif (DN) complet qui mappe marque à l'organisation par défaut HCL Commerce. La valeur doit être en minuscules. |
Intégration IBM MQ
| Chemin Vault | Exigence | Description |
|---|---|---|
|
Facultatif | Indiquez si l'intégration IBM MQ doit être activée. Valeurs admises :
|
|
Obligatoire (lorsque l'intégration MQ est activée) | Valeur du délai d'expiration de la session |
|
Obligatoire (lorsque l'intégration MQ est activée) | Nombre maximum de connexions autorisées avec IBM MQ. |
|
Obligatoire (lorsque l'intégration MQ est activée) | Nom d'hôte du serveur IBM MQ. |
|
Obligatoire (lorsque l'intégration MQ est activée) | Numéro de port du serveur IBM MQ. |
|
Obligatoire (lorsque l'intégration MQ est activée) | Gestionnaire de files d'attente IBM MQ utilisé par HCL Commerce pour se connecter au serveur IBM MQ. |
|
Obligatoire (lorsque l'intégration MQ est activée) | Nom de la file d'attente d'erreurs IBM MQ. |
|
Obligatoire (lorsque l'intégration MQ est activée) | Nom de la file d'attente IBM MQ. |
|
Obligatoire (lorsque l'intégration MQ est activée) | Nom de la file d'attente IBM MQ pour traiter les messages en série. |
|
Obligatoire (lorsque l'intégration MQ est activée) | Nom de la file d'attente IBM MQ pour traiter les messages en parallèle. |
|
Obligatoire (lorsque l'intégration MQ est activée) | Nom de la file d'attente sortante IBM MQ. |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/



Pour
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/store-web/

${VAULT_URL}/${TENANT}/${ENVIRONMENT}/