Skip to content

Commit 9d1d130

Browse files
Update docs and chart metadata
1 parent 1e01228 commit 9d1d130

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

charts/openproject-id/Chart.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,5 @@ maintainers:
1414
- name: OpenProject
1515
url: https://github.com/opf/
1616
name: openproject-id
17+
description: Configures a Keycloak like we use it for OpenProject ID.
1718
version: 0.1.2

charts/openproject-id/README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,28 @@ The intention is to have templates that are easier to read, while giving us flex
66

77
## Configuration
88

9+
### Development
10+
911
The defaults in the helm chart should be working right away on a development cluster (e.g. minikube):
1012

11-
```
13+
```bash
1214
helm upgrade --install keycloak .
1315
```
1416

15-
On a production system you want to:
16-
17-
* disable the postgres dependency (because we want to run the database in a managed service like RDS)
18-
* disable generation of secrets, because we usually seed these externally, e.g. via Terraform
19-
* Customize the remaining values (e.g. adding annotations)
17+
### Production
2018

21-
On production add the repo like so.
19+
Make sure that the corresponding Helm repository is configured:
2220

2321
```bash
2422
helm repo add openproject-id https://opf.github.io/openproject-id/
2523
```
2624

25+
Configuration-wise you want to:
26+
27+
* disable the postgres dependency (because we want to run the database in a managed service like RDS)
28+
* disable generation of secrets, because we usually seed these externally, e.g. via Terraform
29+
* Customize the remaining values (e.g. adding annotations)
30+
2731
An example values.yaml for your production environment might look like this:
2832

2933
```yaml

0 commit comments

Comments
 (0)