Skip to content

Commit ff29782

Browse files
tualerontekton-robot
tualeron
authored and
tekton-robot
committed
Tighten up the language for clarity and flow.
Improves and standardizes the wording throughout the document.
1 parent c76a6ad commit ff29782

File tree

1 file changed

+63
-64
lines changed

1 file changed

+63
-64
lines changed

‎docs/variables.md‎

Lines changed: 63 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -4,108 +4,107 @@ linkTitle: "Variable Substitutions"
44
weight: 15
55
---
66
-->
7-
# Variable Substitutions
7+
# Variable Substitutions Supported by `Tasks` and `Pipelines`
88

9-
This doc aggregates the complete set of variable substitions available
10-
in `Tasks` and `Pipelines`.
9+
This page documents the variable substitions supported by `Tasks` and `Pipelines`.
1110

12-
## Variables Available in a Pipeline
11+
## Variables available in a `Pipeline`
1312

1413
| Variable | Description |
1514
| -------- | ----------- |
16-
| `params.<param name>` | The value of the param at runtime. |
17-
| `tasks.<task name>.results.<result name>` | The value of a Task's result (**Note**: Affects Task ordering in a Pipeline!) |
15+
| `params.<param name>` | The value of the parameter at runtime. |
16+
| `tasks.<taskName>.results.<resultName>` | The value of the `Task's` result. Can alter `Task` execution order within a `Pipeline`.) |
1817

19-
## Variables Available in a Task
18+
## Variables available in a `Task`
2019

2120
| Variable | Description |
2221
| -------- | ----------- |
23-
| `params.<param name>` | The value of the param at runtime. |
24-
| `resources.inputs.<resource name>.path` | The path to the input resource's directory. |
25-
| `resources.outputs.<resource name>.path` | The path to the output resource's directory. |
26-
| `results.<result name>.path` | The path to the file where a Task's result should be written. |
27-
| `workspaces.<workspace name>.path` | The path to the mounted workspace. |
28-
| `workspaces.<workspace name>.claim` | The name of the PersistentVolumeClaim used as a volume source for the workspace or empty string if a volume source other than PersistentVolumeClaim was used. |
29-
| `workspaces.<workspace name>.volume` | The name of the volume populating the workspace. |
30-
| `credentials.path` | The path to the location of credentials written by the `creds-init` init container. |
22+
| `params.<param name>` | The value of the parameter at runtime. |
23+
| `resources.inputs.<resourceName>.path` | The path to the input resource's directory. |
24+
| `resources.outputs.<resourceName>.path` | The path to the output resource's directory. |
25+
| `results.<resultName>.path` | The path to the file where the `Task` writes its results data. |
26+
| `workspaces.<workspaceName>.path` | The path to the mounted `Workspace`. |
27+
| `workspaces.<workspaceName>.claim` | The name of the `PersistentVolumeClaim` specified as a volume source for the `Workspace`. Empty string for other volume types. |
28+
| `workspaces.<workspaceName>.volume` | The name of the volume populating the `Workspace`. |
29+
| `credentials.path` | The path to the credentials written by the `creds-init` init container. |
3130

32-
### PipelineResource Variables
31+
### `PipelineResource` variables available in a `Task`
3332

34-
Each PipelineResource exposes its own set of variables. Below the variables are grouped by
35-
PipelineResource type. These are available in `Tasks`.
33+
Each supported type of `PipelineResource` specified within a `Task` exposes a unique set
34+
of variables. This section lists the variables exposed by each type. You can access a
35+
variable via `resources.inputs.<resourceName>.<variableName>` or
36+
`resources.outputs.<resourceName>.<variableName>`.
3637

37-
Each variable is accessible via `resources.inputs.<resource name>.<variable name>` or
38-
`resources.outputs.<resource name>.<variable name>`.
39-
40-
#### Git PipelineResource
38+
#### Variables for the `Git` type
4139

4240
| Variable | Description |
4341
| -------- | ----------- |
44-
| `name` | The resource's name |
45-
| `type` | `"git"` |
46-
| `url` | The URL to the Git repo |
47-
| `revision` | The revision to be checked out. |
48-
| `depth` | The integer value of the resource's `depth` param. |
49-
| `sslVerify` | The value of the resource's `sslVerify` param: `"true"` or `"false"`. |
50-
| `httpProxy` | The value of the resource's `httpProxy` param. |
51-
| `httpsProxy` | The value of the resource's `httpsProxy` param. |
52-
| `noProxy` | The value of the resource's `noProxy` param. |
53-
54-
#### PullRequest PipelineResource
42+
| `name` | The name of the resource. |
43+
| `type` | Type value of `"git"`. |
44+
| `url` | The URL of the Git repository. |
45+
| `revision` | The revision to check out. |
46+
| `refspec` | The value of the resource's `refspec` parameter. |
47+
| `depth` | The integer value of the resource's `depth` parameter. |
48+
| `sslVerify` | The value of the resource's `sslVerify` parameter, either `"true"` or `"false"`. |
49+
| `httpProxy` | The value of the resource's `httpProxy` parameter. |
50+
| `httpsProxy` | The value of the resource's `httpsProxy` parameter. |
51+
| `noProxy` | The value of the resource's `noProxy` parameter. |
52+
53+
#### Variables for the `PullRequest` type
5554

