Фреймворк плагінів
Розширюйте функціональність Xcellerate RMM за допомогою плагінів спільноти та власних плагінів.
Огляд
Plugin framework дозволяє розширювати Xcellerate RMM додатковою функціональністю без модифікації базової платформи. Плагіни можуть додавати нові віджети панелі інструментів, власні монітори, типи звітів, конектори інтеграцій та навіть цілком нові сторінки інтерфейсу.
RMM Labs підтримує офіційний маркетплейс плагінів з плагінами від спільноти та першої сторони. Ви також можете розробляти власні приватні плагіни за допомогою Plugin SDK та TypeScript/JavaScript.
Ключові поняття
- Плагін — самодостатній пакет розширення з маніфестом, кодом та необов'язковими ресурсами (іконки, шаблони). Встановлюється на рівні сервера.
- Маркетплейс плагінів — вбудований каталог для перегляду, встановлення та оновлення плагінів. Доступний через Administration → Plugins.
- Plugin SDK — набір інструментів розробки з API для взаємодії з даними, UI-компонентами та подіями Xcellerate RMM. Доступний як npm-пакет.
- Хук — точка розширення в платформі, де плагіни можуть вставляти поведінку (наприклад,
onEndpointCreated,onAlertFired,beforePatchInstall). - Віджет — компонент, наданий плагіном, який можна додати на панель інструментів або сторінки деталей кінцевих точок (наприклад, власний графік, кнопка швидкої дії).
- Налаштування плагіна — конфігураційні значення, які надає плагін (наприклад, API-ключ для стороннього сервісу). Адміністратори встановлюють їх після інсталяції.
Покрокова інструкція
Перегляньте маркетплейс
Перейдіть до Administration → Plugins → Marketplace. Переглядайте за категорією (моніторинг, звітність, інтеграції, UI) або шукайте за назвою. Кожна картка плагіна показує опис, автора, версію, рейтинг та кількість встановлень.
Встановіть плагін
Натисніть на плагін для перегляду його сторінки деталей, потім натисніть Install. Плагін завантажується та активується. Деякі плагіни вимагають перезапуску сервера — інтерфейс повідомить вас, якщо це необхідно.
Налаштуйте плагін
Після встановлення перейдіть до Administration → Plugins → Installed. Натисніть на назву плагіна та заповніть необхідні налаштування (наприклад, API-ключі, параметри за замовчуванням). Збережіть.
Використовуйте плагін
Залежно від типу плагіна, ви можете побачити новий пункт у бічному меню, новий віджет на панелі інструментів, додаткові опції в контекстних меню або новий тип звіту. Зверніться до документації плагіна для деталей.
Оновіть або видаліть плагін
На сторінці встановлених плагінів можна перевірити оновлення (значок з'являється при наявності нової версії) або натиснути Uninstall для чистого видалення плагіна.
Розробка власного плагіна
Щоб створити власний плагін, встановіть Plugin SDK та ініціалізуйте новий проект:
npm install -g @xcellerate/plugin-sdk
xcellerate-plugin init my-custom-plugin
cd my-custom-plugin
npm run devСтворений проект включає файл маніфесту (plugin.json), точку входу та приклади хуків. SDK надає TypeScript-типи для всіх API платформи та локальний сервер розробки з гарячим перезавантаженням вашого плагіна у пісочниці Xcellerate.
Поради та найкращі практики
- Перевірте маркетплейс, перш ніж створювати власне рішення — можливо, вже існує плагін, що робить те, що вам потрібно.
- Тримайте плагіни оновленими — автори часто виправляють помилки та додають функції в нових версіях.
- При розробці власного плагіна дотримуйтесь принципу мінімальних привілеїв: запитуйте лише ті дозволи API, які дійсно потрібні вашому плагіну.
- Тестуйте власні плагіни в тестовому середовищі перед розгортанням у виробничому.
- Використовуйте хуки для логіки, що спрацьовує на подіях (наприклад, автоматичне тегування кінцевих точок при створенні) замість опитування API.
- Надсилайте корисні плагіни на маркетплейс, щоб поділитися зі спільнотою та отримати відгуки.