Merge pull request #159 from tumido/document-vanilla

docs: add vanilla Kubernetes docs
janus-idp · Dec 5, 2023 · ab7ec4d · ab7ec4d
2 parents b3bedfb + 643235d
commit ab7ec4d
Show file tree

Hide file tree

Showing 3 changed files with 59 additions and 2 deletions.
diff --git a/charts/backstage/Chart.yaml b/charts/backstage/Chart.yaml
@@ -41,4 +41,4 @@ sources:
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 2.11.3
+version: 2.11.4
diff --git a/charts/backstage/README.md b/charts/backstage/README.md
@@ -2,7 +2,7 @@
 # Janus-IDP Backstage Helm Chart
 
 [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/janus-idp&style=flat-square)](https://artifacthub.io/packages/search?repo=janus-idp)
-![Version: 2.11.3](https://img.shields.io/badge/Version-2.11.3-informational?style=flat-square)
+![Version: 2.11.4](https://img.shields.io/badge/Version-2.11.4-informational?style=flat-square)
 ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
 
 A Helm chart for deploying a Backstage application
@@ -230,3 +230,31 @@ upstream:
         cors:
           origin: 'https://{{- include "janus-idp.hostname" . }}'
 ```
+
+### Vanilla Kubernetes compatibility mode
+
+In order to deploy this chart on vanilla Kubernetes or any other non-OCP platform, please make sure to apply following changes. Further customization may be required, depending on your exact Kubernetes setup:
+
+```yaml
+# values.yaml
+global:
+  host: # Specify your own Ingress host
+route:
+  enabled: false  # OpenShift Routes do not exist on vanilla Kubernetes
+upstream:
+  ingress:
+    enabled: true  # Use Kubernetes Ingress instead of OpenShift Route
+  backstage:
+    podSecurityContext:  # Vanilla Kubernetes doesn't feature OpenShift default SCCs with dynamic UIDs, adjust accordingly to the deployed image
+      runAsUser: 1001
+      runAsGroup: 1001
+      fsGroup: 1001
+  postgresql:
+    primary:
+      podSecurityContext:
+        enabled: true
+        fsGroup: 26
+        runAsUser: 26
+    volumePermissions:
+      enabled: true
+```
diff --git a/charts/backstage/README.md.gotmpl b/charts/backstage/README.md.gotmpl
@@ -186,3 +186,32 @@ upstream:
         cors:
           origin: 'https://{{"{{"}}- include "janus-idp.hostname" . {{"}}"}}'
 ```
+
+
+### Vanilla Kubernetes compatibility mode
+
+In order to deploy this chart on vanilla Kubernetes or any other non-OCP platform, please make sure to apply following changes. Further customization may be required, depending on your exact Kubernetes setup:
+
+```yaml
+# values.yaml
+global:
+  host: # Specify your own Ingress host
+route:
+  enabled: false  # OpenShift Routes do not exist on vanilla Kubernetes
+upstream:
+  ingress:
+    enabled: true  # Use Kubernetes Ingress instead of OpenShift Route
+  backstage:
+    podSecurityContext:  # Vanilla Kubernetes doesn't feature OpenShift default SCCs with dynamic UIDs, adjust accordingly to the deployed image
+      runAsUser: 1001
+      runAsGroup: 1001
+      fsGroup: 1001
+  postgresql:
+    primary:
+      podSecurityContext:
+        enabled: true
+        fsGroup: 26
+        runAsUser: 26
+    volumePermissions:
+      enabled: true
+```