Launching TDV Containers (Single Node) - Using Quick Start Script
Follow these steps to run the script and launch the TDV container using the quick start script:
| 1. | Download the run_tdv_container.sh on your instance for launching the Docker container. |
Note: For Docker Desktop Window users, you must run “bash run_tdv_container.sh” from a WSL shell if you want to run this script.
| 2. | Run the following command: |
$ ./run_tdv_container.sh [-hv] [--dry-run][--skip-wait]
[-d] [--del-vol] # deletion settings (container and volumes)
[-c <cpus>] [-i <name>:<tag>] [-m <memory>] [-n <network>] [--name <name>] [-p <port>] [--vol <volume>] #container settings
[-e <TDV_ARG> ... ] [--env <TDV_ARG>=<TDV_VALUE> ... ] [--env-file <file>] # TDV runtime configuration [--cluster-node] # cluster options
The table below gives a description of the different parameters used with the script.
|
Parameter |
Description |
Comments |
|
--dry-run |
Show output of execution without actually executing the script. |
|
|
--skip-wait |
Skip wait check for TDV container. |
|
|
-h |
Help for using the script. |
|
|
-v |
Enable verbose mode output. |
|
|
Deletion Settings (Container and Volume) |
||
|
-d |
Delete and stop TDV container if it already exists with same <name>:<tag>. |
|
|
--del-vol |
Delete and stop TDV container if it already exists with same <name>:<tag>. |
|
|
Container Settings |
||
|
Set the number of CPUs for container. |
Use decimal or positive whole number form. Default is "2.0". "1.0" CPU is the minimum. Any value below that will result in an error. |
|
|
-i |
Set <name>:<tag> for image to use for container. |
default is "tibco/tdv:version" |
|
-m (memory) |
Set the amount of memory for container. |
Default is7GB. 4GB is the minimum. Any value below that will result in an error. Note: If this is set and -e TDV_MAX_MEMORY is not, then TDV_MAX_MEMORY defaults to the value mentioned in this option. |
|
-n <network> |
Set network for container. |
Default is "tdv-bridge". If <network> doesn't exist then an error will result. |
|
--name |
Set <name> for container. |
Default is "tdv<version>". |
|
-p <port> |
Set base host port for container |
Default is "9400". |
|
--vol |
Set <volume> for container |
default is "tdv<version>-vol" |
|
TDV Runtime Configuration |
||
|
--env <TDV_ARG>=<TDV_VALUE> |
Pass TDV parameters to container for runtime configuration. |
Required Settings: --env TDV_ADMIN_PASSWORD=<PASSWORD> # Set TDV admin password for all containers (i.e. tdv, cache and repo). or --env TDV_ADMIN_PASSWORD_FILE=<clear text password in file> # (optional) Use file to store TDV admin password. Specified file remapped to /run/secrets/tdv-admin-password in container. Note: only TDV_ADMIN_PASSWORD or TDV_ADMIN_PASSWORD_FILE can be specified. Setting both is not allowed. Optional Settings: --env TDV_BASE_PORT=9400 # (optional) Change TDV Server base port. --env TDV_MAX_MEMORY=7 # (optional) Change TDV Server memory value (GB). If this is set and -m <memory> is not, -m <memory> defaults to TDV_MAX_MEMORY + 1 GB. |
|
-e <TDV_ARG> |
Pass TDV parameters to container for runtime configuration, using defined environment variables. |
The variables used in the argument of this option are environment variables defined and assigned values ahead of the usage. |
|
--env-file <file> |
Pass TDV parameters file to container for runtime configuration. |
|
|
Special Options |
||
|
--cluster-node |
Enable TDV container configuration to be a TDV cluster node. |
Default is to enable a standalone TDV single node. |
Note: By default, the script runs the docker command with the “---restart” option set as “unless-stopped”. It means “Restart the container if it stops, except that when the container is stopped (manually or otherwise), it is not restarted even after Docker daemon restarts.”