Документация АппОптима - Вклад [ru]

Периодичный отчёт по дашбордам

2024-05-29T15:48:16Z

RGolovanov: /* Доступ для незарегистрированных пользователей */

Для дашборда имеется возможность настроить периодичный (еженедельный и ежемесячный) отчёт по электронной почте. Это удобно для формирования отчётов за некоторый период.

== Принципы работы ==

=== Доступ для незарегистрированных пользователей ===
Есть возможность настроить отправку отчётов получателям, не зарегистрированным в вашем контуре Ключ-Астром. Доступ для незарегистрированных пользователей также именуется '''анонимным доступом'''.

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

Для включения анонимного доступа выполните следующие действия:

# Перейдите в раздел '''Настройки -> Дашборды -> Общие настройки'''
# Включите кнопку '''Разрешить анонимный доступ'''
# Нажмите на кнопку '''Сохранить изменения'''

При выключенном анонимном доступе переход на страницу отчёта возвращает 403 ошибку.

=== Содержание электронных писем ===
Электронное письмо содержит не данные отчёта, а ссылку на сам отчёт с выбранным периодом отчётности (недельный и месячный период).

=== Формирование и отправка отчётов ===
Формирование отчётов происходит в ночь понедельника с учётом временной зоны окружения.

Рассылка отчётов по почте производится в течение шести часов.

При еженедельной отчётности отчёт отправляется каждое утро понедельника. При ежемесячной отчётности отчёт отправляется утром первого понедельника каждого месяца.

== Работа с отчётностью ==

=== Включение/выключение отчётности ===
По умолчанию подписка на периодичную отчётность по дашбордам отключена. При включении отчётности у пользователей с доступом к дашборду появляется возможность подписаться на отчётность и смотреть её без авторизации в вашем контуре.

Для включения/выключения периодичной отчётности выполните следующие действия:

# Внутри дашборда откройте режим редактирования
# Перейдите в панель '''Настройки'''
# Включите/выключите переключатель '''Включить отчёты'''
# Нажмите на кнопку '''Готово'''

=== Подписка на отчётность ===

# Внутри дашборда нажмите на кнопку '''...''' '''-> Подписаться'''
# Выберите периодичность отправки отчётов

=== Подписать других на отчётность ===
Чтобы подписать на отчётность другие электронные почты, используйте '''API Отчётов''' и укажите электронные почты, на которые вы желаете отправлять отчётность.

=== Отписаться от отчётности ===
Чтобы отписаться от отчётности, перейдите на ссылку отписки, которая также отправляется вместе с каждым отчётом.

Периодичный отчёт по дашбордам

2024-05-29T15:47:57Z

RGolovanov: /* Доступ для незарегистрированных пользователей */

Для дашборда имеется возможность настроить периодичный (еженедельный и ежемесячный) отчёт по электронной почте. Это удобно для формирования отчётов за некоторый период.

== Принципы работы ==

=== Доступ для незарегистрированных пользователей ===
Есть возможность настроить отправку отчётов получателям, не зарегистрированным в вашем контуре Ключ-Астром. Доступ для незарегистрированных пользователей также именуется '''анонимным доступом'''.

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

Для включения анонимного доступа выполните следующие действия:

# Перейдите в раздел '''Настройки -> Дашборды -> Общие настройки'''
# Включите кнопку '''Разрешить анонимный доступ'''
# Нажмите на кнопку '''Сохранить изменения'''

При выключенном анонимном доступе переход на страницу отчёта возвращает 403 ошибку.

=== Содержание электронных писем ===
Электронное письмо содержит не данные отчёта, а ссылку на сам отчёт с выбранным периодом отчётности (недельный и месячный период).

=== Формирование и отправка отчётов ===
Формирование отчётов происходит в ночь понедельника с учётом временной зоны окружения.

Рассылка отчётов по почте производится в течение шести часов.

При еженедельной отчётности отчёт отправляется каждое утро понедельника. При ежемесячной отчётности отчёт отправляется утром первого понедельника каждого месяца.

== Работа с отчётностью ==

=== Включение/выключение отчётности ===
По умолчанию подписка на периодичную отчётность по дашбордам отключена. При включении отчётности у пользователей с доступом к дашборду появляется возможность подписаться на отчётность и смотреть её без авторизации в вашем контуре.

Для включения/выключения периодичной отчётности выполните следующие действия:

# Внутри дашборда откройте режим редактирования
# Перейдите в панель '''Настройки'''
# Включите/выключите переключатель '''Включить отчёты'''
# Нажмите на кнопку '''Готово'''

=== Подписка на отчётность ===

# Внутри дашборда нажмите на кнопку '''...''' '''-> Подписаться'''
# Выберите периодичность отправки отчётов

=== Подписать других на отчётность ===
Чтобы подписать на отчётность другие электронные почты, используйте '''API Отчётов''' и укажите электронные почты, на которые вы желаете отправлять отчётность.

=== Отписаться от отчётности ===
Чтобы отписаться от отчётности, перейдите на ссылку отписки, которая также отправляется вместе с каждым отчётом.

Периодичный отчёт по дашбордам

2024-05-29T14:14:38Z

RGolovanov:

Для дашборда имеется возможность настроить периодичный (еженедельный и ежемесячный) отчёт по электронной почте. Это удобно для формирования отчётов за некоторый период.

== Принципы работы ==

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

Для включения анонимного доступа выполните следующие действия:

# Перейдите в раздел '''Настройки -> Дашборды -> Общие настройки'''
# Включите кнопку '''Разрешить анонимный доступ'''
# Нажмите на кнопку '''Сохранить изменения'''

При выключенном анонимном доступе переход на страницу отчёта возвращает 403 ошибку.

=== Содержание электронных писем ===
Электронное письмо содержит не данные отчёта, а ссылку на сам отчёт с выбранным периодом отчётности (недельный и месячный период).

=== Формирование и отправка отчётов ===
Формирование отчётов происходит в ночь понедельника с учётом временной зоны окружения.

Рассылка отчётов по почте производится в течение шести часов.

При еженедельной отчётности отчёт отправляется каждое утро понедельника. При ежемесячной отчётности отчёт отправляется утром первого понедельника каждого месяца.

== Работа с отчётностью ==

=== Включение/выключение отчётности ===
По умолчанию подписка на периодичную отчётность по дашбордам отключена. При включении отчётности у пользователей с доступом к дашборду появляется возможность подписаться на отчётность и смотреть её без авторизации в вашем контуре.

Для включения/выключения периодичной отчётности выполните следующие действия:

# Внутри дашборда откройте режим редактирования
# Перейдите в панель '''Настройки'''
# Включите/выключите переключатель '''Включить отчёты'''
# Нажмите на кнопку '''Готово'''

=== Подписка на отчётность ===

# Внутри дашборда нажмите на кнопку '''...''' '''-> Подписаться'''
# Выберите периодичность отправки отчётов

=== Подписать других на отчётность ===
Чтобы подписать на отчётность другие электронные почты, используйте '''API Отчётов''' и укажите электронные почты, на которые вы желаете отправлять отчётность.

=== Отписаться от отчётности ===
Чтобы отписаться от отчётности, перейдите на ссылку отписки, которая также отправляется вместе с каждым отчётом.

Периодичный отчёт по дашбордам

2024-05-29T14:05:04Z

RGolovanov: Новая страница: «Для дашборда имеется возможность настроить периодичный (еженедельный и ежемесячный) от...»

Организация дашбордов

2024-05-29T13:39:47Z

RGolovanov: /* Переключение между менеджмент-зонами */

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

== Фильтрация ==
Фильтрация позволяет находить дашборды по некоторому заданному критерию, например, по названию дашборда, его владельцу, тегам.

=== Способы фильтрации ===
Устанавливать фильтры можно двумя способами:

* через скрываемый список фильтров слева от списка дашбордов. Используется для быстрой фильтрации;
* через строку фильтрации. Используется для фильтрации по пользовательскому воду.

=== Описание фильтров ===
Для дашбордов применимы следующие фильтры:

* '''Имя''' — поиск по названию или части названия дашборда
* '''Владение''':
** '''Мой''' — все созданные вами дашборды
** '''Поделились со мной''' — все дашборды, к которым вам выдали доступ другие пользователи
* '''Избранное''' — все дашборды, которые вы добавили в избранные
* '''Владелец''' — поиск дашбордов по имени его владельца
* '''Тег''' — все дашборды, к которым применён указанные теги
* '''Скрытый''' — отображение дашбордов, которые вы скрыли
* '''Пользовательские графики''' — все дашборды, на которых имеются пользовательские графики
* '''Предустановка''' — отображение всех предустановленных и шаблонных дашбордов
== Избранные дашборды ==
Избранные дашборды отображаются в списке выше других.

=== Добавление и удаление дашборда в избранные ===
Добавлять и удалять дашборды в избранные можно двумя способами:

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

Нажатие на звезду отвечает за добавление и удаление дашборда в список избранных. Синяя звезда показывает, что дашборд находится в списке избранного, прозрачная звезда отображает, что дашборд не является избранным.

=== Отображение избранных дашбордов ===
В списке фильтров или в строке фильтрации дашбордов примените фильтр '''Избранное: Да'''

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

=== Скрытие дашборда ===
Чтобы скрыть дашборд, выполните следующие действия:

# Перейдите в раздел '''Дашборды'''
# Нажмите на кнопку многоточия '''(...)''' для открытия контекстного меню скрываемого дашборда
# Нажмите на кнопку '''Скрыть'''

=== Список скрытых дашбордов ===
Чтобы открыть список всех скрытых вами дашбордов, примените фильтр '''Скрытый: Да'''

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

# Перейдите в раздел '''Дашборды'''
# Примените фильтр '''Скрытый: Да'''
# Нажмите на кнопку многоточия '''(...)''' для открытия контекстного меню нужного вам дашборда
# Нажмите на кнопку '''Показать'''

== Популярность дашбордов ==
Столбец '''Популярность''' у каждого дашборда отображает метрику, которая определяет, как часто дашборд просматривают в течение 30 дней. Метрика популярности строится по шкале от 1 (менее просматриваемый) до 10 (самый популярный)

== Теги ==
Для логического разделения дашбордов используются теги. Например, удобно внести под тег '''Веб-сервисы''' все дашборды, отвечающие за представление разных веб-сервисов. После внесения дашборда под данный тег фильтрация '''Тег: Веб-сервисы''' будет возвращать только дашборды по веб-сервисам.

У каждого дашборда может быть неограниченное количество тегов.

=== Добавление тега дашборда ===

# Перейдите в раздел '''Дашборды'''
# Перейдите в редактируемый дашборд
# Нажатием кнопки '''Редактировать''' откройте режим редактирования дашборда
# В списке тегов под названием дашборда нажмите на кнопку '''Добавить тег'''
# Введите тег и нажмите на кнопку '''Добавить'''
# Нажатием кнопки '''Готово''' примените теги к дашборду

== Менеджмент-зоны ==
Менеджмент-зоны, также именуемые зонами управления, используются для логического разделения данных мониторинга внутри дашборда.

=== Примеры использования менеджмент-зон ===
Первым примером использования менеджмент-зон является разделение команд разработки фронтенда и бэкенда. Имеет смысл создать менеджмент-зоны '''Фронтенд''' и '''Бэкенд''' и назначить всех фронт- и бэк-разработчиков на свои менеджмент-зоны. После этого каждый разработчик, открыв дашборд, будет видеть информацию только по сервисам, относящимся к его компетенции: фронт-разработчик будет видеть все метрики, связанные с сервисами клиентской части, бэкенд-разработчику будут отображаться только метрики и данные по сервисам серверной составляющей.

Вторым примером использования менеджмент-зон является разделение инфраструктуры на тестовую и production части. Создаются менеджмент-зоны '''Тестовое окружение''' и '''Продакшн''', к ним привязываются соответствующие сервисы. После этого инженеры и администраторы, находясь в одном дашборде и переключаясь между менеджмент-зонами тестовой и production инфраструктур, могут замерять показатели по тестовым и рабочим стендам независимо друг от друга.

=== Переключение между менеджмент-зонами ===
Для переключения между менеджмент-зонами используйте кнопку менеджмент-зон:
[[Файл:Mz.png|безрамки|867x867пкс]]

Файл:Mz.png

2024-05-29T13:39:19Z

RGolovanov:

Организация дашбордов

2024-05-29T08:09:50Z

RGolovanov:

Организация дашбордов

2024-05-29T06:50:05Z

RGolovanov: /* Теги */

Организация дашбордов

2024-05-29T06:11:33Z

RGolovanov:

Организация дашбордов

2024-05-29T06:05:30Z

RGolovanov:

Организация дашбордов

2024-05-29T06:03:45Z

RGolovanov:

Организация дашбордов

2024-05-29T05:37:05Z

RGolovanov: Новая страница: «Когда в окружении находится большое количество дашбордов, появляется нужда в их организ...»

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

== Избранные дашборды ==
Избранные дашборды отображаются в списке выше других.

=== Добавление и удаление дашборда в избранные ===
Добавлять и удалять дашборды в избранные можно двумя способами:

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

Нажатие на звезду отвечает за добавление и удаление дашборда в список избранных. Синяя звезда показывает, что дашборд находится в списке избранного, прозрачная звезда отображает, что дашборд не является избранным.

== Фильтрация ==

=== Способы фильтрации ===
Устанавливать фильтры можно двумя способами:

* через скрываемый список фильтров слева от списка дашбордов. Используется для быстрой фильтрации;
* через строку фильтрации. Используется для фильтрации по пользовательскому воду.

=== Описание фильтров ===
Для дашбордов применимы следующие фильтры:

* '''Имя''' — поиск по названию или части названия дашборда
* '''Владение''':
** '''Мой''' — все созданные вами дашборды
** '''Поделились со мной''' — все дашборды, к которым вам выдали доступ другие пользователи
* '''Избранное''' — все дашборды, которые вы добавили в избранные
* '''Владелец''' — поиск дашбордов по имени его владельца
* '''Тег''' — все дашборды, к которым применён указанные теги
* '''Скрытый''' — отображение дашбордов, которые вы скрыли
* '''Пользовательские графики''' — все дашборды, на которых имеются пользовательские графики
* '''Предустановка''' — отображение всех предустановленных и шаблонных дашбордов

Динамические фильтры в дашбордах

2024-05-28T13:10:53Z

RGolovanov: /* Через дашборд */

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

В контексте фильтрации сущности называются '''измерениями'''.

== Настройки динамических фильтров ==

=== Через раздел Дашборды ===

# Перейдите в раздел '''Дашборды'''
# Нажмите на кнопку многоточия '''(...)''' для открытия контекстного меню клонируемого дашборда
# Нажмите на кнопку '''Настроить'''
# Перейдите в пункт меню '''Динамические фильтры'''

=== Через страницу дашборда ===

# Нажатием на кнопку '''Редактировать''' в дашборде перейдите в режим редактирования
# Перейдите в панель '''Настройки'''
# Нажмите на кнопку '''Настроить больше'''
# Перейдите в пункт меню '''Динамические фильтры'''

== Добавление и редактирование динамических фильтров ==

# Находясь в пункте меню '''Динамические фильтры''', нажмите на кнопку '''Добавить фильтр'''
# Выберите сущность или критерий, по которому будет произведена фильтрация, в списке '''Критерий фильтрации'''
# Если критерий фильтрации требует дополнительный ввод, введите требуемые данные
# Нажмите на кнопку '''Сохранить изменения'''

== Правила фильтрации ==

* фильтры применяются только к тем измерениям, которые имеются в дашборде. В ином случае плитки будут возвращаться пустые значения
* несколько фильтров по одному измерению соединяются логическим ИЛИ, по разным измерениям - логическим И
* динамические фильтры применяются исключительно на плитки, созданные в разделе '''Визуализация метрик''' и прикреплённые к дашборду

== Пример использования динамических фильтров ==

=== Предварительные данные ===
Имеется дашборд, отображающий для всех сервисов метрики их потребления ЦП и операций ввода-вывода, а также долю сбоев по всем сервисам:

[[Файл:Дашборд сервисов.png|безрамки|520x520пкс]]

=== Цель ===
Требуется добавить фильтрацию сервисов по их типу (базы данных, веб-сервисы и т. д.)

=== Решение ===
1. Нажатием на последовательность кнопок '''...''' -> '''Настроить''' перейти в подробные настройки дашборда:[[Файл:Дашборд-настройки.png|безрамки|612x612пкс]]

2. Перейти в пункт настроек '''Динамические фильтры''', нажать на кнопку '''Добавить фильтр''':

[[Файл:Добавить-фильтр.png|безрамки|469x469px]]

3. Выбираем критерий фильтрации. В нашем случае им является '''Тип сервиса''':

[[Файл:Критерий-фильтрации.png|безрамки|493x493пкс]]

4. Нажатием на кнопку '''Сохранить изменения''' создаём динамический фильтр

=== Результат ===
На странице дашборда появилась строка с фильтрацией по типу сервиса:

[[Файл:Результат-фильтра.png|безрамки|497x497пкс]]

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

[[Файл:Порт-8021-проблема.png|безрамки|506x506пкс]]

Динамические фильтры в дашбордах

2024-05-28T13:10:38Z

RGolovanov:

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

В контексте фильтрации сущности называются '''измерениями'''.

== Настройки динамических фильтров ==

=== Через раздел Дашборды ===

# Перейдите в раздел '''Дашборды'''
# Нажмите на кнопку многоточия '''(...)''' для открытия контекстного меню клонируемого дашборда
# Нажмите на кнопку '''Настроить'''
# Перейдите в пункт меню '''Динамические фильтры'''

=== Через дашборд ===

# Нажатием на кнопку '''Редактировать''' в дашборде перейдите в режим редактирования
# Перейдите в панель '''Настройки'''
# Нажмите на кнопку '''Настроить больше'''
# Перейдите в пункт меню '''Динамические фильтры'''

== Добавление и редактирование динамических фильтров ==

# Находясь в пункте меню '''Динамические фильтры''', нажмите на кнопку '''Добавить фильтр'''
# Выберите сущность или критерий, по которому будет произведена фильтрация, в списке '''Критерий фильтрации'''
# Если критерий фильтрации требует дополнительный ввод, введите требуемые данные
# Нажмите на кнопку '''Сохранить изменения'''

== Правила фильтрации ==

* фильтры применяются только к тем измерениям, которые имеются в дашборде. В ином случае плитки будут возвращаться пустые значения
* несколько фильтров по одному измерению соединяются логическим ИЛИ, по разным измерениям - логическим И
* динамические фильтры применяются исключительно на плитки, созданные в разделе '''Визуализация метрик''' и прикреплённые к дашборду

== Пример использования динамических фильтров ==

=== Предварительные данные ===
Имеется дашборд, отображающий для всех сервисов метрики их потребления ЦП и операций ввода-вывода, а также долю сбоев по всем сервисам:

[[Файл:Дашборд сервисов.png|безрамки|520x520пкс]]

=== Цель ===
Требуется добавить фильтрацию сервисов по их типу (базы данных, веб-сервисы и т. д.)

=== Решение ===
1. Нажатием на последовательность кнопок '''...''' -> '''Настроить''' перейти в подробные настройки дашборда:[[Файл:Дашборд-настройки.png|безрамки|612x612пкс]]

2. Перейти в пункт настроек '''Динамические фильтры''', нажать на кнопку '''Добавить фильтр''':

[[Файл:Добавить-фильтр.png|безрамки|469x469px]]

3. Выбираем критерий фильтрации. В нашем случае им является '''Тип сервиса''':

[[Файл:Критерий-фильтрации.png|безрамки|493x493пкс]]

4. Нажатием на кнопку '''Сохранить изменения''' создаём динамический фильтр

=== Результат ===
На странице дашборда появилась строка с фильтрацией по типу сервиса:

[[Файл:Результат-фильтра.png|безрамки|497x497пкс]]

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

[[Файл:Порт-8021-проблема.png|безрамки|506x506пкс]]

Динамические фильтры в дашбордах

2024-05-28T12:56:12Z

RGolovanov:

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

== Пример использования динамических фильтров ==

=== Предварительные данные ===
Имеется дашборд, отображающий для всех сервисов метрики их потребления ЦП и операций ввода-вывода, а также долю сбоев по всем сервисам:

[[Файл:Дашборд сервисов.png|безрамки|520x520пкс]]

=== Цель ===
Требуется добавить фильтрацию сервисов по их типу (базы данных, веб-сервисы и т. д.)

=== Решение ===
1. Нажатием на последовательность кнопок '''...''' -> '''Настроить''' перейти в подробные настройки дашборда:[[Файл:Дашборд-настройки.png|безрамки|612x612пкс]]

2. Перейти в пункт настроек '''Динамические фильтры''', нажать на кнопку '''Добавить фильтр''':

[[Файл:Добавить-фильтр.png|безрамки|469x469px]]

3. Выбираем критерий фильтрации. В нашем случае им является '''Тип сервиса''':

[[Файл:Критерий-фильтрации.png|безрамки|493x493пкс]]

4. Нажатием на кнопку '''Сохранить изменения''' создаём динамический фильтр

=== Результат ===
На странице дашборда появилась строка с фильтрацией по типу сервиса:

[[Файл:Результат-фильтра.png|безрамки|497x497пкс]]

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

[[Файл:Порт-8021-проблема.png|безрамки|506x506пкс]]

Динамические фильтры в дашбордах

2024-05-28T12:54:45Z

RGolovanov:

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

== Пример использования динамических фильтров ==

=== Предварительные данные ===
Имеется дашборд, отображающий для всех сервисов метрики их потребления ЦП и операций ввода-вывода, а также долю сбоев по всем сервисам:

[[Файл:Дашборд сервисов.png|безрамки|520x520пкс]]

=== Цель ===
Требуется добавить фильтрацию сервисов по их типу (базы данных, веб-сервисы и т. д.)

=== Решение ===

# Нажатием на последовательность кнопок '''...''' -> '''Настроить''' перейти в подробные настройки дашборда: [[Файл:Дашборд-настройки.png|безрамки|612x612пкс]]
# Перейти в пункт настроек '''Динамические фильтры''', нажать на кнопку '''Добавить фильтр''': [[Файл:Добавить-фильтр.png|безрамки|336x336пкс]]
# Выбираем критерий фильтрации. В нашем случае им является '''Тип сервиса''': [[Файл:Критерий-фильтрации.png|безрамки|493x493пкс]]
# Нажатием на кнопку '''Сохранить изменения''' создаём динамический фильтр

=== Результат ===
На странице дашборда появилась строка с фильтрацией по типу сервиса:

[[Файл:Результат-фильтра.png|безрамки|497x497пкс]]

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

[[Файл:Порт-8021-проблема.png|безрамки|506x506пкс]]

Динамические фильтры в дашбордах

2024-05-28T12:54:19Z

RGolovanov:

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

== Пример использования динамических фильтров ==

=== Предварительные данные ===
Имеется дашборд, отображающий для всех сервисов метрики их потребления ЦП и операций ввода-вывода, а также долю сбоев по всем сервисам:

[[Файл:Дашборд сервисов.png|безрамки|520x520пкс]]

=== Цель ===
Требуется добавить фильтрацию сервисов по их типу (базы данных, веб-сервисы и т. д.)

=== Решение ===

# Нажатием на последовательность кнопок '''...''' -> '''Настроить''' перейти в подробные настройки дашборда: [[Файл:Дашборд-настройки.png|безрамки|612x612пкс]]
# Перейти в пункт настроек '''Динамические фильтры''', нажать на кнопку '''Добавить фильтр''': [[Файл:Добавить-фильтр.png|безрамки|336x336пкс]]
# Выбираем критерий фильтрации. В нашем случае им является '''Тип сервиса''': [[Файл:Критерий-фильтрации.png|безрамки|493x493пкс]]
# Нажатием на кнопку '''Сохранить изменения''' создаём динамический фильтр

=== Результат ===
На странице дашборда появилась строка с фильтрацией по типу сервиса:

[[Файл:Результат-фильтра.png|безрамки|497x497пкс]]

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

[[Файл:Порт-8021-проблема.png|безрамки|506x506пкс]]

