HCL Workload Automation is a fully-featured version of the Console component of HCL Workload Automation with the following restriction:
The HCL Workload Automation container has the following prerequisites:
Create a DB instance and schema
For example, use the following command to create a DB2 instance and schema:
docker run --rm DOCKER.REGISTRY@hcl-workload-automation-console:9.5.0.03 cat /opt/dwc/tools/create_database.sql >create_database.sql
Copy the “create_database.sql” file on the machine where the DB2 has been installed, perform a login as administrator and run the following command:
db2 -tvf create_database.sql
Download and install Docker compose. We recommend version 2.3 in order to take advantage of named volumes.
You can access the console container image from the Entitled Registry:
docker login -u <your_username> -p <your_entitled_key> hclcr.ioIf you want to start the container via Docker Compose, use the following command to clone the current repository:
git clone https://github.com/WorkloadAutomation/hcl-workload-automation-docker-composeIf you do not have GitHub installed in your environment, download the ZIP file from the main page of the repository:
Click on "Code" and then select "Download ZIP"In the directory where the docker-compose.yml file has been located, you can start the container by running the following command:
docker-compose up -d wa-console
Once the command has been launched, be sure that the container is started by checking the docker logs; the container configuration is completed when the “wa console started” message is shown.
Note: Internal ports are predefined and must not be changed. External ports can be customized.
Note: To use custom certificates, you need to modify the volume <path_on_host_containing_certs>:/opt/wautils/certs writing the path of the directory that contains your certificates at the place of <path_on_host_containing_certs>. In the defined folder you need to add the following certificates:
- TWSServerTrustFile.jks
- TWSServerKeyFile.jks
- ltpa.keys
Note: If you set on true the “DB_SSL_CONNECTION” setting, you must add the following certificates to the volume that stores customized certificates: TWSServerTrustFile.jks and TWSServerTrustFile.jks.pwd
“TWSServerTrustFile.jks.pwd” file must contain the password for “TWSServerTrustFile.jks” file.
Example of variable: - LICENSE=ACCEPT
You can find the other available variables in the following tables:
| Variable | Description | Mandatory | Example |
|---|---|---|---|
| LICENSE | Use ACCEPT to agree to the license agreement | yes | notaccept |
| WA_PASSWORD | The wauser password to connect to the Console (the same password used for the installation of the Console) | yes | |
| LANG | The language of the container internal system. The supported language are: en (English), de (German), es (Spanish), fr (French), it (Italian), ja (Japanese), ko (Korean), pt_BR (Portuguese (BR)), ru (Russian), zh_CN (Simplified Chinese) and zh_TW (Traditional Chinese) | yes | en |
| TZ | If used, it sets the TZ operating system environment variable | no | Europe/Rome |
| ENGINE_HOSTNAME | The hostname or IP address of the engine where the server is installed. Configuring this setting, the engine hostname field on the UI is automatically filled in | no | wa-server |
| ENGINE_PORT | The port on which the engine - where the server is installed - is contacted by the console. Configuring this setting, the engine port field on the UI is automatically filled in | no | 31116 |
| ENGINE_USER | The user who accesses the engine where the server is installed. Configuring this setting, the engine user field on the UI is automatically filled in | no | wauser |
The following variables are valid only if you set a database different from Derby, such as DB2, Informix (IDS), MSSQL or Oracle. Use Derby database only for demo or test purposes.
| Variable | Description | Mandatory | Example |
|---|---|---|---|
| DB_TYPE | The preferred remote database server type (i.e. DERBY, DB2, ORACLE, MSSQL or IDS). The default value is DB2 | yes | DB2 |
| DB_HOSTNAME | The Hostname or the IP Address of the database server | yes | |
| DB_PORT | The port of the database server. The defualt value is 50000 | yes | 50000 |
| DB_NAME | Depending on the database type the name is different; enter the name of the Console’s database for DB2/Informix/MSSQL, enter the Oracle Service Name for Oracle. The default value is DWC | yes | DWC |
| DB_USER | The database user who accesses the Console tables on the database server. The default value is db2inst1 | yes | db2inst1 |
| DB_PASSWORD | The password of the database user who accesses the Console tables on the database server | yes | |
| DB_ADMIN_USER | The database user administrator who accesses the Console tables on the database server. The default value is db2inst1 | yes | db2inst1 |
| DB_ADMIN_PASSWORD | The password of the database user administrator who accesses the Console tables on the database server | yes | |
| DB_SSL_CONNECTION | If true, SSL connection is used to connect to remote database server. Valid only for DB2 | no | true |
| DB_TS_NAME | The name of the DATA table space. The default value is TWS_DATA | no | TWS_DATA |
| DB_TS_PATH | The path of the DATA table space. The default value is TWS_DATA | no | TWS_DATA |
| DB_SBSPACE | The name of the SB table space. Valid only for IDS. By default, leave it empty | no | |
| DB_ENABLE_PARTITIONING_OPTION | If true, the Oracle Partitioning feature is enabled. Valid only for Oracle, it is ignored by other databases. The default value is true | no | true |
To enable SSO between console and server, LTPA tokens must be the same. The following procedure explains how to create LTPA tokens to be shared between server and console (this procedure must be run only once and not on both systems).
To create new LTPA token, launch the following command:
docker run -i --rm -v <host_dir>:/output hcl-workload-automation-console:9.5.0.03 /opt/wautils/wa_create_ltpa_keys.sh -p <keys_password>
where:
The “ltpa.keys” and “wa_ltpa.xml” files are created in the local folder .
The “ltpa.keys” file must be placed into the volume that stores customized SSL certificates (on both server and console charts).
In both server and console charts, useCustomizedCert property must be set on “true”.
The “wa_ltpa.xml” file must be placed in the volume that stores all custom liberty configuration (on both server and console charts).
This image is officially supported on Docker version 1.11.0 and later.
Support for versions earlier than 1.11.0, is provided on a best-effort basis.
Please see the Docker installation documentation for details on how to upgrade your Docker daemon.
The HCL Workload Automation container has the following limitations:
For additional information on using HCL Workload Automation, see the online documentation. For technical issues, search for Workload Scheduler or Workload Automation on StackOverflow.
The Dockerfile and associated scripts are licensed under the Apache License 2.0. HCL Workload Automation is licensed under the HCL International Program License Agreement. This license for HCL Workload Automation can be found online. Note that this license does not permit further distribution.