Panel | |
---|---|
|
...
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.
Warning |
---|
As a precautionary measure, it is highly recommended that you back up the UDMG database prior to upgrading. |
Upgrading from a pre-2.0 UDMG release
If you are upgrading an installation of UDMG from any release before 2.0.0.0, the following changes must be reviewd reviewed carefully.
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 | ||
---|---|---|
| ||
(1) Local Accounts are converted to Shared Accounts Before this change, a local account was only defined for a given local server and not allowed to have the same account for multiple protocols. For instance, to allow a partner to transfer files over SFTP and FTP, it was required to have both an SFTP and FTP local server, each with their own local account. Each account was then maintained independently, which created additional overhead in configuration and maintenance (password or key updates). A shared Account is created once and can be assigned to several Local Servers, sharing the same login, password, and authentication records. A migrated account has the following characteristics:
(2) New permission for Shared Account management A new User and User Group permission, "sharedAccount", is created for the management of Shared Accounts. |
...
Note | ||
---|---|---|
| ||
The start parameters for several services have changed. Please review the start scripts, especially for manual installation or if the Systemd service files have been edited. The following modules now require a 'start' command in server mode.
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. |
New configuration parameter with UDMG 2.0.0.0
Note | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
UDMG Server
|
Upgrading from a pre-1.3 UDMG release
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. Migration from releases before 1.2.1.1 (0.7.1-sb.3) is not supported anymore.
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.
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.
Note |
---|
The udmg-server "migrate" command handles the necessary database updates and the setting of the internal version.
Code Block | ||
---|---|---|
| ||
The release migration is altering the database structure and requires the database user to have the DDL privileges fore creating, altering and deleting database its own objects. Please refer to Installing a Database section for the requires privileges for each the database vendor. |
The udmg-server "migrate" command handles the necessary database updates and the setting of the internal version.
Code Block |
---|
$ /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 |
...
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: On the main UDMG host:
On the Proxy host: | ||||||||||
Step 4 | Upgrade the UDMG packages (RPM or DEB). For RPM based Linux: On the main UDMG host:
On the Proxy host:
For Debian based Linux: On the main UDMG host:
On the Proxy host:
| ||||||||||
Step 5 | Review the component configuration files. On the main UDMG host: On the Proxy host:
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.
| ||||||||||
Step 6 | Perform the release migration. | ||||||||||
Step 7 | Review the component service configuration files. For instance, the UDMG Authentication Proxy service file (
Note the addition of the
The same applies for the other components:
| ||||||||||
Step 8 | Start the components services. The exact steps depend on the system architecture and the deployed components, for example: On the Proxy host:
On the main UDMG host:
| ||||||||||
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: On the main UDMG host: On the Proxy host: | ||||||||||
Step 4 | Replace the component binaries:
Change ownership/permissions on new files:
Upgrade the Admin UI:
| ||||||||||
Step 5 | Review the component configuration files. Refer to each component installation section below for the list of parameters. | ||||||||||
Step 6 | Perform the release migration. | ||||||||||
Step 7 | Review the component service configuration files. For instance, the UDMG Authentication Proxy service file (
Note the addition of the
The same applies for the other components:
| ||||||||||
Step 8 | Start the components services. The exact steps depend on the system architecture and the deployed components, for example: On the Proxy host:
On the main UDMG host:
| ||||||||||
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 | Install the UDMG packages (RPM or DEB). For RPM based Linux: On the main UDMG host:
On the Proxy host:
For Debian based Linux: On the main UDMG host:
| Step 3 | Review the component configuration files.
|
Step 3 | Review the component configuration files. On the main UDMG host:
On the Proxy host:
| ||
Step 4 | Start the components services. The exact steps depend on the system architecture and the deployed components, for example: On the Proxy host:
On the main UDMG host:
|
...
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 installing version 2.0 or later. |
UDMG
...
Note |
---|
The following steps require root privilege, so make sure that you have the correct access before continuing. |
...
User Setup
Create a dedicated user for running the UDMG modules and to be the owner of the files that are transferred by UDMG.
Panel |
---|
|
UDMG Server
Create the configuration file /opt/udmg/varetc/wwwudmg-server/udmgserver.ini with the following parameters:
Panel |
---|
|
- The zip file can now be deleted.
- If SELinux is enabled on the host, proceed with the steps in the section below: Using UDMG with SELinux
- Validate that the service is working properly, for example with the 'curl' command:
Panel |
---|
|
or with the browser:
UDMG User Setup
Create a dedicated user for running the UDMG modules and to be the owner of the files that are transferred by UDMG.
Panel |
---|
|
UDMG Server
Create the configuration file /opt/udmg/etc/udmg-server/server.ini with the following parameters:
Panel |
---|
|
Note | ||
---|---|---|
| ||
The lines starting with a semicolon ';' or a hash '#' are comments, either describing the option or showing the default value. The parameters must be adapted to your environment, in particular:
|
Note | ||
---|---|---|
| ||
About the log section:
|
Note | ||
---|---|---|
| ||
About the global section: the requested OS file and directory creation permissions are applied after the |
Panel |
---|
; Default OS permission for created directories ; DirPermissions = 770
|
Note | ||
---|---|---|
| ||
The lines starting with a semicolon ';' or a hash '#' are comments, either describing the option or showing the default value. The parameters must be adapted to your environment, in particular:
|
Note | ||
---|---|---|
| ||
About the log section:
|
Note | ||
---|---|---|
| ||
About the global section: the requested OS file and directory creation permissions are applied after the |
Panel |
---|
[admin]
Host = 0.0.0.0
; Threshold before warning for long-running queries, the default is 10 seconds WarningTimeout=10s
|
...
Panel |
---|
|
Please refer to Authentication Methods for the LDAP and SSO authentication options.
- Verify the configuration file with the 'test' command:
Panel |
---|
|
In case of syntax error, a verbose message will indicate the line and the issue:
Panel |
---|
|
- Install the binary under
/opt/udmg/bin:
Panel |
---|
|
...
|
Please refer to Authentication Methods for the LDAP and SSO authentication options.
- Verify the configuration file with the 'test' command:
Panel |
---|
|
In case of syntax error, a verbose message will indicate the line and the issue:
Panel |
---|
|
- Install the binary under
/opt/udmg/bin:
Panel |
---|
|
UDMG Admin UI
Note |
---|
The following steps require root privilege, so make sure that you have the correct access before continuing. |
Extract the distribution files for UDMG Admin UI, under the directory that was configured as the web server root directory during the NGINX Server configuration, The standard value is
/opt/udmg/var/www/udmg
.
Panel |
---|
|
- The zip file can now be deleted.
- If SELinux is enabled on the host, proceed with the steps in the section below: Using UDMG with SELinux
- Validate that the service is working properly, for example with the 'curl' command:
Panel |
---|
|
or with the browser:
UDMG Agent Proxy
- The UDMG Agent Proxy client is installed inside the LAN, typically on the same host as UDMG Server.
- The UDMG Agent Proxy Server is installed on the Proxy host, typically in the DMZ.
Agent Proxy Server Configuration
...
Panel |
---|
|
Panel |
|
Panel |
---|
|
The username and password keys in the '[client]'
section are used for the UDMG Agent Client authentication to the UDMG Agent Server.
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 following modules now require a 'start' command in server mode.
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:
...
Anchor | ||||
---|---|---|---|---|
|
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 |
---|
|
...