Panel | |
---|---|
|
Pre-Installation / Upgrade Backups
The installation process overwrites the current files (exception: the configuration files are kept), effectively removing your modifications. Backing up these files will optimize the time it takes you to get up and running after installing or upgrading.
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.
...
title | Note |
---|
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_PROXY_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 recommened to set an absolute path in the configuration file.
Upgrading UDMG Server
The UDMG release version is stored in the database to ensure the data structure is compatbile 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 necessay 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 |
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.
Code Block |
---|
$ /opt/udmg/bin/udmg-server migrate -c /opt/udmg/etc/udmg-server/server.ini --list | tail -n 5
0.7.1
0.7.1-sb.1
0.7.1-sb.2
0.7.1-sb.3
1.3.0 |
It is recommended to set the verbose parameter (3 times) to follow the progress.
...
Panel | |
---|---|
|
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.
Note | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
If you are upgrading an installation of UDMG from any release prior to 1.3.0.0, you must uninstall the older version before installmysqling the new version.
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. |
Anchor | ||||
---|---|---|---|---|
|
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
db_migration | |
db_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.
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 |
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.
Code Block |
---|
$ /opt/udmg/bin/udmg-server migrate -c /opt/udmg/etc/udmg-server/server.ini --list | tail -n 3
1.3.0
1.4.0
1.4.1 |
It is recommended to set the verbose parameter (3 times) to follow the progress.
Code Block |
---|
$ /opt/udmg/bin/udmg-server migrate -c /opt/udmg/etc/udmg-server/server.ini -vvv 1.4.1
[INFO ] Migration: Starting upgrade migration...
[INFO ] Migration: Applying migration 'Bump database version to 1.4.1' |
After the migration, the services for UDMG components can be started.
Upgrading Universal Data Mover Gateway for Linux
Upgrading with Linux software packages
Step 1 | Contact your Stonebranch representative or the Customer Support to receive the software package for the intended operating system. |
---|---|
Step 2 | Perform the recommended 216891650 of configuration files. |
Step 3 | Stop the components services. The exact steps depend on the system architecture and the deployed components, for example:
|
Step 4 | Upgrade the UDMG packages (RPM or DEB), for example:
|
Step 5 | Review the component configuration files. Note that new configuration file templates (with the extension .rpmnew or .dpk-new) that contains all the allowed parameters are added during the software package upgrade. |
Step 6 | Perform the release migration. |
Step 7 | Start the components services. The exact steps depend on the system architecture and the deployed components, for example:
|
Upgrading a manual installation
Step 1 | Contact your Stonebranch representative or the Customer Support to receive the software package for the intended operating system. |
---|---|
Step 2 | Perform the recommended 216891650 of configuration files. |
Step 3 | Stop the components services. The exact steps depend on the system architecture and the deployed components, for example:
|
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. |
...
After the migration, the service for UDMG Server can be started.
...
Step 6 | Perform the release migration. |
---|---|
Step 7 | Start the components services. The exact steps depend on the system architecture and the deployed components, for example:
|
Installing and Configuring the Components
Anchor | ||||
---|---|---|---|---|
|
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:
|
Step 3 | Review the component configuration files. |
Step 4 | Start the components services. The exact steps depend on the system architecture and the deployed components, for example:
|
Performing a manual installation
UDMG Admin UI
Note |
---|
The following steps require root privilege, make sure that you have the correct access before continuing. |
Extract the distribution file for UDMG Admin UI, under the directory web server root directory, see the NGINX ServiceServer configuration above.
Panel |
---|
|
- The zip file can now be deleted.
- Validate that the service is working properly with the 'curl' command:
Panel |
---|
|
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.
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, describing the option or showing the default value. The parameters must be adapted to your environment, in particular:
|
...
Panel |
---|
|
...
Note | ||
---|---|---|
| ||
AESPassphrase file is generated on first run if it does not exist. It is recommended to set an absolute path, otherwise it is created in the curent current directory. Make sure to set verify the file location during an upgrade and to have a backup. Without the correct AESPassphrase file, the passwords, the keys and the certificates will not be usable.
|
- Install the binaries under /opt/udmg/bin
:
Panel |
---|
|
UDMG Authentication Proxy
Create a directory under
/etc/udmg/:
Panel |
---|
|
- Create a configuration file for the service:
Panel |
---|
|
...
- Install the binary under
/opt/udmg/bin:
Panel |
---|
|
UDMG Agent Proxy
Create a directory under /opt/udmg/etc/udmg
:
Panel |
---|
|
- Install the binaries under
/opt/udmg/bin:
Panel |
---|
|
Agent Proxy Server Configuration
Generate a SSH Key for the service:
...
- Create a configuration file as /opt/udmg/etc/udmg/agent/
agent.toml:
Panel |
---|
|
...
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:
Panel |
---|
|
...
The password key will be used for the client authentication.
Setup the Systemd Services
UDMG Server
Create a new service definition:
Panel |
---|
|
...
- Enable the new service:
Panel |
---|
|
...
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:
Panel |
---|
|
...
- Enable the new service:
Panel |
---|
|
- Start the service and check the status:
Panel |
---|
|
- Start the service and check the status:
Panel |
---|
|
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:
Panel |
---|
|
Panel |
---|
-auth-proxy |
Make sure that the listen port and network interface is reachable by NGINX Server.
UDMG Agent Proxy
Agent Proxy Server Service
...
|
- Enable the new service:
Panel |
---|
|
Panel |
---|
[Unit] Description=UDMG Agent Proxy server
[Service]
Type=simple
User=udmg
Group=udmg
WorkingDirectory=/home/udmg
Environment="UDMG_AGENT_PROXY_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:
Panel |
---|
|
- Start the service and check the status:
Panel |
---|
|
- Start the service and check the status:
Panel |
---|
|
Be sure that the listen port and network interface is reachable by UDMG Agent Client .
Agent Proxy Client Service
Create a new service definition:
Panel |
---|
|
Panel |
---|
|
Be sure that the listen port and network interface is reachable by UDMG Agent Client .
Agent Proxy Client Service
Create a new service definition:
Panel |
---|
|
Panel |
---|
|
- Enable the new service:
Panel |
---|
|
- Start the service and check the status:
Panel |
---|
|
Component Ports
Make sure that all the ports needed are open under your firewall configuration.
Using UDMG with SELinux
...
|
- Enable the new service:
Panel |
---|
|
- Start the service and check the status:
Panel |
---|
|
Ports Configuration
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 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:
Panel |
---|
|
- 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.
Panel |
---|
|
- Modify the file labels so that NGINX (as a process labeled with the
httpd_t
context) can access the configuration filefiles.
Panel |
---|
|
- 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.
Panel |
---|
|
- Allow NGINX to reverse proxy through the authentication proxy UDMG Authentication Proxy by setting the
httpd_can_network_connect
boolean.
Panel |
---|
|
...