Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TEP-0114: Updating runs.md Documentation #5390

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/runs.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,16 @@ A `Run` definition supports the following fields:
- Optional:
- [`params`](#specifying-parameters) - Specifies the desired execution
parameters for the custom task.
- [`status`](#) - Used for cancelling a `Run`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think a few of these links are broken.

- [`statusMessage`](#) - Status message for cancellation.
- [`retries`](#) - Specifies propagating retries count to custom tasks.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [`retries`](#) - Specifies propagating retries count to custom tasks.
- [`retries`](#) - Specifies the number of times the `Run` should retry, if the custom task controller supports retries.

- [`serviceAccountName`](#specifying-a-serviceaccount) - Specifies a `ServiceAccount`
object that provides custom credentials for executing the `Run`.
- [`workspaces`](#specifying-workspaces) - Specifies the physical volumes to use for the
[`Workspaces`](workspaces.md) required by a custom task.
- [`podTemplate`](#specifying-a-pod-template) - Specifies a [`Pod` template](podtemplates.md) to use
to configure pods created by the custom task.
- [`timeout`](#) - Time after which the custom-task times out.
- [`workspaces`](#specifying-workspaces) - Specifies the physical volumes to use for the
[`Workspaces`](workspaces.md) required by a custom task.

[kubernetes-overview]:
https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/#required-fields
Expand Down