[INFRA] Standardize variable management (issue #15)#5
Closed
kristopherjturner wants to merge 2 commits into
Closed
[INFRA] Standardize variable management (issue #15)#5kristopherjturner wants to merge 2 commits into
kristopherjturner wants to merge 2 commits into
Conversation
Rewrite reference/variables.md with full sectioned YAML format matching config/variables.example.yml. Add naming rules, Key Vault resolution, and tool-specific mapping sections. Replace standards page with redirect. Part of AzureLocal/azurelocal.github.io#15
Add config/schema/variables.schema.json for validating variables.example.yml. Add CI workflow that validates example config against schema on PR. Part of AzureLocal/azurelocal.github.io#15
kristopherjturner
added
type/infra
8 tasks
There was a problem hiding this comment.
Pull request overview
This PR consolidates variable documentation into a single “Variable Reference” page and introduces automated validation to ensure config/variables.example.yml stays schema-compliant.
Changes:
- Replaces
docs/standards/variables.mdwith a pointer to the consolidated reference page. - Expands
docs/reference/variables.mdinto a full, sectioned configuration reference (examples + tables). - Adds a JSON Schema for
config/variables.example.ymlplus a GitHub Actions workflow to validate it on changes.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| docs/standards/variables.md | Converts the prior standards page into a “moved” notice linking to the new consolidated reference. |
| docs/reference/variables.md | Rewrites and significantly expands the variable reference content (examples, tables, Key Vault + tool mapping sections). |
| config/schema/variables.schema.json | Introduces a draft-07 JSON schema to validate the structure/required keys of config/variables.example.yml. |
| .github/workflows/validate-config.yml | Adds CI to validate YAML parsing and JSON Schema compliance for config/variables.example.yml. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| # Variable Reference | ||
|
|
||
| All deployment parameters consolidated from every tool's parameter file. | ||
| All deployment tools read from a single central configuration file: `config/variables.yml`. This file is the **single source of truth** — your architecture decisions, sizing, identity settings, and infrastructure IDs are declared here and consumed by every automation tool. |
Comment on lines
+84
to
+87
| | `control_plane.load_balancer_type` | string | Pooled | `BreadthFirst` or `DepthFirst` | `BreadthFirst` | | ||
| | `control_plane.max_session_limit` | integer | Pooled | Max concurrent sessions per host | `16` | | ||
| | `control_plane.preferred_app_group_type` | string | **Yes** | `Desktop`, `RailApplications`, or `None` | `Desktop` | | ||
| | `control_plane.personal_assignment_type` | string | Personal | `Automatic` or `Direct` | `Automatic` | |
Comment on lines
+217
to
+218
| 2. Tool calls `az keyvault secret show --vault-name kv-iic-platform --name avd-local-admin-password` | ||
| 3. Secret value is passed directly to the deployment — never written to disk |
Comment on lines
+236
to
+238
| | **Bicep** | `*.bicepparam` | `avd/bicep/` | | ||
| | **Terraform** | `terraform.tfvars` | `avd/terraform/` | | ||
| | **ARM** | `*.parameters.json` | `avd/arm/` | |
| pull_request: | ||
| branches: [main] | ||
| paths: | ||
| - 'config/**' |
Contributor
Author
|
Superseded by #6 which now includes all issue-15 variable standardization changes merged with issue-14 unified standards. |
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
Consolidates variable documentation and adds schema validation as part of the org-wide variable management standardization initiative.
Changes
Related