Configuration

Overview

This section explains how to completely configure a WorkflowGen upgrade container. Some options are configured as environment variables and others are passed directly to the entry point script. It is available as Linux and Windows images.
This image is not designed to be taken as a base image.

Environment variables

In the case of the upgrade image, the environment variables are arguments that you should not have to change often when upgrading WorkflowGen. That way, you can easily pass a file that defines those variables and reuse it between runs. Here's the list of available environment variables with their descriptions:
Variables
Description & values
WFGEN_UPGRADE_UPDATE_PACKAGES_PATH
A path local to the container where the update packages are located. See the Usage page of this section for more information and examples.
Default value:
  • Windows: C:\wfgen\updatepackages
  • Linux: /mnt/updatepackages
WFGEN_UPGRADE_UPDATE_PACKAGE_FILE_NAME
The name of the update package archive to pick in the update packages path for this upgrade. If no value is provided, <ToVersion>/update.zip will be picked where <ToVersion> is passed as an argument to the container.
WFGEN_DATABASE_CONNECTION_STRING
Required variable
The connection string to the WorkflowGen database. The user passed must have the rights to modify the schema of the database.
WFGEN_UPGRADE_EXCLUDE_FILES
Globally excluded files when copying App_Data files from the update package to your App_Data volume, and when copying wfapps files from the update package to your wfapps volume. The elements in this list must be comma-separated (e.g.myfile.txt,myfile2.txt).
✏️ Notes:
  • There is no distinction between files and folders in the Linux version.
  • Excluded files in Windows version are recursive.
  • You can't use sub-paths in the Windows version.
WFGEN_UPGRADE_EXCLUDE_FOLDERS
Globally excluded folders when copying App_Data files from the update package to your App_Data volume, and when copying wfapps files from the update package to your wfapps volume. The elements in this list must be comma-separated (e.g.myfolder,myfolder).
✏️ Notes:
  • There is no distinction between files and folders in the Linux version.
  • Excluded folders in the Windows version are recursive.
  • You can't use sub-paths in the Windows version.
WFGEN_UPGRADE_APPDATA_EXCLUDE_FILES
Globally excluded files when copying App_Data files from the update package to your App_Data volume. The elements in this list must be comma-separated (e.g.myfile.txt,myfile2.txt).
✏️ Notes:
  • There is no distinction between files and folders in the Linux version.
  • Excluded files in the Windows version are recursive.
  • You can't use sub-paths in the Windows version.
WFGEN_UPGRADE_WFAPPS_EXCLUDE_FILES
Globally excluded files when copying wfapps files from the update package to your wfapps volume. The elements in this list must be comma-separated (e.g.myfile.txt,myfile2.txt).
✏️ Notes:
  • There is no distinction between files and folders in the Linux version.
  • Excluded files in the Windows version are recursive.
  • You can't use sub-paths in the Windows version.
WFGEN_UPGRADE_APPDATA_EXCLUDE_FOLDERS
Globally excluded folders when copying App_Data files from the update package to your App_Data volume. The elements in this list must be comma-separated (e.g. myfolder,myfolder).
✏️ Notes:
  • There is no distinction between files and folders in the Linux version.
  • Excluded folders in the Windows version are recursive.
  • You can't use sub-paths in the Windows version.
WFGEN_UPGRADE_WFAPPS_EXCLUDE_FOLDERS
Globally excluded folders when copying wfapps files from the update package to your wfapps volume. The elements in this list must be comma-separated (e.g. myfolder,myfolder).
✏️ Notes:
  • There is no distinction between files and folders in the Linux version.
  • Excluded folders in the Windows version are recursive.
  • You can't use sub-paths in the Windows version.

Script parameters

