AWS Thinkbox Deadline

https://docs.thinkboxsoftware.com/products/deadline/latest/
Admin
AWS Thinkbox Deadline is a comprehensive render management solution designed to manage and optimize...
Tokens:594,184
Snippets:3,965
Trust Score:9.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Start MongoDB Service - Linux

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/install-db-repo-manual-db-install

Command to start the Deadline MongoDB database service on Linux using the `service` command. The `[VERSION]` placeholder needs to be replaced with the specific Deadline version.

```bash
sudo service deadline[VERSION]db start
```

--------------------------------

### MongoDB Configuration File Example

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/install-db-repo-manual-db-install

A sample MongoDB configuration file for Deadline. This file defines logging, network ports, storage paths, and security settings. Ensure to replace placeholders like '[PathToMongoDB]' and '[DB_PORT]' with your specific values.

```yaml
#MongoDB config file

systemLog:
  destination: file
  # Mongo DB's output will be logged here.
  path: [PathToMongoDB]/data/logs/log.txt
  # Default to quiet mode to limit log output size. Set to 'false' when debugging.
  quiet: true
  # Increase verbosity level for more debug messages (0-5)
  verbosity: <integer>

net:
  # Port MongoDB will listen on for incoming connections
  port: [DB_PORT]
  ipv6: true
  ssl:
    # SSL/TLS options
    mode: disabled
    # If enabling TLS, the below options need to be set:
    #PEMKeyFile:
    #CAFile:

storage:
  # Database files will be stored here
  dbPath: [PathToMongoDB]/data
  engine: wiredTiger

# Enable sharding
#sharding:
  #clusterRole:
  #configDB:

# Setup replica set with given replica set name
#replication:
  #replSetName:

security:
  authorization: disabled

```

--------------------------------

### Start MongoDB Service - Windows

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/install-db-repo-manual-db-install

Command to start the Deadline MongoDB database service on Windows. Requires administrator privileges. The `[VERSION]` placeholder needs to be replaced with the specific Deadline version.

```powershell
sc start Deadline[VERSION]DatabaseService
```

--------------------------------

### Start MongoDB Service - macOS

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/install-db-repo-manual-db-install

Command to load the Deadline MongoDB database service on macOS using `launchctl`. The `[VERSION]` placeholder needs to be replaced with the specific Deadline version.

```bash
launchctl load /Library/LaunchDaemons/org.mongodb_Deadline[VERSION]DatabaseService.plist
```

--------------------------------

### MongoDB Installation Paths for Deadline

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/install-db-repo-manual-db-install

This snippet shows the recommended directory structures for installing MongoDB on different operating systems to ensure compatibility with Deadline. The `[VERSION]` placeholder should be replaced with the major version of Deadline being installed.

```powershell
C:\DeadlineDatabase[VERSION]\mongo
```

```bash
/Applications/Thinkbox/DeadlineDatabase[VERSION]/mongo
```

```bash
/opt/Thinkbox/DeadlineDatabase[VERSION]/mongo
```

--------------------------------

### Get Help for Deadline Repository Installer (macOS)

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/install-db-repo

This command displays all available command-line options for the Deadline Repository installer on macOS. It is run using the `installbuilder.sh` script located within the macOS installer package and the `--help` flag. This is useful for understanding all customization possibilities.

```bash
/DeadlineRepository-X.X.X.X-osx-installer.app/Contents/MacOS/installbuilder.sh --help

```

--------------------------------

### Start Deadline Launcher Service

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/command-line-arguments-clients

Starts the Deadline Launcher Service on the specified machine. This command requires the Deadline Launcher Service to be installed.

```bash
deadlinecommand -StartLauncherService
```

--------------------------------

### Get Help for macOS Submitter Installer

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/install-submitters

Display all available command-line options for the Deadline Submitter installer on macOS. This command is run directly on the installbuilder.sh script located within the application bundle. It's crucial for understanding the full range of installation parameters.

```bash
/Maya-submitter-osx-installer.app/Contents/MacOS/installbuilder.sh --help

```

--------------------------------

### Manual Generation Submission Script Setup (Lua)

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/app-generation

Instructions for manually installing the Deadline Generation submission script by copying a Lua file and modifying the Generation configuration file.

```lua
-- Copy the file:
-- [Repository]\submission\Generation\Client\DeadlineGenerationClient.lua to [Generation Install Folder]\scripts\generation
```

```cfg
SCRIPT_FARMSUBMIT="scripts\generation\DeadlineGenerationClient.lua"
```

