For the UDMG Web Transfer Client, please refer to UDMG Web Transfer Client for Linux Installation.

Upgrading Universal Data Mover Gateway

Upgrading UDMG refers to the increase of a currently installed pre-1.4.x Version, Release, or Modification level of UDMG (1.3.x, 1.2.x, 1.1.x, 1.0.x) to UDMG 1.4.x.

...

If you are upgrading an installation of UDMG from any release prior to 1.3.0.0, you must uninstall the older version before installing the new version.
The installation packages, binaries, services, and environment variables have changed and this does not allow for a standard upgrade.

...

• mft_waarp_gateway
• mft_auth_proxy
• nginx
• mft_web_transfer_client
• mft-agent-proxy-client
• mft-agent-proxy-server

...

• udmg-server
• udmg-auth-proxy
• nginx
• udmg-web-transfer
• udmg-agent-server
• udmg-agent-client

...

• WAARP_GATEWAY_ADDRESS
• MFT_AUTH_PROXY_CONFIG
• MFT_AGENT_PROXY_CONFIG

...

• UDMG_SERVER_ADDRESS
• UDMG_AUTH_PROXY_CONFIG
• UDMG_AGENT_CONFIG

It may be required to modify the work and data directories ownership or access rights and to update UDMG Server transfer rules to use paths that are accessible by the 'udmg' user.

The configuration files must be reviewed and compared between the old and new locations.

Special attention is required for the AESpassphrase parameter for UDMG Server. It must be the path for the file that was used by the previous release and must be accessible by the new service user. It is recommended to set an absolute path in the configuration file.

...

The installation process overwrites the current files (exception: the configuration files are kept), this may affect your modifications.

Backing up the configuration files will optimize the time it takes you to get up and running after installing or upgrading.

/opt/udmg/etc/udmg/nginx/udmg.conf
/opt/udmg/etc/udmg/agent/client.toml
/opt/udmg/etc/udmg/agent/server.toml
/opt/udmg/etc/udmg/auth-proxy/config.toml
/opt/udmg/etc/udmg/web-transfer/config.toml
/opt/udmg/etc/udmg-server/server.ini

After upgrading RPM or DEB packages, review the new configuration file templates (with the extension .rpmnew or .dpk-new) and edit the current configuration files to add new parameters or remove deprecated parameters.

...

The UDMG release version is stored in the database to ensure the data structure is compatible with the version of the UDMG components.

After upgrading the component binaries and before starting the UDMG server it is required to perform the release migration step.

The udmg-server "migrate" command handles the necessary database updates and the setting of the internal version.

$ /opt/udmg/bin/udmg-server migrate --help
Usage:
  udmg-server [OPTIONS] migrate [migrate-OPTIONS] [version]

Help Options:
  -h, --help         Show this help message

[migrate command options]
      -c, --config=  The configuration file to use
      -d, --dry-run  Simulate the migration but does not commit the changes
      -l, --list     List Migrations
      -f, --file=    Writes the migration commands into a file instead of sending them to the database
      -v, --verbose  Show verbose debug information. Can be repeated to increase verbosity

[migrate command arguments]
  version:           The version to which the database should be migrated

The configuration file is the one that will be used for the server mode, with the parameter for accessing the target database.

To get the list of supported target version, use the list parameter. The last version is the release version of the udmg-server.

...

For the UDMG Web Transfer Client, please refer to UDMG Web Transfer Client for Linux Installation.

Upgrading Universal Data Mover Gateway

Upgrading UDMG refers to the increase of a currently installed pre-1.4.x Version, Release, or Modification level of UDMG (1.3.x, 1.2.x, 1.1.x, 1.0.x) to UDMG 1.4.x.

Anchor
backup backup

Pre-Installation / Upgrade Backups

The installation process overwrites the current files (exception: the configuration files are kept), this may affect your modifications.

Backing up the configuration files will optimize the time it takes you to get up and running after installing or upgrading.

