Iniciar el Search server Docker container recuperando parámetros de Vault

Obtenga información sobre cómo empezar Search server Docker container especificando CONFIGURE_MODE=Vault.

Variables de entorno obligatorias

Estas son las variables de entorno obligatorias que debe especificar para configurar el Search server Docker container para recuperar parámetros adicionales de Vault.
Nombre de variable de entornoDescripción:Comentarios
TENANT El nombre del grupo que incluye el conjunto de entornos. Por ejemplo, MyCompany. Variable de entorno de contenedor. Esto se puede especificar en el archivo de configuración values.yaml en common.tenant.
ENTORNO El nombre del entorno. Por ejemplo, Non-production. Variable de entorno de contenedor. Esto se puede especificar en el archivo de configuración values.yaml en common.environmentName.
ENVTYPE El tipo de entorno. Los valores aceptados son auth y live. Variable de entorno de contenedor. Esto se puede especificar en el archivo de configuración values.yaml en common.environmentType.
VAULT_TOKEN La señal de Vault que se utiliza para conectarse a Vault y solicitar la certificación de la característica PKI de Vault. Variable de entorno de contenedor. Esto se puede especificar en el archivo de configuración values.yaml en common.vaultToken.
VAULT_URL El URL de Vault que hay que utilizar para conectarse a Vault y solicitar la certificación de la característica PKI de Vault. Variable de entorno de contenedor. Esto se puede especificar en el archivo de configuración values.yaml en common.vaultUrl.
SOLR_MASTER_SERVER_URLURL de Vault del URL del servidor maestro de Solr.

Esto es obligatorio para el esclavo de Solr y el repetidor de Solr.

Variable de entorno de contenedor.
Generado según el contenido de value.yaml.
solr slave: { common.tenant }{common.environmentName}}livesearch-app-repeater.{ Namespace }.svc.cluster.local:3738 solr repeater: { common.tenant }{common.environmentName}}livesearch-app-master.{ Namespace }.svc.cluster.local:3738
  • SOLR_MASTER
  • SOLR_SLAVE
SOLR_MASTER y SOLR_SLAVE se usan conjuntamente para determinar el tipo de nodo de búsqueda.
Para configurar el contenedor Search server como:
  • Nodo de maestro de búsqueda.
    • SOLR_MASTER=true
    • SOLR_SLAVE=false
  • Nodo de repetidor de búsqueda.
    • SOLR_MASTER=true
    • SOLR_SLAVE=true
  • Nodo de subordinado de búsqueda.
    • SOLR_MASTER=false
    • SOLR_SLAVE=true
SOLR_MASTER y SOLR_SLAVE se manejan mediante la plantilla gráfico de Helm.
CONFIGURE_MODE El modo de configuración.
Los valores aceptados son:
  • Vault para la configuración de Vault.
  • EnvVariables para la configuración de las variables de entorno.
Establezca este valor en Vault para usar la configuración de Vault y las configuraciones presentes en esta referencia.
Variable de entorno de contenedor. Esto se puede especificar en el archivo de configuración values.yaml en common.configureMode.

Variables de entorno opcionales

Estas son las variables de entorno opcionales que puede especificar para configurar el Search server Docker container.

Todos los parámetros que especifique como variables de entorno del contenedor tienen prioridad sobre los valores que se almacenan en Vault.

Nombre de variable de entorno Descripción: Comentarios
EXPOSE_METRICS Especifique si desea habilitar las métricas para el entorno.
Los valores aceptados son:
  • true para habilitado.
  • false para inhabilitado.
El valor predeterminado se establece en true.
Variable de entorno de contenedor. Esto se puede especificar en el archivo de configuración values.yaml en metrics.enabled.
SOLR_REPLICATION_POLLINTERVAL El intervalo de sondeo de réplica para los servidores subordinados de búsqueda dentro del entorno en vivo.
WORKAREA

La vía de acceso del índice de búsqueda en el Search server Docker container.

Por ejemplo, /seach.

Variables de configuración de Vault obligatorias

Estos son los valores de clave de Vault obligatorios que debe especificar dentro de Vault para configurar el Search server Docker container para utilizar el modo de configuración de Vault.

Vía de acceso de Vault Descripción: Variable de entorno de referencia
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/spiUserName
HCL Commerce Version 9.1.7.0 or laterNote: Este valor es opcional a partir de HCL Commerce 9.1.7.0.
El nombre de usuario spiuser.

HCL Commerce Version 9.1.7.0 or laterSi el valor no está definido, se utiliza spiuser.

SPIUSER_NAME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/spiUserPwd La contraseña de usuario spiuser cifrada ASCII.

