Add final runtime and systemd documentation
This commit is contained in:
parent
88e5b83f1e
commit
5259fec3b8
28
README.txt
28
README.txt
|
|
@ -7,13 +7,31 @@ Includes:
|
|||
- runtime/dev dependency manifests
|
||||
- systemd service example
|
||||
- sysusers.d and tmpfiles.d examples
|
||||
- bootstrap skeleton for app.main
|
||||
- loader skeleton for multi-YAML config
|
||||
- minimal smoke tests
|
||||
- backend runtime wiring for event and command contours
|
||||
- CLI entrypoints for event and command submission/cancellation
|
||||
- multi-YAML config loader and bootstrap logic
|
||||
- smoke, unit, and integration tests
|
||||
|
||||
Runtime layout:
|
||||
- backend service entrypoint: `python -m app.main`
|
||||
- CLI entrypoint: `python -m app.cli`
|
||||
- default root config: `/etc/wf-agent/app.yaml`
|
||||
- event config includes: `/etc/wf-agent/events.yaml`
|
||||
- command config includes: `/etc/wf-agent/commands.yaml`
|
||||
- command executor includes: `/etc/wf-agent/executors/*.yaml`
|
||||
- cron includes: `/etc/wf-agent/cron.yaml`
|
||||
|
||||
Typical workflow:
|
||||
1. Install deps
|
||||
2. Generate protobuf bindings
|
||||
3. Load /etc/wf-agent/app.yaml as root config
|
||||
3. Load `/etc/wf-agent/app.yaml` as root config
|
||||
4. Run tests
|
||||
5. Extend bootstrap into full runtime
|
||||
5. Start the backend service under systemd
|
||||
6. Use the CLI to subscribe to events or submit/cancel commands
|
||||
|
||||
Systemd notes:
|
||||
- the unit template is `deploy/systemd/wf-agent.service`
|
||||
- the service runs as `wifi-agent:wifi-agent`
|
||||
- runtime state is stored under `/var/lib/wf-agent`
|
||||
- runtime sockets and transient state live under `/run/wf-agent`
|
||||
- logs are journal-first, with `/var/log/wf-agent` reserved for file-backed output
|
||||
|
|
|
|||
|
|
@ -18,6 +18,13 @@ This directory captures the Linux deployment baseline for `wf-agent`.
|
|||
- `sysusers.d/wf-agent.conf` - user/group definition
|
||||
- `tmpfiles.d/wf-agent.conf` - runtime and state directory layout
|
||||
|
||||
## Runtime entrypoints
|
||||
|
||||
- backend service: `python -m app.main`
|
||||
- CLI: `python -m app.cli`
|
||||
- backend bootstrap loads both event and command contours from `/etc/wf-agent/app.yaml`
|
||||
- CLI reads the same root config and resolves websocket bridge URIs from the `event.bridge` and `commands.bridge` sections
|
||||
|
||||
## Install notes
|
||||
|
||||
1. Install the application package and its runtime dependencies.
|
||||
|
|
@ -41,3 +48,5 @@ This directory captures the Linux deployment baseline for `wf-agent`.
|
|||
- The template supports a journald-first logging policy while also reserving `/var/log/wf-agent` for file-backed logs when needed.
|
||||
- Backend bootstrap loads both `events:` and `commands:` sections when present.
|
||||
- Command contour settings come from `etc/wf-agent/commands.yaml`, executor discovery from `etc/wf-agent/executors/*.yaml`, and cron jobs from `etc/wf-agent/cron.yaml`.
|
||||
- Event contour settings come from `etc/wf-agent/events.yaml`.
|
||||
- The CLI uses the same config layout for local submissions, subscriptions, and cancellation flows.
|
||||
|
|
|
|||
Loading…
Reference in New Issue