DevOps 지식 허브
DevOps 지식 허브

CLI 대 Groovy: 원격 Jenkins 작업을 위한 올바른 도구 선택

원격 작업을 위해 Jenkins CLI와 Groovy Script Console 중 무엇을 선택해야 할까요? 이 글은 두 도구의 기능, 제한 사항, 그리고 사용 사례를 비교합니다. CLI를 사용하여 간단한 명령줄 매개변수로 빠른 작업을 처리할 때와, 강력한 API 기반 Groovy Script Console을 활용하여 복잡한 자동화 및 관리를 수행할 때를 알아보십시오. 효율적인 Jenkins 관리 및 CI/CD에 필수적인 내용입니다.

34 조회수

CLI 대 Groovy: 원격 Jenkins 작업을 위한 올바른 도구 선택

강력한 오픈소스 자동화 서버인 Jenkins는 관리 및 운영 작업을 위해 다양한 상호 작용 방법을 제공합니다. 원격으로 명령을 실행할 때, Jenkins 명령줄 인터페이스(CLI)와 Groovy 스크립트 콘솔이라는 두 가지 주요 방법이 두드러집니다. 둘 다 Jenkins를 자동화하고 관리하는 목적을 수행하지만, 서로 다른 사용 사례에 적합하며 고유한 기능과 한계를 가지고 있습니다. 각 도구를 언제 활용할지 이해하는 것은 효율적인 CI/CD 파이프라인 관리 및 Jenkins 관리에 매우 중요합니다.

이 글에서는 Jenkins CLI와 Groovy 스크립트 콘솔의 장단점을 자세히 다룰 것입니다. 각 도구의 기능들을 살펴보고, 실용적인 예시를 제공하며, 간단한 명령줄 매개변수든 복잡하고 지속적인 자동화 스크립트든 관계없이 원격 Jenkins 작업을 위한 가장 적절한 도구를 선택하는 데 도움을 드릴 것입니다.

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

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

기능 및 사용 사례

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

한계

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

Jenkins CLI 시작하기

  1. CLI 클라이언트 다운로드: jenkins-cli.jar 파일은 Jenkins 인스턴스의 http://<JENKINS_URL>/jnlpJars/jenkins-cli.jar에서 다운로드할 수 있습니다.
  2. 인증: CLI 요청을 인증해야 합니다. 이는 API 토큰 또는 사용자 이름/비밀번호 자격 증명을 사용하여 수행할 수 있습니다.
  3. 명령 실행: 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 성능에 영향을 미칠 수 있습니다.
  • 직접적인 명령줄 인터페이스 없음: 중간 스크립트나 도구 없이 외부 시스템에서 간단한 일회성 명령줄 호출을 위해 설계되지 않았습니다.
  • Groovy/Java 지식 요구: Groovy와 Jenkins의 내부 API에 대한 확실한 이해가 필요합니다.

Groovy 스크립트 콘솔 시작하기

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

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

Jenkins.instance.getAllItems(Job.class).each {
    job -> println "Job: ${job.name}, Last Build Status: ${job.lastBuild?.result ?: 'No builds yet'}"
}

예시: 작업 설명 업데이트

def jobName = "YourJobName"
def newDescription = "This is an automated description."
def job = Jenkins.instance.getItemByFullName(jobName)

if (job) {
    job.updateDescription(newDescription)
    job.save()
    println "Successfully updated description for job: ${jobName}"
} else {
    println "Job '${jobName}' not found."
}

예시: 작업 비활성화

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

if (job instanceof hudson.model.Job) {
    job.disabled = true
    job.save()
    println "Job '${jobName}' has been disabled."
} else {
    println "Job '${jobName}' not found or is not a job type."
}

CLI 대 Groovy: 언제 어떤 것을 사용해야 하는가

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

다음 경우에 Jenkins CLI를 사용하십시오:

  • 로컬 머신이나 스크립트에서 빠르고 일회성 작업을 수행해야 할 때.
  • 작업이 빌드를 트리거하거나, 작업 상태를 확인하거나, 기본 정보를 검색하는 것을 포함할 때.
  • 명령줄 인수를 기대하는 외부 쉘 스크립트 또는 CI/CD 도구에 Jenkins 작업을 통합할 때.
  • 보안 또는 리소스 문제로 인해 Jenkins 컨트롤러에서 복잡한 코드를 직접 실행하는 것을 피하고 싶을 때.
  • CLI 명령으로 직접 노출된 기본 관리 작업을 수행해야 할 때.

다음 경우에 Groovy 스크립트 콘솔을 사용하십시오:

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

모범 사례 및 고려 사항

Jenkins CLI의 경우:

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

Groovy 스크립트 콘솔의 경우:

  • 보안 우선: 절대 신뢰할 수 없는 스크립트를 실행하지 마십시오. 실행 전에 모든 스크립트를 철저히 검토하십시오. 스크립트 콘솔에 대한 접근을 제한하는 것을 고려하십시오.
  • 철저히 테스트: 항상 비프로덕션 환경에서 스크립트를 먼저 테스트하십시오.
  • 리소스 관리: 스크립트가 Jenkins 컨트롤러에 미치는 성능 영향에 유의하십시오. 적절한 최적화 또는 백그라운드 실행 없이 콘솔에서 직접 장시간 실행되거나 리소스 집약적인 작업을 피하십시오.
  • Jenkins.instance.get() 사용: 최신 Jenkins 버전에서는 Jenkins 컨트롤러 인스턴스에 접근하기 위해 Jenkins.instance보다 Jenkins.instance.get()이 선호되는 경우가 많습니다.
  • 스크립트 보안 플러그인 고려: 스크립트를 관리하고 승인하는 데 "Script Security" 플러그인은 매우 중요합니다.

결론

Jenkins CLI와 Groovy 스크립트 콘솔은 모두 Jenkins 환경을 관리하고 자동화하는 데 없어서는 안 될 도구입니다. CLI는 원자적인 작업 및 외부 통합을 위한 빠르고 명령줄 인터페이스를 제공하는 데 탁월합니다. 이와 대조적으로, Groovy 스크립트 콘솔은 복잡한 API 기반 자동화 및 심층 시스템 관리를 위한 비할 데 없는 강력함과 유연성을 제공합니다. 각 도구의 장단점을 이해함으로써, 효율적이고 안전하며 효과적인 원격 Jenkins 작업 실행을 보장하면서 작업에 적합한 도구를 자신 있게 선택할 수 있습니다.