AWS deadline-cloud medium security documentation change
Summary
Added sections on automating license limits via submission hooks and V-Ray license enforcement example with CLI commands
Security assessment
Directly addresses license compliance risks by documenting enforcement mechanisms. Prevents license overuse which could lead to compliance violations or security incidents from unlicensed software usage.
Diff
diff --git a/deadline-cloud/latest/developerguide/job-limit-job.md b/deadline-cloud/latest/developerguide/job-limit-job.md index 8554f4d3c..c7a49d4ac 100644 --- a//deadline-cloud/latest/developerguide/job-limit-job.md +++ b//deadline-cloud/latest/developerguide/job-limit-job.md @@ -6,0 +7,2 @@ +Automate limits with submission hooksEnd-to-end example: Enforce V-Ray license limits + @@ -75,0 +78,52 @@ JSON +## Automate limits with submission hooks + +If you want to enforce limits across all job submissions without requiring artists to manually edit job templates, you can use a [pre-submission hook](https://github.com/aws-deadline/deadline-cloud/blob/mainline/docs/submission-hooks.md) to automatically inject the host requirement into every job template at submission time. + +A pre-submission hook is a script that runs before the job is submitted. The hook can modify the job bundle's `template.yaml` to add the `hostRequirements` amounts entry for your limit. This approach ensures that every job submitted through the Deadline Cloud CLI or DCC submitters declares its need for the limited resource. + +For a complete working example, see the [license limits submission hook sample](https://github.com/aws-deadline/deadline-cloud-samples/tree/mainline/submission_hooks/license_limits) in the Deadline Cloud samples repository. + +## End-to-end example: Enforce V-Ray license limits + +This example shows how to set up a limit for 5 V-Ray floating licenses and verify that the scheduler enforces it. + +###### To set up and test a V-Ray license limit + + 1. Create the limit on your farm: + + aws deadline create-limit \ + --farm-id farm-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \ + --display-name "VRay License" \ + --amount-requirement-name "amount.vray" \ + --max-count 5 + + 2. Associate the limit with your queue: + + aws deadline create-queue-limit-association \ + --farm-id farm-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \ + --queue-id queue-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \ + --limit-id limit-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + 3. Add the host requirement to your job template: + + specificationVersion: jobtemplate-2023-09 + name: My VRay Render + steps: + - name: Render + hostRequirements: + amounts: + - name: amount.vray + min: 1 + script: + actions: + onRun: + command: vray + args: ["-scene", "{{Param.SceneFile}}"] + + 4. Submit the job. The scheduler allows at most 5 tasks with `amount.vray` to run concurrently across all jobs in the queue. Additional tasks remain in the `READY` state until a slot becomes available. + + + + +To verify the limit is working, temporarily set `maxCount` to 1 and submit two jobs. The first job runs while the second remains in the `READY` state until the first completes. +