[Jenkins] Jenkins GitHub 프로젝트 연동하기 01

Jenkins에서 GitLab, GitHub과 같은 Git Repository와 연동하여 프로젝트를 관리할 수 있습니다.

그중 GitHub 프로젝트와 연동하기 위해서는 어떤 설정이 필요한지 알아보고, 간단히 Pipeline을 작성하여 구동시켜보는 것까지 해보도록 하겠습니다.

Personal Access Tokens 발급

GitHub 서버와 연동하기 위한 Personal Access Tokens을 발급합니다.

Profile에서 아래쪽에 Developer settings 메뉴를 선택합니다.

Tokens 메뉴에서 Token 신규 발급 버튼을 클릭합니다.

Token 이름과 만료기간을 설정하고,

Scope를 아래와 같이 설정 후 Token을 발급합니다.

발급한 Token은 복사 후 Jenkins에서 GitHub 서버를 등록할 때 사용합니다.

GitHub 서버 추가

Jenkins 관리 페이지에서 GitHub 서버를 추가해줍니다.

시스템 설정 페이지 하단에 있는 GitHub 서버 추가 버튼을 클릭하여 추가를 진행합니다.

GitHub 서버와 연동 시 Credentials이 필요하며 별도로 추가한 Credentials이 있다면 사용하고 없다면 추가 등록하기위해 Add 버튼을 클릭합니다.

사전에 발급한 Personal Access Tokens을 Secret text로 설정하고 등록합니다.

등록 완료 후 Test connection으로 테스트 시 정상적으로 GitHub 서버 추가 작업이 완료되었음을 확인하실 수 있습니다.

Personal Access Tokens 발급 후 해당 Token으로 GitHub 서버를 추가하는 작업을 완료하였습니다.
다음에는 GitHub 프로젝트와 연동하는 설정을 진행해보도록 하겠습니다...! 끝...!

[Reference]

• https://2mukee.tistory.com/239

[Jenkins] Jenkins Pipeline environment variables 사용 및 전체 리스트 출력하기

Jenkins Pipeline은 전역 변수인 environment variables를 통해 Jenkins에서 제공하는 다양한 환경 변수를 사용할 수 있습니다. 해당 정보를 통해 빌드 또는 테스트를 다르게 구성하도록 설정할 수 있으며 CI 시 필요한 정보에도 사용할 수 있습니다.

environment variables 사용 및 전체 리스트를 출력하는 방법을 알아봅시다.

environment variables 사용하기

environment variables를 사용하기 위해서는 env.을 통해 사용하고자 하는 환경 변수를 뒤에 선언해줍니다.
테스트를 위해 JOB_NAME 항목과 BUILD_ID 항목을 출력하기 위한 pipeline을 작성해봤습니다.

pipeline {
     agent any
     stages {
          stage('test-use-environment-variables') {
               steps {
                    echo "env.JOB_NAME : ${env.JOB_NAME}"
                    echo "env.BUILD_ID : ${env.BUILD_ID}"
               }
          }
     }
}

pipeline을 실행하여 결과 값을 확인합니다.
환경 변수 JOB_NAME 항목과 BUILD_ID 항목의 값을 확인하실 수 있습니다.

