AWS deadline-cloud medium security documentation change
Summary
Comprehensive rewrite of Unreal Engine integration documentation, adding detailed installation guides for submitter/worker, fleet creation instructions, Perforce credential management, and render job workflows.
Security assessment
Added extensive Perforce credentials management section explicitly discussing security implications of different credential storage methods (Secrets Manager vs registry vs environment variables), highlighting risks of credential exposure in logs/jobs. Specifically warns against insecure methods in production and recommends Secrets Manager for encrypted storage, audit trails, and automatic rotation.
Diff
diff --git a/deadline-cloud/latest/userguide/epic-unreal-engine.md b/deadline-cloud/latest/userguide/epic-unreal-engine.md index bce6892cb..fc9a1a978 100644 --- a//deadline-cloud/latest/userguide/epic-unreal-engine.md +++ b//deadline-cloud/latest/userguide/epic-unreal-engine.md @@ -7 +7 @@ -Support overviewUnreal Engine version compatibilityDeadline Cloud Conda ChannelGetting startedUsing the Unreal Engine submitterAdvanced configurationsUnreal Engine rendering featuresOpen source resources +Support overviewUnreal Engine version compatibilityDeadline Cloud Conda ChannelGetting startedInstalling the submitterCreating a fleetSubmitting a test renderSetting up a customer-managed fleet (CMF) workerPerforce credentials managementCreating a Perforce render jobCustom host requirementsAdvanced configurationsUnreal Engine rendering featuresOpen source resources @@ -11,5 +11 @@ Support overviewUnreal Engine version compatibilityDeadline Cloud Conda ChannelG -###### Note - -For more information about installing, configuring, and using this integration on your workstation, see the [Unreal Engine integration user guide on GitHub](https://aws-deadline.github.io/unreal-engine/). - -Unreal Engine is a real-time 3D creation tool for photoreal visuals and immersive experiences. Unreal Engine is supported by Deadline Cloud with submitters, conda packages, and an adaptor for increased rendering performance. +Unreal Engine is a real-time 3D creation tool for photoreal visuals and immersive experiences. Unreal Engine is supported by 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 Unreal Engine to render your Movie Render Queue projects faster by distributing rendering tasks across multiple machines. @@ -74 +70 @@ Before installing the Unreal Engine submitter, ensure you have the following: -### Installing the Unreal Engine Submitter +## Installing the submitter @@ -78 +74 @@ The Unreal Engine submitter adds Deadline Cloud functionality as a plugin to Unr -For detailed installation instructions, see the [Unreal Submitter Setup Guide](https://aws-deadline.github.io/unreal-engine/setup-submitter/). +### Choosing your branch @@ -80 +76 @@ For detailed installation instructions, see the [Unreal Submitter Setup Guide](h -#### Updating the Submitter +Select the appropriate branch for your deployment: @@ -82 +78,4 @@ For detailed installation instructions, see the [Unreal Submitter Setup Guide](h -Refresh your git repository and re-run the installation script as mentioned in [ Unreal Submitter Setup Guide](https://aws-deadline.github.io/unreal-engine/setup-submitter/). +Branch| Stability| Use case| Recommended for +---|---|---|--- +**release**| Stable| Production| Most users +**mainline**| Latest features| Development and testing| Advanced users @@ -84 +83 @@ Refresh your git repository and re-run the installation script as mentioned in [ -## Using the Unreal Engine submitter +###### Tip @@ -86 +85 @@ Refresh your git repository and re-run the installation script as mentioned in [ -To use the Unreal Engine submitter: +Use the **release** branch for production environments to ensure stability. @@ -88 +87 @@ To use the Unreal Engine submitter: - 1. Open Unreal Engine with your project. +### Creating a new Windows Amazon EC2 instance to install Unreal on (optional) @@ -90 +89 @@ To use the Unreal Engine submitter: - 2. Set up your Movie Render Queue with the desired shots and render settings. +If you're setting up on a brand new Windows Amazon Elastic Compute Cloud (Amazon EC2) instance as your submitter, a g5.2xlarge instance with 200 GB of storage is a reasonable minimum: @@ -92 +91 @@ To use the Unreal Engine submitter: - 3. Access the Deadline Cloud submitter plugin from the Unreal Engine interface. + 1. Launch an Amazon EC2 instance with a valid Instance Profile. This is required to download NVIDIA GRID drivers as instructed below. @@ -94 +93 @@ To use the Unreal Engine submitter: - 4. Configure your job settings including: + 2. Download the Epic Installer and install a supported version of Unreal (5.4 - 5.7). @@ -96 +95 @@ To use the Unreal Engine submitter: - * Movie Render Queue configuration + * UE 5.5 has a known crash bug when running with the DirectX 11 plugin (see UE issue #UE-276282). If you need DirectX support on UE 5.5, use DirectX 12 or later. @@ -98 +97 @@ To use the Unreal Engine submitter: - * Output paths and formats + 3. NVIDIA GRID drivers - Follow the [Windows installation instructions](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/install-nvidia-driver.html#nvidia-GRID-driver). @@ -100 +98,0 @@ To use the Unreal Engine submitter: - * Render parameters @@ -102 +99,0 @@ To use the Unreal Engine submitter: - 5. Choose **Submit** to send your job to Deadline Cloud. @@ -104,0 +102 @@ To use the Unreal Engine submitter: +### Windows long paths @@ -105,0 +104 @@ To use the Unreal Engine submitter: +Many of the steps below may create files that exceed the default Windows maximum path length. Before you build and install the Deadline Cloud for Unreal Engine submitter or adapter on a Windows machine, we recommend that you enable Windows long path support. To do this, follow the instructions on the [Maximum file path limitation](https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation?tabs=registry) page, for example by running the [PowerShell command](https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation?tabs=powershell#tabpanel_1_powershell). @@ -107 +106 @@ To use the Unreal Engine submitter: -The submitter automatically detects Movie Render Queue configurations and handles asset dependencies, including project plugins and content files. +There is also an [open issue on the worker agent](https://github.com/aws-deadline/deadline-cloud-worker-agent/issues/520) caused by a dependency that does not ship configured to support Windows long paths. When you set up your workers, follow the workaround steps in the linked issue to fully support Windows long paths until the issue is resolved. @@ -109 +108,474 @@ The submitter automatically detects Movie Render Queue configurations and handle -## Advanced configurations +### Installing build tools + +The Unreal submitter plugin currently must be compiled locally. + + 1. Install Visual Studio using the [Visual Studio Installer](https://visualstudio.microsoft.com/). + + 2. Verify your Visual Studio and build tools version are compatible with your version of Unreal by checking the [Epic compatibility table](https://dev.epicgames.com/documentation/en-us/unreal-engine/setting-up-visual-studio-development-environment-for-cplusplus-projects-in-unreal-engine?application_version=5.5). + + 3. Under **Individual Components** , ensure that the MSVC build tools version selected ("Latest" by default) matches the recommended version in the table. Even though the compatibility guidance may suggest a version "or later", build errors sometimes occur when using a newer version than the one listed as "recommended". + + 4. Under **Individual Components** , select a recent .NET Framework SDK (4.6.1 and 4.8.1 have been verified). + + 5. Under **Workloads** , select **Desktop development with C++**. + + + + +### Installing Deadline Cloud monitor + +Deadline Cloud monitor is used to both manage your credentials for submitting jobs to Deadline Cloud and monitor the status of your jobs. + + 1. Follow the [Deadline Cloud monitor installation instructions](https://docs.aws.amazon.com/deadline-cloud/latest/userguide/submitter.html#install-deadline-cloud-monitor). + + 2. Sign in. + + + + +### Environment setup + + 1. (If not already installed) Install a recent version of Python for all users (verified with 3.12). + + 2. Make sure your environment variables are set correctly. In System Environment Variables, your PATH must include: + + * The path to your Python installation (for example, `C:\Program Files\Python312`). + + * The path to your Python Scripts folder (for example, `C:\Program Files\Python312\scripts`). + + * The path to your Unreal binaries (for example, `C:\Program Files\Epic Games\UE_5.5\Engine\Binaries\Win64`). + + + + +### Deadline Cloud software installation + +Clone or download `deadline-cloud-for-unreal-engine` from either the release branch or mainline, depending on whether you want the most recent tested release or all of the most recent commits. + + + git clone https://github.com/aws-deadline/deadline-cloud-for-unreal-engine.git + cd deadline-cloud-for-unreal-engine + git switch release + +### Optional - Build and install plugin with script + +A helper script at `scripts/build_plugin.py` optionally automates the next two steps. It attempts to find the latest version of Unreal, builds your plugin and Python dependencies, and installs them in the correct locations. You can override settings such as the Unreal version. To see the full help list, run: + + + python scripts/build_plugin.py -h + +To build and install your current copy of `deadline-cloud-for-unreal-engine` as a submitter with the latest Unreal Engine installation, run: + + + python scripts/build_plugin.py --install + +If you've installed with this script successfully, you can skip to Creating a fleet. + +### Build the plugin + +Adjust the first two paths below based on where your installation of Unreal lives, and where you installed `deadline-cloud-for-unreal-engine`. + +From the Unreal Install Batchfiles folder (the `package` parameter can be any new directory, however you'll want it to be called `UnrealDeadlineCloudService` later): + + + cd C:\Program Files\Epic Games\UE_5.5\Engine\Build\BatchFiles + runuat.bat BuildPlugin -plugin="C:\deadline\deadline-cloud-for-unreal-engine\src\unreal_plugin\UnrealDeadlineCloudService.uplugin" -package="C:\UnrealDeadlineCloudService" + +Copy the "package" folder above to your Unreal installation's Plugins folder (for example, `C:\Program Files\Epic Games\UE_5.5\Engine\Plugins\UnrealDeadlineCloudService`). + +### Python dependencies + +There are 4 ways to install the required Python dependencies. + +1\. If you've built and installed the plugin from the release branch above, you can install from pip. Use the following install command, adjusting the paths to your Unreal installation: + + + "C:\Program Files\Epic Games\UE_5.5\Engine\Binaries\ThirdParty\Python3\Win64\python" -m pip install deadline-cloud-for-unreal-engine --target "C:\Program Files\Epic Games\UE_5.5\Engine\Plugins\UnrealDeadlineCloudService\Content\Python\libraries" + +2\. Alternatively in your `.uplugin` file (in the above steps this would live at `C:\Program Files\Epic Games\UE_5.5\Engine\Plugins\UnrealDeadlineCloudService\UnrealDeadlineCloudService.uplugin`) you can add a `PythonRequirements` section which matches the latest release of `deadline-cloud-for-unreal-engine` in GitHub/PyPI, for example: + + + "PythonRequirements": + [ + { + "Platform": "All", + "Requirements": + [ + "deadline-cloud-for-unreal-engine>=0.5.0" + ] + } + ] + +You may wish to deactivate the "strict hash" feature in Unreal's Python settings, or add hash settings for specific library and dependency versions you wish to consume. + +3\. If you're pulling from mainline you may have Python dependencies which are not yet released to PyPI - you'll need to build and install your local copy which can be done with hatch. The `.whl` file will need to be changed to reflect the version which is output by hatch build: + + + pip install hatch + hatch build + "C:\Program Files\Epic Games\UE_5.5\Engine\Binaries\ThirdParty\Python3\Win64\python" -m pip install dist\deadline_cloud_for_unreal_engine-0.2.2.post21-py3-none-any.whl --target "C:\Program Files\Epic Games\UE_5.5\Engine\Plugins\UnrealDeadlineCloudService\Content\Python\libraries" + +4\. Lastly, Python dependencies can be installed by the submitter installer. These may be out of date with your code above from the release or mainline branch, and this method should not currently be preferred. + + 1. Download the submitter installer from the Deadline Cloud AWS console's Downloads tab or from within Deadline Cloud monitor under Workstation Setup → Downloads. + + 2. Run the installer for all users. Default install location is fine. + + 3. Enable the Unreal Engine plugin. + + 4. Make sure the Unreal Engine plugin install path matches where your plugin was copied to (in particular make sure your Unreal version matches). + + + + +### Update notifications + +The submitter plugin automatically checks for newer releases on GitHub when Unreal Editor starts. If an update is available, a dialog will prompt you to visit the release page. + +To deactivate update notifications, uncheck **Show submitter update notifications** under **General Settings** in the Deadline Cloud settings panel (**Edit** > **Project Settings** > **Plugins** > **Deadline Cloud**). + +Alternatively, you can use the CLI: + + + deadline config set settings.submitter_update_notification false +