Skip to content

Latest commit

 

History

History
167 lines (120 loc) · 6.59 KB

README.md

File metadata and controls

167 lines (120 loc) · 6.59 KB
Raw

Python container images

Build and push container images to Quay.io registry

Images available on Quay are:

This repository contains the source for building various versions of the Python application as a reproducible container image using source-to-image. Users can choose between RHEL, Fedora and CentOS based builder images. The resulting image can be run using podman or docker.

For more information about using these images with OpenShift, please see the official OpenShift Documentation.

For more information about concepts used in these container images, see the Landing page.

Note: while the examples in this README are calling podman, you can replace any such calls by docker with the same arguments

Contributing

In this repository distgen > 1.0 is used for generating directories for Python versions. Also make sure distgen imports the jinja2 package >= 2.10.

Files in directories for a specific Python version are generated from templates in the src directory with values from specs/multispec.yml.

A typical way how to contribute is:

  1. Add a feature or fix a bug in templates (src directory) or values (specs/multispec.yml file).
  2. Commit the changes.
  3. Regenerate all files via make generate-all.
  4. Commit generated files.
  5. Test changes via make test TARGET=fedora VERSIONS=3.9 which will build, tag and test an image in one step.
  6. Open a pull request!

For more information about contributing, see the Contribution Guidelines.

Versions

Python versions currently provided are:

RHEL versions currently supported are:

CentOS Stream versions currently supported are:

Fedora versions currently supported are:

Download

To download one of the base Python images, follow the instructions you find in registries mentioned above.

For example, CentOS Stream image can be downloaded via:

$ podman pull quay.io/c9s/python-39-c9s

Build

To build a Python image from scratch run:

$ git clone https://github.com/sclorg/s2i-python-container.git
$ cd s2i-python-container
$ make build TARGET=c9s VERSIONS=3.9

Where TARGET might be one of the supported platforms mentioned above.

Notice: By omitting the VERSIONS parameter, the build/test action will be performed on all provided versions of Python.

Usage

For information about usage of S2I Python images, see the documentation for each version in its folder.

Test

This repository also provides a S2I test framework, which launches tests to check functionality of simple Python applications built on top of the s2i-python-container image.

$ cd s2i-python-container
$ make test TARGET=c9s VERSIONS=3.9

Where TARGET might be one of the supported platforms mentioned above.

Notice: By omitting the VERSIONS parameter, the build/test action will be performed on all provided versions of Python.

Repository organization

  • <python-version>

    • Dockerfile.c9s

      CentOS Stream based Dockerfile.

    • Dockerfile.fedora

      Fedora based Dockerfile.

    • Dockerfile.rhel8 & Dockerfile.rhel9

      RHEL 8/9 based Dockerfile. In order to perform build or test actions on this Dockerfile you need to run the action on a properly subscribed RHEL machine.

    • s2i/bin/

      This folder contains scripts that are run by S2I:

      • assemble

        Used to install the sources into the location where the application will be run and prepare the application for deployment (eg. installing dependencies, etc.)

      • run

        This script is responsible for running the application by using the application web server.

      • usage*

        This script prints the usage of this image.

    • test/

      This folder contains a S2I test framework with multiple test aplications testing different approaches.

      • run

        Script that runs the S2I test framework.