[Pipeline] Start of Pipeline
[Pipeline] {
[Pipeline] stage
[Pipeline] { (test-use-environment-variables)
[Pipeline] echo
env.JOB_NAME : jenkins-test-pipeline-001
[Pipeline] echo
env.BUILD_ID : 101
[Pipeline] }

• env.JOB_NAME : jenkins-test-pipeline-001
• env.BUILD_ID : 101

pipeline에서 사용하고자 하는 구문에 ${env.DATA} 형식으로 환경 변수를 사용할 수 있습니다.

environment variables 전체 리스트 출력하기

environment variables의 전체 리스트를 출력하여 사용할 수 있는 환경 변수를 확인할 수 있습니다.
Git Repository 및 사용하는 Plugins 등에 따라 출력되는 항목은 다를 수 있습니다.

테스트를 위해 전체 리스트를 출력하기 위한 pipeline을 작성해봤습니다.

pipeline {
     agent any
     stages {
          stage('test-use-environment-variables') {
               steps {
                    sh 'printenv'
               }
          }
     }
}

pipeline을 실행하여 결과 값을 확인합니다.
해당 pipeline에서 제공하는 environment variables 전체 리스트를 확인하실 수 있습니다.

(Private한 정보는 숨김처리 했습니다)

+ printenv
gitlabSourceRepoURL=ssh://git@################################################/test-project.git
JENKINS_HOME=/var/jenkins_home
GIT_PREVIOUS_SUCCESSFUL_COMMIT=553623fdd4a070d4d20866df329e0da685025cf6
JENKINS_UC_EXPERIMENTAL=https://updates.jenkins.io/experimental
CI=true
RUN_CHANGES_DISPLAY_URL=http://################################################/job/jenkins-test-pipeline-001/104/display/redirect?page=changes
gitlabAfter=dd77bc3d4dbae981b83223144f00d3e8cd2d2df6
HOSTNAME=2dedf5df6d0f
SHLVL=0
NODE_LABELS=built-in cicd-jenkins
HUDSON_URL=http://################################################/
GIT_COMMIT=dd77bc3d4dbae981b83223144f00d3e8cd2d2df6
HOME=/var/jenkins_home
BUILD_URL=http://################################################/job/jenkins-test-pipeline-001/104/
HUDSON_COOKIE=e1ab8579-0e43-4c87-b99d-d3429a902ad1
gitlabTargetBranch=cicd-jenkins
JENKINS_SERVER_COOKIE=durable-ed442d3ad3a22f5c36c67c83bb48f7b34155799687da888ff49fc84e1cced00a
JENKINS_UC=https://updates.jenkins.io
gitlabSourceRepoHttpUrl=https://################################################/test-project.git
gitlabUserUsername=test-user
WORKSPACE=/var/jenkins_home/workspace/jenkins-test-pipeline-001@3
REF=/usr/share/jenkins/ref
gitlabMergeRequestLastCommit=dd77bc3d4dbae981b83223144f00d3e8cd2d2df6
NODE_NAME=built-in
gitlabSourceRepoSshUrl=ssh://git@################################################/test-project.git
RUN_ARTIFACTS_DISPLAY_URL=http://################################################/job/jenkins-test-pipeline-001/104/display/redirect?page=artifacts
STAGE_NAME=test-use-environment-variables
GIT_BRANCH=origin/cicd-jenkins
gitlabSourceRepoHomepage=https://################################################/test-project
EXECUTOR_NUMBER=0
gitlabBranch=cicd-jenkins
RUN_TESTS_DISPLAY_URL=http://################################################/job/jenkins-test-pipeline-001/104/display/redirect?page=tests
BUILD_DISPLAY_NAME=#104
gitlabSourceBranch=cicd-jenkins
JENKINS_VERSION=2.387.1
JENKINS_INCREMENTALS_REPO_MIRROR=https://repo.jenkins-ci.org/incrementals
HUDSON_HOME=/var/jenkins_home
GO_VERSION=1.19
JOB_BASE_NAME=jenkins-test-pipeline-001
PATH=/opt/java/openjdk/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
BUILD_ID=104
gitlabBefore=f9b8a1cd2c0a396543d73f4df1d808e3a4f43fa4
BUILD_TAG=jenkins-jenkins-test-pipeline-001-104
gitlabActionType=PUSH
JENKINS_URL=http://################################################/
LANG=C.UTF-8
JOB_URL=http://################################################/job/jenkins-test-pipeline-001/
gitlabSourceRepoName=test-project
GIT_URL=https://################################################/test-project.git
gitlabSourceNamespace=experiment
BUILD_NUMBER=104
JENKINS_NODE_COOKIE=4dac1e72-512f-4f72-8c9b-6e7d94748b11
RUN_DISPLAY_URL=http://################################################/job/jenkins-test-pipeline-001/104/display/redirect
JENKINS_SLAVE_AGENT_PORT=50000
HUDSON_SERVER_COOKIE=a600b39245c6beef
JOB_DISPLAY_URL=http://################################################/job/jenkins-test-pipeline-001/display/redirect
JOB_NAME=jenkins-test-pipeline-001
COPY_REFERENCE_FILE_LOG=/var/jenkins_home/copy_reference_file.log
PWD=/var/jenkins_home/workspace/jenkins-test-pipeline-001@3
JAVA_HOME=/opt/java/openjdk
gitlabUserName=홍길동
GIT_PREVIOUS_COMMIT=3f6dff84fe6d6497a120f7668efc65ef140a21c1
WORKSPACE_TMP=/var/jenkins_home/workspace/jenkins-test-pipeline-001@3@tmp
GITLAB_OBJECT_KIND=none

Jenkins Pipeline environment variables 사용 및 전체 리스트 출력하는 작업을 완료하였습니다...! 끝...!

[Reference]

• https://www.jenkins.io/doc/book/pipeline/jenkinsfile/#using-environment-variables

[Jenkins] Jenkins TimeZone 변경하기

Jenkins에서 Project 및 Pipeline 등의 작업을 진행하면 작업 시간이 기록됩니다. 별도의 설정을 하지 않으면 기본 TimeZone으로 시간이 출력되기 때문에 TimeZone을 한국 시간인 Asia/Seoul로 변경하는 방법을 알아봅시다.

Jenkins TimeZone 변경하기

TimeZone 설정은 각 계정별로 관리되는 설정이므로 로그인한 계정의 설정 메뉴를 선택합니다.

User Defined Time Zone 설정에서 변경하고자 하는 TimeZone을 선택합니다.
선택 후 Save 버튼을 클릭하여 저장하면 TimeZone 변경 작업이 완료됩니다.

기존에 작업했던 작업 이력 시간이 변경된 TimeZone 시간으로 변경되어 출력됩니다.

Jenkins TimeZone 변경하는 작업을 완료하였습니다...! 끝...!

[Jenkins] Jenkins root 계정 패스워드 복구

Jenkins root 계정의 패스워드를 까먹었을 경우 복구하는 방법을 알아봅시다.

Jenkins 설정 파일 (config.xml) 파일 수정

Jenkins의 설정 파일인 config.xml 파일을 수정하여 잠시 로그인 없이도 관리 페이지에 접근할 수 있도록 설정이 가능합니다.

vi 에디터 등을 사용하여 Jenkins Home Dir 경로에 생성되어 있는 config.xml 파일의 아래와 같이 useSecurity 항목을 true에서 false로 변경합니다.

vi /{{Jenkins Home Dir}}/config.xml
<useSecurity>true</useSecurity>

<?xml version='1.1' encoding='UTF-8'?>
<hudson>
  <disabledAdministrativeMonitors/>
  <version>2.387.1</version>
  <numExecutors>2</numExecutors>
  <mode>NORMAL</mode>
  <useSecurity>false</useSecurity>
  <authorizationStrategy class="hudson.security.FullControlOnceLoggedInAuthorizationStrategy">
    <denyAnonymousReadAccess>true</denyAnonymousReadAccess>
  </authorizationStrategy>
  <securityRealm class="hudson.security.HudsonPrivateSecurityRealm">
    <disableSignup>true</disableSignup>
    <enableCaptcha>false</enableCaptcha>
  </securityRealm>
  <disableRememberMe>false</disableRememberMe>
  <projectNamingStrategy class="jenkins.model.ProjectNamingStrategy$DefaultProjectNamingStrategy"/>
  <workspaceDir>${JENKINS_HOME}/workspace/${ITEM_FULL_NAME}</workspaceDir>
  <buildsDir>${ITEM_ROOTDIR}/builds</buildsDir>
  <jdks/>
  <viewsTabBar class="hudson.views.DefaultViewsTabBar"/>
  <myViewsTabBar class="hudson.views.DefaultMyViewsTabBar"/>
  <clouds/>
  <scmCheckoutRetryCount>0</scmCheckoutRetryCount>
  <views>
    <hudson.model.AllView>
      <owner class="hudson" reference="../../.."/>
      <name>all</name>
      <filterExecutors>false</filterExecutors>
      <filterQueue>false</filterQueue>
      <properties class="hudson.model.View$PropertyList"/>
    </hudson.model.AllView>
  </views>
  <primaryView>all</primaryView>
  <slaveAgentPort>50000</slaveAgentPort>
  <label></label>
  <crumbIssuer class="hudson.security.csrf.DefaultCrumbIssuer">
    <excludeClientIPFromCrumb>false</excludeClientIPFromCrumb>
  </crumbIssuer>
  <nodeProperties/>
  <globalNodeProperties/>
  <nodeRenameMigrationNeeded>false</nodeRenameMigrationNeeded>
</hudson>

Jenkins 재시작

Jenkins의 설정 파일인 config.xml파일 수정 후 Jenkins를 재시작해야지만 설정이 적용되므로 Jenkins를 재시작해줍니다.
저는 Docker 환경에서 Jenkins를 실행했으므로 Jenkins 컨테이너를 재시작하겠습니다.

# docker restart server-jenkins
server-jenkins

# docker ps -a | grep server-jenkins
2dbe6e4b3f7b   jenkins/jenkins:lts-jdk11                                         "/usr/bin/tini -- /u…"   2 days ago    Up 12 minutes                   0.0.0.0:50000->50000/tcp, 0.0.0.0:8088->8080/tcp   server-jenkins

Jenkins 관리 페이지 접속 및 패스워드 복구

Jenkins 관리 페이지 접속 시 아래와 같이 사용자 이름 및 암호를 입력할 필요 없이 바로 관리자 페이지로 접속됩니다.

패스워드 복구를 위해 Jenkins -> Security -> Configure Global Securiy 메뉴를 접속합니다.

기존에 None 으로 설정되어 있었던 Security Realm 설정을 Jenkins' own user database 로 변경하고 사용자의 가입 허용을 체크하고 Save 버튼을 눌러 저장합니다.

설정 저장이 완료되면 기존에 없었던 Security -> Manage Users 메뉴가 생성되며 해당 메뉴를 접속합니다.

패스워드를 복구하고자 하는 계정의 톱니바퀴 버튼을 클릭하여 패스워드 변경 화면에 접속합니다.

변경하고자 하는 패스워드를 입력 후 Save 버튼을 눌러 저장합니다.

저장 완료 후 다시 로그인 버튼을 클릭하여 패스워드를 복구한 계정으로 접속하여 사용 가능합니다.

Jenkins root 계정 패스워드 복구하는 작업을 완료하였습니다...! 끝...!

[Reference]

• https://bosungtea9416.tistory.com/entry/Jenkins-%EC%82%AC%EC%9A%A9%EC%9E%90-%EC%95%94%ED%98%B8-%EC%9E%8A%EC%96%B4%EB%B2%84%EB%A0%B8%EC%9D%84-%EB%95%8C-%EC%9E%AC%EC%84%A4%EC%A0%95%ED%95%98%EA%B8%B0

[Jenkins] Jenkins Plugin HTTP 프록시 설정

Jenkins 서버가 내부 네트워크망에 있어 별도의 프록시 서버를 통해서만 외부 접근이 가능할 경우 외부에 접속하여 바로 설치할 수 있는 Plugin 조회 및 설치가 불가합니다.
HTTP 프록시를 설정하고 프록시 서버를 통해 Plugin 설치가 가능하도록 Plugin 설정을 알아봅시다.

Jenkins Plugin 설정 변경

Jenkins 관리 -> System Configuration -> 플러그인 관리 메뉴에 접속하여 Plugin 관련 설정을 추가합니다.

Advanced Setting 메뉴에서 HTTP 프록시 설정의 서버 항목과 포트 항목을 프록시 서버 정보로 설정한 후 Submit 버튼을 클릭하여 적용합니다.

HTTP 프록시 설정을 추가 완료하였으므로 Available Plugins 메뉴에서 설치하고자하는 Plugin 조회 및 설치가 가능합니다.

Jenkins Pulugin HTTP 프록시 설정을 추가하는 작업을 완료하였습니다...! 끝...!

[Reference]

• https://jazz.net/forum/questions/214230/how-do-you-configure-jenkins-to-work-with-a-proxy-server

[Jenkins] Jenkins 접속 URL 변경하기

최초로 Jenkins 설치 시 접속 URL을 설정할 수 있습니다.
Jenkins를 설치한 서버의 IP 또는 Domain이 변경되었을 경우 접속 URL을 변경해야 하므로 변경 방법을 알려드립니다.

Jenkins 접속 URL 변경

Jenkins 접속 URL 변경은 Jenkins 관리 메뉴의 시스템 설정으로 가능합니다.

Jenkins 메인 화면에서 Jenkins 관리 메뉴를 선택합니다.

Jenkins 관리 메는 Jenkins의 여러가지 설정을 할 수 있는 관리 페이지이며 URL 변경을 위해 시스템 설정을 선택합니다.

시스템 설정에서는 Jenkins 기본 정보 및 Job 관련 설정을 할 수 있습니다.
Jenkins Location 설정에서 Jenkins의 접속 URL을 변경할 수 있습니다.

간단히 Jenkins 접속 URL을 변경하는 작업을 완료하였습니다...! 끝...!

[Reference]

https://charmer.tistory.com/entry/Jenkins-Jenkins-%EC%A0%91%EC%86%8D-%EC%A3%BC%EC%86%8C%EB%A5%BC-IP%EB%A1%9C-%EB%B3%80%EA%B2%BD%ED%95%98%EA%B8%B0

[Jenkins] Docker 환경에서 Jenkins 서비스 설치

Jenkins는 지속적 통합(Continuous Integration)을 제공하는 툴입니다.
GitHub, GitLab과 같은 Code Repository와 연동하여 소스 코드의 커밋을 감지하여 빌드 및 테스트를 자동화 할 수 있습니다.
Docker 컨테이너를 통해 Jenkins 서비스를 설치해보겠습니다.

Jenkins docker-compose.yml 파일 작성

최신 LTS 버전인 jenkins/jenkins:lts-jdk11 이미지를 사용하여 Jenkins를 구성해보도록 하겠습니다.
서비스 포트인 8080번, 50000번 포트를 포워딩 설정하고, 주요 디렉토리를 마운트하도록 설정합니다.

services:
  jenkins:
    image: jenkins/jenkins:lts-jdk11
    container_name: server-jenkins
    restart: always
    ports:
      - 8080:8080
      - 50000:50000
    volumes:
      - /home/jenkins:/var/jenkins_home:rw

마운트 하고자 하는 디렉토리의 권한을 chown 명령어로 할당해줍니다.
권한을 할당하지 않으면 Jenkins 컨테이너 실행 시 권한 오류가 발생합니다.

mkdir /home/jenkins
chown 1000:1000 /home/jenkins

Jenkins 실행

설정 완료 후 docker-compose up -d 명령어로 컨테이너를 실행합니다.

# docker-compose up -d
Creating network "jenkins_default" with the default driver
Creating server-jenkins ... done

정상적으로 컨테이너가 생성되고 실행되었는지 확인합니다.

# docker ps -a | grep jenkins
28ca76f273c7   jenkins/jenkins:lts-jdk11      "/usr/bin/tini -- /u…"   8 minutes ago   Up 8 minutes                0.0.0.0:8080->8080/tcp, :::8080->8080/tcp, 0.0.0.0:50000->50000/tcp, :::50000->50000/tcp   server-jenkins

Jenkins 로그인 및 설치 확인

컨테이너 실행 완료 후 http://IP:8080 주소를 통해 Jenkins 웹 페이지에 접속합니다.

아래와 같이 약간의 로딩 시간이 걸릴 수 있습니다.

서비스 구동 완료 후 아래와 같이 로그인 화면이 출력됩니다.

initial 패스워드를 통해 접속 가능하며 서버에서 아래 경로에 명령어로 확인 가능합니다.

# cat /home/jenkins/secrets/initialAdminPassword
f9d91c45d67b4c1abe083acf718a6fd1

Jenkins를 설치한 환경이 Offline 환경이면 아래와 같이 Offline 화면이 나오며 Online 환경일 경우 플러그인을 설치할 수 있는 화면이 나옵니다. Install suggested plugins를 선택하여 플러그인 설치를 진행해보겠습니다.

Jenkins 커뮤니티에서 가장 유용하다고 생각하는 플러그인 설치가 진행됩니다.

플러그인 설치 완료 후 계정 설정과 URL 설정을 진행합니다.

마지막 설정을 끝으로 아래와 같이 Jenkins를 사용할 수 있습니다.

Jenkins에서 Code Repository와의 연동 및 CI 작업은 다음에 다뤄보도록 하겠습니다.

[Ansible] 시스템 OS 재시작 하기

Ansible의 reboot 모듈을 사용하여 Managed node의 OS를 재시작 가능합니다.

Playbook 생성

Managed node의 OS를 재시작하는 Playbook을 작성해봅니다.

OS 재시작 후 600초 동안 재시작이 완료되었는지 test_command 인 whoami 명령어를 통해 확인하는 Playbook 입니다.

- name: Reboot web-server
  reboot:
    msg: "Reboot initiated by Ansible"
    connect_timeout: 10                     
    reboot_timeout: 600
    pre_reboot_delay: 0
    post_reboot_delay: 0
    test_command: whoami

• connect_timeout: 연결 대기 시간, OS 종료 시 SSH 연결 끊기 위한 설정
• reboot_timeout: OS 재시작 후 최대 대기하는 시간
• pre_reboot_delay: OS 재시작 전 기다리는 시간
• post_reboot_delay: OS 재시작 후 명령어 입력 전 기다리는 시간
• test_command: OS 재시작 후 정상적으로 시스템이 실행되었는지 확인하는 명령어

Playbook 실행

작성한 yml 파일을 실행하여 로그를 확인해봅니다.
상세 로그를 확인하기 위해 ansible-playbook 명령어에 -vv 옵션을 추가하였습니다.

ansible-playbook -i {{Inventory}} test_work.yml -vv

TASK [test_work : Reboot web-server] ************************************
task path: /deploy/roles/test_work/tasks/main.yml:4
changed: [node0] => {"changed": true, "elapsed": 148, "rebooted": true}
META: role_complete for node0
META: ran handlers
META: ran handlers

상세 로그를 통해 148초만에 해당 Managed node의 OS가 재시작된 것을 확인하실 수 있습니다.

직접 해당 노드에 접속해서 OS 재시작 시간을 아래와 같이 확인하실 수 있습니다.

# last reboot
reboot   system boot  3.10.0-1160.el7. Tue Mar  7 09:34 - 09:41 (3+00:07)

위 방법으로 Managed node의 OS 재시작 작업이 필요한 경우 사용하실 수 있습니다.