☸️Deploy Hyperswitch on Kubernetes

Install Hyperswitch on your K8s setup using our Helm charts

This section outlines cloud-provider agnostic deployment steps for easy installation of the Hyperswitch stack on your K8s cluster


  1. Active Redis service

  2. Create a Postgres database and run the schema migration using the below commands

git clone https://github.com/juspay/hyperswitch.git
diesel migration --database-url postgres://{{user}}:{{password}}@{{host_name}}:5432/{{db_name}} run
  1. Kubernetes Cluster

  2. Add the following label to your node group

node-type: generic-compute

The concept of a "Node group" is a term used in both AWS and GCP to describe a collection of nodes within a cluster. In Azure, however, this is referred to as a "Node pool" within the hierarchy

  1. Create a namespace hyperswitch in your kubernetes cluster using the below commands

kubectl create namespace hyperswitch
  1. Load Balancer Controller Service specific to your Kubernetes cluster provider

On Amazon Web Services (AWS) Cloud, deploy the AWS Load Balancer Controller On Azure Cloud, utilize the Application Gateway Ingress Controller On Google Cloud Platform (GCP), deploy the GKE Ingress Controller


Step 1 - Clone repo and Update Configurations

Clone the hyperswitch-stack repo and start updating the configs

git clone https://github.com/juspay/hyperswitch-helm.git
cd hyperswitch-helm/charts/incubator/hyperswitch-stack

Step 2 - Install Hyperswitch

Before installing the service make sure you label your kubernetes nodes and create a namespace hyperswitch

kubectl label nodes <your-node-name> node-type=generic-compute
kubectl create namespace hyperswitch

Use below command to install hyperswitch services with above configs

helm install hyperswitch-v1 . -n hyperswitch

That's it! Hyperswitch should be up and running on your AWS account πŸŽ‰ πŸŽ‰

Post-Deployment Checklist

After deploying the Helm chart, you should verify that everything is working correctly

App Server

Control Center

Test a payment

Step 1 - Deploy card vault

Card Vault Installation

If you intend to save cards of your customers for future usage then you need a Card Vault. This helm chart doesn't cover inbuilt card vault support as it will violate PCI compliance. You can install manually by following the steps here or use this doc to deploy card vault in aws

Step 2 - Make a payment using our Demo App

Use the Hyperswitch Demo app and make a payment with test card.

Refer our postman collection to try out REST APIs

Contribution guidelines

When you want others to use the changes you have added you need to package it and then index it

helm package .
helm repo index . --url https://juspay.github.io/hyperswitch-helm

Get Repo Info

helm repo add hyperswitch-helm https://juspay.github.io/hyperswitch-helm
helm repo update

Next step:

πŸ”§Account setup

Last updated