aboutsummaryrefslogtreecommitdiffstats
path: root/kubernetes/namespaces/databases/redis/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'kubernetes/namespaces/databases/redis/README.md')
-rw-r--r--kubernetes/namespaces/databases/redis/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/kubernetes/namespaces/databases/redis/README.md b/kubernetes/namespaces/databases/redis/README.md
new file mode 100644
index 0000000..3f50ebd
--- /dev/null
+++ b/kubernetes/namespaces/databases/redis/README.md
@@ -0,0 +1,25 @@
+# Python Discord Redis
+This folder contains the configuration for Python Discord's Redis instance.
+
+## 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.databases.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 |