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

Материал из Документация Ключ-АСТРОМ
 
(не показаны 2 промежуточные версии этого же участника)
Строка 1: Строка 1:
'''''[[API Ключ-АСТРОМ]] / [[API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндпойнты среды]] / [[API Ключ-АСТРОМ#.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|Развёртывание]] / События v1 / Отправка событий развертывания из Jenkins'''''
Чтобы настроить Jenkins для отправки событий развертывания в Ключ-АСТРОМ.
Чтобы настроить Jenkins для отправки событий развертывания в Ключ-АСТРОМ.


* Создайте новый токен доступа для Ключ-АСТРОМ API .
* Создайте новый токен доступа для Ключ-АСТРОМ API .
* Установите подключаемый модуль HTTP-запроса в вашу установку Jenkins.
* Установите подключаемый модуль HTTP-запроса в вашу установку Jenkins.
* В конфигурации сборки Jenkins нажмите '''Добавить шаг сборки''' и выберите '''HTTP Request''' .
* В конфигурации сборки Jenkins нажмите '''Add build step''' и выберите '''HTTP Request''' .
[[Файл:Jenkins-build-addbuildstep-httprequest-2-333-fec9e1de4a.png]]
[[Файл:Jenkins-build-addbuildstep-httprequest-2-333-fec9e1de4a.png]]
* В поле '''URL''' введите URL-адрес конечной точки API вашего события:
* В поле '''URL''' введите URL-адрес конечной точки API вашего события:
** Managed <nowiki>https://{ваш-домен}/e/{идентификатор-вашей-среды}/api/v1/events/</nowiki>
** Managed <nowiki>https://{ваш-домен}/e/{идентификатор-вашей-среды}/api/v1/events/</nowiki>
** SaaS <nowiki>https://{идентификатор_вашей_среды}.live.dynatrace.com/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''' .
* Выберите '''POST''' в качестве режима '''HTTP''' .
* Нажмите '''« Дополнительно»''' , чтобы просмотреть все поля конфигурации.
* Нажмите '''«Advanced»''' , чтобы просмотреть все поля конфигурации.
 
[[Файл:Jenkins-httprequest-1433-c9422103f1.png]]
* В разделе Заголовки выберите APPLICATION_JSON в поле Принять .
* В разделе '''Headers''' выберите '''APPLICATION_JSON''' в поле '''Accept''' .
* Выберите APPLICATION_JSON в поле Content-type .
* Выберите '''APPLICATION_JSON''' в поле '''Content-type''' .
* Добавьте пользовательский заголовок , введите Authorization в поле Header и Api-Token {token} в поле Value .
* Добавьте '''Custom header''' , введите '''Authorization''' в поле '''Header''' и '''Api-Token {token}''' в поле '''Value''' .
 
[[Файл:Jenkins-headers-1417-ef4687d080.png]]
* Скопируйте и при необходимости адаптируйте следующую полезную нагрузку в поле Тело запроса . Дополнительные сведения о полях полезной нагрузки см . в разделе События POST .
* Скопируйте и при необходимости адаптируйте следующую полезную нагрузку в поле '''Request body''' . Дополнительные сведения о полях полезной нагрузки см . в разделе '''POST events'''.


  <code>{
  <code>{

Текущая версия на 17:06, 6 июня 2024

API Ключ-АСТРОМ / Эндпойнты среды / Развёртывание / События v1 / Отправка событий развертывания из Jenkins

Чтобы настроить Jenkins для отправки событий развертывания в Ключ-АСТРОМ.

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

Jenkins-build-addbuildstep-httprequest-2-333-fec9e1de4a.png

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

Jenkins-httprequest-1433-c9422103f1.png

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

Jenkins-headers-1417-ef4687d080.png

  • Скопируйте и при необходимости адаптируйте следующую полезную нагрузку в поле 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тексте запроса.
Источник — https://doc.ruscomtech.ru/index.php?title=Отправка_событий_развертывания_из_Jenkins&oldid=3652