Files
skyg-linux-tracker/plan/workstreams/P3-integration.md
T
2026-10-15 17:07:03 -04:00

3.2 KiB
Raw Blame History

P3 — Integration & hardening

Field Value
Status Backlog
Owner —
Phase 3 (single track)
Depends on WS-E, WS-F, WS-G (and transitively A–D)
Blocks Release
Owned files src/main.rs (serve wiring), systemd/skyg-linux-tracker.service, README.md, tests/

Goal

Wire every surface into one axum server, prove the negative paths, and ship the unit file and docs. This is the only place the surfaces meet.

Tasks

Tick these in TODO.md.

  • I1 slinuxm serve wiring in main.rs:
    1. Load config, then telemetry::init, then db::open when auth is enabled, then construct sources and AppState.
    2. Build the protected router: .nest("/api/v1", api::router(state)) and .nest_service("/mcp", mcp::service(state)), then .layer(auth::layer(state)).
    3. Build the public router with /healthz.
    4. public.merge(protected).layer(TraceLayer::new_for_http()) (review R3).
    5. Spawn the metrics and log export tasks when enabled.
    6. On SIGINT or SIGTERM: cancel state.shutdown so SSE streams and background tasks end, run axum::serve(...).with_graceful_shutdown, then drop the telemetry guard to flush OTel (review G3).
  • I2 Integration tests in tests/ covering Verification #6:
    • A missing or invalid token gets 401 on /api/v1/* and /mcp. /healthz returns 200 without a token.
    • auth.enabled = false with bind = 0.0.0.0 makes startup exit non-zero with a clear message.
    • A missing Docker socket gives 503 on docker routes while systemd routes still return 200.
    • SIGTERM with an open SSE client exits within a few seconds.
  • I3 systemd/skyg-linux-tracker.service:
    • ExecStart=/usr/local/bin/slinuxm serve --config /etc/skyg-linux-tracker.toml
    • A dedicated User= (for example skyg), or DynamicUser=yes if the token CLI story still works. Decide and note it.
    • StateDirectory=skyg-linux-tracker, StateDirectoryMode=0700
    • ProtectSystem=strict, ProtectHome=yes, PrivateTmp=yes, NoNewPrivileges=yes, ProtectKernelTunables=yes, ProtectControlGroups=yes, RestrictAddressFamilies=AF_UNIX AF_INET AF_INET6, LockPersonality=yes, MemoryDenyWriteExecute=yes
    • SupplementaryGroups=systemd-journal. Add docker commented out with a root-equivalence warning (DEC-6).
  • I4 README.md:
    • What it is and how to build it (devenv shell, cargo build --release).
    • Install: binary, config, unit file.
    • Config reference, or a pointer to config.example.toml and the env-var naming.
    • Token workflow: sudo -u skyg slinuxm token create <name>.
    • REST endpoint list, and MCP client setup with a bearer header example.
    • OTel setup and the hardened Docker socket-proxy option.
  • I5 Release build checks:
    • cargo build --release.
    • ldd target/release/slinuxm lists only libc, libsystemd and libsystemd's own deps.
    • Record the binary size in the log.
  • I6 Run Verification #1–#6 from plan.md by hand on a real systemd + Docker host and record the results in the log.

Done when

  • I2 tests pass in cargo test.
  • I6 results are logged with all six checks passing.
  • The unit file starts the service on a clean host with only the binary, config and unit installed.

Log

  • 2026-10-15: Card created.