/opt/udmg/etc/udmg/nginx/udmg.conf
/opt/udmg/etc/udmg/agent/client.toml
/opt/udmg/etc/udmg/agent/server.toml
/opt/udmg/etc/udmg/auth-proxy/config.toml
/opt/udmg/etc/udmg/web-transfer/config.toml
/opt/udmg/etc/udmg-server/server.ini

After upgrading RPM or DEB packages, review the new configuration file templates (with the extension .rpmnew or .dpk-new) and edit the current configuration files to add new parameters or remove deprecated parameters.

Anchor
db_migration db_migration

Release migration

The UDMG release version is stored in the database to ensure the data structure is compatible with the version of the UDMG components.

After upgrading the component binaries and before starting the UDMG server it is required to perform the release migration step.

The udmg-server "migrate" command handles the necessary database updates and the setting of the internal version.

$ /opt/udmg/bin/udmg-server migrate --help
Usage:
  udmg-server [OPTIONS] migrate [migrate-OPTIONS] [version]

Help Options:
  -h, --help         Show this help message

[migrate command options]
      -c, --config=  The configuration file to use
      -d, --dry-run  Simulate the migration but does not commit the changes
      -l, --list     List Migrations
      -f, --file=    Writes the migration commands into a file instead of sending them to the database
      -v, --verbose  Show verbose debug information. Can be repeated to increase verbosity

[migrate command arguments]
  version:           The version to which the database should be migrated

The configuration file is the one that will be used for the server mode, with the parameter for accessing the target database.

To get the list of supported target version, use the list parameter. The last version is the release version of the udmg-server.

$ /opt/udmg/bin/udmg-server migrate -c /opt/udmg/etc/udmg-server/server.ini --list | tail -n 2
1.3.0
1.4.0

It is recommended to set the verbose parameter (3 times) to follow the progress.

$ /opt/udmg/bin/udmg-server migrate -c /opt/udmg/etc/udmg-server/server.ini -vvv 1.4.0
[INFO ] Migration: Starting upgrade migration...
[INFO ] Migration: Applying migration 'Bump database version to 1.4.0'

After the migration, the services for UDMG components can be started.

Upgrading Universal Data Mover Gateway for Linux

...

It is recommended to set the verbose parameter (3 times) to follow the progress.

$ /opt/udmg/bin/udmg-server migrate -c /opt/udmg/etc/udmg-server/server.ini -vvv 1.4.0
[INFO ] Migration: Starting upgrade migration...
[INFO ] Migration: Applying migration 'Bump database version to 1.4.0'

After the migration, the services for UDMG components can be started.

Upgrading Universal Data Mover Gateway for Linux

Upgrading a manual installation

Upgrading a manual installation

Installing and Configuring the Components

Anchor
install_linux_packs install_linux_packs

Installing with Linux software packages

Installing and Configuring the Components

...

Step 1

...

Contact your Stonebranch representative or the Customer Support to receive the software package for the intended operating system.

...

Step 2

...

Install the UDMG packages (RPM or DEB), for example:

sudo rpm -ivh udmg-agent-1.4.0.0+build.5.x86_64.rpm
sudo rpm -ivh udmg-admin-ui-1.4.0.0+build.6.x86_64.rpm
sudo rpm -ivh udmg-admin-ui-nginx-1.4.0.0+build.6.x86_64.rpm
sudo rpm -ivh udmg-auth-proxy-1.4.0.0+build.4.x86_64.rpm
sudo rpm -ivh udmg-server-1.4.0+build.5.x86_64.rpm

...

Step 3

...

Performing a manual installation

UDMG Admin UI

• Extract the distribution file for UDMG Admin UI, under the directory web server root directory, see the NGINX Server configuration.

• Validate that the service is working properly:

UDMG User setup

• Create a dedicated user for running the UDMG modules and to be the owner of the files that will be transferred by UDMG.

UDMG Server

• Create the configuration file /opt/udmg/etc/udmg-server/

