docs(contract): add CATALOG_REPO_CONTRACT.md - #62
Merged
Merged
Conversation
Canonical reference for every bnk-forge-catalog-* repository: - Naming conventions (bnk-forge-catalog-<target>) - Per-release branching cadence (release/2.x) - Required top-level files and directory layout - README requirements - Module structure (bnkforge.pack.json + module.json + TF files) - bnkforge.pack.json schema with forbidden values - forge-blueprint.json schema with platform_defaults, prerequisites, inputs, modules array shape - Cross-module wiring rules (auto-resolution by name match) - Two valid credential patterns: IBM-style cloud-coupled (creds to every module) vs cloud-agnostic with Forge-injected kubeconfig - Vendoring rules: pristine copies, deterministic rewrites, auto-refresh discipline - Validation steps every PR should run Bump VERSION to 2.2-rev.32.
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
Canonical reference doc for every
bnk-forge-catalog-*repository — so future Azure / GCP / on-prem catalog repos, and any third-party contributors, follow the same shape asbnk-forge-catalog-aws-eks.What's covered
bnk-forge-catalog-<target>for JLCode-tech-owned repos; external catalogs may use their own naming.release/2.2,release/2.3, …);maintracks the most recent.<target>-<step>(e.g.eks-cluster-register).bnkforge.pack.jsonschema with forbidden values (nosource: project_secret),module.jsonretention during transition.forge-blueprint.jsonschema withbnk_version,platform_defaults,prerequisites,inputs,modulesarray.depends_on; blueprint manifests only reference blueprint-level inputs via${var}.forge_kubeconfig_content. Both are valid; a single blueprint can mix.Why now
bnk-forge-catalog-aws-eksPR #2 shipped the first complete vendor-and-chain slice. Codifying the contract now means Azure / GCP / on-prem don't have to reverse-engineer the pattern.Test plan
release/2.2Notes
versionfield at that point.docs/.