generated from coulomb/repo-seed
docs: align architecture and scope with AccessManagementDirective
Expands architecture constraints and SCOPE.md to reflect the three-actor vocabulary (adm/agt/atm), two credential modes (static key + cert_command), and ops-warden boundary. Adds directive wiki doc and two new workplans (BRIDGE-WP-0004 directive alignment, WARDEN-WP-0001 ops-warden bootstrap). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
48
SCOPE.md
48
SCOPE.md
@@ -8,7 +8,7 @@
|
||||
|
||||
## One-liner
|
||||
|
||||
SSH reverse tunnel lifecycle manager — keeps remote execution environments continuously connected to the local Custodian State Hub via auto-reconnecting port-forwards.
|
||||
SSH reverse tunnel lifecycle manager — keeps remote execution environments continuously connected to the local Custodian State Hub via auto-reconnecting port-forwards. Supports both static SSH keys (no TTL) and CA-signed short-lived certificates via a pluggable `cert_command` interface.
|
||||
|
||||
---
|
||||
|
||||
@@ -20,11 +20,17 @@ Claude Code sessions run locally; the Custodian State Hub API runs locally. Remo
|
||||
|
||||
## In Scope
|
||||
|
||||
- Named SSH reverse tunnel lifecycle (`bridge up/down/restart/status/logs`)
|
||||
- Named SSH reverse tunnel lifecycle (`bridge up/down/restart/status/logs/cert-status`)
|
||||
- Auto-reconnect with exponential backoff and configurable retry policy
|
||||
- Optional HTTP health checks (confirm forwarded service is actually reachable from remote)
|
||||
- Structured audit logging: JSON events (connected, disconnected, health_check_failed, etc.)
|
||||
- Actor attribution: per-tunnel actor class (human / automation) for audit traceability
|
||||
- Actor attribution: per-tunnel actor type (`adm` / `agt` / `atm`) for audit traceability,
|
||||
with naming convention enforcement (`adm-*`, `agt-*`, `atm-*`)
|
||||
- **Static key mode** (default): `ssh_key` passed directly to SSH — no TTL, no cert logic,
|
||||
works without any CA or external tooling
|
||||
- **cert_command mode** (optional): pluggable shell command that issues a short-lived
|
||||
CA-signed certificate before each SSH launch; TTL-aware pre-emptive cert refresh;
|
||||
`cert_identity` recorded in audit log — satisfies AccessManagementDirective §5
|
||||
- PID + state file management in `~/.local/state/bridge/`
|
||||
- MCP server exposing tunnel lifecycle + OpsCatalog queries as Claude Code tools
|
||||
- OpsCatalog: optional Git-backed YAML catalog of infrastructure topology (domains/targets/bridges)
|
||||
@@ -33,7 +39,10 @@ Claude Code sessions run locally; the Custodian State Hub API runs locally. Remo
|
||||
|
||||
## Out of Scope
|
||||
|
||||
- Identity/credential management (uses existing SSH keys)
|
||||
- Credential issuance and CA management (owned by `ops-warden`; ops-bridge consumes
|
||||
certs via the `cert_command` interface but never signs anything itself)
|
||||
- SSH key generation for human admins (self-service: `ssh-keygen`)
|
||||
- Host-side principal deployment (`/etc/ssh/auth_principals/`) — that is `railiance-infra`
|
||||
- Long-running application hosting on remote machines (port-forward only, not deployment)
|
||||
- VPN or layer-3 connectivity
|
||||
- Monitoring/alerting beyond JSON audit logs
|
||||
@@ -44,9 +53,11 @@ Claude Code sessions run locally; the Custodian State Hub API runs locally. Remo
|
||||
## Relevant When
|
||||
|
||||
- Remote Temporal workers or Railiance nodes need to reach the local Custodian MCP
|
||||
- Need audit trail of which actor (human vs. automation) started/stopped tunnels
|
||||
- Need audit trail of which actor (`adm` / `agt` / `atm`) started/stopped tunnels
|
||||
- Setting up a new machine in the Railiance ecosystem that must phone home to the hub
|
||||
- Diagnosing connectivity issues between local hub and remote services
|
||||
- Checking certificate validity for active tunnels (`bridge cert-status`)
|
||||
- Integrating with a CA (ops-warden or Vault) for short-lived tunnel credentials
|
||||
|
||||
---
|
||||
|
||||
@@ -60,8 +71,10 @@ Claude Code sessions run locally; the Custodian State Hub API runs locally. Remo
|
||||
|
||||
## Current State
|
||||
|
||||
- Status: experimental → active (v0.1 core complete; OpsCatalog planned but not yet shipped)
|
||||
- Implementation: ~75% — CLI tunneling fully functional, MCP integration working, health checks and audit logging complete; OpsCatalog framework present but not populated
|
||||
- Status: active (v0.1 core complete; directive alignment in progress — BRIDGE-WP-0004)
|
||||
- Implementation: ~75% — CLI tunneling fully functional, MCP integration working, health
|
||||
checks and audit logging complete; OpsCatalog framework present but not populated;
|
||||
cert_command / ActorType alignment not yet implemented
|
||||
- Stability: stable tunnel lifecycle; tested under network drops and SSH failures
|
||||
- Usage: running in lab for daily Railiance/Temporal connectivity
|
||||
|
||||
@@ -77,17 +90,24 @@ Claude Code sessions run locally; the Custodian State Hub API runs locally. Remo
|
||||
|
||||
## Terminology
|
||||
|
||||
- Preferred terms: tunnel, bridge, actor, actor_class, reconnect policy, health check
|
||||
- Preferred terms: tunnel, bridge, actor, actor_type, reconnect policy, health check,
|
||||
cert_command, cert_identity
|
||||
- Actor types: `adm` (human operator), `agt` (LLM agent), `atm` (deterministic automation)
|
||||
- Also known as: "the bridge"
|
||||
- Potentially confusing terms: "bridge state" is a tunnel-specific state machine (stopped → starting → connected ↔ degraded → reconnecting), not a network bridge
|
||||
- Potentially confusing: "bridge state" is a tunnel-specific state machine
|
||||
(stopped → starting → connected ↔ degraded → reconnecting), not a network bridge
|
||||
- Legacy terms (deprecated): `actor_class: human` (→ `adm`), `actor_class: automation` (→ `atm`)
|
||||
|
||||
---
|
||||
|
||||
## Related / Overlapping Repositories
|
||||
|
||||
- `the-custodian` — primary consumer; ops-bridge keeps remote agents connected to it
|
||||
- `ops-warden` — optional upstream; owns CA and cert issuance; ops-bridge calls it via
|
||||
`cert_command` when short-lived certificates are required
|
||||
- `activity-core` — Temporal server on remote reached via ops-bridge tunnel
|
||||
- `railiance-cluster` / `railiance-infra` — remote hosts that need to phone home
|
||||
- `railiance-cluster` / `railiance-infra` — remote hosts that need to phone home; owns
|
||||
host-side principal deployment (`/etc/ssh/auth_principals/`)
|
||||
|
||||
---
|
||||
|
||||
@@ -105,5 +125,9 @@ keywords: [ssh, tunnel, reverse-tunnel, connectivity, remote, bridge, ops-bridge
|
||||
## Getting Oriented
|
||||
|
||||
- Start with: `README.txt` (architecture, config format, CLI commands, MCP integration)
|
||||
- Key files / directories: `~/.config/bridge/tunnels.yaml` (tunnel config), `~/.local/state/bridge/` (PID/state files)
|
||||
- Entry points: `bridge --help`; `bridge up <tunnel-name>`; MCP: `bridge_status()`
|
||||
- Key files / directories: `~/.config/bridge/tunnels.yaml` (tunnel config),
|
||||
`~/.local/state/bridge/` (PID/state/cert files)
|
||||
- Entry points: `bridge --help`; `bridge up <tunnel-name>`; `bridge cert-status`;
|
||||
MCP: `bridge_status()`
|
||||
- AccessManagementDirective context: `wiki/AccessManagementDirective.md`
|
||||
- Workplans: BRIDGE-WP-0004 (directive alignment), WARDEN-WP-0001 (ops-warden bootstrap)
|
||||
|
||||
Reference in New Issue
Block a user