Merge pull request #281 from jplesnik/perl-538-support

Add Perl 5.38 support

.github/workflows/build-and-push.yml

@@ -30,6 +30,14 @@ jobs:
             quayio_username: "QUAY_IMAGE_FEDORA_BUILDER_USERNAME"
             quayio_token: "QUAY_IMAGE_FEDORA_BUILDER_TOKEN"
 
+          - dockerfile: "5.38/Dockerfile.fedora"
+            docker_context: "5.38"
+            registry_namespace: "fedora"
+            tag: "5.38"
+            image_name: "perl-538"
+            quayio_username: "QUAY_IMAGE_FEDORA_BUILDER_USERNAME"
+            quayio_token: "QUAY_IMAGE_FEDORA_BUILDER_TOKEN"
+
     steps:
       - name: Build and push to quay.io registry
         uses: sclorg/build-and-push-action@v4

5.38/Dockerfile.c9s

@@ -0,0 +1,63 @@
+FROM quay.io/sclorg/s2i-base-c9s:c9s
+
+# This image provides a Perl 5.38 environment you can use to run your Perl applications.
+
+EXPOSE 8080
+
+# Image metadata
+ENV PERL_VERSION=5.38 \
+    PERL_SHORT_VER=538 \
+    NAME=perl
+
+ENV SUMMARY="Platform for building and running Perl $PERL_VERSION applications" \
+    DESCRIPTION="Perl $PERL_VERSION available as container is a base platform for \
+building and running various Perl $PERL_VERSION applications and frameworks. \
+Perl is a high-level programming language with roots in C, sed, awk and shell scripting. \
+Perl is good at handling processes and files, and is especially good at handling text. \
+Perl's hallmarks are practicality and efficiency. While it is used to do a lot of \
+different things, Perl's most common applications are system administration utilities \
+and web programming."
+
+LABEL summary="$SUMMARY" \
+      description="$DESCRIPTION" \
+      io.k8s.description="$DESCRIPTION" \
+      io.k8s.display-name="Apache 2.4 with mod_fcgid and Perl $PERL_VERSION" \
+      io.openshift.expose-services="8080:http" \
+      io.openshift.tags="builder,${NAME},${NAME}${PERL_SHORT_VER}","${NAME}-${PERL_SHORT_VER}" \
+      io.openshift.s2i.scripts-url="image:///usr/libexec/s2i" \
+      io.s2i.scripts-url="image:///usr/libexec/s2i" \
+      name="sclorg/${NAME}-${PERL_SHORT_VER}-c9s" \
+      com.redhat.component="${NAME}-${PERL_SHORT_VER}-container" \
+      version="1" \
+      com.redhat.license_terms="https://www.redhat.com/en/about/red-hat-end-user-license-agreements#UBI" \
+      maintainer="SoftwareCollections.org <sclorg@redhat.com>" \
+      help="For more information visit https://github.com/sclorg/s2i-${NAME}-container" \
+      usage="s2i build <SOURCE-REPOSITORY> quay.io/sclorg/${NAME}-${PERL_SHORT_VER}:latest <APP-NAME>"
+
+# Deselect a default stream
+RUN INSTALL_PKGS="perl perl-devel mod_fcgid perl-App-cpanminus perl-FCGI patch" && \
+    yum -y --allowerasing distrosync && \
+    yum install -y --setopt=tsflags=nodocs $INSTALL_PKGS && \
+    rpm -V $INSTALL_PKGS && \
+    perl -v | grep -qe "v$PERL_VERSION\." && echo "Found VERSION $PERL_VERSION" && \
+    yum -y clean all --enablerepo='*'
+
+# Copy the S2I scripts from the specific language image to $STI_SCRIPTS_PATH
+COPY ./s2i/bin/ $STI_SCRIPTS_PATH
+
+# Copy extra files to the image.
+COPY ./root/ /
+
+# In order to drop the root user, we have to make some directories world
+# writeable as OpenShift default security model is to run the container under
+# random UID.
+RUN mkdir -p ${APP_ROOT}/etc/httpd.d && \
+    sed -i -f ${APP_ROOT}/etc/httpdconf.sed /etc/httpd/conf/httpd.conf && \
+    chmod -R og+rwx /var/run/httpd /run/mod_fcgid ${APP_ROOT}/etc/httpd.d && \
+    chown -R 1001:0 ${APP_ROOT} && chmod -R ug+rwx ${APP_ROOT} && \
+    rpm-file-permissions
+
+USER 1001
+
+# Set the default CMD to print the usage of the language image
+CMD $STI_SCRIPTS_PATH/usage

