Deploying with Node.JS

Overview

There are three steps to deploy your application:

1. Containerize your application by creating a Dockerfile
2. Modify devfile.yaml to add your Kubernetes code
3. Run odo deploy

Prerequisites

In order to use odo deploy, you must be able to build an image as well as push to a registry.

Step 1. Let odo know where to push container images

odo needs to know where to push non-absolute container images declared in the devfile.yaml file.

You can configure odo with the odo preference set command, like so:

odo preference set ImageRegistry $registry

Example Output

$ odo preference set ImageRegistry ttl.sh
 ✓  Value of 'imageregistry' preference was set to 'ttl.sh'

Step 2 (Optional). Login to your container registry

If the container registry you registered requires some form of authentication, you will need to login to it.

Note that the cluster you are deploying to also needs to be able to pull images from this registry in order for the application container to be started properly.

Podman

podman login $registry

Example Output

$ podman login quay.io
Username:
Password:
Login Succeeded!

Docker

docker login $registry

Example Output

$ docker login docker.io
Username:
Password:
Login Succeeded!

Step 3. Set the appropriate container build platform

Your container image build must match the same architecture as the cluster you are deploying to.

For example: you will have to cross-build a AMD64 image on a Mac M1 (ARM64) in order to deploy to a AMD64 cluster.

odo allows you to do so via the ODO_IMAGE_BUILD_ARGS environment variable, which is a semicolon-separated list of extra arguments to pass to Podman or Docker when building images.

Choose your deployment architecture:

Linux (AMD64)

export ODO_IMAGE_BUILD_ARGS="--platform=linux/amd64"

Linux (ARM)

export ODO_IMAGE_BUILD_ARGS="--platform=linux/arm64"

Windows (AMD64)

export ODO_IMAGE_BUILD_ARGS="--platform=windows/amd64"

Step 1. Create the initial development application

Complete the Developing with Node.JS guide before continuing.

Step 2. Containerize the application

In order to deploy our application, we must containerize it in order to build and push to a registry. Create the following Dockerfile in the same directory:

# Sample copied from https://github.com/nodeshift-starters/devfile-sample/blob/main/Dockerfile

# Install the app dependencies in a full Node docker image
FROM registry.access.redhat.com/ubi8/nodejs-14:latest

# Copy package.json and package-lock.json
COPY package*.json ./

# Install app dependencies
RUN npm install --production

# Copy the dependencies into a Slim Node docker image
FROM registry.access.redhat.com/ubi8/nodejs-14-minimal:latest

# Install app dependencies
COPY --from=0 /opt/app-root/src/node_modules /opt/app-root/src/node_modules
COPY . /opt/app-root/src

ENV NODE_ENV production
ENV PORT 3000

CMD ["npm", "start"]

Step 3. Modify the Devfile

Let's modify the devfile.yaml and add the respective deployment code.

caution

When copy/pasting to devfile.yaml, make sure the lines you inserted are correctly indented.

odo deploy uses Devfile schema 2.2.0. Change the schema to reflect the change:

# Deploy "kind" ID's use schema 2.2.0+
schemaVersion: 2.2.0

Add the variables and change them appropriately:

# Add the following variables section anywhere in devfile.yaml
variables:
  APP_NAME: my-nodejs-app
  CONTAINER_PORT: "3000"
  # The ingress domain name is not necessary when deploying to an OpenShift Cluster.
  # OpenShift will provide us with a dynamic URL to access the application.
  DOMAIN_NAME: nodejs.example.com

Add the commands used to deploy:

# This is the main "composite" command that will run all below commands
commands:
- id: deploy
  composite:
    commands:
    - build-image
    - k8s-deployment
    - k8s-service
    - k8s-url
    group:
      isDefault: true
      kind: deploy

# Below are the commands and their respective components that they are "linked" to deploy
- id: build-image
  apply:
    component: outerloop-build
- id: k8s-deployment
  apply:
    component: outerloop-deployment
- id: k8s-service
  apply:
    component: outerloop-service
- id: k8s-url
  apply:
    component: outerloop-url

Add the Docker image location as well as Kubernetes Deployment and Service resources to components:

components:

# This will build the container image before deployment
- name: outerloop-build
  image:
    dockerfile:
      buildContext: ${PROJECT_SOURCE}
      rootRequired: false
      uri: ./Dockerfile
    imageName: "{{APP_NAME}}"

# This will create a Deployment in order to run your container image across
# the cluster.
- name: outerloop-deployment
  kubernetes:
    inlined: |
      kind: Deployment
      apiVersion: apps/v1
      metadata:
        name: {{APP_NAME}}
      spec:
        replicas: 1
        selector:
          matchLabels:
            app: {{APP_NAME}}
        template:
          metadata:
            labels:
              app: {{APP_NAME}}
          spec:
            containers:
              - name: {{APP_NAME}}
                image: {{APP_NAME}}
                ports:
                  - name: http
                    containerPort: {{CONTAINER_PORT}}
                    protocol: TCP
                resources:
                  limits:
                    memory: "1024Mi"
                    cpu: "500m"

