Customize ActiveGate installation

Linux

Command line parameters can be used with the installer as follows:

Dynatrace-ActiveGate-Linux-x86-<version>.sh [<parameter1>=<value1>] [<parameter2>=<value2>] ...

No spaces

Spaces between the parameter name and parameter value aren't allowed.

  • PROXY=<proxy_address>:<proxy_port>
    Proxy address and proxy port

  • USER=<user>
    Runs the service as the specified user. For versions earlier than Dynatrace 1.155, the user must exist in the system. For versions 1.155+, the installer creates the user if the user doesn't already exist in the system and the user doesn't require root rights. If the parameter isn't specified, the installer creates user dtuserag to run the ActiveGate service. However, you can use USER=root to force the ActiveGate service to run as root. Note: the USER=root parameter is not supported when installing a synthetic-enabled ActiveGate.

  • INSTALL=<folder>
    Stores installation files in the specified folder. The default value for this parameter (if not specified) is /opt/dynatrace. Not permitted during upgrade.

    INSTALL folder limitations

    The INSTALL folder can't be a prefix of the LOG, CONFIG, TEMP, or PACKAGES_DIR folders. This will prevent the ActiveGate from properly performing backups and will cause problems for the ActiveGate one-click update because the configuration files can't be saved properly.

    For example, don't set the INSTALL directory as a root directory of LOG, CONFIG or TEMP:

    INSTALL=/dynatrace
    LOG=/dynatrace/gateway/logs
    CONFIG=/dynatrace/gateway/config
    TEMP=/dynatrace/gateway/tmp
    
  • PACKAGES_DIR=<folder>
    Stores capabilities installation files in the specified folder. The default value for this parameter (if not specified) is /var/lib/dynatrace/gateway/packages. Not permitted during upgrade.

  • LOG=<folder>
    Stores log files in the specified folder. The default value for this parameter (if not specified) is /var/log/dynatrace. Not permitted during upgrade.

  • CONFIG=<folder>
    Stores configuration files in the specified folder. The default value for this parameter (if not specified) is /var/lib/dynatrace. Not permitted during upgrade.

  • TEMP=<folder>
    Indicates the temporary directory to be used by ActiveGate. The default value for this parameter (if not specified) is /var/tmp/dynatrace. Not permitted during upgrade.

  • --ca-certificate-file=<path>
    Absolute path to the location of the certificate to be used when ActiveGate connects to the Dynatrace server. See Specifying CA certificate during ActiveGate installation.

  • --ca-certificate-password-file=<path>
    Absolute path to the location of the file containing the certificate password. See Specifying CA certificate during ActiveGate installation.

  • DYNATRACE_ACTIVEGATE_SERVER_CONNECTION_TIMEOUT=<seconds>
    Defines the maximum number of seconds (default: 120) the installer will wait for a connection to the server in order to download additional capabilities. In Linux deployments, this parameter must be used as an environment variable. For example:

    [root@host]# export DYNATRACE_ACTIVEGATE_SERVER_CONNECTION_TIMEOUT=240
    [root@host]# Dynatrace-ActiveGate-Linux-x86-1.0.0.sh <... other parameters>
    

    or you can use combined commands in a single line. For example:

    [root@host]# export DYNATRACE_ACTIVEGATE_SERVER_CONNECTION_TIMEOUT=240 ; Dynatrace-ActiveGate-Linux-x86-1.0.0.sh <... other parameters>
    
    • If a connection timeout occurs during a fresh install, the installation will fail and the ActiveGate service will be disabled. Extend the timeout value and repeat the installation.

    • If a connection timeout occurs during an upgrade, the installation will fail and the ActiveGate will start with its pre-upgrade capabilities. Extend the timeout value and repeat the installation.

    • When installing or upgrading, the ActiveGate attempts to make a connection to the Dynatrace Server for typical operation once it's installed or upgraded. If that connection times out, the installer may issue a failure message for a connection timeout. In such cases, if all components have downloaded and installed correctly, ActiveGate will operate normally and continue attempting to connect to the server. To check the status of the installation, sign in to Dynatrace, select Show deployment status, and then select the Dynatrace ActiveGates tab.

  • --set-network-zone=<name>
    Defines the network zone to which the ActiveGate belongs. An ActiveGate can be part of only one network zone. Not permitted during upgrade. To add a network zone to the existing ActiveGate, use the custom.properties file.

Mount points

During the install process, ActiveGate creates a number of directories. If you specified the path in the INSTALL and CONFIG parameters, ActiveGate will create its directories inside that path. Do not create mount points to the installer-created directories. You can only mount the default directories or the directories you have specified.

For example, suppose you have provided the following INSTALL parameter:

INSTALL=/opt/MyActiveGate

The ActiveGate installer will create a subdirectory gateway in the installation path you have provided:

/opt/MyActiveGate/gateway

As a result:

  • The mount point /opt/MyActiveGate is VALID.
  • The mount point /opt/MyActiveGate/gateway is INVALID.

Windows

Command line parameters can be used with the installer as follows:

Dynatrace-ActiveGate-Windows-x86-<version>.exe [<parameter1>=<value1>] [<parameter2>=<value2>] ...

  • CA_CERTIFICATE_FILE=<path>
    Absolute path to the location of the certificate to be used when ActiveGate connects to the Dynatrace Server. See Specifying CA certificate during ActiveGate installation

  • CA_CERTIFICATE_PASSWORD_FILE=<path>
    Absolute path to the location of the file containing the certificate password. See Specifying CA certificate during ActiveGate installation

  • DYNATRACE_ACTIVEGATE_SERVER_CONNECTION_TIMEOUT=<seconds>
    Defines the maximum number of seconds (default: 120) that the installer will wait for a connection to the server in order to download additional capabilities.

    • If a timeout occurs during a fresh install or an upgrade, the installation will fail and the ActiveGate service will be disabled. Extend the timeout value and repeat the installation or upgrade.

    • When upgrading, the ActiveGate attempts to make a connection to the Dynatrace Server for typical operation once it's upgraded. If that connection times out, the installer may issue a failure message for a connection timeout. In such cases, if all components have downloaded and installed correctly, ActiveGate will operate normally and continue attempting to connect to the Dynatrace Server. To check the status of the installation, sign in to Dynatrace, select Show deployment status, and then select the Dynatrace ActiveGates tab.

  • --set-network-zone=<name>
    Defines the network zone to which the ActiveGate belongs. An ActiveGate can be part of only one network zone. Not permitted during upgrade. To add a network zone to the existing ActiveGate, use the custom.properties file.

Specifying CA certificate during ActiveGate installation

You can specify the CA proxy certificate (the certificate to be used when ActiveGate connects to the Dynatrace server) during installation. This enables a connection to be established to the server during installation, allowing the ActiveGate installer to download and install any required additional capabilities.

The password is specified as a file from which the password is read. The certificate file is copied into the ActiveGate directory structure, in the customkeys folder of the ssl folder, in the ActiveGate configuration. The password is extracted from the password file and inserted into the custom.properties file in the ActiveGate configuration. It is then encrypted as soon as the ActiveGate service starts.

Linux command example:

[root@host]# Dynatrace-ActiveGate-Linux-1.75.sh --ca-certificate-file=/home/fred/myCert.jks  --ca-certificate-password-file=/home/fred/myPwd.txt

Windows command example:

c:\Dynatrace-ActiveGate-Windows-x86-<version>.exe CA_CERTIFICATE_FILE=D:\Users\Fred\myCert.jks CA_CERTIFICATE_PASSWORD_FILE=D:\Users\Fred\myPwd.txt