Открыть меню
Открыть персональное меню
Вы не представились системе
Your IP address will be publicly visible if you make any edits.

Отправка событий развертывания из Jenkins

Материал из Документация АппОптима

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

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

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

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

  • В поле 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» , чтобы просмотреть все поля конфигурации.

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тексте запроса.