/origin-s2i-nodejs

A basic Source to Image builder for OpenShift Origin, with runtime binaries from Nodejs.org

Primary LanguageShellApache License 2.0Apache-2.0

Origin S2I NodeJS

This repository contains sources for an s2i builder image, based on CentOS7 and nodejs releases from nodejs.org.

If you are interested in developing against SCL-based nodejs releases, try sti-nodejs.

docker hub stats

image layers

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

Versions

Node.JS versions currently provided are:

  • 6.1.0 current
  • 5.11.1
  • 4.4.4 lts
  • 0.12.14
  • 0.10.45

Usage

OpenShift allows you to quickly start a build using the web console, or the CLI.

The oc command-line tool can be used to start a build, layering your desired nodejs REPO_URL sources into a centos7 image with your selected RELEASE of nodejs via the following command format:

oc new-app ryanj/centos7-s2i-nodejs:RELEASE~REPO_URL

For example, you can run a build (including npm install steps), using my http-base example repo, and the current relase of nodejs with:

oc new-app ryanj/centos7-s2i-nodejs:current~http://github.com/ryanj/http-base

Or, to run the latest lts release with my pillar-base example:

oc new-app ryanj/centos7-s2i-nodejs:lts~http://github.com/ryanj/pillar-base

You can try using any of the available tagged nodejs releases, and your own repo sources - as long as your application source will init correctly with npm start, and listen on port 8080.

Builds

The Source2Image cli tools are available as a standalone project, allowing you to run builds outside of OpenShift.

This example will produce a new docker image named pillarjs:

s2i build https://github.com/ryanj/pillar-base ryanj/centos7-s2i-nodejs:current pillarjs

Installation

To install these nodejs S2I builders into your current project, making them available in the web-based OpenShift "create" workflow, run:

oc create -f https://raw.githubusercontent.com/ryanj/origin-s2i-nodejs/master/image-streams.json

Administrators can make these builders available globally (visible in all projects) by adding them to the openshift namespace:

oc create -n openshift -f https://raw.githubusercontent.com/ryanj/origin-s2i-nodejs/master/image-streams.json

If you've (automatically) imported this image using the oc new-app example command, then you may need to clear the auto-imported image stream reference and re-install it, helping ensure that each of the NodeJS release tags are available and displayed correctly in the web UI:

oc delete is/centos7-s2i-nodejs && oc create -f https://raw.githubusercontent.com/ryanj/origin-s2i-nodejs/master/image-streams.json

Building your own Builder images

To build a Node.JS image:

  • CentOS based image

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

    $ docker pull ryanj/centos7-s2i-nodejs
    

    To build your own Node.JS builder images from scratch, run:

    $ git clone https://github.com/ryanj/origin-s2i-nodejs.git
    $ cd origin-s2i-nodejs
    $ make build VERSION=6.1.0
    

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 sti-nodejs image.

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

  • CentOS based image

    $ cd sti-nodejs
    $ make test VERSIONS="0.10.45 0.12.14 4.4.4 5.11.1 6.1.0"
    

Repository organization

  • nodejs.org/

    Dockerfile and scripts to build container images.

  • hack/

    Folder containing scripts which are responsible for the build and test actions performed by the Makefile.

  • ** image-streams.json **

    Use this file to add these runtimes to OpenShift's web-based "Add to Project" workflow.

  • ** Makefile **

    See the build your own builder images section of the README for build and test usage details.