--------------------------------

### Install libffi.so.6 on RHEL 9 / CentOS 9

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/system-requirements

This example provides steps to manually install the `libffi.so.6` library on RHEL 9 and CentOS 9 systems, which is sometimes required for Deadline Client Applications to function correctly. It involves obtaining the RPM, extracting it, and creating a symbolic link.

```bash
# Obtain a copy of libffi.so.6 rpm
# Extract rpm, for example "rpm2cpio libffi.so.6.x86_64.rpm | cpio -idmv"
# Copy "libffi.so.6" to some location, for example to "/opt/libffi.so.6"
# Created a symlink in "/usr/lib64": "ln -s /usr/lib64/libffi.so.6 <libffi.so.6 location>"
# If you have put the library into "/opt" then the command should look like "ln -s /usr/lib64/libffi.so.6 /opt/libffi.so.6"
```

--------------------------------

### Linux Database Script File - Deadline

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/install-db-repo-manual-db-install

This shell script handles the starting, stopping, and status checking of the Deadline database service on Linux systems. It utilizes standard service management commands and logs events.

```bash
rh_status_q(){
        rh_status >/dev/null 2>&1

        return $?
}
log_event "'$1' invoked..."

EXIT_CODE=1
# See how we were called.
case "$1" in
        start)
                start

                EXIT_CODE=$?
                ;;
        stop)
                stop

                EXIT_CODE=$?
                ;;
        restart|force-reload)
                restart

                EXIT_CODE=$?
                ;;
        status)
                rh_status

                EXIT_CODE=$?
                ;;
        condrestart|try-restart)
                if ! rh_status_q; then
                        log_event "The ${LONGNAME} is not currently running; restart will not be performed." true

                        EXIT_CODE=0
                else
                        restart

                        EXIT_CODE=$?
                fi
                ;;
        *)
                log_event "Usage: $0 {start|stop|status|restart|condrestart|try-restart|force-reload}" true
                EXIT_CODE=3
esac

log_event "'$1' operation finished with exit code '$EXIT_CODE'."
exit $EXIT_CODE
```

--------------------------------

### Install 3ds Max Startup Script

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/app-vray-dbr

Copies the SMTDSetup.ms script to the 3ds Max startup scripts directory, ensuring Deadline functionality is loaded on application launch.

```shell
cp [Repository]/submission/3dsmax/Client/SMTDSetup.ms to [3ds Max Install Directory]/scripts/Startup/SMTDSetup.ms
```

--------------------------------

### Example Deadline LauncherNew Log Output

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/logs

Illustrates a typical log output from a Deadline LauncherNew process. These logs provide insights into the self-upgrade procedure, including file copying, decompression, and the launch of various Deadline components.

```text
2015-08-27 23:57:55:  BEGIN - mbp.local\owenm
2015-08-27 23:57:55:  Deadline Launcher 7.2 [v7.2.0.14 R  (dbc900863)]
2015-08-27 23:57:55:  deadlinelaunchernew is running
2015-08-27 23:57:55:  deadlinelauncher has exited, proceeding with self upgrade
2015-08-27 23:58:00:  Reading in bootstrap ini settings...
2015-08-27 23:58:00:  Bootstrap file: /private/var/folders/7y/471pt3h95cz1c6557kgzqkj80000gn/T/LauncherBootstrap/bootstrap.ini
2015-08-27 23:58:00:  Copying /Applications/Thinkbox/DeadlineRepository7/bin/Mac/bin.zip to /private/var/folders/7y/471pt3h95cz1c6557kgzqkj80000gn/T/LauncherBootstrap/bin.zip
2015-08-27 23:58:00:  Copying /Applications/Thinkbox/DeadlineRepository7/bin/Mac/Version to /private/var/folders/7y/471pt3h95cz1c6557kgzqkj80000gn/T/LauncherBootstrap/Version
2015-08-27 23:58:00:  Decompressing /private/var/folders/7y/471pt3h95cz1c6557kgzqkj80000gn/T/LauncherBootstrap/bin.zip to /Applications/Thinkbox/Deadline7/Resources
2015-08-27 23:58:04:  Copying /private/var/folders/7y/471pt3h95cz1c6557kgzqkj80000gn/T/LauncherBootstrap/Version to /Applications/Thinkbox/Deadline7/Resources/Version
2015-08-27 23:58:04:     Launch Worker: False
2015-08-27 23:58:04:     Launch Pulse: False
2015-08-27 23:58:04:     Launch Monitor: True
2015-08-27 23:58:04:     Launch Balancer: False
2015-08-27 23:58:04:     Launch Web Service: False
2015-08-27 23:58:04:  Launching launcher
2015-08-27 23:58:04:  Self upgrade completed
2015-08-27 23:58:04:  Shutting down

```

