Operator-facing documentation for cyclecloud_as_code. The root
README.md covers project overview, architecture, and a
five-line quickstart; deeper how-tos and reference material live here.
| Doc | Read when |
|---|---|
| prerequisites.md | Setting up a fresh workstation or CI runner — Terraform version, Azure CLI auth, required RBAC, what var.current_ip_address is for |
| deploying.md | Cloning the repo, authoring tfvars, and running terraform init / plan / apply |
| access-modes.md | Choosing between bastion and public_ip, opening the web UI |
| ssh-key.md | Pulling the generated SSH private key out of Key Vault and using it with ssh / ssh-agent / Bastion tunneling |
| variables.md | Reference for every input variable and the naming convention applied to each resource |
| post-deploy.md | What the cloud-init bootstrap does, how to verify it finished, and how to log into the CycleCloud web UI |
| testing.md | How tests are organized (static checks, terraform test, planned E2E) and how to run them locally |
| known-gaps.md | Intentional rough edges and TODOs (KV firewall posture, cluster automation, NSG coverage, etc.) |
- Relative links:
[](deploying.md)between docs,[](../README.md)back to the project root,[](../terraform/<file>.tf)to source. - Every doc starts with a one-sentence purpose statement so it stands on its own when reached via a deep link.
- Commands assume the working directory called out at the top of each
shell block (usually
terraform/orpost-config/).