Skip to content
GETTING STARTED / FIELD NOTE

Product walkthrough

SCOUT DOCS · GETTING-STARTED / WALKTHROUGH

This is the production-command sequence asserted by tests/walkthrough/run-redesign-walkthrough.sh. Use release paths, endpoints, and contexts for your hosts. Capture VILNIUS_BRANCH_ID, AREA_ID, CLIENT_ID, CHANGE_ID, and ROOT_BRANCH_ID from the preceding JSON evidence (add-branch reports the new Branch identifier; scout --context vilnius branch show reprints it).

Terminal window
scout run bootstrap-network release_root=/opt/scout root_state=/var/lib/scout/root root_bind=127.0.0.1 root_router_listen=tls/0.0.0.0:7436 root_router_advertise=tls/root.example:7436
scout run add-branch parent_context=root branch_name=vilnius description='Vilnius Branch' owned_prefix=scout/vilnius activation_file=/tmp/vilnius.handoff child_state=/var/lib/scout/vilnius release_root=/opt/scout child_bind=127.0.0.1 port_offset=8 child_router_listen=tls/0.0.0.0:7444 child_router_advertise=tls/vilnius.example:7444
scout --context vilnius area add --name weather --key 'scout/vilnius/weather/**' --branch $VILNIUS_BRANCH_ID
scout run connect-client branch_context=vilnius client_name=weather-sensor action=publish area=$AREA_ID
scout --context vilnius grant explain --client weather-sensor --key scout/vilnius/weather/sample --action publish
scout --context vilnius grant allow $CLIENT_ID subscribe $AREA_ID
scout --context vilnius change review $CHANGE_ID
scout --context vilnius change stage $CHANGE_ID
scout --context vilnius change apply $CHANGE_ID
scout --context vilnius grant allow $ROOT_BRANCH_ID subscribe $AREA_ID
scout --context root tree --descendants
scout --context vilnius status
scout dashboard --state-dir /var/lib/scout/root

The connect-client recipe registers and authenticates the Client, prepares its publish Grant, applies the resulting Change, and verifies both records. The additional subscribe Grant above demonstrates the explicit review → stage → apply lifecycle. The direct-parent Branch Grant is a direct-peer crossing and honestly prepares no Change.

The automated walkthrough requires all of these observations:

  • one root and one child Branch are visible through current tree evidence;
  • the Client record and its authenticated identity are current;
  • Grant explanation reports the publish key as allowed;
  • allowed traffic arrives and a denied neighboring key stays silent;
  • the dashboard process remains available;
  • after the parent controller stops, the child says Operating locally;
  • after the parent returns, current tree evidence shows reconciliation.

A command failure never advances the recipe. Correct the named cause and run scout run --resume; completed effects remain bounded by their recorded command evidence.