docs: add OpenSpec baseline and follow-up change proposals#45
Open
ninjadq wants to merge 1 commit into
Open
Conversation
Introduce OpenSpec as the spec source-of-truth for the controller:
- Archive the baseline-existing-system change that captures current
behavior of Requirement, Operation, AppDeployment, and Cache CRDs
as four capability specs under openspec/specs/.
- Add two follow-up change proposals:
- guarantee-operation-id-uniqueness: tighten operation ID assignment
so uniqueness is enforced (via metadata.uid), not probabilistic.
- document-cache-mode-annotation: document the cache-mode annotation
emitted on cache-created Operations as an operator-facing contract.
- Seed openspec/config.yaml with project context.
- Add a Specifications section to README pointing future PRs at the
spec deltas workflow.
No runtime or API changes.
Co-Authored-By: Claude Opus 4 <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
1 participant
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
Requirement,Operation,AppDeployment,Cache).baseline-existing-systemchange, promoting four capability specs intoopenspec/specs/that describe current externally observable behavior (finalizers, annotations, labels, requeue intervals, cache hit/miss flow).guarantee-operation-id-uniqueness— tighten theOperation.status.operationIdcontract from probabilistic (random) to strict (UID-derived), with concurrent-reconcile coverage.document-cache-mode-annotation— documentoperation-cache-controller.azure.github.com/cache-mode=trueas an operator-facing contract on cache-created Operations.openspec/config.yamlwith stack/conventions context and add a Specifications section toREADME.mdpointing future PRs at the delta workflow.No source code, CRD schema, RBAC, or runtime behavior changes.
Test plan
openspec listshows the two pending follow-up changesopenspec validate requirement-management operation-orchestration appdeployment-execution cache-poolall passopenspec validate guarantee-operation-id-uniquenesspassesopenspec validate document-cache-mode-annotationpassesmake teststill green (no code touched)🤖 Generated with Claude Code