CLI vs. Groovy: 원격 Jenkins 작업에 적합한 도구 선택하기

Jenkins는 원격 관리 작업을 실행하는 여러 방법을 제공합니다. 원격으로 명령을 실행할 때 두 가지 주요 방법이 두드러집니다: Jenkins 명령줄 인터페이스(CLI)와 Groovy 스크립트 콘솔입니다. 둘 다 Jenkins를 자동화하고 관리하는 목적을 제공하지만, 각각 다른 사용 사례에 적합하며 고유한 기능과 제한 사항을 가지고 있습니다. 각 도구를 언제 사용해야 하는지 이해하는 것은 효율적인 CI/CD 파이프라인 관리와 Jenkins 관리를 위해 중요합니다.

실용적인 선택은 일반적으로 간단합니다: 제한된 작업 및 컨트롤러 작업에는 Jenkins CLI를 사용하고, CLI가 노출하지 않는 Jenkins API 액세스가 필요할 때만 Groovy를 사용하세요.

Jenkins 명령줄 인터페이스(CLI)

Jenkins CLI는 명령줄에서 Jenkins 인스턴스와 상호 작용할 수 있는 강력한 도구입니다. 빠른 작업 스크립팅, 작업 상태 확인, 빌드 트리거 및 기본 관리 작업 수행에 특히 유용합니다. CLI 클라이언트는 일반적으로 .jar 파일로 다운로드되어 Java를 사용하여 실행됩니다.

기능 및 사용 사례

간단한 원자적 작업: 작업 나열, 특정 작업 빌드 또는 빌드 로그 검색과 같은 단일 직관적인 명령을 실행하는 데 이상적입니다.
빌드 트리거 스크립팅: Jenkins 빌드를 외부 스크립트나 다른 자동화 도구에 쉽게 통합할 수 있습니다.
상태 확인: Jenkins 컨트롤러, 에이전트 또는 작업의 상태를 빠르게 조회할 수 있습니다.
관리: 플러그인 관리 또는 Jenkins 재구성과 같은 기본 관리 작업을 수행할 수 있습니다.
통합: 셸 스크립트, cron 작업 및 기타 명령줄 기반 자동화와 원활하게 통합됩니다.

제한 사항

제한된 복잡성: 상태 관리가 필요한 복잡한 로직, 조건부 실행 또는 복잡한 워크플로우에는 적합하지 않습니다.
지속 상태 없음: 각 CLI 명령은 독립적으로 실행되며, 여러 호출 간에 컨텍스트나 상태를 유지하지 않습니다.
복잡한 작업에 대한 가파른 학습 곡선: 간단한 명령은 직관적이지만, CLI 명령만으로 복잡한 자동화 시퀀스를 구축하는 것은 번거로울 수 있습니다.

Jenkins CLI 시작하기

CLI 클라이언트 다운로드: http://<JENKINS_URL>/jnlpJars/jenkins-cli.jar에서 jenkins-cli.jar를 다운로드할 수 있습니다.
인증: CLI 요청을 인증해야 합니다. API 토큰 또는 사용자 이름/비밀번호 자격 증명을 사용하여 수행할 수 있습니다.
명령 실행: Java를 사용하여 적절한 명령과 인수로 .jar 파일을 실행합니다.

예제: 모든 Jenkins 작업 나열

java -jar jenkins-cli.jar -s http://<JENKINS_URL>/ -auth <USERNAME>:<API_TOKEN> list-jobs

예제: 특정 작업에 대한 빌드 트리거

java -jar jenkins-cli.jar -s http://<JENKINS_URL>/ -auth <USERNAME>:<API_TOKEN> build <JOB_NAME>

예제: 마지막 빌드의 콘솔 출력 가져오기

java -jar jenkins-cli.jar -s http://<JENKINS_URL>/ -auth <USERNAME>:<API_TOKEN> console <JOB_NAME>

Groovy 스크립트 콘솔

Jenkins Groovy 스크립트 콘솔(종종 스크립트 콘솔 또는 Groovy 콘솔이라고 함)은 Jenkins 컨트롤러에서 직접 임의의 Groovy 스크립트를 실행하기 위한 강력한 대화형 환경을 제공합니다. 이를 통해 Jenkins의 내부 Java API에 액세스할 수 있어 매우 정교하고 동적인 자동화, 관리 및 사용자 정의 기능 개발이 가능합니다.

기능 및 사용 사례

복잡한 로직 및 워크플로우: 조건부 로직, 루프 및 사용자 정의 데이터 처리를 포함한 복잡한 스크립트를 실행할 수 있습니다.
직접 API 액세스: 세밀한 제어를 위해 Jenkins의 핵심 Java 객체 및 API와 직접 상호 작용할 수 있습니다.
데이터 조작: Jenkins 데이터를 쿼리하고, 구성을 수정하며, 사용자 정의 보고서를 생성할 수 있습니다.
시스템 관리: 고급 관리 작업을 수행하고, 문제를 해결하며, 복잡한 설정 절차를 자동화할 수 있습니다.
플러그인 개발 및 테스트: 플러그인 기능을 테스트하거나 새 플러그인을 개발하는 데 유용합니다.

제한 사항

