Files
buryan-infra/ops/bots/commands.yaml

190 lines
6.8 KiB
YAML

# ============================================================
# Справочник команд buryan-hub — ЕДИНСТВЕННЫЙ ИСТОЧНИК ПРАВДЫ
# ============================================================
# Из этого файла генерируется:
# * ответ /help в каждом боте (только его команды);
# * docs/COMMANDS.md в репозитории;
# * закреплённое сообщение в комнате Matrix.
#
# ДОБАВИТЬ КОМАНДУ = ДОБАВИТЬ ЗАПИСЬ СЮДА. Помощь обновится сама.
#
# Поля:
# command — как вызывается, без слэша
# bot — какому боту принадлежит: adm | work | alert | auth | media
# title — короткое название
# description — что делает, одним предложением
# usage — как вызывать
# examples — примеры (показываются в /help)
# access — admin | user (кто может вызывать)
# aliases — другие написания
# status — ready | planned (planned показывается серым, но видно)
bots:
adm:
name: ADM
purpose: Управление службами и состояние инфраструктуры
about: Отвечает на команды о состоянии и выполняет перезапуски.
work:
name: WORK
purpose: Обновления и рабочие задачи
about: Показывает очередь обновлений и принимает решения по ним.
alert:
name: ALERT
purpose: Тревоги инфраструктуры
about: Только сообщает о проблемах и восстановлении. Команд не принимает.
auth:
name: AUTH
purpose: Доступ и регистрация
about: Обслуживает заявки на доступ к сервисам.
media:
name: MEDIA
purpose: Медиа-службы
about: Состояние и управление медиасервисами.
commands:
# ─── ADM: состояние и управление ───────────────────────────
- command: status
bot: adm
title: Состояние служб
description: Показывает состояние хостов и служб с ответами проверок.
usage: /status
examples:
- /status
access: user
aliases: ["!status"]
status: ready
- command: issues
bot: adm
title: Открытые задачи
description: Список открытых задач Gitea с метками важности.
usage: /issues
examples:
- /issues
access: user
aliases: ["!issues"]
status: ready
- command: runbook
bot: adm
title: Ранбук сервиса
description: Показывает инструкцию по обслуживанию указанного сервиса.
usage: /runbook <сервис>
examples:
- /runbook radarr
- /runbook n8n
access: user
aliases: ["!runbook"]
status: ready
- command: restart
bot: adm
title: Перезапуск службы
description: Перезапускает службу через службу восстановления.
usage: /restart <сервис>
examples:
- /restart radarr
access: admin
aliases: ["!restart"]
status: ready
# ─── WORK: обновления ──────────────────────────────────────
- command: queue
bot: work
title: Очередь обновлений
description: Показывает очередь обновлений с номерами заявок.
usage: /queue
examples:
- /queue
access: user
status: planned
- command: approve
bot: work
title: Одобрить обновление
description: Ставит заявку в работу — обновление будет выполнено.
usage: /approve <номер>
examples:
- /approve 17
access: admin
status: planned
- command: reject
bot: work
title: Отклонить обновление
description: Отклоняет заявку — обновление выполнено не будет.
usage: /reject <номер>
examples:
- /reject 17
access: admin
status: planned
- command: update
bot: work
title: Обновить службу сейчас
description: Немедленно ставит обновление службы в очередь.
usage: /update <служба>
examples:
- /update prowlarr
access: admin
status: planned
# ─── AUTH: доступ ──────────────────────────────────────────
- command: requests
bot: auth
title: Заявки на доступ
description: Показывает необработанные заявки на регистрацию.
usage: /requests
examples:
- /requests
access: admin
status: planned
- command: approve-user
bot: auth
title: Одобрить заявку
description: Даёт доступ указанному пользователю и создаёт учётную запись.
usage: /approve-user <почта>
examples:
- /approve-user user@example.com
access: admin
status: planned
- command: deny-user
bot: auth
title: Отклонить заявку
description: Отклоняет заявку на доступ.
usage: /deny-user <почта>
examples:
- /deny-user user@example.com
access: admin
status: planned
# ─── MEDIA: медиасервисы ───────────────────────────────────
- command: media
bot: media
title: Состояние медиасервисов
description: Показывает состояние медиасервисов и их очереди загрузок.
usage: /media
examples:
- /media
access: user
status: planned
# ─── Общие для всех ботов ──────────────────────────────────
- command: help
bot: all
title: Справка
description: Показывает команды этого бота. Можно указать команду подробнее.
usage: /help [команда]
examples:
- /help
- /help restart
access: user
status: ready