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

Update build-templates.md (#138) 

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

19
build/build-templates.md
View File

@ -1,23 +1,23 @@
# Build Templates # Build Templates
This document serves to define "Build Templates", and their capabilities. This document defines "Build Templates" and their capabilities.
A set of curated and supported build templates is available in the A set of curated and supported build templates is available in the
[`build-templates`](https://github.com/knative/build-templates) repo. [`build-templates`](https://github.com/knative/build-templates) repo.
## What is a Build Template? ## What is a Build Template?
A `BuildTemplate` serves to encapsulate a shareable [build](./builds.md) A `BuildTemplate` encapsulates a shareable [build](./builds.md)
process with some limited paramaterization capabilities. process with some limited paramaterization capabilities.
### Example Template ### Example template
For example, a `BuildTemplate` to encapsulate a `Dockerfile` build might look For example, a `BuildTemplate` to encapsulate a `Dockerfile` build might look
something like this: something like this:
**NB:** Building a container image using `docker build` on-cluster is _very **Note:** Building a container image using `docker build` on-cluster is _very
unsafe_. Use [kaniko](https://github.com/GoogleContainerTools/kaniko) instead. unsafe_. Use [kaniko](https://github.com/GoogleContainerTools/kaniko) instead.
This is only used for the purposes of demonstration. This is used only for the purposes of demonstration.
```yaml ```yaml
spec: spec:
@ -26,7 +26,7 @@ spec:
- name: IMAGE - name: IMAGE
description: Where to publish the resulting image. description: Where to publish the resulting image.
# These may be overriden, but provide sensible defaults. # These may be overridden, but provide sensible defaults.
- name: DIRECTORY - name: DIRECTORY
description: The directory containing the build context. description: The directory containing the build context.
default: /workspace default: /workspace
@ -64,11 +64,12 @@ spec:
In this example, `parameters` describes the formal arguments for the template. In this example, `parameters` describes the formal arguments for the template.
The `description` is used for diagnostic messages during validation (and maybe The `description` is used for diagnostic messages during validation (and maybe
in the future for UI). The `default` value enables a template to have a in the future for UI). The `default` value enables a template to have a
graduated complexity, where options are only overridden when the user strays graduated complexity, where options are overridden only when the user strays
from some set of sane defaults. from some set of sane defaults.
`steps` and `volumes` are just like in a [`Build`(./builds.md) resource, but The `steps` and `volumes` parameters are just like in a [`Build`](./builds.md)
may contain references to parameters in the form: `${PARAMETER_NAME}`. resource, but might contain references to parameters in the form:
`${PARAMETER_NAME}`.
The `steps` of a template replace those of its Build. The `volumes` of a The `steps` of a template replace those of its Build. The `volumes` of a
template augment those of its Build. template augment those of its Build.