...

• server.ini with the following parameters:

...

...

...

Step 4

...

Start the components services.

The exact steps depend on the system architecture and the deployed components, for example:

sudo systemctl start udmg-server
sudo systemctl start udmg-auth-proxy
sudo systemctl start udmg-agent-client
sudo systemctl start udmg-agent-server
sudo systemctl start nginx

Performing a manual installation

UDMG Admin UI

• Extract the distribution file for UDMG Admin UI, under the directory web server root directory, see the NGINX Server configuration.

• Validate that the service is working properly:

UDMG User setup

• Create a dedicated user for running the UDMG modules and to be the owner of the files that will be transferred by UDMG.

UDMG Server

• Create the configuration file /opt/udmg/etc/udmg-server/server.ini with the following parameters:

...

[global]
; The name given to identify this gateway instance. If the the database is shared between multiple gateways, this name MUST be unique across these gateways.
GatewayName = udmg

; Default OS permission for created files
; FilePermissions = 770

...

[paths]
; The root directory of the gateway. By default, it is the working directory of the process.
GatewayHome = /home/udmg

; The directory for all incoming files.
; DefaultInDir = in

; The directory for all outgoing files.
; DefaultOutDir = out

; The directory for all running transfer files.
; DefaultTmpDir = tmp

[log]
; All messages with a severity above this level will be logged. Possible values are TRACE, DEBUG, INFO, WARNING, ERROR and CRITICAL.
Level = DEBUG

; The path to the file where the logs must be written. Special values 'stdout' and 'syslog' log respectively to the standard output and to the syslog daemon.
; LogTo = stdout

; If LogTo is set on 'syslog', the logs will be written to this facility.
; SyslogFacility = local0

; The directory for the log files of the local servers, partners, and transfers. No default, if not provided then the detailed log feature is disabled.
; LogPath = /var/opt/udmg/logs

[admin]
; The address used by the admin interface.
Host = 0.0.0.0

; The port used by the admin interface. If the port is 0, a free port will automatically be chosen.
Port = 18080

; Path of the TLS certificate for the admin interface.
; TLSCert =

; Path of the key of the TLS certificate.
; TLSKey =

; API rate limiter: number of allowed requests per client IP, per second. After that HTTP code 429 is returned. Disabled if 0 or not provided.

...

[database]
; Name of the RDBMS used for the gateway database. Possible values: sqlite, mysql, postgresql, oracle
Type = postgresql

; Address of the database
Address = localhost

; The name of the database
Name = udmg

; The name of the gateway database user
User = udmg_user

; The password of the gateway database user
Password = udmg_password

; Path of the database TLS certificate file.
; TLSCert =

; Path of the key of the TLS certificate file.
; TLSKey =

; The path to the file containing the passphrase used to encrypt account passwords using AES
; AESPassphrase = passphrase.aes

[controller]
; The frequency at which the database will be probed for new transfers
; Delay = 5s

; The maximum number of concurrent incoming transfers allowed on the gateway (0 = unlimited).
; MaxTransferIn = 0

; The maximum number of concurrent outgoing transfers allowed on the gateway (0 = unlimited).
; MaxTransferOut = 0

[sftp]
; Set to true to allow legacy and weak cipher algorithms: 3des-cbc, aes128-cbc, arcfour, arcfour128, arcfour256
; AllowLegacyCiphers = false

cannot decrypt password: cipher: message authentication failed

...

; The directory for the log files of the local servers, partners, and transfers. No default, if not provided then the detailed log feature is disabled.
; LogPath = /var/opt/udmg/logs

; RateLimit = 0

cannot decrypt password: cipher: message authentication failed

• Install the binaries under /opt/udmg/bin:

UDMG Authentication Proxy

• Create a directory under /etc/udmg/:

• Create a configuration file for the service:

Please refer to Authentication Methods for the LDAP and SSO authentication options.

• Install the binary under /opt/udmg/bin:

UDMG

...

Agent Proxy

