Update at 31 Jul, 2019
Jenkins Pipeline 을 구성하기 위해 VM 환경에서 Jenkins와 관련 Echo System을 구성합니다. 각 Product의 버전은 문서를 작성하는 시점에서의 최신 버전을 위주로 다운로드 및 설치되었습니다. 구성 기반 환경 및 버전은 필요에 따라 변경 가능합니다.
| Category | Name | Version |
|---|---|---|
| VM | VirtualBox | 6.0.10 |
| OS | Red Hat Enterprise Linux | 8.0.0 |
| JDK | Red Hat OpenJDK | 1.8.222 |
| Jenkins | Jenkins rpm | 2.176.2 |
프로젝트는 Job의 일부 입니다. 즉, 모든 프로젝트가 Job이지만 모든 Job이 프로젝트는 아닙니다. Job의 구조는 다음과 같습니다.
FreeStyleProejct, MatrixProject, ExternalJob만 New job에 표시됩니다.
Step 1에서는 stage없이 기본 Pipeline을 실행하여 수행 테스트를 합니다.
Jenkins 로그인
좌측 새로운 Item 클릭
Enter an item name에 Job 이름 설정 (e.g. 2.Jobs)
Pipeline 선택 후 OK 버튼 클릭
Pipeline 항목 오른 쪽 Try sample Pipelie...클릭하여 Hello world 클릭 후 저장
node {
echo 'Hello World'
}
좌측 Build now클릭
좌측 Build History의 최근 빌드된 항목(e.g. #1) 우측에 마우스를 가져가면 dropdown 버튼이 생깁니다. 해당 버튼을 클릭하여 Console Output 클릭
수행된 echo 동작 출력을 확인합니다.
Started by user GyuSeok.Lee
Running in Durability level: MAX_SURVIVABILITY
[Pipeline] Start of Pipeline
[Pipeline] node
Running on Jenkins in /var/lib/jenkins/workspace/2.Jobs
[Pipeline] {
[Pipeline] echo
Hello World
[Pipeline] }
[Pipeline] // node
[Pipeline] End of Pipeline
Finished: SUCCESS
Pipeline이 수행되는 동작을 추적하는 과정을 확인합니다. 이를 이를 위한 Pipeline 타입의 Item을 추가로 생성합니다. (e.g. 03-01.TrackingBuildState)
Pipeline에 다음과 같이 스크립트를 추가합니다.
pipeline {
agent any
stages {
stage('Deploy') {
steps {
timeout(time: 1, unit: 'MINUTES') {
sh 'for n in `seq 1 10`; do echo $n; sleep 1; done'
}
timeout(time: 1, unit: 'MINUTES') {
sh 'for n in `seq 1 50`; do echo $n; sleep 1; done'
}
}
}
}
}
빌드를 수행하기 위한 Worker로 다중 Jenkins를 컨트롤 할 수 있습니다. 이때 명령을 수행하는 Jenkins는 Master, 빌드를 수행하는 Jenkins는 Worker로 구분합니다. 여기서는 Worker의 연결을 원격 호스트의 Jenkins를 SSH를 통해 연결하는 방식과 컨테이너로 구성된 Jenkins를 연결하는 과정을 확인 합니다.
Master-Slave 방식, 또는 Master-Agent 방식으로 표현합니다.
팁
※ Slave 호스트에 Jenkins를 설치할 필요는 없습니다.
Jenkins가 유용한 툴인 이유중 하나는 방대한 양의 플러그인 입니다. Jenkins의 기능을 확장시키고, 관리, 빌드 정책 등을 확장 시켜주고, 타 서비스와의 연계를 쉽게 가능하도록 합니다.
Jenkins빌드의 결과를 받아볼 수 있는 몇가지 방안에 대해 알아봅니다.
Jenkins에서는 플러그인이나 외부 툴에 의해 빌드에 대한 결과를 받아 볼 수 있습니다. 대표적으로는 Jenkins의 슬랙 플러그인을 사용하여 슬랙으로 빌드에 결과를 받아보거나, catlight.io 에서 데스크탑용 어플리케이션에 연동하는 방법도 있습니다.
테스트 Pipeline 구성시 테스트 과정을 지정할 수 있습니다. Testing을 위한 Pipeline 타입의 Item을 추가로 생성합니다. (e.g. 07-01.CodeCoverageTestsAndReports)
설정은 다음과 같이 수행합니다.
Pipeline 스크립트에 다음과 같이 입력 합니다. 테스트와 빌드, 검증 후 결과를 보관하는 단계까지 이루어 집니다.
pipeline {
agent any
stages {
stage('Build') {
steps {
sh '''
echo This > app.sh
echo That >> app.sh
'''
}
}
stage('Test') {
steps {
sh '''
grep This app.sh >> ${BUILD_ID}.cov
grep That app.sh >> ${BUILD_ID}.cov
'''
}
}
stage('Coverage'){
steps {
sh '''
app_lines=`cat app.sh | wc -l`
cov_lines=`cat ${BUILD_ID}.cov | wc -l`
echo The app has `expr $app_lines - $cov_lines` lines uncovered > ${BUILD_ID}.rpt
cat ${BUILD_ID}.rpt
'''
archiveArtifacts "${env.BUILD_ID}.rpt"
}
}
}
}
빌드가 완료되면 해당 Job화면을 리로드 합니다. Pipeline에 archiveArtifacts가 추가되었으므로 해당 Job에서 이를 관리합니다.
해당 아카이브에는 코드 검증 후의 결과가 저장 됩니다.
Jenkins는 외부 서비스와의 연동이나 정보 조회를 위한 API를 제공합니다.
Jenkins REST API 테스트를 위해서는 Jenkins에 인증 가능한 Token을 취득하고 curl이나 Postman 같은 도구를 사용하여 확인 가능 합니다. 우선 Token을 얻는 방법은 다음과 같습니다.
Jenkins에 로그인 합니다.
우측 상단의 로그인 아이디에 마우스를 호버하면 드롭박스 버튼이 나타납니다. 설정을 클릭합니다.
API Token에서 Current token을 확인합니다. 등록된 Token이 없는 경우 다음과 같이 신규 Token을 발급 받습니다.
ADD NEW TOKEN을 클릭합니다.
이름을 기입하는 칸에 로그인 한 아이디를 등록합니다. (e.g. admin)
GENERATE를 클릭하여 Token을 생성합니다.
이름과 Token을 사용하여 다음과 같이 curl로 접속하면 Jenkins-Crumb 프롬프트가 나타납니다.
$ curl --user "admin:TOKEN" 'http://myjenkins.com/crumbIssuer/api/xml?xpath=concat(//crumbRequestField,":",//crumb)'
Jenkins-Crumb:89e1fd9c402824c89465f6b97f49b605
Crumb를 확인했으면 다시 헤더 값에 Jenkins-Crumb:를 추가하여 02-04.MultiStep Job을 빌드하기 위해 다음과 같이 요청합니다.
$ curl -X POST http://myjenkins.com/job/02-04.MultiStep/build --user gyulee:11479bdec9cada082d189938a3946348be --data-urlencode json='' -H "Jenkins-Crumb:89e1fd9c402824c89465f6b97f49b605"
사용자별 배포수행을 위한 사용자 설정을 설명합니다.
Jenkins 관리로 이동하여 Configure Global Security를 클릭합니다.Enable security는 보안 설정 여부를 설정하는 항목으로 기본적으로는 비활성화되어있습니다. 체크하여 활성화하면 다양한 보안 옵션을 설정할 수 있는 항목이 표기 됩니다.