knative
/
docs
mirror of https://github.com/knative/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update builder-contract.md (#139) 

Copy edits
This commit is contained in:
Peter Delaney 2018-07-17 17:38:42 -07:00 committed by Google Prow Robot
parent 1d9fb5e5bb
commit f774ffc61b
1 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
build/builder-contract.md
View File

@ -1,6 +1,6 @@
# Builders # Builders
This document serves to define what we call `Builder` images, and the This document defines `Builder` images and the
conventions to which they are expected to adhere. conventions to which they are expected to adhere.
## What is a Builder? ## What is a Builder?
@ -8,7 +8,8 @@ conventions to which they are expected to adhere.
A `Builder` image is a special classification for images that run as a part of A `Builder` image is a special classification for images that run as a part of
the Build CRD's `steps:`. the Build CRD's `steps:`.
For example, in the following Build: For example, in the following Build the images, `gcr.io/cloud-builders/gcloud`
and `gcr.io/cloud-builders/docker` are "Builders".:
```yaml ```yaml
spec: spec:
@ -19,14 +20,11 @@ spec:
... ...
``` ```
The images `gcr.io/cloud-builders/gcloud` and `gcr.io/cloud-builders/docker` are
"Builders".
### Typical Builders ### Typical Builders
A Builder is typically a purpose-built container whose entrypoint is a tool that A Builder is typically a purpose-built container whose entrypoint is a tool that
performs some action and exits with a zero status on success. These are often performs some action and exits with a zero status on success. These entrypoints
command-line tools, e.g. `git`, `docker`, `mvn`, ... are often command-line tools, for example, `git`, `docker`, `mvn`, and so on.
Typical builders set their `command:` (aka `ENTRYPOINT`) to be the command they Typical builders set their `command:` (aka `ENTRYPOINT`) to be the command they
wrap and expect to take `args:` to direct their behavior. wrap and expect to take `args:` to direct their behavior.
@ -52,7 +50,7 @@ steps:
### Specialized Builders ### Specialized Builders
It is also possible for advanced users to create very purpose-built builders. It is also possible for advanced users to create purpose-built builders.
One example of this are the ["FTL" builders]( One example of this are the ["FTL" builders](
https://github.com/GoogleCloudPlatform/runtimes-common/tree/master/ftl#ftl). https://github.com/GoogleCloudPlatform/runtimes-common/tree/master/ftl#ftl).