OpenShift Build Service 2

Warning

This version is for Openshift 4 and Tekton pipelines.

For version running on Openshift 3 please visit https://osbs.readthedocs.io/en/osbs_ocp3/ .

Note

Required releases of components:

• osbs-client >= 2.0.0

• atomic-reactor >= 4.0.0

• koji-containerbuild >= 1.0.0

OSBS is a collection of tools, workflows and integration points that build and release layered container images.

OSBS hooks into Koji with the help of the koji-containerbuild plugin, and uses OpenShift tekton pipelines with podman-remote as Content Generators to produce layered images.

One can start an image build with fedpkg, using the container-build subcommand:

$ fedpkg container-build

Table of Contents

• Administration and Maintenance
  • Understanding build parameters
  • Configuring osbs-client
    • reactor_config_map
    • Platform description
    • build_from
    • cleanup_used_resources
    • default_buildtime_limit
    • max_buildtime_limit
  • Deploy OSBS on OpenShift
    • Authentication
    • Server-side Configuration for atomic-reactor
  • Setting up koji for container image builds
    • Example configuration file: Koji builder
    • Including OpenShift build annotations in Koji task output
  • Operator manifests
    • Supporting Operator Manifests extraction
    • Enabling Operator Manifests digest pinning (and other replacements)
    • Enabling operator CSV modifications
  • Cachito integration
    • Configuring your cachito instance
    • Allowing multiple remote sources
    • Configuring koji
    • Obtaining Atomic Reactor stack trace
  • Remote hosts
    • Provisioning
    • Setup of remote hosts
    • Configuring OSBS
• Building Container Images
  • Building images using fedpkg
  • Building images using koji
    • Streamed build logs
    • Koji Build Results
  • Building images using osbs-client
  • Accessing built images
    • Docker
    • Podman
  • Writing a Dockerfile
  • Image configuration
    • platforms
    • go
    • buildtime_limit
    • compose
    • flatpak
    • tags
    • version
    • set_release_env
    • image_build_method
    • Fetching source code from external source using cachito
    • remote_sources
    • Replacing project dependencies with cachito
  • Content Sets
  • Using Artifacts from Koji or Project Newcastle(aka PNC)
    • fetch-artifacts-koji.yaml
    • fetch-artifacts-pnc.yaml
    • fetch-artifacts-url.yaml
    • Koji Build Metadata Integration
  • Image tags
  • Override Parent Image
  • Koji NVR
    • Digests verification
  • Isolated Builds
    • Operator bundle isolated builds
  • Yum repositories
    • ODCS compose
    • RHEL subscription
    • Yum repository URL
    • Koji tag
    • Inherited yum repository and ODCS compose
  • Signing intent
  • Base image builds
  • Multistage builds
  • Operator manifests
    • Operator manifest bundle builds
    • Operator manifest appregistry builds
• Inspecting built image components
  • Dockerfiles
  • Image Content Manifests
    • Content Sets
    • Extra contents
• Building Source Container Images
  • Signing intent resolution
  • Koji integration
    • Koji Build Metadata Integration
  • Building source container images using koji
  • Building source container images using osbs-client
• Understanding the Build Process
  • General workflow
    • Binary pipeline consists of these tasks:
    • Source pipeline consists of these tasks:
  • Binary workflow
  • Source workflow
  • Logging
    • Getting logs during build
    • Getting logs after the build
    • Encoding issues
    • Example
• Build Parameters
  • Environment vs User Parameters
  • Reactor Configuration
  • User Parameters
• Contributing to OSBS
  • Setting up a (local) development environment
    • OSBS-Box environment
  • Contribution guidelines
    • Submitting changes
    • Licensing
    • Code policies
• Documentation of the OSBS tools
  • Koji Containerbuild
  • Atomic Reactor
  • OSBS Client
  • Ansible Playbook
  • Deploying and Running OSBS

Indices and tables

• Index

• Search Page