Various chart enhancements (#8)

Signed-off-by: Andrew Block <[email protected]> Signed-off-by: Andrew Block <[email protected]>
janus-idp · Oct 26, 2022 · 1bcfb8a · 1bcfb8a
1 parent 7e4d629
commit 1bcfb8a
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 41 deletions.
diff --git a/charts/backstage/Chart.yaml b/charts/backstage/Chart.yaml
@@ -1,6 +1,9 @@
 apiVersion: v2
 name: backstage
 description: A helm chart for deploying Backstage
-version: 0.1.2
+version: 0.1.3
 appVersion: "v1.7.0"
+kubeVersion: ">= 1.19.0-0"
 home: https://github.com/redhat-developer/helm-backstage
+annotations:
+  charts.openshift.io/name: backstage
diff --git a/charts/backstage/README.md b/charts/backstage/README.md
@@ -1,11 +1,33 @@
 # backstage
 
-![Version: 0.1.2](https://img.shields.io/badge/Version-0.1.2-informational?style=flat-square) ![AppVersion: v1.7.0](https://img.shields.io/badge/AppVersion-v1.7.0-informational?style=flat-square)
+![Version: 0.1.3](https://img.shields.io/badge/Version-0.1.3-informational?style=flat-square) ![AppVersion: v1.7.0](https://img.shields.io/badge/AppVersion-v1.7.0-informational?style=flat-square)
 
 A helm chart for deploying Backstage
 
 **Homepage:** <https://github.com/redhat-developer/helm-backstage>
 
+## Installation
+
+This chart can be installed to an individual namespace by first adding the chart repository, creating a new namespace (or using an existing namespace) and installing the chart by executing the following commands:
+
+```shell
+helm repo add redhat-developer-backstage https://redhat-developer.github.io/helm-backstage
+helm create namespace backstage
+helm upgrade -i backstage -n backstage redhat-developer-backstage/backstage --set backstage.baseUrl=<BASE_URL>
+```
+
+The preceding command will create a new namespace called `backstage` and install the chart with a release name of `backstage`. At a minimum, the required parameter `backstage.baseUrl` refers to the URL that should be used to access the Backstage user interface.
+
+## Uninstallation
+
+To remove a previously installed chart, execute the following command:
+
+```shell
+helm uninstall <RELEASE>
+```
+
+Replace `<RELEASE>` with the name of the Helm release that was used when installing the chart.
+
 ## Values
 
 | Key | Type | Default | Description |
@@ -25,7 +47,6 @@ A helm chart for deploying Backstage
 | image.repository | string | `"redhat-developer/redhat-backstage-build"` |  |
 | image.version | string | `"latest"` |  |
 | imagePullSecrets | list | `[]` |  |
-| ingress.annotations."route.openshift.io/termination" | string | `"edge"` |  |
 | ingress.className | string | `""` |  |
 | ingress.enabled | bool | `false` |  |
 | ingress.tls.secretName | string | `""` |  |

diff --git a/charts/backstage/templates/_helpers.tpl b/charts/backstage/templates/_helpers.tpl
@@ -100,7 +100,7 @@ Check for existing secret
 {{- if .Values.postgres.database_password }}
 databasePassword: {{ .Values.postgres.database_password | quote }}
 {{- else -}}
-{{- $secret := lookup "v1" "Secret" .Release.Namespace  (include "backstage.fullname" . ) -}}
+{{- $secret := lookup "v1" "Secret" .Release.Namespace  (include "backstage.postgresql.name" . ) -}}
 {{- if $secret -}}
 {{/*
    Reusing existing secret data

diff --git a/charts/backstage/values.schema.json b/charts/backstage/values.schema.json
@@ -156,7 +156,8 @@
             "title": "The route Schema",
             "required": [
                 "enabled",
-                "termination"
+                "termination",
+                "annotations"
             ],
             "properties": {
                 "enabled": {
@@ -167,6 +168,14 @@
                         true
                     ]
                 },
+                "termination": {
+                    "type": "string",
+                    "default": "",
+                    "title": "The termination Schema",
+                    "examples": [
+                        "edge"
+                    ]
+                },
                 "annotations": {
                     "type": "object",
                     "default": {},
@@ -176,21 +185,13 @@
                     "examples": [
                         {}
                     ]
-                },
-                "termination": {
-                    "type": "string",
-                    "default": "",
-                    "title": "The termination Schema",
-                    "examples": [
-                        "edge"
-                    ]
                 }
             },
             "examples": [
                 {
                     "enabled": true,
-                    "annotations": {},
-                    "termination": "edge"
+                    "termination": "edge",
+                    "annotations": {}
                 }
             ]
         },
@@ -225,23 +226,10 @@
                     "type": "object",
                     "default": {},
                     "title": "The annotations Schema",
-                    "required": [
-                        "route.openshift.io/termination"
-                    ],
-                    "properties": {
-                        "route.openshift.io/termination": {
-                            "type": "string",
-                            "default": "",
-                            "title": "The route.openshift.io/termination Schema",
-                            "examples": [
-                                "edge"
-                            ]
-                        }
-                    },
+                    "required": [],
+                    "properties": {},
                     "examples": [
-                        {
-                            "route.openshift.io/termination": "edge"
-                        }
+                        {}
                     ]
                 },
                 "tls": {
@@ -272,9 +260,7 @@
                 {
                     "enabled": false,
                     "className": "",
-                    "annotations": {
-                        "route.openshift.io/termination": "edge"
-                    },
+                    "annotations": {},
                     "tls": {
                         "secretName": ""
                     }
@@ -928,15 +914,13 @@
             },
             "route": {
                 "enabled": true,
-                "annotations": {},
-                "termination": "edge"
+                "termination": "edge",
+                "annotations": {}
             },
             "ingress": {
                 "enabled": false,
                 "className": "",
-                "annotations": {
-                    "route.openshift.io/termination": "edge"
-                },
+                "annotations": {},
                 "tls": {
                     "secretName": ""
                 }

diff --git a/charts/backstage/values.yaml b/charts/backstage/values.yaml
@@ -31,8 +31,7 @@ ingress:
   className: ""
 
   ## @param ingress.annotations Additional annotations for the Ingress resource
-  annotations:
-    route.openshift.io/termination: "edge"
+  annotations: {}
 
   tls:
     secretName: ""