Roadmap¶
What is built, what is being built, and what is planned. This page is deliberately conservative: a feature appears under Completed only when it works end-to-end on a real host.
Completed¶
Installation and lifecycle¶
- Platform installer (
docksight install) — validate, download, extract, configure, start, verify - GitHub Release-based distribution with kind-based asset discovery
- Docker Compose orchestration with health-aware readiness checks
- Credential generation with
crypto/rand, preserved across reinstalls - CLI self-installation via atomic binary replacement
- Independent CLI and platform updates (
docksight update) - Version pinning and rollback (
--version) - Install state recorded in
state.json - Idempotent installs — re-running is the supported upgrade path
Agent¶
- Agent installer (
docksight agent install) — six phases - systemd service generation, enable and start
- Platform URL normalization (
https://host→wss://host/agents) - Durable identity, preserved across upgrades and reinstalls
- YAML configuration with defaults
- Docker socket detection, Unix socket and Windows named pipe
- Installation verification: liveness, crash-loop detection, journal inspection for connection evidence
- Agent updates with version pinning (
docksight agent update)
Protocol and runtime¶
- WebSocket transport with a single message envelope
- Agent registration and upsert by UUID
- 30-second heartbeat
- Automatic reconnection with re-registration
- Container discovery (
container.list/listed) - Container inspection (
container.inspect/inspected) - Container lifecycle: start, stop, restart, with correlated results
- Container log streaming with batched chunks and subscription control
Release engineering¶
- Reproducible multi-target build script
- Publish script with post-upload verification against the GitHub API
- Strict separation of CLI, platform bundle and agent artifacts
- Backward-compatible discovery of legacy bundle names
Security and robustness¶
- Path-traversal-guarded archive extraction
- Atomic writes for binaries,
.envand state files - Restrictive file modes for credentials
- Real host validation that fails before touching the host
In progress¶
-
docksight status— currently a placeholder printing a fixed string; should report real service health - Agent service commands —
start,stop,restart,status,logs,configare declared but return "not implemented yet". The underlyingsystemdpackage already supports all of them -
docksight agent uninstall— clean removal of binary, config, unit, with an explicit choice about identity - CI release workflow — a GitHub Actions job on tag push running build and publish, removing the manual-upload failure mode
- Optional CLI installation on agent hosts — so
docksight agent updateworks without keeping the downloaded binary
Planned¶
Monitoring¶
Metrics collection is scaffolded on the platform side and reserved in the
protocol (metrics.subscribe, metrics.sample), but no agent implementation
exists.
- CPU usage — host and per container
- Memory usage and limits
- Disk usage and I/O
- Network throughput per container
- Historical retention and time-series storage
- Alert thresholds
Containers¶
execinto a running container- Interactive terminal in the dashboard
- Image management — list, pull, remove, prune
- Network management — list, inspect, connect
- Volume management — list, inspect, prune
- Container creation and editing from the dashboard
- Docker Compose stack awareness
Agent¶
- Automatic self-update on a schedule or platform instruction
- Exponential backoff with jitter for reconnection, replacing the fixed 5s delay
- Self-reported health beyond heartbeat
- Plugin system for custom collectors
- Resource limits for the agent process
- Windows service support (the binary already builds; the installer does not)
Platform¶
- Authentication for agents — token issuance and verification. The single most important item on this list; see Security
- User authentication and sessions
- Organizations and multi-tenancy
- Role-based access control
- Notifications — email, webhooks
- Audit logs for every command sent to a host
- Host grouping, tagging and environments
- Backup and restore for platform state
Kubernetes¶
Explicitly out of scope for the core product today. If demand justifies it, the agent model extends naturally:
- Cluster connections
- Node inspection
- Pod listing and logs
- Deployment inspection
Integrations¶
- Prometheus — expose metrics in the standard exposition format
- Grafana — dashboards for DockSight-collected data
- Loki — ship container logs
- OpenTelemetry — traces and metrics export
- Slack — alerts and notifications
- Discord — alerts and notifications
Design commitments¶
Some things will not change, and knowing that helps you plan around them:
- Agents will always connect outbound. Every feature must work for a host behind NAT with no inbound ports.
- The message envelope is stable. New capability arrives as new
typevalues, not a new wire format. - The three artifacts stay independent. No feature will require lockstep upgrades of CLI, platform and agent.
- Installers stay idempotent. Re-running any install command remains safe.
- Docker remains the focus. Kubernetes support, if it ever lands, will be additive rather than a rewrite.
Influencing the roadmap¶
Open an issue describing the problem you have, not only the feature you want — the problem often has a cheaper solution than the proposed feature. See Contributing.