5.38/Dockerfile.fedora

@@ -0,0 +1,62 @@
+FROM quay.io/fedora/s2i-base:39
+
+# This image provides a Perl 5.38 environment you can use to run your Perl applications.
+EXPOSE 8080
+
+# Image metadata
+ENV PERL_VERSION=5.38 \
+    PERL_SHORT_VER=538 \
+    VERSION=0 \
+    NAME=perl \
+    PATH=/opt/app-root/src/extlib/bin:$PATH \
+    PERL5LIB=/opt/app-root/src/extlib/lib/perl5
+
+ENV SUMMARY="Platform for building and running Perl $PERL_VERSION applications" \
+    DESCRIPTION="Perl $PERL_VERSION available as container is a base platform for \
+building and running various Perl $PERL_VERSION applications and frameworks. \
+Perl is a high-level programming language with roots in C, sed, awk and shell scripting. \
+Perl is good at handling processes and files, and is especially good at handling text. \
+Perl's hallmarks are practicality and efficiency. While it is used to do a lot of \
+different things, Perl's most common applications are system administration utilities \
+and web programming."
+
+LABEL summary="$SUMMARY" \
+      description="$DESCRIPTION" \
+      io.k8s.description="$DESCRIPTION" \
+      io.k8s.display-name="Apache 2.4 with mod_fcgid and Perl $PERL_VERSION" \
+      io.openshift.expose-services="8080:http" \
+      io.openshift.tags="builder,${NAME},${NAME}${PERL_SHORT_VER}" \
+      io.openshift.s2i.scripts-url="image:///usr/libexec/s2i" \
+      io.s2i.scripts-url="image:///usr/libexec/s2i" \
+      name="fedora/$NAME-$PERL_SHORT_VER" \
+      com.redhat.component="$NAME" \
+      version="$VERSION" \
+      maintainer="SoftwareCollections.org <sclorg@redhat.com>" \
+      help="For more information visit https://github.com/sclorg/s2i-${NAME}-container" \
+      usage="s2i build <SOURCE-REPOSITORY> quay.io/fedora/fedora/$NAME-$PERL_SHORT_VER <APP-NAME>"
+
+RUN INSTALL_PKGS="perl perl-devel mod_fcgid perl-App-cpanminus perl-FCGI patch" && \
+    dnf install -y --setopt=tsflags=nodocs  $INSTALL_PKGS && \
+    rpm -V $INSTALL_PKGS && \
+    perl -v | grep -qe "v$PERL_VERSION\." && echo "Found VERSION $PERL_VERSION" && \
+    dnf -y clean all --enablerepo='*'
+
+# Copy the S2I scripts from the specific language image to $STI_SCRIPTS_PATH
+COPY ./s2i/bin/ $STI_SCRIPTS_PATH
+
+# Copy extra files to the image.
+COPY ./root/ /
+
+# In order to drop the root user, we have to make some directories world
+# writeable as OpenShift default security model is to run the container under
+# random UID.
+RUN mkdir -p ${APP_ROOT}/etc/httpd.d && \
+    sed -i -f ${APP_ROOT}/etc/httpdconf-fed.sed /etc/httpd/conf/httpd.conf && \
+    chmod -R og+rwx /var/run/httpd /run/mod_fcgid ${APP_ROOT}/etc/httpd.d && \
+    chown -R 1001:0 ${APP_ROOT} && chmod -R ug+rwx ${APP_ROOT} && \
+    rpm-file-permissions
+
+USER 1001
+
+# Set the default CMD to print the usage of the language image
+CMD $STI_SCRIPTS_PATH/usage

5.38/README.md

