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

Découvrez comment démarrer le conteneur Nifi 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 Nifi 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.
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 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 Nifi de manière à utiliser le mode de configuration Vault.

Chemin Vault Description Variable d'environnement de référence
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbHost Nom d'hôte de la base de données pour l'environnement. ${ENVTYPE}_DBHOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbPort Numéro de port de la base de données. ${ENVTYPE}_DBPORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbUser Nom d'utilisateur de la base de données HCL Commerce. ${ENVTYPE}_DBUSER
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbPassword Mot de passe utilisateur de la base de données de HCL Commerce. ${ENVTYPE}_DBPASS
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbName Nom de la base de données. ${ENVTYPE}_DBNAME
${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}/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}/elasticSearchHost Spécifiez une valeur elasticSearchHost. ELASTICSEARCH_HOST
${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}/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}/redisHost Spécifiez le nom d'hôte Redis à qui NiFi se connectera pour les messages d'événement. REDIS_HOST

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 Nifi 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}/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.
 ${ENVTYPE}_DBTYPE
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbSchema Schéma de la base de données. ${ENVTYPE}_DB_SCHEMA
${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.
 ${ENVTYPE}_DB_SSLENABLE
${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}/jdbcUrl 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.DB2
  • Avec SSL : {ENVTYPE}_JDBC_URL="jdbc:db2://${ENVTYPE}_DBHOST}:{ENVTYPE}_DBPORT/{ENVTYPE}_DBNAME}:sslConnection=true;"
  • Sans SSL : {ENVTYPE}_JDBC_URL="jdbc:db2://${ENVTYPE}_DBHOST}:{ENVTYPE}_DBPORT/{ENVTYPE}_DBNAME}
Oracle
  • Avec SSL : {ENVTYPE}_JDBC_URL=jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=tcps)(HOST={ENVTYPE}_DBHOST)(PORT={ENVTYPE}_DBPORT))(CONNECT_DATA=(SERVICE_NAME={ENVTYPE}_DBNAME)))
  • Sans SSL :ENVTYPE_JDBC_URL="jdbc:oracle:thin:@"{ENVTYPE}_DBHOST:{ENVTYPE}_DBPORT/{ENVTYPE}_DBNAME
 ${ENVTYPE}_JDBC_URL
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/jdbcDriver 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 :
  • DB2/opt/nifi/nifi-current/lib/db2jcc4.jar
  • Oracle/opt/nifi/nifi-current/lib/ojdbc8.jar
 ${ENVTYPE}_JDBC_DRIVER_LOCATION
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/jdbcDriverClass 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 :
  • DB2com.ibm.db2.jcc.DB2Driver
  • Oracleoracle.jdbc.driver.OracleDriver
 ${ENVTYPE}_JDBC_DRIVER_CLASSNAME
${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}/${ENVTYPE}/elasticSearchShardCount 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.
  • AUTH_ELASTICSEARCH_SHARD_COUNT
  • LIVE_ELASTICSEARCH_SHARD_COUNT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/elasticSearchReplicaCount 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.
  • AUTH_ELASTICSEARCH_REPLICA_COUNT
  • LIVE_ELASTICSEARCH_REPLICA_COUNT
${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}/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}/nifiClusterIsNode Indiquez si l'installation NiFi est autonome.
Valeurs admises :
  • true pour un nœud dans un cluster NiFi.
  • false pour une installation autonome.
La valeur par défaut est false.
 NIFI_CLUSTER_IS_NODE
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nifiClusterNodeProtocalPort Spécifiez une valeur pour le port du nœud du cluster NiFi. La valeur par défaut est 8082. NIFI_CLUSTER_NODE_PROTOCOL_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nifiElectionMaxWait 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. NIFI_ELECTION_MAX_WAIT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nifiJvmHeapInit Spécifiez une valeur si vous souhaitez définir une valeur nifiJvmHeapInit, au lieu d'utiliser la valeur par défaut. NIFI_JVM_HEAP_INIT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nifiHost Nom d'hôte du service Nifi. La valeur par défaut est nifi. NIFI_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nifiPort Le port de service Nifi. La valeur par défaut est 30600. NIFI_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nifiScheme Le schéma de service Nifi. La valeur par défaut est http. NIFI_SCHEME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nifiWebHttpPort Port HTTP Web du service NiFi. La valeur par défaut est 30600. NIFI_WEB_HTTP_PORT
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. QUERY_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.

 QUERY_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.

 QUERY_SCHEME
${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}/redisHost Spécifiez le nom d'hôte Redis à qui NiFi se connectera pour les messages d'événement. REDIS_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/redisPort Spécifiez le numéro de port Redis auquel NiFi se connectera pour les messages d'événements.

La valeur par défaut est 6379.

 REDIS_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/redisPasswordEncrypt Le mot de passe chiffré du serveur Redis. REDIS_PASSWORD_ENCRYPT
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