--------------------------------

### Manual Installation of Messiah Client for Deadline

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/app-messiah

These code snippets demonstrate the manual installation process for the Messiah 32-bit and 64-bit Deadline client plugins. It involves copying the appropriate plugin file from the Deadline repository to the Messiah installation directory.

```batch
copy "[Repository]\submission\Messiah\Client\DeadlineMessiahClient32.mp" "[Messiah 32 Bit Install Directory]\Plugins"
```

```batch
copy "[Repository]\submission\Messiah\Client\DeadlineMessiahClient64.mp" "[Messiah 64 Bit Install Directory]\Plugins"
```

--------------------------------

### Start Deadline Web Service with Launcher

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/launcher

Starts the Deadline Web Service by commanding the Launcher. This option ensures the Web Service is running and checks for available upgrades, initiating an automatic upgrade if necessary.

```bash
deadlinelauncher -webservice

```

--------------------------------

### Bash Script for Deadline MongoDB Service Management

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/install-db-repo-manual-db-install

This Bash script serves as an init script for managing the MongoDB service used by Deadline. It defines functions for starting, stopping, and checking the status of the service, along with logging capabilities. The script is supported on Red Hat distributions and requires specific paths for MongoDB binaries and data.

```bash
# Source function library. (Supported only on Red Hat distributions.
# ( . /etc/rc.d/init.d/functions > /dev/null 2>&1 )

DEADLINEVERSION=[VERSION]
MONGODBBIN=[PathToMongoDBBin]
MONGODBDATA=[PathToMongoDBData]
MONGOSERVICEFILENAME="mongodb"
MONGOLOCK="/var/lock/subsys/deadline$DEADLINEVERSION$MONGOSERVICEFILENAME"
LOGFILE="/var/log/deadline$DEADLINEVERSION$MONGOSERVICEFILENAME.log"
PIDFILE="/var/run/deadline$DEADLINEVERSION$MONGOSERVICEFILENAME.pid"
RUNNING=0 # Is the process in our PID file running?
PID=-1    # What is the process ID?
ULIMITSETTING=200000 # Open file descriptor limit (200000 is the recommended amount)

LONGNAME="MongoDB Service For Deadline ${DEADLINEVERSION}"

service_is_running() {
        # Note that this only checks to see if there's a process running
        # that was started from this init script.
        if [ -e "${PIDFILE}" ]; then
                PID=`cat ${PIDFILE}`
                ps -p $PID >/dev/null 2>&1
                if [ $? -eq 0 ]; then
                        return 0
                else
                        rm -f "${PIDFILE}" >/dev/null 2>&1
                        rm -f "${MONGOLOCK}" >/dev/null 2>&1
                fi
        fi

        PID=-1
        return 1
}

log_event() {
        if [ $# -gt 0 ]; then
                date "+%F %T: $1" >> "${LOGFILE}"

                if [ $# -gt 1 ] && [ $2 = true ]; then
                        echo $1
                fi
        fi
}

start () {
        if service_is_running; then
                log_event "The ${LONGNAME} is already running (PID ${PID})." true

                return 0
        else
                # Start the service
                if [ -e "${MONGODBBIN}/mongod" ]; then
                        if [ -x "${MONGODBBIN}/mongod" ]; then
                                # Increase file descriptors limit
                                if [ "$(ulimit -n)" -lt "$ULIMITSETTING" ]; then
                                        ulimit -n "$ULIMITSETTING"
                                fi

                                # Start the service
                                ("$MONGODBBIN/mongod" --config "$MONGODBDATA/config.conf") &

                                # Log the PID and create the LOCK file
                                echo $! > "${PIDFILE}"
                                touch "${MONGOLOCK}" 2> /dev/null

                                if service_is_running; then
                                        log_event "The ${LONGNAME} has been started." true
                                        log_event "Full log can be found in ${MONGODBDATA}/logs/log.txt"

                                        return 0
                                else
                                        log_event "The ${LONGNAME} failed to start." true
                                        return 7
                                fi
                        else
                                log_event "'${MONGODBBIN}/mongod' is lacking execute permissions for the current user." true
                                return 4
                        fi
                else
                        log_event "'mongod' was not found at the expected location (${MONGODBBIN})" true
                        return 5
                fi
        fi
}

stop () {
        if ! service_is_running; then
                log_event "The ${LONGNAME} is not currently running." true
                return 0
        else
                log_event "Shutting down the ${LONGNAME}..." true
                kill -QUIT $PID

                COUNTER=0
                while kill -0 $PID >/dev/null 2>&1; do
                        COUNTER=$((COUNTER+1))

                        if [ "$COUNTER" -gt 10 ]; then
                                break
                        fi

                        sleep 0.5
                done

                if service_is_running;
                        then
                        # Time to bring out the big guns
                        kill -KILL $PID

                        sleep 0.5

                        if service_is_running;
                                then
                                log_event "Failed to stop the ${LONGNAME}." true
                                return 1
                        fi
                fi
        fi

        log_event "The ${LONGNAME} has been stopped gracefully." true

        return 0
}

restart() {
        stop
        start

        return $?
}

rh_status(){
        if [ -e "${PIDFILE}" ]; then
                PID=`cat ${PIDFILE}`

                if ps -p $PID >/dev/null 2>&1; then
                        log_event "The ${LONGNAME} is running with PID $PID." true
                        return 0
                else
                        log_event "The ${LONGNAME} exited prematurely." true
                        return 1
                fi
        elif [ -e "${MONGOLOCK}" ]; then
                log_event "The ${LONGNAME} exited prematurely." true
                return 2
        else

```

