# Clouds Against Humanity
A small, cheap, locked-down DigitalOcean environment built with OpenTofu, applied by Spacelift, fed secrets by Doppler, and reachable only through Twingate. **No droplet has a single public inbound port open.** There is no VPN, no bastion host and no SSH on the internet.
It is a cloud extension of a homelab, and it exists to teach: this repository is the reference environment, and the lessons that use it live in the wiki.
> ### Start with the wiki
>
> **The wiki is the real point of this project.** Every lesson, flowchart, exercise and decision (including the ones that were wrong the first time) is written there; this repository is the environment those lessons use.
>
> - **[Wiki home](https://github.com/ChiefGyk3D/Clouds-Against-Humanity/wiki)**: the map of everything.
> - **[Start here if you are new](https://github.com/ChiefGyk3D/Clouds-Against-Humanity/wiki/Start-Here-If-You-Are-New)**: cloud, Terraform and zero trust from zero.
> - **[Why this exists](https://github.com/ChiefGyk3D/Clouds-Against-Humanity/wiki/Why-This-Exists)**: where this comes from and who it is for.
> - **[Reading order](https://github.com/ChiefGyk3D/Clouds-Against-Humanity/wiki/Reading-Order)**: the paths, with time estimates.
> - **[Contents](https://github.com/ChiefGyk3D/Clouds-Against-Humanity/wiki/Contents)**: every page once, grouped by theme, with what each is for.
> - **[Git from zero](https://github.com/ChiefGyk3D/Clouds-Against-Humanity/wiki/Git-From-Zero)**: if you have never used git.
> - **[Repository growth](https://github.com/ChiefGyk3D/Clouds-Against-Humanity/wiki/Repository-Growth)**: stars, forks and weekly work, drawn from GitHub data; the as-of date is printed in the picture, and stars measure attention, not use.
>
> **Who this assumes:** a basic power user. You know how a computer works, may have built or repaired one, and have set up a router and done basic networking. If you could work a help desk or a retail repair counter, you can start; if not, [IT 101 level material such as CompTIA A+ objectives](https://github.com/ChiefGyk3D/Clouds-Against-Humanity/wiki/Start-Here-If-You-Are-New#where-zero-is) is the benchmark (not an endorsement).
>
> **Cost:** the reading and the exercises are free and always will be, and nothing here is sold. Hands-on work uses your own accounts and your provider's bill, nothing you spend goes to the maintainer, and you choose what you can afford to run. The cost gates are explained in [docs/cost.md](docs/cost.md). If you open a DigitalOcean account, my [referral link](https://m.do.co/c/e3aaa65aed6b) is optional and nothing is gated behind it; the wiki says exactly what it is. The same pages are in [`docs/wiki/`](docs/wiki/Home.md) if you prefer reading them in the repo.
> ### Found a mistake or have a question? Open an issue
>
> Something wrong, a command that failed, a confusing explanation, or a topic you wish was here? Please say so. Feedback is free, and it is how the lessons get better. **[Give feedback and open an issue](https://github.com/ChiefGyk3D/Clouds-Against-Humanity/wiki/Give-Feedback-and-Open-an-Issue)** walks through it for a first-timer. Never paste tokens, keys, account names, real IP addresses or hostnames, or anything that identifies you. Security problems go through [SECURITY.md](SECURITY.md), not a public issue. See also [CONTRIBUTING.md](CONTRIBUTING.md).
Recommending other springboards is encouraged throughout this project. The point is to get you thinking in different ways and outside the box, not to hand you one path to copy, so expect pages to point at things to try beyond what they cover.
## How it fits together

Diagram source (Mermaid)
```mermaid
flowchart LR
you["You Twingate client"]:::you
tg["Twingate controller + relays"]:::ctrl
subgraph vpc["DigitalOcean VPC (tor1)"]
ca["connector a"]:::cloud
cb["connector b"]:::cloud
end
net["Public internet"]:::ext
subgraph cp["Control plane"]
gh["GitHub PR + CI"]:::ctrl
sl["Spacelift plan, human confirms, apply"]:::ctrl
dp["Doppler every secret"]:::secret
end
you -- "per-resource access" --> tg
ca -- "outbound only" --> tg
cb -- "outbound only" --> tg
you == "end-to-end encrypted" ==> ca
net -. "no inbound rule exists" .-> vpc
gh --> sl
dp -- "read-only token" --> sl
sl -- "OpenTofu" --> vpc
classDef you fill:#132a1f,stroke:#4ade80,color:#dcfce7
classDef ext fill:#3b1d1d,stroke:#f87171,color:#fde2e2
classDef ctrl fill:#1e1b3a,stroke:#a78bfa,color:#ede9fe
classDef cloud fill:#0f2a3d,stroke:#38bdf8,color:#e0f2fe
classDef secret fill:#3a2a0f,stroke:#fbbf24,color:#fef3c7
```
| Piece | Job | Why this and not the obvious alternative |
|---|---|---|
| **Twingate** (ZTNA) | Gets an authenticated person to one specific host and port | Connectors dial out, so nothing listens on the internet. A VPN would mean a public listener and network-wide access after one login. [More](docs/wiki/Why-ZTNA-Not-a-VPN.md) |
| **DigitalOcean** | Droplets, VPC, cloud firewalls | Predictable pricing and a firewall that attaches by tag, so a droplet is protected from its first boot. [More](docs/wiki/DigitalOcean-Network-and-Firewalls.md) |
| **OpenTofu** | Every resource as code, in layered stacks | Open-source (MPL) Terraform fork; same language, no license surprise. [More](docs/wiki/OpenTofu-Stacks-and-Modules.md) |
| **Spacelift** | Runs plan and apply, holds state, waits for a human | Nothing applies from a laptop or from CI, and pull request plans never see credentials. [More](docs/wiki/Spacelift.md) |
| **Doppler** | Holds every secret | Spacelift holds one read-only token; nothing in this repo is a credential. [More](docs/wiki/Doppler-and-Secrets.md) |
| **GitHub Actions** | Tests, scanners, cost gate | Calls hardened shared workflows, every action pinned by commit. [More](docs/wiki/CI-Tests-and-Cost-Gate.md) |
## Why not just a VPN?
Because a remote-access VPN authenticates you once and then puts your device on the network, and the box doing that authentication has to listen on the internet. Both halves of that have been the starting point of serious breaches: stolen credentials on a legacy single-factor VPN profile (Colonial Pipeline, 2021) and a long run of pre-authentication exploits in VPN appliances from Ivanti, Fortinet, Palo Alto, Citrix and Pulse Secure. ZTNA checks every connection against a per-resource policy and, as built here, leaves nothing listening at all.
That is not "VPNs are always wrong". WireGuard is a very different animal from an SSL VPN appliance, site-to-site tunnels are still fine, and ZTNA means trusting a vendor's control plane. The full argument, sources and the honest tradeoffs are on **[Why ZTNA and not a VPN](docs/wiki/Why-ZTNA-Not-a-VPN.md)**.
## Status
| Stage | What | Monthly | Status |
|---|---|---|---|
| 0 | Foundation: project, VPC, baseline firewall with zero inbound rules | $0 | Built |
| 1 | Access: two Twingate connectors, connector firewall, per-host SSH resources | $12 | Built |
| 2 | Logs to the on-prem SIEM, cloud-to-home access | $0 in the cloud | In progress: the cloud-side code (settings layer, telemetry stack, opt-in node exporter, Wazuh agent and auditd, dashboards) is merged but nothing is applied |
| 3 | Workload host: Portainer, five daemons, Discord-to-Matrix bridge, Spaces bucket, Functions | est. $17 | Planned |
| 4 | Grafana, on-prem | $0 in the cloud | Planned (a cloud Grafana is a learner option, see [Build your own mini SOC](docs/wiki/Build-Your-Own-Mini-SOC.md)) |
| Edge | Public edge (DMZ) and hardening | past the ceiling | Planned, design first |
| AWS | The AWS twin of stages 0 and 1: `modules/aws/*`, `stacks/aws/*` | $0 and $20.84 | Written and tested with mocked providers, never applied. Azure and GCP have no code |
Working ceiling: $30 per month in the current phase (stage 1), shared by every cloud; each phase carries its own ceiling in `docs/stages/approved.json`, so a later phase can raise it on purpose. A cost gate in CI fails any change that raises a cloud's planned total above its approved total, or the active clouds' approved totals above the current phase's ceiling (the AWS twin is marked inactive, because it does not fit beside stage 1). See the [roadmap](docs/wiki/Roadmap.md).
### Growth
Stars measure attention, not use, but the project is young enough that the curve is worth a look. The chart is drawn by a daily workflow from GitHub data (no chart service), and the as-of date is printed in the picture; the [Repository growth](https://github.com/ChiefGyk3D/Clouds-Against-Humanity/wiki/Repository-Growth) page has the numbers as a table.

## Layout
```
Clouds-Against-Humanity/
stacks/00-foundation/ project, tag, VPC, baseline firewall
stacks/10-access/ site, SSH key lookup, two connectors, connector firewall, group, SSH resources
stacks/20-telemetry/ stage 2 telemetry settings layer (see docs/stages/02-telemetry.md)
stacks/aws/{00-foundation,10-access} the AWS twin of stages 0 and 1 (mocked tests only, never applied)
modules/vpc/ per-region VPC
modules/firewall/ tag-based deny-inbound firewall
modules/twingate-bootstrap/ shared connector boot script and tokens, called by every provider's connector
modules/twingate-connector/ connector, its tokens, its droplet and cloud-init
modules/aws/{vpc,firewall,twingate-connector} the AWS versions of those modules
dashboards/ importable Grafana dashboards (sites overview, droplet health, Wazuh agents); see docs/wiki/Grafana-Dashboards.md
scripts/cost_check.py cost gate
scripts/ci_cost_gate.sh the cost gate as CI runs it: compares approved.json with the base branch on pull requests
scripts/cost_raise.py proposes (dry run) or makes a per-phase ceiling change in approved.json
scripts/identifier_check.py fails on cloud account ids in tracked files (never prints them)
scripts/gen_settings_doc.py writes docs/wiki/Settings-Reference.md from docs/settings.json (--check fails when stale)
scripts/gen_project_status.py writes docs/wiki/Project-Status.md from docs/wiki/.status-snapshot.json (--check fails when stale; --refresh fetches live data with the maintainer login)
scripts/gen_repo_metrics.py draws docs/wiki/images/repo-growth.png and writes docs/wiki/Repository-Growth.md from docs/wiki/.metrics-snapshot.json (--check is offline and needs no plotting library; --refresh fetches per-day counts with gh and needs matplotlib (run locally it reads every star time; in CI it runs --no-star-times and records one daily star count in a ledger); --verify-bundle checks what the daily workflow publishes; --repo, --snapshot, --out and --page reuse it for another repository)
scripts/carry_metrics_snapshot.sh the carry half: reads the previous snapshot from the `metrics` branch (size checked before anything is written; fails closed) and prints the tip commit it read
scripts/publish_metrics_branch.sh the publish half of the daily growth chart: re-verifies the bundle against the baseline and the previous snapshot, then fast-forward pushes a child commit of the tip it was told to expect to the `metrics` branch (no force, never main)
scripts/growth-chart-requirements.txt hash-pinned matplotlib and Pillow for the daily growth chart (pip install --require-hashes)
scripts/gen_wiki_nav.py writes docs/wiki/Contents.md and docs/wiki/_Sidebar.md from docs/wiki/_nav.yaml (--check fails when stale or when a page is missing from the manifest)
scripts/gen_example_tests.py writes each live stack's example.tftest.hcl from its terraform.tfvars.example
scripts/gen_timezones.py regenerates modules/twingate-bootstrap/timezones.txt from the local tz database
scripts/hcl_variables.py helper module: a fail-closed reader of `variable` blocks (used by tests and the generators)
scripts/plan_noop_check.py fails unless a saved plan is a no-op over the golden addresses (run by hand, not in CI)
scripts/zero_ports_check.py external zero-open-ports check of the connectors: targets only from the DigitalOcean API, no address argument (run by hand with Doppler, not in CI)
scripts/threat_dragon_layout.py lays out the Threat Dragon models in docs/threat-model (nodes, boundary boxes, flow routes; --check fails when stale)
scripts/spacelift/doppler-env.sh hook that loads Doppler secrets into a run
scripts/render_diagrams.py renders every Mermaid diagram to a dark-mode PNG with its source kept underneath (--check fails when a picture is stale)
scripts/gen-wiki.sh writes the wiki pages and copies docs/wiki/images from docs/wiki (the Wiki workflow publishes them)
scripts/strip_png_metadata.py removes text, EXIF and time chunks from wiki screenshots (--check fails when any remain)
scripts/demo_monitoring.sh runs the synthetic multi-site monitoring demo in labs/demo-monitoring (up, down, silent-site, test, screenshots)
tests/ pytest for the cost gate, settings, module policy, secret separation, the hook, the wiki and more
.spacelift/config.yml which secrets each stack loads
.github/workflows/ci.yml GYST callers only (tofu, python, security) + CI green
.github/workflows/wiki.yml publishes docs/wiki through GYST's wiki-publish.yml
.github/ISSUE_TEMPLATE/ issue forms (lesson feedback, command failed, question, topic request) and config.yml
SECURITY.md, CONTRIBUTING.md private security reporting; how to give feedback and contribute
.spacelift/policies/ Spacelift push and plan policies and their OPA tests
labs/demo-monitoring/ synthetic Prometheus + Grafana demo: two sites, dashboards, alert rules and their promtool tests (no real hosts)
docs/wiki/ the wiki pages (source of truth)
docs/stages/ operator guides: decisions, verify, rollback, per stage (00-foundation, 01-access, 02-telemetry, aws-access)
docs/cost.md cost gate explained
docs/cost-prices.json, docs/cost-prices/ price tables (DigitalOcean, and one file per other cloud)
docs/diagrams.json, docs/diagrams-theme.json source hash of each diagram picture, and the dark theme it is rendered with
docs/settings.json the settings manifest the Settings reference is generated from
docs/threat-model/ the OWASP Threat Dragon model
docs/golden-addresses/ resource addresses the plan no-op check compares against
docs/superpowers/ dated design records (specs and plans), not maintained as guides
docs/spacelift-secrets.md how secrets reach a run, rotation, upgrades
board.yaml the project board as code (Scrum Around and Find Out): fields, sprints, views
media/ icons and images for the README's Support section
```
Modules are reusable building blocks. Stacks are the things you actually apply, one Spacelift stack each. Each module and stack has its tests in `/tests/*.tftest.hcl`.
## Run the checks
Install OpenTofu 1.8 or newer, Python 3 and, for the policy tests, OPA 1.21.0, then:
```bash
# cost gate: totals the planned resources and compares with docs/stages/approved.json
python3 -I scripts/cost_check.py --root .
# the settings page must match docs/settings.json
python3 -I scripts/gen_settings_doc.py --check
python3 -I scripts/gen_project_status.py --check
# the repository tests (needs a virtualenv with pytest and pyyaml installed)
python3 -I -m pytest tests -q
# no cloud account ids in tracked files
python3 -I scripts/identifier_check.py --root .
# tests for the Spacelift push policy
opa test .spacelift/policies -v
# tests for one module or stack (no cloud account needed, providers are mocked)
tofu -chdir=modules/firewall init -backend=false
tofu -chdir=modules/firewall test
```
Run the last pair for each directory in the `directories` list of the tofu job in `.github/workflows/ci.yml`: `modules/vpc`, `modules/firewall`, `modules/twingate-bootstrap`, `modules/twingate-connector`, `modules/aws/vpc`, `modules/aws/firewall`, `modules/aws/twingate-connector`, `stacks/00-foundation`, `stacks/10-access`, `stacks/20-telemetry`, `stacks/aws/00-foundation` and `stacks/aws/10-access`. CI runs all of it through git-your-ship-together's shared workflows; the only job this repository defines itself is the `CI green` gate.
## Documentation
| For | Read |
|---|---|
| Learning how and why it works | [The wiki](https://github.com/ChiefGyk3D/Clouds-Against-Humanity/wiki) (start at [Home](docs/wiki/Home.md)) |
| New to cloud, Terraform, zero trust or CI | [Start here if you are new](docs/wiki/Start-Here-If-You-Are-New.md), then the eight start-from-zero primers it links |
| Building or operating a stage | [Stage 0: foundation](docs/stages/00-foundation.md), [Stage 1: access](docs/stages/01-access.md) |
| Secrets, rotation, troubleshooting runs | [Spacelift and Doppler secrets](docs/spacelift-secrets.md) |
| The money | [Cost](docs/cost.md) |
| How the work is planned: the board, sprints, sizes, definition of done | [How this project is planned](docs/wiki/How-This-Project-Is-Planned.md), the [project board](https://github.com/users/ChiefGyk3D/projects/4) and `board.yaml` |
| What could go wrong | [Threat model](docs/wiki/Threat-Model.md), [Lessons learned](docs/wiki/Lessons-Learned.md) |
The wiki is generated from `docs/wiki/`, so corrections go in as pull requests and get the same review and secret scanning as the code. The Wiki workflow publishes them on every merge to `main`.
## Public by design
This repository is public from its first commit, so the GitHub code-scanning and dependency-review checks run in CI. Everything that varies per person or per account (tokens, tenant names, user ids, address ranges you do not want shared) is a Doppler variable, not a file. If a piece ever cannot meet that rule, it moves to a separate private repository and this one calls it.
## Secrets
Secrets live in Doppler; nothing in this repository is a credential. Spacelift holds one read-only Doppler token and fetches the rest at run time; see [Spacelift and Doppler secrets](docs/spacelift-secrets.md) for how that works and how to rotate it.
---
## 💝 Support This Project
If you find Clouds Against Humanity useful, consider supporting continued development.
Everything is also collected at **[support.chiefgyk3d.com](https://support.chiefgyk3d.com)**.
### Recurring Support