Skip to content

Instantly share code, notes, and snippets.

@gseok

gseok/2019-10-01_Jenkins_Abort.md

Last active October 1, 2019 23:33
Show Gist options
  • Save gseok/3b6ac01a1c356ec5125fda1ef65d2bc1 to your computer and use it in GitHub Desktop.
Save gseok/3b6ac01a1c356ec5125fda1ef65d2bc1 to your computer and use it in GitHub Desktop.
Download ZIP
Jenkins Cancel(Abort) 처리
Raw
2019-10-01_Jenkins_Abort.md

Jenkins Abort

소개

약간 시대에 뒤떨어지는 UI/UX & 사용법으로, 사용자들이 많이 이탈하였지만, 아직도 Top20 등으로 CI/CD Tool검색시 항상 포함되는 정통의 강자가 Jenkins 이다. 여기서는, Jenkins의 Abort(Cancel) action에 대한 후처리(post control or after control)를 별도의 plugin설치 없이 simple하게 하는 방법에 대하여 설명한다.

why needed?

  • 현재 프로젝트에서, 서버로 API를 쏘는 CLI을 사용중인데, Jenkins에서 Cancel하여도, 실제 Build or Deploy동작은 Cancel되지 않는 문제가 있음.
  • 해결방법으로, Jenkins에서 Cancel하면, 해당 동작을 감지하여 서버에 Cancel API을 호출하여 실제 Build or Deploy동작을 Cancel처리 하고자 함.

pre required knowledge

Jenkins 관련

Kubernetes 관련

  • Kubectl CLI
    • 쿠버네티스를 컨트롤 할수 있는 CLI Tool
    • kubectl 명령어로 Kubernetes Cluster와 상호 작용 할 수 있다.
    • kubectl은 실질적으로는 Kubernetes의 API를 사용한다.

problem

  • jenkins의 build step에서 kubernetes의 helm등을 수행했을때, 사용자가 jenkins job을 cancel(abort) 한경우, jenins job은 stop되지만, helm run은 cancel되지 않는 문제가 있음
  • 원인은 위 기본 개념에서 말했듯, 실질적으로 kubectl command가 api call이기때문에, 명령어가 kubernetes cluster에 들어가고 나서 취소 명령어가 들어오기 전까지는 계속 수행이 되고 있기 때문임

solution

  • jenkins의 cancel동작시 해당 동작을 감지하고, any action을 할 수 있게 하면 됨

Jenkins Abort Action

  • jenkins에서 cancel을 누르면, TERM 시그널을 현재 Job의 process group에 발생시킨다.
  • 이후 해당 job에서 수행(spawns)한 subprocess는 모두 TERM이 되고, "Finished: ABORTED" 메시지를 출력하면서, jenkins의 job 수행이 stop된다.

TERM Signal Handle

  • singal은 unix계열의 운영체제에서, IPC용도 혹은, process control을 위해 만들어진 async한 event(signal)이다.
  • unix계열의 운영체제에서는 이러한 signal을 핸들링 할수 있는 C함수(System Call API) 및 CLI command(user command)명령어을 제공한다.
  • signal 핸들링 명령어중 trap은 시그널 발생을 감지하여, command을 실행하는게 가능한 명령어 이다.

Jenkins에서 Abort감지해서 사용자정의 동작하게 하기

  • 위 내용들을 조합하여 아래와 같은 간략한 script을 통해서, jenkins의 abort을 감지하고, 감지이후 사용자정의 동작을 구현 할 수 있다.
#!/bin/bash

getAbort () {
 echo "--- Abort detected ---"
 # other commands here if any...
}
trap 'getAbort; exit' SIGHUP SIGINT SIGTERM

# 테스트를 위해 어떤 동작이 이루어 지고 있다고 가정
for i in {1..30}
do
   echo "Test - $i"
   sleep 1

   # 에러코드로 종료시 abort안들어가고 failed 종료됨 확인
   #if [ $i -eq 10 ]
   #then
   #  exit 1
   #fi

   # npm install에러 발생해봄, abort로 안들어오는것 확인
   #if [ $i -eq 10 ]
   #then
   #  npm install gseok
   #fi
done

# 특이하게도, jenkins의 Execute shell step에서 trap 명령어 하위에, 또다른 명령어 하나가 있어야 정상 동작하는 경우가 있음. 간단히 print하는걸 넣어주면됨.
echo "done"
  • 위와같은 상황에서, Jenkins UI상에서 Cancel수행시 정상적으로, abort을 감지하여 getAbort함수가 수행되는것을 확인 할 수 있다.

refrence

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment