Environment variables for deployed Docker image

The deployed Product Master images have a number of default settings that define how the deployed instance behaves.

Fix Pack 2 - GA

As a prerequisite, the Docker images should exist on the computer where the containers are being created. Additionally, use the following command to create the network a network, which is used by the containers to communicate with each other. 

docker network create mdm-network
The Docker commands use this network. Modify the network name in the commands if you choose to use a different name.

Mandatory environment variables

Note: Following environment variables are applicable to all the Docker images, unless otherwise specified.
DB_HOST
The IP of the database server. The default value is x.x.x.x.
DB_PASSWORD
The password of the authentication account. The default value is db2inst1.
DB_PORT
The database port for database connection. The default value is 50000.
DB_USER_NAME
The user account configured for database authentication. The default value is db2inst1.
ENABLE_GDS
Enable Global Data Synchronization.
EXPOSED_NEWUI_SVR_PORT
The port value mapped to the HTTPS port configured. The default value is 31192 or 9445.
Note: Applicable only to deployments on Kubernetes.
 ipm-persona 
INDEXER_MEMORY_FLAG
The minimum or maximum memory that is configured for indexer service. This environment variable is optional and set to the default value of -Xmx1024m -Xms1024m.
  ipm-fts-pim   ipm-sch 
INGRESS_HOST_URL
The ingress route URL defined in the OpenShift® for routing requests. This environment variable must be set when routes or ingress URLs are defined for accessing the Persona-based UI. The default value is ipm-persona-svc.mynamespace.routerdefault.svc.cluster.local.
MDM_ADMIN_MEMORY_FLAG
The minimum or maximum memory that is configured. The default value is -Xmx128m -Xms48m.
 ipm-admin 
MDM_APPSVR_MEMORY_FLAG
The minimum or maximum memory that is configured. The default value is -Xmx2048m -Xms256m.
 ipm-admin 
MDM_APP_SVR_PORT
The port number used for the Admin UI. This environment variable is optional. The default value is 7507.
MDM_DB_NAME
The name of the database. The default value is database1.
MDM_DB_TYPE
The database type to configure in the MDM configuration files. The default value is db2. Applicable to all the containers if the value is oracle.
MDM_EVENTPROCESSOR_MEMORY_FLAG
The minimum or maximum memory that is configured for event processor service. The default value is -Xmx128m -Xms48m.
 ipm-admin 
MDM_LOG_DIR
The default log location used by all the containers. The default value is /opt/mdmlogs.
MDM_SCHEDULER_MEMORY_FLAG
The minimum or maximum memory that is configured for scheduler service. The default value is -Xmx1024m -Xms48m.
 ipm-sch 
MDM_QUEUEMANAGER_MEMORY_FLAG
The minimum or maximum memory that is configured for queue manager service. The default value is -Xmx128m -Xms48m.
 ipm-admin 
MONGODB_DATABASE
The name of the Mongo database. The default value is mgdb.
MONGODB_PASSWORD
The password of the authentication account. The default value is mluser.
NODE_TYPE
The type of the node. Valid value can be Primary or Additional.
NEWUI_MAX_MEM
The maximum memory configured for the Persona-based UI. The default value is 2048.
NEWUI_SVR_PORT
The port number used for the Persona-based UI. The default value is 9092.
PIMCOLLECTOR_MEMORY_FLAG
The minimum or maximum memory that is configured for pimcollector service. The default value is -Xmx1024m -Xms1024m.
 ipm-persona   ipm-sch 
PIMCOLLECTOR_URI
The URI to communicate with the pimcollector service. The default value is http://<ip address>:9095.
SERVICES
The value of service name. Depending upon the Docker image, the possible value can be machinelearning, scheduler, or workflowengine.
 ipm-ml   ipm-sch   ipm-wfl 

GDS environment variables

COMPANY_NAME
The name of the GDS company.
 ipm-gds   ipm-wfl 
GDS_APP_TYPE
The component of the application being installed.
 ipm-gds   ipm-wfl 
GDS_DATAPOOL_GLN
The Global Location Number (GLN) of the data pool service.
 ipm-gds   ipm-wfl 
GDS_SELF_GLN
The GLN of the trading partner that is using this application.
 ipm-gds   ipm-wfl 
MQ_APP_PASSWORD
The password that the application uses to connect to the IBM® MQ service.
 ipm-gds 
MQ_APP_USERNAME
The username that the application uses to connect to the IBM MQ service.
 ipm-gds 
MQ_CHANNEL_NAME
The name of the IBM MQ service channel.
 ipm-gds 
MQ_HOST
The hostname or IP address of the IBM MQ queue manager.
 ipm-gds 
MQ_PORT
The port number of the IBM MQ queue manager.
 ipm-gds 
MQ_QUEUE_MANAGER
The queue manager of the IBM MQ service.
 ipm-gds 
INBOUND_QUEUE_NAME
The name of the queue for the inbound messages.
 ipm-gds   ipm-wfl 