# This will create a Service so your Deployment is accessible.
# Depending on your cluster, you may modify this code so it's a
# NodePort, ClusterIP or a LoadBalancer service.
- name: outerloop-service
  kubernetes:
    inlined: |
      apiVersion: v1
      kind: Service
      metadata:
        name: {{APP_NAME}}
      spec:
        ports:
        - name: "{{CONTAINER_PORT}}"
          port: {{CONTAINER_PORT}}
          protocol: TCP
          targetPort: {{CONTAINER_PORT}}
        selector:
          app: {{APP_NAME}}
        type: NodePort

To be able to access our application we need to add one more component to the Devfile. For OpenShift cluster we add Route. For Kubernetes cluster we add Ingress.

Kubernetes

- name: outerloop-url
  kubernetes:
    inlined: |
      apiVersion: networking.k8s.io/v1
      kind: Ingress
      metadata:
        name: {{APP_NAME}}
      spec:
        rules:
          - host: "{{DOMAIN_NAME}}"
            http:
              paths:
                - path: "/"
                  pathType: Prefix
                  backend:
                    service:
                      name: {{APP_NAME}}
                      port:
                        number: {{CONTAINER_PORT}}

OpenShift

- name: outerloop-url
  kubernetes:
    inlined: |
      apiVersion: route.openshift.io/v1
      kind: Route
      metadata:
        name: {{APP_NAME}}
      spec:
        path: /
        to:
          kind: Service
          name: {{APP_NAME}}
        port:
          targetPort: {{CONTAINER_PORT}}

Your final Devfile should look something like this:

note

Your Devfile might slightly vary from the example below, but the example should give you an idea about the placements of all the components and commands.

Kubernetes

commands:
- exec:
    commandLine: npm install
    component: runtime
    group:
      isDefault: true
      kind: build
    workingDir: ${PROJECT_SOURCE}
  id: install
- exec:
    commandLine: npm start
    component: runtime
    group:
      isDefault: true
      kind: run
    workingDir: ${PROJECT_SOURCE}
  id: run
- exec:
    commandLine: npm run debug
    component: runtime
    group:
      isDefault: true
      kind: debug
    workingDir: ${PROJECT_SOURCE}
  id: debug
- exec:
    commandLine: npm test
    component: runtime
    group:
      isDefault: true
      kind: test
    workingDir: ${PROJECT_SOURCE}
  id: test
# This is the main "composite" command that will run all below commands
- id: deploy
  composite:
    commands:
    - build-image
    - k8s-deployment
    - k8s-service
    - k8s-url
    group:
      isDefault: true
      kind: deploy
# Below are the commands and their respective components that they are "linked" to deploy
- id: build-image
  apply:
    component: outerloop-build
- id: k8s-deployment
  apply:
    component: outerloop-deployment
- id: k8s-service
  apply:
    component: outerloop-service
- id: k8s-url
  apply:
    component: outerloop-url
components:
- container:
    args:
    - tail
    - -f
    - /dev/null
    endpoints:
    - name: http-node
      targetPort: 3000
    - exposure: none
      name: debug
      targetPort: 5858
    env:
    - name: DEBUG_PORT
      value: "5858"
    image: registry.access.redhat.com/ubi8/nodejs-16:latest
    memoryLimit: 1024Mi
    mountSources: true
  name: runtime
# This will build the container image before deployment
- name: outerloop-build
  image:
    dockerfile:
      buildContext: ${PROJECT_SOURCE}
      rootRequired: false
      uri: ./Dockerfile
    imageName: "{{APP_NAME}}"
# This will create a Deployment in order to run your container image across
# the cluster.
- name: outerloop-deployment
  kubernetes:
    inlined: |
      kind: Deployment
      apiVersion: apps/v1
      metadata:
        name: {{APP_NAME}}
      spec:
        replicas: 1
        selector:
          matchLabels:
            app: {{APP_NAME}}
        template:
          metadata:
            labels:
              app: {{APP_NAME}}
          spec:
            containers:
              - name: {{APP_NAME}}
                image: {{APP_NAME}}
                ports:
                  - name: http
                    containerPort: {{CONTAINER_PORT}}
                    protocol: TCP
                resources:
                  limits:
                    memory: "1024Mi"
                    cpu: "500m"

# This will create a Service so your Deployment is accessible.
# Depending on your cluster, you may modify this code so it's a
# NodePort, ClusterIP or a LoadBalancer service.
- name: outerloop-service
  kubernetes:
    inlined: |
      apiVersion: v1
      kind: Service
      metadata:
        name: {{APP_NAME}}
      spec:
        ports:
        - name: "{{CONTAINER_PORT}}"
          port: {{CONTAINER_PORT}}
          protocol: TCP
          targetPort: {{CONTAINER_PORT}}
        selector:
          app: {{APP_NAME}}
        type: NodePort
