Skip to content

Latest commit

 

History

History
185 lines (126 loc) · 5.79 KB

README.md

File metadata and controls

185 lines (126 loc) · 5.79 KB
Raw

NodeJS container images

Build and push images to Quay.io registry

Images available on Quay are:

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

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

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

Versions

Node.JS versions currently provided are:

RHEL versions currently supported are:

  • RHEL8
  • RHEL9

CentOS Stream versions currently available are:

  • CentOS Stream 9
  • CentOS Stream 10

Installation

To build a Node.JS image, choose either the CentOS or RHEL based image:

  • RHEL based image

    These images are available in the Red Hat Container Catalog. To download it run:

    $ podman pull registry.access.redhat.com/rhel8/nodejs-18

    To build a RHEL based Node.JS image, you need to run the build on a properly subscribed RHEL machine.

    $ git clone --recursive https://github.com/sclorg/s2i-nodejs-container.git
$ cd s2i-nodejs-container
$ git submodule update --init
$ make build TARGET=rhel8 VERSIONS=18

  • CentOS Stream based image

    This image is available on DockerHub. To download it run:

    $ podman pull quay.io/sclorg/nodejs-20-c9s

    To build a Node.JS image from scratch run:

    $ git clone --recursive https://github.com/sclorg/s2i-nodejs-container.git
$ cd s2i-nodejs-container
$ git submodule update --init
$ make build TARGET=c9s VERSIONS=20

Note: while the installation steps are calling podman, you can replace any such calls by docker with the same arguments.

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

Usage

For information about usage of Dockerfile for NodeJS 18, see usage documentation.

For information about usage of Dockerfile for NodeJS 18 minimal, see usage documentation.

For information about usage of Dockerfile for NodeJS 20, see usage documentation.

For information about usage of Dockerfile for NodeJS 20 minimal, see usage documentation.

For information about usage of Dockerfile for NodeJS 22, see usage documentation.

For information about usage of Dockerfile for NodeJS 22 minimal, see usage documentation.

Test

This repository also provides a S2I test framework, which launches tests to check functionality of a simple Node.JS application built on top of the s2i-nodejs image.

Users can choose between testing a Node.JS test application based on a RHEL or CentOS Stream image.

  • RHEL based image

    To test a RHEL8 based Node.JS image, you need to run the test on a properly subscribed RHEL machine.

    $ cd s2i-nodejs-container
$ git submodule update --init
$ make test TARGET=rhel8 VERSIONS=20

  • CentOS Stream based image

    $ cd s2i-nodejs-container
$ git submodule update --init
$ make test TARGET=c9s VERSIONS=20

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

Repository organization

  • <nodejs-version>

    • Dockerfile.rhel8

      RHEL 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 modules using npm, 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.

    • contrib/

      This folder contains a file with commonly used modules.

    • test/

      This folder contains the S2I test framework with simple Node.JS echo server.

      • test-app/

        A simple Node.JS echo server used for testing purposes by the S2I test framework.

      • run

        This script runs the S2I test framework.