AWS deadline-cloud: KeyShot submitter docs updated with worker setup and loopback ports
Summary
Reworked KeyShot integration guidance to use the sample submitter, added worker setup details, executable discovery, conda/customer-managed fleet options, and clarified loopback TCP ports used by jobs.
Security assessment
The change is primarily operational documentation, but it explicitly documents that KeyShot job communication uses loopback-only TCP ports and does not require network access, which is security-relevant network exposure guidance. There is no evidence of a specific vulnerability or incident.
Evidence
The job uses TCP ports 9000-9099 on the loopback interface (127.0.0.1) to communicate between its scripts and the KeyShot process. These ports don't need network access.
Diff
diff --git a/deadline-cloud/latest/userguide/keyshot.md b/deadline-cloud/latest/userguide/keyshot.md index fd7f2d7..2139422 100644 --- a//deadline-cloud/latest/userguide/keyshot.md +++ b//deadline-cloud/latest/userguide/keyshot.md @@ -7 +7 @@ -Support overviewKeyShot version compatibilityPrerequisitesGetting startedInstallationUsing the KeyShot submitterAdvanced configurationsOpen source resources +Support overviewKeyShot version compatibilityPrerequisitesGetting startedInstallationSetting up workersUsing the KeyShot submitterAdvanced configurationsOpen source resources @@ -17 +17 @@ KeyShot Studio is supported by the following components: - * **Submitter** : Integrated submitter extension for direct job submission from KeyShot with automatic scene and asset detection. + * **Submitter** : A sample KeyShot script that submits the open scene to Deadline Cloud and attaches the scene's external file references. @@ -43 +43 @@ Before you begin, make sure that you have: - * A Windows or macOS workstation. + * A Windows or macOS workstation with a version of KeyShot Studio that's listed in the preceding table. @@ -45 +45 @@ Before you begin, make sure that you have: - * KeyShot Studio 2023 - 2025. + * Python 3.11 or later on the workstation, to build the submitter script. @@ -47 +47 @@ Before you begin, make sure that you have: - * [Deadline Cloud monitor](https://docs.aws.amazon.com/deadline-cloud/latest/userguide/monitor-onboarding.html) installed. + * The Deadline Cloud CLI with GUI support, installed so that the `deadline` command is on your `PATH`. The Deadline Cloud monitor installer includes the CLI. For more information, see [Set up your workstation](./submitter.html). @@ -49 +49 @@ Before you begin, make sure that you have: - * Access to an Deadline Cloud farm with a fleet that has KeyShot Studio installed and licensed. + * Access to an Deadline Cloud queue with Windows workers that can run KeyShot. For more information, see Setting up workers. @@ -58 +58 @@ To use KeyShot with Deadline Cloud: - 1. Create a service-managed fleet and associate it with a queue. Your queue must be set up with a queue environment that includes your custom conda channel that contains the KeyShot package. For more information, see [Creating a queue environment](https://docs.aws.amazon.com/deadline-cloud/latest/userguide/create-queue-environment.html). + 1. Set up Windows workers that can run KeyShot. For more information, see Setting up workers. @@ -60 +60 @@ To use KeyShot with Deadline Cloud: - 2. Install the Deadline Cloud monitor on your artist workstation. For more information, see [Set up your workstation](./submitter.html). + 2. Install the Deadline Cloud monitor and CLI on your artist workstation. For more information, see [Set up your workstation](./submitter.html). @@ -69 +69 @@ To use KeyShot with Deadline Cloud: -The KeyShot submitter extension allows you to submit jobs to Deadline Cloud directly from within KeyShot. +The KeyShot submitter is a script that you run from inside KeyShot to submit jobs to Deadline Cloud. @@ -73 +73,7 @@ The KeyShot submitter extension allows you to submit jobs to Deadline Cloud dire -The Deadline Cloud submitter installer doesn't include the KeyShot submitter. The submitter is a single script, `Submit to AWS Deadline Cloud.py`, that you build from the [deadline-cloud-for-keyshot repository](https://github.com/aws-deadline/deadline-cloud-for-keyshot) on the GitHub website and copy into your KeyShot scripts folder. For build steps and the scripts folder location on Windows and macOS, see the [deadline-cloud-for-keyshot development guide](https://github.com/aws-deadline/deadline-cloud-for-keyshot/blob/mainline/DEVELOPMENT.md) on the GitHub website. +The Deadline Cloud submitter installer doesn't include the KeyShot submitter. The submitter is a single script, `Submit to AWS Deadline Cloud.py`, that you build from the [KeyShot submitter sample](https://github.com/aws-deadline/deadline-cloud-samples/tree/mainline/job_bundles/custom_submitters/keyshot) on the GitHub website. The build uses only the Python standard library. After you build the script, copy it into your KeyShot scripts folder. KeyShot picks up the new script without a restart. + +In KeyShot Studio preferences, under **General** , clear **Use local Python paths**. This setting prevents the submitter from importing Python libraries that KeyShot doesn't include. + +For the build command and the scripts folder location on Windows and macOS, see the [KeyShot submitter README](https://github.com/aws-deadline/deadline-cloud-samples/blob/mainline/job_bundles/custom_submitters/keyshot/README.md) on the GitHub website. + +The KeyShot submitter was previously in the deadline-cloud-for-keyshot repository, which is no longer updated. Use the sample for the latest code. @@ -77 +83,25 @@ The Deadline Cloud submitter installer doesn't include the KeyShot submitter. Th -To update the submitter, build the script again from the latest version of the repository and replace the copy in your KeyShot scripts folder. +To update the submitter, build the script again from the latest version of the sample and replace the copy in your KeyShot scripts folder. + +## Setting up workers + +KeyShot jobs run on Windows workers that have KeyShot Studio installed and licensed. The job doesn't use an application adaptor. It looks for the KeyShot executable in the following order: + + 1. The `KEYSHOT_EXECUTABLE` environment variable. + + 2. `%KEYSHOT_LOCATION%\bin\keyshot_headless.exe` + + 3. `keyshot_headless.exe` or `keyshot` on the `PATH`. + + + + +Set up workers in one of the following ways: + + * **Service-managed fleets, or any queue with a conda queue environment** : Build a KeyShot conda package with the sample conda recipe that's described in Prerequisites, and host it in your own conda channel. Set the `CondaChannels` default in the queue environment to that channel, or enter the channel in the submitter's job settings. The submitter requests the KeyShot conda package that matches the major version of KeyShot that submits the job. For more information, see [Creating a queue environment](https://docs.aws.amazon.com/deadline-cloud/latest/userguide/create-queue-environment.html). + + * **Customer-managed fleets with KeyShot installed on the host** : Set `KEYSHOT_EXECUTABLE` on the worker, or add the KeyShot installation directory to the `PATH`. Then clear the `CondaPackages` value in the job settings. + + + + +The job uses TCP ports 9000-9099 on the loopback interface (127.0.0.1) to communicate between its scripts and the KeyShot process. These ports don't need network access. @@ -96 +126 @@ Before submitting a job: - 1. In KeyShot, on the top toolbar, choose **Scripting Console**. + 1. Open your scene in KeyShot Studio. @@ -98 +128 @@ Before submitting a job: - 2. In the Scripting Console, navigate to **Scripts** > **Submit to Deadline Cloud**. + 2. Choose **Window** > **Scripting Console**. @@ -100 +130,3 @@ Before submitting a job: - 3. Choose **Run**. + 3. In the Scripting Console, choose **Scripts** > **Submit to AWS Deadline Cloud**. + + 4. Choose **Run**. @@ -153,0 +186,2 @@ After selecting your submission option, the Deadline Cloud submitter interface a + * **Override KeyShot render device** and **Render Device** : Choose CPU or GPU rendering instead of the device set in the scene. To render on GPU, set the minimum GPUs host requirement to 1. + @@ -173 +207 @@ If you require an unsupported version of KeyShot, you can build a custom conda r -The submitter is open source and available on the GitHub website: +The following KeyShot samples are open source and available in the deadline-cloud-samples repository on the GitHub website: @@ -175 +209 @@ The submitter is open source and available on the GitHub website: - * [Deadline Cloud for KeyShot](https://github.com/aws-deadline/deadline-cloud-for-keyshot). + * [KeyShot submitter](https://github.com/aws-deadline/deadline-cloud-samples/tree/mainline/job_bundles/custom_submitters/keyshot).