- name: outerloop-url
  kubernetes:
    inlined: |
      apiVersion: networking.k8s.io/v1
      kind: Ingress
      metadata:
        name: {{APP_NAME}}
      spec:
        rules:
          - host: "{{DOMAIN_NAME}}"
            http:
              paths:
                - path: "/"
                  pathType: Prefix
                  backend:
                    service:
                      name: {{APP_NAME}}
                      port:
                        number: {{CONTAINER_PORT}}
metadata:
  description: Stack with Node.js 16
  displayName: Node.js Runtime
  icon: https://nodejs.org/static/images/logos/nodejs-new-pantone-black.svg
  language: JavaScript
  name: my-node-app
  projectType: Node.js
  tags:
  - Node.js
  - Express
  - ubi8
  version: 2.1.1
schemaVersion: 2.2.0
starterProjects:
- git:
    remotes:
      origin: https://github.com/odo-devfiles/nodejs-ex.git
  name: nodejs-starter
variables:
  APP_NAME: my-node-app
  CONTAINER_PORT: "3000"
  DOMAIN_NAME: node.example.com

OpenShift

commands:
- exec:
    commandLine: npm install
    component: runtime
    group:
      isDefault: true
      kind: build
    workingDir: ${PROJECT_SOURCE}
  id: install
- exec:
    commandLine: npm start
    component: runtime
    group:
      isDefault: true
      kind: run
    workingDir: ${PROJECT_SOURCE}
  id: run
- exec:
    commandLine: npm run debug
    component: runtime
    group:
      isDefault: true
      kind: debug
    workingDir: ${PROJECT_SOURCE}
  id: debug
- exec:
    commandLine: npm test
    component: runtime
    group:
      isDefault: true
      kind: test
    workingDir: ${PROJECT_SOURCE}
  id: test
# This is the main "composite" command that will run all below commands
- id: deploy
  composite:
    commands:
    - build-image
    - k8s-deployment
    - k8s-service
    - k8s-url
    group:
      isDefault: true
      kind: deploy
# Below are the commands and their respective components that they are "linked" to deploy
- id: build-image
  apply:
    component: outerloop-build
- id: k8s-deployment
  apply:
    component: outerloop-deployment
- id: k8s-service
  apply:
    component: outerloop-service
- id: k8s-url
  apply:
    component: outerloop-url
components:
- container:
    args:
    - tail
    - -f
    - /dev/null
    endpoints:
    - name: http-node
      targetPort: 3000
    - exposure: none
      name: debug
      targetPort: 5858
    env:
    - name: DEBUG_PORT
      value: "5858"
    image: registry.access.redhat.com/ubi8/nodejs-16:latest
    memoryLimit: 1024Mi
    mountSources: true
  name: runtime
# This will build the container image before deployment
- name: outerloop-build
  image:
    dockerfile:
      buildContext: ${PROJECT_SOURCE}
      rootRequired: false
      uri: ./Dockerfile
    imageName: "{{APP_NAME}}"
# This will create a Deployment in order to run your container image across
# the cluster.
- name: outerloop-deployment
  kubernetes:
    inlined: |
      kind: Deployment
      apiVersion: apps/v1
      metadata:
        name: {{APP_NAME}}
      spec:
        replicas: 1
        selector:
          matchLabels:
            app: {{APP_NAME}}
        template:
          metadata:
            labels:
              app: {{APP_NAME}}
          spec:
            containers:
              - name: {{APP_NAME}}
                image: {{APP_NAME}}
                ports:
                  - name: http
                    containerPort: {{CONTAINER_PORT}}
                    protocol: TCP
                resources:
                  limits:
                    memory: "1024Mi"
                    cpu: "500m"

# This will create a Service so your Deployment is accessible.
# Depending on your cluster, you may modify this code so it's a
# NodePort, ClusterIP or a LoadBalancer service.
- name: outerloop-service
  kubernetes:
    inlined: |
      apiVersion: v1
      kind: Service
      metadata:
        name: {{APP_NAME}}
      spec:
        ports:
        - name: "{{CONTAINER_PORT}}"
          port: {{CONTAINER_PORT}}
          protocol: TCP
          targetPort: {{CONTAINER_PORT}}
        selector:
          app: {{APP_NAME}}
        type: NodePort
- name: outerloop-url
  kubernetes:
    inlined: |
      apiVersion: route.openshift.io/v1
      kind: Route
      metadata:
        name: {{APP_NAME}}
      spec:
        path: /
        to:
          kind: Service
          name: {{APP_NAME}}
        port:
          targetPort: {{CONTAINER_PORT}}
