OpenShift docs are moving and will soon only be available at docs.redhat.com, the home of all Red Hat product documentation. Explore the new docs experience today.
  1. Documentation
    2. history
×

S2I Requirements

Overview

Source-to-Image (S2I) is a framework that makes it easy to write images that take application source code as an input and produce a new image that runs the assembled application as output.

The main advantage of using S2I for building reproducible Docker images is the ease of use for developers. As a builder image author, you must understand two basic concepts in order for your images to provide the best possible S2I performance: the build process and S2I scripts.

Build Process

The build process consists of the following three fundamental elements, which are combined into a final Docker image:

  • sources

  • S2I scripts

  • builder image

During the build process, S2I must place sources and scripts inside the builder image. To do so, S2I creates a tar file that contains the sources and scripts, then streams that file into the builder image. Before executing the assemble script, S2I untars that file and places its contents into the location specified with the --destination flag or the io.openshift.s2i.destination label from the builder image, with the default location being the /tmp directory.

For this process to happen, your image must supply the tar archiving utility (the tar command available in $PATH) and the command line interpreter (the /bin/sh command); this allows your image to use the fastest possible build path. If the tar or /bin/sh command is not available, the sti build process is forced to automatically perform an additional Docker build to put both the sources and the scripts inside the image, and only then run the usual sti build procedure.

See the following diagram for the basic S2I build workflow:

S2I workflow
Figure 1. Build Workflow

  • Run build’s responsibility is to untar the sources, scripts and artifacts (if such exist) and invoke the assemble script. If this is the second run (after catching tar//bin/sh not found error) it is responsible only for invoking assemble script, since both scripts and sources are already there.

S2I Scripts

You can write S2I scripts in any programming language, as long as the scripts are executable inside the builder image. S2I supports multiple options providing assemble/run/save-artifacts scripts. All of these locations are checked on each build in the following order:

  1. A script found at the --scripts-url URL

  2. A script found in the application source .sti/bin directory

  3. A script found at the default image URL (io.openshift.s2i.scripts-url label)

Both the io.openshift.s2i.scripts-url label specified in the image and the --scripts-url flag can take one of the following form:

  • image://path_to_scripts_dir - absolute path inside the image to a directory where the S2I scripts are located

  • file://path_to_scripts_dir - relative or absolute path to a directory on the host where the S2I scripts are located

  • http(s)://path_to_scripts_dir - URL to a directory where the S2I scripts are located

In case where the scripts are already placed inside the image (using --scripts-url or io.openshift.s2i.scripts-url with value image:///path/in/image) then setting --destination or io.openshift.s2i.destination label applies only to sources and artifacts.
Table 1. S2I Scripts
Script Description

assemble (required)

The assemble script builds the application artifacts from a source and places them into appropriate directories inside the image. The workflow for this script is:

  1. Restore build artifacts. If you want to support incremental builds, make sure to define save-artifacts as well (optional).

  2. Place the application source in the desired location.

  3. Build the application artifacts.

  4. Install the artifacts into locations appropriate for them to run.

run (required)

The run script executes your application.

save-artifacts (optional)

The save-artifacts script gathers all dependencies that can speed up the build processes that follow. For example:

  • For Ruby, gems installed by Bundler.

  • For Java, .m2 contents.

These dependencies are gathered into a tar file and streamed to the standard output.

usage (optional)

The usage script allows you to inform the user how to properly use your image.

test/run (optional)

The test/run script allows you to create a simple process to check if the image is working correctly. The proposed flow of that process is:

  1. Build the image.

  2. Run the image to verify the usage script.

  3. Run sti build to verify the assemble script.

  4. Run sti build again to verify the save-artifacts and assemble scripts save and restore artifacts functionality. (optional)

  5. Run the image to verify the test application is working.

See the Testing S2I Images topic for more information.

The suggested location to put the test application built by your test/run script is the test/test-app directory in your image repository. See the S2I documentation for more information.

Example S2I Scripts

The following examples are written in Bash and it is assumed all tar contents are unpacked into the /tmp/sti directory.
Example 1. assemble script:
#!/bin/bash

# restore build artifacts
if [ "$(ls /tmp/sti/artifacts/ 2>/dev/null)" ]; then
    mv /tmp/sti/artifacts/* $HOME/.
fi

# move the application source
mv /tmp/sti/src $HOME/src

# build application artifacts
pushd ${HOME}
make all

# install the artifacts
make install
popd
Example 2. run script:
#!/bin/bash

# run the application
/opt/application/run.sh
Example 3. save-artifacts script:
#!/bin/bash

pushd ${HOME}
if [ -d deps ]; then
    # all deps contents to tar stream
    tar cf - deps
fi
popd
Example 4. usage script:
#!/bin/bash

# inform the user how to use the image
cat <<EOF
This is a S2I sample builder image, to use it, install
https://github.com/openshift/source-to-image
EOF

Using Images with ONBUILD Instructions

The ONBUILD instructions can be found in many official Docker images. For example:

See the Docker documentation for more information on ONBUILD.

Upon start S2I detects whether the builder image uses ONBUILD instructions. If there are none, the regular S2I build is performed, otherwise a different strategy is chosen. During such a S2I build, all ONBUILD instructions are executed in the order they were defined in the builder image’s Dockerfile. The S2I scripts are not required for this strategy, but they can be used as a supplement to existing ONBUILD instructions.

Many official Docker images that use ONBUILD do not declare the image CMD or ENTRYPOINT, and for that, S2I must know how to run your application. There are two methods for defining the ENTRYPOINT:

  • Include the run script in your application root folder. S2I recognizes it and sets it as the application image ENTRYPOINT.

  • Use the S2I scripts. If you provide them, the run script is set as an image ENTRYPOINT. If the S2I scripts location also includes the assemble script, that script is executed as the last instruction of the underlying Docker build.