Skip to content

Latest commit

 

History

History

helm

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
api
api
 
 
blockchain
blockchain
 
 
cluster
cluster
 
 
excel-export
excel-export
 
 
frontend
frontend
 
 
provisioning
provisioning
 
 
tests
tests
 
 
README.md
README.md
 
 

README.md

Helm Chart TruBudget

Deploy TruBudget to Kubernetes with Helm

Introduction and Basics

The following guide will help you set up TruBudget on a Kubernetes cluster using Helm charts. In order to configure TruBudget or enable services you will need to take additional steps, but this guide should provide a starting point.

Using these charts, the following resources will be set up for each of the enabled services:

  • a deployment and a pod for each of the TruBudget components that are enabled and that don't need persistance. The deployment creates a replica set that makes sure a pod is up and running at any given time.
  • services for TruBudget components that are enabled. The services expose the underlying pods and make communication between components as well as between TruBudget nodes possible.
  • stateful sets, for all the components that have data that needs to be persisted (blockchain, minio, or email-notification-service).
  • ingress, to enable https access to the frontend service.
  • job, for running the provisioning script.

Prerequisites

Make sure to have Helm installed on the Kubernetes cluster.

helm init

Clone openkfw/TruBudget repository and go to helm folder.

git clone https://github.com/openkfw/TruBudget.git
cd TruBudget/helm

Note: If you enable PVs make sure the underlying infrastructure is supporting PV provisioning.

Deploy TruBudget components to your cluster

Navigate to the cluster folder and update dependencies

cd cluster
helm dep update

Deploy components

helm install . --name trubudget --namespace my-namespace --set tags.minimal=true

This will deploy following components:

  • Ingress
  • Frontend
  • API Test
  • API Prod
  • Blockchain Test
  • Blockchain Prod

Delete chart

helm delete --purge trubudget

Configuration

The following table lists the most important configurable parameters of the TruBudget chart and their default values. For a full list check the values.yaml file.

Parameter Description Default
tags.minimal Includes blockchain-prod-1, blockchain-test1, api-prod-1, api-test1 and frontend-1 components in deployed chart false
tags.blockchain Includes blockchain-prod-1 and blockchain-test1 components in deployed chart false
tags.api Includes api-prod-1 and api-test1 components in deployed chart false
tags.frontend Includes frontend-1 components in deployed chart false
global.image.tag trubudget image tag main
global.fqdn ingress host my-trubudget-url.com
global.fqdn ingress host my-trubudget-url.com
global.env.PROVISIONING_TYPE=PROD if set to PROD, the blockchain resource will be set deployed as statefulsetand persist its data on a PV DEV
global.env.PROVISIONING_TYPE=TEST if set to TEST, except that blockchain service account will be excluded from chart DEV
global.env.STORAGE_TYPE=LOCAL if set to LOCAL, data is stored in the pod itself LOCAL
global.env.STORAGE_TYPE=AZURE_DISK if set to AZURE_DISK, data is stored on a dynamically created azure disk LOCAL
global.env.STORAGE_TYPE=AZURE_FILE if set to AZURE_FILE, data is stored on a dynamically created azure file LOCAL
global.env.EXPOSE_MC if set to true, the blockchain application will check for the external service IP before starting and use it as externalIp false
frontend.initContainer use like frontend-1.initContainer to enable/disable provisioning container as init containers false
frontend.ingress.enabled use like frontend-1.ingress.enabled to enable/disable ingress false
frontend.ingress.fqdnPrefix use like frontend-1.ingress.fqdnPrefix to add a prefix to the global.fqdn a for frontend-1, b for frontend-2

Tip: Edit the default values.yaml file that specifies the values for the above parameters, before executing the helm command.

Alternatively, specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

helm install . --name trubudget --namespace my-namespace --set tags.minimal=true --set frontend-1.ingress.enabled=true

Deploy Provisioning component to Kubernetes

To deploy the provisioning components in order to create some initial test data, check out the provisioning helm chart.

Deploy E2E component to Kubernetes

To deploy a isolated environment to execute E2E tests, check out the e2e-test helm chart.