Skip to content

Commit 78d93b0

Browse files
committedJun 23, 2023
update docs

File tree

1 file changed

+88
-13
lines changed

1 file changed

+88
-13
lines changed
 

‎websites/docs/src/pages/en/learn/deployment.md

+88-13
Original file line numberDiff line numberDiff line change
@@ -25,23 +25,98 @@ layout: '../../../layouts/MainLayout.astro'
2525
The application should now be running at the ports defined in your Docker Compose configuration.
2626

2727
### Kubernetes Deployment (Helm)
28+
# Install ballerine using helm chart
2829

29-
1. **Add the Ballerine Chart Repo**: Add the Helm chart repository that contains the Ballerine charts:
30-
```shell
31-
helm repo add ballerine https://helm.ballerine.io
32-
```
30+
Ballerine is a collection of services like workflow-service, backendoffice.
31+
In values.yaml we have sections to enable/disable them based on the necessity like below
3332

34-
2. **Update your Helm Repo**: Fetch the latest version of the Helm chart from the repo:
35-
```shell
36-
helm repo update
37-
```
33+
``` bash
34+
workflowService:
35+
enabled: true
36+
```
3837

39-
3. **Install the Ballerine Chart**: Now you can install the Ballerine Helm chart onto your Kubernetes cluster:
40-
```shell
41-
helm install ballerine ballerine/ballerine
42-
```
38+
## Prerequisites
39+
40+
- kubernetes cluster
41+
- [helm](https://helm.sh/docs/intro/install/)
42+
- [kubectl](https://storage.googleapis.com/kubernetes-release/release/v1.23.6/bin/linux/amd64/kubectl) preferably 1.24 or less upto 1.23
43+
44+
### How to install
45+
46+
Move to deploy directory
47+
48+
```bash
49+
cd deploy/helm
50+
```
51+
52+
### Setup Postgresql
53+
54+
#### Install postgresql along with ballerine
55+
56+
- edit values.yaml
57+
58+
```bash
59+
## Postgres params
60+
postgresql:
61+
enabled: true
62+
auth:
63+
username: admin
64+
password: admin
65+
postgresPassword: admin
66+
database: postgres
67+
# Local dev purpose
68+
# persistence:
69+
# existingClaim: postgresql-pv-claim
70+
# volumePermissions:
71+
# enabled: true
72+
```
73+
74+
#### How to use managed postgresql along with ballerine
75+
76+
- edit values.yaml
77+
78+
```bash
79+
## Postgres params
80+
postgresql:
81+
enabled: false
82+
.
83+
.
84+
.
85+
.
86+
applicationConfig:
87+
BCRYPT_SALT: "10"
88+
JWT_SECRET_KEY: "secret"
89+
JWT_EXPIRATION: "10d"
90+
DB_URL: "<Managed DB_URL with databasename>"
91+
DB_USER: "<Managed DB_USER>"
92+
DB_PASSWORD: "<Managed DB_PASSWORD>"
93+
DB_PORT: "5432"
94+
```
95+
96+
### Installing Ballerine helm chart
97+
98+
``` bash
99+
helm install ballerine . -n ballerine --create-namespace -f values.yaml
100+
```
101+
102+
### Troubleshooting
103+
104+
```bash
105+
kubectl get pods -n ballerine
106+
```
107+
108+
- Note the pod name of service you wish to trouble shoot
109+
110+
```bash
111+
kubectl logs <pod> -n ballerine
112+
```
113+
114+
- Accessing the application
115+
116+
```bash
117+
kubectl port-forward svc/<service> -n ballerine 3000:3000
118+
```
43119

44-
By default, the application will be deployed on your default namespace. You can specify a different namespace by adding `-n <namespace>` at the end of the `helm install` command.
45120

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

0 commit comments

Comments
 (0)
Please sign in to comment.