Update docs with timeout field

- timeout now on taskRun and PipelineRun
tektoncd · Feb 3, 2019 · 7b5938b · 7b5938b
1 parent 9585e0d
commit 7b5938b
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 9 deletions.
diff --git a/docs/pipelineruns.md b/docs/pipelineruns.md
@@ -41,7 +41,12 @@ following fields:
   - [`serviceAccount`](#service-account) - Specifies a `ServiceAccount`
     resource object that enables your build to run with the defined
     authentication information.
-
+  - `timeout` - Specifies timeout after which the `PipelineRun` will fail.
+  - [`nodeSelector`] - a selector which must be true for the pod to fit on a node.
+     The selector which must match a node's labels for the pod to be scheduled on that node.
+     More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
+  - [`affinity`] - the pod's scheduling constraints. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#node-affinity-beta-feature
+
 [kubernetes-overview]:
   https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/#required-fields
 

diff --git a/docs/pipelines.md b/docs/pipelines.md
@@ -28,7 +28,6 @@ following fields:
 - Optional:
   - [`resources`](#declared-resources) - Specifies which [`PipelineResources`](resources.md)
     of which types the `Pipeline` will be using in its [Tasks](#pipeline-tasks)
-  - `timeout` - Specifies timeout after which the `Pipeline` will fail.
 
 [kubernetes-overview]:
   https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/#required-fields

diff --git a/docs/taskruns.md b/docs/taskruns.md
@@ -47,7 +47,12 @@ following fields:
   - [`inputs`] - Specifies [input parameters](#input-parameters) and
     [input resources](#providing-resources)
   - [`outputs`] - Specifies [output resources](#providing-resources)
-
+  - `timeout` - Specifies timeout after which the `TaskRun` will fail.
+  - [`nodeSelector`] - a selector which must be true for the pod to fit on a node.
+     The selector which must match a node's labels for the pod to be scheduled on that node.
+     More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
+  - [`affinity`] - the pod's scheduling constraints. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#node-affinity-beta-feature
+
 [kubernetes-overview]:
   https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/#required-fields
 

diff --git a/docs/tasks.md b/docs/tasks.md
@@ -70,11 +70,6 @@ following fields:
   - [`outputs`](#outputs) - Specifies [`PipelineResources`](resources.md) needed by your `Task`
   - [`volumes`](#volumes) - Specifies one or more volumes that you want to make
     available to your build.
-  - `timeout` - Specifies timeout after which the `Task` will fail.
-  - [`nodeSelector`] - a selector which must be true for the pod to fit on a node.
-     The selector which must match a node's labels for the pod to be scheduled on that node.
-     More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
-  - [`affinity`] - the pod's scheduling constraints. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#node-affinity-beta-feature
 
 [kubernetes-overview]:
   https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/#required-fields

diff --git a/docs/using.md b/docs/using.md
@@ -1009,7 +1009,7 @@ Below is an example on how to create a storage resource with service account.
          secretKey: service_account.json
    ```
 
-## Timing Out Pipelines and Tasks
+## Timing Out PipelinesRun and TasksRuns
 
 If you want to ensure that your `PipelineRun` or `TaskRun` will be stopped if it runs
 past a certain duration, you can use the `Timeout` field on either `PipelineRun`