[INFRA] Standardize variable management (issue #15)#6
Closed
kristopherjturner wants to merge 3 commits into
Closed
[INFRA] Standardize variable management (issue #15)#6kristopherjturner wants to merge 3 commits into
kristopherjturner wants to merge 3 commits into
Conversation
…issue #15) - Create config/variables.example.yml with IIC example values - Consolidates cluster, credential, and testing config into single entry point - Uses keyvault:// URI format for all secrets - Follows org-wide snake_case naming convention - Subdirectory configs (clusters/, credentials/, profiles/) remain for detailed configs Resolves AzureLocal/azurelocal.github.io#15
Add config/schema/variables.schema.json for validating variables.example.yml. Replace old ajv-cli workflow with standardized Python-based validation. 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 standardizes variable management by introducing a central variables.example.yml template, a JSON Schema for validation, and a simplified CI workflow. It's part of issue #15 for org-wide variable management standardization.
Changes:
- Added
config/variables.example.ymlas a single-source-of-truth configuration template with IIC example values and Key Vault references for secrets. - Added
config/schema/variables.schema.jsonfor schema validation and updated.gitignoreto exclude the realconfig/variables.yml. - Replaced the Node.js-based (ajv-cli + yamllint) CI validation workflow with a simpler Python-based (pyyaml + jsonschema) approach that validates the example file against the schema.
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
config/variables.example.yml |
New central configuration template with Azure, cluster, storage, networking, credentials, testing, monitoring, reporting, WinRM, and tags sections |
config/schema/variables.schema.json |
New JSON Schema (draft-07) to validate the structure of the variables YAML |
.gitignore |
Excludes config/variables.yml (user-specific config with real values) |
.github/workflows/validate-config.yml |
Simplified from Node.js/ajv to Python/jsonschema; now only validates 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.
Comment on lines
+4
to
+5
| # Triggered on PRs and pushes that touch config/ or this workflow. | ||
| # Validates YAML syntax and JSON Schema compliance. |
| # ============================================================================= | ||
| # Validates YAML configs against JSON Schema and checks for syntax errors. | ||
| # Triggered on PRs and pushes that touch config/ or this workflow. | ||
| # Validates YAML syntax and JSON Schema compliance. |
…es.md - Rename variable-reference.md to variables.md (standard naming) - Rewrite content to match sectioned YAML format from config/variables.example.yml - Add all sections: azure, keyvault, azure_local, storage, networking, credentials, testing, monitoring, reporting, winrm, tags - Add naming rules table and Key Vault resolution docs - Update mkdocs.yml nav entry Part of: AzureLocal/azurelocal.github.io#15
Contributor
Author
|
Superseded by #7 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
Adds central variables.example.yml and schema validation as part of the org-wide variable management standardization initiative.
Changes
Related