Configuration
Last updated
Last updated
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.
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:
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:
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:
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.