lockbot 2.1.1

Cluster resource management bot for IM platforms

lockbot

Cluster resource management bot for IM platforms (e.g., Baidu InfoFlow).

Lock and unlock GPU devices, cluster nodes, and queue slots via chat commands. Supports both standalone Flask deployment and a full platform mode with FastAPI + Vue.js frontend.

中文文档 | Live Demo

Features

• Device Lock Bot — Lock/unlock individual GPUs or devices on a cluster
• Node Lock Bot — Lock/unlock entire cluster nodes
• Queue Bot — Manage a queue for resource allocation with booking and preemption
• Platform Mode — Web UI (Vue 3 + Element Plus) for managing multiple bots, user authentication (JWT), role-based access control, and real-time logs
• State Persistence — Bot state survives restarts (JSON file)
• Bilingual — English and Chinese UI and bot responses

Quick Start — Platform Mode (Recommended)

Full management platform with Web UI, multi-bot orchestration, user authentication, and admin panel.

1. Install:

pip install lockbot

2. Set environment variables:

export JWT_SECRET="your-jwt-secret"
export ENCRYPTION_KEY="your-fernet-key"    # python -c "from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())"
export DEV_MODE="true"                      # dev mode, auto-create admin user

3. Start:

# Backend
uvicorn lockbot.backend.app.main:app --host 0.0.0.0 --port 8000 --reload

# Frontend (another terminal)
cd frontend && npm install && npm run dev

4. Open http://localhost:8000 in your browser.

Docker

# 1. Generate ENCRYPTION_KEY and JWT_SECRET
python tools/gen_keys.py

# 2. Pull pre-built image (or build from source)
docker pull ghcr.io/dynamicheart/lockbot:latest
# docker build -f docker/Dockerfile -t lockbot .

# 3. Run (replace the keys with generated values)
docker run -d --name lockbot -p 8000:8000 \
  -e JWT_SECRET=your-secret \
  -e ENCRYPTION_KEY=your-fernet-key \
  -v lockbot-data:/app/python/lockbot/data \
  ghcr.io/dynamicheart/lockbot:latest

# 4. Create super_admin (password auto-generated and printed)
docker exec -it lockbot python tools/create_super_admin.py --username admin --email [e-mail]

Database: SQLite file auto-created at DATA_DIR/lockbot.db (default: python/lockbot/data/lockbot.db). Override with DATA_DIR env var.

Bot Configuration

Key	Description	Default
BOT_TYPE	DEVICE, NODE, or QUEUE	(required)
BOT_NAME	Bot instance name	demo_bot
CLUSTER_CONFIGS	Cluster layout (dict or list)	{}
TOKEN	Bot signature verification token	""
AESKEY	Message decryption AES key	""
WEBHOOK_URL	Message webhook URL	""
PORT	Server listen port	8090
DEFAULT_DURATION	Default lock duration (seconds)	7200 (2h)
MAX_LOCK_DURATION	Max lock duration (seconds)	-1 (unlimited)
EARLY_NOTIFY	Notify before lock expiry	false

See python/lockbot/core/config.py for the full configuration reference.

Commands

Command	Description
lock <node> [duration]	Exclusive lock (e.g., lock gpu0 3d, lock node1 30m)
slock <node> [duration]	Shared lock (multiple users)
unlock <node> / free <node>	Release a specific node
unlock / free	Release all your nodes
kickout <node>	Force release (admin)
book <node> [duration]	Queue: book a node for later
take <node>	Queue: take the current lock
<node>	Query current usage
help	Show usage

Development

# Install dev dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Lint + format check
ruff check python/ tests/
ruff format --check python/ tests/

Standalone Mode

Single-bot deployment with a lightweight Flask webhook server.

Device Lock Bot (per-GPU locking):

from lockbot.core.bot_instance import BotInstance
from lockbot.core.entry import create_app

instance = BotInstance("DEVICE", {
    "BOT_NAME": "my-gpu-bot",
    "WEBHOOK_URL": "https://your-webhook-url",
    "TOKEN": "your-bot-token",
    "AESKEY": "your-aes-key",
    "CLUSTER_CONFIGS": {
        "node0": ["A800", "A800", "H100"],
        "node1": ["A800", "H100"],
    },
})

app = create_app(bot=instance.bot, bot_name="my-gpu-bot", port=8000)
app.run(host="0.0.0.0", port=8000)

Node Lock Bot / Queue Bot (per-node locking or queue scheduling):

from lockbot.core.bot_instance import BotInstance
from lockbot.core.entry import create_app

instance = BotInstance("NODE", {       # or "QUEUE" for queue scheduling
    "BOT_NAME": "my-node-bot",
    "WEBHOOK_URL": "https://your-webhook-url",
    "TOKEN": "your-bot-token",
    "AESKEY": "your-aes-key",
    "CLUSTER_CONFIGS": ["node0", "node1", "node2", "node3"],
})

app = create_app(bot=instance.bot, bot_name="my-node-bot", port=8000)
app.run(host="0.0.0.0", port=8000)

License

MIT