Deployment

io.Bridge is available as a Docker image that can be deployed in a Kubernetes environment.

To deploy io.Bridge in a Kubernetes environment, you can use the Helm package manager for Kubernetes. io.Bridge provides a Helm chart for Kubernetes deployment. The Helm chart is hosted at the GitHub Container Registry at ghcr.io/interopio/charts/io-bridge.

ℹ️ For details on using the Helm package manager, see the official Helm documentation.

Usage

The following example demonstrates how to log in the registry and pull a specific version of the io.Bridge Helm chart:

helm registry login ghcr.io

helm pull oci://ghcr.io/interopio/charts/io-bridge --version 0.0.3-beta

The following example demonstrates how to install a specific version of the io.Bridge Helm chart and create a namespace and a name for the Helm release:

helm install --namespace interop-io-bridge --generate-name oci://ghcr.io/interopio/charts/io-bridge --version 0.0.3-beta

The following example demonstrates how to uninstall the io.Bridge Helm chart:

helm uninstall io-bridge

Configuration

The available configuration options for deploying io.Bridge are listed in the values.yaml file of the io.Bridge Helm chart. You can override the default values by using the --set flag when installing the chart or by using the -f or the --values flag to provide your custom YAML configuration file.

The following example demonstrates how to modify the number of io.Bridge nodes to be deployed in the cluster by using the --set flag to override the cluster.memberCount property specified in the default values.yaml file:

helm install my-io-bridge-release oci://ghcr.io/interopio/charts/io-bridge --set cluster.memberCount=4

The following example demonstrates how to provide your own custom YAML configuration file when installing the io.Bridge Helm chart:

helm install my-io-bridge-release oci://ghcr.io/interopio/charts/io-bridge -f my-values.yaml

The io.Bridge Docker image is available in two variants based on different base images: alpine and trixie-slim. Both variants are functionally identical and differ only in the underlying operating system and package manager.

Alpine

The alpine variant is based on Alpine Linux and uses musl libc instead of glibc. Alpine images are significantly smaller in size, making them ideal for resource-constrained environments where minimizing image size and potential vulnerabilities is a priority.

⚠️ Note that the alpine variant may not be suitable if you require compatibility with native libraries and extensions that depend on glibc. In such cases, it recommended to use the trixie-slim variant.

The following example demonstrates how to configure the io.Bridge Helm chart to use the Alpine image variant by overriding the image.tag property:

helm install my-io-bridge-release oci://ghcr.io/interopio/charts/io-bridge --set image.tag=1.0.6-alpine

The following example demonstrates how to specify the Alpine image variant in a custom values.yaml configuration file:

image:
  registry: "ghcr.io"
  repository: "interopio/bridge"
  tag: "1.0.6-alpine"
  pullPolicy: IfNotPresent

Trixie Slim

The trixie-slim variant is based on Debian Trixie with non-essential packages removed. It uses glibc, which offers broader compatibility with native libraries and extensions. This variant provides a good balance between image size and compatibility.

The following example demonstrates how to configure the io.Bridge Helm chart to use the trixie-slim image variant by overriding the image.tag property:

helm install my-io-bridge-release oci://ghcr.io/interopio/charts/io-bridge --set image.tag=1.0.6-trixie-slim

The following example demonstrates how to specify the trixie-slim image variant in a custom values.yaml configuration file:

image:
  registry: "ghcr.io"
  repository: "interopio/bridge"
  tag: "1.0.6-trixie-slim"
  pullPolicy: IfNotPresent