AWS deadline-cloud: Document environment wrap actions integration point in Deadline Cloud
Summary
Adds documentation for the Open Job Description WRAP_ACTIONS extension: a new table row for 'Wrap actions', an explanatory bullet describing onWrapTaskRun/onWrapEnvEnter/onWrapEnvExit, a revised note on session-scoped onEnter/onExit actions with migration guidance, and links to the Docker queue environment and the wrap actions RFC.
Security assessment
The change is purely functional/architectural documentation of a job-template integration point (wrap actions) and migration guidance from Deadline 10 callbacks. It mentions running tasks in a container and copying outputs to S3, but describes no vulnerability, credential handling, or access-control change, so it is not security documentation.
Evidence
+Wrap actions | Worker | Queue, job, or step environment (`WRAP_ACTIONS` extension) | In place of each task's run action, and of each inner environment's enter and exit actions | Per-task logic, such as running each task in a container or copying each task's outputs to Amazon S3
Diff
diff --git a/deadline-cloud/latest/developerguide/integration-points.md b/deadline-cloud/latest/developerguide/integration-points.md index dc880ba..c352967 100644 --- a//deadline-cloud/latest/developerguide/integration-points.md +++ b//deadline-cloud/latest/developerguide/integration-points.md @@ -45,0 +46 @@ Step environments | Worker | Job bundle or step template | Before and after a st +Wrap actions | Worker | Queue, job, or step environment (`WRAP_ACTIONS` extension) | In place of each task's run action, and of each inner environment's enter and exit actions | Per-task logic, such as running each task in a container or copying each task's outputs to Amazon S3 @@ -63,0 +65,2 @@ The following integration points run on the rendering host. They are nested from + * **Wrap actions** are the `onWrapTaskRun`, `onWrapEnvEnter`, and `onWrapEnvExit` actions of an environment that uses the Open Job Description `WRAP_ACTIONS` extension. While the environment is active, `onWrapTaskRun` runs in place of every task's `onRun` action and receives the original command, so your code runs before and after each task. The default Docker queue environment uses wrap actions to run tasks in a container. + @@ -71 +74 @@ The following integration points run on the rendering host. They are nested from -Environments are session-scoped, not per-task. An `onExit` action runs at session teardown, not after every task. If you are migrating a Deadline 10 post-task callback, use a dependent step instead of an environment `onExit` action. +Environment `onEnter` and `onExit` actions are session-scoped. An `onExit` action runs at session teardown, not after every task. If you are migrating a Deadline 10 pre-task or post-task callback, use `onWrapTaskRun` to run logic on the worker around each task, or a dependent step to process a step's outputs after all of its tasks finish. @@ -82,0 +86,2 @@ For more information, see the following: + * [Docker queue environment overview](./containers-queue-environment.html) + @@ -84,0 +90,2 @@ For more information, see the following: + * [Environment wrap actions RFC](https://github.com/OpenJobDescription/openjd-specifications/blob/mainline/rfcs/0008-environment-wrap-actions.md) on the GitHub website + @@ -125,0 +133,2 @@ Use the following guidance to choose an integration point for a common need: + * To run logic on the worker before and after every task, use wrap actions. +