보안 문제: Jenkins 컨트롤러에서 임의의 스크립트를 실행하는 것은 신중하게 관리하지 않으면 심각한 보안 위험을 초래할 수 있습니다. 스크립트는 철저히 검토되고 테스트되어야 합니다.
컨트롤러 리소스 소비: 무겁거나 비효율적인 스크립트는 상당한 컨트롤러 리소스를 소비하여 Jenkins 성능에 영향을 줄 수 있습니다.
원격 실행 시 주의 필요: 허용되는 경우 Jenkins CLI groovy 또는 groovysh 명령을 통해 Groovy를 원격으로 실행할 수 있지만, 여전히 컨트롤러에서 강력한 코드를 실행합니다.
Groovy/Java 지식 필요: Groovy 및 Jenkins 내부 API에 대한 확실한 이해가 필요합니다.

Groovy 스크립트 콘솔 시작하기

콘솔 액세스: 브라우저에서 http://<JENKINS_URL>/script로 이동합니다.
스크립트 작성: 제공된 텍스트 영역에 Groovy 스크립트를 입력하거나 붙여넣습니다.
실행: "실행" 버튼을 클릭합니다.
결과 보기: 스크립트의 출력이 편집기 아래에 표시됩니다.

예제: 모든 작업 및 마지막 빌드 상태 목록 가져오기

Jenkins.instance.getAllItems(Job.class).each {
    job -> println "작업: ${job.name}, 마지막 빌드 상태: ${job.lastBuild?.result ?: '빌드 없음'}"
}

예제: 작업 설명 업데이트

def jobName = "YourJobName"
def newDescription = "자동화된 설명입니다."
def job = Jenkins.instance.getItemByFullName(jobName)

if (job) {
    job.setDescription(newDescription)
    job.save()
    println "작업 '${jobName}'의 설명이 성공적으로 업데이트되었습니다."
} else {
    println "작업 '${jobName}'을(를) 찾을 수 없습니다."
}

예제: 작업 비활성화

def jobName = "JobToDisable"
def job = Jenkins.instance.getItemByFullName(jobName)

if (job instanceof hudson.model.Job) {
    job.setDisabled(true)
    job.save()
    println "작업 '${jobName}'이(가) 비활성화되었습니다."
} else {
    println "작업 '${jobName}'을(를) 찾을 수 없거나 작업 유형이 아닙니다."
}

CLI vs. Groovy: 언제 무엇을 사용할까

Jenkins CLI와 Groovy 스크립트 콘솔 사이의 선택은 수행해야 할 작업의 복잡성, 범위 및 성격에 크게 좌우됩니다.

Jenkins CLI를 사용해야 할 때:

로컬 머신이나 스크립트에서 빠른 단일 작업을 수행해야 할 때.
작업이 빌드 트리거, 작업 상태 확인 또는 기본 정보 검색과 관련될 때.
Jenkins 작업을 명령줄 인수를 기대하는 외부 셸 스크립트 또는 CI/CD 도구에 통합할 때.
보안 또는 리소스 이유로 Jenkins 컨트롤러에서 직접 복잡한 코드를 실행하지 않으려 할 때.
CLI 명령으로 직접 노출된 기본 관리 작업을 수행해야 할 때.

Groovy 스크립트 콘솔을 사용해야 할 때:

의사 결정 및 사용자 정의 로직이 포함된 복잡한 자동화 워크플로우를 구현해야 할 때.
구성을 조작하거나, 데이터를 세부적으로 쿼리하거나, 시스템 설정을 관리하기 위해 Jenkins의 내부 API에 직접 액세스해야 할 때.
단순한 CLI 명령을 넘어서는 고급 관리, 문제 해결 또는 데이터 분석을 수행할 때.
CLI에서 직접 지원하지 않는 방식으로 특정 Jenkins 객체 또는 플러그인과 상호 작용해야 할 때.
Groovy 스크립팅에 익숙하고 컨트롤러에서 코드 실행의 보안 영향을 이해하고 있을 때.

모범 사례 및 고려 사항

Jenkins CLI의 경우:

안전한 인증: 비밀번호 대신 항상 API 토큰을 사용하여 인증하세요. 토큰을 안전하게 저장하세요.
매개변수화: URL, 자격 증명 및 작업 이름을 매개변수화하여 CLI 스크립트를 견고하게 만드세요.
오류 처리: 호출 스크립트에서 명령 실행 성공/실패에 대한 검사를 구현하세요.

Groovy 스크립트 콘솔의 경우:

보안 우선: 신뢰할 수 없는 스크립트를 절대 실행하지 마세요. 실행 전에 모든 스크립트를 철저히 검토하세요. 스크립트 콘솔에 대한 액세스를 제한하는 것을 고려하세요.
철저한 테스트: 항상 비프로덕션 환경에서 먼저 스크립트를 테스트하세요.
리소스 관리: Jenkins 컨트롤러에 대한 스크립트의 성능 영향을 인식하세요. 적절한 최적화나 백그라운드 실행 없이 콘솔에서 장기 실행, 리소스 집약적 작업을 피하세요.
지원되는 API 액세스 사용: 현재 Jenkins 코드에서 재사용 가능한 Groovy를 작성할 때는 jenkins.model.Jenkins의 Jenkins.get()을 선호하세요. 많은 오래된 스니펫이 여전히 Jenkins.instance를 사용합니다. Jenkins 버전과 가져오기를 확인하세요.

핵심 요점

작업이 작업 빌드, 작업 나열 또는 콘솔 출력 읽기와 같은 기존 명령에 매핑될 때는 Jenkins CLI를 사용하세요. Jenkins 내부에서 직접 객체 수준 변경이 필요할 때는 Groovy를 사용하고, 모든 스크립트를 컨트롤러 수준의 관리 코드로 취급하세요. 비프로덕션 컨트롤러에서 Groovy를 먼저 테스트하고, 스크립트를 작게 유지하며, 최종 버전을 소스 제어에 저장하세요.