Skip to content

docs: fix inaccuracies and scrub internal references across all documentation#45

Merged
syscod3 merged 7 commits intomainfrom
feat/capacity-guard
Mar 26, 2026
Merged

docs: fix inaccuracies and scrub internal references across all documentation#45
syscod3 merged 7 commits intomainfrom
feat/capacity-guard

Conversation

@syscod3
Copy link
Copy Markdown
Collaborator

@syscod3 syscod3 commented Mar 26, 2026

Summary

  • README: fix badge version (1.8→1.11), omni_endpoint format, variable name (omni_join_token), capacity troubleshooting
  • CONTRIBUTING.md: fix markdownlint violations (MD031/MD032/MD040)
  • PLAN.md: terraform→tofu commands, update tfvars example to current syntax
  • ROADMAP.md: rewrite Current State section to accurately reflect Talos+Omni implementation (old Proxmox phases marked as historical)
  • docs/nix-dagger-*.md: add superseded notice (mise+GHA was adopted)
  • docs/OCI_AMPERE_BUILD.md: add "not yet implemented" notice (referenced workflows don't exist)
  • .markdownlintignore: exclude legacy/superseded docs with pre-existing violations
  • .gitignore: exclude .specstory/, docs/plans/, .claude/ from tracking
  • Scrub all internal profile/endpoint references from tfvars, workflows, validation, mise config, scripts

🤖 Generated with Claude Code

syscod3 added 7 commits March 26, 2026 22:45
Query live OCI state before planning to catch:
- Config errors: tfvars requests more than the per-tenancy limit
- Drift: live instances already exceed limit from out-of-band provisioning

Checks A1 OCPU, A1 RAM, and E2.1.Micro count independently.
…ternal context

- E2.1.Micro is available in both Always Free and PAYG accounts (was wrong)
- Block storage limit is 200 GB total per tenancy, not per AD (was wrong)
- NLB is fully Always Free — not pay-per-GB (was wrong)
- Remove fractional OCPU claim (was an empirical fluke, not a product difference)
- Remove all tenancy-specific sections and deployment state
- Remove internal cross-references
- terraform.tfvars: strip omni_endpoint and oci_config_profile; rename
  node names to generic node-{1..4}; document all sensitive vars as
  TF_VAR_ env vars
- terraform.tfvars.example: replace internal profile/endpoint with
  generic placeholders (DEFAULT, omni.example.com)
- deploy.yml: OCI config profile → DEFAULT; region from OCI_REGION
  secret; omni_endpoint from OMNI_ENDPOINT secret; oci_config_profile
  passed as -var flag
- validation.tf, variables.tf: replace internal domain in examples
- mise.toml, cleanup script, docs: replace internal profile with DEFAULT
- README: badge 1.8→1.11, fix omni_endpoint format (hostname:port not URL),
  fix variable name siderolink_join_token→omni_join_token, update capacity
  troubleshooting (remove reference to untracked retry script)
- CONTRIBUTING.md: fix markdownlint violations (MD031/MD032/MD040)
- PLAN.md: terraform→tofu commands, update tfvars example to current syntax
- ROADMAP.md: rewrite Current State to reflect Talos+Omni reality; old
  Proxmox phases are historical reference only
- docs/nix-dagger-{analysis,detailed}.md: add superseded notice (mise+GHA
  was adopted instead)
- docs/OCI_AMPERE_BUILD.md: add "Not yet implemented" notice (referenced
  workflows do not exist yet)
- .markdownlintignore: exclude superseded/legacy docs with pre-existing
  markdownlint violations
@syscod3 syscod3 merged commit 317e9f9 into main Mar 26, 2026
5 checks passed
@syscod3 syscod3 deleted the feat/capacity-guard branch March 26, 2026 23:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant