Launching TDV Containers (Cluster Nodes) - Using Quick Start Script

Follow these steps to run the script and launch the TDV Cluster container using the quick start script:

1. Download the run_tdv_cluster_container.sh on your instance for launching the Docker container.
2. Run the following command: 
$ ./run_tdv_cluster_container.sh [--dry-run] [--skip-wait] -h # -h for help
[-hv] [--nodes <number>] [-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 [-env <TDV_ARG>=<TDV_VALUE> ... ] [--env-file <file>]  # TDV runtime configuration

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.

 

--nodes <number>

Set the number of TDV cluster node containers to create

Default number of nodes is "1". Minimum number of nodes is "1".

Deletion Settings (Container and Volume)

-d

Delete and stop TDV containers (tdv, cache, and repo) if already exists with same <name>:<tag>.

 

--del-vol

Delete TDV volumes (tdv, cache, and repo) associated with container name <name>:<tag>.

 

Container Settings
 

Set the number of cpus for container (decimal or positive whole number formats)

Default is "2.0". "1.0" cpu is the minimum. Any value below that will result in an error.

Note: cache and repo containers are hardcoded to use 1 cpu only.

-i

Set <name>:<tag> for image to use for container.

default is "tibco/tdv:0.0"

Note: cache and repo image names will be changed to be similar to <name> and <tag> accordingly.

-m (memory)

Set the amount of memory for container.

Default is 7 GB. 4 GB 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.

cache and repo containers are hardcoded to use 2g memory only.

-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 "tdv0.0cluster"

Note: cache and repo container names will be changed to be similar to <name>.

cache and repo container volume names will also be changed to be similar to <name> if --vol is not specified.

-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>=<TDV_VALUE>

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.