metadata:
  description: Stack with Node.js 16
  displayName: Node.js Runtime
  icon: https://nodejs.org/static/images/logos/nodejs-new-pantone-black.svg
  language: JavaScript
  name: my-node-app
  projectType: Node.js
  tags:
  - Node.js
  - Express
  - ubi8
  version: 2.1.1
schemaVersion: 2.2.0
starterProjects:
- git:
    remotes:
      origin: https://github.com/odo-devfiles/nodejs-ex.git
  name: nodejs-starter
variables:
  APP_NAME: my-node-app
  CONTAINER_PORT: "3000"
  DOMAIN_NAME: node.example.com

Step 4. Run the odo deploy command

Now we're ready to deploy our application on the cluster:

odo deploy

Sample Output

$ odo deploy
  __
 /  \__     Deploying the application using my-nodejs-app Devfile
 \__/  \    Namespace: odo-dev
 /  \__/    odo version: v3.15.0
 \__/

↪ Building & Pushing Container: ttl.sh/my-nodejs-app-my-nodejs-app:611242
 •  Building image locally  ...
build -t ttl.sh/my-nodejs-app-my-nodejs-app -f /home/user/quickstart-demo/nodejs-demo/Dockerfile /home/user/quickstart-demo/nodejs-demo
 ✓  Building image locally
 •  Pushing image to container registry  ...
push ttl.sh/my-nodejs-app-my-nodejs-app
 ✓  Pushing image to container registry

↪ Deploying Kubernetes Component: my-nodejs-app
 ✓  Creating resource Deployment/my-nodejs-app

↪ Deploying Kubernetes Component: my-nodejs-app
 ✓  Creating resource Service/my-nodejs-app

↪ Deploying Kubernetes Component: my-nodejs-app
 ✓  Creating resource Ingress/my-nodejs-app

Your Devfile has been successfully deployed

note

If you are using the quay.io registry, you might have to change the permissions of the newly pushed image to Public to continue. Otherwise, you might see failures related to pulling the image.

Step 5. Accessing the application

You can now determine how to access the application by running odo describe component:

odo describe component

Check for Kubernetes Ingresses if you are on a Kubernetes cluster or OpenShift Routes if you are an OpenShift cluster to obtain the URI for accessing your application.

Sample Output

Kubernetes

Name: my-nodejs-app
Display Name: Node.js Runtime
Project Type: Node.js
Language: JavaScript
Version: 2.1.1
Description: Stack with Node.js 16
Tags: Node.js, Express, ubi8

Running in: Deploy

Supported odo features:
 •  Dev: true
 •  Deploy: true
 •  Debug: false

Container components:
 •  runtime

Kubernetes components:
 •  outerloop-deployment
 •  outerloop-service
 •  outerloop-url

Kubernetes Ingresses:
 •  my-go-app: go.example.com/

OpenShift

Name: my-nodejs-app
Display Name: Node.js Runtime
Project Type: Node.js
Language: JavaScript
Version: 2.1.1
Description: Stack with Node.js 16
Tags: Node.js, Express, ubi8

Running in: Deploy

Supported odo features:
 •  Dev: true
 •  Deploy: true
 •  Debug: false

Container components:
 •  runtime

Kubernetes components:
 •  outerloop-deployment
 •  outerloop-service
 •  outerloop-url

OpenShift Routes:
 •  my-nodejs-app: my-nodejs-app-user-crt-dev.apps.sandbox-m2.ll9k.p1.openshiftapps.com/

Kubernetes

Since we are using Ingress, we can check if an IP address has been set.

$ kubectl get ingress my-nodejs-app
NAME            CLASS     HOSTS                ADDRESS      PORTS   AGE
my-nodejs-app   traefik   nodejs.example.com   172.19.0.2   80      2m2s

Once the IP address appears, you can now access the application, like so:

curl --resolve "nodejs.example.com:80:172.19.0.2" -i http://nodejs.example.com/

OpenShift

We can directly access the application by using the OpenShift Route displayed in the odo describe component output above:

curl -i http://my-nodejs-app-user-crt-dev.apps.sandbox-m2.ll9k.p1.openshiftapps.com/

Step 6. Delete the resources

After testing your application, you may optionally undeploy using the odo delete component command:

odo delete component

Sample output

$ odo delete component
Searching resources to delete, please wait...
This will delete "my-nodejs-app" from the namespace "odo-dev".
 •  The following resources will get deleted from cluster:
 •      - Deployment: my-nodejs-app
 •      - Service: my-nodejs-app
 •      - Ingress: my-nodejs-app

? Are you sure you want to delete "my-nodejs-app" and all its resources? Yes
 ✓  Deleting resources from cluster [65ms]
The component "my-nodejs-app" is successfully deleted from namespace "odo-dev"