Para establecer la contraseña en sus contenedores de Docker personalizados, consulte Establecimiento de la contraseña de spiuser en las imágenes de Docker.

SPIUSER_PWD
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/adminSpiUserPwd La contraseña de usuario spiuser de texto sin formato.

El ADMIN_SPIUSER_PWD debe tener el mismo valor que SPIUSER_PWD pero se conserva como texto sin formato.

Para establecer la contraseña en sus contenedores de Docker personalizados, consulte Establecimiento de la contraseña de spiuser en las imágenes de Docker.

ADMIN_SPIUSER_PWD
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/domainName Especifique el nombre de dominio de servicio interno. Si el entorno desplegado se encuentra en un espacio de nombres especial en Kubernetes, el nombre del dominio debe ser .svc.cluster.local. Si no se especifica ningún valor, se utiliza el valor predeterminado.

default.svc.cluster.local

DOMAIN_NAME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbHost El nombre de host de la base de datos para el entorno.
Note: Este valor solo es obligatorio en el entorno de creación de WCPublishDataSource.
DBHOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbPort El número de puerto de la base de datos.
Note: Este valor solo es obligatorio en el entorno de creación de WCPublishDataSource.
DBPORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/sessionKeyEncrypt
HCL Commerce Version 9.1.12.0 or laterNote: Ahora obligatorio, este valor era opcional antes de HCL Commerce 9.1.12.0.
La clave de sesión cifrada, cifrada con la clave de cifrado de claves. La clave de sesión que se ha creado cuando usted o un administrador han cargado el esquema de la base de datos de HCL Commerce.
Important: Debe especificar sus propios valores de clave de comerciante y clave de cifrado de claves para la seguridad de la instalación HCL Commerce. No utilice los valores predeterminados contenidos en los archivos de configuración de ejemplo y ejemplos de documentación proporcionados.
SESSION_KEY_ENCRYPT

Variables de configuración de Vault opcionales

Estos son los valores de clave de Vault opcionales que puede especificar dentro de Vault para configurar el Search server Docker container cuando se usa con el modo de configuración de Vault.

Vía de acceso de Vault Descripción: Variable de entorno de referencia
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbSSLEnable Especifique si la conexión de base de datos utiliza SSL.
Los valores aceptados son:
  • true para una conexión SSL.
  • false para una conexión no cifrada.
El valor predeterminado es false.
Note: También puede especificar credenciales de origen de datos mediante el mandato de inicio si no desea recuperar los valores de origen de datos de Vault.
DB_SSLENABLE
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbType El tipo de base de datos.
Los valores aceptados son:
  • db2 para IBM Db2 Database.
  • oracle para Oracle Database.
El valor predeterminado es db2.
DBTYPE
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/dbXA Especifique si la función XA está habilitada para la base de datos.
Los valores aceptados son:
  • true para habilitado.
  • false para inhabilitado.
El valor predeterminado es false.
Note: También puede especificar credenciales de origen de datos mediante el mandato de inicio si no desea recuperar los valores de origen de datos de Vault.
DB_XA
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/txHost El nombre de host del Transaction server.

El valor predeterminado es app.

TX_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/txPort El número de puerto Transaction server.

El valor predeterminado es 5443.

TX_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/xcHost Especifique un valor si desea establecer un nombre de host para el Customization server, en lugar de utilizar el valor predeterminado. XC_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/xcPort Especifique un valor si desea establecer un número de puerto para el Customization server, en lugar de utilizar el valor predeterminado. XC_PORT
HCL Commerce Version 9.1.6.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/enableJsonLogging Habilite el registro JSON.
Los valores aceptados son
  • true para habilitar el registro JSON.
  • false para inhabilitar el registro JSON.

El valor predeterminado es false.

ENABLE_JSON_LOGGING
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/traceSpecification/search-app Si desea cambiar la especificación de rastreo para el Search server, especifique un valor. TRACE_SPEC
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/healthCenterEnable/search-app Especifique un valor si desea habilitar Health Center.
Los valores aceptados son:
  • true para habilitar Health Center.
  • false para no habilitar Heather Center.
El valor predeterminado es false.
HEALTH_CENTER_ENABLED
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/threadMonitorEnable/search-app Especifique un valor si desea habilitar Monitor de subprocesos.
Los valores aceptados son:
  • true para habilitar Monitor de subprocesos.
  • false para no habilitar Monitor de subprocesos.
El valor predeterminado es false.
THREAD_MONITOR_ENABLED
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/redisPasswordEncrypt La contraseña cifrada de Redis. REDIS_PASSWORD_ENCRYPT