Soon, all Red Hat OpenShift documentation will only be available on docs.redhat.com, the official location of all Red Hat product documentation. Get familiar with the updated experience today!
  1. Documentation
    2. history
×

Custom Builder

Overview

Custom build is designed to fill the gap that was created when everybody jumped into creating Docker images. Still there is a requirement to produce individual artifacts (packages, jars, wars, installable zips, base images etc.) This is where Custom build is the perfect match to fill in that gap. Additionally Custom build allows implementing any extended build process for example, CI/CD flow that runs unit or integration tests. The limit here is just the imagination of the custom builder image author.

To fully utilize the power of Custom build one needs to be understand how to create a builder image that will be capable of building desired objects.

Custom Builder Image

The builder image upon invocation receives following environment variables with the information needed to proceed with the build:

Table 1. Custom Builder Environment Variables
Variable name Description

BUILD

This variable specifies the entire serialized Build object.

SOURCE_REPOSITORY

This variable specifies the URL to a repository with sources to build.

DOCKER_SOCKET

This variable specifies the path to the Docker socket, if exposing the Docker socket was enabled on BuildConfig.

Custom Builder Workflow

Although the custom builder image author has a great flexibility in defining the build process on its own, still they should follow a few required steps necessary to seamlessly run a build inside of OpenShift. The required steps for a custom builder image are following:

  1. Read the Build definition, which contains all the necessary information about input parameters for the build.

  2. Run the build process.

  3. If your build produces image, push it to the Build's output location if the output location is defined. Other output locations can be passed with environment variable for now.