5655
| Variable | Description |
5756
| -------- | ----------- |
58-
| `name` | The resource's name |
59-
| `type` | `"pullRequest"` |
60-
| `url` | The URL pointing to the pull request. |
61-
| `provider` | `"github"` or `"gitlab"`. |
62-
| `insecure-skip-tls-verify` | The value of the resource's `insecure-skip-tls-verify` param: `"true"` or `"false"`. |
57+
| `name` | The name of the resource. |
58+
| `type` | Type value of `"pullRequest"`.|
59+
| `url` | The URL of the pull request. |
60+
| `provider` | Provider value, either `"github"` or `"gitlab"`. |
61+
| `insecure-skip-tls-verify` | The value of the resource's `insecure-skip-tls-verify` parameter, either `"true"` or `"false"`. |
6362

64-
#### Image PipelineResource
63+
#### Variables for the `Image` type
6564

6665
| Variable | Description |
6766
| -------- | ----------- |
68-
| `name` | The resource's name |
69-
| `type` | `"image"` |
67+
| `name` | The name of the resource. |
68+
| `type` | Type value of `"image"`. |
7069
| `url` | The complete path to the image. |
71-
| `digest` | The image's digest. |
70+
| `digest` | The digest of the image. |
7271

73-
#### GCS PipelineResource
72+
#### Variables for the `GCS` type
7473

7574
| Variable | Description |
7675
| -------- | ----------- |
77-
| `name` | The resource's name |
78-
| `type` | `"gcs"` |
79-
| `location` | The location of the blob storage. |
76+
| `name` | The name of the resource. |
77+
| `type` | Type value of `"gcs"`. |
78+
| `location` | The fully qualified address of the blob storage. |
8079

81-
#### BuildGCS PipelineResource
80+
#### Variables for the `BuildGCS` type
8281

8382
| Variable | Description |
8483
| -------- | ----------- |
85-
| `name` | The resource's name |
86-
| `type` | `"build-gcs"` |
87-
| `location` | The location of the blob storage. |
84+
| `name` | The name of the resource. |
85+
| `type` | Type value of `"build-gcs"`. |
86+
| `location` | The fully qualified address of the blob storage. |
8887

89-
#### Cluster PipelineResource
88+
#### Variables for the `Cluster` type
9089

9190
| Variable | Description |
9291
| -------- | ----------- |
93-
| `name` | The resource's name |
94-
| `type` | `"cluster"` |
95-
| `url` | Host url of the master node. |
92+
| `name` | The name of the resource. |
93+
| `type` | Type value of `"cluster"`. |
94+
| `url` | Host URL of the master node. |
9695
| `username` | The user with access to the cluster. |
97-
| `password` | The password to be used for clusters with basic auth. |
96+
| `password` | The password for the user specified in `username`. |
9897
| `namespace` | The namespace to target in the cluster. |
99-
| `token` | Bearer token. |
100-
| `insecure` | Whether TLS connection to server should be verified: `"true"` or `"false"`. |
101-
| `cadata` | Stringified PEM-encoded bytes typically read from a root certificates bundle. |
102-
| `clientKeyData` | Stringified PEM-encoded bytes from a client key file for TLS. |
103-
| `clientCertificateData` | Stringified PEM-encoded bytes from a client cert file for TLS. |
98+
| `token` | The bearer token. |
99+
| `insecure` | Whether to verify the TLS connection to the server, either `"true"` or `"false"`. |
100+
| `cadata` | Stringified PEM-encoded bytes from the relevant root certificate bundle. |
101+
| `clientKeyData` | Stringified PEM-encoded bytes from the client key file for TLS. |
102+
| `clientCertificateData` | Stringified PEM-encoded bytes from the client certificate file for TLS. |
104103

105-
#### CloudEvent PipelineResource
104+
#### Variables for the `CloudEvent` type
106105

107106
| Variable | Description |
108107
| -------- | ----------- |
109-
| `name` | The resource's name |
110-
| `type` | `"cloudEvent"` |
111-
| `target-uri` | The URI that will be hit with cloud event payloads. |
108+
| `name` | The name of the resource. |
109+
| `type` | Type value of `"cloudEvent"`. |
110+
| `target-uri` | The URI to hit with cloud event payloads. |

0 commit comments

Comments
 (0)