Skip to content

Commit 8107948

Browse files
tomfrenkentekton-robot
authored andcommittedOct 25, 2019
Improve documentation
1 parent e3838c3 commit 8107948

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed
 

‎docs/pipelineruns.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ following fields:
4242
object that enables your build to run with the defined authentication
4343
information. When a `ServiceAccount` isn't specified, the `default-service-account`
4444
specified in the configmap - config-defaults will be applied.
45-
- [`serviceAccountNames`](#service-accounts) - Specifies a list of `ServiceAccountName`
46-
and `PipelineTask` pairs that enable you to overwrite `ServiceAccount` for concrete `PipelineTask`.
47-
- [`timeout`] - Specifies timeout after which the `PipelineRun` will fail. If the value of
45+
- [`serviceAccountNames`](#service-accounts) - Specifies a list of `serviceAccountName`
46+
and `PipelineTask` pairs that enable you to overwrite a `ServiceAccount` for a concrete `PipelineTask`.
47+
- `timeout` - Specifies timeout after which the `PipelineRun` will fail. If the value of
4848
`timeout` is empty, the default timeout will be applied. If the value is set to 0,
4949
there is no timeout. `PipelineRun` shares the same default timeout as `TaskRun`. You can
5050
follow the instruction [here](taskruns.md#Configuring-default-timeout) to configure the
@@ -85,14 +85,14 @@ spec:
8585
greetings while embedding the spec of the `Pipeline` directly in the `PipelineRun`.
8686

8787

88-
After creating such `PipelineRun`, logs from a pod displaying morning greetings:
88+
After creating such a `PipelineRun`, the logs from this pod are displaying morning greetings:
8989

9090
```bash
9191
kubectl logs $(kubectl get pods -o name | grep pipelinerun-echo-greetings-echo-good-morning)
9292
Good Morning, Bob!
9393
```
9494

95-
And logs from a pod displaying morning greetings:
95+
And the logs from this pod are displaying evening greetings:
9696
```bash
9797
kubectl logs $(kubectl get pods -o name | grep pipelinerun-echo-greetings-echo-good-night)
9898
Good Night, Bob!
@@ -107,12 +107,12 @@ be run with different `PipelineResources` in cases such as:
107107
- When triggering the run of a `Pipeline` against a pull request, the triggering
108108
system must specify the commitish of a git `PipelineResource` to use
109109
- When invoking a `Pipeline` manually against one's own setup, one will need to
110-
ensure that one's own GitHub fork (via the git `PipelineResource`), image
110+
ensure one's own GitHub fork (via the git `PipelineResource`), image
111111
registry (via the image `PipelineResource`) and Kubernetes cluster (via the
112112
cluster `PipelineResource`).
113113

114-
Specify the `PipelineResources` in the PipelineRun using the `resources` section
115-
in the `PipelineRun` spec, for example:
114+
Specify the `PipelineResources` in the `PipelineRun` using the `resources` section
115+
in the PipelineRun's spec, for example:
116116

117117
```yaml
118118
spec:
@@ -162,7 +162,7 @@ Specifies the `name` of a `ServiceAccount` resource object. Use the
162162
`serviceAccountName` field to run your `Pipeline` with the privileges of the
163163
specified service account. If no `serviceAccountName` field is specified, your
164164
resulting `TaskRuns` run using the service account specified in the ConfigMap
165-
`configmap-defaults` which if absent will default to
165+
`configmap-defaults` which if absent will default to the
166166
[`default` service account](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server)
167167
that is in the [namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/)
168168
of the `TaskRun` resource object.
@@ -172,9 +172,9 @@ For examples and more information about specifying service accounts, see the
172172

173173
### Service Accounts
174174

175-
Specifies the list of `ServiceAccountName` and `PipelineTask` pairs. Specified
176-
`PipelineTask` will be run with configured `ServiceAccount`,
177-
overwriting [`serviceAccountName`](#service-account) configuration, for example:
175+
Specifies the list of `serviceAccountName` and `PipelineTask` pairs. A specified
176+
`PipelineTask` will be run with the configured `ServiceAccount`,
177+
overwriting the [`serviceAccountName`](#service-account) configuration, for example:
178178

179179
```yaml
180180
spec:
@@ -220,9 +220,9 @@ allows to customize some Pod specific field per `Task` execution, aka
220220
[runtime class](https://kubernetes.io/docs/concepts/containers/runtime-class/)
221221
to use to run the pod.
222222

223-
In the following example, the Task is defined with a `volumeMount`
224-
(`my-cache`), that is provided by the PipelineRun, using a
225-
PersistenceVolumeClaim. The Pod will also run as a non-root user.
223+
In the following example, the `Task` is defined with a `volumeMount`
224+
(`my-cache`), that is provided by the `PipelineRun`, using a
225+
`persistentVolumeClaim`. The Pod will also run as a non-root user.
226226

227227
```yaml
228228
apiVersion: tekton.dev/v1alpha1

0 commit comments

Comments
 (0)
Please sign in to comment.