Deadline 6 Documentation
Deadline 5 Documentation
RSS< Twitter< etc

Repository Options


Overview

There are a wide variety of Repository options that can be configured. On Windows and Linux, these options were available in the Repository Setup Wizard that was launched after installing the Deadline Repository. However, all of these options can be modified at any time from the Deadline Monitor while in Super User Mode by selecting Tools -> Configure Repository Options.

Note that long-running applications like the Launcher, Slave, and Pulse only update these settings every 10 minutes, so after making changes, it can take up to 10 minutes for all machines to recognize them. You can restart these applications to have them recognize the changes immediately.

Client Setup

These settings affect the Deadline Client installed on each machine.

  • Remote Administration: Enabling Remote Administration allows the Deadline Clients to be controlled remotely from the Monitor running on another machine. Note that this can be a security risk if you are not behind a firewall.
  • Automatic Upgrades:Enabling Automatic Upgrades allows the Deadline Clients to detect if the Repository has been upgraded, and upgrade themselves if necessary. Note that the upgrade check is only performed when launching applications via the Launcher.

Monitor Settings

These settings affect the Deadline Monitor application on each machine.

  • Pulse refresh connection time out: The number of seconds a monitor that has connected to Pulse will wait for Pulse to respond when refreshing.
  • Batch command limit while in Satellite Mode: If Satellite Mode is enabled, batch operations (on multiple jobs or slaves, for example) will be limited to this number. Limiting batch operations helps ensure that users don't accidentally start a command that could take a very long time to complete.
  • Allow Growl messages to be sent: Whether or not Growl notifications can be sent to machines from the Deadline Monitor. This requires Growl to be installed on the remote machine.
  • Allow Network messages to be sent: Whether or not instant network messages can be sent to machines from the Deadline Monitor. This requires the Deadline Launcher to be running on the remote machine.

Slave Settings

These settings affect the Deadline Slave application on each machine.

General

  • Limit the number of characters per line for standard output handling: Lines of standard output that are longer than the specified limit will be ignored by the Slave's stdout handling.
  • Remove Offline/Stalled Slaves from the Repository after this many days: Slaves that are Offline or Stalled will be removed from the Repository after this many days.
  • Gather System Resources (CPU and RAM) When Rendering Tasks On Linux/Mac: If enabled, the Slave will collect CPU and RAM usage for a task while it is rendering. We have seen cases where this can cause the Slave to crash on Linux or Mac, so you should only disable this feature if you run into this problem.
  • Manually scan the Repository for jobs if the Slave cannot connect to Pulse: If enabled, the Slaves will try to scan the Repository manually for jobs if they cannot connect to Pulse.
  • Power Management Thermal Shutdown check interval: The number of seconds between thermal shutdown checks. The Slave only performs this check if Pulse isn't running. Note that this is the only feature of Power Management that has redundancy built into the Slave.

Wait Times

  • Number of seconds between queries for new Tasks while the Slave is Rendering: The number of seconds a Slave will wait after it finishes a task before moving on to another. This delay is not applied when the Slave is idle.
  • Number of seconds between Repository queries while the Slave is Idle: The number of seconds a Slave that has not connected to Pulse will wait between polls to the Respository for tasks when it is idle.
  • Number of seconds between Pulse queries while the Slave is Idle: The number of seconds a Slave that has connected to Pulse will wait between polls to Pulse for tasks when it is idle.
  • Number of seconds a Slave that has connected to Pulse will wait for a response: The number of seconds a Slave that has connected to Pulse will wait for Pulse to respond when querying for a job.
  • Number of mintues a Slave must be unresponsive before it is considered Stalled: Deadline determines if a Slave has stalled by checking the last time that the Slave provided a status update. If a Slave has not updated its state in the specified amount of time, it will be marked as Stalled.

Pulse Settings

