registrystack / registrystack/registry-stack

Make every governed deployment verification example copy-paste strict

Open
#604 1 comment 0 reactions 0 assignees View on GitHub
area:platform needs-jeremi-decision
Dominant language
Rust
Stars
2
Forks
0
Avg merge
2h 57m
Merged PRs (30d)
128

Description

## Outcome

Every public convenience example for verifying a managed deployment package includes the externally recorded closure digest and structural operator-file checks, matching the generated runbook.

## Context

PR #598 makes transferred-package and lifecycle instructions strict. Two convenience examples in the single-node Compose guide remain intentionally shorter and are not on the critical update path, but copying them alone provides weaker assurance.

## Definition of Done

- [ ] Every managed-package verification example uses `--expected-closure-sha256`.
- [ ] Every operator-ready verification example uses `--check-operator-files`.
- [ ] Examples show where the externally recorded digest comes from without inventing a secret/config generator.
- [ ] Docs tests prevent weaker commands from reappearing outside explicitly labelled structural-only examples.

## Non-goals

- Semantic validation of operator file values in Registryctl.
- Certification of operator-owned Compose overrides.
- A general secret-management workflow.

Contributor guide

Open the contributing guide

Research direction

Start with the single-node Compose guide and compare its managed-package and operator-ready verification examples with the generated runbook from PR #598. Trace how the externally recorded closure digest is presented, then inspect the docs tests and extend their coverage so weaker commands are rejected except in explicitly labelled structural-only examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker-compose
Domain
devops, documentation, testing
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.