Создание задач Jira из оповещений
Когда Jira подключена, оператор одним щелчком превращает оповещение или замечание по безопасности в задачу Jira. Задача заполняется всем, что известно Excubius, ее ключ сохраняется в оповещении, а ее статус отслеживается до завершения. В этом руководстве показано, как подключить Jira Cloud, как направить задачи каждого клиента в его собственный проект и что содержит задача.
Перед началом работы
- Сайт Jira Cloud. Jira Server и Data Center не поддерживаются.
- Учетная запись Atlassian для Excubius со следующими разрешениями в целевых проектах: Browse projects, Create issues, Add comments и Link issues. Права администрирования не нужны: Excubius никогда не переводит задачи в другие статусы, не изменяет и не удаляет их.
- Функция
collab.jiraвключена в разделе Settings › Instance. Ей требуетсяcollab.assign. Включает ее суперадминистратор. - Чтобы задать значения по умолчанию для всего сервера, вам нужен доступ к конфигурации сервера. Чтобы задать собственные параметры Jira для сущности, вам нужна роль Entity admin (администратор сущности) в ней.
В этом выпуске в консоли нет экрана параметров Jira: значения по умолчанию задаются в конфигурации сервера, а параметры отдельных сущностей — через API.
Выбор способа входа Excubius в Jira
auth | Учетные данные | Когда использовать |
|---|---|---|
token (по умолчанию) | Адрес электронной почты учетной записи и токен API | Обычный случай: выделенная учетная запись Atlassian с токеном API |
oauth | Идентификатор клиента и секрет клиента служебной учетной записи Atlassian, а также облачный идентификатор сайта | Ваша организация использует служебные учетные записи Atlassian с учетными данными клиента OAuth 2.0. В этом случае API доступен по адресу https://api.atlassian.com/ex/jira/<cloud_id> |
bearer | Токен, отправляемый как есть | Личный маркер доступа за шлюзом |
Облачный идентификатор сайта можно найти по адресу https://<site>.atlassian.net/_edge/tenant_info.
Настройка значений по умолчанию на сервере
Значения по умолчанию применяются ко всем сущностям, которые не задают собственные.
-
Подключитесь к серверу и переключитесь на учетную запись службы командой
sudo -iu excubius. -
Добавьте параметры в
/opt/excubius/.env. Для проверки подлинностиtokenпо умолчанию:JIRA_BASE_URL=https://areito.atlassian.netJIRA_EMAIL=monitoring@areito.exampleJIRA_API_TOKEN=<API token>JIRA_DEFAULT_PROJECT=OPSJIRA_ISSUE_TYPE=TaskДля
oauthвместо адреса электронной почты и токена API задайтеJIRA_AUTH=oauth,JIRA_OAUTH_CLIENT_ID,JIRA_OAUTH_CLIENT_SECRETиJIRA_CLOUD_ID. -
Перезапустите платформу:
export XDG_RUNTIME_DIR=/run/user/$(id -u)systemctl --user restart excubius.service
Отправка задач клиента в его собственный проект
Каждая сущность может задать для себя любые ключи Jira. Параметр наследуется вниз по дереву поключево: побеждает ближайшая сущность, которая задает ключ. Поэтому один сайт Jira может обслуживать всех клиентов, у каждого из которых свой проект и свои учетные данные.
-
Сохраните учетные данные Jira в сущности: откройте Settings › Credentials, выберите сущность, например ООО «Лукоморье», и добавьте учетные данные типа HTTP user and password (адрес электронной почты и токен API или идентификатор и секрет клиента OAuth) или Bearer token. Секрет хранится в зашифрованном виде и больше никогда не отображается.
-
Задайте ключи сущности через API.
$BASE— этоhttps://<your server>/api/v1, аHсодержит ваш токен, как в разделе Краткое руководство. Добавление экземпляра SQL Server с помощью API:curl -s "${H[@]}" -X PUT "$BASE/entities/$CIGUAPA/jira" -d '{"project_key": "CIG", "issue_type": "Task","credential_id": "'"$JIRA_CRED"'", "labels": ["monitoring"]}' -
Проверьте, что применяется и откуда берется каждый ключ. Ответ показывает, настроена ли сущность (
configured), а если нет — чего не хватает (problem):curl -s "${H[@]}" "$BASE/entities/$CIGUAPA/jira" | jq '{configured, problem, effective, sources}' -
Проверьте подключение. Проверка только читает данные: кем являются учетные данные в Jira, проект и его типы задач.
curl -s "${H[@]}" -X POST "$BASE/entities/$CIGUAPA/jira/test"
Чтобы вернуть ключу унаследованное значение, отправьте его как null. DELETE /entities/{id}/jira удаляет все собственные ключи сущности.
| Ключ | По умолчанию | Значение |
|---|---|---|
base_url | JIRA_BASE_URL | https://<site>.atlassian.net |
auth | JIRA_AUTH, а если не задано — token | token, oauth или bearer |
credential_id | Адрес электронной почты и токен или клиент OAuth из конфигурации сервера | Учетные данные этой сущности или ее предка: HTTP user and password для token и oauth, Bearer token для bearer |
cloud_id | JIRA_CLOUD_ID | Только для oauth |
project_key | JIRA_DEFAULT_PROJECT | Куда поступают задачи, например OPS |
issue_type | JIRA_ISSUE_TYPE, а если не задано — Task | Имя типа задачи в этом проекте |
priority_map | critical → High, warning → Medium, info → Low | Сопоставление серьезности с именем приоритета Jira |
labels | Нет | Дополнительные метки без пробелов |
summary_prefix | Название продукта в квадратных скобках | Текст перед кратким описанием; пустой текст — без префикса |
sync | true | Отслеживать статус задачи |
done_comment | true | Добавлять в задачу комментарий после ее завершения с указанием, обнаруживается ли условие по-прежнему |
resolve_events_on_done | true | Разрешать оповещения о событиях, например об изменении состава привилегированной группы, когда их задача завершена |
Создание задачи
- В Alert inbox выберите оповещение. Замечание по безопасности откройте на странице Security posture.
- Нажмите Create Jira ticket. Вам нужна роль Operator (оператор) или выше.
Excubius подтверждает создание сообщением Jira ticket OPS-123 created и сохраняет ключ в оповещении, где его видят все. Для оповещения создается не больше одной задачи: повторный запрос возвращает существующий ключ.
Задача содержит:
- Summary (краткое описание): префикс, заголовок оповещения и ресурс.
- Description (описание): серьезность, категория и состояние; время первого и последнего обнаружения; ресурс с путем его сущности, критичностью, тегами и идентифицирующими сведениями, например узлом, версией и группой доступности; значение проверки в сравнении с пороговым значением и место, где это пороговое значение задано; для замечания — его доказательства; ссылка на базовый уровень; последние десять событий временной шкалы; предлагаемое действие с пометкой, что это предложение; ссылки обратно на оповещение и ресурс.
- Labels (метки): название продукта, категория (
alert,finding,advisory), серьезность и ваши дополнительные метки. - Priority (приоритет): определяется по серьезности через
priority_map. Если проект не принимает приоритет, задача создается без него. - Ссылка в задаче обратно на оповещение.
Отслеживание статуса задачи
Каждые 10 минут Excubius читает статус не более чем 100 открытых задач, начиная с тех, что проверялись давнее всего. Интервал меняется параметром JIRA_SYNC_MINUTES. Когда задача переходит в статус категории Done:
- Это записывается во временную шкалу оповещения.
- Оповещение о событии, например об изменении состава
sysadmin, разрешается: изменение проверено. - Другие оповещения задача не разрешает. Они разрешаются, когда следующая проверка больше не обнаруживает условие, а комментарий в задаче сообщает, обнаруживается ли оно по-прежнему.
Просроченный токен или удаленная задача записываются, и попытка повторяется при следующей синхронизации. После завершения задача больше не отслеживается.
Ограничения
- Статус опрашивается; веб-перехватчики Jira, обращающиеся к Excubius, пока не используются.
- OAuth 2.0 — это поток учетных данных клиента для служебной учетной записи Atlassian. OAuth от имени отдельных пользователей не поддерживается.
- Jira Server и Data Center не поддерживаются.