Rename Buildpacks-V3 task to Buildpacks, and add Buildpacks-Phases task

task/buildpacks-v3/0.1/README.md → task/buildpacks-phases/0.1/README.md

@@ -1,35 +1,28 @@
 # Cloud Native Buildpacks
 
 This build template builds source into a container image using [Cloud Native
-Buildpacks](https://buildpacks.io).
+Buildpacks](https://buildpacks.io). To do that, it uses [builders](https://buildpacks.io/docs/concepts/components/builder/#what-is-a-builder) to run buildpacks against your application.
 
-The Cloud Native Buildpacks website describes v3 buildpacks as:
+Cloud Native Buildpacks are pluggable, modular tools that transform application source code into OCI images. They replace Dockerfiles in the app development lifecycle, and enable for swift rebasing of images and modular control over images (through the use of builders), among other benefits. This command uses a builder to construct the image, and pushes it to the registry provided.
 
-> ... pluggable, modular tools that translate source code into container-ready
-> artifacts such as OCI images. They replace Dockerfiles in the app development
-> lifecycle with a higher level of abstraction. ...  Cloud Native Buildpacks
-> embrace modern container standards, such as the OCI image format. They take
-> advantage of the latest capabilities of these standards, such as remote image
-> layer rebasing on Docker API v2 registries.
+See also [`buildpacks`](../buildpacks) for the combined version of this task, which uses the [creator binary](https://github.com/buildpacks/spec/blob/platform/0.3/platform.md#operations), to run all of the [lifecycle phases](https://buildpacks.io/docs/concepts/components/lifecycle/#phases). This task, in contrast, runs all of the phases separately.
 
 ## Install the Task
 
 ```
-kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/task/buildpacks-v3/0.1/buildpacks-v3.yaml
+kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/task/buildpacks-phases/0.1/buildpacks-phases.yaml
 ```
 
 > **NOTE:** This task is currently only compatible with Tekton **v0.11.0** and above, and CNB Platform API 0.3 (lifecycle v0.7.0 and above). For previous Platform API versions, [see below](#previous-platform-api-versions).
 
 ## Parameters
 
-* **`BUILDER_IMAGE`**: The image on which builds will run. (must include v3 lifecycle and compatible buildpacks; _required_)
+* **`BUILDER_IMAGE`**: The image on which builds will run. (must include lifecycle and compatible buildpacks; _required_)
 
-* **`CACHE`**: The name of the persistent app cache volume. (_default:_ an empty
-  directory -- effectively no cache)
+* **`CACHE`**: The name of the persistent app cache volume. (_default:_ an empty directory -- effectively no cache)
 
 * **`PLATFORM_DIR`**: A directory containing platform provided configuration, such as environment variables.
-  Files of the format `/platform/env/MY_VAR` with content `my-value` will be translated by the lifecycle into
-  environment variables provided to buildpacks. For more information, see the [buildpacks spec](https://github.com/buildpacks/spec/blob/master/buildpack.md#provided-by-the-platform). (_default:_ an empty directory)
+  Files of the format `/platform/env/MY_VAR` with content `my-value` will be translated by the lifecycle into environment variables provided to buildpacks. For more information, see the [buildpacks spec](https://github.com/buildpacks/spec/blob/master/buildpack.md#provided-by-the-platform). (_default:_ an empty directory)
 
 * **`USER_ID`**: The user ID of the builder image user, as a string value. (_default:_ `"1000"`)
 
@@ -50,7 +43,7 @@ The `source` workspace holds the source to build. See `SOURCE_SUBPATH` above if
 
 ## Usage
 
-This `TaskRun` will use the `buildpacks-v3` task to build the source code, then publish a container image.
+This `TaskRun` will use the `buildpacks` task to build the source code, then publish a container image.
 
 ```
 apiVersion: tekton.dev/v1beta1
@@ -59,7 +52,7 @@ metadata:
   name: example-run
 spec:
   taskRef:
-    name: buildpacks-v3
+    name: buildpacks-phases
   podTemplate:
     volumes:
 # Uncomment the lines below to use an existing cache
@@ -96,13 +89,17 @@ spec:
 ```
 
 ### Example builders
-
-Cloud Foundry:
- - `cloudfoundry/cnb:bionic`
- - `cloudfoundry/cnb:cflinuxfs3`
+Paketo:
+- `gcr.io/paketo-buildpacks/builder:base` → Ubuntu bionic base image with buildpacks for Java, NodeJS and Golang
+- `gcr.io/paketo-buildpacks/builder:tiny` → Tiny base image (bionic build image, distroless run image) with buildpacks for Golang
+- `gcr.io/paketo-buildpacks/builder:full-cf` → cflinuxfs3 base image with buildpacks for Java, .NET, NodeJS, Golang, PHP, HTTPD and NGINX
+> NOTE: The `gcr.io/paketo-buildpacks/builder:full-cf` requires setting the USER_ID and GROUP_ID parameters to 2000, in order to work.
 
 Heroku:
- - `heroku/buildpacks:18`
+ - `heroku/buildpacks:18` → heroku-18 base image with buildpacks for Ruby, Java, Node.js, Python, Golang, & PHP
+
+Google:
+ - `gcr.io/buildpacks/builder:v1` → Ubuntu 18 base image with buildpacks for .NET, Go, Java, Node.js, and Python
 
 ## Previous Platform API Versions
 

task/buildpacks-v3/0.1/buildpacks-v3.yaml → task/buildpacks-phases/0.1/buildpacks-phases.yaml

@@ -2,27 +2,28 @@
 apiVersion: tekton.dev/v1beta1
 kind: Task
 metadata:
-  name: buildpacks-v3
+  name: buildpacks-phases
   labels:
     app.kubernetes.io/version: "0.1"
   annotations:
     tekton.dev/pipelines.minVersion: "0.12.1"
     tekton.dev/tags: image-build
-    tekton.dev/displayName: "buildpacks"
+    tekton.dev/displayName: "buildpacks-phases"
 spec:
   description: >-
-    This build template builds source into a container image using Cloud Native Buildpacks.
+    The Buildpacks-Phases task builds source into a container image and pushes it to
+    a registry, using Cloud Native Buildpacks. This command separately calls the aspects of the
+    Cloud Native Buildpacks lifecycle, to provide more granular control over the construction of
+    the image.
 
-    The Cloud Native Buildpacks website describes v3 buildpacks as pluggable, modular tools
-    that translate source code into container-ready artifacts such as OCI images. They replace
-    Dockerfiles in the app development lifecycle with a higher level of abstraction. Cloud
-    Native Buildpacks embrace modern container standards, such as the OCI image format. They take
-    advantage of the latest capabilities of these standards, such as remote image layer
-    rebasing on Docker API v2 registries.
+    Cloud Native Buildpacks are pluggable, modular tools that transform application source code
+    into OCI images. They replace Dockerfiles in the app development lifecycle, and allow for swift
+    rebasing of images, and give modular control over images through the use of builders, among other
+    benefits. This command uses a builder to construct the image, and pushes it to the registry provided.
 
   params:
     - name: BUILDER_IMAGE
-      description: The image on which builds will run (must include v3 lifecycle and compatible buildpacks).
+      description: The image on which builds will run (must include lifecycle and compatible buildpacks).
     - name: CACHE
       description: The name of the persistent app cache volume.
       default: empty-dir

task/buildpacks-phases/0.1/tests/run.yaml

@@ -0,0 +1,65 @@
+---
+apiVersion: tekton.dev/v1beta1
+kind: Pipeline
+metadata:
+  name: buildpacks-phases-test-pipeline
+spec:
+  workspaces:
+  - name: shared-workspace
+  resources:
+  - name: build-image
+    type: image
+  tasks:
+  - name: fetch-repository
+    taskRef:
+      name: git-clone
+    workspaces:
+    - name: output
+      workspace: shared-workspace
+    params:
+    - name: url
+      value: https://github.com/buildpacks/samples
+    - name: subdirectory
+      value: ""
+    - name: deleteExisting
+      value: "true"
+  - name: buildpacks-phases
+    taskRef:
+      name: buildpacks-phases
+    runAfter:
+    - fetch-repository
+    workspaces:
+    - name: source
+      workspace: shared-workspace
+    params:
+    - name: SOURCE_SUBPATH
+      value: apps/java-maven
+    - name: BUILDER_IMAGE
+      value: cnbs/sample-builder:alpine-p0.3
+    - name: CACHE
+      value: buildpacks-cache
+    resources:
+      outputs:
+      - name: image
+        resource: build-image
+---
+apiVersion: tekton.dev/v1beta1
+kind: PipelineRun
+metadata:
+  name: buildpacks-phases-test-pipeline-run
+spec:
+  pipelineRef:
+    name: buildpacks-phases-test-pipeline
+  workspaces:
+  - name: shared-workspace
+    persistentvolumeclaim:
+      claimName: buildpacks-source-pvc
+  resources:
+  - name: build-image
+    resourceRef:
+      name: buildpacks-app-image
+  podTemplate:
+    volumes:
+    - name: buildpacks-cache
+      persistentVolumeClaim:
+        claimName: buildpacks-cache-pvc

task/buildpacks/0.1/OWNERS

@@ -0,0 +1,20 @@
+approvers:
+- jkutner
+- hone
+- nebhale
+- sclevine
+- ekcasey
+- jromero
+- ameyer-pivotal
+- simonjjones
+
+reviewers:
+- vdemeester
+- ImJasonH
+- jkutner
+- hone
+- sclevine
+- ekcasey
+- jromero
+- ameyer-pivotal
+- simonjjones

task/buildpacks/0.1/README.md

@@ -0,0 +1,127 @@
+# Cloud Native Buildpacks
+
+This build template builds source into a container image using [Cloud Native Buildpacks](https://buildpacks.io). To do that, it uses [builders](https://buildpacks.io/docs/concepts/components/builder/#what-is-a-builder) to run buildpacks against your application.
+
+Cloud Native Buildpacks are pluggable, modular tools that transform application source code into OCI images. They replace Dockerfiles in the app development lifecycle, and enable for swift rebasing of images and modular control over images (through the use of builders), among other benefits. This command uses a builder to construct the image, and pushes it to the registry provided.
+
+See also [`buildpacks-phases`](../buildpacks-phases) for the deconstructed version of this task, which runs each of the [lifecycle phases](https://buildpacks.io/docs/concepts/components/lifecycle/#phases) individually (this task uses the [creator binary](https://github.com/buildpacks/spec/blob/platform/0.3/platform.md#operations), which coordinates and runs all of the phases).
+
+## Install the Task
+
+```
+kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/task/buildpacks/0.1/buildpacks.yaml
+```
+
+> **NOTE:** This task is currently only compatible with Tekton **v0.11.0** and above, and CNB Platform API 0.3 (lifecycle v0.7.0 and above). For previous Platform API versions, [see below](#previous-platform-api-versions).
+
+## Parameters
+
+* **`BUILDER_IMAGE`**: The image on which builds will run. (must include lifecycle and compatible buildpacks; _required_)
+
+* **`CACHE`**: The name of the persistent app cache volume. (_default:_ an empty directory -- effectively no cache)
+
+* **`CACHE_IMAGE`**: The name of the persistent app cache image. (_default:_ no cache image)
+
+* **`PLATFORM_DIR`**: A directory containing platform provided configuration, such as environment variables.
+  Files of the format `/platform/env/MY_VAR` with content `my-value` will be translated by the lifecycle into environment variables provided to buildpacks. For more information, see the [buildpacks spec](https://github.com/buildpacks/spec/blob/master/buildpack.md#provided-by-the-platform). (_default:_ an empty directory)
+
+* **`USER_ID`**: The user ID of the builder image user, as a string value. (_default:_ `"1000"`)
+
+* **`GROUP_ID`**: The group ID of the builder image user, as a string value. (_default:_ `"1000"`)
+
+* **`PROCESS_TYPE`**: The default process type to set on the image. (_default:_ `"web"`)
+
+* **`SKIP_RESTORE`**: Do not write layer metadata or restore cached layers. (clear cache between each run) (_default:_ `"false"`)
+
+* **`RUN_IMAGE`**: Reference to a run image to use. (_default:_ run image of the builder)
+
+* **`SOURCE_SUBPATH`**: A subpath within the `source` input where the source to build is located. (_default:_ `""`)
+
+### Outputs
+
+* **`image`**: An `image`-type `PipelineResource` specifying the image that should
+  be built.
+
+## Workspaces
+
+The `source` workspace holds the source to build. See `SOURCE_SUBPATH` above if source is located within a subpath of this input.
+
+## Usage
+
+This `TaskRun` will use the `buildpacks` task to build the source code, then publish a container image.
+
+```
+apiVersion: tekton.dev/v1beta1
+kind: TaskRun
+metadata:
+  name: example-run
+spec:
+  taskRef:
+    name: buildpacks
+  podTemplate:
+    volumes:
+# Uncomment the lines below to use an existing cache
+#    - name: my-cache
+#      persistentVolumeClaim:
+#        claimName: my-cache-pvc
+# Uncomment the lines below to provide a platform directory
+#    - name: my-platform-dir
+#      persistentVolumeClaim:
+#        claimName: my-platform-dir-pvc
+  params:
+  - name: SOURCE_SUBPATH
+    value: <optional subpath within your source repo, e.g. "apps/java-maven">
+  - name: BUILDER_IMAGE
+    value: <your builder image tag, see below for suggestions, e.g. "builder-repo/builder-image:builder-tag">
+# Uncomment the lines below to use an existing cache
+#  - name: CACHE
+#    value: my-cache
+# Uncomment the lines below to provide a platform directory
+#  - name: PLATFORM_DIR
+#    value: my-platform-dir
+  resources:
+    outputs:
+    - name: image
+      resourceSpec:
+        type: image
+        params:
+        - name: url
+          value: <your output image tag, e.g. "gcr.io/app-repo/app-image:app-tag">
+  workspaces:
+  - name: source
+    persistentVolumeClaim:
+      claimName: my-source-pvc
+```
+
+### Example builders
+Paketo:
+- `gcr.io/paketo-buildpacks/builder:base` &rarr; Ubuntu bionic base image with buildpacks for Java, NodeJS and Golang
+- `gcr.io/paketo-buildpacks/builder:tiny` &rarr; Tiny base image (bionic build image, distroless run image) with buildpacks for Golang
+- `gcr.io/paketo-buildpacks/builder:full-cf` &rarr; cflinuxfs3 base image with buildpacks for Java, .NET, NodeJS, Golang, PHP, HTTPD and NGINX
+> NOTE: The `gcr.io/paketo-buildpacks/builder:full-cf` requires setting the USER_ID and GROUP_ID parameters to 2000, in order to work.
+
+Heroku:
+ - `heroku/buildpacks:18` &rarr; heroku-18 base image with buildpacks for Ruby, Java, Node.js, Python, Golang, & PHP
+
+Google:
+ - `gcr.io/buildpacks/builder:v1` &rarr; Ubuntu 18 base image with buildpacks for .NET, Go, Java, Node.js, and Python
+
+## Previous Platform API Versions
+
+Use one of the following commands to install a previous version of this task. Be sure to also supply a compatible builder image (`BUILDER_IMAGE` input) when running the task (i.e. one that has a lifecycle implementing the expected platform API).
+
+### CNB Platform API 0.2
+
+Commit: [8c34055](https://github.com/tektoncd/catalog/tree/8c34055ea728413fb72af061e7bcbf1859a9fbd6/buildpacks#inputs)
+
+```
+kubectl -f https://raw.githubusercontent.com/tektoncd/catalog/8c34055ea728413fb72af061e7bcbf1859a9fbd6/buildpacks/buildpacks-v3.yaml
+```
+
+### CNB Platform API 0.1
+
+Commit: [5c2ab7d6](https://github.com/tektoncd/catalog/tree/5c2ab7d6c3b2507d43b49577d7f1bee9c49ed8ab/buildpacks#inputs)
+
+```
+kubectl -f https://raw.githubusercontent.com/tektoncd/catalog/5c2ab7d6c3b2507d43b49577d7f1bee9c49ed8ab/buildpacks/buildpacks-v3.yaml
+```