Files
sand-boxer/docs/runbooks/profile-compose-e2e.md
tegwick d6d3155792 Implement SAND-WP-0002 meta-framework foundation (T01–T09)
Add meta-framework spec, pydantic schemas, profile/extension YAML, extension
registry, ext.compose-ssh backend, SandboxManager with State Hub events, CLI
commands, integration docs, capability registry entry, and compose-e2e runbook.
Nine unit tests pass. T10 remote smoke test remains for operator.
2026-06-22 23:27:31 +02:00

2.1 KiB

Runbook: profile.compose-e2e

Provision a compose-based e2e sandbox via ext.compose-ssh (e2e-framework lineage).

Prerequisites

Workstation

  • uv, ssh, rsync
  • sand-boxer installed: make setup

Remote host (CoulombCore or sandboxer01)

  • SSH access (SANDBOXER_HOST or --host)
  • Docker + compose plugin
  • Sufficient disk for images
export SANDBOXER_HOST=<ip-or-hostname>    # e.g. coulombcore IP
export SANDBOXER_SSH_USER=root             # optional
export SANDBOXER_SSH_KEY=~/.ssh/id_rsa    # optional

Create

Target repo must contain e2e/e2e.yml (for compose file path) or a docker-compose*.yml at repo root.

sandboxer create \
  --profile profile.compose-e2e \
  --input repo=/path/to/repo \
  --actor adm \
  --project sand-boxer

Confirm state: ready and note reachability.ssh, reachability.remote_dir, and reachability.compose_project.

Manual readiness check

sand-boxer confirms compose services are running (not HTTP health — that is wise-validator's job):

ssh $SANDBOXER_SSH_USER@$SANDBOXER_HOST \
  'docker compose -p <compose_project> -f <remote_dir>/<compose_file> ps'

Destroy

sandboxer destroy <sandbox_id>

Verify cleanup:

ssh $SANDBOXER_SSH_USER@$SANDBOXER_HOST 'docker compose ls'
ssh $SANDBOXER_SSH_USER@$SANDBOXER_HOST 'ls /tmp/sandboxer/'

Compatibility with legacy make e2e

Interim callers in the-custodian should migrate to sand-boxer for provision/teardown only. Test execution remains in wise-validator (SAND-WP-0003).

Legacy sand-boxer
make e2e REPO=foo (full pipeline) sandboxer create + wise-validator run
rsync + compose up ext.compose-ssh provision
compose down + dir removal sandboxer destroy

Troubleshooting

Provision fails — no compose file

Ensure repo has e2e/e2e.yml with compose_file or a root docker-compose*.yml.

Leftover compose projects

ssh $SANDBOXER_HOST 'docker compose -p sbx-e2e-<id> down -v; rm -rf /tmp/sandboxer/<id>'

Skip State Hub events (local debug)

export SANDBOXER_NO_STATE_HUB=1