--------------------------------

### Example: Get Pulse Names in Deadline

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/command-line-arguments-clients

An example demonstrating how to use the '-GetPulseNames' command to retrieve a list of Pulse names configured in the Deadline system.

```bash
C:\>deadlinecommand -GetPulseNames
    stack057409b23f554c3d859cfecfd58b70dd
    stack104c3b15d5514fab873897836e0c9ea9
    stack1a2389b361244f35946638a7882dd666
    HPZ-1234567890


```

--------------------------------

### Example Deadline Launcher Log Output

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/logs

Provides a sample of the typical log entries found in a Deadline Launcher log file. These entries detail the launcher's initialization, network activity, and configuration status, aiding in troubleshooting startup or connection problems.

```text
2015-08-10 12:28:56:  BEGIN - mbp.local\owenm
2015-08-10 12:28:56:  Deadline Launcher 7.2 [v7.2.0.13 R  (fcc207a56)]
2015-08-10 12:28:56:  Launcher Thread - Launcher thread initializing...
2015-08-10 12:28:56:  Launcher Thread - Launcher thread listening on port 17070
2015-08-10 12:28:58:  Auto Configuration: Picking configuration based on: mbp.local / 192.168.20.144
2015-08-10 12:28:58:  Auto Configuration: No auto configuration could be detected, using local configuration
2015-08-10 12:28:58:  Launcher Thread - Remote Administration is now enabled
2015-08-10 12:28:58:  Launcher Thread - Automatic Updates is now enabled

```

--------------------------------

### Start Deadline License Forwarder with Launcher

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/launcher

Launches the Deadline License Forwarder using the Launcher. This command ensures the License Forwarder starts correctly and checks for any available upgrades, triggering them automatically if found.

```bash
deadlinelauncher -licenseforwarder

```

--------------------------------

### Windows Submitter Batch Installation Script

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/install-submitters

An example batch script demonstrating unattended installation of multiple Deadline submitters on Windows. It showcases the use of '--mode unattended', '--enable-components', '--disable-components', and '--destDir' for granular control over the installation process. This script installs submitters for Maya, 3ds Max, and Nuke with specific configurations.

```batch
@echo off
.\Maya-submitter-windows-installer.exe --mode unattended --disable-components Maya2014
.\3dsMax-submitter-windows-installer.exe --mode unattended
    --enable-components 3dsMax2011,3dsMax2015
    --disable-components 3dsMax2012,3dsMax2013,3dsMax2014
    --destDir2011 "C:\3dsMax2011_64"
.\Nuke-submitter-windows-installer.exe --mode unattended

```

--------------------------------

### Manual Installation of Deadline Fusion Client Script

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/app-fusion

Provides instructions for manually installing the Deadline Fusion client script for different versions of Fusion and operating systems. This script enables direct submission of Fusion render jobs to Deadline from within the Fusion GUI.

```batch
[Repository]\submission\Fusion\Client\DeadlineFusionClient.eyeonscript to [Fusion Install Directory]\Scripts\Comp

```

