build.md

Builds

A Build is a resource that schedules and run a single Cloud Native Buildpacks build.

Unlike with the Image resource, using Builds directly allows granular control of when builds execute. Each build resource is immutable and corresponds to a single build execution. You will need to create a new build for every build execution as builds will not rebuild on source code and buildpack updates. Additionally, you will need to manually specify the source, and the cache volume.

Configuration

apiVersion: kpack.io/v1alpha1
kind: Build
metadata:
  name: sample-build
spec:
  tags:
  - sample/image
  serviceAccount: service-account
  builder:
    image: gcr.io/paketo-buildpacks/builder:base
    imagePullSecrets: 
    - name: builder-secret  
  cacheName: persisent-volume-claim-name
  source:
    git:
      url: https://github.com/buildpack/sample-java-app.git
      revision: master
  env:
  - name: "JAVA_BP_ENV"
    value: "value"
  resources:
    requests:
      cpu: "0.25"
      memory: "128M"
    limits:
      cpu: "0.5"
      memory: "256M"

• tags: A list of docker tags to build. At least one tag is required.
• serviceAccount: The Service Account name that will be used for credential lookup. Check out the secrets documentation for more information.
• builder.image: This is the tag to the Cloud Native Buildpacks builder image to use in the build. Unlike on the Image resource, this is an image not a reference to a Builder resource.
• builder.imagePullSecrets: An optional list of pull secrets if the builder is in a private registry. To create this secret please reference this link
• source: The source location that wil be the input to the build. See the Source Configuration section below.
• cacheName: Optional name of a persistent volume claim to used for a build cache across builds.
• env: Optional list of build time environment variables.
• resources: Optional configurable resource limits on CPU and memory.

Note: All fields on a build are immutable. Instead of updating a build, create a new one.

Source Configuration

The source field is a composition of a source code location and a subpath. It can be configured in exactly one of the following ways:

• Git

  source:
    git:
      url: ""
      revision: ""
    subPath: ""

  • git: (Source Code is a git repository)
    • url: The git repository url. Both https and ssh formats are supported; with ssh format requiring a ssh secret.
    • revision: The git revision to use. This value may be a commit sha, branch name, or tag.
  • subPath: A subdirectory within the source folder where application code resides. Can be ignored if the source code resides at the root level.

• Blob

  source:
    blob:
      url: ""
    subPath: ""

  • blob: (Source Code is a blob/jar in a blobstore)
    • url: The URL of the source code blob. This blob needs to either be publicly accessible or have the access token in the URL
  • subPath: A subdirectory within the source folder where application code resides. Can be ignored if the source code resides at the root level.

• Registry

  source:
    registry:
      image: ""
      imagePullSecrets:
      - name: ""
    subPath: ""

  • registry ( Source code is an OCI image in a registry that contains application source)
    • image: Location of the source image
    • imagePullSecrets: A list of dockercfg or dockerconfigjson secret names required if the source image is private
  • subPath: A subdirectory within the source folder where application code resides. Can be ignored if the source code resides at the root level.

Status

When a build complete successfully its status will report the fully qualified built image reference.

If you are using kubectl this information is available with kubectl get <build-name> or kubectl describe <build-name>.

status:
  conditions:
  - lastTransitionTime: "2020-01-17T16:16:36Z"
    status: "True"
    type: Succeeded
  latestImage: index.docker.io/sample/image@sha256:d3eb15a6fd25cb79039594294419de2328f14b443fa0546fa9e16f5214d61686
  ...

When a build fails its status will report the condition Succeeded=False.

status:
  conditions:
  - lastTransitionTime: "2020-01-17T16:13:48Z"
    status: "False"
    type: Succeeded
  ...