ayon-core/website/docs/module_deadline.md

id	title	sidebar_label
module_deadline	Deadline Administration	Deadline

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Preparation

For AWS Thinkbox Deadline support you need to set a few things up in both OpenPype and Deadline itself

1. Deploy OpenPype executable to all nodes of Deadline farm. See Install & Run

2. Enable Deadline module it in the settings

3. Set up Deadline Web API service. For more details on how to do it, see here.

4. Point OpenPype to your deadline webservice URL in the settings

5. Install our custom plugin, event plugin and scripts to your deadline repository. It should be as simple as copying content of openPype/vendor/deadline/custom to path/to/your/deadline/repository/custom

Configuration

OpenPype integration with Deadline consists of two parts, event listener which gets triggered for each job and handles populating rendering jobs with proper environment variables and OpenPype plugin which handles publishing itself.

Both need to be configured by pointing DL to OpenPype executables. These executables need to be installed to destinations accessible by DL process. Check permissions (must be executable and accessible by Deadline process)

• Enable Tools > Super User Mode in Deadline Monitor

• Go to Tools > Configure plugins, find OpenPype in the list on the left side, find location of OpenPype executable. It is recommended to use the openpype_console executable as it provides a bit more logging.

• In case of multi OS farms, provide multiple locations, each node goes through a list and tries to find accessible locations for itself.

• Go to Tools > Configure events, find OpenPype in the list on the left side, find location of OpenPype executable. It is recommended to use the openpype_console executable as it provides a bit more logging.

• State is expected to be set to Global Enabled

Path to executables needs to be configured on both, plugin and event level!

Troubleshooting

Publishing jobs fail directly in DCCs

• Double check that all previously described steps were finished
• Check that deadlinewebservice is running on DL server
• Check that user's machine has access to deadline server on configured port

Jobs are failing on DL side

Each publishing from OpenPype consists of 2 jobs, first one is rendering, second one is the publishing job (triggered after successful finish of the rendering job).

• Jobs are failing with OpenPype executable was not found error

  Check if OpenPype is installed on a node handling this job, plugin and events are properly configured

• Publishing job is failing with ffmpeg not installed error

  OpenPype executable has to have access to ffmpeg executable, check OpenPype Setting > General

  

• Both jobs finished successfully, but there is no review on Ftrack

  Make sure that you correctly set published family to be send to Ftrack.

  

  Example: I want send to Ftrack review of rendered images from Harmony : - Host names: "harmony" - Families: "render" - Add Ftrack Family to "Enabled"

  Make sure that you actually configured to create review for published subset in project_settings/ftrack/publish/CollectFtrackFamily

  

  Example: I want to create review for all reviewable subsets in Harmony : - Add "harmony" as a new key an ".*" as a value.

• Rendering jobs are stuck in 'Queued' state or failing

  Make sure that your Deadline is not limiting specific jobs to be run only on specific machines. (Eg. only some machines have installed particular application.)

  Check project_settings/deadline

  

  Example: I have separated machines with "Harmony" installed into "harmony" group on Deadline. I want rendering jobs published from Harmony to run only on those machines.