Руководство: различия между версиями

Материал из Документация Ключ-АСТРОМ
(Новая страница: «Давайте учиться на примере. В этом уроке мы покажем вам создание базового расширения Акт...»)
 
Строка 13: Строка 13:


# Войдите в Ключ-АСТРОМ, перейдите в «Настройки » > «Отслеживаемые технологии » > «Добавить мониторинг новых технологий » > «Добавить расширение АктивногоШлюза» и нажмите «Загрузить SDK расширения» .
# Войдите в Ключ-АСТРОМ, перейдите в «Настройки » > «Отслеживаемые технологии » > «Добавить мониторинг новых технологий » > «Добавить расширение АктивногоШлюза» и нажмите «Загрузить SDK расширения» .
#Распакуйте архив в удобную директорию. Он содержит документацию, примеры и файл Extension SDK, который <code>whl</code>вы будете использовать для установки SDK.
# В каталоге вы найдете примеры расширений <code>examples</code>. В этой статье мы будем использовать <code>CustomCloudTechnology</code>расширение, расположенное в <code>demo_activegate_plugin_multi</code>каталоге.
== Установите SDK расширения АктивногоШлюза ==
Виртуальная среда Python
Мы рекомендуем установить Extension SDK с использованием виртуальной среды Python. Инструкции см. в разделе «Виртуальные среды и пакеты».в документации Python.
# Перейдите в извлеченный каталог с <code>whl</code>файлом и выполните следующую команду: <code>pip3 install plugin_sdk-[sdk version number]-py3-none-any.whl</code> например <code>pip3 install plugin_sdk-1.156.0.20181003.61122-py3-none-any.whl</code>
# Запустите <code>plugin_sdk --help</code>, чтобы проверить установку Extension SDK. Дополнительную информацию см. в разделе [Install Extension SDK]plugin-sdk-overview).
== Развернуть расширение ==
=== То, что нужно запомнить ===
# Вы должны загрузить расширение как на сервер КлючАстром, так и на АктивномШлюзе, который будет его выполнять. Если вы установили Extension SDK на хосте АктивногоШлюза, <code>build_plugin</code>команда позаботится как о Сервере, так и о АктивномШлюзе. Если вы установили SDK расширения на отдельный хост, что является более распространенным случаем, загрузите расширение в АктивныйШлюз вручную. На этапе разработки мы рекомендуем вам установить Extension SDK на АктивныйШлюз, чтобы упростить процесс разработки.
# Команда <code>build_plugin</code>создает пакет расширения и загружает его в выбранный каталог развертывания. Для запуска команды вам понадобится URL-адрес и токен сервера Ключ-АСТРОМ. Если вы установили Extension SDK на хосте АктивногоШлюза, SDK автоматически получит URL-адрес сервера из конфигурации АктивногоШлюза. Получите токен в разделе «Настройки» > «Отслеживаемые технологии» > «Пользовательские расширения» и сохраните его как <code>plugin_upload.token</code>файл в каталоге конфигурации подключаемого модуля АктивногоШлюза. По умолчанию <code>%PROGRAMFILES%\astromkey\remotepluginmodule\agent\conf</code>в Windows и <code>/opt/astromkey/remotepluginmodule/agent/conf</code>Linux.
# Вы не можете развернуть одну и ту же версию расширения дважды. Чтобы загрузить измененное расширение, обязательно увеличивайте версию расширения при каждой сборке или загрузке. Используйте это <code>version</code>свойство в разделе метаданных вашего определения JSON .
=== Разверните свое расширение! ===
Перейдите в <code>\examples\demo_activegate_plugin</code>каталог расширения SDK и выполните <code>plugin_sdk build_plugin</code>команду. Он создаст пакет расширения из текущего каталога. По завершении скопируйте пакет расширения в каталог развертывания ActiveGate ( <code>%PROGRAMFILES%\astromkey\remotepluginmodule\plugin_deployment</code>или <code>/opt/astromkey/remotepluginmodule/plugin_deployment</code>загрузите расширение на сервер Ключ-АСТРОМ, которому назначен ваш ActiveGate. Подобное сообщение означает, что все прошло хорошо.

Версия 08:45, 28 декабря 2023

Давайте учиться на примере. В этом уроке мы покажем вам создание базового расширения АктивногоШлюза. Ваше расширение АктивногоШлюза будет выполняться на АктивномШлюзе и позволит отслеживать демонстрационное приложение, входящее в комплект АктивногоШлюза Extension SDK.

Подготовьте свое окружение

  1. Проверьте предварительные условия:
    • Ключ-АСТРОМ версии 1.176 или новее
    • Среда АктивногоШлюза. Чтобы запускать расширения с АктивнымШлюзом, установленным в Amazon Linux 2022, вам необходимо установить библиотеку libxcrypt-compat.
    • Мониторинг доступа администратора
  2. Установите Python 3.8. АктивныйШлюз поставляется с Python 3.8. Мы рекомендуем использовать Extension SDK с той же версией Python.
  3. Установите среду АктивногоШлюза. В версии 1.175+ модуль плагина установлен по умолчанию.

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

  1. Войдите в Ключ-АСТРОМ, перейдите в «Настройки » > «Отслеживаемые технологии » > «Добавить мониторинг новых технологий » > «Добавить расширение АктивногоШлюза» и нажмите «Загрузить SDK расширения» .
  2. Распакуйте архив в удобную директорию. Он содержит документацию, примеры и файл Extension SDK, который whlвы будете использовать для установки SDK.
  3. В каталоге вы найдете примеры расширений examples. В этой статье мы будем использовать CustomCloudTechnologyрасширение, расположенное в demo_activegate_plugin_multiкаталоге.

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

Виртуальная среда Python

Мы рекомендуем установить Extension SDK с использованием виртуальной среды Python. Инструкции см. в разделе «Виртуальные среды и пакеты».в документации Python.

  1. Перейдите в извлеченный каталог с whlфайлом и выполните следующую команду: pip3 install plugin_sdk-[sdk version number]-py3-none-any.whl например pip3 install plugin_sdk-1.156.0.20181003.61122-py3-none-any.whl
  1. Запустите plugin_sdk --help, чтобы проверить установку Extension SDK. Дополнительную информацию см. в разделе [Install Extension SDK]plugin-sdk-overview).

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

