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

Connect to services on Kubernetes easily with kube-service-bindings

August 11, 2022
Costas Papastathis Michael Dawson
Related topics:
KubernetesNode.jsOperators
Related products:
Red Hat OpenShift

Share:

One of the projects the Node.js team at Red Hat has been focusing on over the past year is the development of kube-service-bindings for Kubernetes. We've found that combining the Service Binding Operator and kube-service-bindings is a convenient and consistent way of sharing credentials for services, letting you easily secure your deployments.

This article is the first of a three-part series. Our goals in the series are to:

  • Introduce Kubernetes service bindings and the Service Binding Operator.
  • Explain how the kube-service-bindings NPM package supports service bindings for Node.js applications.
  • Cover the clients we've added support for in kube-service-bindings.
  • Show an end-to-end deployment of a Node.js application communicating with a database in a Kubernetes setting.

After reading this article and parts two and three of the series, you should have a better understanding of how service bindings and kube-service-bindings work. This first article explains the tools we're using and their benefits for Node.js programmers using Kubernetes.

What are service bindings and the Service Binding Operator?

In our service binding terminology for Kubernetes, a service binding provides information about a service to a process that needs to bind to that service. In subsequent parts of this series, for instance, you will use a service binding to provide the credentials of a MongoDB database when your Node.js application connects to it. The database is called a backing service, while the application is called the workload. The data passed between them is called binding data.

Protocols and rules for sharing information are laid out in the Service Binding Specification for Kubernetes. The Service Binding Operator (SBO) establishes a connection to share the credentials between the workload and backing service. The SBO is implemented by Red Hat and is available in the OpenShift Operator Hub.

The Service Binding Operator has two significant benefits compared to other methods of sharing secrets. The first is security: The SBO requires less exposure of credentials or secrets throughout the CI/CD process. The second benefit is convenience: Rarely is development as easy as dragging a line in a graphical user interface (UI) in the Red Hat OpenShift console.

You can find more information on how the Service Binding Operator works in the article Announcing Service Binding Operator 1.0 GA. The article Simplify secure connections to PostgreSQL databases with Node.js provides information about using the SBO to share credentials among backing services and compares the technique to others, using as an example the PostgreSQL client supported by kube-service-bindings.

In the background, the SBO:

  • Passes a variable named SERVICE_BINDING_ROOT to the application environment to direct it to the credentials.
  • Projects the binding data into the application container, under the directory /$SERVICE_BINDING_ROOT/<application-name>.

What is kube-service-bindings and how does it work?

kube-service-bindings finds, parses, and transforms data such as credentials into a consumable format appropriate for each client, such as a database. kube-service-bindings checks the SERVICE_BINDING_ROOT environment variable to find which directory in the application instance has the binding data. The presence of the SERVICE_BINDING_ROOT variable indicates that binding data is available. If the environment variable or binding data are not available, kube-service-bindings throws an error, which can easily be discovered through a try/catch block.

Besides parsing the data, kube-service-bindings knows exactly what it takes to provide the right configuration for each client, another advantage to using the package. Our goal in developing kube-service-bindings is to support the most common clients. We started by supporting backing services listed in the General Availability (GA) release for the Red Hat Service Binding Operator, as outlined in the section Extracting the binding data from backing services of the previously mentioned article.

Version 1.0 of kube-service-bindings has made a good start in its support for clients. We would like to prioritize our work based on the needs of the community, so feel free to open a request in the kube-service-bindings repository for the next client you would like to see supported.

Table 1 shows the currently supported clients. To connect to a client, the Node.js program issues a getBinding call, passing the type (column 1) as the first argument and the client (column 2) as the second.

Table 1: Clients currently supported by kube-service-bindings.

Type

Client

Date Added

AMQP

rhea

March 2022

Kafka

node-rdkafka

April 2021

Kafka

kafkajs

April 2021

MongoDB

MongoDB

February 2022

MongoDB

mongoose

June 2022

MySQL

MySQL

May 2022

MySQL

MySQL 2

May 2022

MySQL

odbc

May 2022

PostgreSQL

odbc

June 2022

PostgreSQL

postgres

December 2021

Redis

redis

January 2022

Redis

ioredis

January 2022

Simplifying access to services on Kubernetes

This article has explained the roles of the Service Binding Operator and kube-service-bindings in making it easy to connect to backing services such as databases. Subsequent articles in this series will go through an example that connects a Node.js application to a database using these tools.

Last updated: August 14, 2023

Related Posts

  • Enable backing services in Kubernetes with kube-service-bindings

  • Connect MongoDB to a Node.js application with kube-service-bindings

  • Announcing Service Binding Operator 1.0 GA

  • Simplify secure connections to PostgreSQL databases with Node.js

  • Bind a Kafka cluster to a Node.js application the easy way

Recent Posts

  • Storage considerations for OpenShift Virtualization

  • Upgrade from OpenShift Service Mesh 2.6 to 3.0 with Kiali

  • EE Builder with Ansible Automation Platform on OpenShift

  • How to debug confidential containers securely

  • Announcing self-service access to Red Hat Enterprise Linux for Business Developers

What’s up next?

The Node.js cheat sheet will help you master the most useful command-line flags to customize Node.js’s behavior. You’ll save time and energy looking up how to do everyday development tasks like executing scripts, debugging, and monitoring your Node.js applications.

Get the cheat sheet
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
© 2025 Red Hat

Red Hat legal and privacy links

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

Report a website issue