From 74d2bd770f0facb829ee02923f50bd1ee9fe1896 Mon Sep 17 00:00:00 2001 From: Jim Martens Date: Sun, 20 Aug 2023 23:08:58 +0200 Subject: [PATCH] Filled out README files and added production config for wahlrecht --- helm/configserver/README.md | 35 +++++++++++++++++-- helm/wahlrecht/Chart.lock | 6 ++-- helm/wahlrecht/Chart.yaml | 2 +- helm/wahlrecht/README.md | 38 +++++++++++++++++++-- helm/wahlrecht/environments/production.yaml | 2 ++ 5 files changed, 74 insertions(+), 9 deletions(-) create mode 100644 helm/wahlrecht/environments/production.yaml diff --git a/helm/configserver/README.md b/helm/configserver/README.md index c955b5f..7d20ac7 100644 --- a/helm/configserver/README.md +++ b/helm/configserver/README.md @@ -3,6 +3,37 @@ This chart installs a minimal Spring Boot configserver into the Kubernetes cluster. -## Requirements +## Configuration -* needs a running Kafka instance (host and port can be configured) +* by default, it expects a Kafka running inside the cluster, available under + kafka:9092 + ```yaml + application: + kafka: + host: kafka + port: 9092 + ``` +* change Git repository used to fetch configuration + ```yaml + application: + repositoryPath: yourPath + ``` +* if necessary, adjust search path within repository + ```yaml + application: + searchPath: yourPath + ``` +* if necessary, adjust prefix of config server + ```yaml + application: + prefix: /config + ``` +* if necessary, adjust ports + ```yaml + application: + port: 8888 + actuatorPort: 13000 + service: + port: 8888 + actuatorPort: 13000 + ``` \ No newline at end of file diff --git a/helm/wahlrecht/Chart.lock b/helm/wahlrecht/Chart.lock index 7e704b2..7b1ffe1 100644 --- a/helm/wahlrecht/Chart.lock +++ b/helm/wahlrecht/Chart.lock @@ -1,6 +1,6 @@ dependencies: - name: template repository: file://../template - version: 0.1.5 -digest: sha256:02ec98f8169a9fdd9155a9ffd790472f1ea0b1c1b1274ccaff10002aa42da2a7 -generated: "2023-08-20T20:04:03.22839+02:00" + version: 0.1.6 +digest: sha256:40131d6bbdde57f882dcdc958122f7a3553e3b71e6f24445a17dd12182b99bed +generated: "2023-08-20T23:07:51.509297+02:00" diff --git a/helm/wahlrecht/Chart.yaml b/helm/wahlrecht/Chart.yaml index e98b167..eafee7f 100644 --- a/helm/wahlrecht/Chart.yaml +++ b/helm/wahlrecht/Chart.yaml @@ -10,5 +10,5 @@ sources: - https://git.2martens.de/2martens/wahlrecht dependencies: - name: template - version: 0.1.5 + version: 0.1.6 repository: file://../template diff --git a/helm/wahlrecht/README.md b/helm/wahlrecht/README.md index e8e34bc..21e27e3 100644 --- a/helm/wahlrecht/README.md +++ b/helm/wahlrecht/README.md @@ -3,7 +3,39 @@ This chart installs the Wahlrecht API into the Kubernetes cluster. -## Requirements +## Configuration -* running config server (host and port can be configured) -* running Kafka (host and port can be configured) +* by default, it expects a Spring Boot config server running inside the cluster, available under + http://configserver:8888/config + ```yaml + application: + configserver: + host: configserver + port: 8888 + prefix: /config + scheme: http + ``` +* by default, it expects a Kafka running inside the cluster, available under + kafka:9092 + ```yaml + application: + kafka: + host: kafka + port: 9092 + ``` +* configure Keycloak + ```yaml + application: + keycloak: + url: https://yourKeycloak + realm: yourRealm + ``` +* configure secrets (the application expects these values to be set) + ```yaml + secrets: + MONGODB_CONNECTION_STRING: mongoDBConnectionString + CLIENT_SECRET: keycloakClientSecret + ``` + Should you want to use, for example, an external secret provider, + then you are currently out of luck. The chart does not support that, + yet. \ No newline at end of file diff --git a/helm/wahlrecht/environments/production.yaml b/helm/wahlrecht/environments/production.yaml new file mode 100644 index 0000000..74bfdc9 --- /dev/null +++ b/helm/wahlrecht/environments/production.yaml @@ -0,0 +1,2 @@ +image: + tag: 0.2.8