readme

Signed-off-by: André Bauer <[email protected]>
kokuwaio · Jun 27, 2024 · 0a95e5d · 0a95e5d
1 parent afbdff8
commit 0a95e5d
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 10 deletions.
diff --git a/charts/visual-regression-tracker/README.md b/charts/visual-regression-tracker/README.md
@@ -49,6 +49,16 @@ helm upgrade vrt kokuwa/visual-regression-tracker
 
 _See [`helm upgrade`](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._
 
+### From 3.0.x to 4.0.0
+
+This version adds a proxy in fornt of the api server which protects it via basic auth. The configuration can be done via `authProxy.basicAuth.username`, `authProxy.basicAuth.password`. The password can also be populated by predefined secret via `secrets.authProxy`.
+
+The `secrets.apiUrl` secrets has been removed.
+
+The `reactAppApiUrl` variables has been split up into `reactAppApi.protocol`, `reactAppApi.url` & `reactAppApi.port`.
+
+The `vrtComponents.api.ingress` config has been moved to `authProxy.ingress`.
+
 ### From 2.0.x to 3.0.0
 
 This updates Visual Regression Tracker to 5.0.3. Please follow the [official migration steps](https://github.com/Visual-Regression-Tracker/Visual-Regression-Tracker/releases/tag/5.0.0):

diff --git a/charts/visual-regression-tracker/values.yaml b/charts/visual-regression-tracker/values.yaml
@@ -5,7 +5,7 @@ imagePullSecrets: []
 
 authProxy:
   replicaCount: 1
-  
+
   basicAuth:
     username: api-user
     password: "ChangeTheApiPassword!"
@@ -15,7 +15,8 @@ authProxy:
       repository: httpd
       pullPolicy: IfNotPresent
       tag: "2.4.59"
-    resources: {}
+    resources:
+      {}
       # We usually recommend not to specify default resources and to leave this as a conscious
       # choice for the user. This also increases chances charts run on environments with little
       # resources, such as Minikube. If you do want to specify resources, uncomment the following
@@ -41,7 +42,8 @@ authProxy:
   ingress:
     enabled: false
     className: ""
-    annotations: {}
+    annotations:
+      {}
       # kubernetes.io/ingress.class: nginx
       # kubernetes.io/tls-acme: "true"
     hosts:
@@ -58,7 +60,8 @@ authProxy:
 
   podLabels: {}
 
-  resources: {}
+  resources:
+    {}
     # We usually recommend not to specify default resources and to leave this as a conscious
     # choice for the user. This also increases chances charts run on environments with little
     # resources, such as Minikube. If you do want to specify resources, uncomment the following
@@ -124,7 +127,8 @@ vrtComponents:
       pullPolicy: IfNotPresent
       tag: "5.0.5"
 
-    resources: {}
+    resources:
+      {}
       # We usually recommend not to specify default resources and to leave this as a conscious
       # choice for the user. This also increases chances charts run on environments with little
       # resources, such as Minikube. If you do want to specify resources, uncomment the following
@@ -155,7 +159,8 @@ vrtComponents:
 
     imagePullSecrets: []
 
-    resources: {}
+    resources:
+      {}
       # We usually recommend not to specify default resources and to leave this as a conscious
       # choice for the user. This also increases chances charts run on environments with little
       # resources, such as Minikube. If you do want to specify resources, uncomment the following
@@ -183,7 +188,8 @@ vrtComponents:
     ingress:
       enabled: false
       className: ""
-      annotations: {}
+      annotations:
+        {}
         # kubernetes.io/ingress.class: nginx
         # kubernetes.io/tls-acme: "true"
       hosts:
@@ -196,7 +202,8 @@ vrtComponents:
       #    hosts:
       #      - chart-example.local
 
-    resources: {}
+    resources:
+      {}
       # We usually recommend not to specify default resources and to leave this as a conscious
       # choice for the user. This also increases chances charts run on environments with little
       # resources, such as Minikube. If you do want to specify resources, uncomment the following
@@ -271,7 +278,8 @@ podAnnotations: {}
 
 podLabels: {}
 
-podDisruptionBudget: {}
+podDisruptionBudget:
+  {}
   # maxUnavailable: 1
 
 podSecurityContext:
@@ -301,7 +309,8 @@ postgresql:
     username: vrt
     password: vrt-db-password
   fullnameOverride: vrt-postgresql
-  resources: {}
+  resources:
+    {}
     # limits:
     #   cpu: 50m
     #   memory: 64Mi