From f174e85bce895983c2f23f322bead8bac80138a7 Mon Sep 17 00:00:00 2001
From: MarcoIeni <11428655+MarcoIeni@users.noreply.github.com>
Date: Tue, 24 Sep 2024 15:34:44 +0200
Subject: [PATCH] docs: document the `rds-databases` module

---
 terraform/rds-databases/README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 terraform/rds-databases/README.md

diff --git a/terraform/rds-databases/README.md b/terraform/rds-databases/README.md
new file mode 100644
index 000000000..44fde5dbe
--- /dev/null
+++ b/terraform/rds-databases/README.md
@@ -0,0 +1,21 @@
+# RDS databases
+
+This module creates a `shared` RDS instance that contains three databases:
+
+- `discord-mods-bot`
+- `triagebot`
+- `rustc_perf`
+
+You can access the DB instance using [bastion].
+
+To run `terraform` commands, use the following command
+to port-forward the bastion host:
+
+```sh
+ssh -L localhost:57467:shared.<id>.us-west-1.rds.amazonaws.com:5432 bastion.infra.rust-lang.org
+```
+
+You can find the full endpoint (including `<id>`) in the
+AWS console.
+
+[bastion]: https://github.com/rust-lang/infra-team/tree/master/service-catalog/bastion