docs(reuse): establish reviewed NetKingdom security capabilities
Assistant: codex Assistant-Model: gpt-6-astra Assistant-Session: 01a137ca-5c77-7a71-b9ae-23ad9b0b5684
This commit is contained in:
parent
a6da9f2c5c
commit
bf199707ff
3 changed files with 282 additions and 227 deletions
|
|
@ -1,34 +1,35 @@
|
|||
---
|
||||
id: capability.registry.register
|
||||
name: Capability Registration
|
||||
summary: Register a new capability so it becomes visible for planning and implementation reuse.
|
||||
name: Capability registry and federation
|
||||
summary: Owner Markdown entries, indexes, federation hub and planning queries.
|
||||
owner: reuse-surface
|
||||
status: draft
|
||||
domain: helix_forge
|
||||
tags:
|
||||
- registry
|
||||
- governance
|
||||
- meta
|
||||
|
||||
- registry
|
||||
- governance
|
||||
- meta
|
||||
- security
|
||||
- netkingdom
|
||||
- framework-reuse
|
||||
maturity:
|
||||
discovery:
|
||||
current: D3
|
||||
target: D5
|
||||
confidence: medium
|
||||
rationale: >
|
||||
Core use case UC-RS-001 is documented in specs/UseCaseCatalog.md and the
|
||||
registry model is bounded in INTENT.md, but concrete promotion workflows
|
||||
rationale: 'Core use case UC-RS-001 is documented in specs/UseCaseCatalog.md and
|
||||
the registry model is bounded in INTENT.md, but concrete promotion workflows
|
||||
are not yet grounded in registry artifacts.
|
||||
|
||||
'
|
||||
availability:
|
||||
current: A4
|
||||
current: A3
|
||||
target: A5
|
||||
confidence: medium
|
||||
rationale: >
|
||||
Local registry workflows use the reuse-surface CLI (A3). Federation repo
|
||||
registration is also available through the hosted hub HTTP API at
|
||||
reuse.coulomb.social (POST/PATCH /v1/repos), deployed and dogfood-tested
|
||||
on Railiance01 (REUSE-WP-0011).
|
||||
|
||||
rationale: 'Source interface assessed 2026-10-14: Owner Markdown entries, indexes,
|
||||
federation hub and planning queries. Availability describes the delivery form,
|
||||
not production acceptance. Discovery is not readiness; empty and stale entries
|
||||
need evidence-led maintenance.'
|
||||
external_evidence:
|
||||
completeness:
|
||||
level: C2
|
||||
|
|
@ -36,164 +37,162 @@ external_evidence:
|
|||
confidence: medium
|
||||
basis: scope_vs_intent_and_consumer_expectations
|
||||
satisfied_expectations:
|
||||
- capability IDs can be assigned in registry entries
|
||||
- maturity vectors can be recorded at registration time
|
||||
- CLI validate, query, and export support registry workflows
|
||||
- promotion history can be recorded in entries
|
||||
- federation repo registration via hosted hub API and hub CLI
|
||||
- capability IDs can be assigned in registry entries
|
||||
- maturity vectors can be recorded at registration time
|
||||
- CLI validate, query, and export support registry workflows
|
||||
- promotion history can be recorded in entries
|
||||
- federation repo registration via hosted hub API and hub CLI
|
||||
broken_expectations:
|
||||
- no automated duplicate detection yet
|
||||
- no automated duplicate detection yet
|
||||
out_of_scope_expectations:
|
||||
- hosting registered capabilities
|
||||
- enforcing implementation architecture
|
||||
- hosting registered capabilities
|
||||
- enforcing implementation architecture
|
||||
reliability:
|
||||
level: R3
|
||||
name: Usable
|
||||
confidence: medium
|
||||
basis: consumer_quality_signals
|
||||
known_reliability_risks:
|
||||
- index drift still possible if authors skip validate
|
||||
- CLI requires local venv install
|
||||
- sibling repos cannot register until indexes publish raw URLs
|
||||
- index drift still possible if authors skip validate
|
||||
- CLI requires local venv install
|
||||
- sibling repos cannot register until indexes publish raw URLs
|
||||
evidence:
|
||||
satisfied_signals:
|
||||
- CI validate with fail-on-warnings on every push
|
||||
- hub register/list/federated smoke on production reuse.coulomb.social
|
||||
- pytest coverage for hub API and federation compose paths
|
||||
|
||||
- CI validate with fail-on-warnings on every push
|
||||
- hub register/list/federated smoke on production reuse.coulomb.social
|
||||
- pytest coverage for hub API and federation compose paths
|
||||
discovery:
|
||||
intent: >
|
||||
Make a capability candidate visible in the registry so humans and agents can
|
||||
discover, assess, compare, and reuse it instead of rebuilding it in isolation.
|
||||
intent: Owner Markdown entries, indexes, federation hub and planning queries
|
||||
includes:
|
||||
- stable capability ID assignment
|
||||
- initial discovery and availability classification
|
||||
- explicit completeness and reliability placeholders
|
||||
- evidence and relation references
|
||||
- Owner Markdown entries, indexes, federation hub and planning queries
|
||||
excludes:
|
||||
- implementing the registered capability
|
||||
- certifying implementation quality
|
||||
- operating runtime services for registered capabilities
|
||||
- Discovery is not readiness; empty and stale entries need evidence-led maintenance
|
||||
assumptions:
|
||||
- unregistered capabilities are invisible for registry-driven reuse
|
||||
- low-maturity entries are acceptable when evidence gaps are explicit
|
||||
- unregistered capabilities are invisible for registry-driven reuse
|
||||
- low-maturity entries are acceptable when evidence gaps are explicit
|
||||
use_cases:
|
||||
- UC-RS-001
|
||||
- UC-RS-001
|
||||
- 'U01: Architect composes a security deployment from explicit owner contracts and
|
||||
case types'
|
||||
- 'U09: Maintainer observes posture, prioritizes findings, coordinates work and
|
||||
verifies outcomes'
|
||||
- 'U14: Framework adopter validates and reuses selected contracts, tools and reference
|
||||
compositions'
|
||||
research_memos:
|
||||
- specs/UseCaseCatalog.md
|
||||
- specs/ProductRequirementsDocument.md
|
||||
|
||||
- specs/UseCaseCatalog.md
|
||||
- specs/ProductRequirementsDocument.md
|
||||
availability:
|
||||
current_level: A4
|
||||
current_level: A3
|
||||
target_level: A5
|
||||
current_artifacts:
|
||||
- templates/capability-entry.template.md
|
||||
- registry/indexes/capabilities.yaml
|
||||
- reuse_surface/cli.py
|
||||
- reuse_surface/hub/
|
||||
- specs/FederationHubAPI.md
|
||||
- https://reuse.coulomb.social
|
||||
- docs/RegistryFederation.md
|
||||
- specs/CapabilityMaturityStandard.md
|
||||
target_artifacts:
|
||||
- packaged container release with documented SLO
|
||||
- packaged container release with documented SLO
|
||||
consumption_modes:
|
||||
- informational
|
||||
- markdown authoring
|
||||
- cli
|
||||
- service API
|
||||
|
||||
- library
|
||||
- CLI
|
||||
relations:
|
||||
depends_on: []
|
||||
supports:
|
||||
- capability.feature-control.evaluate
|
||||
- capability.identity.vocabulary-canonicalize
|
||||
- capability.feature-control.evaluate
|
||||
- capability.identity.vocabulary-canonicalize
|
||||
related_to:
|
||||
- capability.registry.validate
|
||||
|
||||
- capability.registry.validate
|
||||
- capability.security.iam-tooling-suite
|
||||
evidence:
|
||||
documentation:
|
||||
- INTENT.md
|
||||
- specs/UseCaseCatalog.md
|
||||
- specs/FederationHubAPI.md
|
||||
- docs/deploy/reuse-kubernetes.md
|
||||
- docs/RegistryFederation.md
|
||||
- specs/CapabilityMaturityStandard.md
|
||||
tests:
|
||||
- tests/test_hub.py
|
||||
- tests/test_hub_sync.py
|
||||
- .forgejo/workflows/ci.yml
|
||||
- tests/test_hub.py
|
||||
- tests/test_hub_sync.py
|
||||
- .forgejo/workflows/ci.yml
|
||||
consumer_feedback:
|
||||
- >
|
||||
reuse-surface dogfood (REUSE-WP-0011): production hub registration and
|
||||
/v1/federated compose succeeded on Railiance01 without write-path
|
||||
regressions after WP-0011 deploy.
|
||||
- 'reuse-surface dogfood (REUSE-WP-0011): production hub registration and /v1/federated
|
||||
compose succeeded on Railiance01 without write-path regressions after WP-0011
|
||||
deploy.
|
||||
|
||||
'
|
||||
bug_reports: []
|
||||
incidents: []
|
||||
|
||||
consumer_guidance:
|
||||
recommended_for:
|
||||
- making a new capability visible at D0/A0/C0/R0 with minimal friction
|
||||
- seeding planning discussions before implementation exists
|
||||
- Architect composes a security deployment from explicit owner contracts and case
|
||||
types
|
||||
- Maintainer observes posture, prioritizes findings, coordinates work and verifies
|
||||
outcomes
|
||||
- Framework adopter validates and reuses selected contracts, tools and reference
|
||||
compositions
|
||||
not_recommended_for:
|
||||
- treating registry presence as proof of implementation readiness
|
||||
- skipping explicit evidence for maturity promotion
|
||||
- Discovery is not readiness; empty and stale entries need evidence-led maintenance
|
||||
known_limitations:
|
||||
- manual index updates are required after adding an entry
|
||||
- duplicate detection is guidance-only in the MVP
|
||||
|
||||
- Discovery is not readiness; empty and stale entries need evidence-led maintenance
|
||||
- 2026-10-14 architecture review estimates operational maturity separately; a registry
|
||||
entry does not authorize execution or establish deployment.
|
||||
promotion_history:
|
||||
- date: "2026-06-14"
|
||||
dimension: discovery
|
||||
from: D0
|
||||
to: D1
|
||||
rationale: Added name, summary, and registry-first intent from INTENT.md.
|
||||
author: reuse-surface
|
||||
- date: "2026-06-15"
|
||||
dimension: discovery
|
||||
from: D1
|
||||
to: D3
|
||||
rationale: Bounded scope with UC-RS-001 and MVP registry artifacts in specs/.
|
||||
author: reuse-surface
|
||||
- date: "2026-06-15"
|
||||
dimension: availability
|
||||
from: A0
|
||||
to: A3
|
||||
rationale: reuse-surface CLI shipped validate, query, and export commands.
|
||||
author: reuse-surface
|
||||
- date: "2026-06-15"
|
||||
dimension: availability
|
||||
from: A3
|
||||
to: A4
|
||||
rationale: >
|
||||
Hosted federation hub live at reuse.coulomb.social; hub register/update
|
||||
via HTTP API and reuse-surface hub CLI; production deploy on Railiance01.
|
||||
author: reuse-surface
|
||||
- date: "2026-06-16"
|
||||
dimension: reliability
|
||||
from: R2
|
||||
to: R3
|
||||
rationale: >
|
||||
CI gates, pytest hub/federation coverage, and production hub smoke support
|
||||
normal registration workflows with documented limitations.
|
||||
author: reuse-surface
|
||||
- date: '2026-06-14'
|
||||
dimension: discovery
|
||||
from: D0
|
||||
to: D1
|
||||
rationale: Added name, summary, and registry-first intent from INTENT.md.
|
||||
author: reuse-surface
|
||||
- date: '2026-06-15'
|
||||
dimension: discovery
|
||||
from: D1
|
||||
to: D3
|
||||
rationale: Bounded scope with UC-RS-001 and MVP registry artifacts in specs/.
|
||||
author: reuse-surface
|
||||
- date: '2026-06-15'
|
||||
dimension: availability
|
||||
from: A0
|
||||
to: A3
|
||||
rationale: reuse-surface CLI shipped validate, query, and export commands.
|
||||
author: reuse-surface
|
||||
- date: '2026-06-15'
|
||||
dimension: availability
|
||||
from: A3
|
||||
to: A4
|
||||
rationale: 'Hosted federation hub live at reuse.coulomb.social; hub register/update
|
||||
via HTTP API and reuse-surface hub CLI; production deploy on Railiance01.
|
||||
|
||||
'
|
||||
author: reuse-surface
|
||||
- date: '2026-06-16'
|
||||
dimension: reliability
|
||||
from: R2
|
||||
to: R3
|
||||
rationale: 'CI gates, pytest hub/federation coverage, and production hub smoke support
|
||||
normal registration workflows with documented limitations.
|
||||
|
||||
'
|
||||
author: reuse-surface
|
||||
- date: '2026-10-14'
|
||||
dimension: availability
|
||||
from: A4
|
||||
to: A3
|
||||
rationale: Interface-form reassessment from current owner sources; no completeness/reliability
|
||||
promotion.
|
||||
author: codex
|
||||
---
|
||||
|
||||
# Capability Registration
|
||||
# Capability registry and federation
|
||||
|
||||
## Overview
|
||||
Owner Markdown entries, indexes, federation hub and planning queries.
|
||||
|
||||
Registration is the entry point for reuse visibility. A capability that is not
|
||||
registered cannot be discovered through the registry surface, even if code or
|
||||
documentation exists elsewhere.
|
||||
## Reuse boundary
|
||||
|
||||
## Current reuse mode
|
||||
Discovery is not readiness; empty and stale entries need evidence-led maintenance.
|
||||
|
||||
**Local registry (A3 CLI):** add Markdown entries under `registry/capabilities/`,
|
||||
update `registry/indexes/capabilities.yaml`, run `reuse-surface validate`.
|
||||
## Supported use cases
|
||||
|
||||
**Federation registration (A4 API):** register published index URLs on the hosted
|
||||
hub (`reuse-surface hub register`, `POST /v1/repos`) for cross-repo discovery
|
||||
via `GET /v1/federated`.
|
||||
- U01: Architect composes a security deployment from explicit owner contracts and case types
|
||||
- U09: Maintainer observes posture, prioritizes findings, coordinates work and verifies outcomes
|
||||
- U14: Framework adopter validates and reuses selected contracts, tools and reference compositions
|
||||
|
||||
## Next promotion steps
|
||||
## Evidence and integration
|
||||
|
||||
1. Attach concrete use cases and actors to reach D5.
|
||||
2. Package hub as a versioned container release with operator SLO (A5).
|
||||
3. Record consumer expectations and broken expectations as external evidence.
|
||||
- [docs/RegistryFederation.md](../../docs/RegistryFederation.md)
|
||||
- [specs/CapabilityMaturityStandard.md](../../specs/CapabilityMaturityStandard.md)
|
||||
|
||||
Assessment: CUST-WP-0081, 2026-10-14. Relations identify interfaces to compose; they do not certify native integration. Existing external evidence levels are retained where present. New entries use conservative C1/R0 until consumer assessment exists.
|
||||
|
|
|
|||
|
|
@ -1,24 +1,31 @@
|
|||
---
|
||||
id: capability.registry.validate
|
||||
name: Registry Entry Validation
|
||||
summary: Validate capability registry entries against schema, index consistency, and relation integrity.
|
||||
name: Capability registry validation
|
||||
summary: Schema, index consistency and relation checks.
|
||||
owner: reuse-surface
|
||||
status: draft
|
||||
domain: helix_forge
|
||||
tags: [registry, validation, cli]
|
||||
|
||||
tags:
|
||||
- registry
|
||||
- validation
|
||||
- cli
|
||||
- security
|
||||
- netkingdom
|
||||
- framework-reuse
|
||||
maturity:
|
||||
discovery:
|
||||
current: D4
|
||||
target: D5
|
||||
confidence: medium
|
||||
rationale: UC-RS-023 is implemented via reuse-surface validate with schema and drift checks.
|
||||
rationale: UC-RS-023 is implemented via reuse-surface validate with schema and
|
||||
drift checks.
|
||||
availability:
|
||||
current: A3
|
||||
target: A3
|
||||
confidence: high
|
||||
rationale: Available as reuse-surface validate CLI command.
|
||||
|
||||
rationale: 'Source interface assessed 2026-10-14: Schema, index consistency and
|
||||
relation checks. Availability describes the delivery form, not production acceptance.
|
||||
Schema validity alone proves neither capability behavior nor hosted freshness.'
|
||||
external_evidence:
|
||||
completeness:
|
||||
level: C3
|
||||
|
|
@ -26,82 +33,102 @@ external_evidence:
|
|||
confidence: medium
|
||||
basis: scope_vs_intent_and_consumer_expectations
|
||||
satisfied_expectations:
|
||||
- schema validation for entry front matter
|
||||
- index drift detection
|
||||
- optional relation integrity checks
|
||||
- schema validation for entry front matter
|
||||
- index drift detection
|
||||
- optional relation integrity checks
|
||||
broken_expectations: []
|
||||
out_of_scope_expectations:
|
||||
- runtime validation of registered capability implementations
|
||||
- runtime validation of registered capability implementations
|
||||
reliability:
|
||||
level: R3
|
||||
name: Usable
|
||||
confidence: medium
|
||||
basis: consumer_quality_signals
|
||||
known_reliability_risks:
|
||||
- requires local venv install
|
||||
- relation warnings require explicit --relations flag
|
||||
- requires local venv install
|
||||
- relation warnings require explicit --relations flag
|
||||
evidence:
|
||||
satisfied_signals:
|
||||
- validate --relations --fail-on-warnings in CI
|
||||
- tests/test_registry.py schema and drift coverage
|
||||
|
||||
- validate --relations --fail-on-warnings in CI
|
||||
- tests/test_registry.py schema and drift coverage
|
||||
discovery:
|
||||
intent: Keep registry data structurally sound so agents and humans can trust discovery metadata.
|
||||
intent: Schema, index consistency and relation checks
|
||||
includes:
|
||||
- JSON Schema validation
|
||||
- index drift warnings
|
||||
- relation reference checks
|
||||
- Schema, index consistency and relation checks
|
||||
excludes:
|
||||
- validating implementation code in other repos
|
||||
- Schema validity alone proves neither capability behavior nor hosted freshness
|
||||
use_cases:
|
||||
- UC-RS-023
|
||||
- UC-RS-023
|
||||
- 'U01: Architect composes a security deployment from explicit owner contracts and
|
||||
case types'
|
||||
- 'U14: Framework adopter validates and reuses selected contracts, tools and reference
|
||||
compositions'
|
||||
research_memos:
|
||||
- specs/UseCaseCatalog.md
|
||||
|
||||
- specs/UseCaseCatalog.md
|
||||
availability:
|
||||
current_level: A3
|
||||
target_level: A3
|
||||
current_artifacts:
|
||||
- reuse_surface/cli.py
|
||||
- schemas/capability.schema.yaml
|
||||
- docs/RegistryFederation.md
|
||||
- schemas/capability.schema.yaml
|
||||
consumption_modes:
|
||||
- cli
|
||||
|
||||
- library
|
||||
- CLI
|
||||
relations:
|
||||
depends_on:
|
||||
- capability.registry.register
|
||||
- capability.registry.register
|
||||
supports: []
|
||||
related_to:
|
||||
- capability.registry.register
|
||||
|
||||
- capability.registry.register
|
||||
- capability.security.iam-tooling-suite
|
||||
evidence:
|
||||
documentation:
|
||||
- tools/README.md
|
||||
- .forgejo/workflows/ci.yml
|
||||
- docs/RegistryFederation.md
|
||||
- schemas/capability.schema.yaml
|
||||
tests:
|
||||
- tests/test_registry.py
|
||||
- tests/test_registry.py
|
||||
consumer_feedback:
|
||||
- >
|
||||
reuse-surface CI: registry changes fail when schema validation or relation
|
||||
checks warn with --fail-on-warnings, giving agents a dependable pre-merge gate.
|
||||
- 'reuse-surface CI: registry changes fail when schema validation or relation checks
|
||||
warn with --fail-on-warnings, giving agents a dependable pre-merge gate.
|
||||
|
||||
'
|
||||
consumer_guidance:
|
||||
recommended_for:
|
||||
- pre-commit and CI validation of registry changes
|
||||
- Architect composes a security deployment from explicit owner contracts and case
|
||||
types
|
||||
- Framework adopter validates and reuses selected contracts, tools and reference
|
||||
compositions
|
||||
not_recommended_for:
|
||||
- certifying business correctness of capability claims
|
||||
- Schema validity alone proves neither capability behavior nor hosted freshness
|
||||
known_limitations:
|
||||
- warnings do not fail CI unless --fail-on-warnings is set
|
||||
|
||||
- Schema validity alone proves neither capability behavior nor hosted freshness
|
||||
- 2026-10-14 architecture review estimates operational maturity separately; a registry
|
||||
entry does not authorize execution or establish deployment.
|
||||
promotion_history:
|
||||
- date: "2026-06-16"
|
||||
dimension: reliability
|
||||
from: R2
|
||||
to: R3
|
||||
rationale: CI fail-on-warnings and pytest registry coverage support dependable validation.
|
||||
author: reuse-surface
|
||||
- date: '2026-06-16'
|
||||
dimension: reliability
|
||||
from: R2
|
||||
to: R3
|
||||
rationale: CI fail-on-warnings and pytest registry coverage support dependable validation.
|
||||
author: reuse-surface
|
||||
---
|
||||
|
||||
# Registry Entry Validation
|
||||
# Capability registry validation
|
||||
|
||||
Validates registry shape and consistency through the reuse-surface CLI.
|
||||
Schema, index consistency and relation checks.
|
||||
|
||||
## Reuse boundary
|
||||
|
||||
Schema validity alone proves neither capability behavior nor hosted freshness.
|
||||
|
||||
## Supported use cases
|
||||
|
||||
- U01: Architect composes a security deployment from explicit owner contracts and case types
|
||||
- U14: Framework adopter validates and reuses selected contracts, tools and reference compositions
|
||||
|
||||
## Evidence and integration
|
||||
|
||||
- [docs/RegistryFederation.md](../../docs/RegistryFederation.md)
|
||||
- [schemas/capability.schema.yaml](../../schemas/capability.schema.yaml)
|
||||
|
||||
Assessment: CUST-WP-0081, 2026-10-14. Relations identify interfaces to compose; they do not certify native integration. Existing external evidence levels are retained where present. New entries use conservative C1/R0 until consumer assessment exists.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue