Data Watcher Domain Master Configuration reference

The Domain Master Configuration (DMCFG) is a YAML document that contains the essential bootstrap parameters required by the product at startup.

The DMCFG is located on the DW Control Node at <DOIM_HOME>/config/dmcfg.yaml. The initial DMCFG document is automatically generated as part of the installation process and can be partially modified at any time during the product's lifetime.

Global configuration

The following table lists the variables that apply globally to the system. The initial values of these variables are set based on user responses to the setup questions during installation. Depending on your installation's customization needs, you may provide node-level overrides for some global variables.

Name

Default Value

Description

env_name

production

Execution environment name, e.g. "production" / "QA" / "test". This is a human-readable free text that is shown in the product WUI banner and selected log messages. It is intended to be used as a quick visual identifier of the environment where a given Data Watcher instance is running.

dataone_home

/opt/dataone

Data Watcher home path where product code and some node-level state information is stored. Node-level overrides can be provided for this variable.

dataone_log_path

/opt/dataone/log

Data Watcher log path where all product-generated logs and traces are stored. Node-level overrides can be provided for this variable.

number_of_datawatcher

3

Number of Data Watcher hosts forming the Data Watcher cluster

brokerconfig_journal_directory

/opt/shared

AMQ active-passive broker message store path; it must be on a shared file system visible by all CEMAN nodes

activemq_https_port

7443

AMQ broker web console HTTPS listening port

brokerconfig_jgroups_port

7701

AMQ active-passive broker JGroups primary listening port, a secondary listening port brokerconfig_jgroups_port+3 for JGroups failure detection protocol will also be bound.

brokerconfig_acceptor_core_port

61617

AMQ active-active broker native protocol listening port

brokerconfig_aa_jgroups_port

7702

AMQ active-active broker JGroups primary listening port, a secondary listening port brokerconfig_aa_jgroups_port+3 for JGroups failure detection protocol will also be bound.

brokerconfig_aa_acceptor_core_port

61617

AMQ active-active broker native protocol listening port

brokerconfig_aa_scaledown_jgroups_port

7703

AMQ active-active broker scaledown jgroups primary listening port, a secondary listening port brokerconfig_aa_scaledown_jgroups_port+3 for JGroups failure detection protocol will also be bound.

activemq_localcontroller_port

7772

AMQ local controller listening port, internally used by the product to stop/check a running AMQ broker

dwapi_https_port

2580

DATA WATCHER APIs HTTPS listening port. To change this default value during the update procedure, edit the file $DOIM_HOME/NEXT/config/dmcfg.yaml after update-prepare phase and before update-commit.

To change this default value after updating the environment, edit the file $DOIM_HOME/config/dmcfg.yaml and execute the following command to propagate the changes:

cd $DOIM_HOME/bin

./doim.sh domain-deploycfg

zk_port

2181

DATA WATCHER Zookeeper listening port

net_port

27017

DATA WATCHER embedded MongoDB listening port

storm_worker_port

6710

DATA WATCHER base listening port for Storm workers port range Ports from storm_worker_port to storm_worker_port+ 9 could be listened to (in a worst-case scenario, the typical actual number is less than that).

ssl_default_keystore_password_obf

N/A

ACTIVEMQ SSL/TLS P12 keystore password

amq_web_console_password_obf

N/A

Set the AMQ web console "amqadmin" user password

DW_SUPERUSER_PASSWORD

Data Watcher IAM "admin" user's password

Node configuration

The next table lists the variables that have a node-level scope, meaning a value must be specified for each node. Depending on the number of nodes, one or more options for each variable must be specified during the installation phase.

For example, if you have three Data Watcher hosts, you must enter three hostname variables.

Name

Default value

Description

hostname

Managed node hostname

dataone_user

Managed node SSH connection username

N/A

N/A

Managed node SSH connection password

activemq_server_name

amq1

CEMAN AMQ Liberty server name

Last updated