README
¶
OS API
(OSAPI /ˈoʊsɑːpi/ - Oh-sah-pee) A CRUD API for managing Linux systems.
This project provides basic management capabilities to Linux systems, enabling them to be used as appliances.
Documentation
Architecture | Getting Started | API | Usage
License
The MIT License.
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmd provides CLI commands for OSAPI.
|
Package cmd provides CLI commands for OSAPI. |
|
internal
|
|
|
api
Package api provides the REST API server and handler registration.
|
Package api provides the REST API server and handler registration. |
|
api/common/gen
Package gen provides primitives to interact with the openapi HTTP API.
|
Package gen provides primitives to interact with the openapi HTTP API. |
|
api/health
Package health provides health check API handlers.
|
Package health provides health check API handlers. |
|
api/health/gen
Package gen contains generated code for the health API.
|
Package gen contains generated code for the health API. |
|
api/job
Package job provides job queue API handlers.
|
Package job provides job queue API handlers. |
|
api/job/gen
Package gen contains generated code for the job API.
|
Package gen contains generated code for the job API. |
|
api/metrics
Package metrics provides the Prometheus metrics endpoint handler.
|
Package metrics provides the Prometheus metrics endpoint handler. |
|
api/network
Package network provides network-related API handlers.
|
Package network provides network-related API handlers. |
|
api/network/gen
Package gen contains generated code for the network API.
|
Package gen contains generated code for the network API. |
|
api/system
Package system provides system-related API handlers.
|
Package system provides system-related API handlers. |
|
api/system/gen
Package gen contains generated code for the system API.
|
Package gen contains generated code for the system API. |
|
authtoken
Package authtoken provides JWT token generation and validation.
|
Package authtoken provides JWT token generation and validation. |
|
client
Package client provides the HTTP client for the OSAPI REST API.
|
Package client provides the HTTP client for the OSAPI REST API. |
|
client/gen
Package gen provides primitives to interact with the openapi HTTP API.
|
Package gen provides primitives to interact with the openapi HTTP API. |
|
config
Package config provides configuration types and validation for OSAPI.
|
Package config provides configuration types and validation for OSAPI. |
|
exec
Package exec provides command execution utilities.
|
Package exec provides command execution utilities. |
|
exec/mocks
Package mocks provides mock implementations for testing.
|
Package mocks provides mock implementations for testing. |
|
job
Package job provides NATS subject hierarchy for distributed job routing.
|
Package job provides NATS subject hierarchy for distributed job routing. |
|
job/client
Package client provides job client operations for NATS JetStream.
|
Package client provides job client operations for NATS JetStream. |
|
job/mocks
Package mocks provides mock implementations for testing.
|
Package mocks provides mock implementations for testing. |
|
job/worker
Package worker provides the job worker implementation.
|
Package worker provides the job worker implementation. |
|
messaging
Package messaging provides message types for NATS communication.
|
Package messaging provides message types for NATS communication. |
|
provider/network/dns
Package dns provides DNS configuration management.
|
Package dns provides DNS configuration management. |
|
provider/network/dns/mocks
Package mocks provides mock implementations for testing.
|
Package mocks provides mock implementations for testing. |
|
provider/network/ping
Package ping provides network ping functionality.
|
Package ping provides network ping functionality. |
|
provider/network/ping/mocks
Package mocks provides mock implementations for testing.
|
Package mocks provides mock implementations for testing. |
|
provider/system/disk/mocks
Package mocks provides mock implementations for testing.
|
Package mocks provides mock implementations for testing. |
|
provider/system/host
Package host provides system host information.
|
Package host provides system host information. |
|
provider/system/host/mocks
Package mocks provides mock implementations for testing.
|
Package mocks provides mock implementations for testing. |
|
provider/system/load
Package load provides system load average statistics.
|
Package load provides system load average statistics. |
|
provider/system/load/mocks
Package mocks provides mock implementations for testing.
|
Package mocks provides mock implementations for testing. |
|
provider/system/mem
Package mem provides memory usage statistics.
|
Package mem provides memory usage statistics. |
|
provider/system/mem/mocks
Package mocks provides mock implementations for testing.
|
Package mocks provides mock implementations for testing. |
|
telemetry
Package telemetry provides OpenTelemetry tracing initialization and helpers.
|
Package telemetry provides OpenTelemetry tracing initialization and helpers. |
|
validation
Package validation provides a shared validator instance.
|
Package validation provides a shared validator instance. |
Click to show internal directories.
Click to hide internal directories.