...
Upgrading Universal Data Mover Gateway
Upgrading UDMG refers to the increase of a currently installed pre-2.0.x Version, Release, or Modification level of UDMG (1.5.x, 1.4.x, 1.3.x, 1.2.x) to UDMG 2.0.x.
| Note |
|---|
|
Starting with UDMG version 2.0, a license key must be provided to enable file transfers. Contact your Stonebranch representative or Customer Support to receive the license key before upgrading to version 2.0 or later.
|
| Note |
|---|
|
If you are upgrading an installation of UDMG from any release before 2.0.0.0, the start parameters for several services have changed. Please review them carefully, especially for manual installation or if the Systemd service files have been edited.
The service configuration is updated automatically for a standard upgrade with the provided Linux packages. The following modules now require a 'start' command in server mode. udmg-auth-proxy start -f configuration_file
udmg-agent-client start -f configuration_file
udmg-agent-server start -f configuration_file
Without it, they will only display the command line usage information. In addition, a 'test' command allows the syntax of the configuration file to be verified without starting the server. |
| Note |
|---|
|
If you are upgrading an installation of UDMG from any release before 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.
| Category | Prior releases | Release 1.3 |
|---|
| user and group | mft:mft | udmg:udmg | | binaries | /usr/local/bin | /opt/udmg/bin | | configuration files | /etc/mft | /opt/udmg/etc | | log files | /var/opt/udmg/logs | /var/opt/udmg/logs | | UDMG Admin UI assets | /opt/udmg/var/www/mft | /opt/udmg/var/www/udmg | | Services | - 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
| | Environment variables | - 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. |
...
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 optimizes 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.
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.
...
Upgrading with Linux Software Packages
Step 1 | Contact your Stonebranch representative or Customer Support to receive the software package for the intended operating system. |
|---|
Step 2 | Perform the recommended backup of configuration files. |
|---|
Step 3 | Stop the components services. The exact steps depend on the system architecture and the deployed components, for example: sudo systemctl stop nginx
sudo
sudo
sudo
sudo
|
|---|
Step 4 | Upgrade the UDMG packages (RPM or DEB), for example: sudo rpm -Uvh udmg-agent-2.0.0.0.build.7.x86_64.rpm
sudo rpm -Uvh udmg-admin-ui-2.0.0.0.build.4.x86_64.rpm
sudo rpm -Uvh udmg-admin-ui-nginx-2.0.0.0.build.4.x86_64.rpm
sudo rpm -Uvh udmg-auth-proxy-2.0.0.0.build.15.x86_64.rpm
sudo rpm -Uvh --force udmg-server-2.0.0.build.3.x86_64.rpm
|
|---|
| Step 5 | Review the component configuration files.
Refer to each component installation section below for the list of parameters.
/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-server/server.ini Note that new configuration file templates (with the extension .rpmnew or .dpk-new) that contain all the allowed parameters are added during the software package upgrade.
| Note |
|---|
| The default upstream port to reach the UDMG Authentication Proxy is set to 5775 in /opt/udmg/etc/udmg/nginx/udmg.conf starting from version 1.5.0.1. Please review and make sure that the same port (either 5000 or 5775) is also defined in /opt/udmg/etc/udmg/auth-proxy/config.toml . |
|
|---|
| Step 6 | Perform the release migration. |
|---|
| Step 7 | Review the component service configuration files. For instance, the UDMG Authentication Proxy service file (/etc/systemd/system/udmg-auth-proxy.service) was installed with these parameters in version 1.5 | Code Block |
|---|
| title | udmg-auth-proxy.service (Version 1.5) |
|---|
| [Unit]
Description=Stonebranch UDMG Authentication Proxy
[Service]
Type=simple
User=udmg
Group=udmg
WorkingDirectory=/home/udmg
Environment="UDMG_AUTH_PROXY_CONFIG=/opt/udmg/etc/udmg/auth-proxy/config.toml"
ExecStart=/bin/sh -c 'exec /opt/udmg/bin/udmg-auth-proxy'
Restart=on-failure
SyslogIdentifier=udmg-auth-proxy
SyslogFacility=local0
[Install]
WantedBy=multi-user.target
|
Note the addition of the start command on the ExecStart directive in the version 2.0: | Code Block |
|---|
| title | udmg-auth-proxy.service (Version 2.0) |
|---|
| [Unit]
Description=Stonebranch UDMG Authentication Proxy
[Service]
Type=simple
User=udmg
Group=udmg
WorkingDirectory=/home/udmg
Environment="UDMG_AUTH_PROXY_CONFIG=/opt/udmg/etc/udmg/auth-proxy/config.toml"
ExecStart=/bin/sh -c 'exec /opt/udmg/bin/udmg-auth-proxy start'
Restart=on-failure
SyslogIdentifier=udmg-auth-proxy
SyslogFacility=local0
[Install]
WantedBy=multi-user.target |
The same applies for the other components: /etc/systemd/system/udmg-auth-proxy.service
/etc/systemd/system/udmg-agent-client.service
/etc/systemd/system/udmg-agent-server.service
|
|---|
| Step 8 | Start the components services. The exact steps depend on the system architecture and the deployed components, for example: sudo
sudo start udmg-auth-proxy
sudo start udmg-agent-client
sudo start udmg-agent-server
sudo
|
|---|
| Step 9 | Verify or apply the license; see UDMG Licensing. |
|---|
...
Step 1 | Contact your Stonebranch representative or Customer Support to receive the software package for the intended operating system. |
|---|
Step 2 | Perform the recommended backup of configuration files. |
|---|
Step 3 | Stop the components services. The exact steps depend on the system architecture and the deployed components, for example: sudo
sudo
sudo
sudo
sudo
|
|---|
Step 4 | Replace the component binaries: sudo
sudo
sudo
Change ownership/permissions on new files: sudo
sudo
Upgrade the Admin UI: sudo
sudo
sudo
|
|---|
| Step 5 | Review the component configuration files. Refer to each component installation section below for the list of parameters.
/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-server/server.ini |
|---|
| Step 6 | Perform the release migration. |
|---|
| Step 7 | Review the component service configuration files. For instance, the UDMG Authentication Proxy service file (/etc/systemd/system/udmg-auth-proxy.service) was installed with these parameter in version 1.5 | Code Block |
|---|
| title | udmg-auth-proxy.service (Version 1.5) |
|---|
| [Unit]
Description=Stonebranch UDMG Authentication Proxy
[Service]
Type=simple
User=udmg
Group=udmg
WorkingDirectory=/home/udmg
Environment="UDMG_AUTH_PROXY_CONFIG=/opt/udmg/etc/udmg/auth-proxy/config.toml"
ExecStart=/bin/sh -c 'exec /opt/udmg/bin/udmg-auth-proxy'
Restart=on-failure
SyslogIdentifier=udmg-auth-proxy
SyslogFacility=local0
[Install]
WantedBy=multi-user.target
|
Note the addition of the start command on the ExecStart directive in the version 2.0: | Code Block |
|---|
| title | udmg-auth-proxy.service (Version 2.0) |
|---|
| [Unit]
Description=Stonebranch UDMG Authentication Proxy
[Service]
Type=simple
User=udmg
Group=udmg
WorkingDirectory=/home/udmg
Environment="UDMG_AUTH_PROXY_CONFIG=/opt/udmg/etc/udmg/auth-proxy/config.toml"
ExecStart=/bin/sh -c 'exec /opt/udmg/bin/udmg-auth-proxy start'
Restart=on-failure
SyslogIdentifier=udmg-auth-proxy
SyslogFacility=local0
[Install]
WantedBy=multi-user.target |
The same applies for the other components: /etc/systemd/system/udmg-auth-proxy.service
/etc/systemd/system/udmg-agent-client.service
/etc/systemd/system/udmg-agent-server.service
|
|---|
| Step 8 | Start the components services. The exact steps depend on the system architecture and the deployed components, for example: sudo
sudo start udmg-auth-proxy
sudo start udmg-agent-client
sudo start udmg-agent-server
sudo
|
|---|
| Step 9 | Verify or apply the license; see UDMG Licensing. |
|---|
...
Please refer to Authentication Methods for the LDAP and SSO authentication options.
- Verify the configuration file with the 'test' command:
| Panel |
|---|
$ udmg-auth-proxy test -f /opt/udmg/etc/udmg/auth_proxy/config.toml
level=info TS=2024-05-06T10:37:30.263799884Z Configuration="Loading configuration file: /opt/udmg/etc/udmg/auth_proxy/config.toml."
level=info TS=2024-05-06T10:37:30.269199501Z Configuration="Test Pass"
|
In case of syntax error, a verbose message will indicate the line and the issue:
| Panel |
|---|
$ udmg-auth-proxy test -f /opt/udmg/etc/udmg/auth_proxy/config.toml
level=info TS=2024-05-06T10:37:30.263799884Z Configuration="Loading configuration file: /opt/udmg/etc/udmg/auth_proxy/config.toml."
level=warn TS=2024-05-06T10:37:30.699063132Z Configuration=File Error="toml: line 83 (last key \"service.udmg\"): Key 'service.udmg.settings' has already been defined."
level=error TS=2024-05-06T10:37:30.699096632Z Configuration="Error reading the configuration file." err="configuration file invalid structure"
|
- Install the binary under
/opt/udmg/bin:
...
Setup the Systemd Services
| Note |
|---|
|
If you are upgrading an installation of UDMG from any release before 2.0.0.0, the start parameters for several services have changed. Please review them carefully, especially for manual installation or if the Systemd service files have been edited.
The service configuration is updated automatically for a standard upgrade with the provided Linux packages. The following modules now require a 'start' command in server mode. udmg-auth-proxy start -f configuration_file
udmg-web-transfer start -f configuration_file
udmg-agent-client start -f configuration_file
udmg-agent-server start -f configuration_file
Without it, they will only display the command line usage information. In addition, a 'test' command allows the syntax of the configuration file to be verified without starting the server. |
UDMG Server
Create a new service definition:
...
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 shows "403 access denied" and "404 page not found" errors on the landing page, and permission errors are reported in the NGINX log files:
| Panel |
|---|
...
2023/09/19 12:51:38 [error] 108236#108236: *1 "/opt/udmg/var/www/udmg/index.html" is forbidden (13: Permission denied), client: 127.0.0.1, server: localhost, request: "GET / HTTP/1.1", host: "localhost
...
|
...