Skip to content

Commit 832a062

Browse files
committed
docs: clarify container contract documentation to avoid ambiguity
fix tektoncd#8647
1 parent 99c805a commit 832a062

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/container-contract.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ If you do not specify a `command` value, the Pipelines controller performs a loo
3030
the `entrypoint` value in the associated remote container registry. If the image is in
3131
a private registry, you must include an [`ImagePullSecret`](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#add-imagepullsecrets-to-a-service-account)
3232
value in the service account definition used by the `Task`.
33-
The Pipelines controller uses this value unless the service account is not
33+
The Pipelines controller uses this value unless the service account is not
3434
defined, at which point it assumes the value of `default`.
3535

3636
The final fallback occurs to the Docker config specified in the `$HOME/.docker/config.json` file.
@@ -39,16 +39,16 @@ controller performs an anonymous lookup of the image.
3939

4040
For example, consider the following `Task`, which uses two images named
4141
`gcr.io/cloud-builders/gcloud` and `gcr.io/cloud-builders/docker`. In this example, the
42-
Pipelines controller retrieves the `entrypoint` value from the registry, which allows
43-
the `Task` to execute the `gcloud` and `docker` commands, respectively.
42+
Pipelines controller retrieves the `entrypoint` value from the registry, which means
43+
the container will execute using the default `entrypoint` defined in the image.
4444

4545
```yaml
4646
spec:
4747
steps:
4848
- image: gcr.io/cloud-builders/gcloud
49-
command: [gcloud]
49+
# No command specified, so the default entrypoint from the image will be used
5050
- image: gcr.io/cloud-builders/docker
51-
command: [docker]
51+
# No command specified, so the default entrypoint from the image will be used
5252
```
5353

5454
However, if you specify a custom `command` value, the controller uses that value instead:

0 commit comments

Comments
 (0)