pyobs-web-admin

This is a web-based administration interface for pyobs (documentation), the robotic telescope framework. Unlike most pyobs_* packages, it is not itself a pyobs module loaded via a YAML class: entry – it is a standalone Django application that manages a fleet of pyobs module processes from the outside, via subprocess and the filesystem. It has no import-time dependency on pyobs-core.

From a browser it lets you start, stop, and restart modules, tail and filter their logs, view and edit their YAML configuration files, audit and edit their access-control policy fleet-wide, and – optionally – manage the XMPP accounts they connect to ejabberd with.

Feature overview

• Dashboard – sortable list of every module with status, RAM, CPU, uptime, and recent warning/error log counts; quick start/restart/stop/activate/deactivate per module plus bulk Start All / Restart All / Stop All. See Dashboard and module detail.

• Module detail – Overview, Logs, Config, and ACL tabs for a single module. See Dashboard and module detail and ACL matrix and per-module ACL editing.

• Module lifecycle – how start/stop/restart/status/logs actually work under the hood, new-module creation, shared config fragments. See How modules are managed.

• ACL matrix – a fleet-wide view of every module’s access-control policy, editable in place. See ACL matrix and per-module ACL editing.

• journald-backed logging – an alternative to flat log files for modules run under systemd. See journald-backed logging.

• Hub mode – control multiple remote pyobs hosts from a single browser tab. See Hub mode.

• ejabberd / XMPP integration (optional) – live connection status and, if wanted, account management for modules’ XMPP identities. See ejabberd / XMPP integration.

• Overview page and fleet-wide Users page – cross-host summaries built on top of hub mode. See Dashboard and module detail and XMPP user management.

Getting started

Getting started

• Installation
  • Development
  • Production
• Configuration
  • Django core
  • Authentication
  • pyobs paths
  • Hub mode
  • ejabberd integration (optional)

Features

• Dashboard and module detail
  • Dashboard
  • Module detail
  • New module
  • Shared configs
  • Fleet-wide Overview page
• How modules are managed
  • Discovery
  • Activate / deactivate
  • Start
  • Stop
  • Restart
  • Status
  • Resource usage
  • Logs
  • Log counts
• ACL matrix and per-module ACL editing
  • Background
  • Resolving {include} and shared fragments
  • What the matrix shows
  • Editing from the matrix
  • Hub mode
• journald-backed logging
  • Choosing a backend
  • What changes, and what doesn’t
• Hub mode
  • Setup
  • Authentication
  • One active host at a time – and the exception
• ejabberd / XMPP integration
  • Read-only status integration
  • XMPP user management

Project

• Architecture
  • Technology
  • Design principles
  • Project layout
• Development
  • Setup
  • Tests
  • Design docs

API reference

• API reference
  • modules.services
  • modules.views
  • modules.ejabberd
  • modules.proxy