Skip to content
Ballerine Documentation

Deployment Guide

Docker Compose Deployment

  1. Clone the project: Use Git to clone the Ballerine repository to your local machine:
git clone https://github.com/ballerine-io/ballerine.git && cd ballerine
  1. Switch to the dev branch: After cloning, switch to the dev branch (or the branch you wish to deploy):
git checkout dev
  1. Run Docker Compose: Now, you can start all services using Docker Compose:
docker-compose up -d

The application should now be running at the ports defined in your Docker Compose configuration.

Kubernetes Deployment (Helm)

Install ballerine using helm chart

Ballerine is a collection of services like workflow-service, and backoffice. In values.yaml we have sections to enable/disable them based on the necessity like below

workflowService:
  enabled: true

Prerequisites

  • kubernetes cluster
  • helm
  • kubectl preferably 1.24 or less upto 1.23

How to install

Move to deploy directory

cd deploy/helm

Setup Postgresql

Install postgresql along with ballerine

  • edit values.yaml
## Postgres params
postgresql:
  enabled: true
  auth:
    username: admin
    password: admin
    postgresPassword: admin
    database: postgres
#   Local dev purpose
#   persistence:
#     existingClaim: postgresql-pv-claim
#   volumePermissions:
#     enabled: true

How to use managed postgresql along with ballerine

  • edit values.yaml
## Postgres params
postgresql:
  enabled: false
.
.
.
.
  applicationConfig:
    BCRYPT_SALT: "10"
    SESSION_EXPIRATION_IN_MINUTES: "60"
    DB_URL: "<Managed DB_URL with databasename>"
    DB_USER: "<Managed DB_USER>"
    DB_PASSWORD: "<Managed DB_PASSWORD>"
    DB_PORT: "5432"

Installing Ballerine helm chart

helm install ballerine . -n ballerine --create-namespace -f values.yaml

Troubleshooting

kubectl get pods -n ballerine
  • Note the pod name of service you wish to trouble shoot
kubectl logs <pod> -n ballerine
  • Accessing the application
kubectl port-forward svc/<service> -n ballerine 3000:3000

Always refer to the official documentation of Ballerine for more specific configuration and deployment details.