docs: Sync configuration reference with current allocator schema#261
Merged
docs: Sync configuration reference with current allocator schema#261
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updates
docs/configuration.mdto accurately reflect the current allocator configuration schema defined instructured_config.py, and removes advanced override documentation not needed by end users hosting tutorials.Changes
Updated
machine.ami_iddefault:ami-067cc81f948e50e06(Ubuntu 20.04) →ami-00c257e12d6828491(Ubuntu 24.04 + Docker + Nvidia)machine.repositorydefault: documented as a URL → corrected toNone(Optional[str])db.table_namedefault:vms→vm_table(matches schema)db.password/app.admin_passworddefaults: now show actual schema defaults instead of placeholder valuesdns.terraform_manageddefault:false→true(matches schema)Added
machine.extensionfield — file extension for software data files (default:slp)ssl.certificate_arnfield — AWS ACM certificate ARN supportsslprovider:acm— AWS Certificate Manager as fourth SSL provider optionallocator) section — documentsimage_tagfor Terraformmonitoring) section — full documentation for thresholds, budget, and CloudTrail configRemoved
ssl.stagingfield — no longer exists in schema (replaced byprovider: "none")host/port) — was incorrectly placed in allocator config referenceapp_name,pattern,custom_subdomain,create_zone— no longer in schemaTest plan
docs/configuration.mdrenders correctly with MkDocs (/docs-serve)packages/allocator/src/lablink_allocator_service/conf/structured_config.py🤖 Generated with Claude Code