Add instructions to change the redis password

Author: LEDfan

docs/deployment/README.md

@@ -25,6 +25,12 @@ and dependencies of the operator.
   Redis is run in a high-available way. It is also possible to use a Redis
   server provided by cloud providers.
 
+  **Note:** when deploying to production, it is important to change the password
+  used to secure Redis. Each example (see below) already changes the
+  password `mySecurePassword12`. For an example see
+  the [`overlays/1-namespaced/patches/redis.secret.yaml`](overlays/1-namespaced/patches/redis.secret.yaml)
+  file.
+
 ## Tutorial using minikube
 
 This section provides a step-by-step tutorial on the basic deployment of the

docs/deployment/bases/redis-sentinel/kustomization.yml

@@ -1,10 +1,9 @@
-
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
 
 resources:
   - resources/redis-sentinel.yaml
   - resources/redis.pdb.yaml
 
-patchesStrategicMerge:
-  - patches/redis-node.statefulset.yaml
+patches:
+  - path: patches/redis-node.statefulset.yaml

docs/deployment/overlays/1-namespaced/kustomization.yaml

@@ -8,3 +8,6 @@ resources:
   - github.com/openanalytics/shinyproxy-operator/docs/deployment/bases/shinyproxy?ref=v2.0.0
   - resources/shinyproxy.namespace.yaml
   - resources/shinyproxy.shinyproxy.yaml
+
+patches:
+  - path: patches/redis.secret.yaml

docs/deployment/overlays/1-namespaced/patches/redis.secret.yaml

@@ -0,0 +1,8 @@
+apiVersion: v1
+kind: Secret
+metadata:
+  name: redis
+type: Opaque
+data:
+  # IMPORTANT: replace this password!
+  redis-password: bXlTZWN1cmVQYXNzd29yZDEy

docs/deployment/overlays/2-clustered/redis/kustomization.yaml

@@ -6,5 +6,5 @@ resources:
   - github.com/openanalytics/shinyproxy-operator/docs/deployment/bases/redis-sentinel?ref=v2.0.0
   - resources/redis.namespace.yaml
 
-patchesStrategicMerge:
-  - resources/redis.secret.yaml
+patches:
+  - path: resources/redis.secret.yaml

docs/deployment/overlays/2-clustered/redis/resources/redis.secret.yaml

@@ -5,4 +5,4 @@ metadata:
 type: Opaque
 data:
   # IMPORTANT: replace this password!
-  redis-password: bXlTZWN1cmVQYXNzd29yZA==
+  redis-password: bXlTZWN1cmVQYXNzd29yZDEy

docs/deployment/overlays/2-clustered/shinyproxy-dept2/resources/redis.secret.yaml

@@ -5,4 +5,4 @@ metadata:
 type: Opaque
 data:
   # IMPORTANT: replace this password!
-  redis-password: bXlTZWN1cmVQYXNzd29yZA==
+  redis-password: bXlTZWN1cmVQYXNzd29yZDEy

docs/deployment/overlays/2-clustered/shinyproxy/resources/redis.secret.yaml

@@ -5,4 +5,4 @@ metadata:
 type: Opaque
 data:
   # IMPORTANT: replace this password!
-  redis-password: bXlTZWN1cmVQYXNzd29yZA==
+  redis-password: bXlTZWN1cmVQYXNzd29yZDEy

docs/deployment/overlays/3-namespaced-app-ns/shinyproxy/kustomization.yaml

@@ -8,3 +8,6 @@ resources:
   - github.com/openanalytics/shinyproxy-operator/docs/deployment/bases/shinyproxy?ref=v2.0.0
   - resources/shinyproxy.namespace.yaml
   - resources/shinyproxy.shinyproxy.yaml
+
+patches:
+  - path: patches/redis.secret.yaml

docs/deployment/overlays/3-namespaced-app-ns/shinyproxy/patches/redis.secret.yaml

@@ -0,0 +1,8 @@
+apiVersion: v1
+kind: Secret
+metadata:
+  name: redis
+type: Opaque
+data:
+  # IMPORTANT: replace this password!
+  redis-password: bXlTZWN1cmVQYXNzd29yZDEy