Script parameters define options to pass as arguments directly to the upgrade container. These arguments are more likely to be defined each time you run the container, which is why they are not in environment variables. Here's the help file of the entrypoint script. It describes all of the parameters and their groupings, and provides a few examples:
1
NAME
2
/usr/local/bin/docker-entrypoint.ps1
3
4
SYNOPSIS
5
Entrypoint script for the upgrade container.
6
7
8
SYNTAX
9
/usr/local/bin/docker-entrypoint.ps1 -FromVersion <String> -ToVersion <String> [-RemainingArgs <Object>] [-Offline] [<CommonParameters>]
10
11
/usr/local/bin/docker-entrypoint.ps1 -Command -RemainingArgs <Object> [<CommonParameters>]
12
13
/usr/local/bin/docker-entrypoint.ps1 -Help [<CommonParameters>]
14
15
16
DESCRIPTION
17
This script will merge files for the App_Data and wfapps directory between
18
the upgrade package of the destination version and the current installation
19
ones (passed as volumes).
20
21
It will also launch the required SQL migration scripts in order from lowest
22
to highest version. Make sure to use a SQL account that has the proper
23
rights to modify the database tables.
24
25
The "Files", "LogFiles" and "Ws" subfolders in App_Data are always ignored.
26
You don't have to specify them in the exclusion environment variables.
27
28
29
PARAMETERS
30
-FromVersion <String>
31
The current version of WorkflowGen. The starting version of the
32
migration.
33
34
Required? true
35
Position? named
36
Default value
37
Accept pipeline input? false
38
Accept wildcard characters? false
39
40
-ToVersion <String>
41
The version to which you want to migrate the current one.
42
43
Required? true
44
Position? named
45
Default value
46
Accept pipeline input? false
47
Accept wildcard characters? false
48
49
-Command [<SwitchParameter>]
50
Indicates to execute a command inside the container. This is used in
51
conjunction with RemainingArgs
52
53
Required? true
54
Position? named
55
Default value False
56
Accept pipeline input? false
57
Accept wildcard characters? false
58
59
-RemainingArgs <Object>
60
Commands to execute inside the container. If versions are not passed, it is
61
executed at the beginning and then it exits after the execution. If
62
versions are passed, it is executed at the end of the script.
63
64
Required? false
65
Position? named
66
Default value
67
Accept pipeline input? false
68
Accept wildcard characters? false
69
70
-Help [<SwitchParameter>]
71
Get full help for this script.
72
73
Required? true
74
Position? named
75
Default value False
76
Accept pipeline input? false
77
Accept wildcard characters? false
78
79
-Offline [<SwitchParameter>]
80
If provided, the script will not try to download the update package.
81
This means that you have to provide the update package from a volume.
82
83
Required? false
84
Position? named
85
Default value False
86
Accept pipeline input? false
87
Accept wildcard characters? false
88
89
<CommonParameters>
90
This cmdlet supports the common parameters: Verbose, Debug,
91
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
92
OutBuffer, PipelineVariable, and OutVariable.
93
For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).
94
95
NOTES
96
97
98
File name: docker-entrypoint.ps1
99
100
requires -Version 7.0
101
102
-------------------------- EXAMPLE 1 --------------------------
103
104
PS > docker container run -i "..." advantys/workflowgen-upgrade:latest-ubuntu-18.04 -Help
105
106
Displays the full help for the container.
107
108
109
110
111
-------------------------- EXAMPLE 2 --------------------------
112
113
PS > docker container run -i "..." advantys/workflowgen-upgrade:latest-ubuntu-18.04 -Command dir /mnt/appdata
114
115
This executes an arbitrary command inside the container. It can be useful
116
for debugging network issues or other problems prior to the migration.
117
118
119
120
121
-------------------------- EXAMPLE 3 --------------------------
122
123
PS > docker container run -i "..." advantys/workflowgen-upgrade:latest-ubuntu-18.04 -FromVersion 7.14.10 -ToVersion 7.18.2
124
125
This will launch the migration process to upgrade WorkflowGen from version
126
7.14.10 to the 7.18.2 version.
127
128
129
130
131
-------------------------- EXAMPLE 4 --------------------------
132
133
PS > docker container run -i "..." advantys/workflowgen-upgrade:latest-ubuntu-18.04 -FromVersion 7.14.10 -ToVersion 7.18.2 dir /mnt/appdata
134
135
This will launch the migration process to upgrade WorkflowGen from version
136
7.14.10 to the 7.18.2 version. In addition, it will execute an arbitrary command
137
at the end of the migration process.
138
139
Copied!

Using an external configuration manager

Some popular configuration managers support Docker containers out-of-the-box. You would use an external configuration manager only for environment variables definition. Here are a few links to their specific documentation to get you started:

Chef

Ansible

Puppet

Last modified 10mo ago