Merge pull request #223 from projectsyn/helm-chart-version-standardis…

…ation Refactor helm chart parameters against Project Syn best practices
projectsyn · Jul 10, 2023 · b62545d · b62545d
2 parents d17069c + 0804bf2
commit b62545d
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 16 deletions.
diff --git a/class/defaults.yml b/class/defaults.yml
@@ -57,8 +57,12 @@ parameters:
         repository: bitnami/bitnami-shell
         tag: 11-debian-11-r76
     charts:
-      keycloakx: "2.2.1"
-      postgresql: "12.5.6"
+      keycloakx:
+        source: https://codecentric.github.io/helm-charts
+        version: v2.2.1
+      postgresql:
+        source: https://charts.bitnami.com/bitnami
+        version: v12.5.6
     # FQDN should be overwritten on the cluster level
     fqdn: keycloak.example.com
     # Disables dynamically resolving the hostname from request headers.

diff --git a/class/keycloak.yml b/class/keycloak.yml
@@ -2,15 +2,15 @@ parameters:
   kapitan:
     dependencies:
       - type: helm
+        source: ${keycloak:charts:keycloakx:source}
         chart_name: keycloakx
-        version: ${keycloak:charts:keycloakx}
-        source: https://codecentric.github.io/helm-charts
-        output_path: dependencies/keycloak/helmcharts/keycloakx/${keycloak:charts:keycloakx}/
+        version: ${keycloak:charts:keycloakx:version}
+        output_path: dependencies/keycloak/helmcharts/keycloakx/${keycloak:charts:keycloakx:version}
       - type: helm
+        source: ${keycloak:charts:postgresql:source}
         chart_name: postgresql
-        version: ${keycloak:charts:postgresql}
-        source: https://charts.bitnami.com/bitnami
-        output_path: dependencies/keycloak/helmcharts/postgresql/${keycloak:charts:postgresql}/
+        version: ${keycloak:charts:postgresql:version}
+        output_path: dependencies/keycloak/helmcharts/postgresql/${keycloak:charts:postgresql:version}
     compile:
       - input_paths:
           - keycloak/component/app.jsonnet
@@ -28,7 +28,7 @@ parameters:
         input_type: helm
         output_type: yaml
         input_paths:
-          - keycloak/helmcharts/keycloakx/${keycloak:charts:keycloakx}/
+          - keycloak/helmcharts/keycloakx/${keycloak:charts:keycloakx:version}
         helm_params:
           name: keycloakx
           namespace: "${keycloak:namespace}"
@@ -37,7 +37,7 @@ parameters:
         input_type: helm
         output_type: yaml
         input_paths:
-          - keycloak/helmcharts/postgresql/${keycloak:charts:postgresql}/
+          - keycloak/helmcharts/postgresql/${keycloak:charts:postgresql:version}
         helm_params:
           name: keycloak
           namespace: "${keycloak:namespace}"

diff --git a/docs/modules/ROOT/pages/references/parameters.adoc b/docs/modules/ROOT/pages/references/parameters.adoc
@@ -67,22 +67,43 @@ default:: `see class/defaults.yml`
 The image tag used for the container image path.
 
 
-== `charts.keycloakx`
+== `charts.keycloakx.source`
+
+[horizontal]
+type:: helm chart source
+default:: `https://codecentric.github.io/helm-charts`
+
+A specific helm chart source.
+See the https://kapitan.dev/external_dependencies/#helm-type[kapitan documentation] for more information.
+
+
+== `charts.keycloakx.version`
 
 [horizontal]
 type:: helm chart version
-default:: `1.6.1`
+default:: See `class/defaults.yml`
+
+A specific helm chart version. See the https://kapitan.dev/external_dependencies/#helm-type[kapitan documentation] for more information.
+
+
+== `charts.postgresql.source`
+
+[horizontal]
+type:: helm chart source
+default:: `https://charts.bitnami.com/bitnami`
 
-A specific chart version. See the https://kapitan.dev/external_dependencies/#helm-type[kapitan documentation] for more information.
+A specific helm chart source.
+See the https://kapitan.dev/external_dependencies/#helm-type[kapitan documentation] for more information.
 
 
-== `charts.postgresql`
+== `charts.postgresql.version`
 
 [horizontal]
 type:: helm chart version
-default:: `11.6.15`
+default:: See `class/defaults.yml`
 
-A specific chart version. See the https://kapitan.dev/external_dependencies/#helm-type[kapitan documentation] for more information.
+A specific chart version.
+See the https://kapitan.dev/external_dependencies/#helm-type[kapitan documentation] for more information.
 
 
 == `fqdn`