💻[Jenkins] 젠킨스란 무엇인가?

jenkins

 

1. 젠킨스란 무엇인가?

먼저 젠킨스를 알아보기 전, CI/CD에 대한 이해를 해야 한다.

• CI (Continuous Integration)
  • 지속적인 통합
  • 여러 개발자 들이 지속적으로 코드를 통합하는 것

• CD (Continuous Deployment / Continuous Delivery)
  • 지속적인 배포
  • 변경 사항들을 테스트와 빌드를 거치고, 사용자에게 자동으로 배포

CI/CD

CI/CD 과정인 위의 그림과 같다.

1. 로컬에서 개발 후 커밋

2. Github WebHook 을 이용해 젠킨스에게 전달

3. 빌드가 성공하게 되면 배포 서버로 전송

4. 빌드가 실패할 경우 로그를 남기고 알림

젠킨스 파이프 라인 구성

 

다음은 프로젝트 진행 시 파이프라인을 구성한 예시이다. 젠킨스 + 도커를 이용해 젠킨스 서버를 만들었고 그 안에서 도커를 사용하였다. 도커인도커 방식으로 처음에 구축을 하다가 하나의 인스턴스에서 운영서버와 개발서버를 나누어야 해서 docker daemon을 이용해 도커아웃오브도커로 변경하였다. 

파이프 라인의 구성은 agent section, post section, stages section, declaratives, steps 으로 이루어져 있다.

pipeline {
    agent any

    environment {
        DOCKER_IMAGE = '이미지 이름'
        DOCKER_CONTAINER = '컨테이너 이름'
        DOCKER_HUB_IMAGE = '도커 허브 이미지 이름'
        TARGET_DIRECTORY = '이동하고 싶은 dir'
    }

    stages {
        stage('Clone Git Repository') {
            steps {
                git url: 'github URL'
                echo 'Git Clone SUCCESS'
            }
            post {
                success {
                    echo 'Git Clone stage succeeded!'
                }
                failure {
                    echo 'Git Clone stage failed!'
                }
            }
        }

        stage('Stop and Remove Docker Container') {
            when {
                expression { isContainerRunning() }
            }
            steps {
                script {
                    // If the container is running, stop it
                    sh "docker stop ${DOCKER_CONTAINER}"
                    // Remove the stopped container
                    sh "docker rm ${DOCKER_CONTAINER}"
                }
            }
            post {
                success {
                    echo 'Remove Docker Container Success!'
                }
                failure {
                    echo 'Remove Docker Container Fail!'
                }
            }
        }

        stage('Remove Existing Docker Image') {
            when {
                expression { doesImageExist() }
            }
            steps {
                script {
                    // If the Docker image exists, remove it
                    echo "Docker image : ${DOCKER_IMAGE}"
                    sh "docker rmi ${DOCKER_IMAGE}"
                }
            }
            post {
                success {
                    echo 'Remove Existing Docker Image Success!'
                }
                failure {
                    echo 'Remove Existing Docker Image Fail!'
                }
            }
        }

        stage('Build Docker Image') {
            steps {
                script {
                    dir(TARGET_DIRECTORY) {
                        // Build the Docker image from the Dockerfile in the current directory
                        sh "docker build -t ${DOCKER_IMAGE} ."
                    }
                }
            }
            post {
                success {
                    echo 'Build Docker Image Success!'
                }
                failure {
                    echo 'Build Docker Image Fail!'
                }
            }
        }

        stage('Push Docker Image to Docker Hub') {
            steps {
                script {
                    withCredentials([usernamePassword(credentialsId: 'docker-hub', usernameVariable: 'DOCKER_HUB_USERNAME', passwordVariable: 'DOCKER_HUB_PASSWORD')]) {
                        sh "docker login -u $DOCKER_HUB_USERNAME -p $DOCKER_HUB_PASSWORD"
                        sh "docker tag ${DOCKER_IMAGE} ${DOCKER_HUB_IMAGE}:latest"
                        sh "docker push ${DOCKER_HUB_IMAGE}:latest"
                    }
                }
            }
            post {
                success {
                    echo 'Push Docker Image to Docker Hub Success!'
                }
                failure {
                    echo 'Push Docker Image to Docker Hub Fail!'
                }
            }
        }

        stage('Pull and Run Docker Container') {
            steps {
                script {
                    dir(TARGET_DIRECTORY) {
                        // Pull the Docker image from Docker Hub
                        sh "docker pull ${DOCKER_HUB_IMAGE}:latest"
                        // Run the Docker container
                        sh "docker run -d -p 80:80 -p 443:443 --name ${DOCKER_CONTAINER} ${DOCKER_HUB_IMAGE}:latest"
                    }
                }
            }
            post {
                success {
                    echo 'Docker Image Pull And Run Success!'
                }
                failure {
                    echo 'Docker Image Pull And Run Fail!'
                }
            }
        }
    }

    post {
        success {
            echo 'Pipeline executed successfully!'
        }
    }
}

def isContainerRunning() {
    def isRunning = sh(script: "docker ps -q -f name=${DOCKER_CONTAINER}", returnStatus: true)
    return isRunning == 0
}

def doesImageExist() {
    def imageExists = sh(script: "docker images -q ${DOCKER_IMAGE}", returnStatus: true)
    return imageExists == 0
}

 

내 나름대로 찾아보고 파이프라인을 작성하였다. 젠킨스 설정과 설치는 다음에 다루도록 하고 이러한 파이프 라인을 구성하여 개발자가 로컬에서 커밋 시 자동으로 젠킨스에서 빌드 후 배포까지 과정을 보여주었다. 

자세한 내용은 다음 글에서 만나보도록..