HCL Commerce Version 9.1 Référence de la charte Helm
La référence complète suivante détaille la charte Helm hcl-commerce-helmchart fournie et les différentes options de configuration disponibles pour le déploiement de HCL Commerce Version 9.1 sur Kubernetes.
Il est fortement recommandé de ne pas modifier le fichier de configuration values.yaml par défaut pour votre déploiement. Créez plutôt une copie à utiliser comme fichier de valeurs personnalisées, par exemple my-values.yaml. Cela vous permettra de conserver vos valeurs personnalisées pour les futurs déploiements et mises à niveau.
Paramètres de la charte Helm hcl-commerce-helmchart et leurs valeurs par défaut
Les sections suivantes décomposent la liste des paramètres de charte Helm en sections uniquement à des fins d'organisation. Pour une répartition et une description plus détaillées des fonctions HCL Commerce avec lesquelles elles correspondent ou qu'elles chevauchent, voir Configuration requise du chart Helm pour HCL Commerce Version 9.1.
- Configuration de déploiement de base
- Configuration d'Ingress
- Configuration de la recherche
HCL Digital Experience intégration
Assets tool configuration
Intégration LDAP
Intégration d'Anthos
Configuration du service d'approbation
Configuration du magasin Next.js (Ruby)
| Paramètre | Description | Valeur par défaut |
|---|---|---|
| Licence | La licence HCL Commerce Version 9. Vous devez accepter la licence avant de pouvoir déployer HCL Commerce. Pour afficher la licence, parcourez tous les fichiers sous le répertoire LICENSES. Pour accepter la licence, définissez license sur accept. |
not_accepted
|
| common.vaultTokenSecret | L'objet secret Kubernetes pour jeton Vault. |
vault-token-secret
|
| common.dbType | Type de base de données. Valeurs admises :
|
db2
|
| common.tenant | Le nom du titulaire. La valeur common.tenant peut désigner le nom de votre organisation. Vous pouvez disposer de plusieurs environnements sous le même locataire. |
demo
|
common.timezone
|
Fuseau horaire au format ICANN TZ. Par exemple, America/Toronto.Ce paramètre peut également être défini dans tous les conteneurs HCL Commerce en tant que variable d'environnement, TZ. Si cette valeur n'est pas définie ou vide, Warning: La modification du fuseau horaire aura un impact sur la logique métier HCL Commerce, telle que les activités Web marketing et les dates et heures de début et de fin de promotion. Les valeurs définies pour ces comportements de site ne s'ajusteront pas automatiquement en fonction de ce paramètre de fuseau horaire. Il est recommandé de conserver cette valeur vide si votre site est déjà utilisé dans un environnement de production opérationnel. |
nil |
Common.runAsNonRoot.enabled
|
Ce paramètre démarre tous les conteneurs en tant qu'utilisateur non root, comuser, pour améliorer la sécurité globale du déploiement.Valeurs admises :
Par défaut, cette valeur est définie sur Il est uniquement recommandé de désactiver cette fonctionnalité pour continuer d'utiliser un déploiement existant avant de pouvoir le tester et le mettre à jour pour une utilisation avec l'utilisateur non root. Pour plus d'informations, voir HCL Commerce utilisateurs et privilèges liés aux conteneurs. |
true
|
Common.runAsNonRoot.migrateAssetsPvcFromRootToNonroot
|
Ce paramètre déclenche une tâche de pré-mise à niveau pour mettre à jour les autorisations des fichiers dans le Persistent Volume Container (PVC) de votre Assets Tool readWriteMany, si vous en utilisez un dans votre déploiement existant.Il doit être utilisé dans des circonstances spécifiques lorsque vous mettez à niveau votre déploiement pour qu'il fonctionne correctement avec l'utilisateur non root. Pour plus d'informations, voir Mise à jour des autorisations de fichiers PVC pour la mise à niveau d'un déploiement Kubernetes des images d'utilisateur root vers les images utilisateur non root. |
FAUX |
| common.environmentName | Nom de l'environnement. Le common.environmentName désigne le nom de l'environnement. Comme exemples de noms d'environnement, citons |
qa
|
| common.environmentType | Le type d'environnement. Valeurs admises :
common.environmentType est le type d'environnement spécifique. Pour chaque environnement, un type d'environnement doit être spécifié :
|
auth
|
| common.imageRepo | Registre d'images Docker. |
my-docker-registry.io:5000/
|
| common.spiUserName | Nom d'utilisateur de spiuser. Pour plus d'informations, voir Définition du mot de passe spiuser dans vos images Docker. |
spiuser
|
| common.spiUserPwdAes | Mot de passe de l'utilisateur spiuser, chiffré avec AES par l'utilitaire wc_encrypt . Le mot de passe en texte en clair par défaut est : Vous pouvez utiliser la clé par défaut pour correspondre à l'exemple de conteneur Docker de base de données db2.
Pour plus d'informations, voir Définition du mot de passe spiuser dans vos images Docker. |
nil
|
| common.spiUserPwdBase64 | Valeur codée Base64 pour spiuser:password. Le mot de passe en texte en clair par défaut est :
Cette valeur peut être obtenue en canalisant les valeurs par l'intermédiaire de l'utilitaire système Base64 : |
nil
|
| common.vaultUrl | URL de l'API Vault v1. |
http://vault-consul.vault.svc.cluster.local:8200/v1
Note:
Cette valeur suppose que cela hcl-commerce-vaultconsul-helmchart a été utilisé pour déployer Vault dans l'espace de noms
vault.
|
| common.externalDomain | Utilisation de domaine externe pour spécifier le nom de domaine externe du service. |
.mycompany.com
|
| common.bindingConfigMap | Nom du ConfigMap qui doit être monté dans chaque conteneur pour exposer les variables d'environnement. Laissez cette valeur vide si vous n'utilisez pas une Configuration pour transmettre la configuration à chaque application. Ceci n'est nécessaire que si common.configureMode est défini sur EnvVariables |
nil
|
| common.configureMode | Mode de configuration du conteneur par défaut. Valeurs admises :
|
Vault
|
| common.imagePullSecrets | Détermine si l'image doit extraire des données confidentielles si Docker Registry nécessite l'authentification. |
nil
|
| common.imagePullPolicy | Politique d'extraction d'image Valeurs admises :
|
IfNotPresent
|
| common.serviceAccountName | Le serviceAccount utilisé pour l'exécution de commande Helm. |
par défaut
|
| common.localStoreEnabled | Paramètre permettant d'activer la création Ingress spécifique du magasin local lors du déploiement d'un service Aurora migré à partir du Transaction server. Valeurs admises :
|
false
|
| backwardCompatibility.selector | Libelés de sélecteur de pod définis dans le déploiement existant. Cela est nécessaire lorsque vous avez déployé HCL Commerce à l'aide d'une autre charte Helm précédemment et que vous souhaitez utiliser cette charte pour mettre à niveau. |
empty map
|
| hclCache.configMap | Mappe de configuration utilisée pour définir HCL Cache. | Voir le fichier values.yaml pour la configuration par défaut. |
| vaultCA.enabled | Paramètre permettant d'activer le mode de configuration de l'Autorité de certification (CA) Vault. |
true
|
| metrics.enabled | Paramètre permettant d'activer les métriques pour HCL Commerce. |
true
|
| metrics.serviceMonitor.enabled | Paramètre permettant de surveiller le service pour HCL Commerce. |
false
|
| metrics.serviceMonitor.interval | Intervalle, en secondes, pour permettre à Prometheus de demander HCL Commerce pour la surveillance du service. |
15s
|
| metrics.serviceMonitor.selector | Les libelés pour Prometheus pour correspondre à la surveillance de service. | Voir le fichier values.yaml pour la configuration par défaut. |
metrics.prometheusAnnotations.enabled
|
Paramètre permettant d'ajouter des annotations de suppression Prometheus aux pods. Valeurs admises :
|
false
|
logging.jsonLogging.enabled
|
Paramètre permettant d'activer la journalisation JSON. Lorsque la valeur de ce paramètre est true, celui-ci active la journalisation JSON pour tous les serveurs d'applications. Les valeurs acceptées sont true, pour activer la journalisation et false pour désactiver la journalisation JSON. |
false
|
common.ipv6Enabled
|
Paramètre permettant d'activer IPV6. Lorsqu'elles sont désactivées, les applications HCL Commerce ajoutent le paramètre JVM |
false
|
OpenshiftDeployment.enabled
|
Activez le déploiement sur Red Hat OpenShift. Les valeurs acceptées sont true et false. |
false
|
OpenshiftDeployment.SccName
|
Contraintes de contexte de sécurité (SCC) auxquelles vous souhaitez accorder l'accès pour le déploiement. |
privileged
|
| tsDb | Détails de la configuration pour le déploiement tsDb. |
Voir le fichier values.yaml pour la configuration par défaut. |
| tsApp | Détails de la configuration pour le déploiement tsApp. |
Voir le fichier values.yaml pour la configuration par défaut. |
| searchAppMaster | Détails de la configuration pour le déploiement searchAppMaster. |
Voir le fichier values.yaml pour la configuration par défaut. |
| searchAppRepeater | Détails de la configuration pour le déploiement searchAppRepeater. |
Voir le fichier values.yaml pour la configuration par défaut. |
| searchAppSlave | Détails de la configuration pour le déploiement searchAppSlave. |
Voir le fichier values.yaml pour la configuration par défaut. |
| tsWeb | Détails de la configuration pour le déploiement tsWeb. |
Voir le fichier values.yaml pour la configuration par défaut. |
| toolingWeb | Détails de la configuration pour le déploiement toolingWeb. |
Voir le fichier values.yaml pour la configuration par défaut. |
| storeWeb | Détails de la configuration pour le déploiement storeWeb. |
Voir le fichier values.yaml pour la configuration par défaut. |
| crsApp | Détails de la configuration pour le déploiement crsApp. |
Voir le fichier values.yaml pour la configuration par défaut. |
| xcApp | Détails de la configuration pour le déploiement xcApp. |
Voir le fichier values.yaml pour la configuration par défaut. |
| nifiApp | Détails de la configuration pour le déploiement nifiApp. |
Voir le fichier values.yaml pour la configuration par défaut. |
| registryApp | Détails de la configuration pour le déploiement registryApp. |
Voir le fichier values.yaml pour la configuration par défaut. |
| ingestApp | Détails de la configuration pour le déploiement ingestApp. |
Voir le fichier values.yaml pour la configuration par défaut. |
| queryApp | Détails de la configuration pour le déploiement queryApp. |
Voir le fichier values.yaml pour la configuration par défaut. |
tsUtils
|
Détails de la configuration pour le déploiement tsUtils. |
Voir le fichier values.yaml pour la configuration par défaut. |
cacheApp
|
Détails de configuration pour le déploiement de l'application de cache. | Voir le fichier values.yaml pour la configuration par défaut. |
mustgatherApp
|
Détails de la configuration pour le déploiement de l'application Must-Gather. Note: Pour utiliser l'application Must-Gather, un système de journalisation basé sur Elasticsearch (tel que ELK ou EFK) est requis pour l'ingestion de tous les messages de journalisation de l'application HCL Commerce sur Elasticsearch. L'application Must-Gather doit être configurée pour se connecter au serveur Elasticsearch afin de pouvoir extraire les messages du journal. Pour en savoir plus sur la configuration de Must-Gather, voir Données d'environnement dans Vault ou Démarrage du conteneur Docker Must-Gather en récupérant des paramètres à partir de variables d'environnement de conteneurs. |
Voir le fichier values.yaml pour la configuration par défaut. |
graphqlApp
|
Détails de la configuration du déploiement de l'application GraphQL. | Voir le fichier values.yaml pour la configuration par défaut. |
| supportC.image | L'image Docker du conteneur de support à utiliser en tant que Helm initContainer, pour contrôler les processus pré-installation et post-suppression. |
commerce/supportcontainer
|
| supportC.tag | Balise d'image Docker du conteneur de support. |
v9-latest
|
| test.image | L'image de test Docker pour le test Helm. |
docker.io/centos:latest
|
| Paramètre | Description | Valeur par défaut |
|---|---|---|
ingress.enabled
|
Activez la création Ingress. Les valeurs acceptées sont true, pour activer Ingress et false pour désactiver Ingress. |
true
|
| common.dataIngressEnabled |
Deprecated: Ce paramètre a été rendu obsolète et supprimé dans la version 9.1.7.0.Valeurs admises :
|
false
|
OpenshiftDeployment.destinationCACertificate
|
Dans un déploiement de conteneur OpenShift, les ressources de routes seront créées directement au lieu d'Ingress. Spécifiez le certificat d'AC pour permettre au proxy HAProxy de faire confiance au certificat des serveurs HCL Commerce. Le certificat d'AC est celui que vous avez spécifié dans le déploiement de Vault. |
nil
|
ingress.apiVersion
|
Version d'API à utiliser pour Ingress.
|
nil |
ingress.enableToolingForReactStore
|
Paramètre permettant de spécifier si le service Ingress pour l'approbation de la place de marché est activé ou désactivé. | true |
ingress.ingressController
|
Type de contrôleur Ingress. Valeurs admises :
Note:
|
nginx
|
ingress.emissaryIdsList
|
La liste d'ID Ambassador pour le programme d'écoute Emissary qui écoute sur les ports HTTP et HTTPS. Laissez cette valeur vide si vous utilisez uniquement l'ID Ambassador par défaut. Si vous utilisez différents ID Ambassador définis dans la configuration Ingress pour différents composants, vous devez les ajouter ici afin de créer des programmes d'écoute pour différents émissaires. |
nil
|
| ingressSecret.autoCreate | Le paramètre spécifie si vous avez besoin de la pré-installation Helm pour générer un secret de certification du contrôleur Ingress. C'est un moyen pratique de générer le certificat autosigné pour un environnement de test. |
true
|
| ingressSecret.replaceExist | Paramètre à spécifier si le secret de certification du contrôleur Ingress existant doit être remplacé lors du déploiement. |
true
|
ingress.enableManageApprovalPage
|
Paramètre permettant de spécifier si Ingress est activé pour la page Gérer l'approbation utilisée pour le service d'approbation de la place de marché. Valeurs admises : Il est désactivé (false) par défaut.
|
false
|
Voici toutes les configurations liées à la recherche, à l'exclusion des configurations de serveur de recherche et d'entrée.
| Paramètre | Description | Valeur par défaut |
|---|---|---|
| common.searchEngine | La solution de recherche. Valeurs admises :
|
elastic
|
searchIndexCreation
|
Paramètre permettant d'activer une construction d'index de solution de recherche basée sur Elasticsearch lors du déploiement. Les valeurs acceptées sont true pour activer le travail de génération d'index ou false pour désactiver le travail de génération d'index. |
Voir le fichier values.yaml pour la configuration par défaut. |
searchIndexCreation.pushToLiveEnabled
|
Paramètre permettant d'activer la partie du connecteur d'index push-to-live dans le travail de génération d'index. Les valeurs acceptées sont true pour activer le connecteur d'index push-to-live ou false pour désactiver le connecteur d'index push-to-live. |
Voir le fichier values.yaml pour la configuration par défaut. |
searchIndexCreation.overalMaxDuration
|
Durée maximale, en secondes, pour que le travail se termine avant d'être annulé en raison du délai d'expiration. Cette valeur doit prendre en compte le nombre de magasins indexés, la taille du jeu de données et la complexité de la génération d'index de chaque magasin. Si la valeur n'est pas suffisamment définie avec une marge généreuse, le travail peut être involontairement annulé avant qu'il ne se soit correctement terminé. |
Voir le fichier values.yaml pour la configuration par défaut. |
searchIndexCreation.indexMaxDuration
|
Durée maximale, en secondes, pendant laquelle chaque exécution d'index individuelle doit être annulée avant l'expiration du délai. | Voir le fichier values.yaml pour la configuration par défaut. |
searchIndexCreation.interval
|
Intervalle, en secondes, entre chaque vérification de préparation de chaque composant de recherche requis pour le travail de génération d'index. | Voir le fichier values.yaml pour la configuration par défaut. |
searchIndexCreation.txnMaxDuration
|
Durée maximale d'attente en secondes pour que le Transaction server soit prêt. | Voir le fichier values.yaml pour la configuration par défaut. |
searchIndexCreation.nifiMaxDuration
|
Durée maximale d'attente en secondes pour que l'application NiFi soit prête. | Voir le fichier values.yaml pour la configuration par défaut. |
searchIndexCreation.ingestMaxDuration
|
Durée maximale d'attente en secondes pour que l'application Ingest soit prête. | Voir le fichier values.yaml pour la configuration par défaut. |
searchIndexCreation.maxRetry
|
Nombre maximal de tentatives pour chaque exécution de génération d'index, en cas d'échec du travail de génération d'index. | Voir le fichier values.yaml pour la configuration par défaut. |
searchIndexCreation.storeIds
|
Liste d'ID de magasin, séparés par des virgules, par rapport à laquelle les générations d'index seront exécutées. | Voir le fichier values.yaml pour la configuration par défaut. |
searchIndexCreation.calculatePriceEnabled
|
Paramètre permettant d'activer le calcul des prix pour les magasins B2B. Les valeurs acceptées sont true pour activer le calcul des prix et false pour désactiver le calcul des prix. |
Voir le fichier values.yaml pour la configuration par défaut. |
searchIndexCreation.calculatePriceStoreIds
|
Liste d'ID de magasin, séparés par des virgules, par rapport à laquelle le calcul des prix sera exécutée. | Voir le fichier values.yaml pour la configuration par défaut. |
| Paramètre | Description | Valeur par défaut |
|---|---|---|
dx.enabled
|
Activez ou désactivez les configurations (DX) HCL Digital Experience pour HCL Commerce. |
false
|
dx.namespace.auth
|
L'espace de nom de l'environnement auth DX. Il doit se trouver dans le même cluster que Commerce. |
nil
|
dx.namespace.live
|
L'espace de nom de l'environnement live DX. Il doit se trouver dans le même cluster que Commerce. |
nil
|
dx.serviceName.auth
|
Nom du service de routage DX auth (équilibreur de charge). Les valeurs acceptées sont haproxy ou ambassador selon la version de DX. Vous pouvez obtenir le nom du service avec kubectl get service. |
nil
|
dx.serviceName.live
|
Nom du service de routage DX live (équilibreur de charge). Les valeurs acceptées sont haproxy ou ambassador selon la version de DX. Vous pouvez obtenir le nom du service avec kubectl get service. |
nil
|
| Paramètre | Description | Valeur par défaut |
|---|---|---|
assetsPVC.enabled
|
Créez un PersistentVolumeClaim (PVC) pour l'outil Ressources.
|
false
|
assetsPVC.storageClass
|
Nom de classe de stockage utilisé par le PVC pour l'outil Ressources. Ce fournisseur de ressources doit prendre en charge le mode d'accès ReadWriteMany. |
La valeur par défaut est la classe de stockage par défaut pour le cluster. |
assetsPVC.storage
|
Taille de stockage affectée au volume persistant. |
5Gi
|
assetsPVC.accessMode
|
Mode d'accès du PVC. Cette valeur doit être |
ReadWriteMany
|
assetsPVC.existingClaim.auth
|
S'il existe déjà un PVC pour l'outil Ressources dans l'environnement de création, vous pouvez l'affecter avec ce paramètre. | nil |
assetsPVC.existingClaim.live
|
S'il existe déjà un PVC pour l'outil Ressources dans l'environnement opérationnel, vous pouvez l'affecter avec ce paramètre. | nil |
Intégration LDAP
| Paramètre | Description | Valeur par défaut |
|---|---|---|
ldap.auth.enabled
|
Indique si LDAP est activé pour l'environnement de création. Valeurs admises :
Note: Par défaut, Vault est la méthode de configuration par défaut. Aucun paramètre n'est requis pour spécifier cette méthode de configuration LDAP. |
false
|
ldap.auth.useVmmPropertiesFile
|
Vous pouvez utiliser le fichier vmm.properties pour définir la configuration LDAP pour un déploiement Kubernetes en incluant une copie de celui-ci dans un Transaction server Docker container personnalisé. Pour utiliser cette méthode de configuration, définissez cette valeur sur true, puis suivez les instructions pour Intégration de déploiements Kubernetes HCL Commerce à LDAP. Valeurs admises :
|
false
|
ldap.auth.useConfigMapForVmmPropertiesFile
|
Vous pouvez utiliser le fichier de configuration ldap-vmm-auth.properties pour définir la configuration LDAP pour un déploiement Kubernetes. Pour utiliser cette méthode de configuration, définissez cette valeur sur true, puis suivez les instructions pour Intégration de déploiements Kubernetes HCL Commerce à LDAP. Valeurs admises :
|
false
|
ldap.live.enabled
|
Indique si LDAP est activé pour l'environnement opérationnel. Valeurs admises :
Note: Par défaut, Vault est la méthode de configuration par défaut. Aucun paramètre n'est requis pour spécifier cette méthode de configuration LDAP. |
false
|
ldap.live.useVmmPropertiesFile
|
Vous pouvez utiliser le fichier vmm.properties pour définir la configuration LDAP pour un déploiement Kubernetes en incluant une copie de celui-ci dans un Transaction server Docker container personnalisé. Pour utiliser cette méthode de configuration, définissez cette valeur sur true, puis suivez les instructions pour Intégration de déploiements Kubernetes HCL Commerce à LDAP. Valeurs admises :
|
false
|
ldap.live.useConfigMapForVmmPropertiesFile
|
Vous pouvez utiliser le fichier de configuration ldap-vmm-auth.properties pour définir la configuration LDAP pour un déploiement Kubernetes. Pour utiliser cette méthode de configuration, définissez cette valeur sur true, puis suivez les instructions pour Intégration de déploiements Kubernetes HCL Commerce à LDAP. Valeurs admises :
|
false
|
Intégration d'Anthos
| Paramètre | Description | Valeur par défaut |
|---|---|---|
AnthosDeployment.enabled
|
Introduit dans HCL Commerce 9.1.11.0, Google Anthos est pris en charge par le chart Helm HCL Commerce. Activez cette fonctionnalité pour le déploiement lorsque Google Anthos est utilisé. Cela a pour effet de désactiver l'injection sidecar istio pour pre-install, pre-delete, create-index, nifi et ingest en vue d'éviter les échecs.
Note: Vous pouvez toujours utiliser des versions antérieures de HCL Commerce avec Google Anthos en mettant à jour manuellement la charte Helm HCL Commerce.
|
false
|
Configuration de l'application d'approbation
| Paramètre | Description | Valeur par défaut |
|---|---|---|
approvalApp.enabled
|
Introduit dans HCL Commerce 9.1.12.0, le service d'approbation est utilisé pour les approbations au sein d'un marché. L'application du service d'approbation nécessite un PostgresSQL déployé séparément qui doit être exécuté avant le démarrage du service. L'URL de la base de données PostgreSQL est transmise au service d'approbation à l'aide du chart Helm dans lequel figure une section bootConfig sous approvedApp.
|
Voir le fichier values.yaml pour la configuration par défaut. |

Configuration du magasin Next.js (Ruby)
| Paramètre | Description | Valeur par défaut |
|---|---|---|
nextjsApp.enabled
|
Introduit dans HCL Commerce version 9.1.13.0, le Nextjs Ruby store est un magasin type basé sur le framework Next.js qui active les applications Web basées sur React avec le rendu côté serveur et la génération de sites Web statiques. Pour plus d'informations, voir Magasin type Next.js.
|
Voir le fichier values.yaml pour la configuration par défaut. |
common.timezone
Common.runAsNonRoot.enabled