AWS deadline-cloud documentation change
Summary
Expanded documentation for Deadline Cloud integration with Foundry Nuke, adding installation instructions, detailed job submission workflows for both render jobs and CopyCat training jobs, and specific configuration settings.
Security assessment
The changes focus on feature enhancements (CopyCat training support), installation procedures, and job configuration details. No security vulnerabilities, patches, or security-specific configurations are mentioned or addressed in the diff.
Diff
diff --git a/deadline-cloud/latest/userguide/foundry-nuke.md b/deadline-cloud/latest/userguide/foundry-nuke.md index 97d68787f..4bff2a5b7 100644 --- a//deadline-cloud/latest/userguide/foundry-nuke.md +++ b//deadline-cloud/latest/userguide/foundry-nuke.md @@ -7 +7 @@ -Support overviewNuke version compatibilityDeadline Cloud Conda ChannelGetting startedUsing the Nuke submitterAdvanced configurationsNuke compositing featuresOpen source resources +Support overviewNuke version compatibilityDeadline Cloud Conda ChannelGetting startedInstallationUsing the Nuke submitterAdvanced configurationsNuke compositing featuresOpen source resources @@ -11,5 +11 @@ Support overviewNuke version compatibilityDeadline Cloud Conda ChannelGetting st -###### Note - -For more information about installing, configuring, and using this integration on your workstation, see the [Nuke integration user guide on GitHub](https://aws-deadline.github.io/nuke/). - -Foundry Nuke is a node-based digital compositing and visual effects application used for television and film post-production. Nuke is supported by Deadline Cloud with submitters, conda packages, and an adaptor for increased rendering performance. +Foundry Nuke is a node-based digital compositing and visual effects application used for television and film post-production. Nuke is supported by AWS Deadline Cloud (Deadline Cloud) with submitters, conda packages, and an adaptor for increased rendering performance. This guide provides step-by-step instructions for using Deadline Cloud with Nuke to render your projects faster by distributing rendering tasks across multiple machines. @@ -84 +80,30 @@ Support for Nuke is provided using the Conda environment for service-managed fle - 1. If you are not already authenticated in the Deadline Cloud submitter, the **Credentials Status** shows as **NEEDS_LOGIN**. + 5. If you are not already authenticated, choose **Login** and log in with your user credentials in the browser window. + + 6. Choose **Submit**. + + + + +## Installation + +To install the Deadline Cloud for Nuke submitter, you need: + + * A Windows, macOS, or Linux workstation. + + * Nuke 14, 15, 16, or 17. We recommend Nuke 15 or later over Nuke 14, because these versions are supported by the [default conda queue environment](https://docs.aws.amazon.com/deadline-cloud/latest/userguide/create-queue-environment.html#conda-queue-environment) on service-managed fleets. To use Nuke 14 with a service-managed fleet, you need to make Nuke 14 available to the worker. The recommended way is to create your own conda package by following [Create a conda package for an application or plugin](https://docs.aws.amazon.com/deadline-cloud/latest/developerguide/conda-package.html). + + + + +There are two ways to install the Deadline Cloud for Nuke submitter: + + * Using the Deadline Cloud submitter installer (recommended). + + * [Manually installing the submitter from source](https://github.com/aws-deadline/deadline-cloud-for-nuke/blob/mainline/DEVELOPMENT.md#manual-installation). + + + + +### Using the Deadline Cloud submitter installer + +You can install the Deadline Cloud for Nuke submitter using the Deadline Cloud submitter installer. @@ -86 +111 @@ Support for Nuke is provided using the Conda environment for service-managed fle - 2. Choose **Login**. +**To install the submitter** : @@ -88 +113 @@ Support for Nuke is provided using the Conda environment for service-managed fle - 3. In the login browser window, log in with your user credentials. + 1. Download the [Deadline Cloud submitter installer](https://docs.aws.amazon.com/deadline-cloud/latest/userguide/submitter.html). @@ -90 +115 @@ Support for Nuke is provided using the Conda environment for service-managed fle - 4. Choose **Allow**. You are now logged in and the **Credentials Status** shows as **AUTHENTICATED**. + 2. Run the installer. @@ -92 +117,9 @@ Support for Nuke is provided using the Conda environment for service-managed fle - 5. Choose **Submit**. + 3. When prompted to select components, find and mark the checkbox for Nuke. + + + + 4. Finish running the installer. + + 5. Launch Nuke. + + 6. Verify the installation by checking if **Deadline Cloud** has been added to the top navigation bar. @@ -99 +132,101 @@ Support for Nuke is provided using the Conda environment for service-managed fle -To use the Nuke submitter: +The Deadline Cloud for Nuke submitter supports two types of jobs: + + * Render jobs - Render the output files created by one or more of the [Write nodes](https://learn.foundry.com/nuke/content/comp_environment/rendering/output_write_nodes.html) in your Nuke script. + + * CopyCat training jobs - Perform training for a [CopyCat node](https://learn.foundry.com/nuke/content/reference_guide/air_nodes/copycat.html) in your Nuke script. + + + + +### Render jobs + +To use the Deadline Cloud for Nuke submitter, you need: + + * A profile to submit to Deadline Cloud with. + + * An Deadline Cloud farm and queue to submit to. + + + + +**To submit a render job from Nuke to Deadline Cloud** : + + 1. Save your Nuke file. + + 2. From the top navigation bar, choose **Deadline Cloud**. From the drop-down menu, choose **Submit to Deadline Cloud**. + + 3. Use the tabs in the dialog to customize your job. + + 4. (Optional) To export a job's associated files to your job history directory without submitting it, choose **Export bundle**. + + 5. Choose **Submit** and follow the prompts to send your job to Deadline Cloud. + + + + +#### Nuke render-specific settings + +The **Job-specific settings** tab has options specific to jobs created in Nuke. + + + + * _Write nodes_ \- Which [write nodes](https://learn.foundry.com/nuke/content/comp_environment/rendering/output_write_nodes.html) to render outputs for. You can either select to render all write nodes, or select a specific node. + + * _Views_ \- Which [views](https://learn.foundry.com/nuke/content/comp_environment/stereoscopic_films/setting_up_stereo_views.html) should be rendered. + + * _Override frame range_ \- Select this option to render a different frame or frame range than is set in Nuke. Frame ranges follow the [Open Job Description](https://github.com/OpenJobDescription/openjd-specifications/wiki/2023-09-Template-Schemas#34111-intrangeexpr) pattern. + + * _Use proxy mode_ \- Manages whether to use [proxy mode](https://learn.foundry.com/nuke/9.0/content/getting_started/managing_scripts/proxy_mode.html) in the submitted job. + + * _Continue on error_ \- If selected, Nuke tries to continue rendering when it encounters an error. If cleared, Nuke fails the task when it encounters an error. + + * _Chunk size_ \- Number of frames to group into each chunk (1-150). Use 1 for one frame per task (default). Higher values group frames into contiguous chunks to reduce per-task overhead. For more information, see [Task chunking for job templates](https://docs.aws.amazon.com/deadline-cloud/latest/developerguide/build-job-bundle-chunking.html). + + * _Target chunk duration (seconds)_ \- When you specify a value, the scheduler dynamically adjusts chunk sizes based on observed runtimes of completed chunks, aiming for this duration for each chunk. Leave at 0 to use a fixed chunk size for all chunks. + + * _Use timeouts_ \- Whether to use user-configured timeouts. + + * _Render task timeout_ \- Maximum duration of each action which performs a render. Default is 6 days. + + * _Setup timeout_ \- Maximum duration of each action which sets up the job for rendering, such as scene load. Default is 1 day. + + * _Teardown timeout_ \- Maximum duration of action which tears down the setup required for rendering. Default is 1 hour. + + * _Include gizmos in job bundle_ \- Whether to include [gizmos](https://learn.foundry.com/nuke/content/comp_environment/configuring_nuke/creating_sourcing_gizmos.html) in the job bundle. + + + + +For information about the other submitter tabs, see the [Deadline Cloud guide for using a submitter](https://docs.aws.amazon.com/deadline-cloud/latest/userguide/jobs-using-submitter.html). + +### CopyCat training jobs + +To use the Deadline Cloud for Nuke submitter to train CopyCat nodes, you need: + + * A profile to submit to Deadline Cloud with. + + * An Deadline Cloud farm and queue to submit to. + + * An Deadline Cloud fleet with GPU-enabled workers associated with the queue you will be submitting to. For instructions on creating a service-managed fleet with GPU access, see [Managing service-managed fleets](https://docs.aws.amazon.com/deadline-cloud/latest/userguide/smf-manage.html). + + + + +**To submit a CopyCat training job from Nuke to Deadline Cloud** : + + 1. Create or open a Nuke script containing a CopyCat node. + + 2. Attach ground-truth and input nodes to the CopyCat node, and configure knobs on the node to desired values. See [Foundry's CopyCat documentation](https://learn.foundry.com/nuke/content/reference_guide/air_nodes/copycat.html) for details on using CopyCat. + + 3. Save your Nuke file. + + 4. From the top navigation bar, choose **Deadline Cloud**. From the drop-down menu, choose **Submit CopyCat Training to Deadline Cloud**. + + 5. Use the tabs in the dialog to customize your job. + + 6. (Optional) To export a job's associated files to your job history directory without submitting it, choose **Export bundle**. + + 7. Choose **Submit** and follow the prompts to send your job to Deadline Cloud. + + + @@ -101 +234 @@ To use the Nuke submitter: - 1. Open Nuke. +#### Nuke CopyCat training-specific settings @@ -103 +236 @@ To use the Nuke submitter: - 2. Load your composition with the required Write nodes configured. +The **Job-specific settings** tab has options specific to CopyCat training jobs created in Nuke. @@ -105 +238 @@ To use the Nuke submitter: - 3. From the menu, choose **Deadline Cloud** to launch the submitter. + @@ -107 +240 @@ To use the Nuke submitter: - 4. If you are not already authenticated, choose **Login** and authenticate with your credentials. + * _CopyCat Node_ \- Select which CopyCat node to train by node name. @@ -109 +242 @@ To use the Nuke submitter: - 5. Configure your job settings in the submitter interface, including: + * _Use timeouts_ \- Whether to use user-configured timeouts. @@ -111 +244 @@ To use the Nuke submitter: - * Frame range settings + * _Render task timeout_ \- Maximum duration of each action. In the case of CopyCat, the training is a single action. Default is 6 days. @@ -113 +246 @@ To use the Nuke submitter: - * Write node selection + * _Setup timeout_ \- Maximum duration of each action which sets up the job, such as scene load. Default is 1 day. @@ -115 +248 @@ To use the Nuke submitter: - * Output paths and formats + * _Teardown timeout_ \- Maximum duration of action which tears down the setup. Default is 1 hour. @@ -117 +250 @@ To use the Nuke submitter: - 6. Choose **Submit** to send your job to Deadline Cloud. + * _Include gizmos in job bundle_ \- Whether to include [gizmos](https://learn.foundry.com/nuke/content/comp_environment/configuring_nuke/creating_sourcing_gizmos.html) in the job bundle. @@ -122 +255 @@ To use the Nuke submitter: -The submitter automatically detects Write nodes in your composition and allows you to select which ones to render. It also handles automatic input/output path detection and supports multiple views rendering. +For information about the other submitter tabs, see the [Deadline Cloud guide for using a submitter](https://docs.aws.amazon.com/deadline-cloud/latest/userguide/jobs-using-submitter.html). @@ -128 +261 @@ The submitter automatically detects Write nodes in your composition and allows y