Connection

  • Host Name or IP Address: "The host name or the IP address of the machine that Pulse is running on. If left blank, the Deadline applications will not try to connect to Pulse.
  • Listening Port: The port that Pulse will listen on.
  • Maximum Incoming Connections: The maximum number of incoming connections that Pulse will accept before it starts rejecting them.
  • Connection Timeout: The number of milliseconds in which messages being sent to/from Pulse must complete before a timeout occurs.
  • Maximum Connection Attempts: The maximum amount of times the Deadline applications will attempt to connect to Pulse before giving up.
  • Task Confirmation: If enabled, Slaves that receive tasks from Pulse will wait up to the specified amount of time to confirm the task's existence before it proceeds with the render. This can help in cases where network latency causes the Slave to think the task has been requeued. Note that if the Slave confirms the existence before the given timeout, it will move on immediately. So under normal circumstances, the feature shouldn't have any impact on the overall speed of a task.

General

  • Dedicated Data Loading Threads: The maximum number of threads that Pulse uses for loading Repository data.
  • Repository Scan Interval: The number of seconds between Repository scans. After each scan, Pulse will distribute jobs to any Slaves that are currently connected.
  • Repository Clean-up Interval: The number of seconds between Repository clean-ups. This process includes resuming pending jobs, cleaning up unused files, etc.
  • Power Management Check Interval: The number of seconds between Power Management checks.
  • Repository Disk Space Monitoring: If the repository machine has this much space (in MB) or less, a warning email is sent. Note that this feature only works when Pulse is running on the Repository machine.

Throttling

  • Enable Throttling: Enable to limit the number of Slaves that can copy over job files at the same time.
  • Maximum number of Slaves that can copy job files at the same time: The maximum number of Slaves that can copy over job files at the same time.
  • Number of seconds a Slave waits between updates to see if it can start copying job files: The amount of time (in seconds) a Slave will wait between sending throttle checks and updates to Pulse.
  • Throttle update timeout multiplier: The number of seconds a Slave waits between throttle updates is multiplied by this value to determine the timeout value.

Web Service

  • Enable the Web Service: Enable the Pulse Web Service.
  • Listening Port: The port that the Web Service will listen on.
  • Connection Limit: The amount of simultaneous connections the Web Service can handle.
  • Connection Timeout: The amount of time, in seconds, that responses from the Web Service have to complete.
  • Require Authentication: If enabled, a valid user name and password must be provided to access the Pulse Web Service. If you change this setting, you must restart Pulse for the change to take effect.
  • Allow Empty Passwords: If enabled, the Pulse Web Service will accept an empty password if no password is provided.
  • Allow Execution of Non-Script Commands: If enabled, you can call Deadline Command commands using the Web Service.

Email Notification

SMTP Settings

  • SMTP Server: The SMTP server used by Deadline to send emails.
  • Sender Account: The email account that Deadline will use to send emails from.
  • Port: The SMTP port to use.
  • Use SSL: The email account from which the notifications will be sent.
  • SMTP Server Requires Authentication: Enable if the SMTP server requires a user name and password to authenticate.
  • Testing: Send a test email to the specified email address.

Note that if you have SSL enabled, you may need to configure your Linux and OSX machines for SSL to work. The process for doing this is explained in Mono's Security Documentation.

Job Notifications

  • Job Completed: When a job completes, an email will be sent to these email addresses.
  • Job Timed Out: When a job times out, an email will be sent to these email addresses.
  • Job Error Warning: When a job accumulates a certain number of errors, a warning email will be sent to these email addresses. You can configure the warning limit in the Failure Detection settings.
  • Job Failed: "When a job fails, an email will be sent to these email addresses.
  • Job Corrupted: When a corrupted job is detected, an email will be sent to these email addresses.

Repository Notifications

  • Slave License Errors: "When a slave is unable to get a license, an email will be sent to these email addresses.
  • Slave Status Errors: When a slave is unable to update its state in the Repository, an email will be sent to these email addresses.
  • Slave Error Warning: When a slave accumulates a certain number of errors in one session, a warning email will be sent to these email addresses. You can configure the warning limit in the Failure Detection settings.
  • Stalled Slave: When a stalled slave detected, an email will be sent to these email addresses.
  • Power Management: All Power Management related emails will be sent to these email addresses.
  • Repository Disk Space: If you have Pulse running on your Repository machine, and that machine has reached the disk space threshold set in the Pulse Settings, an email will be sent to these email addresses.
  • System Administrator: When users use the option in the Error Report Viewer to report error messages to their system administrator, those emails will be sent to these email addresses.

Error Reporting

  • Enable Remote Error Reporting: "Enable or disable remote error reporting.

Auto Configuration

