You might use one or more of the environment variables defined below to customize various aspects of your MigratoryData KE deployment. These environment variables should be defined in the following system configuration file:

System configuration file Platform
/etc/default/migratorydata-ke For deb-based Linux (Debian, Ubuntu)
/etc/sysconfig/migratorydata-ke For rpm-based Linux (RHEL, CentOS)

MIGRATORYDATA_EXTRA_OPTS

   
Description Specifies various extra options for MigratoryData KE
Default value ""
Required parameter Optional

Use this environment variable to define various extra options for MigratoryData KE. Thus it can be used to configure default parameters which are not yet set in the main configuration file, or override parameters which are already configured in the main configuration file.

Every configurable parameter of MigratoryData KE can be either configured in the main configuration file, or specified as an extra option with the MIGRATORYDATA_EXTRA_OPTS environment variable using the following syntax:

-Dparameter=value

The value of a parameter should be defined without spaces and quotes. For example, use -DMemory=512MB, rather than -DMemory='512 MB'. Likewise, use -DLogFolder=/tmp/somefile, rather than -DLogFolder="/tmp/some file".

Also, the value of a parameter cannot be defined on multiple lines. For example, if the LicenseKey parameter is configured in your configuration file on multiple lines as follows:

LicenseKey = aaaa\
             bbbb\
             cccc

then, you could redefine it as an extra option only as follows -DLicenseKey=aaaabbbbcccc.

A parameter defined using an extra option will override the value of that parameter defined in the main configuration file. This is typically the goal of the extra options. For example, an extra option could be used to temporarily test a feature of your deployment without modifying the configuration file. Another use of the extra options is when running MigratoryData KE into a container. In this case, the default configuration file cannot be typically edited inside the container, so customization is done using extra options from the outside.

For example, to configure the JMX monitoring on the port 3000, without using authentication, or to alter the existing configuration of JMX monitoring use:

MIGRATORYDATA_EXTRA_OPTS='-DMonitor=JMX \
                          -DMonitorJMX.Listen=*:3000 \
                          -DMonitorJMX.Authentication=false'

MIGRATORYDATA_JAVA_EXTRA_OPTS

   
Description Specifies various extra options for Java
Default value ""
Required parameter Optional

Use this environment variable to define extra options for Java Virtual Machine.

For most cases, you don’t need to configure this environment variable.mHowever, there are situations when adding an extra option for Java could be necessary.

For example, if you run MigratoryData KE into a docker container or on an AWS EC2 machine, then, in order to be able to access the JMX monitoring using the jconsole tool, you will need to provide some extra options for Java as follows:

MIGRATORYDATA_JAVA_EXTRA_OPTS='-Djava.net.preferIPv4Stack=true \
                               -Djava.rmi.server.hostname=yourhostname'

where yourhostname is the DNS name of the machine hosting the docker container, or the public DNS name of the AWS EC2 machin e.

MIGRATORYDATA_JAVA_GC_OPTS

   
Description Specifies various options for Java Garbage Collection
Default value "-verbosegc -XX:+UseParallelOldGC"
Required parameter Optional

Use this environment variable to define the Java options related to Garbage Collection. These options should not include the Java options for Garbage Collection logging which should be provided using the environment variable MIGRATORYDATA_JAVA_GC_LOG_OPTS.

For most cases, it is sufficient to use the default value of this environment variable.

MIGRATORYDATA_JAVA_GC_LOG_OPTS

   
Description Specifies options for Java Garbage Collection logs
Default value for Java 8 "-XX:+PrintGCDetails \
-XX:+PrintGCTimeStamps \
-XX:+PrintGCDateStamps \
-XX:+UseGCLogFileRotation \
-XX:GCLogFileSize=10M \
-XX:NumberOfGCLogFiles=5 \
-Xloggc:YourLogFolder/all/gc-%t.log"
Default value for Java 9+ "-Xlog:gc*:file=YourLogFolder/all/gc-%t.log:time, \
uptimemillis:filecount=5,filesize=10000"
Required parameter Optional

Use this environment variable to define the Java options related to Garbage Collection logging.

For most cases, it is sufficient to use the default value of this environment variable.

MIGRATORYDATA_MAX_DESCRIPTORS

   
Description Specifies the maximum number of socket descriptors
Default value 1000000
Required parameter Optional

Use this environment variable to define the maximum number of socket descriptors to be used by the maximum number of concurrent users connecting to MigratoryData KE.

For most cases, it is sufficient to use the default value of this environment variable.

MIGRATORYDATA_KAFKA_EXTRA_OPTS

   
Description Specifies various options for Kafka consumer and producer
Default value ""
Required parameter Optional

Use this environment variable to define the Kafka consumer and producer options related to Kafka cluster.