@@ -0,0 +1,220 @@
+Perl 5.38 container image
+=========================
+
+This container image includes Perl 5.38 as an [S2I](https://github.com/openshift/source-to-image) base image for your Perl 5.38 applications.
+Users can choose Fedora based builder image.
+The Fedora images are available in [Quay.io](https://quay.io/fedora/).
+The resulting image can be run using [podman](https://github.com/containers/libpod).
+
+Note: while the examples in this README are calling `podman`, you can replace any such calls by `docker` with the same arguments.
+
+Description
+-----------
+
+Perl 5.38 available as container is a base platform for
+building and running various Perl 5.38 applications and frameworks.
+Perl is a high-level programming language with roots in C, sed, awk and shell scripting.
+Perl is good at handling processes and files, and is especially good at handling text.
+Perl's hallmarks are practicality and efficiency. While it is used to do a lot of
+different things, Perl's most common applications are system administration utilities
+and web programming.
+
+This container image includes an cpanm utility, so users can use it to install Perl
+modules for their web applications. There is no guarantee for any specific CPAN module
+version, that is included in the image; those versions can be changed anytime.
+
+Usage in Openshift
+------------------
+
+In this example, we will assume that you are using the `ubi9/perl-538` image, available via `perl:5.38` imagestream tag in Openshift.
+To build a simple [perl-sample-app](https://github.com/sclorg/dancer-ex.git) application in Openshift:
+
+```
+oc new-app perl:5.38~https://github.com/sclorg/dancer-ex.git
+```
+
+**To access the application:**
+
+```
+oc get pods
+oc exec <pod> -- curl 127.0.0.1:8080
+```
+
+Source-to-Image framework and scripts
+-------------------------------------
+
+This image supports the [Source-to-Image](https://docs.openshift.com/container-platform/3.11/creating_images/s2i.html)
+(S2I) strategy in OpenShift. The Source-to-Image is an OpenShift framework
+which makes it easy to write images that take application source code as
+an input, use a builder image like this PHP container image, and produce
+a new image that runs the assembled application as an output.
+
+To support the Source-to-Image framework, important scripts are included in the builder image:
+
+* The `/usr/libexec/s2i/assemble` script inside the image is run to produce a new image with the application artifacts. The script takes sources of a given application and places them into appropriate directories inside the image. It utilizes some common patterns in Perl application development (see the **Environment variables** section below).
+* The `/usr/libexec/s2i/run` script is set as the default command in the resulting container image (the new image with the application artifacts). It runs `httpd` for production.
+
+Building an application using a Dockerfile
+------------------------------------------
+
+Compared to the Source-to-Image strategy, using a Dockerfile is a more
+flexible way to build a Perl container image with an application.
+Use a Dockerfile when Source-to-Image is not sufficiently flexible for you or
+when you build the image outside of the OpenShift environment.
+
+To use the Perl image in a Dockerfile, follow these steps:
+
+#### 1. Pull a base builder image to build on
+
+```
+podman pull ubi9/perl-538
+```
+
+An ubi9 image `ubi9/perl-538` is used in this example.
+
+#### 2. Pull and application code
+
+An example application available at https://github.com/sclorg/dancer-ex.git is used here. Feel free to clone the repository for further experiments.
+
+```
+git clone https://github.com/sclorg/dancer-ex.git app-src
+```
+
+#### 3. Prepare an application inside a container
+
+This step usually consists of at least these parts:
+
+* putting the application source into the container
+* installing the dependencies
+* setting the default command in the resulting image
+
+For all these three parts, users can either setup all manually and use commands `perl` and `cpanm` explicitly in the Dockerfile ([3.1.](#31-to-use-your-own-setup-create-a-dockerfile-with-this-content)), or users can use the Source-to-Image scripts inside the image ([3.2.](#32-to-use-the-source-to-image-scripts-and-build-an-image-using-a-dockerfile-create-a-dockerfile-with-this-content); see more about these scripts in the section "Source-to-Image framework and scripts" above), that already know how to set-up and run some common Perl applications.
+
+##### 3.1 To use your own setup, create a Dockerfile with this content:
+
+```
+FROM ubi9/perl-538
+
+# Add application sources
+ADD app-src .
+
+# Set the paths to local Perl modules
+ENV PATH=/opt/app-root/src/extlib/bin:${PATH}
+ENV PERL5LIB=/opt/app-root/src/extlib/lib/perl5
+
+# Install the dependencies
+RUN  cpanm --notest -l extlib Module::CoreList && \
+     cpanm --notest -l extlib --installdeps .
+
+# Install Plack as an FCGI server
+RUN cpanm --notest -l extlib Plack::Handler::FCGI FCGI::ProcManager
+RUN patch --read-only=ignore -d ./extlib/lib/perl5 -p2 < /opt/app-root/Plack-1.0047-Work-around-mod_fcgid-bogus-SCRIPT_NAME-PATH_INFO.patch
+RUN printf '\
+FcgidInitialEnv MODFCGID_VIRTUAL_LOCATION /\n\
+PassEnv HOME\n\
+FcgidInitialEnv "HOME" "%s"\n\
+PassEnv PATH\n\
+FcgidInitialEnv "PATH" "%s"\n\
+PassEnv PERL5LIB\n\
+FcgidInitialEnv "PERL5LIB" "%s"\n\
+<Location />\n\
+SetHandler fcgid-script\n\
+Options +ExecCGI\n\
+FcgidWrapper "/opt/app-root/psgiwrapper /usr/bin/env plackup -s FCGI ./app.psgi" virtual\n\
+</Location>\n' "$HOME" "$PATH" "$PERL5LIB"> /opt/app-root/etc/httpd.d/40-psgi.conf
+
+# Run scripts uses standard ways to run the application
+CMD exec httpd -C 'Include /opt/app-root/etc/httpd.conf' -D FOREGROUND
+```
+
+##### 3.2 To use the Source-to-Image scripts and build an image using a Dockerfile, create a Dockerfile with this content:
+
+```
+FROM ubi9/perl-538
+
+# Add application sources to a directory that the assemble scriptexpects them
+# and set permissions so that the container runs without root access
+USER 0
+ADD app-src /tmp/src
+RUN chown -R 1001:0 /tmp/src
+USER 1001
+
+# Install the dependencies
+RUN /usr/libexec/s2i/assemble
+
+# Set the default command for the resulting image
+CMD /usr/libexec/s2i/run
+```
+
+#### 4. Build a new image from a Dockerfile prepared in the previous step
+
+```
+podman build -t perl-app .
+```
+
+#### 5. Run the resulting image with final application
+
+```
+podman run -d perl-app
+```
+
+Environment variables for Source-to-Image
+-----------------------------------------
+
+To set environment variables, you can place them as a key value pair into a `.s2i/environment`
+file inside your source code repository.
+
+* **ENABLE_CPAN_TEST**
+
+    Allow the installation of all specified cpan packages and the running of their tests. The default value is `false`.
+
+* **CPAN_MIRROR**
+
+    This variable specifies a mirror URL which will used by cpanminus to install dependencies.
+    By default the URL is not specified.
+
+* **HTTPD_START_SERVERS**
+
+    The [StartServers](https://httpd.apache.org/docs/2.4/mod/mpm_common.html#startservers)
+    directive sets the number of child server processes created on startup. Default is 8.
+
+* **HTTPD_MAX_REQUEST_WORKERS**
+
+    Number of simultaneous requests that will be handled by Apache httpd. The default
+    is 256, but it will be automatically lowered if memory is limited.
+
+* **PSGI_FILE**
+
+    Override PSGI application detection.
+
+    If the PSGI_FILE variable is set to empty value, no PSGI application will
+    be detected and mod_fcgid not be reconfigured.
+
+    If the PSGI_FILE variable is set and non-empty, it will define path to
+    the PSGI application file. No detection will be used.
+
+    If the PSGI_FILE variable does not exist, autodetection will be used:
+    If exactly one ./*.psgi file exists, mod_fcgid will be configured to
+    execute that file.
+
+* **PSGI_RELOAD**
+
+    Reload PSGI application when source code in application directory will be changed.
+
+    If the PSGI_RELOAD variable is set to empty value, no reload will be used.
+
+    If the PSGI_RELOAD variable is set and non-empty, it will cause reload defined by
+    code change in application directory.
+
+* **PSGI_URI_PATH**
+
+    This variable overrides location URI path that is handled path the PSGI
+    application. Default value is "/".
+
+See also
+--------
+
+Dockerfile and other sources are available on https://github.com/sclorg/s2i-perl-container.
+In that repository you also can find another versions of Perl environment Dockerfiles.
+Dockerfile for CentOS is called `Dockerfile`, Dockerfile for RHEL7 is called `Dockerfile.rhel7`, for RHEL8 `Dockerfile.rhel8`,
+for CentOS Stream 9 `Dockerfile.c9s` and the Fedora Dockerfile is called `Dockerfile.fedora`.