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.
...
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 binaries, services, configuration parameters, and environment variables have changed and this does not allow for a standard upgrade.
...
- 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 new paths.
The configuration files must be reviewed and compared between the old and new versions.
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.
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.
...
Panel | |
---|---|
|
For the UDMG Web Transfer Client, please refer to UDMG Web Transfer Client for Windows 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 installing 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 new paths. The configuration files must be reviewed and compared between the old and new versions. 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 | ||||
---|---|---|---|---|
|
Make sure to have a backup of the configuration files as it will optimize the time it takes you to get up and running after upgrading.
C:\UDMG\UDMG Server\server.ini
C:\UDMG\UDMG Auth Proxy\config.toml
C:\UDMG\UDMG Agent\agent\agent.toml
C:\UDMG\UDMG Agent\client\client.toml
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 |
---|
C:\UDMG\UDMG Server>udmg-server migrate /?
Usage:
udmg-server [OPTIONS] migrate [migrate-OPTIONS] [version]
Help Options:
/? Show this help message
/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 |
---|
C:\UDMG\UDMG Server>udmg-server migrate /c "C:\UDMG\UDMG Server\server.ini" /list
0.7.1
0.7.1-sb.1
0.7.1-sb.2
0.7.1-sb.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 |
---|
C:\UDMG\UDMG Server>udmg-server migrate /?
Usage:
udmg-server [OPTIONS] migrate [migrate-OPTIONS] [version]
Help Options:
/? Show this help message
/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 |
---|
C:\UDMG\UDMG Server>udmg-server migrate /c "C:\UDMG\UDMG Server\server.ini" /list
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.
Code Block |
---|
C:\UDMG\UDMG Server>udmg-server migrate /c "C:\UDMG\UDMG Server\server.ini" /v /v /v 1.3.0.0
[INFO ] Migration: Starting upgrade migration...
[INFO ] Migration: Applying migration 'Fix the 'sb_generic_group_join' table foreign keys'
[INFO ] Migration: Applying migration 'Fix the 'sb_user_group_member' table foreign keys'
[INFO ] Migration: Applying migration 'Fix the 'sb_user_group_permission' table foreign keys'
[INFO ] Migration: Applying migration 'Bump database version to 0.7.1-sb.2'
[INFO ] Migration: Applying migration 'Add description under 'local_agents' and 'remote_accounts''
[INFO ] Migration: Applying migration 'Add a 'revoked' column to the 'crypto_credentials' table'
[INFO ] Migration: Applying migration 'Bump database version to 0.7.1-sb.3'
[INFO ] Migration: Applying migration 'Add a 'email' column to the 'users' table'
[INFO ] Migration: Applying migration 'Create the 'access_token' table'
[INFO ] Migration: Applying migration 'Bump database version to 1.3.0' |
...
Server>udmg-server migrate /c "C:\UDMG\UDMG Server\server.ini" /v /v /v 1.4.1
[INFO ] Migration: Starting upgrade migration...
[INFO ] Migration: Applying migration 'Bump database version to 1.4.1' |
After the migration, the service for UDMG Server can be started.
Upgrading Universal Data Mover Gateway for Windows
Step 1 | Contact your Stonebranch representative or the Customer Support to receive the software binaries. |
---|---|
Step 2 | Perform the recommended 216891684 of configuration files. |
Step 3 | Stop the components services. The exact steps depend on the system architecture and the deployed components, for example: C:\UDMG\nginx>nginx-service.exe stop C:\UDMG\UDMG Auth Proxy\udmg-auth-proxy-service.exe stop C:\UDMG\UDMG Server\udmg-server-service.exe stop C:\UDMG\UDMG Agent\client\udmg-agent-client-service.exe stop C:\UDMG\UDMG Agent\agent\udmg-agent-server-service.exe stop |
Step 4 | Upgrade the UDMG component binaries by copying the release files to their target location:
Upgrade the UDMG Admin UI:
|
Step 5 | Review the component configuration files. |
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
...
Panel |
---|
|
- The zip file can now be deleted.
- Validate that the service is working properly with the 'curl' command:
Panel |
---|
|
...
Create a directory
C:\UDMG\
UDMG Server
Install Copy the binaries as
andudmg-server.exe
udmg-client.exe
- Create the configuration file
C:\UDMG\
UDMG Server\server.ini
Note | ||
---|---|---|
| ||
The lines starting with a colon ';' or a hash '#' are comments, describing the option or showing the default value. The parameters must be adapted to your environment, in particular:
|
...
Panel |
---|
|
...
Create a directory
C:\UDMG\UDMG
Auth Proxy
Install Copy the binaries binary as
udmg-auth-proxy.exe
Create the configuration file
C:\UDMG\UDMG Auth Proxy\config.toml
Panel |
---|
|
Please refer to Authentication Methods for the LDAP and SSO authentication options.
UDMG Agent Proxy
...
|
Please refer to Authentication Methods for the LDAP and SSO authentication options.
UDMG Agent Proxy
Agent Proxy Server Configuration
Create a directory
C:\UDMG\UDMG Agent\agent
Copy the binary as
udmg-agent-server.exe
Generate a SSH Key for the service.
For example with the ssh-keygen tool that is provided by Windows OpenSSH tools (Key-based authentication in OpenSSH for Windows), or by 3PP packages like Copssh - OpenSSH for Windows or Portable Git for Windows
Panel |
---|
|
...
Install the binaries as udmg-agent-proxy-client.exe
and udmg-agent-proxy-server.exe
Agent Proxy Server Configuration
Generate a SSH Key for the service.
For example with the ssh-keygen tool that is provided by Windows OpenSSH tools (Key-based authentication in OpenSSH for Windows), or by 3PP packages like Copssh - OpenSSH for Windows or Portable Git for Windows
Panel |
---|
|
If OpenSSH is not installed or not available, the PuTTY tool can be used instead.
Use PuTTYgen to generate a key pair for the agent, more detailed instructions can be found here: Using public keys for SSH authentication
After generating the key, export it with OpenSSH format:
Create a configuration file as
C:\UDMG\UDMG Agent\
...
If OpenSSH is not installed or not available, the PuTTY tool can be used instead.
Use PuTTYgen to generate a key pair for the agent, more detailled instructions can be found here: Using public keys for SSH authentication
After generating the key, export it with OpenSSH format:
Create a configuration file as
C:\UDMG\UDMG Agent\agent\agent.toml
agent\agent.toml
Note | ||
---|---|---|
| ||
The Windows paths in the TOML configuration file must be specified either in UNIX-style, using forward slashes '/', or with double backslashes '\\'. For example:
|
Panel |
---|
|
...
Agent Proxy Client Configuration
Create a directory "
C:\UDMG\UDMG Agent\client"
Copy the binary as
udmg-agent-client.exe
Create a configuration file as
"
C:\UDMG\UDMG Agent\client\client.toml"
Panel |
---|
|
...
The UDMG components can be installed as Windows service with the WinSw WinSW tool.
NGINX Server
- Download WinSW and copyy
winsw.exe
underC:\UDMG\nginx
with the following name:nginx-service
.exe
- Create a new service definition file:
nginx-service
.yml
...
Panel |
---|
|
...
Panel |
---|
|
Be sure that the UDMG Server API listen port (8080 by default) and network interface is are reachable by UDMG Authentication Proxy and UDMG Agent Client. Refer to Ports Configuration for more information.
UDMG Authentication Proxy
...
Panel |
---|
|
Be sure that the UDMG Authentication Proxy API listen port (5000 by default) and network interface is are reachable by NGINX ServerNGINX Server. Refer to Ports Configuration for more information.
UDMG Agent Proxy
Agent Proxy Server Service
- Download WinSW and copy
winsw.exe
underC:\UDMG\UDMG Agent\agent
with the following name:udmg-agent-proxy-server-service.exe
- Create a new service definition file:
udmg-agent-proxy-server-service
.yml
Panel |
---|
|
...
Panel |
---|
|
Be sure that the UDMG Agent Proxy Server listen port (2222 by default) and network interface is are reachable by UDMG Agent Client. Refer to Ports Configuration for more information.
Agent Proxy Client Service
- Download WinSW and copy
winsw.exe
underC:\UDMG\UDMG Agent\client
with the following name:udmg-agent-proxy-client-service.exe
- Create a new service definition file:
udmg-agent-proxy-client-service
.yml
Panel |
---|
|
- Start the service and check the status:
Panel |
---|
|
...
Ports
...
Configuration
See Network Requirements.
References
This document references the following documents.
Name | Location |
---|---|
PostgreSQL Client Authentication | |
PostgreSQL Password Authentication | |
Guide on setting up Nginx as a service on Windows | https://github.com/sheggi/win-service-nginx |
...