AWS deadline-cloud: Restructure Deadline Cloud plugin sync documentation
Summary
Rewrites the plugin sync guide: renames sections, adds prerequisites, clarifies the S3 prefix structure, adds a verification procedure, and updates the supported applications table with version folders and worker OS details.
Security assessment
The change is a documentation reorganization of the plugin sync feature (section renames, prerequisites, prefix guidance, verification steps, and an updated support table). It contains no mention of vulnerabilities, credentials, encryption, or access control, so it is not security-related.
Evidence
+Plugin sync delivers custom plugins and add-ons without requiring you to build a conda package. Upload the plugin files to a prescribed prefix in the queue's job attachments bucket. When a job uses a supported application package, the package copies the files to the worker and configures the application to load them.
Diff
diff --git a/deadline-cloud/latest/developerguide/plugin-sync.md b/deadline-cloud/latest/developerguide/plugin-sync.md index 156e3c939..498412ee4 100644 --- a//deadline-cloud/latest/developerguide/plugin-sync.md +++ b//deadline-cloud/latest/developerguide/plugin-sync.md @@ -7 +7 @@ -How plugin sync worksUpload plugins to Amazon S3Supported DCC applications +How plugin sync worksPrerequisitesUpload plugin files to Amazon S3Verify plugin deliveryApplications that support plugin sync @@ -9 +9 @@ How plugin sync worksUpload plugins to Amazon S3Supported DCC applications -# Sync plugins to Deadline Cloud workers +# Deliver custom plugins with plugin sync @@ -11 +11 @@ How plugin sync worksUpload plugins to Amazon S3Supported DCC applications -Artists rely on plugins to extend the functionality of their digital content creation (DCC) applications. Plugins add capabilities such as custom renderers, file format support, and pipeline tools that are essential to production workflows. Delivering these plugins to cloud workers can be complex, especially when managing multiple versions across different applications. +Plugin sync delivers custom plugins and add-ons without requiring you to build a conda package. Upload the plugin files to a prescribed prefix in the queue's job attachments bucket. When a job uses a supported application package, the package copies the files to the worker and configures the application to load them. @@ -13 +13 @@ Artists rely on plugins to extend the functionality of their digital content cre -Plugin sync provides a simplified way to deliver plugins to AWS Deadline Cloud (Deadline Cloud) workers. It works like copying plugins to a shared filesystem folder that all workstations can access—except the shared folder is an Amazon Simple Storage Service (Amazon S3) bucket. You upload your plugin files to a prescribed path in Amazon S3, and Deadline Cloud handles the rest. +Use plugin sync when the plugin can run after its files are copied to an application search path. If the plugin requires dependency resolution, installation commands, or a system change, return to [Use custom plugins with Deadline Cloud](./custom-plugins.html) to choose another delivery method. @@ -17 +17 @@ Plugin sync provides a simplified way to deliver plugins to AWS Deadline Cloud ( -When a job session starts, Deadline Cloud syncs plugin files from your queue's job attachments Amazon S3 bucket to the worker's session directory. The conda package for the DCC application then configures the application to load plugins from that directory. This process is automatic—you only need to place your plugin files in the correct Amazon S3 location. +The supported digital content creation (DCC) conda packages use activation and deactivation scripts for plugin sync. The following events occur for each worker session: @@ -19 +19 @@ When a job session starts, Deadline Cloud syncs plugin files from your queue's j -## Upload plugins to Amazon S3 + 1. The queue environment creates a conda environment containing the DCC and adaptor packages selected by the job. @@ -21 +21,29 @@ When a job session starts, Deadline Cloud syncs plugin files from your queue's j -To deliver plugins to your workers, upload the plugin files to the job attachments Amazon S3 bucket associated with your queue. Use the following folder structure in the bucket: + 2. When conda activates the environment, the DCC package's plugin sync script reads the job attachments bucket and root prefix from the session environment. + + 3. The script downloads files from the operating system, DCC, and DCC version prefix in Amazon S3. It then sets application-specific environment variables or copies the files to an application plugin directory. + + 4. When the session ends, the deactivation script removes the downloaded plugin files and configuration. The next session starts from the packaged DCC environment. + + + + +The script writes messages that begin with `Plugin Sync:` to the session log. You can use these messages to confirm the source prefix, destination, and files processed. + +## Prerequisites + +Before you upload a plugin, confirm the following requirements: + + * The application, version, and worker operating system appear in the supported applications table. + + * The plugin files are compatible with the worker operating system, application version, and processor architecture. + + * You know the plugin vendor's required directory structure. Plugin sync preserves the directory structure that you upload. + + * If the plugin requires a license, the worker can reach the license server. + + + + +## Upload plugin files to Amazon S3 + +Upload the plugin files to the job attachments Amazon S3 bucket associated with your queue. Use the following prefix: @@ -28 +56,6 @@ To deliver plugins to your workers, upload the plugin files to the job attachmen -The Amazon S3 path is case-sensitive. Use lowercase for all folder names in the path. +The Amazon S3 prefix is case-sensitive. Use lowercase for the operating system and DCC folder names. + +Replace the variables as follows: + +``<job-attachments-bucket>`` + @@ -30 +63 @@ The Amazon S3 path is case-sensitive. Use lowercase for all folder names in the -Where: +The job attachments bucket associated with your queue. The queue details page displays the bucket. @@ -32 +65 @@ Where: - * ``<job-attachments-bucket>`` – The job attachments Amazon S3 bucket associated with your queue (visible in the queue details page). +``<root-prefix>`` @@ -34 +66,0 @@ Where: - * ``<root-prefix>`` – The job attachment root prefix for your queue (visible in the queue details page). @@ -36 +68 @@ Where: - * ``<os>`` – The operating system: `linux` or `windows`. +The job attachments root prefix for your queue. The queue details page displays the prefix. @@ -38 +70 @@ Where: - * ``<dcc-name>`` – The DCC application name in lowercase. See the supported DCC applications table for the exact folder name to use. +``<os>`` @@ -40 +71,0 @@ Where: - * ``<dcc-version>`` – The DCC application version (for example, `2025` for Maya, `5.0` for Blender). @@ -41,0 +73 @@ Where: +The worker operating system, either `linux` or `windows`. @@ -42,0 +75 @@ Where: +``<dcc-name>`` @@ -45 +78 @@ Where: -###### Note +The exact folder name from the supported applications table. @@ -47 +80 @@ Where: -Use the major version number in the path. Patch versions such as Maya 2025.3 use `2025`. +``<dcc-version>`` @@ -49 +82,4 @@ Use the major version number in the path. Patch versions such as Maya 2025.3 use -For example, to deliver a Maya 2025 plugin on Linux: + +The version folder from the supported applications table. For example, Maya 2025.3 uses `2025`, and Blender 5.1 uses `5.1`. + +For example, the prefix for a Maya 2025 plugin on Linux is: @@ -54 +90 @@ For example, to deliver a Maya 2025 plugin on Linux: -###### To upload plugins using the Amazon S3 console +###### To upload plugin files using the Amazon S3 console @@ -56 +92 @@ For example, to deliver a Maya 2025 plugin on Linux: - 1. Open the Deadline Cloud console and navigate to your queue details page. + 1. Open the Deadline Cloud console, and then open the queue details page. @@ -60 +96 @@ For example, to deliver a Maya 2025 plugin on Linux: - 3. Navigate to the root prefix folder for your queue. + 3. Open the root prefix for the queue. @@ -62 +98 @@ For example, to deliver a Maya 2025 plugin on Linux: - 4. Create the folder path `plugins/`<os>`/`<dcc-name>`/`<dcc-version>`` (for example, `plugins/linux/maya/2025`). + 4. Create the prefix `plugins/`<os>`/`<dcc-name>`/`<dcc-version>`/`. For example, use `plugins/linux/maya/2025/` for Maya 2025. @@ -64 +100 @@ For example, to deliver a Maya 2025 plugin on Linux: - 5. Upload your plugin files into the version folder. + 5. Upload the plugin files and directories to the version prefix. Preserve the directory structure that the plugin vendor requires. @@ -69 +105 @@ For example, to deliver a Maya 2025 plugin on Linux: -## Supported DCC applications +## Verify plugin delivery @@ -71 +107 @@ For example, to deliver a Maya 2025 plugin on Linux: -The following table lists DCC applications that support plugin sync, the exact Amazon S3 folder name to use, whether a conda recipe sample is available on the GitHub website, and whether the service-managed fleet conda channel supports plugin sync for that application. +###### To verify that plugin sync delivered the files @@ -73,8 +109,3 @@ The following table lists DCC applications that support plugin sync, the exact A -DCC application | S3 folder name | Supported versions | [Conda recipe sample](https://github.com/aws-deadline/deadline-cloud-samples/tree/mainline/conda_recipes) | Service-managed fleet | Forum ----|---|---|---|---|--- -Blender | `blender` | 5.0, 5.1 | ✓ Yes | ✓ Yes | [Plugins](https://github.com/aws-deadline/deadline-cloud-for-blender/discussions/categories/plugins) -Autodesk Maya | `maya` | 2024, 2025, 2026 | ✓ Yes | ✓ Yes | [Plugins](https://github.com/aws-deadline/deadline-cloud-for-maya/discussions/categories/plugins) -Foundry Nuke | `nuke` | 15.0, 16.0, 17.0 | ✓ Yes | ✓ Yes | [Plugins](https://github.com/aws-deadline/deadline-cloud-for-nuke/discussions/categories/plugins) -SideFX Houdini | `houdini` | 19.5, 20.0, 20.5, 21.0 | ✓ Yes | ✓ Yes | [Plugins](https://github.com/aws-deadline/deadline-cloud-for-houdini/discussions/categories/plugins) -Maxon Cinema 4D | `cinema4d` | 2024, 2025, 2026 | ✓ Yes | ✓ Yes | Not applicable -Adobe After Effects | `aftereffects` | 24, 25, 26 | ✓ Yes | ✓ Yes | Not applicable + 1. Submit a job that selects the supported DCC package and version. + + 2. In the AWS Deadline Cloud monitor (Deadline Cloud monitor), open the session log for a task. @@ -82 +113 @@ Adobe After Effects | `aftereffects` | 24, 25, 26 | ✓ Yes | ✓ Yes | Not appl -To find or discuss supported plugins, visit our GitHub forum for each DCC integration. + 3. Search the session log for `Plugin Sync:`. Confirm that the log shows the expected Amazon S3 prefix and destination. @@ -84 +115,17 @@ To find or discuss supported plugins, visit our GitHub forum for each DCC integr -###### Note + 4. Confirm in the task log that the application loaded the plugin. The message depends on the application and plugin. + + + + +## Applications that support plugin sync + +The following table lists applications and versions that contain plugin sync scripts. It also identifies whether a conda recipe sample is available on the GitHub website and whether the `deadline-cloud` channel for service-managed fleets includes the scripts. + +DCC application | S3 folder name | Version folders | Worker operating system | [Conda recipe sample](https://github.com/aws-deadline/deadline-cloud-samples/tree/mainline/conda_recipes) | Service-managed fleet package +---|---|---|---|---|--- +Blender | `blender` | `5.0`, `5.1` | Linux | Yes | Yes +Autodesk Maya | `maya` | `2024`, `2025`, `2026`, `2027` | Linux | Yes | Yes +Foundry Nuke | `nuke` | `15.0`, `16.0`, `17.0` | Linux | Yes | Yes +SideFX Houdini | `houdini` | `19.5`, `20.0`, `20.5`, `21.0`, `22.0` | Linux | Yes | Yes +Maxon Cinema 4D | `cinema4d` | Linux: `2024.5.1`, `2025.3.1`, and `2026.3.4`; Windows: `2025.3.3` and `2026.3.4` | 2024: Linux; 2025 and 2026: Linux and Windows | Yes | Yes +Adobe After Effects | `aftereffects` | `25.6` or `25.6.4`; `26.0` or `26.0.0` | Windows | Yes | Yes @@ -86 +133 @@ To find or discuss supported plugins, visit our GitHub forum for each DCC integr -You can also use our [conda recipe samples](https://github.com/aws-deadline/deadline-cloud-samples/tree/mainline/conda_recipes) on the GitHub website for plugin sync with self-hosted channels. To build and host your own channel, see [Create a conda channel using S3](./configure-jobs-s3-channel.html). +If your application or version does not appear in the table, see [Package a plugin](./conda-package.html#conda-package-plugins) or [Configure jobs using queue environments](./configure-jobs.html), or use a customer-managed fleet. The [conda recipe samples](https://github.com/aws-deadline/deadline-cloud-samples/tree/mainline/conda_recipes) on the GitHub website include plugin sync scripts that you can use with a self-hosted channel. @@ -94 +141 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -Automate package builds with Deadline Cloud +Use custom plugins with Deadline Cloud @@ -96 +143 @@ Automate package builds with Deadline Cloud -Host configuration scripts +Configure jobs using queue environments