Отправка событий развертывания из Jenkins: различия между версиями

Текущая версия от 14:15, 24 декабря 2024

API АппОптима / Эндпойнты среды / Развёртывание / События v1 / Отправка событий развертывания из Jenkins

Чтобы настроить Jenkins для отправки событий развертывания в АппОптима.

Создайте новый токен доступа для АппОптима API .
Установите подключаемый модуль HTTP-запроса в вашу установку Jenkins.
В конфигурации сборки Jenkins нажмите Add build step и выберите HTTP Request .

В поле URL введите URL-адрес конечной точки API вашего события:
- АппОптима https://{ваш-домен}/e/{идентификатор-вашей-среды}/api/v1/events/
- SaaS https://{идентификатор_вашей_среды}.live.ruscomtech.ru/api/v1/events/
- Cреда АктивногоШлюза https://{ваш-активный-домен}/e/{идентификатор-вашей-среды}/api/v1/events
Выберите POST в качестве режима HTTP .
Нажмите «Advanced» , чтобы просмотреть все поля конфигурации.

В разделе Headers выберите APPLICATION_JSON в поле Accept .
Выберите APPLICATION_JSON в поле Content-type .
Добавьте Custom header , введите Authorization в поле Header и Api-Token {token} в поле Value .

Скопируйте и при необходимости адаптируйте следующую полезную нагрузку в поле Request body . Дополнительные сведения о полях полезной нагрузки см . в разделе POST events.

<{
  "eventType": "CUSTOM_DEPLOYMENT",
  "attachRules": {
    "tagRule" : {
        "meTypes" : "PROCESS_GROUP_INSTANCE",
        "tags" : "Dev"
    }
  },
  "deploymentName":"${JOB_NAME}",
  "deploymentVersion":"1.1",
  "deploymentProject":"CustomBankingService",
  "remediationAction":"http://revertMe",
  "ciBackLink":"${BUILD_URL}",
  "source":"Jenkins",
  "customProperties":{
    "Jenkins Build Number": "${BUILD_ID}",
    "Git commit": "${GIT_COMMIT}"
  }
}

${JOB_NAME}, ${BUILD_URL}, ${BUILD_ID}, ${GIT_COMMIT}— это переменные среды, устанавливаемые Jenkins во время выполнения задания.

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

@@ Строка 1: / Строка 1: @@
-Чтобы настроить Jenkins для отправки событий развертывания в Ключ-АСТРОМ.
+'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%A2%D0%B0%D1%80%D0%B1%D0%BE%D0%BB%D0%BB%D1%8B%20%D0%BE%D1%80%D0%BA%D0%B5%D1%81%D1%82%D1%80%D0%BE%D0%B2%D0%BA%D0%B8-,%D0%A1%D0%BE%D0%B1%D1%8B%D1%82%D0%B8%D1%8F%20v1,-GET%20%D0%BB%D0%B5%D0%BD%D1%82%D1%8B%20%D1%81%D0%BE%D0%B1%D1%8B%D1%82%D0%B8%D0%B9 События v1] / Отправка событий развертывания из Jenkins'''''
-* Создайте новый токен доступа для Ключ-АСТРОМ API .
+Чтобы настроить Jenkins для отправки событий развертывания в АппОптима.
+* Создайте новый токен доступа для АппОптима API .
 * Установите подключаемый модуль HTTP-запроса в вашу установку Jenkins.
 * В конфигурации сборки Jenkins нажмите '''Add build step''' и выберите '''HTTP Request''' .
 [[Файл:Jenkins-build-addbuildstep-httprequest-2-333-fec9e1de4a.png]]
 * В поле '''URL''' введите URL-адрес конечной точки API вашего события:
-** Managed <nowiki>https://{ваш-домен}/e/{идентификатор-вашей-среды}/api/v1/events/</nowiki>
+** АппОптима <nowiki>https://{ваш-домен}/e/{идентификатор-вашей-среды}/api/v1/events/</nowiki>
 ** SaaS <nowiki>https://{идентификатор_вашей_среды}.live.ruscomtech.ru/api/v1/events/</nowiki>
-** Окружающая среда АктивногоШлюза <nowiki>https://{ваш-активный-домен}/e/{идентификатор-вашей-среды}/api/v1/events</nowiki>
+** Cреда АктивногоШлюза <nowiki>https://{ваш-активный-домен}/e/{идентификатор-вашей-среды}/api/v1/events</nowiki>
 * Выберите '''POST''' в качестве режима '''HTTP''' .
 * Нажмите '''«Advanced»''' , чтобы просмотреть все поля конфигурации.
-[[Файл:Jenkins-httprequest-1433-c9422103f1.png]]
+[[Файл:Jenkins-httprequest-1433-c9422103f1.png|1248x1248пкс]]
 * В разделе '''Headers''' выберите '''APPLICATION_JSON''' в поле '''Accept''' .
 * Выберите '''APPLICATION_JSON''' в поле '''Content-type''' .
 * Добавьте '''Custom header''' , введите '''Authorization''' в поле '''Header''' и '''Api-Token {token}''' в поле '''Value''' .
-[[Файл:Jenkins-headers-1417-ef4687d080.png]]
+[[Файл:Jenkins-headers-1417-ef4687d080.png|1270x1270пкс]]
 * Скопируйте и при необходимости адаптируйте следующую полезную нагрузку в поле '''Request body''' . Дополнительные сведения о полях полезной нагрузки см . в разделе  '''POST events'''.
-  <code>{
+  <{
     "eventType": "CUSTOM_DEPLOYMENT",
     "attachRules": {
@@ Строка 36: / Строка 38: @@
       "Git commit": "${GIT_COMMIT}"
     }
-  }</code>
+  }
 <code>${JOB_NAME}</code>, <code>${BUILD_URL}</code>, <code>${BUILD_ID}</code>, <code>${GIT_COMMIT}</code>— это переменные среды, устанавливаемые Jenkins во время выполнения задания.
 * Сохраните конфигурацию сборки. В следующий раз, когда вы создадите свой проект, событие развертывания будет отправлено отслеживаемым объектам (например, узлам и службам), которые вы определили в <code>tagRule</code>тексте запроса.