Файл:Порт-8021-проблема.png

2024-05-28T12:53:59Z

RGolovanov:

порт-8021-проблема

Файл:Результат-фильтра.png

2024-05-28T12:47:33Z

RGolovanov:

результат-фильтра

Файл:Критерий-фильтрации.png

2024-05-28T12:45:45Z

RGolovanov:

критерий-фильтрации

Файл:Добавить-фильтр.png

2024-05-28T12:44:38Z

RGolovanov:

добавить-фильтр

Файл:Дашборд-настройки.png

2024-05-28T12:42:25Z

RGolovanov:

дашборд-настройки

Динамические фильтры в дашбордах

2024-05-28T12:31:43Z

RGolovanov: Новая страница: «Динамические фильтры используются для фильтрации сущностей (хосты, сервисы, приложения,...»

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

== Пример использования динамических фильтров ==
Имеется дашборд, отображающий для всех сервисов метрики их потребления ЦП и операций ввода-вывода, а также долю сбоев по всем сервисам.

Файл:Дашборд сервисов.png

2024-05-28T12:31:13Z

RGolovanov:

Дашборд сервисов

Управление дашбордами

2024-05-28T11:35:28Z

RGolovanov: Новая страница: «В данной статье описаны создание, редактирование и конфигурация дашбордов и их плиток. =...»

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

== Создание дашборда ==

=== Создание нового дашборда ===

# Перейдите в раздел '''Дашборды'''
# Нажмите на кнопку '''Создать дашборд'''
# Введите название создаваемого дашборда и нажмите '''Создать'''

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

=== Клонирование существующего дашборда ===

# Перейдите в раздел '''Дашборды'''
# Нажмите на кнопку многоточия '''(...)''' для открытия контекстного меню клонируемого дашборда
# Нажмите на кнопку '''Клонировать'''

После создания дашборда вас перенаправит на его страницу в режиме редактирования.

== Редактирование дашборда ==

=== Режим редактирования ===

# Перейдите в раздел '''Дашборды'''
# Перейдите в редактируемый дашборд
# Нажатием кнопки '''Редактировать''' откройте режим редактирования дашборда

Следует отметить, что доступ к режиму редактирования есть только у пользователей с правом редактирования дашбордов. У остальных пользователей кнопка '''Редактировать''' отсутствует.

=== Добавление плитки ===

# В режиме редактирования откройте панель '''Плитки'''
# Удержанием курсора мыши переносите нужные вам плитки на полотно дашборда

=== Редактирование плитки ===

# Нажатием на стрелку в правом верхнем углу плитки откройте её контекстное меню
# Нажмите на кнопку '''Редактировать плитку'''
# Внесите требуемые изменения
# По внесении изменений нажмите на кнопку '''Готово'''

=== Удаление плитки ===

# В режиме редактирования нажатием на плитку откройте её контекстное меню
# Нажмите на кнопку '''Удалить'''

== Конфигурация дашборда ==

=== Настройка фильтров ===
Для дашборда можно установить таймфрейм и менеджмент-зону по умолчанию. Подробнее настройка описана в разделе [[Таймфреймы и менеджмент-зоны дашбордов]].

=== Периодичные отчёты ===
Имеется возможность настроить периодичные отчёты по дашбордам. Подробнее настройка описана в разделе [[Периодичный отчёт по дашбордам]].

=== Размер заголовков плиток ===
Вы можете настроить общий размер заголовков всех плиток в дашборде. Для этого в режиме редактирования изменяйте значение '''Размер заголовков'''

=== Одинаковые цвета объектов ===
Если вы желаете, чтобы метрики по одному и тому же объекту, находящиеся в разных плитках (например, потребление ОЗУ по всем хостам в одной плитке и потребление мощностей процессора в другой плитке) имели одинаковый цвет для визуального различения, установите в режиме редактирования в разделе '''Настройки''' переключатель '''Единообразные цвета объектов''' в активное положение

=== Подробная настройка ===
Для подробной настройки в разделе '''Настройки''' нажмите на кнопку '''Настроить больше'''

== Удаление дашборда ==

# Перейдите в раздел '''Дашборды'''
# Нажмите на кнопку многоточия '''(...)''' для открытия контекстного меню удаляемого дашборда
# Нажмите на кнопку '''Удалить'''
# Подтвердите удаление дашборда

Создание дашбордов для нескольких окружений Ключ-АСТРОМ

2024-05-28T10:53:07Z

RGolovanov: RGolovanov переименовал страницу Создание дашбордов для удалённых сред и мультисред Ключ-АСТРОМ в Создание дашбордов для нескольких окружений Ключ-АСТРОМ

'''''[https://doc.ruscomtech.ru/index.php/%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D0%BD%D0%B5%D0%BD%D0%B8%D0%B5_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C Применение Ключ-АСТРОМ] / [https://doc.ruscomtech.ru/index.php/%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D0%BD%D0%B5%D0%BD%D0%B8%D0%B5_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C#.D0.94.D0.B0.D1.88.D0.B1.D0.BE.D1.80.D0.B4.D1.8B_.D0.B8_.D0.BE.D1.82.D1.87.D1.91.D1.82.D1.8B Дашборды и отчеты] / Классические дашборды / Управление классическими дашбордами мониторинга / Создание дашбордов для удалённых сред и мультисред Ключ-АСТРОМ'''''

== Добавление удаленной среды ==
Чтобы добавить удаленную среду Ключ-АСТРОМ в список доступных удаленных сред

# Войдите в локальную среду Ключ-АСТРОМ.
# В меню Ключ-АСТРОМ перейдите в '''«Настройки»''' .
# Выберите '''Интеграция''' > '''Удаленные среды''' .
# Выберите '''Подключить среду''' .
# Определите удаленную среду, из которой ваша локальная среда извлекает данные, а затем выберите '''Сохранить изменения''' .
#* '''Имя''' — это имя, под которым эта среда будет указана в вашей локальной среде Ключ-АСТРОМ, когда вы настроите плитку для запроса этой удаленной среды. Это текст произвольной формы. Это не влияет на удаленную среду.
#* '''URI удаленной среды''' — это URI, который вы скопировали из адресной строки браузера в предыдущей процедуре.
#* '''Область действия сети'''
#** <code>External</code>: удаленная среда находится в другой сети. При наличии используются глобально настроенные параметры прокси. Это область действия по умолчанию.
#** <code>Internal</code>: удаленная среда находится в той же сети. Глобально настроенные параметры прокси не используются.
#** <code>Cluster</code>: удаленная среда находится в том же кластере. Запрос сделан на <code>localhost</code>. ''Примечание:'' Ключ-АСТРОМ SaaS может использовать только <code>External</code>область сети.
#* '''Токен''' — это токен, который вы создали в предыдущей процедуре. Он должен включать в'''ыборку данных из области удаленной среды''' ( <code>RestRequestForwarding</code>).
#* '''Тестовое соединение''' проверяет подключение из вашей локальной среды к удаленной среде.

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

== Создание плитки, отображающей удаленные данные ==
Чтобы создать плитку, которая извлекает данные из удаленной среды

# Отобразите панель мониторинга, на которой будет отображаться плитка.
# Выберите '''Изменить''' .
# Выберите или добавьте плитку, на которой вы хотите отображать данные из удаленной среды. В разделе '''«Среда»''' панели настроек плитки отображается имя среды, из которой эта плитка извлекает данные мониторинга.
#* '''Значение по умолчанию (локальное)''' настраивает плитку на извлечение данных из локальной среды Ключ-АСТРОМ.
#* Все остальные перечисленные среды являются удаленными средами, для которых установлено соединение.
# Выберите удаленную среду, которую вы хотите, чтобы выбранная плитка запрашивала. Если вы назвали удаленную среду <code>ABC</code>при добавлении удаленной среды в предыдущей процедуре, она <code>ABC</code>должна быть в этом списке.
# Выберите '''Готово''' , чтобы отобразить готовую панель мониторинга.
# Наведите указатель мыши на значок фильтра плитки, чтобы увидеть выбор среды.

== Примеры ==

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

# В меню Ключ-АСТРОМ перейдите к '''Дашборды''' , выберите '''Создать дашборд''' , дайте ему имя и выберите '''Создать''' .
# Перетащите две плитки '''заголовков''' на панель мониторинга (или перетащите одну, а затем клонируйте ее).
# Отредактируйте один заголовок так, чтобы он был '''Локально''' , а другой — '''Удалённо''' .
# Перетащите две плитки '''работоспособности узла''' на панель управления (или перетащите одну, а затем клонируйте ее). Поместите один под заголовком '''Локально''' , а другой под заголовком '''Удалённо'''
#.
# Перетащите две плитки '''состояния сети''' на панель управления (или перетащите одну, а затем клонируйте ее). Поместите одну под заголовком '''Локально''' , а другой под заголовком '''Удалённо''' . На этом этапе все плитки запрашивают локальную среду, поэтому у вас есть две идентичные плитки '''работоспособности хоста''' и две идентичные плитки '''состояния сети''' .
# Под заголовком '''«Удаленно»''' отредактируйте плитки '''«Состояние хоста »''' и '''«Состояние сети»''' , чтобы они оба запрашивали удаленную среду ( <code>ABC</code>в этом примере).
# Выберите '''Готово''' , чтобы отобразить панель мониторинга.
#* Плитки в разделе '''«Локально»''' по-прежнему отображают информацию о локальном хосте и сети.
#* Плитки в разделе '''Удалённо''' теперь запрашивают удаленную среду:
#** Удаленные плитки отображают работоспособность хоста и состояние сети для удаленной среды, а не для локальной среды по умолчанию.
#** На каждой удаленной плитке отображается значок фильтра. Наведите указатель мыши на значок, чтобы увидеть название среды.

Конечно, вы можете добавить другие типы плиток и указать на дополнительные удаленные среды.

== Поиск неисправностей ==
'''''При настройке плитки я не вижу удаленную среду в списке Среда'''''

Если вы не видите удаленную среду в списке «Среда» для своей плитки, убедитесь, что среда указана в таблице '''«Удаленные среды»''' .

# В меню Ключ-АСТРОМ перейдите в '''«Настройки»''' .
# Выберите '''Интеграция''' > '''Удаленные среды''' .
# Найдите среду в таблице '''удаленных сред''' .
#* Убедитесь, что вы ищете правильное имя.
#* Убедитесь, что среда не была удалена.

'''''«Проверка не удалась, проверьте настройки: ограничения нарушены». Сообщение, отображаемое при добавлении удаленной среды.'''''

Сообщение <code>Verification failed, please check your settings: Constraints violated.</code>указывает на ошибку конфигурации.

Что проверить:

* '''Имя''' — это текст произвольной формы, поэтому он не имеет значения для функциональности, но проверьте его, чтобы убедиться, что вы смотрите на правильную среду.
* '''URI удаленной среды''' — скопируйте и вставьте содержимое этого поля на новую вкладку браузера и убедитесь, что она открывает правильную среду Ключ-АСТРОМ.
* '''Токен''' — убедитесь, что вы скопировали и вставили токен целиком в это поле. Если вы потеряли этот токен, вы не можете вернуться и скопировать его снова, но вы можете создать новый и получить от него токен.

Настройка прокси АктивногоШлюза

2022-09-28T20:07:48Z

RGolovanov:

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

== Свойства конфигурации прокси ==
Конфигурация прокси АктивногоШлюза состоит из следующих настроек. В зависимости от типа связи, для которой вы хотите использовать (или отключить) прокси, следующие свойства конфигурации могут появиться в разных разделах конфигурации вашей конфигурации АктивногоШлюза.
{| class="wikitable"
!Свойство
!Описание
|-
|<code>proxy-server</code>
|Адрес сервера (имя хоста или IP-адрес)
|-
|<code>proxy-port</code>
|Порт (необязательно)

Если оставить пустым, используется порт <code>8080</code> по умолчанию.
|-
|<code>proxy-user</code>
|Имя пользователя (необязательно)
|-
|<code>proxy-domain</code>
|Домен пользователя в случае аутентификации NTLM
|-
|<code>proxy-password</code>
|Пароль (необязательно)

Пароль, указанный в свойстве <code>proxy-password</code>, обфусцируется после перезапуска АктивногоШлюза, а замаскированный пароль сохраняется в свойстве <code>proxy-password-encr</code>.
|-
|<code>proxy-off</code>
|Если установлено значение <code>true</code>, прокси отключается для определенного типа связи.
|-
|<code>proxy-non-proxy-hosts</code>
|Список хостов, для связи с которыми АктивныйШлюз не должен использовать прокси

Хосты в списке должны быть разделены символом <code>|</code> персонажи. Вы также можете использовать звездочку <code>*</code> в качестве подстановочного знака для соответствия любой строке. Может быть только один подстановочный знак в начале или в конце имени хоста. Например, <code>proxy-non-proxy-hosts=*.foo.com|localhost</code> указывает, что каждый хост в домене <code>foo.com</code> и <code>localhost</code> должен быть доступен напрямую, даже если указан прокси-сервер. Полное описание допустимого синтаксиса см. в синтаксисе параметра <code>http.nonProxyHosts</code> в свойствах сети.
|}

== Конфигурация прокси для АктивногоШлюза ==
Конфигурация прокси АктивногоШлюза может быть указана во время установки АктивногоШлюза в Linux или Windows (только настройка для всех исходящих соединений), либо ее можно настроить после установки АктивногоШлюза. Чтобы настроить прокси для АктивногоШлюза:

* Отредактируйте файл <code>custom.properties</code> в каталоге конфигурации АктивногоШлюза.
* Укажите параметры прокси в соответствующем разделе конфигурации файла <code>custom.properties</code>, в зависимости от того, для каких целей вы хотите использовать прокси (см. примеры ниже). Например:

<code>[http.client]
proxy-server=127.0.0.1
proxy-port=8080
# basic authentication credentials
proxy-user=username
proxy-password=password</code>

* Сохраните файл <code>custom.properties</code>.
* Перезапустите основную службу АктивногоШлюза. Обратите внимание, что после перезапуска службы пароль прокси, указанный вами в конфигурации, шифруется и перемещается из свойства <code>proxy-password</code> в <code>proxy-password-encr</code>.

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

=== Прокси для всего исходящего трафика ===
[[Файл:ПроксиАктивногоШлюзаДляВсегоТрафика.png]]

Следующая конфигурация охватывает наиболее распространенный случай указания параметров прокси-сервера для исходящего соединения АктивногоШлюза как с кластером Ключ-Астром, так и с отслеживаемыми технологиями, такими как AWS, VMware или Azure.

Укажите параметры, связанные с прокси, в разделе <code>[http.client]</code> файла <code>custom.properties</code>, включая параметры, связанные с аутентификацией, если это необходимо:
<code>[http.client]
proxy-server=127.0.0.1
proxy-port=8080
# basic authentication credentials
proxy-user=username
proxy-password=password</code>

=== Прокси только для кластера ===
[[Файл:ПроксиАктивногоШлюзаДляКластера.png]]

Чтобы настроить прокси специально для кластера, позволяя исходящему мониторинговому трафику напрямую подключаться к отслеживаемым технологиям, задайте настройки прокси в разделе <code>[http.client.internal]</code> конфигурации АктивногоШлюза.
<code>[http.client.internal]
proxy-server=127.0.0.1
proxy-port=8080
# basic authentication credentials
proxy-user=username
proxy-password=password</code>
'''Примечание:'''

Для корректной работы связи АктивногоШлюза после указания вышеперечисленных настроек вам потребуется повторить настройки связи без прокси в <code>http.client.internal</code> или <code>http.client.external</code> и/или вам потребуется создать разделы <code>http.client.internal</code> или <code>http.client.external</code>.

=== Прокси для исходящего трафика с прямым подключением к кластеру ===
[[Файл:ПроксиАктивногоШлюзаДляКластераИТрафика.png]]

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

* Укажите конфигурацию прокси в разделе <code>[http.client]</code> файла <code>custom.properties</code>.
* Отключите прокси в разделе <code>[http.client.internal]</code>.

<code>[http.client]
proxy-server=127.0.0.1
proxy-port=8080
# basic authentication credentials
proxy-user=username
proxy-password=password

[http.client.internal]
proxy-off=true</code>
'''Примечание:'''

Для корректной работы связи АктивногоШлюза после указания вышеперечисленных настроек вам потребуется повторить настройки связи без прокси в <code>http.client.internal</code> или <code>http.client.external</code> и/или вам потребуется создать разделы <code>http.client.internal</code> или <code>http.client.external</code>.

== Расширенные сценарии настройки прокси для АктивногоШлюза ==
Чтобы настроить прокси '''для исходящих подключений''' из АктивногоШлюза, то есть для подключений к отслеживаемым технологиям или к кластеру, отредактируйте файл <code>custom.properties</code> и задайте свойства в соответствующем разделе. В зависимости от раздела конфигурации, в котором указаны свойства, прокси (и другие параметры связи) влияют только на выбранные типы соединений:

* <code>[http.client]</code> — настройки прокси для всех исходящих соединений АктивногоШлюза, включая кластер и все отслеживаемые технологии.
* <code>[http.client.internal]</code> — настройки прокси специально для связи с кластером. Эти настройки переопределяют настройки, указанные в <code>[http.client]</code>.
* <code>[http.client.external]</code> — настройки прокси специально для отслеживаемых технологий: CloudFoundry, Kubernetes, приватный синтетический мониторинг. Эти настройки переопределяют настройки, указанные в <code>[http.client]</code>.
* <code>[<technology name>]</code> — настройки прокси специально для конкретной отслеживаемой технологии, например <code>cloudfoundry_monitoring</code>, <code>kubernetes_monitoring</code>, <code>synthetic</code>. Эти параметры переопределяют параметры, указанные в <code>[http.client]</code> и <code>[http.client.external]</code>. Обратите внимание, что настройки для многих из этих технологий можно указать совместно в <code>[http.client.external]</code>.

=== Прокси для Kubernetes, Cloud Foundry и Синтетики ===
Вы можете указать настройки прокси сразу для нескольких отслеживаемых технологий. Настройки, указанные в разделе <code>http.client.external</code>, влияют на Kubernetes, CloudFoundry и приватный синтетический мониторинг (этот набор может быть расширен в будущем):
<code>[http.client.external]
proxy-server=127.0.0.1
proxy-port=8080
# basic authentication credentials
proxy-user=username
proxy-password=password</code>
'''Примечание:'''

Для корректной работы связи АктивногоШлюза после указания вышеперечисленных настроек вам потребуется повторить настройки связи без прокси в <code>http.client.internal</code> или <code>http.client.external</code> и/или вам потребуется создать разделы <code>http.client.internal</code> или <code>http.client.external</code>.

=== Разные настройки прокси для Kubernetes, Cloud Foundry и Синтетики ===
Вы также можете указать выделенные настройки прокси для конкретной отслеживаемой технологии:

* Cloud Foundry в разделе <code>cloudfoundry_monitoring</code>
* Kubernetes в разделе <code>kubernetes_monitoring</code>
* Приватный синтетический мониторинг в разделе <code>synthetic</code>

<code>[kubernetes_monitoring]
proxy-server=127.0.0.1
proxy-port=8080
# basic authentication credentials
proxy-user=username
proxy-password=password</code>

== Текущие ограничения ==

=== Повторение настроек связи в <code>[http.client.internal]</code> или <code>[http.client.external]</code>. ===
При указании конфигурации прокси в <code>[http.client.internal]</code> или <code>[http.client.external]</code> обратите внимание, что эти разделы затрагивают различные аспекты связи, а не только прокси. При создании любого из этих разделов обязательно сначала скопируйте содержимое существующего раздела <code>[http.client]</code> из файла <code>configuration.properties</code> (и настройте его соответствующим образом):

* Откройте файл <code>config.properties</code> и скопируйте все свойства из раздела <code>[http.client]</code> в файл <code>custom.properties</code>, раздел <code>[http.client.internal]</code> или <code>[http.client.external]</code> (в зависимости от ситуации).
* Если в файле <code>custom.properties</code> есть раздел <code>[http.client]</code>, используйте перечисленные там значения, чтобы перезаписать указанные выше значения (значения, которые вы только что скопировали из <code>config.properties</code>).

<code>[http.client.external]
# proxy settings as specific to http.client.external:
proxy-server=127.0.0.1
proxy-port=8080
# basic authentication credentials
proxy-user=username
proxy-password=password
# communication settings copied from existing configuration:
connection-timeout=5000
socket-timeout=20000
connection-request-timeout=5000
idle-connection-timeout=15000
max-total-connections=256
max-connections-per-route=32
certificate-validation=yes
hostname-verification=yes</code>

Схемы подключения АктивныхШлюзов

2022-09-28T20:05:28Z

RGolovanov: Новая страница: «В зависимости от ваших конкретных требований АктивныйШлюз можно использовать в '''Ключ-А...»

В зависимости от ваших конкретных требований АктивныйШлюз можно использовать в '''Ключ-Астром''' '''SaaS''' или '''Managed'''. Ключ-Астром Managed имеет [[Развертывания Managed|несколько сценариев развёртывания]].

Ключ-Астром требует, чтобы определенные порты и пути были открыты и доступны через контролируемую инфраструктуру, брандмауэры и другие компоненты. Порты настраиваются, и здесь показаны значения по умолчанию.

== Схема Ключ-Астром SaaS ==
Сплошные стрелки указывают предпочтительные пути. Например, ЕдиныйАгент подключится к АктивномуШлюзу Окружения, если таковой имеется. Однако он будет подключаться к кластеру Ключ-Астром Saas напрямую, если подключение к АктивномуШлюзу Окружения невозможно. Направление стрелок на диаграммах указывает, какой компонент инициирует соединение.

[[Файл:АктивныеШлюзы-SaaS.png]]

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

[[Файл:АктивныеШлюзы-Managed.png]]

== Использование портов ==

* АктивныйШлюз Окружения принимает соединения на порт 9999.
* АктивныйШлюз Кластера принимает соединения на порт 9999.
* Кластер SaaS получает соединения через порт 443.
* Кластер Ключ-Астром Managed (встроенный АктивныйШлюз) принимает соединения через порт 443.

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

Для подключения АктивногоШлюза в Ключ-Астром Managed, АктивныйШлюз должен иметь сетевой доступ к другим службам, а также к определенным портам, в зависимости от вашего [[Развертывания Managed|сценария развертывания]].

== Иерархия соединений ==
АктивныеШлюзы существуют в следующей иерархии:

* Уровень 1 — АктивныеШлюзы Окружения
* Уровень 2 — АктивныеШлюзы Кластера
* Уровень 3 — Встроенные в кластер АктивныеШлюзы.

АктивныйШлюз может отправлять данные только на более высокие уровни иерархии. Невозможно отправить данные на тот же или более низкий уровень иерархии.

'''Примечание'''. АктивныеШлюзы окружения по умолчанию подключаются напрямую к кластеру (если не используются настраиваемые сетевые зоны). Это устраняет промежуточный этап подключения к АктивномШлюзу Кластера. Подключение через АктивныйШлюз Кластера необходимо организовать, если кластер недоступен напрямую. Например, если АктивныйШлюз Окружения находится в другой сети или в другом центре обработки данных.

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

== Настройка прокси и балансировщика загрузки ==
Все компоненты Ключ-Астром (ЕдиныеАгенты, АктивныеШлюзы, Кластер) определяют свои имена хостов и распределяют их между собой в качестве конечных точек связи для достижения максимально возможной надежности соединения.

Это работает автоматически, если только в вашей среде нет сетевых устройств (прокси, балансировщиков загрузки), которые следует учитывать и о которых Ключ-Астром не знает.

На приведенной ниже диаграмме показаны все возможные варианты размещения прокси и балансировщика загрузки (обратного прокси) для развертывания АктивногоШлюза. Для простоты прямые подключения на этой диаграмме не показаны. Альтернативные подключения (которые подключаются через один или несколько прокси-серверов или балансировщиков загрузки) показаны пунктирными линиями.

* Если между ЕдинымиАгентами и АктивнымиШлюзами есть балансировщик загрузки, вы должны указать адрес балансировщика загрузки в качестве свойства <code>dnsEntryPoint</code> в конфигурации АктивногоШлюза.
* Если между АктивнымШлюзом и следующей конечной точкой связи, через которую должен проходить трафик, есть балансировщик загрузки, настройте <code>seedServerUrl</code> и <code>ignoreClusterRuntimeInfo</code>.
* Если для доступа к кластеру или любому из отслеживаемых облаков используется прокси-сервер, настройте прокси-сервер.

[[Файл:АктивныеШлюзыБалансировщикиЗагрузки.png]]

Файл:АктивныеШлюзыБалансировщикиЗагрузки.png

2022-09-28T20:02:09Z

RGolovanov:

АктивныеШлюзыБалансировщикиЗагрузки

Файл:АктивныеШлюзы-Managed.png

2022-09-28T19:35:04Z

RGolovanov:

АктивныеШлюзы-Managed

Файл:АктивныйШлюз-Managed.png

2022-09-28T19:34:00Z

RGolovanov:

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

Файл:АктивныеШлюзы-SaaS.png

2022-09-28T19:28:32Z

RGolovanov:

АктивныеШлюзы-SaaS

Директории АктивногоШлюза

2022-09-28T19:16:16Z

RGolovanov: Новая страница: «== Linux == {| class="wikitable" !'''Цель каталога''' !'''Путь по умолчанию'''Путь относительно параметра ус...»

== Linux ==
{| class="wikitable"
!'''Цель каталога'''
!'''Путь по умолчанию'''Путь относительно параметра установки
!'''Требования к дисковому пространству'''(если размер не указан, предположим, что он меньше 1 МБ)
|-
|Исполняемые файлы АктивногоШлюза, библиотеки и связанные файлы
|<code>/opt/AstromKey/gateway</code><code><INSTALL>/gateway</code>
|300 МБ
|-
|Конфигурация АктивногоШлюза
|<code>/var/lib/AstromKey/gateway/config</code><code><CONFIG>/gateway/config</code>
|
|-
|SSL-папка АктивногоШлюза
|<code>/var/lib/AstromKey/gateway/ssl</code><code><CONFIG>/gateway/ssl</code>
|
|-
|Временные файлы АктивногоШлюза
|<code>/var/tmp/AstromKey/gateway</code><code><TEMP>/gateway</code>
|4 ГБ (включая 3 ГБ для кэшированных установщиков ЕдиныхАгентов и образов контейнеров)
|-
|Логи АктивногоШлюза
|<code>/var/log/AstromKey/gateway</code><code><LOG>/gateway</code>
|500 МБ
|-
|Файлы дампа, загруженные в АктивныйШлюз ЕдинымАгентом
|<code>/var/lib/AstromKey/gateway/dump</code>
|Функциональность отключена по умолчанию. При активации может принимать настраиваемый максимальный размер: по умолчанию 100 ГБ.
|-
|Каталог пакетов АктивногоШлюза для загрузки установщика автоматического обновления
|<code>/var/lib/AstromKey/packages</code><code><PACKAGES_DIR></code>
|500 МБ
|-
|Исполняемые файлы расширений 1.0 и 2.0 АктивногоШлюза, библиотеки и связанные файлы
|<code>/opt/AstromKey/remotepluginmodule</code><code><INSTALL>/remotepluginmodule</code>
|350 МБ
|-
|Конфигурация расширений 1.0 и 2.0 АктивногоШлюза, журналы, кеш, рабочая область во время выполнения
|<code>/var/lib/AstromKey/remotepluginmodule</code><code><CONFIG>/remotepluginmodule</code>
|2 ГБ (для журналов и аварийных дампов)
|-
|Каталог загрузки расширений АктивногоШлюза
|<code>/opt/AstromKey/remotepluginmodule/plugin_deployment/</code>
|В зависимости от загруженных расширений
|-
|zRemote исполняемые файлы, библиотеки и связанные файлы
|<code>/opt/AstromKey/zremote</code>Использование каталогов не по умолчанию не поддерживается.
|50 МБ
|-
|zRemote редактируемая пользователем постоянная конфигурация,
zRemote Рабочая область удаленного выполнения, отчеты о сбоях
|<code>/var/lib/AstromKey/zremote/agent</code>Использование каталогов не по умолчанию не поддерживается.
|50 МБ
|-
|Логи zRemote
|<code>/var/lib/AstromKey/zremote/log</code>Установка АктивногоШлюзас zRemote в каталоги, отличные от каталогов по умолчанию, не поддерживается.
|200 МБ
|-
|Частные синтетические исполняемые файлы, библиотеки и связанные файлы
|<code>/opt/AstromKey/synthetic</code><code><INSTALL>/synthetic</code>
|270 МБ
|-
|Приватные синтетические логи
|<code>/var/log/AstromKey/synthetic</code><code><LOG>/synthetic/log</code>
|1 ГБ
|-
|Частные синтетические временные файлы
|<code>/var/tmp/AstromKey/synthetic</code>
|20 ГБ, в том числе
1 ГБ для <code>/var/tmp/AstromKey/synthetic/cache</code> и

1 ГБ для <code>/var/tmp/AstromKey/synthetic/screenshots</code>
|-
|Автообновление
|<code>/opt/AstromKey/autoupdater</code><code><INSTALL>/autoupdater</code>
|Включено в оценку исполняемых файлов АктивногоШлюза
|-
|Логи автообновления
|<code>/var/log/AstromKey/autoupdater</code><code><LOG>/autoupdater</code>
|200 МБ
|}

== Windows ==
'''Примечание'''. В Windows каталог %PROGRAMDATA% обычно скрыт для непривилегированных пользователей. Поэтому вы не можете выбрать его, просматривая папки. Вместо этого, чтобы получить доступ к папке, вставьте путь к папке непосредственно в поле адреса Проводника Windows.
{| class="wikitable"
!'''Цель каталога'''
!'''Путь по умолчанию'''Путь относительно параметра установки
!'''Требования к дисковому пространству'''(если размер не указан, предположим, что он меньше 1 МБ)
|-
|Исполняемые файлы АктивногоШлюза, библиотеки и связанные файлы
|<code>%PROGRAMFILES%\AstromKey\gateway</code><code><INSTALL>\gateway</code>
|300 МБ
|-
|Конфигурация АктивногоШлюза
|<code>%PROGRAMDATA%\AstromKey\gateway\config</code>
|
|-
|SSL-папка АктивногоШлюза
|<code>%PROGRAMDATA%\AstromKey\gateway\ssl</code>
|
|-
|Временные файлы АктивногоШлюза
|<code>%PROGRAMDATA%\AstromKey\gateway\tmp</code>
|4 ГБ (включая 3 ГБ для кэшированных установщиков ЕдиныхАгентов и образов контейнеров)
|-
|Логи АктивногоШлюза
|<code>%PROGRAMDATA%\AstromKey\gateway\log</code>
|500 МБ
|-
|Файлы дампа, загруженные в АктивныйШлюз ЕдинымАгентом
|<code>%PROGRAMDATA%\AstromKey\gateway\dump</code>
|Функциональность отключена по умолчанию. При активации может принимать настраиваемый максимальный размер: по умолчанию 100 ГБ.
|-
|Каталог пакетов АктивногоШлюза для загрузки установщика автоматического обновления
|<code>%PROGRAMDATA%\AstromKey\packages</code>
|500 МБ
|-
|Исполняемые файлы расширений 1.0 и 2.0 АктивногоШлюза, библиотеки и связанные файлы
|<code>%PROGRAMFILES%\AstromKey\remotepluginmodule</code>
|350 МБ
|-
|Конфигурация расширений 1.0 и 2.0 АктивногоШлюза, журналы, кеш, рабочая область во время выполнения
|<code>%PROGRAMDATA%\AstromKey\remotepluginmodule</code>
|2 ГБ (для логов и аварийных дампов)
|-
|Каталог загрузки расширений АктивногоШлюза
|<code>%PROGRAMFILES%\AstromKey\remotepluginmodule\plugin_deployment</code>
|В зависимости от загруженных расширений
|-
|zRemote исполняемые файлы, библиотеки и связанные файлы
|<code>%PROGRAMFILES%\AstromKey\zremote</code>
|50 МБ
|-
|zRemote редактируемая пользователем постоянная конфигурация,
zRemote Рабочая область удаленного выполнения, отчеты о сбоях
|<code>%PROGRAMDATA%\AstromKey\zremote\agent</code>
|50 МБ
|-
|Логи zRemote
|<code>%PROGRAMDATA%\AstromKey\zremote\log</code>
|200 МБ
|-
|Частные синтетические исполняемые файлы, библиотеки и связанные файлы
|<code>%PROGRAMFILES%\AstromKey\synthetic</code>
|270 МБ
|-
|Приватные синтетические логи
|<code>%PROGRAMDATA%\AstromKey\synthetic\log</code>
|1 ГБ
|-
|Частные синтетические временные файлы
|<code>%PROGRAMDATA%\AstromKey\synthetic</code>
|20 ГБ, в том числе
1 ГБ для <code>/var/tmp/AstromKey/synthetic/cache</code> и

1 ГБ для <code>/var/tmp/AstromKey/synthetic/screenshots</code>
|-
|Автообновление
|<code>%PROGRAMFILES%\AstromKey\gateway</code>Относительно параметра установки: <code><INSTALL>\gateway</code>
|Включено в оценку исполняемых файлов АктивногоШлюза
|-
|Логи автообновления
|<code>%PROGRAMDATA%\AstromKey\autoupdater\log</code>
|200 МБ
|}

Установка АктивногоШлюза на Windows

2022-09-28T19:15:00Z

RGolovanov:

== Требования к установке ==

=== Аппаратные требования ===
Вам нужна машина, предназначенная для АктивногоШлюза, которая имеет:

* 4 ГБ свободного места на диске для установки АктивногоШлюза и расширений, настройки и журналов для автоматического обновления.
* 4 ГБ для кэшированных установщиков АктивногоШлюза и ЕдиногоАгента и образов контейнеров — если их нужно будет хранить.
* Место для файлов дампа — если их нужно будет сохранить. Эта функция отключена по умолчанию, но ее можно включить в конфигурации АктивногоШлюза. Максимальный размер дискового пространства настраивается — по умолчанию 100 ГБ.
* Место для загрузки расширений — в зависимости от используемых расширений.
* 2 ГБ оперативной памяти (рекомендуется 4 ГБ).
* 1 двухъядерный процессор.

Для больших сред вам может понадобиться машина с дополнительным процессором и памятью.

=== Требования к пространству по каталогам ===
{| class="wikitable"
!'''Каталог верхнего уровня'''
!'''Требования к дисковому пространству'''
|-
|Исполняемые файлы АктивногоШлюза и автообновления, библиотеки и сопутствующие файлы

стандартный каталог: <code>%PROGRAMFILES%\AstromKey\gateway</code>

относительно параметра установки: <code><INSTALL>\gateway</code>
|300 МБ
|-
|Конфигурация АктивногоШлюза и связанные каталоги

Для АктивногоШлюза Окружения он также содержит конфигурацию Extensions 1.0 и Extensions 2.0.

стандартный каталог: <code>%PROGRAMDATA%\AstromKey</code>

относительно параметра установки: <code><CONFIG></code>
|2 МБ
|-
|Только для АктивногоШлюза Окружения: Исполняемые файлы Extensions 1.0 и Extensions 2.0, библиотеки и связанные файлы по умолчанию: <code>%PROGRAMFILES%\AstromKey\remotepluginmodule</code>

относительно параметра установки: <code><INSTALL>\remotepluginmodule</code>
|350 МБ
|-
|Журналы АктивныхШлюзов и автообновления

стандартный каталог: <code>%PROGRAMDATA%\AstromKey</code>

параметр установки: <code><LOG></code>
|1.2 ГБ
|-
|Временные файлы АктивногоШлюза

default: <code>%PROGRAMDATA%\AstromKey\gateway\tmp</code>

путь относительно параметра установки: <code><TEMP>\gateway</code>
|4 ГБ (включая 3 ГБ для кэшированных установщиков OneAgent и образов контейнеров)
|-
|Файлы дампа, загруженные в АктивныйШлюз ЕдинымАгентом

<code>%PROGRAMDATA%\AstromKey\gateway\dump</code>
|Функциональность отключена по умолчанию, не настраивается во время установки.

При активации может принимать настраиваемый максимальный размер: по умолчанию 100 ГБ.
|-
|Только для АктивногоШлюза Окружения: журналы расширений 1.0 и 2.0 АктивногоШлюза, кэш, рабочая область во время выполнения

стандартный каталог: <code>%PROGRAMDATA%\AstromKey\remotepluginmodule</code>

путь относительно параметра установки: <code><CONFIG>\remotepluginmodule</code>
|2 ГБ
|-
|Только для АктивногоШлюза Окружения: Каталог загрузки расширений

стандартный каталог: <code>%PROGRAMFILES%\AstromKey\remotepluginmodule\plugin_deployment</code>

путь относительно параметра установки: <code><INSTALL>\remotepluginmodule\plugin_deployment</code>
|В зависимости от загруженных расширений
|}

=== Поддерживаемые операционные системы ===
{| class="wikitable"
!Дистрибутив Linux
!Версии
!Архитектуры ЦП
|-
| rowspan="1" |Windows
|8.1, 10
|x86-64
|-
| rowspan="1" |Windows Server
|2012, 2012 R2, 2016, 2019, 2022
|x86-64
|}

=== Системные требования ===

* АктивныйШлюз поддерживает только операционные системы, работающие на архитектуре x86-64 (64-битные Intel/AMD).
* Убедитесь, что у вас правильная конфигурация сетевого порта.
* Установка АктивногоШлюза не поддерживается в Windows с отключенной учетной записью <code>NT AUTHORITY\LocalService</code>.

=== Размеры AWS ===
В таблице представлены требования к размеру экземпляра машины в зависимости от количества агентов ЕдиныхАгентов, взаимодействующих с АктивнымШлюзом. На каждом хосте ЕдиныйАгент выполняет семь задач мониторинга:

* Мониторинг инфраструктуры
* Мониторинг логов
* Полный стек мониторинга 3 экземпляров Apache Tomcat
* Полный стек мониторинга 2 экземпляров HTTP-сервера Apache

{| class="wikitable"
!Размер машины
!Количество хостов
|-
|c4.large
|450
|-
|c4.xlarge
|900
|-
|c4.2xlarge
|1200
|}
Экземпляры машин С4:
{| class="wikitable"
!Машина
!vCPU
!Память (ГБ)
!Хранилище
!Выделенная пропускная способность EBS (Мбит/с)
!Производительность сети
|-
|c4.large
|2
|3.75
|EBS-Only
|500
|Умеренная
|-
|c4.xlarge
|4
|7.5
|EBS-Only
|750
|Высокая
|-
|c4.2xlarge
|8
|15
|EBS-Only
|1,000
|Высокая
|}

== Установка АктивногоШлюза ==

=== Разрешите подключения через брандмауэр ===
Убедитесь, что настройки вашего брандмауэра разрешают связь с Ключом-Астром.

В зависимости от политики вашего брандмауэра вам может потребоваться явно разрешить определенные исходящие соединения.

АктивныйШлюз обычно прослушивает (принимает входящие соединения) порт <code>9999</code> и взаимодействует с Ключом-Астром (устанавливает исходящие соединения) через порт <code>443</code>.

=== Установка ===

# Войдите в Ключ-Астром, выберите '''Развернуть Ключ-Астром''' в меню навигации и выберите '''Установить АктивныйШлюз'''.
# На странице '''Установка АктивногоШлюза Окружения''' выберите '''Windows'''.
# Выберите [https://doc.ruscomtech.ru/index.php/%D0%A6%D0%B5%D0%BB%D0%B8%20%D0%90%D0%BA%D1%82%D0%B8%D0%B2%D0%BD%D0%BE%D0%B3%D0%BE%D0%A8%D0%BB%D1%8E%D0%B7%D0%B0 цель АктивногоШлюза].
# Предоставьте PaaS-токен. Он необходим для загрузки установщика АктивногоШлюза из вашей среды. Если у вас нет токена PaaS, вы можете создать его прямо в пользовательском интерфейсе. Токен автоматически добавляется к командам загрузки и установки, которые вы будете использовать позже.
# Скачайте установщик по скопированной cmd-команде или по ссылке.
# Запустите установщик '''с правами администратора'''.

==== Конфигурация установки ====
Вы можете добавить дополнительные параметры в команду установки, чтобы настроить установку. Например, чтобы установить АктивныйШлюз в другой каталог, используйте параметр <code>INSTALL=<путь></code>:
<code>C:\ AstromKey-ActiveGate-Windows-x86-1.0.0.exe '''INSTALL=D:\hosted_app\AstromKey'''</code>

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

Чтобы проверить статус установки, выберите '''Показать статус развертывания''' и перейдите на вкладку '''АктивныеШлюзы'''.
==Стандартные настройки установщика==
Если вы не укажете какие-либо параметры во время установки АктивногоШлюза для настройки параметров, будут применены следующие параметры по умолчанию.
===Каталоги===
{| class="wikitable"
!'''Цель каталога'''
!'''Путь по умолчанию'''Путь относительно параметра установки
!'''Требования к дисковому пространству'''(если размер не указан, предположим, что он меньше 1 МБ)
|-
|Исполняемые файлы АктивногоШлюза, библиотеки и связанные файлы
|<code>%PROGRAMFILES%\AstromKey\gateway</code><code><INSTALL>\gateway</code>
|300 МБ
|-
|Конфигурация АктивногоШлюза
|<code>%PROGRAMDATA%\AstromKey\gateway\config</code>
|
|-
|SSL-папка АктивногоШлюза
|<code>%PROGRAMDATA%\AstromKey\gateway\ssl</code>
|
|-
|Временные файлы АктивногоШлюза
|<code>%PROGRAMDATA%\AstromKey\gateway\tmp</code>
|4 ГБ (включая 3 ГБ для кэшированных установщиков ЕдиныхАгентов и образов контейнеров)
|-
|Логи АктивногоШлюза
|<code>%PROGRAMDATA%\AstromKey\gateway\log</code>
|500 МБ
|-
|Файлы дампа, загруженные в АктивныйШлюз ЕдинымАгентом
|<code>%PROGRAMDATA%\AstromKey\gateway\dump</code>
|Функциональность отключена по умолчанию. При активации может принимать настраиваемый максимальный размер: по умолчанию 100 ГБ.
|-
|Каталог пакетов АктивногоШлюза для загрузки установщика автоматического обновления
|<code>%PROGRAMDATA%\AstromKey\packages</code>
|500 МБ
|-
|Исполняемые файлы расширений 1.0 и 2.0 АктивногоШлюза, библиотеки и связанные файлы
|<code>%PROGRAMFILES%\AstromKey\remotepluginmodule</code>
|350 МБ
|-
|Конфигурация расширений 1.0 и 2.0 АктивногоШлюза, журналы, кеш, рабочая область во время выполнения
|<code>%PROGRAMDATA%\AstromKey\remotepluginmodule</code>
|2 ГБ (для логов и аварийных дампов)
|-
|Каталог загрузки расширений АктивногоШлюза
|<code>%PROGRAMFILES%\AstromKey\remotepluginmodule\plugin_deployment</code>
|В зависимости от загруженных расширений
|-
|zRemote исполняемые файлы, библиотеки и связанные файлы
|<code>%PROGRAMFILES%\AstromKey\zremote</code>
|50 МБ
|-
|zRemote редактируемая пользователем постоянная конфигурация,
zRemote Рабочая область удаленного выполнения, отчеты о сбоях
|<code>%PROGRAMDATA%\AstromKey\zremote\agent</code>
|50 МБ
|-
|Логи zRemote
|<code>%PROGRAMDATA%\AstromKey\zremote\log</code>
|200 МБ
|-
|Частные синтетические исполняемые файлы, библиотеки и связанные файлы
|<code>%PROGRAMFILES%\AstromKey\synthetic</code>
|270 МБ
|-
|Приватные синтетические логи
|<code>%PROGRAMDATA%\AstromKey\synthetic\log</code>
|1 ГБ
|-
|Частные синтетические временные файлы
|<code>%PROGRAMDATA%\AstromKey\synthetic</code>
|20 ГБ, в том числе
1 ГБ для <code>/var/tmp/AstromKey/synthetic/cache</code> и

1 ГБ для <code>/var/tmp/AstromKey/synthetic/screenshots</code>
|-
|Автообновление
|<code>%PROGRAMFILES%\AstromKey\gateway</code>

Относительно параметра установки: <code><INSTALL>\gateway</code>
|Включено в оценку исполняемых файлов АктивногоШлюза
|-
|Логи автообновления
|<code>%PROGRAMDATA%\AstromKey\autoupdater\log</code>
|200 МБ
|}
===Службы===
{| class="wikitable"
|'''Название компонента'''
|'''Наименование службы'''
|'''Учетная запись пользователя'''
|'''Описание'''
|-
|АктивныйШлюз
|<code>AstromKeygateway</code>
|<code>Local Service</code>
|Основной сервис АктивногоШлюза. Присутствует для всех целей и функциональных модулей.
|-
|Автообновление АктивногоШлюза
|<code>AstromKeyautoupdater</code>
|<code>Local Service</code>
|Сервис автоматического обновления. Присутствует для всех целей и функциональных модулей АктивногоШлюза.
|-
|Расширения 1.0 (удаленный подключаемый модуль)
|<code>remotepluginmodule</code>
|<code>Local Service</code>
|Сервис для функционального модуля Extensions 1.0. Присутствует на АктивныхШлюзах, установленных для мониторинга маршрутизации. Эта служба будет активной или неактивной в зависимости от конфигурации — настройки по умолчанию см. в описании модуля.
|-
|Расширения 2.0
|<code>extensionsmodule</code>
|<code>Local Service</code>
|Сервис для функционального модуля Extensions 2.0. Присутствует на АктивныхШлюзах, установленных для мониторинга маршрутизации. Эта служба будет активной или неактивной в зависимости от конфигурации — настройки по умолчанию см. в описании модуля.
|-
|zRemote
|<code>zremote</code>
|<code>Local Service</code>
|Сервис для функционального модуля zRemote. Присутствует на АктивныхШлюзах, установленных с целью маршрутизации трафика z/OS в Ключ-Астром.
|-
|Синтетика
|<code>vuc</code>
|<code>Local Service</code>
|Сервис для Синтетического функционального модуля. Присутствует на АктивныхШлюзах, установленных для запуска синтетических мониторов из частной локации.
|}
===Использование портов===
По умолчанию АктивныйШлюз:
*получает соединения от ЕдиныхАгентов или других АктивныхШлюзов через порт 9999
*получает API Ключ-Астром на порт 9999
*подключается к SaaS или Managed-кластеру через порт 443

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

=== Синтаксис команды установки ===
<code>AstromKey-ActiveGate-Windows-x86-<version>.exe [<parameter1>=<value1>] [<parameter2>=<value2>] ...</code>
Пробелы между именем параметра и значением параметра (вокруг знака <code>=</code>) не допускаются в синтаксисе команды.

=== Конфигурация прокси ===
Конфигурация прокси должна быть указана в следующем формате. Это позволит настроить прокси АктивногоШлюза для всех исходящих соединений (в разделе конфигурации <code>http.client</code>):
<code>PROXY=<схема_прокси><пользователь>:<пароль>@<сервер>:<порт></code>
Где:

* Все компоненты необязательны, кроме <code><server></code>.
* Если не указаны ни <code><пользователь></code>, ни <code><пароль></code>, то символ @ следует опустить.
* <code><пароль></code> можно указать, только если указано имя пользователя.
* ':' после <code><user></code> можно указать, даже если часть пароля пуста.
* <code><схема_прокси></code> не является обязательной и может быть <code>"http://"</code> или <code>"https://"</code>.
* <code><пользователь></code> является необязательным.
* <code><server></code> может быть IP-адресом или DNS-именем, но не путем. Например, если указано «1.2.3.4/textaferslash», будет извлечена только часть IP («1.2.3.4»). Косая черта и следующий за ней текст будут игнорироваться.
* <code><порт></code> является необязательным.

=== Конфигурация обратного прокси (балансировщика нагрузки) ===
На пути от АктивногоШлюза до Кластера можно разместить обратный прокси-сервер или балансировщик нагрузки. Это позволяет вашему АктивномуШлюзу подключаться к любому доступному узлу кластера, распределяя нагрузку между узлами.

Для этого вам необходимо:

* Указать адрес обратного прокси-сервера/балансировщика нагрузки.
* Убедитесь, что АктивныйШлюзбудет игнорировать любую дополнительную информацию о целевом адресе, отправленную из кластера, и, таким образом, будет подключаться только к указанному вами адресу.

Такие параметры конфигурации можно указать во время установки АктивногоШлюза, задав следующие параметры командной строки программе установки:
<code>IGNORE_CLUSTER_RUNTIME_INFO=true SERVER=<адрес_обратного_прокси></code>
Кроме того, вы можете настроить АктивныйШлюз после установки, внеся изменения в конфигурацию АктивногоШлюза.

=== Каталог установки ===
Абсолютный путь к каталогу установки можно указать либо в пользовательском интерфейсе установщика, либо в командной строке (версия АктивногоШлюза 1.232+). Эта папка будет использоваться для установки исполняемых файлов и библиотек АктивногоШлюза.
<code>C:\AstromKey-ActiveGate-Windows-x86-1.0.0.exe INSTALL=D:\hosted_app\AstromKey</code>
Сохраняет установочные файлы в указанном каталоге. Значение по умолчанию для этого параметра (если оно не указано) — <code>/opt/AstromKey</code>. Этот параметр не разрешен во время обновления.

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

Таким образом вы можете указать прокси-сертификат ЦС (сертификат, который будет использоваться при подключении АктивногоШлюза к кластеру). Это позволяет установить соединение с кластером во время установки, позволяя программе установки АктивногоШлюза загрузить и установить любые необходимые дополнительные возможности.

Пароль сертификата указывается в виде файла, из которого считывается пароль.

Абсолютный путь к расположению настраиваемых доверенных корневых сертификатов для добавления:
<code>CA_CERTIFICATE_FILE=<path></code>
Абсолютный путь к местоположению файла, содержащего пароль сертификата:
<code>CA_CERTIFICATE_PASSWORD_FILE=<path></code>
Пример команды:mple:
<code>C:\AstromKey-ActiveGate-Windows-x86-<version>.exe CA_CERTIFICATE_FILE=D:\Users\Fred\myCert.jks CA_CERTIFICATE_PASSWORD_FILE=D:\Users\Fred\myPwd.txt</code>

=== Пользовательский SSL-сертификат ===
Во время установки вы можете указать сертификат аутентификации, который АктивныйШлюз предоставляет подключающимся клиентам, ЕдинымАгентам или подключениям из браузерных клиентов. Если такие сертификаты требуются, это уменьшает усилия по настройке после установки.

Пароль сертификата указывается в виде файла, из которого считывается пароль.

Абсолютный путь к местоположению сертификата аутентификации, который АктивныйШлюз предоставляет подключающимся клиентам, ЕдинымАгентам, или подключениям из браузерных клиентов (таких как RUM JavaScript):
<code>CERTIFICATE_FILE=<path></code>
Абсолютный путь к местоположению файла, содержащего пароль сертификата, для сертификата аутентификации, который АктивныйШлюз предоставляет подключающимся клиентам:
<code>CERTIFICATE_PASSWORD_FILE=<path></code>
Пример команды:
<code>C:\AstromKey-ActiveGate-Windows-x86-<version>.exe CERTIFICATE_FILE=D:\Users\Fred\myCert.jks CERTIFICATE_PASSWORD_FILE=D:\Users\Fred\myPwd.txt</code>

=== Сетевая зона ===
<code>--set-network-zone=<name></code>
Определяет сетевую зону, к которой принадлежит АктивныйШлюз. Он может принадлежать только одной сетевой зоне. Имя сетевой зоны представляет собой строку буквенно-цифровых символов, дефисов <code>(-)</code>, знаков подчеркивания <code>(_)</code> и точек <code>(.)</code>. Точки используются в качестве разделителей, поэтому вы не должны использовать точку в качестве первого символа имени сетевой зоны. Длина строки ограничена 256 символами.

Этот параметр не разрешен во время обновления.

=== Группа ===
<code>--set-group=<name></code>
Определяет группу АктивныхШлюзов, к которой принадлежит АктивныйШлюз. АктивныйШлюз может принадлежать только одной группе. Имя группы АктивныхШлюзов представляет собой строку буквенно-цифровых символов, дефисов (-), знаков подчеркивания (_) и точек (.). Точки используются в качестве разделителей, поэтому вы не должны использовать точку в качестве первого символа имени группы. Длина строки ограничена 256 символами. Вы можете использовать группы АктивныхШлюзов для выполнения массовых действий на ваших АктивныхШлюзах, таких как управление расширениями 2.0, работающими на АктивныхШлюзах.

Этот параметр не разрешен во время обновления.

=== Время соединения ===
<code>ASTROMKEY_ACTIVEGATE_SERVER_CONNECTION_TIMEOUT=<seconds></code>
Определяет максимальное количество секунд (по умолчанию: <code>120</code>), в течение которых программа установки будет ожидать подключения к кластеру. В развертываниях Linux этот параметр необходимо использовать как переменную среды.

Время ожидания соединения, указанное в переменной среды <code>ASTROMKEY_ACTIVEGATE_SERVER_CONNECTION_TIMEOUT=<секунды></code>, используется на двух этапах установки:

* При загрузке дополнительных (необязательных) возможностей.
* При ожидании соединения с кластером в конце установки АктивныхШлюзов: это соединение затем используется АктивнымШлюзом во время его нормальной работы.

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

Чтобы проверить успешность установки и подключения, войдите в AstromKey, в разделе '''Настройки''' выберите '''Статус развертывания''', а затем перейдите на вкладку '''АктивныеШлюзы'''.

Установка АктивногоШлюза на Linux

2022-09-28T19:14:41Z

RGolovanov: /* Стандартные настройки установщика */

== Требования к установке ==

=== Аппаратные требования ===
Вам нужна машина, предназначенная для АктивногоШлюза, которая имеет:

* 4 ГБ свободного места на диске для установки АктивногоШлюза и расширений, настройки и журналов для автоматического обновления.
* 4 ГБ для кэшированных установщиков АктивногоШлюза и ЕдиногоАгента и образов контейнеров — если их нужно будет хранить.
* Место для файлов дампа — если их нужно будет сохранить. Эта функция отключена по умолчанию, но ее можно включить в конфигурации АктивногоШлюза. Максимальный размер дискового пространства настраивается — по умолчанию 100 ГБ.
* Место для загрузки расширений — в зависимости от используемых расширений.
* 2 ГБ оперативной памяти (рекомендуется 4 ГБ).
* 1 двухъядерный процессор.

Для больших сред вам может понадобиться машина с дополнительным процессором и памятью.

=== Требования к пространству по каталогам ===
{| class="wikitable"
!'''Каталог верхнего уровня'''
!'''Требования к дисковому пространству'''
|-
|Исполняемые файлы АктивногоШлюза и автообновления, библиотеки и сопутствующие файлы

стандартный каталог: <code>/opt/AstromKey</code>

относительно параметра установки: <code><INSTALL></code>
|300 МБ
|-
|Конфигурация АктивногоШлюза и связанные каталоги

Для АктивногоШлюза Окружения он также содержит конфигурацию Extensions 1.0 и Extensions 2.0.

стандартный каталог: <code>/var/lib/AstromKey</code>

относительно параметра установки: <code><CONFIG></code>
|2 МБ
|-
|Только для АктивногоШлюза Окружения: Исполняемые файлы Extensions 1.0 и Extensions 2.0, библиотеки и связанные файлы по умолчанию: <code>/opt/AstromKey/remotepluginmodule</code>

относительно параметра установки: <code><INSTALL>/remotepluginmodule</code>
|350 МБ
|-
|Журналы АктивныхШлюзов и автообновления

стандартный каталог: <code>/var/log/AstromKey</code>

параметр установки: <code><LOG></code>
|700 MB
|-
|Каталог пакетов АктивногоШлюза для загрузки установщика автоматического обновления

стандартный каталог: <code>/var/lib/AstromKey/packages</code>

параметр установки: <code><PACKAGES_DIR></code>
|500 MB
|-
|Временные файлы АктивногоШлюза

default: <code>/var/tmp/AstromKey/gateway</code>

путь относительно параметра установки: <code><TEMP>/gateway</code>
|4 ГБ (включая 3 ГБ для кэшированных установщиков OneAgent и образов контейнеров)
|-
|Файлы дампа, загруженные в АктивныйШлюз ЕдинымАгентом

<code>/var/lib/AstromKey/gateway/dump</code>
|Функциональность отключена по умолчанию, не настраивается во время установки.

При активации может принимать настраиваемый максимальный размер: по умолчанию 100 ГБ.
|-
|Только для АктивногоШлюза Окружения: журналы расширений 1.0 и 2.0 АктивногоШлюза, кэш, рабочая область во время выполнения

стандартный каталог: <code>/var/lib/AstromKey/remotepluginmodule</code>

путь относительно параметра установки: <code><CONFIG>/remotepluginmodule</code>
|2 ГБ
|-
|Только для АктивногоШлюза Окружения: Каталог загрузки расширений

стандартный каталог: <code>/opt/AstromKey/remotepluginmodule/plugin_deployment</code>

путь относительно параметра установки: <code><INSTALL>/remotepluginmodule/plugin_deployment</code>
|В зависимости от загруженных расширений
|}

=== Поддерживаемые операционные системы ===
{| class="wikitable"
!Дистрибутив Linux
!Версии
!Архитектуры ЦП
|-
| rowspan="1" |Amazon Linux 2
|Поддерживаются все версии
|x86-64
|-
| rowspan="1" |Amazon Linux AMI
|2018.3
|x86-64
|-
| rowspan="1" |CentOS
|7.9
|x86-64
|-
| rowspan="1" |Oracle Linux
|7.9, 8.4
|x86-64
|-
| rowspan="1" |Red Hat Enterprise Linux
|7.9, 8.2, 8.4, 8.6, 9.0
|x86-64
|-
| rowspan="1" |SUSE Enterprise Linux
|15.1, 15.2, 15.3
|x86-64
|-
| rowspan="1" |Ubuntu
|14.04, 16.04, 18.04, 20.04, 22.04
|x86-64
|}

=== Системные требования ===

* АктивныйШлюз поддерживает только операционные системы, работающие на архитектуре x86-64 (64-битные Intel/AMD).
* Убедитесь, что у вас правильная конфигурация сетевого порта.
* Ваша операционная система должна обрабатывать не менее 500 000 открытых файлов для пользователя <code>dtuserag</code>. Чтобы просмотреть системный лимит, выполните следующую команду: <code>[user@host]# cat /proc/sys/fs/file-max</code>. Кроме того, возможно, вы проверили слишком много открытых файлов в Linux.
* В вашей операционной системе должно быть не менее 20 000 процессов, доступных пользователю <code>dtuserag</code>. Чтобы просмотреть ограничение системы, выполните следующую команду: <code>[user@host]# cat /proc/sys/kernel/pid_max</code>.
* Программа установки АктивногоШлюза не поддерживает ACL (список управления доступом). Правила ACL могут запретить доступ к каталогам и файлам, созданным установщиком, из-за чего АктивныйШлюз не запустится. Если вы используете ACL, правила, относящиеся к каталогам установки, определенным в следующих параметрах, должны быть отключены: <code>INSTALL=↵CONFIG=↵LOG=↵TEMP=↵PACKAGES_DIR=</code>

=== Размеры AWS ===
В таблице представлены требования к размеру экземпляра машины в зависимости от количества агентов ЕдиныхАгентов, взаимодействующих с АктивнымШлюзом. На каждом хосте ЕдиныйАгент выполняет семь задач мониторинга:

* Мониторинг инфраструктуры
* Мониторинг логов
* Полный стек мониторинга 3 экземпляров Apache Tomcat
* Полный стек мониторинга 2 экземпляров HTTP-сервера Apache

{| class="wikitable"
!Размер машины
!Количество хостов
|-
|c4.large
|450
|-
|c4.xlarge
|900
|-
|c4.2xlarge
|1200
|}
Экземпляры машин С4:
{| class="wikitable"
!Машина
!vCPU
!Память (ГБ)
!Хранилище
!Выделенная пропускная способность EBS (Мбит/с)
!Производительность сети
|-
|c4.large
|2
|3.75
|EBS-Only
|500
|Умеренная
|-
|c4.xlarge
|4
|7.5
|EBS-Only
|750
|Высокая
|-
|c4.2xlarge
|8
|15
|EBS-Only
|1,000
|Высокая
|}

== Установка АктивногоШлюза ==

=== Разрешите подключения через брандмауэр ===
Убедитесь, что настройки вашего брандмауэра разрешают связь с Ключом-Астром.

В зависимости от политики вашего брандмауэра вам может потребоваться явно разрешить определенные исходящие соединения.

АктивныйШлюз обычно прослушивает (принимает входящие соединения) порт <code>9999</code> и взаимодействует с Ключом-Астром (устанавливает исходящие соединения) через порт <code>443</code>.

=== Установка ===

# Войдите в Ключ-Астром, выберите '''Развернуть Ключ-Астром''' в меню навигации и выберите '''Установить АктивныйШлюз'''.
# На странице '''Установка АктивногоШлюза Окружения''' выберите '''Linux'''.
# Выберите [[Цели АктивногоШлюза|цель АктивногоШлюза]].
# Предоставьте PaaS-токен. Он необходим для загрузки установщика АктивногоШлюза из вашей среды. Если у вас нет токена PaaS, вы можете создать его прямо в пользовательском интерфейсе. Токен автоматически добавляется к командам загрузки и установки, которые вы будете использовать позже.
# Скачайте установщик по скопированной <code>wget</code>-команде или по ссылке.
# Проверьте подпись. Дождитесь завершения загрузки. Затем проверьте подпись, скопировав команду из второго текстового поля '''Проверить подпись''' и вставив ее в окно терминала.
# Скопируйте команду установки АктивногоШлюза с указанной целью в терминал.

==== Конфигурация установки ====
Вы можете добавить дополнительные параметры в команду установки, чтобы настроить установку. Например, чтобы установить АктивныйШлюз в другой каталог, используйте параметр <code>INSTALL=<путь></code>:
<code>[root@host]# /bin/bash AstromKey-ActiveGate-Linux-x86-1.0.0.sh '''INSTALL=/hosted_app/AstromKey'''</code>

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

Чтобы проверить статус установки, выберите '''Показать статус развертывания''' и перейдите на вкладку '''АктивныеШлюзы'''.

== Стандартные настройки установщика ==
Если вы не укажете какие-либо параметры во время установки АктивногоШлюза для настройки параметров, будут применены следующие параметры по умолчанию.

=== Каталоги ===
{| class="wikitable"
!'''Цель каталога'''
!'''Путь по умолчанию'''Путь относительно параметра установки
!'''Требования к дисковому пространству'''(если размер не указан, предположим, что он меньше 1 МБ)
|-
|Исполняемые файлы АктивногоШлюза, библиотеки и связанные файлы
|<code>/opt/AstromKey/gateway</code>

<code><INSTALL>/gateway</code>
|300 МБ
|-
|Конфигурация АктивногоШлюза
|<code>/var/lib/AstromKey/gateway/config</code>

<code><CONFIG>/gateway/config</code>
|
|-
|SSL-папка АктивногоШлюза
|<code>/var/lib/AstromKey/gateway/ssl</code>

<code><CONFIG>/gateway/ssl</code>
|
|-
|Временные файлы АктивногоШлюза
|<code>/var/tmp/AstromKey/gateway</code>

<code><TEMP>/gateway</code>
|4 ГБ (включая 3 ГБ для кэшированных установщиков ЕдиныхАгентов и образов контейнеров)
|-
|Логи АктивногоШлюза
|<code>/var/log/AstromKey/gateway</code>

<code><LOG>/gateway</code>
|500 МБ
|-
|Файлы дампа, загруженные в АктивныйШлюз ЕдинымАгентом
|<code>/var/lib/AstromKey/gateway/dump</code>
|Функциональность отключена по умолчанию. При активации может принимать настраиваемый максимальный размер: по умолчанию 100 ГБ.
|-
|Каталог пакетов АктивногоШлюза для загрузки установщика автоматического обновления
|<code>/var/lib/AstromKey/packages</code>

<code><PACKAGES_DIR></code>
|500 МБ
|-
|Исполняемые файлы расширений 1.0 и 2.0 АктивногоШлюза, библиотеки и связанные файлы
|<code>/opt/AstromKey/remotepluginmodule</code>

<code><INSTALL>/remotepluginmodule</code>
|350 МБ
|-
|Конфигурация расширений 1.0 и 2.0 АктивногоШлюза, журналы, кеш, рабочая область во время выполнения
|<code>/var/lib/AstromKey/remotepluginmodule</code>

<code><CONFIG>/remotepluginmodule</code>
|2 ГБ (для журналов и аварийных дампов)
|-
|Каталог загрузки расширений АктивногоШлюза
|<code>/opt/AstromKey/remotepluginmodule/plugin_deployment/</code>
|В зависимости от загруженных расширений
|-
|zRemote исполняемые файлы, библиотеки и связанные файлы
|<code>/opt/AstromKey/zremote</code>

Использование каталогов не по умолчанию не поддерживается.
|50 МБ
|-
|zRemote редактируемая пользователем постоянная конфигурация,

zRemote Рабочая область удаленного выполнения, отчеты о сбоях
|<code>/var/lib/AstromKey/zremote/agent</code>

Использование каталогов не по умолчанию не поддерживается.
|50 МБ
|-
|Логи zRemote
|<code>/var/lib/AstromKey/zremote/log</code>

Установка АктивногоШлюзас zRemote в каталоги, отличные от каталогов по умолчанию, не поддерживается.
|200 МБ
|-
|Частные синтетические исполняемые файлы, библиотеки и связанные файлы
|<code>/opt/AstromKey/synthetic</code>

<code><INSTALL>/synthetic</code>
|270 МБ
|-
|Приватные синтетические логи
|<code>/var/log/AstromKey/synthetic</code>

<code><LOG>/synthetic/log</code>
|1 ГБ
|-
|Частные синтетические временные файлы
|<code>/var/tmp/AstromKey/synthetic</code>
|20 ГБ, в том числе

1 ГБ для <code>/var/tmp/AstromKey/synthetic/cache</code> и

1 ГБ для <code>/var/tmp/AstromKey/synthetic/screenshots</code>
|-
|Автообновление
|<code>/opt/AstromKey/autoupdater</code>

<code><INSTALL>/autoupdater</code>
|Включено в оценку исполняемых файлов АктивногоШлюза
|-
|Логи автообновления
|<code>/var/log/AstromKey/autoupdater</code>

<code><LOG>/autoupdater</code>
|200 МБ
|}

=== Службы ===
{| class="wikitable"
|'''Название компонента'''
|'''Наименование службы'''
|'''Учетная запись пользователя'''
|'''Описание'''
|-
|АктивныйШлюз
|<code>AstromKeygateway</code>
|по умолчанию: <code>dtuserag</code>

настраивается во время установки
|Основной сервис АктивногоШлюза. Присутствует для всех целей и функциональных модулей.
|-
|Автообновление АктивногоШлюза
|<code>AstromKeyautoupdater</code>
|<code>root</code>
|Сервис автоматического обновления. Присутствует для всех целей и функциональных модулей АктивногоШлюза.
|-
|Расширения 1.0 (удаленный подключаемый модуль)
|<code>remotepluginmodule</code>
|как и для АктивногоШлюза
|Сервис для функционального модуля Extensions 1.0. Присутствует на АктивныхШлюзах, установленных для мониторинга маршрутизации. Эта служба будет активной или неактивной в зависимости от конфигурации — настройки по умолчанию см. в описании модуля.
|-
|Расширения 2.0
|<code>extensionsmodule</code>
|как и для АктивногоШлюза
|Сервис для функционального модуля Extensions 2.0. Присутствует на АктивныхШлюзах, установленных для мониторинга маршрутизации. Эта служба будет активной или неактивной в зависимости от конфигурации — настройки по умолчанию см. в описании модуля.
|-
|zRemote
|<code>zremote</code>
|как и для АктивногоШлюза
|Сервис для функционального модуля zRemote. Присутствует на АктивныхШлюзах, установленных с целью маршрутизации трафика z/OS в Ключ-Астром.
|-
|Синтетика
|<code>vuc</code>
|как и для АктивногоШлюза
|Сервис для Синтетического функционального модуля. Присутствует на АктивныхШлюзах, установленных для запуска синтетических мониторов из частной локации.
|}

=== Пользователь, работающий со службой АктивногоШлюза ===
По умолчанию программа установки АктивногоШлюза использует пользователя <code>dtuserag</code> для запуска службы АктивногоШлюза. Этому пользователю не требуются привилегии root.

Если пользователь <code>dtuserag</code> еще не существует в системе, программа установки создаст его.

=== Использование портов ===
По умолчанию АктивныйШлюз:

* получает соединения от ЕдиныхАгентов или других АктивныхШлюзов через порт 9999
* получает API Ключ-Астром на порт 9999
* подключается к SaaS или Managed-кластеру через порт 443

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

=== Синтаксис команды установки ===
<code>AstromKey-ActiveGate-Linux-x86-<version>.sh [<параметр_1>=<значение_1>] [<параметр_2>=<значение_2>] ...</code>
Пробелы между именем параметра и значением параметра (вокруг знака <code>=</code>) не допускаются в синтаксисе команды.

=== Конфигурация прокси ===
Конфигурация прокси должна быть указана в следующем формате. Это позволит настроить прокси АктивногоШлюза для всех исходящих соединений (в разделе конфигурации <code>http.client</code>):
<code>PROXY=<схема_прокси><пользователь>:<пароль>@<сервер>:<порт></code>
Где:

* Все компоненты необязательны, кроме <code><server></code>.
* Если не указаны ни <code><пользователь></code>, ни <code><пароль></code>, то символ @ следует опустить.
* <code><пароль></code> можно указать, только если указано имя пользователя.
* ':' после <code><user></code> можно указать, даже если часть пароля пуста.
* <code><схема_прокси></code> не является обязательной и может быть <code>"http://"</code> или <code>"https://"</code>.
* <code><пользователь></code> является необязательным.
* <code><server></code> может быть IP-адресом или DNS-именем, но не путем. Например, если указано «1.2.3.4/textaferslash», будет извлечена только часть IP («1.2.3.4»). Косая черта и следующий за ней текст будут игнорироваться.
* <code><порт></code> является необязательным.

=== Конфигурация обратного прокси (балансировщика нагрузки) ===
На пути от АктивногоШлюза до Кластера можно разместить обратный прокси-сервер или балансировщик нагрузки. Это позволяет вашему АктивномуШлюзу подключаться к любому доступному узлу кластера, распределяя нагрузку между узлами.

Для этого вам необходимо:

* Указать адрес обратного прокси-сервера/балансировщика нагрузки.
* Убедитесь, что АктивныйШлюзбудет игнорировать любую дополнительную информацию о целевом адресе, отправленную из кластера, и, таким образом, будет подключаться только к указанному вами адресу.

Такие параметры конфигурации можно указать во время установки АктивногоШлюза, задав следующие параметры командной строки программе установки:
<code>--ignore-cluster-runtime-info SERVER=<адрес_обратного_прокси></code>
Кроме того, вы можете настроить АктивныйШлюз после установки, внеся изменения в конфигурацию АктивногоШлюза.

=== Пользователь службы АктивногоШлюза ===
Чтобы указать пользователя, запускающего службу АктивногоШлюза, укажите следующую опцию командной строки:
<code>USER=<user></code>
Установщик создает пользователя, если он еще не существует в системе и ему не требуются привилегии root. Если параметр не указан, установщик создает пользователя <code>dtuserag</code> для запуска службы АктивногоШлюза. Однако вы можете использовать <code>USER=root</code>, чтобы заставить службу работать от имени пользователя root. Примечание: параметр <code>USER=root</code> не поддерживается при установке синтетического АктивногоШлюза.

=== Ограничения для расположения каталогов и точек монтирования ===
<code><настраиваемый_каталог>/gateway</code>, то есть <code>INSTALL/gateway,</code> <code>CONFIG/gateway,</code> <code>LOG/gateway</code>, <code>TEMP/gateway</code>, <code>PACKAGES_DIR/gateway</code>, не может быть родительским для другого настраиваемого каталога, то есть <code>INSTALL</code>, <code>CONFIG</code>, <code>TEMP</code>, <code>LOG</code> или <code>PACKAGED_DIR</code>.

Например, не указывайте:
<code>INSTALL=/AstromKey
LOG=/AstromKey/gateway/logs
CONFIG=/AstromKey/gateway/config
TEMP=/AstromKey/gateway/tmp</code>
Также не указывайте:
<code>CONFIG=/var/lib/AstromKey
PACKAGES_DIR=/var/lib/AstromKey/gateway/packages</code>
Однако разрешен общий родитель, например:
<code>INSTALL=/example/apps
CONFIG=/example/configs
LOG=/example/logs
TEMP=/example/tmp</code>

==== Точки монтирования ====
В процессе установки АктивныйШлюз создает подкаталоги в своих каталогах верхнего уровня. Если вы использовали параметры <code>INSTALL</code> или <code>CONFIG</code> для указания путей, АктивныйШлюз создаст свои подкаталоги по указанным путям. Не создавайте точки монтирования для этих подкаталогов, созданных установщиком. Вы можете монтировать только каталоги верхнего уровня по умолчанию или указанные вами каталоги верхнего уровня.

Например, если вы указали следующий параметр <code>INSTALL</code>:
<code>INSTALL=/opt/MyActiveGate</code>
Программа установки АктивногоШлюза создаст подкаталог <code>gateway</code> в указанном вами пути установки: <code>/opt/MyActiveGate/gateway</code>

Как результат:

* Точка монтирования <code>/opt/MyActiveGate</code> '''КОРРЕКТНА'''.
* Точка монтирования <code>/opt/MyActiveGate/gateway</code> '''НЕКОРРЕКТНА'''.

==== Использование <code>/temp</code> или <code>/tmp</code> ====
Из-за возможной автоматической очистки мы рекомендуем вам не использовать каталоги <code>/temp</code> или <code>/tmp</code> или их подкаталоги для установки АктивногоШлюза или хранения каких-либо данных, сгенерированных или используемых АктивнымШлюзом.

=== Каталог установки ===
<code>INSTALL=<directory></code>
Сохраняет установочные файлы в указанном каталоге. Значение по умолчанию для этого параметра (если оно не указано) — <code>/opt/AstromKey</code>. Этот параметр не разрешен во время обновления.

=== Каталог для хранения загруженных пакетов ===
<code>PACKAGES_DIR=<directory></code>
Сохраняет установочные файлы дополнительных возможностей в указанном каталоге. Значение по умолчанию для этого параметра (если не указано) — <code>/var/lib/AstromKey/packages</code>. Не разрешено во время обновления.

=== Каталог логов ===
<code>LOG=<directory></code>
Сохраняет файлы журналов в указанном каталоге. Значение по умолчанию для этого параметра (если не указано) — <code>/var/log/AstromKey</code>. Не разрешено во время обновления.

=== Каталог конфигурации ===
<code>CONFIG=<directory></code>
Сохраняет файлы конфигурации в указанном каталоге. Значение по умолчанию для этого параметра (если не указано) — <code>/var/lib/AstromKey</code>. Не разрешено во время обновления.

=== Временный каталог ===
<code>TEMP=<directory></code>
Указывает временный каталог, который будет использоваться АктивнымШлюзом. Значение по умолчанию для этого параметра (если не указано) — <code>/var/tmp/AstromKey</code>. Не разрешено во время обновления.

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

Таким образом вы можете указать прокси-сертификат ЦС (сертификат, который будет использоваться при подключении АктивногоШлюза к кластеру). Это позволяет установить соединение с кластером во время установки, позволяя программе установки АктивногоШлюза загрузить и установить любые необходимые дополнительные возможности.

Пароль сертификата указывается в виде файла, из которого считывается пароль.

Абсолютный путь к расположению настраиваемых доверенных корневых сертификатов для добавления:
<code>--ca-certificate-file=<path></code>
Абсолютный путь к местоположению файла, содержащего пароль сертификата:
<code>--ca-certificate-password-file=<path></code>
Пример команды:mple:
<code>[root@host]# ./AstromKey-ActiveGate-Linux-1.217.sh --ca-certificate-file=/home/fred/myCert.jks --ca-certificate-password-file=/home/fred/myPwd.txt</code>

==== Ограничения для указания SSL-сертификата ====
Прямое указание SSL-сертификата для АктивногоШлюза неприменимо для АктивногоШлюза Кластера. Не пытайтесь настроить SSL-сертификаты непосредственно на АктивномШлюзе Кластера. Если вы это сделаете, сертификат будет перезаписан автоматическим управлением Для АктивныхШлюзов Кластера вы должны загрузить свои сертификаты с помощью Консоли Менеджмента Кластера или REST API Кластера v1.

=== Пользовательский SSL-сертификат ===
Во время установки вы можете указать сертификат аутентификации, который АктивныйШлюз предоставляет подключающимся клиентам, ЕдинымАгентам или подключениям из браузерных клиентов. Если такие сертификаты требуются, это уменьшает усилия по настройке после установки.

Пароль сертификата указывается в виде файла, из которого считывается пароль.

Абсолютный путь к местоположению сертификата аутентификации, который АктивныйШлюз предоставляет подключающимся клиентам, ЕдинымАгентам, или подключениям из браузерных клиентов (таких как RUM JavaScript):
<code>--certificate-file=<path></code>
Абсолютный путь к местоположению файла, содержащего пароль сертификата, для сертификата аутентификации, который АктивныйШлюз предоставляет подключающимся клиентам:
<code>--certificate-password-file=<path></code>
Пример команды:
<code>[root@host]# ./AstromKey-ActiveGate-Linux-1.217.sh --certificate-file=/home/fred/myCert.jks --certificate-password-file=/home/fred/myPwd.txt</code>

=== Сетевая зона ===
<code>--set-network-zone=<name></code>
Определяет сетевую зону, к которой принадлежит АктивныйШлюз. Он может принадлежать только одной сетевой зоне. Имя сетевой зоны представляет собой строку буквенно-цифровых символов, дефисов <code>(-)</code>, знаков подчеркивания <code>(_)</code> и точек <code>(.)</code>. Точки используются в качестве разделителей, поэтому вы не должны использовать точку в качестве первого символа имени сетевой зоны. Длина строки ограничена 256 символами.

Этот параметр не разрешен во время обновления.

=== Группа ===
<code>--set-group=<name></code>
Определяет группу АктивныхШлюзов, к которой принадлежит АктивныйШлюз. АктивныйШлюз может принадлежать только одной группе. Имя группы АктивныхШлюзов представляет собой строку буквенно-цифровых символов, дефисов (-), знаков подчеркивания (_) и точек (.). Точки используются в качестве разделителей, поэтому вы не должны использовать точку в качестве первого символа имени группы. Длина строки ограничена 256 символами. Вы можете использовать группы АктивныхШлюзов для выполнения массовых действий на ваших АктивныхШлюзах, таких как управление расширениями 2.0, работающими на АктивныхШлюзах.

Этот параметр не разрешен во время обновления.

=== Время соединения ===
<code>AstromKey_ACTIVEGATE_SERVER_CONNECTION_TIMEOUT=<seconds></code>
Определяет максимальное количество секунд (по умолчанию: <code>120</code>), в течение которых программа установки будет ожидать подключения к кластеру. В развертываниях Linux этот параметр необходимо использовать как переменную среды.

Время ожидания соединения, указанное в переменной среды <code>ASTROMKEY_ACTIVEGATE_SERVER_CONNECTION_TIMEOUT=<секунды></code>, используется на двух этапах установки:

* При загрузке дополнительных (необязательных) возможностей.
* При ожидании соединения с кластером в конце установки АктивныхШлюзов: это соединение затем используется АктивнымШлюзом во время его нормальной работы.

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

Чтобы проверить успешность установки и подключения, войдите в AstromKey, в разделе '''Настройки''' выберите '''Статус развертывания''', а затем перейдите на вкладку '''АктивныеШлюзы'''.

Например:
<code>[root@host]# export ASTROMKEY_ACTIVEGATE_SERVER_CONNECTION_TIMEOUT=240
[root@host]# AstromKey-ActiveGate-Linux-x86-1.0.0.sh <... other parameters></code>
или вы можете использовать комбинированные команды в одной строке. Например:

<code>[root@host]# export ASTROMKEY_ACTIVEGATE_SERVER_CONNECTION_TIMEOUT=240 ; AstromKey-ActiveGate-Linux-x86-1.0.0.sh <... other parameters></code>

Развертывание АктивногоШлюза в нескольких средах

2022-09-28T19:12:31Z

RGolovanov: Новая страница: «Если вы настроили несколько сред мониторинга, установка и обслуживание нескольких Акти...»

Если вы настроили несколько сред мониторинга, установка и обслуживание нескольких АктивныхШлюзов может оказаться затруднительной. Таким образом, Ключ-Астром позволяет настроить один АктивныйШлюз для поддержки нескольких сред мониторинга.

Такая конфигурация значительно снижает затраты на обслуживание и настройку. Благодаря этой функции вам не нужно развертывать несколько АктивныхШлюзов и настраивать параметры брандмауэра для каждого дополнительного АктивногоШлюза Окружения. Мультисредовые АктивныеШлюзы способны обрабатывать весь трафик из всех сред, с которыми они связаны.<blockquote>Ограничения

Вы не можете использовать АктивныйШлюз Окружения, сконфигурированный для поддержки нескольких сред, для:

* '''Подключения к средам из разных кластеров'''
* Перенаправления трафика z/OS в Ключ-Астром с помощью модуля zRemote
* Мониторинга удаленных технологий с помощью расширений, включая платформу Расширения 1.0 и Расширения 2.0.
* Выполнения мониторов из частных синтетических местоположений
* Запуска анализа базы данных
* Подключения к Ключу-Астром с помощью AWS PrivateLink.

Все остальные функции АктивныхШлюзов поддерживаются.</blockquote>

== Настройка АктивногоШлюза для поддержки нескольких сред ==

=== Отключение и удаление сред ===
'''Убедитесь, что модули АктивногоШлюза, несовместимые с работой в нескольких средах, отключены.'''

Только один из следующих модулей может присутствовать на АктивномШлюзе. Отключение и удаление этих модулей допустимо:

* Расширения 1.0 — отключено в разделе <code>[rpm]</code>
* Расширения 2.0 — отключено в разделе <code>[extension_controller]</code>
* zRemote — отключено в разделе <code>[zremote]</code>
* Синтетика 1.0 — отключена в разделе <code>[синтетика]</code>

Чтобы отключить модули, найдите файл <code>custom.properties</code> в каталоге конфигурации и убедитесь, что для соответствующих свойств конфигурации установлено значение <code>false</code>:
<code>[rpm]
rpm_enabled = false

[zremote]
zremote_enabled = false

[synthetic]
synthetic_enabled = false

[extension_controller]
extension_controller_enabled = false</code>
'''Убедитесь, что модули АктивногоШлюза, несовместимые с работой в нескольких средах, удалены.'''

Для Linux — выполните одну из следующих команд в зависимости от того, какой модуль необходимо удалить. Если вы сомневаетесь, выполните все команды: Если команды будут найдены, соответствующие модули будут удалены. Если команды не найдены, значит модули отсутствуют:
<code>sudo /opt/AstromKey/remotepluginmodule/uninstall.sh
sudo /opt/AstromKey/zremote/uninstall.sh
sudo /opt/AstromKey/synthetic/uninstall.sh</code>

* Для Windows: найдите и удалите следующие приложения, если они установлены:
** '''AstromKey Remote Plugin Module'''
** '''AstromKey ZRemote'''
** '''AstromKey Synthetic'''

=== Конфигурация авторизации среды ===
'''В каталоге конфигурации АктивногоШлюза найдите файл <code>authorization.properties</code> и ознакомьтесь с его содержимым.'''

В файле перечислены сведения для каждой среды, идентифицированные идентификатором среды: <code>tenantToken</code> и, при необходимости, свойствами авторизации.

Один и только один из разделов будет содержать свойство <code>mainTenant = true</code>. Не удаляйте этот раздел или эту запись. Не удаляйте никакие другие разделы, относящиеся к другим средам, если вы не хотите, чтобы АктивныйШлюз поддерживал эти конкретные среды.

Формат записей в author.properties:
<code>[<environment_ID>]
tenantToken = <tenant_token>
mainTenant = true # ID среды, из которой был загружен АктивныйШлюз
authToken = <authorization_token> # если требуется</code>
Например:
<code>[mySampleEnv]
tenantToken = abcdevjhij1234567890
authToken = dt0g01.HVMTLRLZ.1234567890ZYXWVUTSRQPONMLKJIHGFEDCBA01234567890ABCDEFGHIGKLMNOPQ
mainTenant = true</code>
<blockquote>'''Примечание'''

Из соображений безопасности вы больше не можете найти <code><tenant_token></code> в веб-интерфейсе.</blockquote>

=== Добавление новых сред ===
'''Чтобы добавить больше сред, добавьте новые разделы в файл <code>authorization.properties</code>.'''

Перечислите каждую среду, которую вы хотите поддерживать в АктивномШлюзе. Используйте следующий формат:
<code>[<environment_ID>]
tenantToken = <tenant_token>

[<environment_ID>]
tenantToken = <tenant_token></code>
Например:
<code>[mySampleEnv]
tenantToken = abcdevjhij1234567890

[myAnotherEnv]
tenantToken = 0987654321jijvedcba</code>
<blockquote>Обеспечьте согласованную конфигурацию

Для корректной работы необходимо убедиться, что:

* Все среды, которые должны поддерживаться одной и той же средой АктивногоШлюза, работают в одном и том же кластере.
* Основная среда, связанная со свойством конфигурации <code>mainTenant</code>, настроена правильно. Неправильная конфигурация основной среды приведет к '''отклонению АктивногоШлюза во всех настроенных средах''': в журналах АктивногоШлюза будет зарегистрирована ошибка с информацией о том, что конфигурация <code>mainTenant</code> неверна, а АктивныйШлюз не будет отображаться на страницах состояния развертывания на любой из сред.
</blockquote>

=== Сохранение и перезапуск АктивногоШлюза ===
Сохраните файл <code>authorization.properties</code> и перезапустите основной сервис АктивногоШлюза. Убедитесь, что новые среды успешно добавлены.

Файл журнала АктивногоШлюза должен содержать запись с указанием количества сред, с которыми работает АктивныйШлюз, например:
<code>Working mode is set to MULTITENANT with 5 tenant(s).</code>
Если в сообщении журнала не указано количество сред, которые вы пытались настроить, проверьте файл журнала на наличие записей, указывающих на ошибку в файле <code>authorization.properties</code>. Сообщения об ошибках появляются в таком виде:
<code>Error during parsing config file `...\conf\authorization.properties` - invalid configuration: ...</code>

Конфигурация шифра для АктивногоШлюза

2022-09-28T18:46:19Z

RGolovanov: Новая страница: «Компоненты Ключ-Астром обмениваются данными через SSL, использующий шифры для шифрования...»

Компоненты Ключ-Астром обмениваются данными через SSL, использующий шифры для шифрования HTTP-запросов. Не все доступные шифры в настоящее время считаются достаточно безопасными. Поэтому по умолчанию исключаются некоторые шифры (например, все MD5, все RC4, все DES, все DSS).

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

== Настройка шифров ==

=== Сканирование шифров ===

* Сканируйте поддерживаемые шифры с помощью Nmap. Результатом сканирования будет список, подобный следующему:

<code>PORT STATE SERVICE
9999/tcp open abyss
| ssl-enum-ciphers:
| TLSv1.2:
| ciphers:
| TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 (secp256r1) - A
| TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 (dh 2048) - A
| TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 (secp256r1) - A
| TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 (dh 2048) - A
| TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (secp256r1) - A
| TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 (dh 2048) - A
| TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (secp256r1) - A
| TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 (dh 2048) - A
| compressors:
| NULL
| cipher preference: server
|_ least strength: A</code>

=== Исключение шифров ===

* Исключите нежелательные шифры, перечислив их в файле <code>custom.properties</code>. Мы поддерживаем только исключения шаблонов, поэтому в приведенном ниже примере исключение <code>TLS_DHE_RSA_WITH_AES_256_CBC_SHA</code> также исключает <code>TLS_DHE_RSA_WITH_AES_256_CBC_SHA384</code>. В следующем примере показано, как исключить шифры ECDHE из приведенного выше списка:

<code>[com.compuware.apm.webserver]
excluded-ciphers = TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256</code>
Проблема с этим подходом заключается в том, что список становится длинным, и поэтому его трудно поддерживать, если OpenSSL изменяется. Более надежным/динамичным способом является использование подшаблона, как показано в примере ниже.
<code>[com.compuware.apm.webserver]
excluded-ciphers = TLS_ECDHE_</code>
В этом примере будут исключены все имена шифров, содержащие строку <code>TLS_ECDHE_</code>. Этот шаблон исключит дополнительные шифры, если базовый список изменится, например, из-за обновлений OpenSSL.

Чтобы исключить шаблон суффикса, завершите строку шаблона символом <code>$</code>. Чтобы исключить SHA без исключения <code>SHA256</code>, укажите <code>SHA$</code> в качестве шаблона. Например:
<code>[com.compuware.apm.webserver]
excluded-ciphers = TLS_RSA_WITH,_SHA$</code>
Кроме того, вы можете определить, какие шифры вы хотите включить.
<code>[com.compuware.apm.webserver]
included-ciphers = _ECDHE_</code>
Как правило, вы определяете либо включенные, либо исключенные шифры, но не оба.

Обратите внимание, что '''если шифр был определен в списке как включенных, так и исключенных, он будет считаться исключенным — ''исключение имеет приоритет над включением'''''.

Доверенные корневые сертификаты для АктивногоШлюза

2022-09-28T18:16:57Z

RGolovanov:

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

=== Добавление сертификатов во время установки АктивногоШлюза ===
При желании дополнительные доверенные корневые сертификаты можно указать во время установки АктивногоШлюза, указав параметры установки для [[Установка АктивногоШлюза на Linux|Linux]] или [[Установка АктивногоШлюза на Windows|Windows]].

== Убедитесь, нужен ли вам сертификат ЦС ==
АктивныйШлюз подключается к другим компонентам Ключа-Астром (кластерам, серверам) или сторонним системам (таким как VMware, Cloud Foundry, Kubernetes или OpenShift) с использованием защищенных SSL каналов. Встроенного хранилища АктивногоШлюза (набор сертификатов по умолчанию, поставляемый с Java), иногда недостаточно для покрытия всех необходимых вариантов использования. Это может произойти, если, например, сертификат был выдан внутри вашей организации для прокси-сервера, принимающего SSL-трафик. Также возможно, что некоторые серверы в вашей организации, к которым АктивныйШлюз должен подключаться, генерируют и используют самоподписанные сертификаты, и ваша организация не заменила их официальными сертификатами.

При возникновении таких ситуаций в лог-файле АктивногоШлюза будет ошибка о том, что сертификат, представленный сервером, к которому ваш АктивныйШлюз пытался подключиться, не является доверенным. В этих случаях вам необходимо импортировать отсутствующий сертификат в АктивныйШлюз.<blockquote>'''Предупреждение'''

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

Если в журнале АктивногоШлюза сообщается об ошибке о том, что сертификат, представленный сервером, к которому ваш АктивныйШлюз пытался подключиться, не был доверенным, не думайте, что вам нужно добавить отсутствующий сертификат. Прежде чем продолжить, необходимы дополнительные исследования.</blockquote>'''Ошибка недействительного сертификата также может означать, что была попытка нарушить безопасность вашей организации. Поэтому вы всегда должны исследовать эту возможность, когда сообщается о такой ошибке.'''

== Подготовка сертификатов ==
Прежде чем добавлять сертификат в АктивныйШлюз, его необходимо получить и поместить в файл <code>ca.cert</code>.

'''Следующая общая информация о сертификатах ЦС может помочь вам определить необходимые сертификаты:'''

Условия доверенного соединения SSL:

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

Чтобы увидеть, какие сертификаты предоставляет конечная точка, вы можете использовать следующую команду:
<code>openssl s_client -connect <API_ENDPOINT>:<PORT> -showcerts -servername <API_ENDPOINT_HOSTNAME></code>
'''Примечание:'''

Некоторые приложения (например, OpenShift) могут предоставлять разные сертификаты в зависимости от SNI. АктивныйШлюз установит сконфигурированное имя хоста конечной точки в SNI.

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

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

Например, конечная точка запроса <code>openssl</code> к этому серверу возвращает только сертификат сервера, а не корневой сертификат. Вы знаете, что этот сервер представляет только сертификат сервера, а не корневой сертификат, поскольку в сообщении об ошибке говорится, что невозможно получить сертификат локального эмитента. При наличии корневого сертификата в сообщении об ошибке будет указано «<code>Самозаверяющий сертификат в цепочке сертификатов</code>». Чтобы создать действительное SSL-соединение с этой конечной точкой, необходимо отдельно получить корневой сертификат.

Например:
<code>openssl s_client -connect localhost:6443
CONNECTED(00000005)
depth=0 CN = kube-apiserver
verify error:num=20:unable to get local issuer certificate
verify return:1
depth=0 CN = kube-apiserver
verify error:num=21:unable to verify the first certificate
verify return:1
---
Certificate chain
0 s:CN = apiserver
i:CN = AstromKeyRootAuth
---
Server certificate
-----BEGIN CERTIFICATE-----
MDIDYGCCAkigAwIBAgJIJ8SQ/FcmJiYwDQZJKoZIhvcNAQESBQAwFTETMBEGA1UE
AxMKa3ViZXJuZXRlczAeFw0yMTAxMjcxOTM1MDhaFw0yMjAxMjcxOTM1MDhaMBkx
FzAVBgNVBAMTDmt1YmUtYXBpc2VydmVyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A
MIIBCgKSAQEA15BVGULXSXZAM6a4Y7lR6JfSBOXIAq1sCoydH2AdhzqHu0mXj+Fd
sooRQ46f7bySZvMGFfLupmaAzH5kVJOVDQ2WoHPYVzAEhDji+SUBOi99AC0tevEa
ONLdkLGzR//2u8XND0iiswsGkK3yaNyPwCVnOnA3c4O32waMoM1VI9XGuNSqqfQF
6XUx8sGHG5bNVzfHOXh5CBJZ5JReDhW/J8CbPElYJPJaQcSpTVFx5ReTQqBLeBSy
eWyCwqMj/jAnKzpPffO478If/Uc8I5vS8zi2yPhYJhKqD0m1b96hH0slXKho25Ip
gpu4cIw03mQZMK558W4d6ccww/OvMbpKQQIDAQABo4GvMIGsMA4GA1UdDwEB/wQE
AwIFoDATBgNVHSUEDDAKBgfrBgEFBQcDATSBhAYDVR0RBH0we4IPamstazhzLWNs
b25lLTAwggprdWJlcm5ldGVzghJrdWJlcm5ldGVzLmRlZmF1bHSCFmt1YmVybmV0
ZXMuZGVmYXVsdC5zdmOCAGt1YmVybmV0ZXMuZGVmYXVsdC5zdmMuY2x1c3Rlci5s
b2NhbIcECmAAAYcErBcSvDANBgkqhkiG9w0BAQsFAAOCAQEAdmOq/Sp74xiLCa14
EI/9v7jUG+GqjD3HPpj/oXIdLHg6HA4nixxcxwnWAf2RAMVXBYn7qTDU6x7W5M+t
6M0uaCe8Od8oKjOKeQ31dfMpPbLYprKmcnuBriiN5gjfghINZKaZlGlX0GkBC9Ts
THYbmWfXfvfsX2xfpc4J0esfK+BafllEimCx8blnw1uY7CiCedEANePT+J5Q+m9L
m5pu7Qz/B4JDHLIJBArhFTBM6IIF6DhoqGUXM1XXqMlTVBpxz2vhf0N/HxcTaEBa
VWu7GZbk5mCYhngmRJ8PJ3uA8yajDT2muWm/la5oOI/GeuTgR98tqjXOXmz2NjvE
Zng1CA==
-----END CERTIFICATE-----
subject=CN = kube-apiserver

issuer=CN = kubernetes

---
Acceptable client certificate CA names
CN = kubernetes</code>
Приведенный ниже сертификат является примером корневого сертификата для вышеуказанного сертификата сервера. Убедитесь, что вы добавляете в свои хранилища доверенных сертификатов только те корневые сертификаты, которым вы доверяете.

Например:
<code>cat ca.crt | openssl x509 -text -noout
Certificate:
Data:
Version: 3 (0x2)
Serial Number: 0 (0x0)
Signature Algorithm: sha256WithRSAEncryption
Issuer: CN = kubernetes
Validity
Not Before: Jan 27 19:35:08 2021 GMT
Not After : Jan 25 19:35:08 2031 GMT
Subject: CN = kubernetes
Subject Public Key Info:</code>
Вы можете видеть, что это корневой сертификат, который вам нужен, потому что субъект и эмитент идентичны, и они совпадают с эмитентом сертификата сервера, показанного выше ('kube-apiserver').

== Создание хранилища доверенных сертификатов из сертификата ЦС ==
Создайте дополнительное хранилище доверенных сертификатов, содержащее только ваши сертификаты ЦС, которые будут объединены в АктивномШлюзе во время выполнения со встроенным хранилищем доверенных сертификатов JDK. Хранилище доверия должно быть в формате <code>PKCS12</code>. Форматы OpenSSL не поддерживаются, поэтому используйте команду <code>keytool</code> для выполнения преобразования. После преобразования вы должны поместить сертификат в каталог SSL АктивногоШлюза .

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

Примеры для Linux создания файла PKCS12 из файла CRT или файла PEM и размещения его либо непосредственно в каталоге SSL АктивногоШлюза, либо в текущем каталоге для последующего копирования:
<code>/opt/AstromKey/gateway/jre/bin/keytool -import -file ca.crt -alias dt_k8s_api -storetype pkcs12 -keystore /var/lib/AstromKey/gateway/ssl/mytrusted.p12</code>
или
<code>/opt/AstromKey/gateway/jre/bin/keytool -import -file dt_k8s_api.pem -alias myCertAuthority -storetype pkcs12 -keystore mytrusted.p12</code>

=== Проверка разрешений ===
Для Linux проверьте, что пользователь АктивногоШлюза, для которого был установлен АктивныйШлюз (по умолчанию <code>dtuser</code>), имеет права на запись в каталог SSL АктивногоШлюза (по умолчанию <code>/var/lib/AstromKey/gateway/ssl</code>) и что у пользователя есть права на чтение для созданного хранилища доверия.

== Настройка АктивногоШлюза для использования хранилища доверенных сертификатов ==
Чтобы настроить АктивныйШлюз для использования пользовательского файла хранилища доверенных сертификатов <code>mytrusted.p12</code>, убедитесь, что файл хранилища доверенных сертификатов находится в каталоге SSL АктивногоШлюза, а затем добавьте следующие записи в файл <code>custom.properties</code> в каталоге конфигурации АктивногоШлюза:
<code>[collector]
trustedstore = mytrusted.p12
# the following entries are optional
trustedstore-password = changeit
trustedstore-type = PKCS12</code>
Вы можете отобразить настроенный список псевдонимов и описания сертификатов с помощью команды <code>keytool -list</code> в новом хранилище доверенных сертификатов.

Например:
<code># /opt/AstromKey/gateway/jre/bin/keytool -list -keystore /var/lib/AstromKey/gateway/ssl/mytrusted.p12
Enter keystore password:
Keystore type: PKCS12
Keystore provider: SUN
Your keystore contains 1 entry
dt_k8s_api, Apr 26, 2020,
trustedCertEntry,
Certificate fingerprint (SHA-256): 08:18:9A:F2:29:31:0D:64:F0:1F:93:A1:CC:2E:A9:21:E9:DA:40:82:9B:A8:71:B7:A4:2C:6D:8C:B3:90:31:31</code>
<blockquote>Зашифрованный пароль

Пароль будет удален и зашифрован при перезапуске службы АктивногоШлюза.</blockquote>

== Перезапуск службы АктивногоШлюза и проверка конфигурации сертификата ==
Перезапустите основную службу АктивногоШлюза, чтобы изменения вступили в силу.

Если все настроено правильно, в журнале АктивногоШлюза должна быть запись следующего содержания:
<code>Custom certificate configuration created successfully.</code>

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

* Указано системное свойство <code>javax.net.ssl.trustStore</code>. Если это свойство указано, оно имеет приоритет над конфигурацией АктивногоШлюза.
* Настроенное хранилище доверенных сертификатов не может быть прочитано с использованием настроенного пути, пароля и типа.
* Объединенную конфигурацию нельзя записать в файл <code>ssl/runtime.cacerts</code>.

Доверенные корневые сертификаты для АктивногоШлюза

2022-09-28T18:15:32Z

RGolovanov: Новая страница: «Могут быть ситуации, когда необходимо добавить дополнительные сертификаты в хранилище...»

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

=== Добавление сертификатов во время установки АктивногоШлюза ===
При желании дополнительные доверенные корневые сертификаты можно указать во время установки АктивногоШлюза, указав параметры установки для [[Установка АктивногоШлюза на Linux|Linux]] или [[Установка АктивногоШлюза на Windows|Windows]].

== Определите, нужно ли вам добавить сертификат ЦС в АктивныйШлюз ==
АктивныйШлюз подключается к другим компонентам Ключа-Астром (кластерам, серверам) или сторонним системам (таким как VMware, Cloud Foundry, Kubernetes или OpenShift) с использованием защищенных SSL каналов. Встроенного хранилища АктивногоШлюза (набор сертификатов по умолчанию, поставляемый с Java), иногда недостаточно для покрытия всех необходимых вариантов использования. Это может произойти, если, например, сертификат был выдан внутри вашей организации для прокси-сервера, принимающего SSL-трафик. Также возможно, что некоторые серверы в вашей организации, к которым АктивныйШлюз должен подключаться, генерируют и используют самоподписанные сертификаты, и ваша организация не заменила их официальными сертификатами.

При возникновении таких ситуаций в лог-файле АктивногоШлюза будет ошибка о том, что сертификат, представленный сервером, к которому ваш АктивныйШлюз пытался подключиться, не является доверенным. В этих случаях вам необходимо импортировать отсутствующий сертификат в АктивныйШлюз.<blockquote>'''Предупреждение'''

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

Если в журнале АктивногоШлюза сообщается об ошибке о том, что сертификат, представленный сервером, к которому ваш АктивныйШлюз пытался подключиться, не был доверенным, не думайте, что вам нужно добавить отсутствующий сертификат. Прежде чем продолжить, необходимы дополнительные исследования.</blockquote>'''Ошибка недействительного сертификата также может означать, что была попытка нарушить безопасность вашей организации. Поэтому вы всегда должны исследовать эту возможность, когда сообщается о такой ошибке.'''

== Подготовка сертификатов ЦС в файле ==
Прежде чем добавлять сертификат в АктивныйШлюз, его необходимо получить и поместить в файл <code>ca.cert</code>.

'''Следующая общая информация о сертификатах ЦС может помочь вам определить необходимые сертификаты:'''

Условия доверенного соединения SSL:

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

Чтобы увидеть, какие сертификаты предоставляет конечная точка, вы можете использовать следующую команду:
<code>openssl s_client -connect <API_ENDPOINT>:<PORT> -showcerts -servername <API_ENDPOINT_HOSTNAME></code>
'''Примечание:'''

Некоторые приложения (например, OpenShift) могут предоставлять разные сертификаты в зависимости от SNI. АктивныйШлюз установит сконфигурированное имя хоста конечной точки в SNI.

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

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

Например, конечная точка запроса <code>openssl</code> к этому серверу возвращает только сертификат сервера, а не корневой сертификат. Вы знаете, что этот сервер представляет только сертификат сервера, а не корневой сертификат, поскольку в сообщении об ошибке говорится, что невозможно получить сертификат локального эмитента. При наличии корневого сертификата в сообщении об ошибке будет указано «<code>Самозаверяющий сертификат в цепочке сертификатов</code>». Чтобы создать действительное SSL-соединение с этой конечной точкой, необходимо отдельно получить корневой сертификат.

Например:
<code>openssl s_client -connect localhost:6443
CONNECTED(00000005)
depth=0 CN = kube-apiserver
verify error:num=20:unable to get local issuer certificate
verify return:1
depth=0 CN = kube-apiserver
verify error:num=21:unable to verify the first certificate
verify return:1
---
Certificate chain
0 s:CN = apiserver
i:CN = AstromKeyRootAuth
---
Server certificate
-----BEGIN CERTIFICATE-----
MDIDYGCCAkigAwIBAgJIJ8SQ/FcmJiYwDQZJKoZIhvcNAQESBQAwFTETMBEGA1UE
AxMKa3ViZXJuZXRlczAeFw0yMTAxMjcxOTM1MDhaFw0yMjAxMjcxOTM1MDhaMBkx
FzAVBgNVBAMTDmt1YmUtYXBpc2VydmVyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A
MIIBCgKSAQEA15BVGULXSXZAM6a4Y7lR6JfSBOXIAq1sCoydH2AdhzqHu0mXj+Fd
sooRQ46f7bySZvMGFfLupmaAzH5kVJOVDQ2WoHPYVzAEhDji+SUBOi99AC0tevEa
ONLdkLGzR//2u8XND0iiswsGkK3yaNyPwCVnOnA3c4O32waMoM1VI9XGuNSqqfQF
6XUx8sGHG5bNVzfHOXh5CBJZ5JReDhW/J8CbPElYJPJaQcSpTVFx5ReTQqBLeBSy
eWyCwqMj/jAnKzpPffO478If/Uc8I5vS8zi2yPhYJhKqD0m1b96hH0slXKho25Ip
gpu4cIw03mQZMK558W4d6ccww/OvMbpKQQIDAQABo4GvMIGsMA4GA1UdDwEB/wQE
AwIFoDATBgNVHSUEDDAKBgfrBgEFBQcDATSBhAYDVR0RBH0we4IPamstazhzLWNs
b25lLTAwggprdWJlcm5ldGVzghJrdWJlcm5ldGVzLmRlZmF1bHSCFmt1YmVybmV0
ZXMuZGVmYXVsdC5zdmOCAGt1YmVybmV0ZXMuZGVmYXVsdC5zdmMuY2x1c3Rlci5s
b2NhbIcECmAAAYcErBcSvDANBgkqhkiG9w0BAQsFAAOCAQEAdmOq/Sp74xiLCa14
EI/9v7jUG+GqjD3HPpj/oXIdLHg6HA4nixxcxwnWAf2RAMVXBYn7qTDU6x7W5M+t
6M0uaCe8Od8oKjOKeQ31dfMpPbLYprKmcnuBriiN5gjfghINZKaZlGlX0GkBC9Ts
THYbmWfXfvfsX2xfpc4J0esfK+BafllEimCx8blnw1uY7CiCedEANePT+J5Q+m9L
m5pu7Qz/B4JDHLIJBArhFTBM6IIF6DhoqGUXM1XXqMlTVBpxz2vhf0N/HxcTaEBa
VWu7GZbk5mCYhngmRJ8PJ3uA8yajDT2muWm/la5oOI/GeuTgR98tqjXOXmz2NjvE
Zng1CA==
-----END CERTIFICATE-----
subject=CN = kube-apiserver

issuer=CN = kubernetes

---
Acceptable client certificate CA names
CN = kubernetes</code>
Приведенный ниже сертификат является примером корневого сертификата для вышеуказанного сертификата сервера. Убедитесь, что вы добавляете в свои хранилища доверенных сертификатов только те корневые сертификаты, которым вы доверяете.

Например:
<code>cat ca.crt | openssl x509 -text -noout
Certificate:
Data:
Version: 3 (0x2)
Serial Number: 0 (0x0)
Signature Algorithm: sha256WithRSAEncryption
Issuer: CN = kubernetes
Validity
Not Before: Jan 27 19:35:08 2021 GMT
Not After : Jan 25 19:35:08 2031 GMT
Subject: CN = kubernetes
Subject Public Key Info:</code>
Вы можете видеть, что это корневой сертификат, который вам нужен, потому что субъект и эмитент идентичны, и они совпадают с эмитентом сертификата сервера, показанного выше ('kube-apiserver').

== Создание хранилища доверенных сертификатов из сертификата ЦС ==
Создайте дополнительное хранилище доверенных сертификатов, содержащее только ваши сертификаты ЦС, которые будут объединены в АктивномШлюзе во время выполнения со встроенным хранилищем доверенных сертификатов JDK. Хранилище доверия должно быть в формате <code>PKCS12</code>. Форматы OpenSSL не поддерживаются, поэтому используйте команду <code>keytool</code> для выполнения преобразования. После преобразования вы должны поместить сертификат в каталог SSL АктивногоШлюза .

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

Примеры для Linux создания файла PKCS12 из файла CRT или файла PEM и размещения его либо непосредственно в каталоге SSL АктивногоШлюза, либо в текущем каталоге для последующего копирования:
<code>/opt/AstromKey/gateway/jre/bin/keytool -import -file ca.crt -alias dt_k8s_api -storetype pkcs12 -keystore /var/lib/AstromKey/gateway/ssl/mytrusted.p12</code>
или
<code>/opt/AstromKey/gateway/jre/bin/keytool -import -file dt_k8s_api.pem -alias myCertAuthority -storetype pkcs12 -keystore mytrusted.p12</code>

=== Проверка разрешений ===
Для Linux проверьте, что пользователь АктивногоШлюза, для которого был установлен АктивныйШлюз (по умолчанию <code>dtuser</code>), имеет права на запись в каталог SSL АктивногоШлюза (по умолчанию <code>/var/lib/AstromKey/gateway/ssl</code>) и что у пользователя есть права на чтение для созданного хранилища доверия.

== Настройка АктивногоШлюза для использования хранилища доверенных сертификатов ==
Чтобы настроить АктивныйШлюз для использования пользовательского файла хранилища доверенных сертификатов <code>mytrusted.p12</code>, убедитесь, что файл хранилища доверенных сертификатов находится в каталоге SSL АктивногоШлюза, а затем добавьте следующие записи в файл <code>custom.properties</code> в каталоге конфигурации АктивногоШлюза:
<code>[collector]
trustedstore = mytrusted.p12
# the following entries are optional
trustedstore-password = changeit
trustedstore-type = PKCS12</code>
Вы можете отобразить настроенный список псевдонимов и описания сертификатов с помощью команды <code>keytool -list</code> в новом хранилище доверенных сертификатов.

Например:
<code># /opt/AstromKey/gateway/jre/bin/keytool -list -keystore /var/lib/AstromKey/gateway/ssl/mytrusted.p12
Enter keystore password:
Keystore type: PKCS12
Keystore provider: SUN
Your keystore contains 1 entry
dt_k8s_api, Apr 26, 2020,
trustedCertEntry,
Certificate fingerprint (SHA-256): 08:18:9A:F2:29:31:0D:64:F0:1F:93:A1:CC:2E:A9:21:E9:DA:40:82:9B:A8:71:B7:A4:2C:6D:8C:B3:90:31:31</code>
<blockquote>Зашифрованный пароль

Пароль будет удален и зашифрован при перезапуске службы АктивногоШлюза.</blockquote>

== Перезапуск службы АктивногоШлюза и проверка конфигурации сертификата ==
Перезапустите основную службу АктивногоШлюза, чтобы изменения вступили в силу.

Если все настроено правильно, в журнале АктивногоШлюза должна быть запись следующего содержания:
<code>Custom certificate configuration created successfully.</code>

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

* Указано системное свойство <code>javax.net.ssl.trustStore</code>. Если это свойство указано, оно имеет приоритет над конфигурацией АктивногоШлюза.
* Настроенное хранилище доверенных сертификатов не может быть прочитано с использованием настроенного пути, пароля и типа.
* Объединенную конфигурацию нельзя записать в файл <code>ssl/runtime.cacerts</code>.

Пользовательский SSL-сертификат для АктивногоШлюза

2022-09-28T17:45:43Z

RGolovanov: Новая страница: «<blockquote>'''Не применимо к АктивномуШлюзу Кластера''' Прямая загрузка SSL-сертификата в Актив...»

<blockquote>'''Не применимо к АктивномуШлюзу Кластера'''

Прямая загрузка SSL-сертификата в АктивныйШлюз неприменима для АктивногоШлюза Кластера. Не пытайтесь настроить SSL-сертификаты непосредственно на АктивныйШлюз Кластера. Если вы сделаете это, сертификат будет перезаписан автоматическим управлением Dynatrace. Для АктивныхШлюзов Кластера вы должны загрузить свои сертификаты с помощью Cluster Management Console или Cluster REST API v1.</blockquote>Подключение к АктивномуШлюзу из OneAgents или REST API происходит по зашифрованному каналу HTTPS. АктивныйШлюз предоставляет самозаверяющий сертификат аутентификации всем подключающимся клиентам. В то время как экземпляры OneAgent могут игнорировать действительность сертификатов АктивныхШлюзов (в зависимости от конфигурации), подключения от клиентов браузера (например, RUM JavaScript) перед отправкой данных проверяют правильность имени хоста, указанного в сертификате.

'''АктивныйШлюз может обслуживать пользовательский сертификат вместо сертификата по умолчанию. Чтобы настроить это, вам нужен файл в формате PKCS#12, который содержит закрытый ключ и соответствующую цепочку сертификатов.'''

=== Настройка во время установки ===
Эту конфигурацию также можно применить во время установки АктивногоШлюза, указав параметры установки для установок [[Установка АктивногоШлюза на Linux|Linux]] или [[Установка АктивногоШлюза на Windows|Windows]].

== Настройка пользовательского сертификата ==
Чтобы настроить АктивныйШлюз для использования пользовательского сертификата

# Скопируйте файл сертификата в каталог ssl и установите правильные разрешения. В Linux убедитесь, что разрешения скопированного файла сертификата включают пользователя АктивногоШлюза, которого вы назначили для запуска службы АктивногоШлюза. Если вы не указали пользовательского пользователя во время установки, пользователем по умолчанию будет <code>dtuserag</code>. В Windows убедитесь, что учетная запись <code>LocalService</code> имеет разрешения на доступ к скопированному файлу сертификата.
# Добавьте следующие записи в файл <code>custom.properties</code> в каталоге конфигурации АктивногоШлюза.

<code>[com.compuware.apm.webserver]
certificate-file = certificate-file.p12
certificate-password = password
certificate-alias = friendly-name</code>
Вам необходимо добавить указанные выше записи в раздел <code>[com.compuware.apm.webserver]</code>. Если в вашем файле <code>custom.properties</code> уже есть такой раздел, просто добавьте свойства в раздел. Если раздела нет, то создайте и заголовок раздела.

Пароль сертификата, который вы указываете в свойстве <code>certificate-password</code>, будет запутан после перезапуска основной службы АктивногоШлюза. Запутанный пароль хранится в свойстве <code>certificate-password-encr</code>, а исходное свойство удаляется.

'''Примечание:'''

'''Значение <code>certificate-alias</code> должно быть указано в нижнем регистре'''.

Если у сертификата нет понятного имени, вы можете опустить свойство <code>certificate-alias</code>.

== Управление сертификатами через REST API ==
Сертификатами можно управлять удаленно через REST API. Подготовьте файл сертификата <code>PKCS#12</code>, и вы можете загрузить его в АктивныйШлюз с помощью REST.<blockquote>'''Токен авторизации'''

Токен API необходим для авторизации. Токены API могут предоставляться через заголовки HTTP или другими способами.

Токен API, используемый для следующих действий, должен иметь разрешение <code>ActiveGate Certificate Management</code>.</blockquote>

=== Загрузить и активировать сертификат ===
Следующая точка REST загружает и активирует выбранный файл сертификата. Пароль для файла должен совпадать с паролем для ключей, содержащихся в файле, и они должны быть указаны в пользовательском HTTP-заголовке <code>X-Password</code>.

<code>curl <nowiki>https://{address</nowiki> of ActiveGate}:{port}/e/{environment ID}/api/v1/certificate/{certificate file name} -H"Authorization: Api-Token {token}" -H"X-Password: {password}" -T {path to certificate file}</code>

* Порт настраивается, по умолчанию 9999.
* Путь к файлу сертификата может быть просто именем локального файла или полным путем.
* Имя сертификата, указанное в URL-адресе, не обязательно должно совпадать с именем файла.

<code>curl <nowiki>https://myActiveGate:9999/e/myEnvironmentId/api/v1/certificate/cert.p12</nowiki> -H"Authorization: Api-Token 123abc" -H"X-Password: myPassword" -T cert.p12</code>
Если вызов API выполнен успешно, ответ HTTP будет <code>200</code> с описанием содержимого файла активированного сертификата в формате JSON.

Если вызов API завершится неудачно, ответом HTTP будет код ошибки <code>4xx</code> или <code>5xx</code> с обычным текстовым сообщением.

=== Замена активного сертификата ===
Вы не можете заменить активный сертификат с помощью этой конечной точки. Операция вернет <code>HTTP 403 Forbidden</code>. Чтобы заменить активный сертификат, загрузите новый сертификат под другим именем, а затем удалите старый сертификат.ld certificate.

=== Удаление сертификата ===
<code>curl -XDELETE <nowiki>https://myActiveGate:9999/e/myEnvironmentId/api/v1/certificate/cert.p12</nowiki> -H"Authorization: Api-Token 123abc"</code>
Если сертификат удален успешно, вызов API ответит кодом HTTP <code>200</code> без содержимого.

Если файл с указанным именем не существует, вызов API ответит кодом HTTP <code>404 Not found</code>.

Если файл сертификата в настоящее время используется, вызов API ответит кодом HTTP <code>403 Forbidden</code>.

=== Активация сертификата ===
<code>curl -XPOST <nowiki>https://myActiveGate:9999/e/myEnvironmentId/api/v1/certificate/cert.p12/activate</nowiki> -H"Authorization: Api-Token 123abc" -d"{\"password\":\"pass\"}"</code>

<code>curl -XPOST <nowiki>https://myActiveGate:9999/e/myEnvironmentId/api/v1/certificate/cert.p12/activate</nowiki> -H"Authorization: Api-Token 123abc" -H"X-Password: pass"</code>
Если сертификат успешно активирован, вызов API ответит кодом HTTP <code>200</code> с описанием содержимого файла активированного сертификата в формате JSON.

Если запрошенный файл сертификата не существует в АктивномШлюзе, вызов API ответит кодом HTTP <code>404</code>.

Если предоставленный пароль не совпадает, вызов API отвечает кодом HTTP <code>400</code>.

=== Список всех сертификатов ===
<code>curl <nowiki>https://myActiveGate:9999/e/myEnvironmentId/api/v1/certificate/list</nowiki> -H"Authorization: Api-Token 123abc"</code>
Если активное хранилище ключей есть в списке, его запись будет содержать дополнительные сведения.

Пример ответа:
<code>[
{
"name":"cert_demo.p12"

},
{ "name":"cert.p12",
"desc":[ {
"alias":"local",
"description":"Subject:CN=myActiveGate;Valid from:Fri Feb 15 13:16:58 CET 2019;Valid to:Sat Feb 15 13:16:58 CET 2020;Serial number:71d275dd3983c3cb9382437275dd3983c3cb93dbca"

},
{
"alias":"dynatrace",
"description":"Subject:CN=*.clients.dynatrace.org;Valid from:Thu Feb 21 10:06:03 CET 2019;Valid to:Fri Feb 21 10:06:03 CET 2020;Serial number:6dc7008ab269ecebeed03652ce08ab269ecebeeeb33"

}

]

},
{
"name":"cert_key_1.p12"

}
]</code>

=== Описание сертификата ===
Этот вызов API возвращает описание выбранного файла в формате JSON.
<code>curl <nowiki>https://myActiveGate:9999/e/myEnvironmentId/api/v1/certificate/cert.p12/list</nowiki> -H"Authorization: Api-Token 123abc" -H"X-Password: pass"</code>

<code>curl -XPOST <nowiki>https://myActiveGate:9999/e/myEnvironmentId/api/v1/certificate/cert.p12/list</nowiki> -H"Authorization: Api-Token 123abc" -H"X-Password: pass"</code>

<code>curl -XPOST <nowiki>https://myActiveGate:9999/e/myEnvironmentId/api/v1/certificate/cert.p12/list</nowiki> -H"Authorization: Api-Token 123abc" -d"{\"password\":\"pass\"}"</code>
Если запрошенный файл сертификата не существует в АктивномШлюзе, вызов API ответит кодом HTTP <code>404</code>.

Если пароль не совпадает, вызов API отвечает кодом HTTP <code>400</code>.

Пример ответа:
<code>{ "name":"cert.p12",
"desc":[ {
"alias":"local",
"description":"Subject:CN=myActiveGate;Valid from:Fri Feb 15 13:16:58 CET 2019;Valid to:Sat Feb 15 13:16:58 CET 2020;Serial number:7137275dd398c4182437275dd3983c3cb93dbca"

},
{
"alias":"dynatrace",
"description":"Subject:CN=*.clients.dynatrace.org;Valid from:Thu Feb 21 10:06:03 CET 2019;Valid to:Fri Feb 21 10:06:03 CET 2020;Serial number:6d2ce08ab269ecebeee7f1bd03652ce08ab269ecebeeeb33"

}

]
}</code>

=== Исправление проблем ===
Когда файл сертификата и пароль указаны, АктивныйШлюз пытается использовать заданную конфигурацию.

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

<code>UTC WARNING [<1>] [CollectorImpl] Unusable custom SSL config, falling back to default.</code>
АктивныйШлюз дополнительно регистрирует причину, по которой он не может использовать настроенный сертификат. Например, если псевдоним не соответствует содержимому файла, АктивныйШлюз запишет в лог-файл запись:
<code>UTC SEVERE [<1>] [SSLEnvironment] missing configured-alias entry in keystore:/var/lib/dynatrace/gateway/config/../ssl/cert-file.p12, available aliases: available-alias,</code>

== Создание файла сертификата для тестирования ==
Чтобы создать файл самоподписанного сертификата <code>PKCS#12</code> для тестирования,

* Сгенерируйте ключ и самоподписанный сертификат:

<code>openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365 -subj "/CN=localhost"</code>

* Преобразуйте сгенерированные файлы в формат <code>PKCS#12</code>, устанавовив понятное имя <code>-name friendly-name</code> в нижнем регистре:

<code>openssl pkcs12 -export -inkey key.pem -in cert.pem -out cert_key.p12</code>

== Известные ограничения и поддержка нескольких сертификатов ==

* Пароль для файла <code>PKCS#12</code> должен совпадать с паролем для ключа, содержащегося в этом файле. Не используйте параметр <code>-twopass</code> в команде <code>openssl pkcs12</code>.
* Невозможно использовать несколько файлов сертификатов: может быть только один файл сертификата АктивногоШлюза, хотя файл может содержать несколько сертификатов и ключей.

Обратный прокси (балансировщик загрузки) для АктивногоШлюза

2022-09-28T17:17:51Z

RGolovanov:

На пути от АктивногоШлюза до кластера Ключ-Астром можно разместить обратный прокси-сервер или балансировщик нагрузки. Это позволит вашему АктивномуШлюзу подключаться к любому доступному узлу кластера, распределяя нагрузку между узлами.

Для этого вам необходимо:

* Указать адрес обратного прокси-сервера/балансировщика нагрузки.
* Убедиться, что АктивныйШлюз будет игнорировать любую дополнительную информацию о целевом адресе, отправленную из кластера Ключ-Астром, и, таким образом, будет подключаться только к указанному вами адресу. [[Файл:Бз для АктивногоШлюза. .png]]

=== Возможность настройки во время установки ===
Эту конфигурацию можно использовать для обратного прокси-сервера или балансировщика нагрузки. Также можно применить во время установки АктивногоШлюза, указав параметры в установщике АктивногоШлюза для Linux или Windows, или ее можно настроить позже, после установки АктивногоШлюза, как показано в следующей процедуре.

== Настройка АктивногоШлюза для обратного прокси-сервера или балансировщика нагрузки. ==
Выполните следующие шаги, чтобы указать адрес обратного прокси-сервера и игнорировать информацию о подключении, полученную от кластера Ключ-Астром:

* Остановите АктивныйШлюз и отредактируйте файл <code>custom.properties</code> в каталоге конфигурации АктивногоШлюза.
* Чтобы АктивныйШлюз игнорировал информацию о подключении, полученную от кластера Ключ-Астром, добавьте или измените параметр <code>ignoreClusterRuntimeInfo</code> в <code>[connectivity]</code> разделе <code>custom.properties</code> файл:

<code>[connectivity]
ignoreClusterRuntimeInfo = true</code>

* Укажите адрес обратного прокси: Добавьте параметр <code>seedServerUrl</code> в <code>[collector]</code> раздел <code>custom.properties</code> файл в следующем формате:

<code>seedServerUrl = https://<REVERSE_PROXY>:<REVERSE_PROXY_PORT>/communication</code>
<code>[collector]
seedServerUrl = <nowiki>https://my.reverse-proxy.com:443/communication</nowiki></code>
'''Укажите несколько адресов:'''

Параметр может быть одним значением или списком через запятую целевых адресов, к которым подключается АктивныйШлюз.
<code>[collector]
seedServerUrl = <nowiki>https://my.reverse-proxy-1.com:443/communication,https://my.reverse-proxy-2.com:443/communication</nowiki></code>

* Сохраните файл <code>custom.properties</code> и перезапустите основную службу АктивногоШлюза.

Файл:Бз для АктивногоШлюза. .png

2022-09-28T17:17:24Z

RGolovanov:

Бз для АктивногоШлюза.

Обратный прокси (балансировщик загрузки) для АктивногоШлюза

2022-09-28T17:10:52Z

RGolovanov:

На пути от АктивногоШлюза до кластера Ключ-Астром можно разместить обратный прокси-сервер или балансировщик нагрузки. Это позволит вашему АктивномуШлюзу подключаться к любому доступному узлу кластера, распределяя нагрузку между узлами.

Для этого вам необходимо:

* Указать адрес обратного прокси-сервера/балансировщика нагрузки.
* Убедиться, что АктивныйШлюз будет игнорировать любую дополнительную информацию о целевом адресе, отправленную из кластера Ключ-Астром, и, таким образом, будет подключаться только к указанному вами адресу.

=== Возможность настройки во время установки ===
Эту конфигурацию можно использовать для обратного прокси-сервера или балансировщика нагрузки. Также можно применить во время установки АктивногоШлюза, указав параметры в установщике АктивногоШлюза для Linux или Windows, или ее можно настроить позже, после установки АктивногоШлюза, как показано в следующей процедуре.

== Настройка АктивногоШлюза для обратного прокси-сервера или балансировщика нагрузки. ==
Выполните следующие шаги, чтобы указать адрес обратного прокси-сервера и игнорировать информацию о подключении, полученную от кластера Ключ-Астром:

* Остановите АктивныйШлюз и отредактируйте файл <code>custom.properties</code> в каталоге конфигурации АктивногоШлюза.
* Чтобы АктивныйШлюз игнорировал информацию о подключении, полученную от кластера Ключ-Астром, добавьте или измените параметр <code>ignoreClusterRuntimeInfo</code> в <code>[connectivity]</code> разделе <code>custom.properties</code> файл:

<code>[connectivity]
ignoreClusterRuntimeInfo = true</code>

* Укажите адрес обратного прокси: Добавьте параметр <code>seedServerUrl</code> в <code>[collector]</code> раздел <code>custom.properties</code> файл в следующем формате:

<code>seedServerUrl = https://<REVERSE_PROXY>:<REVERSE_PROXY_PORT>/communication</code>
<code>[collector]
seedServerUrl = <nowiki>https://my.reverse-proxy.com:443/communication</nowiki></code>
'''Укажите несколько адресов:'''

Параметр может быть одним значением или списком через запятую целевых адресов, к которым подключается АктивныйШлюз.
<code>[collector]
seedServerUrl = <nowiki>https://my.reverse-proxy-1.com:443/communication,https://my.reverse-proxy-2.com:443/communication</nowiki></code>

* Сохраните файл <code>custom.properties</code> и перезапустите основную службу АктивногоШлюза.

Обратный прокси (балансировщик загрузки) для АктивногоШлюза

2022-09-28T17:06:57Z

RGolovanov: Новая страница: «На пути от АктивногоШлюза до кластера Ключ-Астром можно разместить обратный прокси-серв...»

На пути от АктивногоШлюза до кластера Ключ-Астром можно разместить обратный прокси-сервер или балансировщик нагрузки. Это позволит вашему АктивномуШлюзу подключаться к любому доступному узлу кластера, распределяя нагрузку между узлами.

Для этого вам необходимо:

* Указать адрес обратного прокси-сервера/балансировщика нагрузки.
* Убедиться, что АктивныйШлюз будет игнорировать любую дополнительную информацию о целевом адресе, отправленную из кластера Ключ-Астром, и, таким образом, будет подключаться только к указанному вами адресу.

=== Возможность настройки во время установки ===
Эту конфигурацию можно использовать для обратного прокси-сервера или балансировщика нагрузки. Также можно применить во время установки АктивногоШлюза, указав параметры в установщике АктивногоШлюза для Linux или Windows, или ее можно настроить позже, после установки АктивногоШлюза, как показано в следующей процедуре.

== Настройка АктивногоШлюза для обратного прокси-сервера или балансировщика нагрузки. ==
Выполните следующие шаги, чтобы указать адрес обратного прокси-сервера и игнорировать информацию о подключении, полученную от кластера Ключ-Астром:

# Остановите АктивныйШлюз и отредактируйте файл <code>custom.properties</code> в каталоге конфигурации АктивногоШлюза.
# Чтобы АктивныйШлюз игнорировал информацию о подключении, полученную от кластера Ключ-Астром, добавьте или измените параметр <code>ignoreClusterRuntimeInfo</code> в <code>[connectivity]</code> разделе <code>custom.properties</code> файл:

<code>[connectivity]
ignoreClusterRuntimeInfo = true</code>
Укажите адрес обратного прокси: Добавьте параметр <code>seedServerUrl</code> в <code>[collector]</code> раздел <code>custom.properties</code> файл в следующем формате:

<code>seedServerUrl = https://<REVERSE_PROXY>:<REVERSE_PROXY_PORT>/communication</code>
<code>[collector]
seedServerUrl = <nowiki>https://my.reverse-proxy.com:443/communication</nowiki></code>
'''Укажите несколько адресов:'''

Параметр может быть одним значением или списком через запятую целевых адресов, к которым подключается АктивныйШлюз.
<code>[collector]
seedServerUrl = <nowiki>https://my.reverse-proxy-1.com:443/communication,https://my.reverse-proxy-2.com:443/communication</nowiki></code>
Сохраните файл <code>custom.properties</code> и перезапустите основную службу АктивногоШлюза.

Настройка прокси АктивногоШлюза

2022-09-28T16:38:54Z

RGolovanov:

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

== Свойства конфигурации прокси ==
Конфигурация прокси АктивногоШлюза состоит из следующих настроек. В зависимости от типа связи, для которой вы хотите использовать (или отключить) прокси, следующие свойства конфигурации могут появиться в разных разделах конфигурации вашей конфигурации АктивногоШлюза.
{| class="wikitable"
!Свойство
!Описание
|-
|<code>proxy-server</code>
|Адрес сервера (имя хоста или IP-адрес)
|-
|<code>proxy-port</code>
|Порт (необязательно)

Если оставить пустым, используется порт <code>8080</code> по умолчанию.
|-
|<code>proxy-user</code>
|Имя пользователя (необязательно)
|-
|<code>proxy-domain</code>
|Домен пользователя в случае аутентификации NTLM
|-
|<code>proxy-password</code>
|Пароль (необязательно)

Пароль, указанный в свойстве <code>proxy-password</code>, обфусцируется после перезапуска АктивногоШлюза, а замаскированный пароль сохраняется в свойстве <code>proxy-password-encr</code>.
|-
|<code>proxy-off</code>
|Если установлено значение <code>true</code>, прокси отключается для определенного типа связи.
|-
|<code>proxy-non-proxy-hosts</code>
|Список хостов, для связи с которыми АктивныйШлюз не должен использовать прокси

Хосты в списке должны быть разделены символом <code>|</code> персонажи. Вы также можете использовать звездочку <code>*</code> в качестве подстановочного знака для соответствия любой строке. Может быть только один подстановочный знак в начале или в конце имени хоста. Например, <code>proxy-non-proxy-hosts=*.foo.com|localhost</code> указывает, что каждый хост в домене <code>foo.com</code> и <code>localhost</code> должен быть доступен напрямую, даже если указан прокси-сервер. Полное описание допустимого синтаксиса см. в синтаксисе параметра <code>http.nonProxyHosts</code> в свойствах сети.
|}

== Укажите конфигурацию прокси для АктивногоШлюза ==
Конфигурация прокси АктивногоШлюза может быть указана во время установки АктивногоШлюза в Linux или Windows (только настройка для всех исходящих соединений), либо ее можно настроить после установки АктивногоШлюза. Чтобы настроить прокси для АктивногоШлюза:

* Отредактируйте файл <code>custom.properties</code> в каталоге конфигурации АктивногоШлюза.
* Укажите параметры прокси в соответствующем разделе конфигурации файла <code>custom.properties</code>, в зависимости от того, для каких целей вы хотите использовать прокси (см. примеры ниже). Например:

<code>[http.client]
proxy-server=127.0.0.1
proxy-port=8080
# basic authentication credentials
proxy-user=username
proxy-password=password</code>

* Сохраните файл <code>custom.properties</code>.
* Перезапустите основную службу АктивногоШлюза. Обратите внимание, что после перезапуска службы пароль прокси, указанный вами в конфигурации, шифруется и перемещается из свойства <code>proxy-password</code> в <code>proxy-password-encr</code>.

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

=== Настройки прокси АктивногоШлюза для всего исходящего трафика ===
[[Файл:ПроксиАктивногоШлюзаДляВсегоТрафика.png]]

Следующая конфигурация охватывает наиболее распространенный случай указания параметров прокси-сервера для исходящего соединения АктивногоШлюза как с кластером Ключ-Астром, так и с отслеживаемыми технологиями, такими как AWS, VMware или Azure.

Укажите параметры, связанные с прокси, в разделе <code>[http.client]</code> файла <code>custom.properties</code>, включая параметры, связанные с аутентификацией, если это необходимо:
<code>[http.client]
proxy-server=127.0.0.1
proxy-port=8080
# basic authentication credentials
proxy-user=username
proxy-password=password</code>

=== Настройки прокси АктивногоШлюза только для кластера ===
[[Файл:ПроксиАктивногоШлюзаДляКластера.png]]
Чтобы настроить прокси специально для кластера, позволяя исходящему мониторинговому трафику напрямую подключаться к отслеживаемым технологиям, задайте настройки прокси в разделе <code>[http.client.internal]</code> конфигурации АктивногоШлюза.
<code>[http.client.internal]
proxy-server=127.0.0.1
proxy-port=8080
# basic authentication credentials
proxy-user=username
proxy-password=password</code>
'''Примечание:'''

Для корректной работы связи АктивногоШлюза после указания вышеперечисленных настроек вам потребуется повторить настройки связи без прокси в <code>http.client.internal</code> или <code>http.client.external</code> и/или вам потребуется создать разделы <code>http.client.internal</code> или <code>http.client.external</code>.

=== Прокси-сервер АктивногоШлюза для исходящего трафика мониторинга с прямым подключением к кластеру ===
[[Файл:ПроксиАктивногоШлюзаДляКластераИТрафика.png]]

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

* Укажите конфигурацию прокси в разделе <code>[http.client]</code> файла <code>custom.properties</code>.
* Отключите прокси в разделе <code>[http.client.internal]</code>.

<code>[http.client]
proxy-server=127.0.0.1
proxy-port=8080
# basic authentication credentials
proxy-user=username
proxy-password=password

[http.client.internal]
proxy-off=true</code>
'''Примечание:'''

Для корректной работы связи АктивногоШлюза после указания вышеперечисленных настроек вам потребуется повторить настройки связи без прокси в <code>http.client.internal</code> или <code>http.client.external</code> и/или вам потребуется создать разделы <code>http.client.internal</code> или <code>http.client.external</code>.

== Расширенные сценарии настройки прокси для АктивногоШлюза ==
Чтобы настроить прокси '''для исходящих подключений''' из АктивногоШлюза, то есть для подключений к отслеживаемым технологиям или к кластеру, отредактируйте файл <code>custom.properties</code> и задайте свойства в соответствующем разделе. В зависимости от раздела конфигурации, в котором указаны свойства, прокси (и другие параметры связи) влияют только на выбранные типы соединений:

* <code>[http.client]</code> — настройки прокси для всех исходящих соединений АктивногоШлюза, включая кластер и все отслеживаемые технологии.
* <code>[http.client.internal]</code> — настройки прокси специально для связи с кластером. Эти настройки переопределяют настройки, указанные в <code>[http.client]</code>.
* <code>[http.client.external]</code> — настройки прокси специально для отслеживаемых технологий: CloudFoundry, Kubernetes, приватный синтетический мониторинг. Эти настройки переопределяют настройки, указанные в <code>[http.client]</code>.
* <code>[<technology name>]</code> — настройки прокси специально для конкретной отслеживаемой технологии, например <code>cloudfoundry_monitoring</code>, <code>kubernetes_monitoring</code>, <code>synthetic</code>. Эти параметры переопределяют параметры, указанные в <code>[http.client]</code> и <code>[http.client.external]</code>. Обратите внимание, что настройки для многих из этих технологий можно указать совместно в <code>[http.client.external]</code>.

=== Прокси АктивногоШлюза для Kubernetes, CloudFoundry и частного синтетического мониторинга ===
Вы можете указать настройки прокси сразу для нескольких отслеживаемых технологий. Настройки, указанные в разделе <code>http.client.external</code>, влияют на Kubernetes, CloudFoundry и приватный синтетический мониторинг (этот набор может быть расширен в будущем):
<code>[http.client.external]
proxy-server=127.0.0.1
proxy-port=8080
# basic authentication credentials
proxy-user=username
proxy-password=password</code>
'''Примечание:'''

Для корректной работы связи АктивногоШлюза после указания вышеперечисленных настроек вам потребуется повторить настройки связи без прокси в <code>http.client.internal</code> или <code>http.client.external</code> и/или вам потребуется создать разделы <code>http.client.internal</code> или <code>http.client.external</code>.

=== Разные прокси для Kubernetes, CloudFoundry и частный синтетический мониторинг ===
Вы также можете указать выделенные настройки прокси для конкретной отслеживаемой технологии:

* Cloud Foundry в разделе <code>cloudfoundry_monitoring</code>
* Kubernetes в разделе <code>kubernetes_monitoring</code>
* Приватный синтетический мониторинг в разделе <code>synthetic</code>

<code>[kubernetes_monitoring]
proxy-server=127.0.0.1
proxy-port=8080
# basic authentication credentials
proxy-user=username
proxy-password=password</code>

== Текущие ограничения ==

=== Повторение настроек связи в <code>[http.client.internal]</code> или <code>[http.client.external]</code>. ===
При указании конфигурации прокси в <code>[http.client.internal]</code> или <code>[http.client.external]</code> обратите внимание, что эти разделы затрагивают различные аспекты связи, а не только прокси. При создании любого из этих разделов обязательно сначала скопируйте содержимое существующего раздела <code>[http.client]</code> из файла <code>configuration.properties</code> (и настройте его соответствующим образом):

* Откройте файл <code>config.properties</code> и скопируйте все свойства из раздела <code>[http.client]</code> в файл <code>custom.properties</code>, раздел <code>[http.client.internal]</code> или <code>[http.client.external]</code> (в зависимости от ситуации).
* Если в файле <code>custom.properties</code> есть раздел <code>[http.client]</code>, используйте перечисленные там значения, чтобы перезаписать указанные выше значения (значения, которые вы только что скопировали из <code>config.properties</code>).

<code>[http.client.external]
# proxy settings as specific to http.client.external:
proxy-server=127.0.0.1
proxy-port=8080
# basic authentication credentials
proxy-user=username
proxy-password=password
# communication settings copied from existing configuration:
connection-timeout=5000
socket-timeout=20000
connection-request-timeout=5000
idle-connection-timeout=15000
max-total-connections=256
max-connections-per-route=32
certificate-validation=yes
hostname-verification=yes</code>

Файл:ПроксиАктивногоШлюзаДляКластераИТрафика.png

2022-09-28T16:38:42Z

RGolovanov:

ПроксиАктивногоШлюзаДляКластераИТрафика

Файл:ПроксиАктивногоШлюзаДляКластера.png

2022-09-28T16:33:22Z

RGolovanov:

ПроксиАктивногоШлюзаДляКластера

Файл:ПроксиАктивногоШлюзаДляВсегоТрафика.png

2022-09-28T16:31:29Z

RGolovanov:

ПроксиАктивногоШлюзаДляВсегоТрафика

Установка АктивногоШлюза на Windows

2022-09-28T16:21:37Z

RGolovanov:

== Требования к установке ==

=== Аппаратные требования ===
Вам нужна машина, предназначенная для АктивногоШлюза, которая имеет:

* 4 ГБ свободного места на диске для установки АктивногоШлюза и расширений, настройки и журналов для автоматического обновления.
* 4 ГБ для кэшированных установщиков АктивногоШлюза и ЕдиногоАгента и образов контейнеров — если их нужно будет хранить.
* Место для файлов дампа — если их нужно будет сохранить. Эта функция отключена по умолчанию, но ее можно включить в конфигурации АктивногоШлюза. Максимальный размер дискового пространства настраивается — по умолчанию 100 ГБ.
* Место для загрузки расширений — в зависимости от используемых расширений.
* 2 ГБ оперативной памяти (рекомендуется 4 ГБ).
* 1 двухъядерный процессор.

Для больших сред вам может понадобиться машина с дополнительным процессором и памятью.

=== Требования к пространству по каталогам ===
{| class="wikitable"
!'''Каталог верхнего уровня'''
!'''Требования к дисковому пространству'''
|-
|Исполняемые файлы АктивногоШлюза и автообновления, библиотеки и сопутствующие файлы

стандартный каталог: <code>%PROGRAMFILES%\AstromKey\gateway</code>

относительно параметра установки: <code><INSTALL>\gateway</code>
|300 МБ
|-
|Конфигурация АктивногоШлюза и связанные каталоги

Для АктивногоШлюза Окружения он также содержит конфигурацию Extensions 1.0 и Extensions 2.0.

стандартный каталог: <code>%PROGRAMDATA%\AstromKey</code>

относительно параметра установки: <code><CONFIG></code>
|2 МБ
|-
|Только для АктивногоШлюза Окружения: Исполняемые файлы Extensions 1.0 и Extensions 2.0, библиотеки и связанные файлы по умолчанию: <code>%PROGRAMFILES%\AstromKey\remotepluginmodule</code>

относительно параметра установки: <code><INSTALL>\remotepluginmodule</code>
|350 МБ
|-
|Журналы АктивныхШлюзов и автообновления

стандартный каталог: <code>%PROGRAMDATA%\AstromKey</code>

параметр установки: <code><LOG></code>
|1.2 ГБ
|-
|Временные файлы АктивногоШлюза

default: <code>%PROGRAMDATA%\AstromKey\gateway\tmp</code>

путь относительно параметра установки: <code><TEMP>\gateway</code>
|4 ГБ (включая 3 ГБ для кэшированных установщиков OneAgent и образов контейнеров)
|-
|Файлы дампа, загруженные в АктивныйШлюз ЕдинымАгентом

<code>%PROGRAMDATA%\AstromKey\gateway\dump</code>
|Функциональность отключена по умолчанию, не настраивается во время установки.

При активации может принимать настраиваемый максимальный размер: по умолчанию 100 ГБ.
|-
|Только для АктивногоШлюза Окружения: журналы расширений 1.0 и 2.0 АктивногоШлюза, кэш, рабочая область во время выполнения

стандартный каталог: <code>%PROGRAMDATA%\AstromKey\remotepluginmodule</code>

путь относительно параметра установки: <code><CONFIG>\remotepluginmodule</code>
|2 ГБ
|-
|Только для АктивногоШлюза Окружения: Каталог загрузки расширений

стандартный каталог: <code>%PROGRAMFILES%\AstromKey\remotepluginmodule\plugin_deployment</code>

путь относительно параметра установки: <code><INSTALL>\remotepluginmodule\plugin_deployment</code>
|В зависимости от загруженных расширений
|}

=== Поддерживаемые операционные системы ===
{| class="wikitable"
!Дистрибутив Linux
!Версии
!Архитектуры ЦП
|-
| rowspan="1" |Windows
|8.1, 10
|x86-64
|-
| rowspan="1" |Windows Server
|2012, 2012 R2, 2016, 2019, 2022
|x86-64
|}

=== Системные требования ===

* АктивныйШлюз поддерживает только операционные системы, работающие на архитектуре x86-64 (64-битные Intel/AMD).
* Убедитесь, что у вас правильная конфигурация сетевого порта.
* Установка АктивногоШлюза не поддерживается в Windows с отключенной учетной записью <code>NT AUTHORITY\LocalService</code>.

=== Размеры AWS ===
В таблице представлены требования к размеру экземпляра машины в зависимости от количества агентов ЕдиныхАгентов, взаимодействующих с АктивнымШлюзом. На каждом хосте ЕдиныйАгент выполняет семь задач мониторинга:

* Мониторинг инфраструктуры
* Мониторинг логов
* Полный стек мониторинга 3 экземпляров Apache Tomcat
* Полный стек мониторинга 2 экземпляров HTTP-сервера Apache

{| class="wikitable"
!Размер машины
!Количество хостов
|-
|c4.large
|450
|-
|c4.xlarge
|900
|-
|c4.2xlarge
|1200
|}
Экземпляры машин С4:
{| class="wikitable"
!Машина
!vCPU
!Память (ГБ)
!Хранилище
!Выделенная пропускная способность EBS (Мбит/с)
!Производительность сети
|-
|c4.large
|2
|3.75
|EBS-Only
|500
|Умеренная
|-
|c4.xlarge
|4
|7.5
|EBS-Only
|750
|Высокая
|-
|c4.2xlarge
|8
|15
|EBS-Only
|1,000
|Высокая
|}

== Установка АктивногоШлюза ==

=== Разрешите подключения через брандмауэр ===
Убедитесь, что настройки вашего брандмауэра разрешают связь с Ключом-Астром.

В зависимости от политики вашего брандмауэра вам может потребоваться явно разрешить определенные исходящие соединения.

АктивныйШлюз обычно прослушивает (принимает входящие соединения) порт <code>9999</code> и взаимодействует с Ключом-Астром (устанавливает исходящие соединения) через порт <code>443</code>.

=== Установка ===

# Войдите в Ключ-Астром, выберите '''Развернуть Ключ-Астром''' в меню навигации и выберите '''Установить АктивныйШлюз'''.
# На странице '''Установка АктивногоШлюза Окружения''' выберите '''Windows'''.
# Выберите [https://doc.ruscomtech.ru/index.php/%D0%A6%D0%B5%D0%BB%D0%B8%20%D0%90%D0%BA%D1%82%D0%B8%D0%B2%D0%BD%D0%BE%D0%B3%D0%BE%D0%A8%D0%BB%D1%8E%D0%B7%D0%B0 цель АктивногоШлюза].
# Предоставьте PaaS-токен. Он необходим для загрузки установщика АктивногоШлюза из вашей среды. Если у вас нет токена PaaS, вы можете создать его прямо в пользовательском интерфейсе. Токен автоматически добавляется к командам загрузки и установки, которые вы будете использовать позже.
# Скачайте установщик по скопированной cmd-команде или по ссылке.
# Запустите установщик '''с правами администратора'''.

==== Конфигурация установки ====
Вы можете добавить дополнительные параметры в команду установки, чтобы настроить установку. Например, чтобы установить АктивныйШлюз в другой каталог, используйте параметр <code>INSTALL=<путь></code>:
<code>C:\ AstromKey-ActiveGate-Windows-x86-1.0.0.exe '''INSTALL=D:\hosted_app\AstromKey'''</code>

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

Чтобы проверить статус установки, выберите '''Показать статус развертывания''' и перейдите на вкладку '''АктивныеШлюзы'''.
==Стандартные настройки установщика==
Если вы не укажете какие-либо параметры во время установки АктивногоШлюза для настройки параметров, будут применены следующие параметры по умолчанию.
===Каталоги===
{| class="wikitable"
!'''Цель каталога'''
!'''Путь по умолчанию'''Путь относительно параметра установки
!'''Требования к дисковому пространству'''(если размер не указан, предположим, что он меньше 1 МБ)
|-
|Исполняемые файлы АктивногоШлюза, библиотеки и связанные файлы
|<code>%PROGRAMFILES%\AstromKey\gateway</code><code><INSTALL>\gateway</code>
|300 МБ
|-
|Конфигурация АктивногоШлюза
|<code>%PROGRAMDATA%\AstromKey\gateway\config</code>
|
|-
|SSL-папка АктивногоШлюза
|<code>%PROGRAMDATA%\AstromKey\gateway\ssl</code>
|
|-
|Временные файлы АктивногоШлюза
|<code>%PROGRAMDATA%\AstromKey\gateway\tmp</code>
|4 ГБ (включая 3 ГБ для кэшированных установщиков ЕдиныхАгентов и образов контейнеров)
|-
|Логи АктивногоШлюза
|<code>%PROGRAMDATA%\AstromKey\gateway\log</code>
|500 МБ
|-
|Файлы дампа, загруженные в АктивныйШлюз ЕдинымАгентом
|<code>%PROGRAMDATA%\AstromKey\gateway\dump</code>
|Функциональность отключена по умолчанию. При активации может принимать настраиваемый максимальный размер: по умолчанию 100 ГБ.
|-
|Каталог пакетов АктивногоШлюза для загрузки установщика автоматического обновления
|<code>%PROGRAMDATA%\AstromKey\packages</code>
|500 МБ
|-
|Исполняемые файлы расширений 1.0 и 2.0 АктивногоШлюза, библиотеки и связанные файлы
|<code>%PROGRAMFILES%\AstromKey\remotepluginmodule</code>
|350 МБ
|-
|Конфигурация расширений 1.0 и 2.0 АктивногоШлюза, журналы, кеш, рабочая область во время выполнения
|<code>%PROGRAMDATA%\AstromKey\remotepluginmodule</code>
|2 ГБ (для логов и аварийных дампов)
|-
|Каталог загрузки расширений АктивногоШлюза
|<code>%PROGRAMFILES%\AstromKey\remotepluginmodule\plugin_deployment</code>
|В зависимости от загруженных расширений
|-
|zRemote исполняемые файлы, библиотеки и связанные файлы
|<code>%PROGRAMFILES%\AstromKey\zremote</code>
|50 МБ
|-
|zRemote редактируемая пользователем постоянная конфигурация,
zРабочая область удаленного выполнения, отчеты о сбоях
|<code>%PROGRAMDATA%\AstromKey\zremote\agent</code>
|50 МБ
|-
|Логи zRemote
|<code>%PROGRAMDATA%\AstromKey\zremote\log</code>
|200 МБ
|-
|Частные синтетические исполняемые файлы, библиотеки и связанные файлы
|<code>%PROGRAMFILES%\AstromKey\synthetic</code>
|270 МБ
|-
|Приватные синтетические логи
|<code>%PROGRAMDATA%\AstromKey\synthetic\log</code>
|1 ГБ
|-
|Частные синтетические временные файлы
|<code>%PROGRAMDATA%\AstromKey\synthetic</code>
|20 ГБ, в том числе
1 ГБ для <code>/var/tmp/AstromKey/synthetic/cache</code> и

1 ГБ для <code>/var/tmp/AstromKey/synthetic/screenshots</code>
|-
|Автообновление
|<code>%PROGRAMFILES%\AstromKey\gateway</code>

Относительно параметра установки: <code><INSTALL>\gateway</code>
|Включено в оценку исполняемых файлов АктивногоШлюза
|-
|Логи автообновления
|<code>%PROGRAMDATA%\AstromKey\autoupdater\log</code>
|200 МБ
|}
===Службы===
{| class="wikitable"
|'''Название компонента'''
|'''Наименование службы'''
|'''Учетная запись пользователя'''
|'''Описание'''
|-
|АктивныйШлюз
|<code>AstromKeygateway</code>
|<code>Local Service</code>
|Основной сервис АктивногоШлюза. Присутствует для всех целей и функциональных модулей.
|-
|Автообновление АктивногоШлюза
|<code>AstromKeyautoupdater</code>
|<code>Local Service</code>
|Сервис автоматического обновления. Присутствует для всех целей и функциональных модулей АктивногоШлюза.
|-
|Расширения 1.0 (удаленный подключаемый модуль)
|<code>remotepluginmodule</code>
|<code>Local Service</code>
|Сервис для функционального модуля Extensions 1.0. Присутствует на АктивныхШлюзах, установленных для мониторинга маршрутизации. Эта служба будет активной или неактивной в зависимости от конфигурации — настройки по умолчанию см. в описании модуля.
|-
|Расширения 2.0
|<code>extensionsmodule</code>
|<code>Local Service</code>
|Сервис для функционального модуля Extensions 2.0. Присутствует на АктивныхШлюзах, установленных для мониторинга маршрутизации. Эта служба будет активной или неактивной в зависимости от конфигурации — настройки по умолчанию см. в описании модуля.
|-
|zRemote
|<code>zremote</code>
|<code>Local Service</code>
|Сервис для функционального модуля zRemote. Присутствует на АктивныхШлюзах, установленных с целью маршрутизации трафика z/OS в Ключ-Астром.
|-
|Синтетика
|<code>vuc</code>
|<code>Local Service</code>
|Сервис для Синтетического функционального модуля. Присутствует на АктивныхШлюзах, установленных для запуска синтетических мониторов из частной локации.
|}
===Использование портов===
По умолчанию АктивныйШлюз:
*получает соединения от ЕдиныхАгентов или других АктивныхШлюзов через порт 9999
*получает API Ключ-Астром на порт 9999
*подключается к SaaS или Managed-кластеру через порт 443

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

=== Синтаксис команды установки ===
<code>AstromKey-ActiveGate-Windows-x86-<version>.exe [<parameter1>=<value1>] [<parameter2>=<value2>] ...</code>
Пробелы между именем параметра и значением параметра (вокруг знака <code>=</code>) не допускаются в синтаксисе команды.

=== Конфигурация прокси ===
Конфигурация прокси должна быть указана в следующем формате. Это позволит настроить прокси АктивногоШлюза для всех исходящих соединений (в разделе конфигурации <code>http.client</code>):
<code>PROXY=<схема_прокси><пользователь>:<пароль>@<сервер>:<порт></code>
Где:

* Все компоненты необязательны, кроме <code><server></code>.
* Если не указаны ни <code><пользователь></code>, ни <code><пароль></code>, то символ @ следует опустить.
* <code><пароль></code> можно указать, только если указано имя пользователя.
* ':' после <code><user></code> можно указать, даже если часть пароля пуста.
* <code><схема_прокси></code> не является обязательной и может быть <code>"http://"</code> или <code>"https://"</code>.
* <code><пользователь></code> является необязательным.
* <code><server></code> может быть IP-адресом или DNS-именем, но не путем. Например, если указано «1.2.3.4/textaferslash», будет извлечена только часть IP («1.2.3.4»). Косая черта и следующий за ней текст будут игнорироваться.
* <code><порт></code> является необязательным.

=== Конфигурация обратного прокси (балансировщика нагрузки) ===
На пути от АктивногоШлюза до Кластера можно разместить обратный прокси-сервер или балансировщик нагрузки. Это позволяет вашему АктивномуШлюзу подключаться к любому доступному узлу кластера, распределяя нагрузку между узлами.

Для этого вам необходимо:

* Указать адрес обратного прокси-сервера/балансировщика нагрузки.
* Убедитесь, что АктивныйШлюзбудет игнорировать любую дополнительную информацию о целевом адресе, отправленную из кластера, и, таким образом, будет подключаться только к указанному вами адресу.

Такие параметры конфигурации можно указать во время установки АктивногоШлюза, задав следующие параметры командной строки программе установки:
<code>IGNORE_CLUSTER_RUNTIME_INFO=true SERVER=<адрес_обратного_прокси></code>
Кроме того, вы можете настроить АктивныйШлюз после установки, внеся изменения в конфигурацию АктивногоШлюза.

=== Каталог установки ===
Абсолютный путь к каталогу установки можно указать либо в пользовательском интерфейсе установщика, либо в командной строке (версия АктивногоШлюза 1.232+). Эта папка будет использоваться для установки исполняемых файлов и библиотек АктивногоШлюза.
<code>C:\AstromKey-ActiveGate-Windows-x86-1.0.0.exe INSTALL=D:\hosted_app\AstromKey</code>
Сохраняет установочные файлы в указанном каталоге. Значение по умолчанию для этого параметра (если оно не указано) — <code>/opt/AstromKey</code>. Этот параметр не разрешен во время обновления.

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

Таким образом вы можете указать прокси-сертификат ЦС (сертификат, который будет использоваться при подключении АктивногоШлюза к кластеру). Это позволяет установить соединение с кластером во время установки, позволяя программе установки АктивногоШлюза загрузить и установить любые необходимые дополнительные возможности.

Пароль сертификата указывается в виде файла, из которого считывается пароль.

Абсолютный путь к расположению настраиваемых доверенных корневых сертификатов для добавления:
<code>CA_CERTIFICATE_FILE=<path></code>
Абсолютный путь к местоположению файла, содержащего пароль сертификата:
<code>CA_CERTIFICATE_PASSWORD_FILE=<path></code>
Пример команды:mple:
<code>C:\AstromKey-ActiveGate-Windows-x86-<version>.exe CA_CERTIFICATE_FILE=D:\Users\Fred\myCert.jks CA_CERTIFICATE_PASSWORD_FILE=D:\Users\Fred\myPwd.txt</code>

=== Пользовательский SSL-сертификат ===
Во время установки вы можете указать сертификат аутентификации, который АктивныйШлюз предоставляет подключающимся клиентам, ЕдинымАгентам или подключениям из браузерных клиентов. Если такие сертификаты требуются, это уменьшает усилия по настройке после установки.

Пароль сертификата указывается в виде файла, из которого считывается пароль.

Абсолютный путь к местоположению сертификата аутентификации, который АктивныйШлюз предоставляет подключающимся клиентам, ЕдинымАгентам, или подключениям из браузерных клиентов (таких как RUM JavaScript):
<code>CERTIFICATE_FILE=<path></code>
Абсолютный путь к местоположению файла, содержащего пароль сертификата, для сертификата аутентификации, который АктивныйШлюз предоставляет подключающимся клиентам:
<code>CERTIFICATE_PASSWORD_FILE=<path></code>
Пример команды:
<code>C:\AstromKey-ActiveGate-Windows-x86-<version>.exe CERTIFICATE_FILE=D:\Users\Fred\myCert.jks CERTIFICATE_PASSWORD_FILE=D:\Users\Fred\myPwd.txt</code>

=== Сетевая зона ===
<code>--set-network-zone=<name></code>
Определяет сетевую зону, к которой принадлежит АктивныйШлюз. Он может принадлежать только одной сетевой зоне. Имя сетевой зоны представляет собой строку буквенно-цифровых символов, дефисов <code>(-)</code>, знаков подчеркивания <code>(_)</code> и точек <code>(.)</code>. Точки используются в качестве разделителей, поэтому вы не должны использовать точку в качестве первого символа имени сетевой зоны. Длина строки ограничена 256 символами.

Этот параметр не разрешен во время обновления.

=== Группа ===
<code>--set-group=<name></code>
Определяет группу АктивныхШлюзов, к которой принадлежит АктивныйШлюз. АктивныйШлюз может принадлежать только одной группе. Имя группы АктивныхШлюзов представляет собой строку буквенно-цифровых символов, дефисов (-), знаков подчеркивания (_) и точек (.). Точки используются в качестве разделителей, поэтому вы не должны использовать точку в качестве первого символа имени группы. Длина строки ограничена 256 символами. Вы можете использовать группы АктивныхШлюзов для выполнения массовых действий на ваших АктивныхШлюзах, таких как управление расширениями 2.0, работающими на АктивныхШлюзах.

Этот параметр не разрешен во время обновления.

=== Время соединения ===
<code>ASTROMKEY_ACTIVEGATE_SERVER_CONNECTION_TIMEOUT=<seconds></code>
Определяет максимальное количество секунд (по умолчанию: <code>120</code>), в течение которых программа установки будет ожидать подключения к кластеру. В развертываниях Linux этот параметр необходимо использовать как переменную среды.

Время ожидания соединения, указанное в переменной среды <code>ASTROMKEY_ACTIVEGATE_SERVER_CONNECTION_TIMEOUT=<секунды></code>, используется на двух этапах установки:

* При загрузке дополнительных (необязательных) возможностей.
* При ожидании соединения с кластером в конце установки АктивныхШлюзов: это соединение затем используется АктивнымШлюзом во время его нормальной работы.

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

Чтобы проверить успешность установки и подключения, войдите в AstromKey, в разделе '''Настройки''' выберите '''Статус развертывания''', а затем перейдите на вкладку '''АктивныеШлюзы'''.

Направление трафика ЕдиногоАгента

2022-09-28T16:20:46Z

RGolovanov:

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

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

=== Маршрутизация сообщений (модуль Routing) ===

==== Маршрутизация сообщений ====
АктивныйШлюз знает о структуре времени выполнения вашей среды и направляет сообщения от экземпляров ЕдиныхАгентов к нужным конечным точкам сервера.

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

==== Аутентификация ====
АктивныйШлюз аутентифицирует запросы ЕдиныхАгентов (подтверждение SSL и аутентификация по идентификатору среды).

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

=== Дампы памяти (модуль Memory Dumps) ===
Дампы памяти поступают от ЕдиныхАгентов и, таким образом, могут рассматриваться как часть функции маршрутизации АктивныхШлюзов.

==== Дампы памяти ====
Ключ-Астром поддерживает как автоматический, так и ручной захват и анализ дампов памяти на контролируемых хостах. Дампы памяти необходимо хранить в централизованном месте для загрузки и анализа. Поскольку такие дампы часто бывают большими и могут содержать конфиденциальные данные, Ключ-Астром не позволяет загружать дампы в кластер в облаке. Вместо этого вы должны установить АктивныйШлюз и настроить его так, чтобы он служил хостом для дампов памяти. Пользовательский интерфейс Ключ-Астром предоставляет вам URL-адреса загрузки для REST API АктивныхШлюзов, который обслуживает дампы.

== Мониторинг облачных сред и удаленных технологий ==

==== AWS-мониторинг (модуль AWS) ====
Мониторинг сервисов AWS — ресурсоемкая задача. Поэтому для мониторинга более 2000 ресурсов AWS необходимо установить АктивныйШлюз и настроить мониторинг AWS.

==== Мониторинг Cloud Foundry (модуль Cloud Foundry) ====
Чтобы подключить свои фонды Cloud Foundry к Ключу-Астром, вам необходимо установить АктивныйШлюз, чтобы дополнить метрики Cloud Foundry на уровне процессов и хостов, собранные ЕдинымиАгентами, дополнительными метаданными и метриками, полученными из Cloud Foundry API. Эта интеграция позволяет вам использовать обзорную страницу Cloud Foundry, а также автоматическое обнаружение ваших организаций Cloud Foundry в дополнение к другим свойствам процесса Cloud Foundry, таким как <code>пространство</code>, <code>идентификатор пространства</code>, <code>приложение</code>, <code>идентификатор приложени</code>я и <code>индекс экземпляра</code>.

==== Мониторинг Kubernetes/OpenShift (модуль Kubernetes) ====
Чтобы подключить кластеры Kubernetes/OpenShift к Ключу-Астром и воспользоваться преимуществами специальной страницы обзора Kubernetes/OpenShift, вам необходимо запустить Активный Шлюз версии 1.163+ в своей среде.

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

==== Мониторинг с помощью расширения АктивногоШлюза (модули Расширения 1.0, Расширения 2.0) ====
С расширениями АктивныхШлюзов вы можете распространить мониторинг на любую удаленную технологию, предоставляющую интерфейс, где установка ЕдиныхАгентов невозможна. Например, технологии PaaS, сетевые устройства или облачные технологии. Расширения АктивныхШлюзов (также известные как удаленные плагины) выполняются на АктивныхШлюзах и могут получать метрики и информацию о топологии из удаленных источников, тем самым полностью интегрируя удаленный мониторинг технологий в Ключ-Астром Smartscape и обнаружение проблем. В настоящее время эта возможность предлагается только в АктивныхШлюзах Окружения.

==== Информация о базе данных Oracle (модуль Анализ Базы Данных) ====
Инсайты по базам данных добавляют взгляд на инфраструктуру к мониторингу вашей базы данных. С помощью дополнительных данных, получаемых с уровня базы данных, вы можете решить проблемы с производительностью, глубоко укоренившиеся в базе данных.

==== Мониторинг виртуализированной инфраструктуры (модуль VMware) ====
АктивныйШлюз может опросить ваш vCenter или автономные хосты ESXi, чтобы получить информацию обо всех важных ресурсах, которые серверы ESXi предоставляют вашим виртуальным машинам (например, об использовании ЦП, потреблении памяти и действиях, связанных с хранилищем данных, на вашей платформе VMware). Чтобы получить эту информацию, Ключу-Астром необходим компонент, установленный в вашей среде, который имеет доступ к vCenter API.

== API Ключ-Астром ==
АктивныйШлюз предоставляет конечные точки для доступа к API Ключ-Астром. Перечисленные ниже типы вызовов API обрабатываются или предварительно обрабатываются в АктивномШлюзе до включения кластера. Другие вызовы API перенаправляются непосредственно в кластер.

АктивныйШлюз поддерживает вызовы ко всем конечным точкам версий v1 и v2 API-интерфейсов конфигурации и среды.

==== Мониторинг Логов (модуль Мониторинг Логов) ====
Используя Мониторинг Логов как часть платформы Ключ-Астром, вы получаете прямой доступ к содержимому журналов всех ваших критически важных процессов. Вы можете создавать собственные метрики журнала для более эффективного и быстрого устранения неполадок. Вы сможете понимать данные журналов в контексте всего стека, включая реальное влияние пользователей.

==== Прием метрик (модуль API HTTP-метрик) ====
Прием метрик предоставляет вам простой способ передать любые пользовательские метрики в Ключ-Астром. Вы можете дополнительно уточнить свои показатели по категориям.

==== Прием трассировки OpenTelemetry (модуль OTLP Ingest) ====
Вы можете отправлять данные трассировки OpenTelemetry (трассы и интервалы) в формате OTLP в Ключ-Астром через API, доступный на АктивномШлюзе. Полученные диапазоны интегрируются в распределенные трассировки PurePath®.

==== Real User Monitoring (модуль Beacon Forwarder) ====
Инфраструктура Ключ-Астром может использоваться в качестве конечной точки маяка по умолчанию для безагентного мониторинга ваших приложений. Автоматически внедряемые приложения отправляют маяк обратно на веб-сервер клиента, минуя необходимость в стороннем домене. Однако при необходимости такие приложения также могут использовать инфраструктуру в качестве конечной точки для сигналов мониторинга RUM.