Удаленное управление конфигурацией ЕдиногоАгента и АктивногоШлюза

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

Используйте удаленное управление конфигурацией, чтобы организовать несколько ЕдиныхАгентов или АктивныхШлюзов с помощью одной команды вместо того, чтобы выполнять одни и те же действия по одному (будь то во время установки, путем редактирования файлов конфигурации или с помощью инструмента командной строки oneagentctl).

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

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

Возможности

Благодаря удаленному управлению конфигурацией вы можете с помощью одной команды выполнить любое из следующих действий на нескольких ЕдиныхАгентах или АктивныхШлюзах, которые соответствуют требованиям версии.

ЕдиныйАгент

Действие Требуемая версия Ключ-АСТРОМ Требуемая версия ЕдиногоАгента
Назначение группы хостов 1.252+ 1.237+
Назначение сетевой зоны 1.252+ 1.237+
Назначение тега 1.268+ 1.263+
Назначение права собственности 1.268+ 1.263+

АктивныйШлюз

Действие Требуемая версия Ключ-АСТРОМ Требуемая версия АктивногоШлюза
Назначение группы АктивногоШлюза 1.252+ 1.237+
Назначение сетевой зоны 1.252+ 1.237+

Удалённое управление конфигурацией работает для ЕдиныхАгентов в режимах Full-Stack и Infrastructure Monitoring, а также для хостовых АктивныхШлюзов. ЕдиныйАгент и АктивныйШлюз должны взаимодействовать с вашей средой.

Ограничения

Удаленное управление конфигурацией НЕ работает с:

  • ЕдинымАгентом развернутом с помощью Ключ-АСТРОМ Operator
  • ЕдинымАгентом только для приложений
  • ЕдинымАгентом на Solaris
  • Контейнерным АктивнымШлюзом

Разрешения

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

IAM-разрешения

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

  • deployment:oneagents.network-zones:write
  • deployment:oneagents.host-groups:write
  • deployment:oneagents.host-tags:write
  • deployment:oneagents.host-properties:write
  • deployment:activegates.network-zones:write
  • deployment:activegates.groups:write

Используя разрешения IAM, вы можете ограничить действия пользователя одним действием по настройке, например, изменить только назначение группы хостов ЕдиногоАгента.

Токены доступа

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

  • Запись ЕдиныхАгентов (oneAgents.write) — для проверки полезной нагрузки, создания предварительного просмотра и запуска изменения конфигурации для ЕдиныхАгентов
  • Запись АктивныхШлюзов (activeGates.write) — для проверки полезной нагрузки, создания предварительного просмотра и запуска изменения конфигурации для АктивныхШлюзов

Операции веб-интерфейса

Рабочий процесс удаленной настройки веб-интерфейса Ключ-АСТРОМ аналогичен для ЕдиныхАгентов и АктивныхШлюзов.

Настроить ЕдиныеАгенты

Вы можете назначить следующее нескольким ЕдинымАгентам:

  • Принимающая группа
  • Сетевая зона
  • Теги
  • Характеристики

Чтобы обновить несколько ЕдиныхАгентов для любого из вышеперечисленных

  1. Перейдите в раздел Состояние развертывания > ЕдиныеАгенты.
  2. Отфильтруйте и выберите ЕдиныеАгенты, которые хотите настроить. Вы можете использовать поле выбора в заголовке таблицы, чтобы выбрать все отфильтрованные ЕдиныеАгенты, или выбрать их по отдельности. После выбора ЕдиныхАгентов в нижней части страницы появится панель редактирования.
  3. Выберите изменение конфигурации, которое вы хотите выполнить.
    • изменить группу хостов
    • изменить сетевую зону
    • изменить теги хоста
    • изменить свойства хоста
  4. Выберите действие Выполнить.
    Это запустит мастер удалённого управления конфигурацией для внесения изменений в конфигурацию выбранных ЕдиныеАгенты. Изменения не будут сохранены, пока вы не нажмёте кнопку Применить изменения и не подтвердите все необходимые перезагрузки. До этого вы сможете изменить или отменить действие.
  5. Укажите, какие изменения вы хотите применить ко всем выбранным ЕдинымАгентам. В зависимости от выбранного действия вы можете:
    • Добавить или удалить назначение группы хостов
    • Добавить или удалить назначение сетевой зоны
    • Добавить или удалить теги хоста
    • Добавить или удалить свойства хоста
  6. Выберите Далее.
  7. Проверьте внесенные изменения.
  8. Выберите Применить изменения.
  9. Выберите Продолжить, чтобы начать массовое действие.
    • ЕдиныйАгент будет перезапущен, чтобы применить изменения в назначениях зон сети, назначениях групп хостов и Ключ-АСТРОМ версии 1.308+ теги и свойства.
    • При изменении назначения группы хостов необходимо вручную перезапустить процессы, внедрённые ЕдиныеАгенты. При изменении назначения сетевой зоны перезапуск внедрённых процессов не требуется.
  10. Во время выполнения массового действия строка состояния в верхней части страницы состояния развертывания информирует о ходе выполнения массового действия. Вы не сможете начать другое массовое действие, пока текущее не завершится.

Изменения сетевых зон и групп хостов могут вступить в силу в течение 10 минут. Удаление свойств хоста и тегов может занять до семи часов.

Настроить АктивныеШлюз

Нескольким АктивнымШлюзам можно назначить следующее:

  • Группа АктивногоШлюза
  • Сетевая зона