This allows you to configure your Slaves from a single location. When a Slave starts up, it will automatically pull this configuration from Pulse and apply it before fully initializing. See the Auto Configuration documentation for more information.

User Security

User Security

  • Super User Password: The password needed to access Super User Mode in the Monitor. Leave blank for no password.
  • Allow Normal users to view the jobs of other users in the Monitor: If enabled, Normal users can see jobs that belong to other users in the Monitor. However, they will not be able to control or change the properties of jobs that do not belong to them.
  • Allow Normal users to switch to another Deadline user from the Monitor or Launcher: If enabled, Normal users can change the current Deadline user from the Launcher or Monitor. If disabled, only Power users can do this.
  • Allow Normal users to switch to another Repository from the Monitor or Launcher: If enabled, Normal users can change the current Repository from the Launcher or Monitor. If disabled, only Power users can do this.
  • Allow Normal users to change the License Server settings from the Launcher: If enabled, Normal users can change the current License Server from the Launcher. If disabled, only Power users can do this.
  • Allow Normal users to add and remove Slave Instances from the Launcher: If enabled, Normal users can add and remove Slave instances from the Launcher. If disabled, only Power users can do this.
  • Use the System User For The Deadline User: Enable to use enhanced user security, which prevents users from impersonating others.

Menu Item Permissions

  • Each item in the lists represents a Menu Item that is available in the Monitor. Simply place a check mark beside each item that you want Normal and Power users to have access to.

Job Property Permissions

  • Each item in the lists represents a job property that can be changed from the Monitor. Simply place a check mark beside each item that you want Normal and Power users to have access to.

Job Settings

Job Scheduling

  • Job Scheduling Order: The order of priority by which Deadline schedules the jobs in the queue. The default order is based on the job\'s pool, then its priority, then finally its submission date.
  • Automatic Job Timeout: Configure Deadline to automatically determine a timeout for a job based on the render times of tasks that have already completed. If a task goes longer than that timeout, a timeout error will occur and the task will be requeued.
  • Automatic Job Cleanup: Configure Deadline to clean up completed jobs by either archiving or deleting them. You can also configure Deadline to automatically delete completed jobs that are archived. Non-completed jobs will never be automatically deleted.

Failure Detection

  • Send a warning to the job's user after it has generated this many errors: The number of errors that incomplete tasks can accumulate for a job before a warning is sent to the job's user.
  • Mark a job as failed after it has generated this many errors: The number of errors that incomplete tasks can accumulate for a job before the job is marked as Failed.
  • Mark a task as failed after it has generated this many errors: The maximum number of times a specific task can report an error before that task is marked as Failed.
  • Automatically delete corrupted jobs from the Repository: If enabled, corrupted jobs will automatically be deleted from the Repository
  • Send a warning after a Slave has generated this many errors in one session: The maximum number of times a slave can report an error in one session before an email is sent to the corresponding email address in the Email Setup notification settings.
  • Mark a Slave as Bad after it has generated this many errors for a job in a row: The number of consecutive times a slave can error on a job before it marks itself as bad for that job.
  • Frequency at which a Slave will attempt a job that it has been marked bad for: A percentage (0 - 100) that determines how often a Slave will try to render a task for a job that it has been marked as bad for if no good jobs are available.

Auxiliary Files

  • Store job auxiliary file in a different location: If enabled, auxiliary files that are submitted with the job will be stored in an alternate location to save space and reduce load on the repository machine.

Extra Properties

  • Extra arbitrary properties can be submitted with a job, and these properties can be given user friendly names so that they can easily be identified and used to filter and sort jobs in the Monitor.

Application Logging

  • Delete Monitor logs after this many days: Number of days to keep Monitor logs before deleting them.
  • Delete Slave logs after this many days: Number of days to keep Slave logs before deleting them.
  • Delete Pulse logs after this many days: Number of days to keep Pulse logs before deleting them.
  • Slave Verbose Logging: Enable this option to have the Slave print out more information to its log while it's running.
  • Pulse Verbose Logging: Enable this option to have Pulse print out more information to its log while it's running.

Statistics Gathering