OUTBOUND_QUEUE_NAME
The name of the queue for the outbound messages.
 ipm-gds   ipm-wfl 
QUEUE_CONNECTION_FACTORY
The name of the connection factory.
 ipm-gds   ipm-wfl 

Digital Assets Management environment variables

ENABLE_DAM
To enable DAM. The default value is 0.
 ipm-admin   ipm-persona   ipm-sch 
IPM_SHARED_VOLUME_DIR
The directory shared between ipm-admin, ipm-persona, and ipm-sch containers. Depending on the IBM Product Master version, the value of this variable can be,
IBM Product Master 12.0 and later
/opt/ipm_shared_vol
IBM Product Master Version 12.0 Fix Pack 2 and later
/opt/MDM/public_html
 ipm-admin   ipm-persona   ipm-sch 
MONGODB_IP
The IP address of the server hosting the MongoDB service. The default value is x.x.x.x.
 ipm-admin   ipm-persona   ipm-sch 
MONGODB_PORT
The port number configured to use with the MongoDB. The default value is 27017.
 ipm-admin   ipm-persona   ipm-sch 

Free text search environment variables

ES_AUTH_PASSWORD
The default value is changeme.
 ipm-admin   ipm-persona   ipm-fts-indexer   ipm-fts-pim   ipm-sch   ipm-wfl 
ES_AUTH_USERNAME
The user account name used for authentication with the Elasticsearch. Set to user elastic by default. The default value is elastic.
 ipm-persona   ipm-fts-indexer   ipm-fts-pim   ipm-sch 
ES_CLUSTER_IP
The IP address of the server hosting the Elasticsearch service. The default value is x.x.x.x.
 ipm-persona   ipm-fts-indexer   ipm-fts-pim 
ES_CLUSTER_NAME
The name of the Elasticsearch cluster. The default value is docker-cluster.
 ipm-persona   ipm-fts-indexer   ipm-fts-pim 
ES_HTTP_PORT
The default HTTP port for Elasticsearch. The default value is 9200.
 ipm-persona   ipm-fts-indexer   ipm-fts-pim 
ENABLE_FTS
To enable free text search. The default value is 0.
 ipm-admin   ipm-persona   ipm-sch   ipm-wfl 
ES_PASSWORD_ENCRYPTED
Flag to hint that the password is in encrypted format (similar to the database connections). The default value is 0.
 ipm-persona   ipm-fts-indexer   ipm-fts-pim 
ES_TRANSPORT_PORT
The default TCP port for transport-based communication. The default value is 9300.
 ipm-persona   ipm-fts-indexer   ipm-fts-pim 
ES_USE_AUTH
Flag to enable authentication with the Elasticsearch. This environment variable, by default, is set to value 0 as enabling authentication requires some additional JARs, which are not free and carry license cost. You would also need to customize the Docker image to specify the additional JARs. The default value is 0.
 ipm-persona   ipm-fts-indexer   ipm-fts-pim 
HAZELCAST_IP
The IP address of the server hosting the Hazelcast service. The default value is x.x.x.x.
 ipm-admin   ipm-persona    ipm-fts-pim    ipm-fts-indexer   ipm-ml   ipm-sch   ipm-wfl 
HAZELCAST_PORT
The port number configured to use with Hazelcast. The default value is 5702.
 ipm-admin   ipm-persona    ipm-fts-pim    ipm-fts-indexer   ipm-ml   ipm-sch   ipm-wfl 
PIMCOLLECTOR_URI
The URI to communicate with the pimcollector service. The default value is http://<ip address>:9095.
 ipm-persona   ipm-fts-indexer   ipm-fts-pim 

Machine learning environment variables

ENABLE_ML
To enable machine learning. The default value is 0.
 ipm-admin   ipm-persona   ipm-sch   ipm-wf   ipm-ml 
ML_HOST
The IP address of the server hosting the Machine learning service. The default value is x.x.x.x.
 ipm-admin   ipm-persona   ipm-sch   ipm-wf   ipm-ml 
ML_PORT
The port number configured to use with the Machine learning. The default value is 5000.
 ipm-admin   ipm-persona   ipm-sch   ipm-wf   ipm-ml 
MONGODB_DATABASE
The name of the Mongo database. The default value is mgdb.
 ipm-admin   ipm-persona   ipm-sch   ipm-ml 
MONGODB_IP
The IP address of the server hosting the MongoDB service. The default value is x.x.x.x.
 ipm-admin   ipm-persona   ipm-sch   ipm-ml 
MONGODB_PASSWORD
Password of the authentication account. The default value is mluser.
 ipm-admin   ipm-persona   ipm-sch   ipm-ml 
MONGODB_PORT
The port number configured to use with the MongoDB. The default value is 27017.
 ipm-admin   ipm-persona   ipm-sch 

Vendor Persona environment variables

ENABLE_VENDOR
To enable Vendor portal. The default value is 0.
 ipm-admin   ipm-persona   ipm-sch   ipm-wfl