Managing Systems
This guide covers deploying, managing, archiving, and restoring systems through the Rumi Admin web interface.
Overview
Rumi Admin provides a visual interface for managing the lifecycle of Rumi systems. It communicates with one or more Rumi Agents to perform system operations.
Connecting to Agents
Before managing systems, Rumi Admin must be connected to at least one Rumi Agent:
Default agents are configured in
ecosystem.jsonand loaded automatically at startup.Additional agents can be added, updated, or removed through the Admin UI. Agent registrations are stored in the SQLite database shared with Grafana.
Each agent provides access to the systems it manages. The Admin UI aggregates systems across all connected agents.
Deploying Systems
To deploy a new system:
Navigate to the system management section.
Upload a XAR file through the UI.
Select the target agent to deploy to.
The XAR is uploaded to the Agent's
POST /xars/unpackendpoint, which unpacks it and creates the system.
Once deployed, the system appears in the system list and is available for script execution and lifecycle management.
System Operations
Viewing Systems
The Admin UI displays all systems from all connected agents, showing:
System name.
Available containers and their status.
Available scripts.
Archiving Systems
To archive a system that is no longer actively used:
Select the system.
Choose the archive operation.
The system is moved to the
.archived/directory on the Agent.
Archived systems are retained but no longer active.
Restoring Systems
To restore a previously archived system:
Navigate to the archived systems view.
Select the system to restore.
The system is moved back to the active
systems/directory.
Deleting Systems
To permanently remove a system:
Select the system.
Choose the delete operation.
The system is permanently removed from the Agent.
System deletion is permanent. Ensure the system is no longer needed before deleting.
Permission Control
Rumi Admin supports restricting command-and-control access:
Per-user — The
disable_cncflag can be set per user to provide read-only monitoring access.Global — The
global_disable_cncsetting disables command-and-control for all non-admin users.
When command-and-control is disabled, users can view system status and dashboards but cannot execute scripts, deploy XARs, or invoke commands.
Last updated