catalog/task/buildpacks/0.1

Cloud Native Buildpacks

This build template builds source into a container image using Cloud Native Buildpacks. To do that, it uses builders 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 for the deconstructed version of this task, which runs each of the lifecycle phases individually (this task uses the creator binary, 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.

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. (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:

• paketobuildpacks/builder:base → Ubuntu bionic base image with buildpacks for Java, NodeJS and Golang
• paketobuildpacks/builder:tiny → Tiny base image (bionic build image, distroless run image) with buildpacks for Golang
• paketobuildpacks/builder:full-cf → cflinuxfs3 base image with buildpacks for Java, .NET, NodeJS, Golang, PHP, HTTPD and NGINX

NOTE: The paketobuildpacks/builder:full-cf requires setting the USER_ID and GROUP_ID parameters to 2000, in order to work.

Heroku:

• 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

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

kubectl -f https://raw.githubusercontent.com/tektoncd/catalog/8c34055ea728413fb72af061e7bcbf1859a9fbd6/buildpacks/buildpacks-v3.yaml

CNB Platform API 0.1

Commit: 5c2ab7d6

kubectl -f https://raw.githubusercontent.com/tektoncd/catalog/5c2ab7d6c3b2507d43b49577d7f1bee9c49ed8ab/buildpacks/buildpacks-v3.yaml