Развёртывание расширения

Материал из Документация Ключ-АСТРОМ

Расширения / Разработка / Расширения / Развёртывание расширения

Окончание поддержки расширений 1.0

ЕдиныйАгент и АктивныйШлюз версии 1.299 — последние версии, поддерживающие фреймворк ЕдиногоАгента и АктивногоШлюза Расширений 1.0. Вы можете продолжить использовать Расширения 1.0, если используете ЕдиныйАгент или АктивныйШлюз версии 1.299. Обратите внимание, что это означает, что вы будете использовать неподдерживаемую версию Python 3.8. Настоятельно рекомендуем перенести ваши расширения на последнюю версию фреймворка Расширения 2.0.

Завершив разработку расширения, убедитесь, что ваш plugin.jsonфайл действителен и в нем определены все обязательные поля. Особое внимание обратите на sourceраздел, где необходимо определить:

  • package, что соответствует имени файла расширения Python,
  • className, что соответствует имени класса в вашем расширении,
  • install_requires, в котором перечислены внешние зависимости, необходимые вашему расширению.

{

  "source": {

    "package": "demo_plugin",

    "className": "DemoPlugin",

    "install_requires": ["boto3==1.0.0"]

  }

}

Поместите все файлы расширений в один каталог.

Существует два способа загрузить и развернуть расширение: с помощью Extension SDK или с помощью веб-интерфейса Ключ-АСТРОМ.

Развертывание через Extension SDK

Если вы установили Extension SDK на хосте АктивногоШлюза, вы можете развернуть расширение на АктивномШлюзе и сервере с помощью SDK. Получите токен в разделе «Настройки» > «Отслеживаемые технологии» > «Пользовательские расширения» и сохраните его как plugin_upload.tokenфайл в каталоге конфигурации модуля расширения АктивногоШлюза.

Убедитесь, что у текущего пользователя есть writeразрешения на доступ к plugin_deploymentкаталогу. По умолчанию он находится в:

Расширения АктивногоШлюза

  • Linux:/opt/astromkey/remotepluginmodule/plugin_deployment
  • Windows:C:\Program Files\astromkey\remotepluginmodule\plugin_deployment

Перейдите в каталог с файлами расширения и выполните следующую команду:

plugin_sdk build_plugin

Что происходит:

  • Ваше расширение загружается в среду, к которой подключен АктивныйШлюз.
  • Ваше расширение сохраняется в каталоге, доступном для модуля расширения АктивныйШлюз.

Развертывание через веб-интерфейс Ключ-АСТРОМ

Вы также можете развернуть свое расширение вручную и загрузить его на сервер через веб-интерфейс Ключ-АСТРОМ.

  1. Скопируйте папку с файлами вашего расширения в plugin_deploymentпапку на АктивныйШлюз, который вы будете использовать для запуска расширения. Путь к plugin.jsonдолжен быть следующим:
    • Linux:/opt/astromkey/remotepluginmodule/plugin_deployment/custom.remote.python.demo/plugin.json
    • Окна:C:\Program Files\astromkey\remotepluginmodule\plugin_deployment\custom.remote.python.demo\plugin.json
  2. Загрузите расширение в свою среду с помощью веб-интерфейса Ключ-АСТРОМ. Откройте «Настройки» > «Отслеживаемые технологии» > «Пользовательские плагины» . Вы можете либо использовать кнопку «Загрузить расширение» напрямую (в разделе «Обновить расширения »), либо перейти в «Настройки» > «Отслеживаемые технологии» > «Добавить мониторинг новых технологий» > «Добавить расширение АктивногоШлюза» и использовать кнопку «Загрузить расширение» . В обоих случаях вам необходимо выбрать plugin.jsonфайл или заархивированную папку, содержащую все файлы расширений.

Расширение развернуто

После успешного развертывания вы должны увидеть свое расширение, готовое к настройке , в веб-интерфейсе Ключ-АСТРОМ в разделе «Настройки» > «Отслеживаемые технологии» > вкладка «Пользовательские расширения» .