То, что нужно запомнить

  1. Вы должны загрузить расширение как на сервер КлючАстром, так и на АктивномШлюзе, который будет его выполнять. Если вы установили Extension SDK на хосте АктивногоШлюза, build_pluginкоманда позаботится как о Сервере, так и о АктивномШлюзе. Если вы установили SDK расширения на отдельный хост, что является более распространенным случаем, загрузите расширение в АктивныйШлюз вручную. На этапе разработки мы рекомендуем вам установить Extension SDK на АктивныйШлюз, чтобы упростить процесс разработки.
  2. Команда build_pluginсоздает пакет расширения и загружает его в выбранный каталог развертывания. Для запуска команды вам понадобится URL-адрес и токен сервера Ключ-АСТРОМ. Если вы установили Extension SDK на хосте АктивногоШлюза, SDK автоматически получит URL-адрес сервера из конфигурации АктивногоШлюза. Получите токен в разделе «Настройки» > «Отслеживаемые технологии» > «Пользовательские расширения» и сохраните его как plugin_upload.tokenфайл в каталоге конфигурации подключаемого модуля АктивногоШлюза. По умолчанию %PROGRAMFILES%\astromkey\remotepluginmodule\agent\confв Windows и /opt/astromkey/remotepluginmodule/agent/confLinux.
  3. Вы не можете развернуть одну и ту же версию расширения дважды. Чтобы загрузить измененное расширение, обязательно увеличивайте версию расширения при каждой сборке или загрузке. Используйте это versionсвойство в разделе метаданных вашего определения JSON .

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

Перейдите в \examples\demo_activegate_pluginкаталог расширения SDK и выполните plugin_sdk build_pluginкоманду. Он создаст пакет расширения из текущего каталога. По завершении скопируйте пакет расширения в каталог развертывания ActiveGate ( %PROGRAMFILES%\astromkey\remotepluginmodule\plugin_deploymentили /opt/astromkey/remotepluginmodule/plugin_deploymentзагрузите расширение на сервер Ключ-АСТРОМ, которому назначен ваш ActiveGate. Подобное сообщение означает, что все прошло хорошо.