Skip to main content
Redhat Developers  Logo
  • Products

    Featured

    • Red Hat Enterprise Linux
      Red Hat Enterprise Linux Icon
    • Red Hat OpenShift AI
      Red Hat OpenShift AI
    • Red Hat Enterprise Linux AI
      Linux icon inside of a brain
    • Image mode for Red Hat Enterprise Linux
      RHEL image mode
    • Red Hat OpenShift
      Openshift icon
    • Red Hat Ansible Automation Platform
      Ansible icon
    • Red Hat Developer Hub
      Developer Hub
    • View All Red Hat Products
    • Linux

      • Red Hat Enterprise Linux
      • Image mode for Red Hat Enterprise Linux
      • Red Hat Universal Base Images (UBI)
    • Java runtimes & frameworks

      • JBoss Enterprise Application Platform
      • Red Hat build of OpenJDK
    • Kubernetes

      • Red Hat OpenShift
      • Microsoft Azure Red Hat OpenShift
      • Red Hat OpenShift Virtualization
      • Red Hat OpenShift Lightspeed
    • Integration & App Connectivity

      • Red Hat Build of Apache Camel
      • Red Hat Service Interconnect
      • Red Hat Connectivity Link
    • AI/ML

      • Red Hat OpenShift AI
      • Red Hat Enterprise Linux AI
    • Automation

      • Red Hat Ansible Automation Platform
      • Red Hat Ansible Lightspeed
    • Developer tools

      • Red Hat Trusted Software Supply Chain
      • Podman Desktop
      • Red Hat OpenShift Dev Spaces
    • Developer Sandbox

      Developer Sandbox
      Try Red Hat products and technologies without setup or configuration fees for 30 days with this shared Openshift and Kubernetes cluster.
    • Try at no cost
  • Technologies

    Featured

    • AI/ML
      AI/ML Icon
    • Linux
      Linux Icon
    • Kubernetes
      Cloud icon
    • Automation
      Automation Icon showing arrows moving in a circle around a gear
    • View All Technologies
    • Programming Languages & Frameworks

      • Java
      • Python
      • JavaScript
    • System Design & Architecture

      • Red Hat architecture and design patterns
      • Microservices
      • Event-Driven Architecture
      • Databases
    • Developer Productivity

      • Developer productivity
      • Developer Tools
      • GitOps
    • Secure Development & Architectures

      • Security
      • Secure coding
    • Platform Engineering

      • DevOps
      • DevSecOps
      • Ansible automation for applications and services
    • Automated Data Processing

      • AI/ML
      • Data Science
      • Apache Kafka on Kubernetes
      • View All Technologies
    • Start exploring in the Developer Sandbox for free

      sandbox graphic
      Try Red Hat's products and technologies without setup or configuration.
    • Try at no cost
  • Learn

    Featured

    • Kubernetes & Cloud Native
      Openshift icon
    • Linux
      Rhel icon
    • Automation
      Ansible cloud icon
    • Java
      Java icon
    • AI/ML
      AI/ML Icon
    • View All Learning Resources

    E-Books

    • GitOps Cookbook
    • Podman in Action
    • Kubernetes Operators
    • The Path to GitOps
    • View All E-books

    Cheat Sheets

    • Linux Commands
    • Bash Commands
    • Git
    • systemd Commands
    • View All Cheat Sheets

    Documentation

    • API Catalog
    • Product Documentation
    • Legacy Documentation
    • Red Hat Learning

      Learning image
      Boost your technical skills to expert-level with the help of interactive lessons offered by various Red Hat Learning programs.
    • Explore Red Hat Learning
  • Developer Sandbox

    Developer Sandbox

    • Access Red Hat’s products and technologies without setup or configuration, and start developing quicker than ever before with our new, no-cost sandbox environments.
    • Explore Developer Sandbox

    Featured Developer Sandbox activities

    • Get started with your Developer Sandbox
    • OpenShift virtualization and application modernization using the Developer Sandbox
    • Explore all Developer Sandbox activities

    Ready to start developing apps?

    • Try at no cost
  • Blog
  • Events
  • Videos

Installing Node.js dependencies with Yarn via s2i builds and OpenShift

June 2, 2017
David Martin
Related topics:
ContainersLinuxKubernetes
Related products:
Red Hat Enterprise LinuxRed Hat OpenShift Container Platform

