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.
...
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 /c "C:\UDMG\UDMG Server\server.ini" /v /v /v 1.4.01 [INFO ] Migration: Starting upgrade migration... [INFO ] Migration: Applying migration 'Bump database version to 1.4.01' |
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 backup 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-proxy-client-service.exe stop C:\UDMG\UDMG Agent\agent\udmg-agent-proxyserver-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:
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
...
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
Agent Proxy Server Configuration
Create a directory
C:\UDMG\UDMG Agent\agent
Install Copy the binaries as
udmg-agent-proxy-client.exe
and binary asudmg-agent-proxy-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 |
---|
|
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:
...
generating the key, export it with OpenSSH format:
Create a configuration file as
C:\UDMG\UDMG Agent\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 |
---|
|
The password key will be used for the client authentication.
...
|
The password key will be used for the client authentication.
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 copy
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 ClientAgent 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 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 |
---|
|
...
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 |
...