Skip to content

docs: Sync configuration reference with current allocator schema#261

Merged
7174Andy merged 4 commits intomainfrom
andrew/update-dns-configs
Feb 5, 2026
Merged

docs: Sync configuration reference with current allocator schema#261
7174Andy merged 4 commits intomainfrom
andrew/update-dns-configs

Conversation

@7174Andy
Copy link
Collaborator

@7174Andy 7174Andy commented Feb 3, 2026

Summary

Updates docs/configuration.md to accurately reflect the current allocator configuration schema defined in structured_config.py, and removes advanced override documentation not needed by end users hosting tutorials.

Changes

Updated

  • machine.ami_id default: ami-067cc81f948e50e06 (Ubuntu 20.04) → ami-00c257e12d6828491 (Ubuntu 24.04 + Docker + Nvidia)
  • machine.repository default: documented as a URL → corrected to None (Optional[str])
  • db.table_name default: vmsvm_table (matches schema)
  • db.password / app.admin_password defaults: now show actual schema defaults instead of placeholder values
  • dns.terraform_managed default: falsetrue (matches schema)
  • AMI finder command updated from Ubuntu 20.04 to Ubuntu 24.04
  • Table column alignment fixed for consistency

Added

  • machine.extension field — file extension for software data files (default: slp)
  • ssl.certificate_arn field — AWS ACM certificate ARN support
  • ssl provider: acm — AWS Certificate Manager as fourth SSL provider option
  • SSL Validation Rules subsection — documents cross-field dependency checks
  • Allocator Deployment Options (allocator) section — documents image_tag for Terraform
  • Monitoring Options (monitoring) section — full documentation for thresholds, budget, and CloudTrail config
  • Configuration examples for each SSL provider

Removed

  • Overriding Configuration section (5 override methods) — not needed by end users
  • Configuration for Different Environments section (dev/staging/prod examples) — not needed by end users
  • ssl.staging field — no longer exists in schema (replaced by provider: "none")
  • Staging vs Production Mode section — replaced with provider-based documentation
  • Allocator Options (client host/port) — was incorrectly placed in allocator config reference
  • DNS fields app_name, pattern, custom_subdomain, create_zone — no longer in schema

Test plan

  • Verify docs/configuration.md renders correctly with MkDocs (/docs-serve)
  • Cross-check all defaults against packages/allocator/src/lablink_allocator_service/conf/structured_config.py
  • Confirm no broken internal doc links

🤖 Generated with Claude Code

7174Andy and others added 4 commits February 2, 2026 16:50
Sync configuration.md with the actual structured config in
structured_config.py. Key updates: add machine.extension field, update
AMI to Ubuntu 24.04, fix dns.terraform_managed default to true, replace
removed ssl.staging with provider-based docs (add acm/certificate_arn),
replace client allocator options with deployment image_tag section, and
add full monitoring section (thresholds, budget, cloudtrail).

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add monitoring configuration block to docs/configuration.md example
- Add monitoring configuration to allocator config.yaml with comments
- Syncs documentation with structured_config.py schema

The monitoring section includes:
- enabled: Toggle monitoring infrastructure
- email: Alert notification address
- thresholds: Instance/termination/API rate limits
- budget: AWS Budget configuration
- cloudtrail: Log retention settings

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- dns-configuration.md: Remove outdated options (app_name, pattern,
  custom_subdomain, create_zone) and update to current schema
  (enabled, terraform_managed, domain, zone_id)
- quickstart.md: Remove non-existent gpu_support and staging options
- troubleshooting.md: Update DNS config example to current format

The old pattern-based subdomain approach was replaced with direct
domain specification in the config schema.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@7174Andy 7174Andy merged commit eda4aa8 into main Feb 5, 2026
10 checks passed
@7174Andy 7174Andy deleted the andrew/update-dns-configs branch February 5, 2026 04:04
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