Add examples for using external redis (#53)

Added examples to show how to use external redis instances ## Test plan N/A, it's the helm-way of configuring external redis instances - https://docs.sourcegraph.com/admin/install/kubernetes/configure#configure-custom-redis - https://docs.sourcegraph.com/admin/external_services/redis#using-your-own-redis-server fix https://github.com/sourcegraph/sourcegraph/issues/31874
sourcegraph · Mar 2, 2022 · 8389421 · 8389421
1 parent fac583b
commit 8389421
Show file tree

Hide file tree

Showing 3 changed files with 224 additions and 0 deletions.
diff --git a/charts/sourcegraph/examples/external-redis/README.md b/charts/sourcegraph/examples/external-redis/README.md
@@ -0,0 +1,82 @@
+# Using external Redis instances
+
+Sourcegraph deployment by default ships two separate Redis instances for different purposes
+
+- [redis-cache.Deployment.yaml](../../templates/redis/redis-cache.Deployment.yaml)
+- [redis-store.Deployment.yaml](../../templates/redis/redis-store.Deployment.yaml)
+
+When using external Redis instances, you’ll need to specify the corresponding environment variable for each of the following deployments:
+
+> __IMPORTANT__: This list may not be up-to-date. You should always consult the [offical docs](https://docs.sourcegraph.com/admin/install/kubernetes/configure#configure-custom-redis) for the latest list of dependent services.
+
+- [sourcegraph-frontend.Deployment.yaml](../../templates/frontend/sourcegraph-frontend.Deployment.yaml)
+- [repo-updater.Deployment.yaml](../../templates/repo-updater/repo-updater.Deployment.yaml)
+- [gitserver.Deployment.yaml](../../templates/gitserver/gitserver.Deployment.yaml)
+- [searcher.Deployment.yaml](../../templates/searcher/searcher.Deployment.yaml)
+- [symbols.Deployment.yaml](../../templates/symbols/symbols.Deployment.yaml)
+- [worker.Deployment.yaml](../../templates/worker/worker.Deployment.yaml)
+## Option 1 - One shared external Redis instance
+
+Example values override [override-shared.yaml](./override-shared.yaml)
+
+### `REDIS_ENDPOINT`
+
+The string must either have the format `$HOST:PORT` or follow the [IANA specification for Redis URLs](https://www.iana.org/assignments/uri-schemes/prov/redis) (e.g., redis://:mypassword@host:6379/2)
+
+## Option 2 - Two separate external Redis instances
+
+Example values override [override-separate.yaml](./override-separate.yaml)
+
+### `REDIS_CACHE_ENDPOINT`
+
+The string must either have the format `$HOST:PORT` or follow the [IANA specification for Redis URLs](https://www.iana.org/assignments/uri-schemes/prov/redis) (e.g., redis://:mypassword@host:6379/2)
+
+### `REDIS_STORE_ENDPOINT`
+
+The string must either have the format `$HOST:PORT` or follow the [IANA specification for Redis URLs](https://www.iana.org/assignments/uri-schemes/prov/redis) (e.g., redis://:mypassword@host:6379/2)
+
+## Notes
+
+You may store these sensitive environment variables in a [Secret](https://kubernetes.io/docs/concepts/configuration/secret/).
+
+```yaml
+apiVersion: v1
+kind: Secret
+metadata:
+  name: sourcegraph-external-redis-credentials
+data:
+  # notes: secrets data has to be base64-encoded
+  REDIS_ENDPOINT: ""
+```
+
+```yaml
+apiVersion: v1
+kind: Secret
+metadata:
+  name: sourcegraph-external-redis-credentials
+data:
+  # notes: secrets data has to be base64-encoded
+  REDIS_CACHE_ENDPOINT: ""
+  REDIS_STORE_ENDPOINT: ""
+```
+
+Optionally, if your external Redis instances do not required authentication, you may use a [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/). Learn more about [how to reference ConfigMap](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#define-container-environment-variables-using-configmap-data).
+
+```yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: sourcegraph-external-redis-credentials
+data:
+  REDIS_ENDPOINT: "redis://redis.example.com:6379/2"
+```
+
+```yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: sourcegraph-external-redis-credentials
+data:
+  REDIS_CACHE_ENDPOINT: "redis://redis-cache.example.com:6379/2"
+  REDIS_STORE_ENDPOINT: "redis://redis-store.example.com:6379/2"
+```
diff --git a/charts/sourcegraph/examples/external-redis/override-separate.yaml b/charts/sourcegraph/examples/external-redis/override-separate.yaml
@@ -0,0 +1,86 @@
+# Demonstrate using external redis instance(s)
+# Disables deployment of the internal `redis-cache` and `redis-store` deployment
+
+frontend:
+  env:
+    REDIS_CACHE_ENDPOINT:
+      valueFrom:
+        secretKeyRef: # Pre-existing secret, not created by this chart
+          name: sourcegraph-external-redis-credentials
+          key: REDIS_CACHE_ENDPOINT
+    REDIS_STORE_ENDPOINT:
+      valueFrom:
+        secretKeyRef: # Pre-existing secret, not created by this chart
+          name: sourcegraph-external-redis-credentials
+          key: REDIS_STORE_ENDPOINT
+
+repoUpdater:
+  env:
+    REDIS_CACHE_ENDPOINT:
+      valueFrom:
+        secretKeyRef: # Pre-existing secret, not created by this chart
+          name: sourcegraph-external-redis-credentials
+          key: REDIS_CACHE_ENDPOINT
+    REDIS_STORE_ENDPOINT:
+      valueFrom:
+        secretKeyRef: # Pre-existing secret, not created by this chart
+          name: sourcegraph-external-redis-credentials
+          key: REDIS_STORE_ENDPOINT
+
+gitserver:
+  env:
+    REDIS_CACHE_ENDPOINT:
+      valueFrom:
+        secretKeyRef: # Pre-existing secret, not created by this chart
+          name: sourcegraph-external-redis-credentials
+          key: REDIS_CACHE_ENDPOINT
+    REDIS_STORE_ENDPOINT:
+      valueFrom:
+        secretKeyRef: # Pre-existing secret, not created by this chart
+          name: sourcegraph-external-redis-credentials
+          key: REDIS_STORE_ENDPOINT
+
+searcher:
+  env:
+    REDIS_CACHE_ENDPOINT:
+      valueFrom:
+        secretKeyRef: # Pre-existing secret, not created by this chart
+          name: sourcegraph-external-redis-credentials
+          key: REDIS_CACHE_ENDPOINT
+    REDIS_STORE_ENDPOINT:
+      valueFrom:
+        secretKeyRef: # Pre-existing secret, not created by this chart
+          name: sourcegraph-external-redis-credentials
+          key: REDIS_STORE_ENDPOINT
+
+symbols:
+  env:
+    REDIS_CACHE_ENDPOINT:
+      valueFrom:
+        secretKeyRef: # Pre-existing secret, not created by this chart
+          name: sourcegraph-external-redis-credentials
+          key: REDIS_CACHE_ENDPOINT
+    REDIS_STORE_ENDPOINT:
+      valueFrom:
+        secretKeyRef: # Pre-existing secret, not created by this chart
+          name: sourcegraph-external-redis-credentials
+          key: REDIS_STORE_ENDPOINT
+
+worker:
+  env:
+    REDIS_CACHE_ENDPOINT:
+      valueFrom:
+        secretKeyRef: # Pre-existing secret, not created by this chart
+          name: sourcegraph-external-redis-credentials
+          key: REDIS_CACHE_ENDPOINT
+    REDIS_STORE_ENDPOINT:
+      valueFrom:
+        secretKeyRef: # Pre-existing secret, not created by this chart
+          name: sourcegraph-external-redis-credentials
+          key: REDIS_STORE_ENDPOINT
+
+redisCache:
+  enabled: false
+
+redisStore:
+  enabled: false
diff --git a/charts/sourcegraph/examples/external-redis/override-shared.yaml b/charts/sourcegraph/examples/external-redis/override-shared.yaml
@@ -0,0 +1,56 @@
+# Demonstrate using external redis instance(s)
+# Disables deployment of the internal `redis-cache` and `redis-store` deployment
+
+frontend:
+  env:
+    REDIS_ENDPOINT:
+      valueFrom:
+        secretKeyRef: # Pre-existing secret, not created by this chart
+          name: sourcegraph-external-redis-credentials
+          key: REDIS_ENDPOINT
+
+repoUpdater:
+  env:
+    REDIS_ENDPOINT:
+      valueFrom:
+        secretKeyRef: # Pre-existing secret, not created by this chart
+          name: sourcegraph-external-redis-credentials
+          key: REDIS_ENDPOINT
+
+gitserver:
+  env:
+    REDIS_ENDPOINT:
+      valueFrom:
+        secretKeyRef: # Pre-existing secret, not created by this chart
+          name: sourcegraph-external-redis-credentials
+          key: REDIS_ENDPOINT
+
+searcher:
+  env:
+    REDIS_ENDPOINT:
+      valueFrom:
+        secretKeyRef: # Pre-existing secret, not created by this chart
+          name: sourcegraph-external-redis-credentials
+          key: REDIS_ENDPOINT
+
+symbols:
+  env:
+    REDIS_ENDPOINT:
+      valueFrom:
+        secretKeyRef: # Pre-existing secret, not created by this chart
+          name: sourcegraph-external-redis-credentials
+          key: REDIS_ENDPOINT
+
+worker:
+  env:
+    REDIS_ENDPOINT:
+      valueFrom:
+        secretKeyRef: # Pre-existing secret, not created by this chart
+          name: sourcegraph-external-redis-credentials
+          key: REDIS_ENDPOINT
+
+redisCache:
+  enabled: false
+
+redisStore:
+  enabled: false