• Create a directory under under /opt/udmg/etc/udmg/:

Please refer to Authentication Methods for the LDAP and SSO authentication options.

• Install the binary under /opt/udmg/bin:

UDMG Agent Proxy

• Create a directory under /opt/udmg/etc/udmg:

• Create a configuration file for the service:

...

• Install the binaries under /opt/udmg/bin:

Agent Proxy Server Configuration

• Generate a SSH Key for the service:

• Change the agent key permissions:

• Create a configuration file as /opt/udmg/etc/udmg/agent/agent.toml:

The password key will be used for the client authentication.

Agent Proxy Client Configuration

• Create a configuration file as /etc/udmg/agent_proxy/client.toml:

• Install the binaries under /opt/udmg/bin:

Agent Proxy Server Configuration

• Generate a SSH Key for the service:

• Change the agent key permissions:

...

The password key will be used for the client authentication.

Setup the Systemd Services

UDMG Server

Create a new service definition:

[

Unit]
Description=UDMG Server

[Service]
Type=simple
User=udmg
Group=udmg
WorkingDirectory=/home/udmg
ExecStart=/bin/sh -c '/usr/local/bin/udmg-server server -c /opt/udmg/etc/udmg-server/

The password key will be used for the client authentication.

Agent Proxy Client Configuration

...

server.ini' 
Restart=on-failure 

[Install] WantedBy=multi-user.target

• Enable the new service:

The password key will be used for the client authentication.

Setup the Systemd Services

...

• Start the service and check the status:

Make sure that the listen port and network interface is reachable by UDMG Authentication Proxy and UDMG Agent Client.

UDMG Authentication Proxy

• Create a new service definition:

• Enable the new service:

• Start the service and check the status:

Make sure that the listen port and network interface is reachable by NGINX Server.

UDMG

...

Agent Proxy

...

Agent Proxy Server Service

• Create a new service definition:

Description=UDMG

 Agent Proxy server

[Service]

Type=simple

User=udmg

Group=udmg

WorkingDirectory=/home/udmg

Environment="UDMG_

AGENT_CONFIG=/opt/udmg/etc/udmg/

agent/

server.toml"

ExecStart=/bin/sh -c 'exec /opt/udmg/bin/udmg-

agent-proxy-server'

Restart=on-failure

[Install]

WantedBy=multi-user.target

• Enable the new service:

• Start the service and check the status:

...

Be sure that the listen port and network interface is reachable by NGINX Server.UDMG Agent

...

Client .

Agent

...

Proxy Client Service

• Create a new service definition:

• Enable the new service:

• Start the service and check the status:

...

• :

...

Be sure that the listen port and network interface is reachable by UDMG Agent Client .

Agent Proxy Client Service

• Create a new service definition:

• Enable the new service:

• Start the service and check the status:

Ports Configuration

See Network Requirements

Using UDMG with SELinux

...

Ports Configuration

See Network Requirements

Anchor
selinux selinux

Using UDMG with SELinux

Security-Enhanced Linux (SELinux)  is enabled by default on modern RHEL and CentOS servers. Each operating system object (process, file descriptor, file, etc.) is labeled with an SELinux context that defines the permissions and operations the object can perform. In RHEL 6.6/CentOS 6.6 and later, NGINX is labeled with the httpd_t context.

When SELinux is enabled, the UDMG Admin UI will show "403 access denied" and "404 page not found" errors on the landing page and permission errors are reported in the NGINX log files:

• Verify whether SELinux is enforced with the getenforce command. A result of "Enforcing" means that is is enabled and that the steps below are required.

• Modify the file labels so that NGINX (as a process labeled with the httpd_t context) can access the configuration filefiles.

• Modify the file label labels so that NGINX (as a process labeled with the httpd_t context) can access the UDMG Admin UI asset files.

• Allow NGINX to reverse proxy through the authentication proxy UDMG Authentication Proxy by setting the httpd_can_network_connect boolean.

...