```batch
%APPDATA%\Blackmagic Design\Fusion\Scripts\Comp

```

```shell
~/Library/Application Support/Blackmagic Design/Fusion/Scripts/Comp

```

```shell
~/.fusion/BlackmagicDesign/Fusion/Scripts/Comp

```

--------------------------------

### Deadline Launcher Service Management

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/command-line-arguments-clients

Commands to manage the Deadline Launcher service, including changing the listening port, installing the service with or without starting it, and installing it with specified logon credentials.

```bash
deadlinecommand -ChangeListeningPort <Port>

```

```bash
deadlinecommand -InstallLauncherService [<StartService>]

```

```bash
deadlinecommand -InstallLauncherServiceLogOn <User Name> <Password> [<StartService>]

```

--------------------------------

### Install MongoDB as a Windows Service

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/db-mongo-replica-set

Command to install and register the MongoDB executable as a Windows service. This allows MongoDB to run in the background and start automatically with the operating system. Requires administrative privileges.

```bash
mongod --install
```

--------------------------------

### Unattended Secrets Management Installation Example

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/secrets-management/deadline-secrets-management

Provides an example of installing the Secrets Management feature in unattended mode on Windows. This requires specifying parameters such as `--installSecretsManagement`, `--secretsAdminName`, `--secretsAdminPassword`, and database connection details like `--dbssl`, `--dbhost`, `--dbport`, `--dbclientcert`, and `--dbname`. Optional parameters like `--removeLegacySecrets` and `--removeSecretsManagement` can also be included.

```bash
DeadlineRepository-windows-installer.exe --mode unattended --installmongodb false --secretsAdminName *** --secretsAdminPassword **** --dbssl true --dbhost "db-ip-address" --dbport 27100 --dbclientcert "C:\certs\cert_path.pfx" --dbname "deadline10db" --dbauth "true" --installSecretsManagement "true"

```

--------------------------------

### Start MongoDB Instance from Configuration File

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/db-mongo-replica-set

Launches a MongoDB daemon (mongod) using a specified configuration file. This is typically used for starting individual MongoDB instances, especially during initial setup or for standalone deployments.

```bash
./mongod --config <databaseDirectory>/mongo/data/config.conf
```

--------------------------------

### Compile and Install HAProxy on Ubuntu

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/licensing-usage-based-proxy

Downloads, compiles, and installs the latest version of HAProxy on Ubuntu. This process involves downloading the tarball, changing directories, and then using 'make' commands to build and install.

```bash
>>> make TARGET=linux2628 USE_OPENSSL=1
>>> make install

```

--------------------------------

### Install HAProxy Prerequisites on Ubuntu

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/licensing-usage-based-proxy

Installs necessary packages for building HAProxy from source on Ubuntu. This ensures you have the latest version and the required development tools.

```bash
>>> sudo -s
>>> apt-get install build-essential libopenssl-dev

```

--------------------------------

### Example Rule Configuration in deadline.ini

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/auto-config

Shows how to configure individual client settings directly within the deadline.ini file. This demonstrates an alternative to using the graphical Ruleset interface.

```ini
# Example: Setting Repository Path and Launch Worker At Startup
# RepositoryPath = /path/to/repository
# LaunchWorkerAtStartup = true
```

--------------------------------

### Create MongoDB Windows Service Command

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/install-db-repo-manual-db-install

Command to create a Windows service for MongoDB used by Deadline. This command registers the mongod.exe executable with specified configuration and service details. Replace '[VERSION]' and '[PathToMongoInstall]' with your Deadline version and MongoDB installation path.

```batch
sc create Deadline[VERSION]DatabaseService binPath= "[PathToMongoInstall]\application\bin\mongod.exe" --config "[PathToMongoInstall]\data\config.conf" --service start= auto depend= TCPIP DisplayName= "Deadline [VERSION] Database Service"
```

--------------------------------

### Configure Launch Slave at Startup

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/client-config

Determines if the Deadline Launcher should automatically start the Worker upon startup. Default is True. Example sets it to False.

```ini
LaunchSlaveAtStartup=False
```

--------------------------------

### Start Deadline Monitor with Launcher

Source: https://docs.thinkboxsoftware.com/products/deadline/latest/1_User%20Manual/manual/launcher

Starts the Deadline Monitor by interacting with an existing Launcher instance. If an upgrade is available, it will trigger an automatic upgrade. This command is essential for launching the monitoring interface.

```bash
deadlinelauncher -monitor

```
Tokens:
Raw