Skip to content

image.md

Latest commit

 

History

History
174 lines (148 loc) · 6.19 KB

image.md

File metadata and controls

174 lines (148 loc) · 6.19 KB

Images

Images provide a configuration for kpack to build and maintain a docker image utilizing Cloud Native Buildpacks. kpack will monitor the inputs to the image configuration to rebuild the image when the underlying source or builder buildpacks have changed.

The following defines the relevant fields of the image resource spec in more detail:

  • tag: The image tag.
  • builder: Configuration of the builder resource the image builds will use. See more info Builder Configuration.
  • serviceAccount: The Service Account name that will be used for credential lookup.
  • source: The source code that will be monitored/built into images. See the Source Configuration section below.
  • cacheSize: The size of the Volume Claim that will be used by the build cache.
  • failedBuildHistoryLimit: The maximum number of failed builds for an image that will be retained.
  • successBuildHistoryLimit: The maximum number of successful builds for an image that will be retained.
  • imageTaggingStrategy: Allow for builds to be additionally tagged with the build number. Valid options are None and BuildNumber.
  • build: Configuration that is passed to every image build. See "Build Configuration" section below.

Builder Configuration

The builder field describes the builder resource that will build the OCI images for a provided image configuration. It can be defined in exactly one of the following ways:

  • Cluster Builder

    builder:
    name: cluster-builder-name
    kind: ClusterBuilder
    • name: The name of the ClusterBuilder resource in kubernetes.
    • kind: The type as defined in kubernetes. This will always be ClusterBuilder.

  • Namespaced Builder

    builder:
    name: builder-name
    kind: Builder
    • name: The name of the Builder resource in kubernetes.
    • kind: The type as defined in kubernetes. This will always be Builder.

Note: This image can only reference builders defined in the same namespace. This is not true for ClusterBuilders because they are not namespace scoped.

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. For now, only https repositories are supported.
      • 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)
      • 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.

Build Configuration

The build field on the image resource can be used to configure env variables required during the build process and to configure resource limits on CPU and memory.

build:
  env:
    - name: "name of env variable"
      value: "value of the env variable"
  resources:
      limits:
        cpu: "0.25"
        memory: "128M"
      requests:
        cpu: "0.5"
        memory: "256M"

See the kubernetes documentation on setting environment variables and resource limits and requests for more information.

Sample Image with a Git Source

apiVersion: build.pivotal.io/v1alpha1
kind: Image
metadata:
  name: sample-image
  namespace: build-namespace
spec:
  tag: gcr.io/project-name/app
  serviceAccount: service-account
  builder:
    name: sample-builder
    kind: ClusterBuilder
  cacheSize: "1.5Gi" # Optional, if not set then the caching feature is disabled
  failedBuildHistoryLimit: 5 # Optional, if not present defaults to 10
  successBuildHistoryLimit: 5 # Optional, if not present defaults to 10
  source:
    git:
      url: https://github.com/buildpack/sample-java-app.git
      revision: master
  build: # Optional
    env:
      - name: BP_JAVA_VERSION
        value: 8.*
    resources:
      limits:
        cpu: 100m
        memory: 1G
      requests:
        cpu: 50m
        memory: 512M

Sample Image with hosted zip or jar as a source

apiVersion: build.pivotal.io/v1alpha1
kind: Image
metadata:
  name: sample-image
  namespace: build-namespace
spec:
  tag: gcr.io/project-name/app
  serviceAccount: service-account
  builder:
    name: sample-builder
    kind: ClusterBuilder
  cacheSize: "1.5Gi" # Optional, if not set then the caching feature is disabled
  failedBuildHistoryLimit: 5 # Optional, if not present defaults to 10
  successBuildHistoryLimit: 5 # Optional, if not present defaults to 10
  source:
    blob:
      url: https://storage.googleapis.com/build-service/sample-apps/spring-petclinic-2.1.0.BUILD-SNAPSHOT.jar
  build: # Optional
    env:
      - name: BP_JAVA_VERSION
        value: 8.*
    resources:
      limits:
        cpu: 100m
        memory: 1G
      requests:
        cpu: 50m
        memory: 512M