General

  • Enable Statistics Gathering: Enable statistics gathering in Deadline.
  • Slave Statistics Gathering Interval: How often Slave Statistics are gathered by Pulse.
  • Repository Statistics Gathering Interval: "How often Repository Statistics are gathered by Pulse.
  • Delete job statistics after this many days: Delete job statistics after the specified period.
  • Delete Slave statistics after this many days: Delete Slave statistics after the specified period.
  • Delete Repository statistics after this many days: Delete Repository statistics after the specified period.

Database

  • Enable Database Statistics Gathering: Enable to have Deadline store statistics in a database.
  • Server Name: The host name or IP address of the database server.
  • Port: The database port number.
  • User Name: The database user that Deadline will log in as to enter statistics. When Postgres is first installed, the default user name is 'postgres'.
  • Password: The password for the database user.
  • Database: Name of the database schema. When Postgres is first installed, the default database name is 'postgres'.
  • Create Database: Connects to the specified database and creates the necessary tables that Deadline uses to store statistics. This will fail if the database already contains the necessary tables.
  • Update Database: Connects to the specified database and updates the tables it to ensure they're compatible with the current version of Deadline. If the update can't be done automatically, you will be prompted for a file that contains the SQL to perform the update. These will be made available for download as required.
  • Test Connection: Tests the connection to the specified database.

Mapped Paths

When using a mixed render farm, it is all but guaranteed that asset paths will be different each on operating system. In many cases, Deadline is aware of the paths being passed to the rendering application, so you can configure Path Mappings to swap out paths when appropriate based on the operating system. See the Cross Platform Rendering documentation for more information.

Note that the ordering of the path mappings can be a factor. For example, of you want to remap /Volumes/Assets/ and /Assets/, make sure to list /Volumes/Assets/ first, or else /Assets/ will match anything that /Volumes/Assets/ would have matched.

Mapped Drives

If your pipeline uses mapped drives on your Windows machines for network shares, you can configure Deadline to automatically map these drives before a Slave begins rendering. This is especially useful if Deadline is running as a service on your Slaves, as they may not be able to access these drives otherwise.

To add a new Mapped Drive, just click the Add button. Here you specify the driver letter you want to map to, and the path that needs to be mapped. You can also specify the credentials if required.

Script Menus

There are many scripts that ship with Deadline, and it's more than likely that you don't need to use them all, especially the submission scripts. Here, you can configure the contents of the individual script menus to only display what you use. Note though that these settings will affect all Monitors that connect to this Repository.

Python Settings

A list of additional paths to be added to the Python search paths. Specify one path per line, and use the Add Path button to browse for paths.

Remoting Software

Support for the following remoting software is integrated into the Deadline Monitor. See the Remote Control and Access documentation for more information.

VNC

  • Allow VNC connections from the Monitor: If enabled, VNC connections can be made from the Monitor to connect to remote machines.
  • Viewer Executable: The local path(s) to the VNC Viewer executable on the client machines. Specify one path per line, and Deadline will use the first path that exists.
  • Port: The VNC server listening port.
  • Password: The VNC password.
  • Viewer Command Line Arguments: Command line arguments to be used when running the VNC viewer on the different operating systems.

Radmin

  • Allow Radmin connections from the Monitor: If enabled, Radmin connections can be made from the Monitor to connect to remote machines.
  • Viewer Executable: The local path(s) to the Radmin Viewer executable on the client machines. Specify one path per line, and Deadline will use the first path that exists.
  • Port: The Radmin server listening port.

RDC

  • Allow RDC connections from the Monitor: If enabled, RDC connections can be made from the Monitor to connect to remote machines.
  • Settings Directory: Where the Remote Desktop Connection settings files should be stored. If you are unconcerned about security you could specify a shared network path. Note that this value is ignored if using a Settings File Name instead.
  • Settings File Name: The path to the RDC settings (*.rdp) to always use when connecting. If left blank, the RDC Settings Storage Directory will be used instead.
  • RDC Executable: Optionally specify the path to the Remote Desktop Connection executable. If left blank, the executable in the Windows system path will be used.

ARD

  • Allow ARD connections from the Monitor: If enabled, ARD connections can be made from the Monitor to connect to remote machines.

Wake On Lan Settings

Deadline's Power Management uses Wake On Lan to wake up machines, and you can configure which port(s) the WOL packet is sent over. If no ports are listed here, Deadline will use port 9 by default.