daemon

Olares System Daemon (olaresd)

olaresd is the foundational process that boots on every Olares node. It runs as a systemd service on port 18088, exposing a secure REST API for hardware abstraction, network orchestration, storage management, and turnkey cluster operations—all before Kubernetes starts.

Olaresd is installed as a systemd service in /etc/systemd/system/olaresd.service.

Key features

• System monitoring: Continuous health checks of cluster and node status.
• Cluster lifecycle management: Automated install, upgrade, IP-switching, restart, and maintenance operations.
• Hardware Abstraction: USB auto-mounting, storage provisioning, and management.
• Network Management: mDNS service discovery, WiFi onboarding, and network interface control.

REST API reference

The daemon provides an authenticated REST API (using signature-based auth):

Base URL: http://<node-ip>:18088

System commands /command/

Lifecycle operations

Network configuration

Storage management

System Maintenance

System information (/system/)

System status

Mount information

Cluster-wide mounts

Container management (/containerd/)

Registry Management

Image Management

Build from source

Prerequisites

• Go 1.24+
• GoReleaser (Optional, for creating release artifacts)

Steps

1. Navigate to the daemon directory:

   cd daemon
   

2. Build for your host OS/architecture:

   go build -o olaresd ./cmd/olaresd/main.go
   

3. Cross-compile for another target (e.g., Linux AMD64):

   GOOS=linux GOARCH=amd64 go build -o olaresd ./cmd/olaresd/main.go
   

4. Produce release artifacts (optional):

   goreleaser release --snapshot --clean
   

Extend olaresd

To add a new command API:

1. Define command: Add a new command struct in pkg/commands/.
2. Implement handler: Create the corresponding HTTP handler logic in internal/apiserver/handlers/.
3. Register route: Register the new API route in internal/apiserver/server.go.
4. Update state: If the command modifies the cluster's state, ensure you update the logic in pkg/cluster/state/.
5. Validate: Run go vet ./... && go test ./... to check for issues and ensure all tests pass before opening a pull request.

Test a custom build

1. Copy the binary to your Olares node.

2. On the node, replace the existing binary:

   # Move the new binary into place
   sudo cp -f /tmp/olaresd /usr/local/bin/
   
   

3. Restart the daemon to apply changes:

   sudo systemctl restart olaresd