AWS deadline-cloud documentation change
Summary
Completely restructured Blender documentation with detailed installation instructions, job submission workflow, and Blender-specific configuration settings
Security assessment
The changes are purely instructional improvements focusing on installation methods and workflow optimization. No security vulnerabilities, patches, or security features are mentioned. The modifications enhance user guidance but contain no security-related content or references to security mechanisms.
Diff
diff --git a/deadline-cloud/latest/userguide/blender.md b/deadline-cloud/latest/userguide/blender.md index bcb9b1cf2..fb182e06e 100644 --- a//deadline-cloud/latest/userguide/blender.md +++ b//deadline-cloud/latest/userguide/blender.md @@ -7 +7 @@ -Support overviewBlender version compatibilityDeadline Cloud Conda ChannelGetting startedUsing the Blender submitterAdvanced configurationsBlender render enginesOpen source resources +Support overviewBlender version compatibilityDeadline Cloud Conda ChannelGetting startedInstallationUsing the Blender submitterAdvanced configurationsBlender render enginesOpen source resources @@ -11,5 +11 @@ Support overviewBlender version compatibilityDeadline Cloud Conda ChannelGetting -###### Note - -For more information about installing, configuring, and using this integration on your workstation, see the [Blender integration user guide on GitHub](https://aws-deadline.github.io/blender/). - -Blender is a free and open-source 3D computer graphics software toolset used for creating animated films, visual effects, art, 3D printed models, motion graphics, interactive 3D applications, virtual reality, and computer games. Blender is supported by Deadline Cloud with comprehensive integration including submitters, conda packages, and an adaptor for increased rendering performance. +Blender is a free and open-source 3D computer graphics software toolset used for creating animated films, visual effects, art, 3D printed models, motion graphics, interactive 3D applications, virtual reality, and computer games. Blender is supported by AWS Deadline Cloud (Deadline Cloud) with comprehensive integration including submitters, conda packages, and an adaptor for increased rendering performance. This guide provides step-by-step instructions for using Deadline Cloud with Blender to render your projects faster by distributing rendering tasks across multiple machines. @@ -70 +66,103 @@ To use Blender with Deadline Cloud: -For more information about using the Blender integrated submitter, see the [Blender integration user guide on GitHub](https://aws-deadline.github.io/blender/). +## Installation + +To install the Deadline Cloud for Blender submitter, you need: + + * A Windows, macOS, or Linux workstation. + + * Blender 3.6 or later. + + + + +There are three ways to install the Deadline Cloud for Blender submitter: + + * Using the Deadline Cloud submitter installer (recommended). + + * Installing the submitter from Blender. + + * [Manually installing the submitter from source](https://github.com/aws-deadline/deadline-cloud-for-blender/blob/mainline/DEVELOPMENT.md#manual-installation). + + + + +### Using the Deadline Cloud submitter installer + +You can install the Deadline Cloud for Blender submitter using the Deadline Cloud submitter installer. + +**To install the submitter** + + 1. Download the [Deadline Cloud submitter installer](https://docs.aws.amazon.com/deadline-cloud/latest/userguide/submitter.html). + + 2. Run the installer. + + * When prompted, select each version of Blender you want to use the submitter with. + + 3. Launch Blender. + + 4. Verify the installation by checking the **Render** menu for a **Submit to Deadline Cloud** option. + + + + +If the add-on is not available from the **Render** menu, you need to manually enable it. + +**To manually enable the submitter add-on** + + 1. On the **Edit** menu, choose **Preferences…**. + + 2. Choose **File Paths** on the left side bar. + + 3. Find the **Script Directories** section and choose **+**. + + 4. For **Name** , enter `python`. + + 5. For **Path** , enter the path to the `python` directory in your Blender submitter installation. + + 6. Restart Blender for changes to take effect. + + + + +### Installing the submitter from Blender + +###### Note + +This is an experimental feature and is subject to change. + +You can install and update the Blender submitter from within Blender using Blender's extension feature. + +To install the Blender submitter using Blender extensions, you need: + + * Blender 4.2 or later. + + * A workstation with consistent internet access. + + + + +**To add the Blender submitter as an extension** + + 1. Open Blender. + + 2. On the **Edit** menu, choose **Preferences…**. + + 3. Choose **Get Extensions** on the left side bar. + + 4. Choose **Repositories** , **+** , **Add Remote Repository**. + + + + 5. For **URL** , enter `https://github.com/aws-deadline/deadline-cloud-for-blender/releases/latest/download/index.json`. + + 6. Select **Check for Updates on Startup** and choose **Create**. + + 7. On the **Deadline Cloud** entry under **Available** , choose **Install**. + + + + + + +The add-on is now installed. You can use the new **Submit to Deadline Cloud** option in the **Render** menu. + +When an update is available, an **Update** button appears next to the **Deadline Cloud** entry in the **Get Extensions** section. @@ -74 +172,33 @@ For more information about using the Blender integrated submitter, see the [Blen -To submit a render job from Blender: +To use the Deadline Cloud for Blender submitter, you need: + + * A profile to submit to Deadline Cloud with. + + * An Deadline Cloud farm and queue to submit to. + + + + +### Submit a job + +**To submit a job from Blender to Deadline Cloud** + + 1. Save your Blender file. + + 2. On the **Render** menu, choose **Submit to Deadline Cloud**. + + * You might see a pop-up to install GUI dependencies. Choose **OK** and wait for the dialog to disappear, then choose **Submit to Deadline Cloud** again. + + 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. + + + + +### Blender-specific settings + +The **Job-specific settings** tab has options specific to jobs created in Blender. + + @@ -76 +206 @@ To submit a render job from Blender: - 1. Open Blender and load your scene file. + * _Project Path_ \- The location where the current project is saved. This value can't be changed. @@ -78 +208 @@ To submit a render job from Blender: - 2. Configure your render settings including output path, frame range, and render engine (Cycles, Eevee, or Workbench). + * _Output Directory_ \- The location to save file outputs from the render job. @@ -80 +210 @@ To submit a render job from Blender: - 3. From the top menu, select **Render** > **Deadline Cloud**. + * _Output File Prefix_ \- The pattern to use when naming file outputs, follows Blender's convention for file names. Output files are formatted like `[LayerName]_[CameraName]_[OutputPrefix].[EXT]`. @@ -82 +212 @@ To submit a render job from Blender: - 4. In the Deadline Cloud submission dialog: + * _Scene_ \- The scene from the current project to render. @@ -84 +214 @@ To submit a render job from Blender: - * Enter a job name and description. + * _Render Engine_ \- The render engine (Cycles, EEVEE, or Workbench) to use. @@ -86 +216 @@ To submit a render job from Blender: - * Select your target farm and queue. + * _View Layers_ \- The layer to render, or "All Renderable Layers" to render each applicable layer in the scene separately. @@ -88 +218 @@ To submit a render job from Blender: - * Configure job attachments to include your scene file and any external assets. + * _Cameras_ \- The camera to render, "All Renderable Cameras" to render each camera in the scene separately, or "Use Default Camera" to use the scene's default camera or cameras bound to timeline markers. @@ -90 +220 @@ To submit a render job from Blender: - * Review render settings and frame range. + * _Cycles GPU Rendering_ \- Whether to enable GPU rendering. Choose a device type supported by Blender or specify your own. If this device type is not supported on your rendering machine, the adaptor attempts to use a compatible device type before falling back to CPU rendering. @@ -92 +222 @@ To submit a render job from Blender: - 5. Choose **Submit** to send your job to the queue. + * _Override Frame Range_ \- Select this option to render a different frame or frame range than is set in the scene file. Frame ranges follow the [Open Job Description](https://github.com/OpenJobDescription/openjd-specifications/wiki/2023-09-Template-Schemas#34111-intrangeexpr) pattern. @@ -97 +227 @@ To submit a render job from Blender: -The Deadline Cloud submission will automatically detect your scene dependencies, configure the appropriate render engine, and submit the job with the correct conda packages for your Blender version. +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).