aboutsummaryrefslogtreecommitdiffstats
path: root/kubernetes/namespaces/default/black-knight/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'kubernetes/namespaces/default/black-knight/README.md')
-rw-r--r--kubernetes/namespaces/default/black-knight/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/kubernetes/namespaces/default/black-knight/README.md b/kubernetes/namespaces/default/black-knight/README.md
new file mode 100644
index 0000000..d1f8d89
--- /dev/null
+++ b/kubernetes/namespaces/default/black-knight/README.md
@@ -0,0 +1,16 @@
+## Black Knight
+Deployment file for @Black-Knight, our courageous and ever present anti-raid bot.
+
+## Secrets
+This deployment expects a number of secrets/environment variables to exist in a secret called `black-knight-env`.
+
+| Environment | Description |
+|-----------------------|-------------------------------------------------------------------|
+| BOT_TOKEN | The Discord bot token for Black Knight to connect to Discord with |
+| DATABASE_URL | A full PostgreSQL connection string to the postgres db |
+| BOT_SENTRY_DSN | The DSN to connect send sentry reports to |
+
+Black knight also requires a redis password, which is pulled from the `redis-credentials` secret.
+```
+REDIS_PASSWORD - The password to redis
+```