Жизненный цикл расширений 2.0

Вы можете управлять своим расширением через приложение Расширения (последняя версия Ключ-АСТРОМ), Ключ-АСТРОМ Hub или API Ключ-АСТРОМ.

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

Требуемое разрешение: изменение настроек мониторинга.

Центр Ключ-АСТРОМ

Загрузить пользовательское расширение

1. Перейти в раздел Расширения.
2. Прокрутите страницу вниз и выберите Загрузить собственное расширение 2.0 .
3. Выберите архив расширения (или перетащите его) и загрузите его в Ключ-АСТРОМ. Ключ-АСТРОМ Hub проверяет архив расширения и структуру и автоматически включает его после успешной загрузки.
4. Большинство полей предварительно заполнены на основе файла расширения YAML. Вы можете предоставить информацию о примечаниях к выпуску, объясняющую, почему изменилась версия расширения.

Развернуть расширение из Ключ-АСТРОМ Hub

1. Перейдите в раздел Расширения.
2. Найдите плитку расширения в разделе Расширения 2.0, которую вы можете добавить в свою среду .
3. Выберите плитку, затем выберите Добавить в среду.

Определить устройства

Выберите Добавить устройство, чтобы определить устройства, с которых вы хотите извлекать данные, и предоставить сведения о подключении устройства:

• IP-адрес или имя устройства
• Порт
• Версия SNMP и соответствующие данные аутентификации

Начать мониторинг

Ваше расширение отображается в Ключ-АСТРОМ Hub. Следующий шаг — предоставить конфигурацию мониторинга для вашего расширения.

Обновление расширения

Чтобы обновить расширение, просто загрузите новую версию. Ключ-АСТРОМ Hub автоматически активирует новую версию расширения.

Каждое обновление расширения перезапишет конфигурацию событий метрики, которая может поставляться с расширением. Это означает, что любые настройки, внесенные в настройки событий метрики, будут сброшены до значений по умолчанию при обновлении расширения. Рекомендуется записать любые пользовательские конфигурации и повторно применить их после обновления, если необходимо.

Удалить версию расширения

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

API-интерфейс Ключ-АСТРОМ

Чтобы добавить расширение в среду Ключ-АСТРОМ через API, выполните следующую последовательность шагов.

1. Загрузить расширение
2. Включить расширение
3. Начните мониторинг

После добавления и включения расширения управляйте его жизненным циклом:

• Обновление расширения
• Удаление расширения

Разрешения API

• Для управления жизненным циклом расширения вам понадобится токен API со следующими разрешениями:
  • API v2
    • Читать расширения
    • Писать расширения
    • Читать конфигурации среды расширения
    • Писать конфигурации среды расширения
    • Читать конфигурации мониторинга расширения
    • Писать конфигурации мониторинга расширений
  • API-интерфейс v1
    • Читать конфигурацию
    • Писать конфигурацию

Загрузить расширение с API

Выполните следующую команду, чтобы загрузить пакет расширения в вашу среду. Для этого примера мы используем URL-адрес Ключ-АСТРОМ SaaS:

curl -X POST "https://{env-id}.live.astromkey.com/api/v2/extensions" \ -H "accept: application/json; charset=utf-8" \ -H "Authorization: Api-Token {api-token}" \ -H "Content-Type: multipart/form-data" \ -F "file=@MyCustomExtension.zip;type=application/zip"

Замените:

• {env-id} вашим идентификатором среды .
• {api-token} API-токеном , имеющим необходимые разрешения .
• MyCustomExtension.zip на фактическое имя вашего пакета расширения.

После успешной загрузки API Ключ-АСТРОМ возвращает основные сведения о расширении, включая имя расширения, версию и минимальную версию Ключ-АСТРОМ, необходимую для запуска расширения:

{    "extensionName":"custom:my.company.extension",    "version":"1.0.0",    "author":{       "name":"My Company"    },    "dataSources":[    ],    "variables":[    ],    "featureSets":[    ],    "minastromkeyVersion":"1.213.0" }

Включить расширение с API

После загрузки расширения в среду вам необходимо включить конфигурацию среды. Этот шаг необходим, поскольку вы можете загрузить до 10 версий расширения, но использовать одновременно можно только одну версию расширения. При активации расширения вы указываете, какую версию расширения использовать.

Выполните следующую команду, чтобы активировать расширение в вашей среде. Для этого примера мы используем URL-адрес Ключ-АСТРОМ SaaS.

curl -X PUT "https://{env-id}.live.astromkey.com/api/v2/extensions/{extensionName}/environmentConfiguration" \ -H "accept: application/json; charset=utf-8" \ -H "Authorization: Api-Token {api-token}" \ -H "Content-Type: application/json; charset=utf-8" \ -d "{\"version\":\"{version}\"}"

Замените:

• {env-id} вашим идентификатором среды .
• {api-token} API-токеном , имеющим необходимые разрешения .
• {extensionName} фактическим именем расширения.
• {version} версией расширения, которую вы хотите активировать.

Чтобы определить имя расширения, извлеките пакет расширения, извлеките файл extensions.zip из пакета и откройте файл extension.yaml.