Share:

    Building a docker formatted container image for a Node.js application

    There are 2 main strategies for building an image for a Node.js Application. The most common strategy is simply using a Dockerfile with a base image of something like FROM node:4-onbuild. Then do a docker build. This will produce an image with your application in it, ready to be run. This strategy is known as the Docker strategy in an OpenShift BuildConfig.

    Another strategy is using the s2i tool for taking the application source from a repository and producing the image. A typical command would be.s2i build git@github.com/me/myrepo.git bucharestgold/centos7-s2i-nodejs:latest myapp. With this strategy, there is no explicit Dockerfile. It is known as the Source strategy in an OpenShift BuildConfig.

    Alternatives to npm

    Both of these strategies will install any Node dependencies using the npm tool. However, there are other tools available for managing dependencies in Node.js applications. Yarn is one such tool that has gained popularity due to the speed of dependency installation and locking mechanism for dependency versions.

    To use Yarn for installation of dependencies with an s2i strategy, the s2i builder image needs a couple of modifications. The first change is to install the Yarn binary. For these examples, the CentOS s2i builder image maintained at https://github.com/bucharest-gold/centos7-s2i-nodejs will be used. Installing the Yarn binary is a simple enough change to contrib/etc/install_node.sh.

    # Install yarn
    npm install -g yarn -s &>/dev/null

    The second change is to use Yarn when installing Node.js dependencies. Since Yarn is not the official dependency install tool, it would be nice to use npm by default and allow developers to choose Yarn if they wanted. An environment variable can help with that. Developers may also want to pass additional flags to Yarn. This change to s2i/assemble will allow both scenarios:

    if [ ! -z "$YARN_ENABLED" ]; then
     echo "---> Using 'yarn install' with YARN_ARGS"
     yarn install $YARN_ARGS
    else
     echo "---> Using 'npm install'"
     npm install -s
    fi

    Doing a make all will produce create a new s2i builder image with above changes.

    S2I builder in action with Yarn

    Environment variables can be passed to s2i with the -e flag. The following command uses Yarn to install dependencies:

    s2i build -e "YARN_ENABLED=true" git@github.com:david-martin/nodejs-ex docker.io/bucharestgold/centos7-s2i-nodejs:latest myapp
    
    ---> Installing application source
    ---> Building your Node application from source
    ---> Using 'yarn install' with YARN_ARGS
    yarn install v0.24.5
    [1/4] Resolving packages...
    [2/4] Fetching packages...
    [3/4] Linking dependencies...
    [4/4] Building fresh packages...
    Done in 1.79s.

    Using it in OpenShift

    To use it in OpenShift, there are 2 small changes to your BuildConfig. The first is to tell it to use a different s2i build image. Then configure it to use Yarn by setting an environment variable.

      strategy:
        type: Source
        sourceStrategy:
          from:
            kind: DockerImage
            name: 'bucharestgold/centos7-s2i-nodejs:latest'
          env:
            - name: YARN_ENABLED
              value: 'true'

    Trigger a build using the oc build command, and the build logs will look similar to above. That's all there is to it. You can extend on this idea to allow other dependency management or installation tools to be used.

    Links

    • CentOS s2i builder image, with Yarn support - https://hub.docker.com/r/bucharestgold/centos7-s2i-nodejs/
    • Pull Request where Yarn support was added - https://github.com/bucharest-gold/centos7-s2i-nodejs/pull/2
    • Sample Node.js Application with a Yarn lock file - https://github.com/david-martin/nodejs-ex
    Last updated: February 22, 2024

    Recent Posts

    • How to run AI models in cloud development environments

    • How Trilio secures OpenShift virtual machines and containers

    • How to implement observability with Node.js and Llama Stack

    • How to encrypt RHEL images for Azure confidential VMs

    • How to manage RHEL virtual machines with Podman Desktop

    Red Hat Developers logo LinkedIn YouTube Twitter Facebook

    Products

    • Red Hat Enterprise Linux
    • Red Hat OpenShift
    • Red Hat Ansible Automation Platform

    Build

    • Developer Sandbox
    • Developer Tools
    • Interactive Tutorials
    • API Catalog

    Quicklinks

    • Learning Resources
    • E-books
    • Cheat Sheets
    • Blog
    • Events
    • Newsletter

    Communicate

    • About us
    • Contact sales
    • Find a partner
    • Report a website issue
    • Site Status Dashboard
    • Report a security problem

    RED HAT DEVELOPER

    Build here. Go anywhere.

    We serve the builders. The problem solvers who create careers with code.

    Join us if you’re a developer, software engineer, web designer, front-end designer, UX designer, computer scientist, architect, tester, product manager, project manager or team lead.

    Sign me up

    Red Hat legal and privacy links

    • About Red Hat
    • Jobs
    • Events
    • Locations
    • Contact Red Hat
    • Red Hat Blog
    • Inclusion at Red Hat
    • Cool Stuff Store
    • Red Hat Summit

    Red Hat legal and privacy links

    • Privacy statement
    • Terms of use
    • All policies and guidelines
    • Digital accessibility

    Report a website issue