aboutsummaryrefslogtreecommitdiffstats
path: root/kubernetes/namespaces/default/bot/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'kubernetes/namespaces/default/bot/README.md')
-rw-r--r--kubernetes/namespaces/default/bot/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/kubernetes/namespaces/default/bot/README.md b/kubernetes/namespaces/default/bot/README.md
new file mode 100644
index 0000000..6a992b5
--- /dev/null
+++ b/kubernetes/namespaces/default/bot/README.md
@@ -0,0 +1,18 @@
+## Bot
+
+Deployment file for @Python, our valiant community bot and workhorse.
+
+## Secrets
+This deployment expects a number of secrets and environment variables to exist in a secret called `bot-env`.
+
+| Environment | Description |
+|-------------------|-------------------------------------------------------------|
+| API_KEYS_GITHUB | An API key for Github's API. |
+| API_KEYS_SITE_API | The token to access our site's API. |
+| BOT_SENTRY_DSN | The sentry DSN to send sentry events to. |
+| BOT_TOKEN | The Discord bot token to run the bot on. |
+| BOT_TRACE_LOGGERS | Comma separated list of loggers to enable trace logging for |
+| DEBUG | Debug mode true/false |
+| METABASE_PASSWORD | Password for Metabase |
+| METABASE_USERNAME | Username for Metabase |
+| URLS_PASTE_URL | The URL to the paste site |