После успешной активации API Ключ-АСТРОМ возвращает версию активированного расширения. Например:

{"version":"1.0.0"}

Начните мониторинг с API

Для начала мониторинга необходимо добавить хотя бы одну версию конфигурации мониторинга. Формат полезной нагрузки JSON зависит от отслеживаемого источника данных.

curl -X POST "{env-id}.live.astromkey.com/api/v2/extensions/{extensionName>/monitoringConfigurations" \ -H "accept: application/json; charset=utf-8" \ -H "Authorization: Api-Token {api-token}" \ -H "Content-Type: application/json; charset=utf-8" \ --data @{monitoring-configuration} -i

Замените:

• {env-id} вашим идентификатором среды .
• {api-token} API-токеном , имеющим необходимые разрешения .
• {extensionName} фактическим именем расширения.
• {version} версией расширения, которую вы хотите активировать.
• {monitoring-configuration} именем файла, содержащего полезную нагрузку JSON с конфигурацией мониторинга. Подробнее о формате см. SNMP .

После успешного вызова API Ключ-АСТРОМ возвращает объект MonitoringConfigurationResponse. Например:

[ { "objectId": "vu9U3hXa3q0AAAABACVleHQ6Y29tLmR5bmF0cmFjZS5zY2hlbWEtc25tcC1nZW5lcmljAAhhZ19ncm91cAAHRTJFVEVTVAAkMWMxZTlhMDctNzVkYi0zZjI0LWI4OGUtZmIxYWRiNGNjYTY4vu9U3hXa3q0", "code": 200 } ]

Через несколько минут перейдите в визуализацию метрик и найдите метрики, которые вы определили для своего расширения.

Обновление расширения с помощью API

Чтобы обновить расширение, вам необходимо загрузить новый пакет расширения и включить новую конфигурацию среды.

Загрузить обновленный пакет расширения с API

Чтобы загрузить пакет, используйте ту же команду, которую вы использовали для загрузки первоначальной версии расширения. Вам нужно использовать новое имя файла пакета расширения, если оно изменилось.

Включить новую версию конфигурации с API

Чтобы включить версию конфигурации среды, необходимо добавить параметр версии в вызов API. Используйте один из этих методов для определения версии:

• После успешной загрузки API Ключ-АСТРОМ возвращает основные сведения о расширении, включая версию.
• Найдите версию в файле extension.yaml внутри пакета расширения.
• Запустите вызов API GET extension versions.

Выполните следующую команду для активации новой версии. Для этого примера мы используем URL-адрес Ключ-АСТРОМ SaaS.

curl -X PUT "https://{env-id}.live.astromkey.com/api/v2/extensions/{extensionName}/environmentConfiguration" \ -H "accept: application/json; charset=utf-8" \ -H "Authorization: Api-Token  {api-token}" \ -H "Content-Type: application/json; charset=utf-8" \ -d "{\"version\":\"{version}\"}"

Замените:

• {env-id} вашим идентификатором среды .
• {api-token} API-токеном , имеющим необходимые разрешения .
• {extensionName} фактическим именем расширения.
• {version} версией расширения, которую вы хотите активировать.

После успешной активации API Ключ-АСТРОМ возвращает версию активированного расширения. Например:

{"version":"1.1.0"}

Удалить расширение с API

Если вы загрузили несколько версий расширения, вам нужно удалить все версии, чтобы полностью удалить расширение из вашей среды. Вы можете использовать GET extension versions, чтобы получить список всех версий расширения, доступных в вашей среде.

Удалить конфигурацию среды с помощью API

Чтобы удалить текущую активную конфигурацию среды, используйте DELETE environment configuration . Для этого примера мы используем URL-адрес Ключ-АСТРОМ SaaS.

curl -X DELETE "{env-id}.live.astromkey.com/api/v2/extensions/{extensionName}/environmentConfiguration" \ -H "accept: application/json; charset=utf-8" \ -H "Authorization: Api-Token {api-token}"

Замените:

• {env-id} вашим идентификатором среды .
• {api-token} API-токеном , имеющим необходимые разрешения .
• {extensionName} фактическим именем расширения.

После успешной деактивации API Ключ-АСТРОМ возвращает версию деактивированного расширения. Например:

{"version":"1.1.0"}

Удалить версию расширения с API

Чтобы удалить версию расширения, используйте DELETE an extension version. В этом примере мы используем URL-адрес Ключ-АСТРОМ SaaS.

curl -X DELETE "{env-id}.live.astromkey.com/api/v2/extensions/{extensionName}/{version}" \ -H "accept: application/json; charset=utf-8" \ -H "Authorization: Api-Token {api-token}"

Замените:

• {env-id} вашим идентификатором среды .
• {api-token} API-токеном , имеющим необходимые разрешения .
• {extensionName} фактическим именем расширения.
• {version} версией расширения, которую вы хотите удалить.

После успешного удаления версии API Ключ-АСТРОМ возвращает следующий ответ:

{    "extensionName":"custom:my.company.extension",    "version":"1.0.0",    "author":{       "name":"My Company"    },    "dataSources":[    ],    "variables":[    ],    "featureSets":[    ],    "minastromkeyVersion":"1.213.0" }