aboutsummaryrefslogtreecommitdiffstats
path: root/kubernetes/namespaces/default/redis/README.md
diff options
context:
space:
mode:
authorGravatar Chris Lovering <[email protected]>2023-08-13 20:01:42 +0100
committerGravatar Chris Lovering <[email protected]>2023-08-14 11:44:03 +0100
commit661f49409e69f5cfafbef4cd41411a72ebc5418d (patch)
tree9ddd7f2a2ab09cadc5b716be00628e19d839ad4d /kubernetes/namespaces/default/redis/README.md
parentAllow multiple documents within yaml files (diff)
Copy all files from kubernetes repo into this one
This commit is a like-for-like copy of the [kubernetes repo](https://github.com/python-discord/kubernetes) check that repo for comit history prioir to this commit. Co-authored-by: Amrou Bellalouna <[email protected]> Co-authored-by: Bradley Reynolds <[email protected]> Co-authored-by: Chris <[email protected]> Co-authored-by: Chris Lovering <[email protected]> Co-authored-by: ChrisJL <[email protected]> Co-authored-by: Den4200 <[email protected]> Co-authored-by: GDWR <[email protected]> Co-authored-by: Hassan Abouelela <[email protected]> Co-authored-by: Hassan Abouelela <[email protected]> Co-authored-by: jchristgit <[email protected]> Co-authored-by: Joe Banks <[email protected]> Co-authored-by: Joe Banks <[email protected]> Co-authored-by: Joe Banks <[email protected]> Co-authored-by: Johannes Christ <[email protected]> Co-authored-by: Kieran Siek <[email protected]> Co-authored-by: kosayoda <[email protected]> Co-authored-by: ks129 <[email protected]> Co-authored-by: Leon Sand├©y <[email protected]> Co-authored-by: Leon Sand├©y <[email protected]> Co-authored-by: MarkKoz <[email protected]> Co-authored-by: Matteo Bertucci <[email protected]> Co-authored-by: Sebastiaan Zeeff <[email protected]> Co-authored-by: Sebastiaan Zeeff <[email protected]> Co-authored-by: vcokltfre <[email protected]>
Diffstat (limited to 'kubernetes/namespaces/default/redis/README.md')
-rw-r--r--kubernetes/namespaces/default/redis/README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/kubernetes/namespaces/default/redis/README.md b/kubernetes/namespaces/default/redis/README.md
new file mode 100644
index 0000000..d496758
--- /dev/null
+++ b/kubernetes/namespaces/default/redis/README.md
@@ -0,0 +1,34 @@
+# Python Discord Redis
+This folder contains the configuration for Python Discord's Redis instance.
+
+## ConfigMap
+**We'll need to create a ConfigMap for this service, which will hold the `redis.conf` configuration.**
+
+Do the following:
+1. Make a copy of `redis.conf.template` called `redis.conf`
+2. Edit your `redis.conf` to replace `<INSERT PASSWORD>` with the password you'd like your redis instance to use.
+3. Use `kubectl create configmap redis-conf --from-file=redis.conf` to create the ConfigMap
+4. Delete the `redis.conf`. **We don't wanna commit that password anywhere!**
+
+## Volume
+A 10Gi volume is provisioned on the Linode Block Storage (Retain) storage class.
+
+## Deployment
+The deployment will pull the `redis:latest` image from DockerHub.
+
+It will mount the created volume at `/data`.
+
+It will expose port `6379` to connect to Redis.
+
+## Service
+A service called `redis` will be created to give the deployment a cluster local DNS record of `redis.default.svc.cluster.local`.
+
+## Secrets
+
+Redis requires a `redis-credentials` secret with the following entries:
+
+| Environment | Description |
+|----------------|---------------------------------------|
+| REDIS_HOST | The host redis is running on |
+| REDIS_PASSWORD | The password to connect to redis with |
+| REDIS_PORT | The port redis is listening on |