Чтобы обновить несколько АктивныхШлюзов для любого из вышеперечисленных

  1. Перейдите в раздел Состояние развертывания > АктивныеШлюзы.
  2. Отфильтруйте и выберите устройства АктивногоШлюза, которые вы хотите настроить. Вы можете использовать поле выбора в заголовке таблицы, чтобы выбрать все отфильтрованные устройства АктивногоШлюза, или выбрать каждое устройство по отдельности.
  3. После выбора АктивногоШлюза в нижней части страницы появится панель редактирования.
  4. Выберите изменение конфигурации, которое вы хотите выполнить.
    • изменить группу АктивногоШлюза
    • изменить сетевую зону
  5. Выберите конфигурацию, которую вы хотите выполнить, а затем выберите Выполнить действие.
    Это запустит мастер удалённого управления конфигурацией для внесения изменений в конфигурацию выбранных вами устройств АктивногоШлюза. Изменения не будут сохранены, пока вы не нажмёте кнопку Применить изменения и не подтвердите все необходимые перезагрузки. До этого вы сможете изменить или отменить действие.
  6. Укажите, какие изменения вы хотите применить ко всем выбранным АктивнымШлюзам. В зависимости от выбранного действия вы можете:
    • Добавить или удалить назначение группы АктивногоШлюза
    • Добавить или удалить назначение сетевой зоны
  7. Выберите Далее.
  8. Проверьте внесенные изменения.
  9. Выберите Применить изменения, чтобы запустить массовое действие.
  10. Во время выполнения массового действия панель в верхней части страницы состояния развертывания информирует о ходе выполнения. Не запускайте другое массовое действие, пока текущее не завершится. Перезапуск АктивногоШлюза не требуется для применения изменений.

Для вступления изменений в силу может потребоваться до 10 минут.

Операции API

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

Пример управления конфигурацией ЕдиногоАгента

Ниже приведен пример назначения нескольких ЕдиныхАгентов группе хостов с помощью API Ключ-АСТРОМ.

Фильтр ЕдиныхАгентов для настройки

Используйте ЕдиныйАгент на конечной точке API хоста, чтобы указать список ЕдиныхАгентов, для которых вы хотите изменить назначение хоста.

Вы можете использовать любое из доступных свойств ЕдиногоАгента в качестве критерия фильтрации. Например, чтобы получить список всех ЕдиныхАгентов, установленных в Windows, выполните следующий запрос.

curl --request GET \

  --url 'https://myenvironment.com/api/v2/oneagents?osType=WINDOWS \

  --header 'Authorization: Api-Token <token>'

Создать полезную нагрузку

В полезной нагрузке перечислены ЕдиныеАгенты, для которых вы выполните массовое действие, и подробности самого действия. Пример полезной нагрузки ниже приведёт к изменению назначения группы хостов some-host-group для трёх перечисленных ЕдиныхАгентов, идентифицированных по их идентификаторам хостов.

{

    "entities": ["HOST-0000000000000001", "HOST-0000000000000002", "HOST-0000000000000003"],

    "operations": [

        {

            "operation": "SET",

            "attribute": "hostGroup",

            "value": "some-host-group"

        }

    ]

}

Проверить полезную нагрузку

Перед запуском задания конфигурации вы можете проверить созданную вами полезную нагрузку, выполнив следующий запрос. В приведённом ниже примере полезная нагрузка передаётся в запрос в виде файла payload.json.

curl --request POST \

  --url https://myenvironment.com/api/v2/oneagents/remoteConfigurationManagement/validator \

  --header 'Authorization: Api-Token <token>' \

  --header 'Content-Type: application/json' \

  --data @payload.json

Допустимая полезная нагрузка возвращает ответ HTTP 204. Недопустимая полезная нагрузка возвращает ответ с подробностями нарушения.

Создать предварительный просмотр

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

Этап предварительного просмотра не поддерживается для тегов и свойств.

Чтобы запустить предварительный просмотр, выполните следующий запрос:

curl --request POST \

  --url https://myenvironment.com/api/v2/oneagents/remoteConfigurationManagement/preview \

  --header 'Authorization: Api-Token <token>' \

  --header 'Content-Type: application/json' \

  --data @payload.json

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

{

    "previews": [

        {

            "operation": "SET",

            "attribute": "hostgroup",

            "existingEntitiesCount": 3,

            "targetEntitiesCount": 6

        }

    ]

}

Выполнить массовую настройку

Чтобы запустить массовую настройку, выполните следующий запрос:

curl --request POST \

  --url https://myenvironment.com/api/v2/oneagents/remoteConfigurationManagement \

  --header 'Authorization: Api-Token <token>' \

  --header 'Content-Type: application/json' \

  --data @payload.json

Успешный запрос возвращает ответ HTTP 201. Это означает, что задание по настройке запущено. Изменение применяется не мгновенно. Каждый ЕдиныйАгент сначала выполняет настройку самостоятельно, а затем отправляет информацию в вашу среду, после чего кластер Ключ-АСТРОМ обновляет назначение группы хостов. Изменение может отразиться в вашей среде в течение 10 минут.

Вы можете проверить изменение, запустив ЕдиныйАгент на запросе API хоста, отфильтрованном по группе хостов, в которую вы только что назначили свои хосты.

curl --request GET \

  --url 'https://myenvironment.com/api/v2/oneagents?hostGroupName=some-host-group \

  --header 'Authorization: Api-Token <token>'

Ответ должен содержать три идентификатора хоста, которые вы добавили в задание по настройке.

Источник — https://doc.fit4u.kz/index.php?title=Удаленное_управление_конфигурацией_ЕдиногоАгента_и_АктивногоШлюза&oldid=5642