Roadmap
OSAPI aims to be a comprehensive Linux system management API. This page documents what exists today and where the project is headed, organized by priority tier.
Current Capabilities
These features are implemented and available today. See Features for detailed documentation on each.
- System Management — hostname, status, uptime, OS info, disk, memory, load
- Network Management — DNS get/update, ping
- Job System — async job processing via NATS JetStream with KV-first architecture, broadcast/load-balanced/label-based routing
- Health Checks — liveness, readiness, system status with component metrics
- Audit Logging — structured API operation audit trail stored in NATS KV with 30-day retention, export, admin-only access
- Authentication & RBAC — JWT bearer tokens
with HS256 signing, fine-grained
resource:verbpermissions, built-in roles (admin/write/read), custom roles, and direct permission grants - Metrics — Prometheus endpoint (
/metrics) - Distributed Tracing — OpenTelemetry with stdout and OTLP exporters, trace context propagation across HTTP and NATS
- Namespace support — multi-tenant NATS subject and infrastructure prefixing for shared clusters
- CLI — full parity with the REST API,
--jsonoutput on all commands
Individual task tracking for planned features is in the Task Backlog.
Tier 1 — Core Appliance
The minimum feature set to be taken seriously as an OS management API.
| Feature | Description | Ansible Equivalent |
|---|---|---|
| Service management | systemctl start/stop/restart/enable/disable | service, systemd |
| Package management | Install, remove, update packages | apt, yum, package |
| User/group management | Create, modify, delete users and groups | user, group |
| Power management | Shutdown, reboot (with delay/scheduling) | reboot |
| Hostname set | Set hostname (complement existing get) | hostname |
Tier 2 — Security & Networking
What makes OSAPI production-ready and secure.
| Feature | Description | Ansible Equivalent |
|---|---|---|
| Firewall management | ufw/nftables rule management | ufw, firewalld |
| Network interfaces | IP config, routing, interface up/down | nmcli |
| SSH key management | Authorized key management per user | authorized_key |
| TLS certificates | Certificate install, CSR, CA trust store | openssl_certificate |
| SELinux/AppArmor | Security policy mode and profiles | selinux |
Tier 3 — Operations & Observability
What makes OSAPI useful for day-to-day operations.
| Feature | Description | Ansible Equivalent |
|---|---|---|
| File management | Read, write, lineinfile, permissions | file, copy, lineinfile |
| Command execution | Ad-hoc command/shell execution | command, shell |
| Process management | List, inspect, signal processes | — |
| Log viewing | Query systemd journal and syslog | — |
| NTP/time management | NTP sync, timezone configuration | chrony, timezone |
| System updates | Check and apply OS patches | apt upgrade |
| Sysctl/kernel params | Query and tune kernel parameters | sysctl |
Tier 4 — Advanced
Differentiators for fleet management and enterprise use.
| Feature | Description | Ansible Equivalent |
|---|---|---|
| System facts/inventory | Comprehensive hardware/OS/network facts | setup |
| Storage management | LVM, mounts, SMART health | lvol, mount |
| Cron/scheduling | Scheduled task management | cron |
Implementation Pattern
Each new feature follows the same architecture:
- Provider interface + platform implementations
- Job operation types and subject routing
- Worker processor dispatch
- Job client methods
- OpenAPI spec with strict-server + BearerAuth
- API handler with scope middleware
- CLI commands with
--jsonoutput - Tests (provider, client, handler, integration)
See Architecture for the system overview, and Job Architecture for the provider and worker pipeline.
Contributing
Want to pick up a feature from the roadmap? Start with the Contributing guide, then:
- Open an issue or discussion to claim the feature
- Follow the implementation pattern above
- Submit a PR with tests and documentation
Lower-tier features are higher priority, but contributions at any tier are welcome.