Skip to content

docs: clarify container contract documentation to avoid ambiguity #8696

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify container contract documentation to avoid ambiguity #8696

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions docs/container-contract.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ If you do not specify a `command` value, the Pipelines controller performs a loo
the `entrypoint` value in the associated remote container registry. If the image is in
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)
value in the service account definition used by the `Task`.
The Pipelines controller uses this value unless the service account is not
The Pipelines controller uses this value unless the service account is not
defined, at which point it assumes the value of `default`.

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

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

```yaml
spec:
steps:
- image: gcr.io/cloud-builders/gcloud
command: [gcloud]
# No command specified, so the default entrypoint from the image will be used
- image: gcr.io/cloud-builders/docker
command: [docker]
# No command specified, so the default entrypoint from the image will be used
```

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