generated from coulomb/repo-seed
Implement credentialed live hardening workplan
This commit is contained in:
@@ -26,24 +26,25 @@ to 5.
|
||||
|
||||
## Current Score
|
||||
|
||||
Overall maturity: **4.3 / 5**
|
||||
Overall maturity: **4.4 / 5**
|
||||
|
||||
Two sub-scores make the result easier to reason about:
|
||||
|
||||
- Local integration maturity: **4.6 / 5**
|
||||
- Operational maturity: **4.0 / 5**
|
||||
- Local integration maturity: **4.7 / 5**
|
||||
- Operational maturity: **4.2 / 5**
|
||||
|
||||
The repo is strong as a deterministic local library and service-boundary core.
|
||||
It is not yet production-operational because adapter coverage is still
|
||||
credential-gated rather than continuously exercised against live services, and
|
||||
service packaging is stdlib/local rather than deployed to a managed environment.
|
||||
It now has credential-safe operator artifacts, managed deployment manifest
|
||||
validation, persisted evaluation trend histories, and a troubleshooting matrix.
|
||||
It is not yet production-operational because real endpoint and managed platform
|
||||
evidence still requires an approved operator environment.
|
||||
|
||||
## Dimension Scorecard
|
||||
|
||||
| Dimension | Score | Target | Evidence | Needed Next |
|
||||
| --- | ---: | ---: | --- | --- |
|
||||
| Intent and boundaries | 4.4 | 5.0 | `INTENT.md`, `SCOPE.md`, `README.md`, architecture docs, adjacent-repo boundary docs | Keep docs current as live adapters and service bindings clarify real ownership. |
|
||||
| Package and API foundation | 4.6 | 4.8 | Python package, public exports, runtime facade, CLI, service runner export, service config, dependency-light tests, public API snapshot, release-note template | Add compatibility migration examples from a real release. |
|
||||
| Package and API foundation | 4.7 | 4.8 | Python package, public exports, runtime facade, CLI, service runner export, service config, deployment/troubleshooting helpers, dependency-light tests, public API snapshot, release-note template | Add compatibility migration examples from a real release. |
|
||||
| Markitect profile contract ingress | 3.7 | 4.5 | Profile loading, diagnostics, runtime envelopes, profile-derived config, local alias normalization | Add richer compatibility fixtures and schema drift diagnostics. |
|
||||
| Graph and event ingress | 4.0 | 4.5 | Graph loading, endpoint diagnostics, event model, JSONL log, export, repair checks, corrupt-record diagnostics, fake and live-shaped graph/event adapters | Add broader malformed/large graph fixtures and operator repair utilities. |
|
||||
| Phase domain model | 3.5 | 4.5 | Phases, lifecycle states, actions, paths, retention rules, profile-derived transition rules | Add migration semantics for profile/rule changes over durable stores. |
|
||||
@@ -51,13 +52,13 @@ service packaging is stdlib/local rather than deployed to a managed environment.
|
||||
| Lifecycle planning and apply | 4.1 | 4.5 | Dry-run lifecycle plans, profile rules, review-gated local apply, service `lifecycle.apply`, apply audit/export queries | Add richer apply rollback and repair drills. |
|
||||
| Activation planning | 4.0 | 4.8 | Budgeted activation, selections, package request, graph neighborhoods, paths, ranking, metrics, multi-scenario evaluation fixtures | Wire semantic-index-assisted retrieval into runtime planning. |
|
||||
| Local persistence | 4.0 | 4.5 | File-backed graph store, JSONL event log, audit sink, atomic JSON writes, executable metadata migrations, migration audit, export, repair diagnostics | Add compaction/retention utilities and stronger corruption recovery. |
|
||||
| Policy, review, and audit | 4.4 | 5.0 | Operation points, review records, audit schema, queryable/exportable audit sinks, retention plans and apply, denials, redaction, fake/live-shaped policy/audit adapters | Add live policy adapter boundary and credentialed telemetry pruning drill. |
|
||||
| Observability and operations | 4.3 | 4.8 | Health report, readiness report, config diagnostics, adapter status, service binding, stdlib service entrypoint, operator runbook, fake/live-shaped telemetry audit sinks | Add metrics/event export to external telemetry and managed deployment packaging. |
|
||||
| Markitect interop | 4.1 | 4.5 | Local validation, package request/response envelopes, fake/live-shaped compiler fixtures, credential-gated drill contract | Add credentialed Markitect compiler execution and schema drift suite. |
|
||||
| Kontextual/Infospace interop | 3.9 | 4.5 | Delegation envelope, fake/live-shaped runtime registry, credential-gated drill contract, activation quality report fixture, adapter compatibility manifests | Add credentialed Kontextual execution and broader Infospace restart reports. |
|
||||
| Testing and evaluation | 4.5 | 4.7 | Deterministic tests over runtime, CLI, adapters, policy, activation, lifecycle, service, fakes, live-shaped packs, credential skip gates, API snapshots, evaluation threshold and trend reports | Add larger regression corpus and persisted trend history. |
|
||||
| Service readiness | 4.6 | 4.8 | Service contracts, full local runner parity, framework-neutral service binding, WSGI adapter, stdlib service entrypoint, health/readiness, config, adapter conformance | Add managed deployment packaging. |
|
||||
| Developer experience | 4.5 | 4.7 | README, package map, CLI examples, persistence/policy/interop/service/lifecycle/fake-pack docs, operational recipe, operator runbook, API compatibility docs, release-note template | Add troubleshooting matrix from real operator feedback. |
|
||||
| Policy, review, and audit | 4.5 | 5.0 | Operation points, review records, audit schema, queryable/exportable audit sinks, retention plans and apply, denials, redaction, fake/live-shaped policy/audit adapters, credential-safe telemetry retention drill | Add live policy adapter boundary and external telemetry pruning evidence. |
|
||||
| Observability and operations | 4.5 | 4.8 | Health report, readiness report, config diagnostics, adapter status, service binding, stdlib service entrypoint, managed deployment manifest validation, operator runbook, fake/live-shaped telemetry audit sinks | Pilot the managed package in an operator deployment target. |
|
||||
| Markitect interop | 4.2 | 4.5 | Local validation, package request/response envelopes, fake/live-shaped compiler fixtures, credential-gated drill contract, redacted operator reports | Add credentialed Markitect compiler execution and schema drift suite. |
|
||||
| Kontextual/Infospace interop | 4.0 | 4.5 | Delegation envelope, fake/live-shaped runtime registry, credential-gated drill contract, redacted operator reports, activation quality report fixture, adapter compatibility manifests | Add credentialed Kontextual execution and broader Infospace restart reports. |
|
||||
| Testing and evaluation | 4.6 | 4.7 | Deterministic tests over runtime, CLI, adapters, policy, activation, lifecycle, service, fakes, live-shaped packs, credential skip gates, API snapshots, evaluation threshold/trend reports, persisted trend history | Add larger regression corpus and make trend history a release gate. |
|
||||
| Service readiness | 4.7 | 4.8 | Service contracts, full local runner parity, framework-neutral service binding, WSGI adapter, stdlib service entrypoint, health/readiness, config, adapter conformance, managed deployment manifest validation | Pilot managed deployment packaging on the target platform. |
|
||||
| Developer experience | 4.6 | 4.7 | README, package map, CLI examples, persistence/policy/interop/service/lifecycle/fake-pack docs, operational recipe, operator runbook, API compatibility docs, release-note template, troubleshooting matrix | Refine troubleshooting from real operator feedback. |
|
||||
|
||||
## Assessment
|
||||
|
||||
@@ -68,9 +69,10 @@ and live-shaped external pack manifests, credential-gated drills, service
|
||||
binding and stdlib entrypoint, API snapshots, release discipline, and
|
||||
conformance helpers form a solid integration boundary.
|
||||
|
||||
The biggest optimization opportunity is now the next operational layer:
|
||||
running the credential-gated drills against real services, adding managed
|
||||
deployment packaging, and growing evaluation trends into a historical corpus.
|
||||
The biggest optimization opportunity is now evidence, not scaffolding:
|
||||
run the credentialed reports against real services, pilot the managed manifest
|
||||
on a target platform, and make persisted trend history part of the operator
|
||||
release gate.
|
||||
|
||||
## Completed Refinement Workplan
|
||||
|
||||
@@ -108,19 +110,30 @@ deployment packaging, and growing evaluation trends into a historical corpus.
|
||||
- evaluation trend artifacts with threshold and regression deltas;
|
||||
- release-note template gating for public API snapshot changes.
|
||||
|
||||
`PMEM-WP-0014` moved the score from 4.3 to 4.4 by adding:
|
||||
|
||||
- credential-safe operator reports with token and endpoint redaction;
|
||||
- credentialed telemetry retention drill coverage through live-shaped or
|
||||
operator-approved fixture paths;
|
||||
- managed deployment manifest generation and validation for service entrypoint,
|
||||
probes, rollback, replicas, and local-store mounts;
|
||||
- deterministic persisted evaluation trend history;
|
||||
- operator troubleshooting matrix coverage for credential, readiness,
|
||||
migration, audit retention, and adapter-manifest failures.
|
||||
|
||||
## Recommended Next Refinement
|
||||
|
||||
Create and execute `PMEM-WP-0014`: live credential execution and managed
|
||||
deployment hardening.
|
||||
Create and execute `PMEM-WP-0015`: credentialed live pilot and deployment
|
||||
evidence.
|
||||
|
||||
Highest-value tasks:
|
||||
|
||||
- Run the credential-gated drills against real Markitect/Kontextual endpoints
|
||||
in an operator environment.
|
||||
- Add managed deployment packaging and readiness probes.
|
||||
- Persist evaluation trend reports across runs.
|
||||
- Add credentialed telemetry export and retention pruning drills.
|
||||
- Expand troubleshooting from actual operator feedback.
|
||||
- Run the redacted credentialed report against real Markitect/Kontextual
|
||||
endpoints in an operator environment.
|
||||
- Pilot the managed deployment manifest on the target platform.
|
||||
- Capture external telemetry retention evidence.
|
||||
- Promote trend history into a release/regression gate.
|
||||
- Refine troubleshooting from actual operator feedback.
|
||||
|
||||
## Score Movement Gates
|
||||
|
||||
@@ -139,6 +152,15 @@ Achieved overall score **4.3+** when:
|
||||
- Operational docs include deployable service packaging and an operator
|
||||
readiness runbook.
|
||||
|
||||
Achieved overall score **4.4+** when:
|
||||
|
||||
- Credentialed operator report artifacts redact credential values and endpoint
|
||||
URLs.
|
||||
- Managed deployment manifest validation covers service entrypoint, probes,
|
||||
rollback, replicas, and store mounts.
|
||||
- Evaluation trend artifacts can be persisted into deterministic history.
|
||||
- Troubleshooting docs map common operator diagnostics to actions.
|
||||
|
||||
Move overall score to **4.7+** only when:
|
||||
|
||||
- Live adapter behavior, telemetry, audit retention, migration, and evaluation
|
||||
|
||||
@@ -130,6 +130,72 @@ python3 -m pytest tests/test_credentialed_drills.py
|
||||
The report redacts tokens and uses a credential fingerprint rather than
|
||||
persisting secrets.
|
||||
|
||||
Persist a redacted operator report from the same environment:
|
||||
|
||||
```python
|
||||
from phase_memory import write_credentialed_operator_report
|
||||
|
||||
write_credentialed_operator_report("reports/credentialed-operator-report.json")
|
||||
```
|
||||
|
||||
Run the credentialed telemetry retention drill when an operator has approved
|
||||
using the local fixture path or the required credentials are present:
|
||||
|
||||
```python
|
||||
from phase_memory import credentialed_telemetry_retention_drill
|
||||
|
||||
report = credentialed_telemetry_retention_drill(operator_approved_fixture=True)
|
||||
```
|
||||
|
||||
The drill records old and new audit events, plans retention, applies pruning,
|
||||
and reports retained/pruned operation ids without storing credential values.
|
||||
|
||||
## Managed Deployment Manifest
|
||||
|
||||
Build and validate a deployment manifest before handing it to platform-specific
|
||||
packaging:
|
||||
|
||||
```python
|
||||
from phase_memory import managed_deployment_manifest, validate_managed_deployment_manifest
|
||||
from phase_memory import ServiceAppConfig
|
||||
|
||||
manifest = managed_deployment_manifest(
|
||||
ServiceAppConfig(host="0.0.0.0", port=8080, local_store_path="/var/lib/phase-memory")
|
||||
)
|
||||
validation = validate_managed_deployment_manifest(manifest)
|
||||
```
|
||||
|
||||
Required manifest features:
|
||||
|
||||
- `phase-memory-service` command entrypoint;
|
||||
- `/health` liveness probe;
|
||||
- `/ready` readiness probe;
|
||||
- writable local-store mount;
|
||||
- rollback checks that include `phase-memory-service --check` and
|
||||
`runtime.repair_diagnostics`.
|
||||
|
||||
## Evaluation Trend History
|
||||
|
||||
Persist trend artifacts into a history file after evaluation runs:
|
||||
|
||||
```python
|
||||
from phase_memory import write_evaluation_trend_history
|
||||
|
||||
history = write_evaluation_trend_history("reports/evaluation-trend-history.json", trend)
|
||||
```
|
||||
|
||||
Repeated writes of the same trend id do not duplicate the run.
|
||||
|
||||
## Troubleshooting Matrix
|
||||
|
||||
| Category | Diagnostic | Operator action |
|
||||
| --- | --- | --- |
|
||||
| Credentials | `credential_env_missing` | Set the four credential environment variables in the drill shell; do not write them to files. |
|
||||
| Readiness | `unsupported_operation` | Run service contract and public API snapshot tests, then update dispatch or release notes. |
|
||||
| Migrations | `store_migration_unsupported` | Use a file-backed local store or run repair diagnostics before accepting traffic. |
|
||||
| Audit retention | `audit_retention_apply_unsupported` | Switch to a JSONL or telemetry audit sink with retention support, then rerun the retention drill. |
|
||||
| Adapter manifest | `adapter_pack_manifest_invalid` | Regenerate and validate the adapter pack manifest before using the pack. |
|
||||
|
||||
## Compatibility Release Discipline
|
||||
|
||||
When public exports or service operations change:
|
||||
|
||||
Reference in New Issue
Block a user