GitHub Actions Importer를 사용해 Jenkins에서 마이그레이션하기

GitHub Actions Importer을(를) 사용하여 Jenkins 파이프라인을 GitHub Actions(으)로 마이그레이션을 자동화하는 방법을 알아봅니다.

이 문서의 내용

법적 고지 사항

GitHub Actions Importer를 사용해 Jenkins에서 마이그레이션 정보

아래 지침은 GitHub Actions Importer을(를) 사용하여 Jenkins 파이프라인을 GitHub Actions로 마이그레이션하도록 환경을 구성하는 방법을 안내합니다.

필수 조건

  • GitHub Actions 워크플로로 변환하려는 파이프라인 및 작업이 있는 Jenkins 계정 또는 조직입니다.
  • 계정 또는 조직용 Jenkins 개인 API 토큰을 만들 수 있는 액세스 권한입니다.
  • Linux 기반 컨테이너를 실행하고 필요한 도구를 설치할 수 있는 환경입니다.

    Note

    GitHub Actions Importer 컨테이너와 CLI는 CI 플랫폼과 동일한 서버에 설치할 필요가 없습니다.

제한 사항

GitHub Actions Importer을(를) 사용하여 Jenkins에서 GitHub Actions(으)로 마이그레이션하는 경우, 몇 가지 제한 사항이 있습니다. 예를 들어 다음 구문을 수동으로 마이그레이션해야 합니다.

  • 필수 빌드 도구
  • 스크립트된 파이프라인
  • 비밀
  • 자체 호스팅 실행기
  • 알 수 없는 플러그인

수동 마이그레이션에 대한 자세한 내용은 Jenkins에서 GitHub Actions로 마이그레이션을(를) 참조하세요.

GitHub Actions Importer CLI 확장 프로그램 설치하기

  1. GitHub Actions Importer CLI 확장을 설치합니다.

    Bash
    gh extension install github/gh-actions-importer

  2. 다음 확장이 설치되어 있는지 확인:

    $ gh actions-importer -h
Options:
  -?, -h, --help  Show help and usage information

Commands:
  update     Update to the latest version of GitHub Actions Importer.
  version    Display the version of GitHub Actions Importer.
  configure  Start an interactive prompt to configure credentials used to authenticate with your CI server(s).
  audit      Plan your CI/CD migration by analyzing your current CI/CD footprint.
  forecast   Forecast GitHub Actions usage from historical pipeline utilization.
  dry-run    Convert a pipeline to a GitHub Actions workflow and output its yaml file.
  migrate    Convert a pipeline to a GitHub Actions workflow and open a pull request with the changes.

필요한 자격 증명 구성

configure CLI 명령은 Jenkins 및 GitHub(으)로 작업할 때 GitHub Actions Importer에 필요한 자격 증명 및 옵션을 설정하는 데 사용됩니다.

  1. GitHub personal access token (classic)을(를) 만듭니다. 자세한 내용은 개인용 액세스 토큰 관리을(를) 참조하세요.

    이 토큰에는 workflow 범위가 있어야 합니다.

    토큰을 만든 후 복사하고 나중에 사용할 수 있도록 안전한 위치에 저장합니다.

  2. Jenkins API 토큰을 만듭니다. 자세한 내용은 Jenkins 설명서의 스크립트된 클라이언트 인증하기를 참조하세요.

    토큰을 만든 후 복사하고 나중에 사용할 수 있도록 안전한 위치에 저장합니다.

  3. 터미널에서 GitHub Actions Importer configure CLI 명령을 실행합니다.

    gh actions-importer configure

    configure 명령을 실행하면 다음 정보를 입력하라는 메시지가 표시됩니다:

    • "어떤 CI 공급자를 구성하고 있나요?"에 대해 화살표 키를 사용하여 Jenkins을(를) 선택하고Space을 눌러 선택한 다음Enter를 누릅니다.
    • "Personal access token for GitHub"에 앞서 만든 personal access token (classic)의 값을 입력하고 EnterEnter다.
    • “GitHub 인스턴스의 기본 URL”의 경우 입력을 눌러 기본값(https://github.com)을 수락합니다.
    • "Personal access token for Jenkins"의 경우 이전에 만든 Jenkins 개인 API 토큰의 값을 입력하고 Enter 키를 누릅니다.
    • "Jenkins 사용자의 사용자 이름"에 Jenkins 사용자 이름을 입력하고 Enter 키를 누릅니다.
    • "Jenkins 인스턴스의 기본 URL"에 Jenkins 인스턴스의 URL을 입력하고 Enter 키를 누릅니다.

    다음은 configure 명령 예제입니다.

    $ gh actions-importer configure
✔ Which CI providers are you configuring?: Jenkins
Enter the following values (leave empty to omit):
✔ Personal access token for GitHub: ***************
✔ Base url of the GitHub instance: https://github.com
✔ Personal access token for Jenkins: ***************
✔ Username of Jenkins user: admin
✔ Base url of the Jenkins instance: https://localhost
Environment variables successfully updated.

  4. 터미널에서 GitHub Actions Importer를 실행합니다.update CLI 명령을 실행하여 GitHub Packages에 연결합니다. {data variables.product.prodname_container_registry %}에 연결하고 컨테이너 이미지가 최신 버전으로 업데이트되었는지 확인합니다.

    gh actions-importer update

    이 명령의 출력은 다음과 비슷해야 합니다.

    Updating ghcr.io/actions-importer/cli:latest...
ghcr.io/actions-importer/cli:latest up-to-date

Jenkins 감사

이 audit 명령을 사용하여 Jenkins 서버의 모든 파이프라인을 개략적으로 볼 수 있습니다.

audit 명령을 실행하면 다음 작업이 수행됩니다.

  1. Jenkins 서버에 정의된 모든 프로젝트를 가져옵니다.
  2. 각 파이프라인을 해당하는 GitHub Actions 워크플로로 변환합니다.
  3. GitHub Actions Importer을(를) 사용하여 마이그레이션의 완전하고 복잡한 작업이 가능한 방법을 요약하는 보고서를 생성합니다.

감사 명령 실행

Jenkins 서버 감사를 수행하려면 터미널에서 다음 명령을 실행합니다.

gh actions-importer audit jenkins --output-dir tmp/audit

감사 결과 점검

지정된 출력 디렉터리의 파일에는 감사의 결과가 포함됩니다. 감사 결과에 대한 요약은 audit_summary.md 파일을 참조하세요.

감사 요약에는 다음의 섹션이 있습니다.

Pipelines

"파이프라인" 섹션에는 GitHub Actions Importer이(가) 수행한 변환률에 대한 개략적인 통계가 포함되어 있습니다.

아래에 "파이프라인" 섹션에 나타날 수 있는 몇 가지 주요 용어가 나와 있습니다.

  • 성공한 파이프라인에는 파이프라인 구문의 100%가 있고 개별 항목은 해당 GitHub Actions(으)로 자동으로 변환됩니다.
  • 부분적으로 성공한 파이프라인에는 모든 파이프라인 구문이 변환되지만 해당 GitHub Actions으로 자동으로 변환되지 않은 일부 개별 항목이 있습니다.
  • 지원 되지 않는 파이프라인은 GitHub Actions Importer에서 지원되지 않는 정의 형식입니다.
  • 실패한 파이프라인을 변환할 때는 심각한 오류가 발생했다는 의미입니다. 이 현상은 다음의 3가지 이유로 발생할 수 있습니다.
    • 파이프라인이 원래 잘못 구성되어 유효하지 않습니다.
    • GitHub Actions Importer을(를) 변환할 때 내부 오류가 발생했습니다.
    • 파이프라인에 액세스할 수 없게 되는 실패한 네트워크 응답이 있으며, 이는 종종 잘못된 자격 증명 때문입니다.

빌드 단계

"빌드 단계" 섹션에는 모든 파이프라인에서 사용되는 개별 빌드 단계 및 GitHub Actions Importer에서 자동으로 변환된 개수에 대한 개요가 포함되어 있습니다.

아래 "파이프라인" 섹션에 나타날 수 있는 몇 가지 주요 용어가 나와 있습니다.

  • 알려진 빌드 단계는 해당 동작으로 자동으로 변환된 단계입니다.
  • 알려진 빌드 단계는 해당 동작으로 자동으로 변환되지 않은 단계입니다.
  • 지원되지 않는 빌드 단계는 다음과 같은 단계입니다.
    • GitHub Actions에서 기본적으로 지원되지 않습니다.
    • GitHub Actions과(와) 호환되지 않는 방식으로 구성됩니다.
  • 작업은 변환된 워크플로에서 사용된 작업의 목록입니다. 이 작업은 다음과 같은 경우에 중요할 수 있습니다.
    • GitHub Enterprise Server을(를) 사용하는 경우 인스턴스와 동기화할 작업 목록을 수집합니다.
    • 사용되는 작업의 조직 수준 허용 목록을 정의합니다. 이 작업 목록은 보안 또는 규정 준수 팀에서 검토해야 할 수도 있는 포괄적인 작업 목록입니다.

수동 작업

"수동 작업" 섹션에는 GitHub Actions Importer이(가) 자동으로 완료할 수 없으며 수동으로 완료해야 하는 작업에 대한 개요가 포함되어 있습니다.

아래 "파이프라인" 섹션에 나타날 수 있는 몇 가지 주요 용어가 나와 있습니다.

  • 비밀은 변환된 파이프라인에서 사용되는 리포지토리 또는 조직 수준의 비밀입니다. 이러한 파이프라인이 제대로 작동하려면 GitHub Actions에서 이러한 비밀을 수동으로 만들어야 합니다. 자세한 내용은 GitHub Actions에서 비밀 사용을(를) 참조하세요.
  • 자체 호스팅 실행기는 GitHub호스티드 러너가 아닌 변환된 파이프라인에서 참조되는 실행기의 레이블을 나타냅니다. 이러한 파이프라인을 제대로 작동시키려면 이러한 실행기를 수동으로 정의해야 합니다.

Files

감사 보고서의 마지막 섹션에는 감사 중 디스크에 기록된 모든 파일의 매니페스트를 제공합니다.

각 파이프라인 파일에는 다음을 포함하며, 감사에 포함된 다양한 파일이 있습니다.

  • GitHub에 정의된 원래 파이프라인입니다.
  • 파이프라인을 변환하기 위해 사용되는 모든 네트워크 응답입니다.
  • 변환된 워크플로 파일입니다.
  • 실패한 파이프라인 변환 문제를 해결하기 위해 사용할 수 있는 스택 추적입니다.

또한 workflow_usage.csv 파일에는 성공적으로 변환된 각 파이프라인에서 사용되는 모든 작업, 비밀 및 실행기의 쉼표로 구분된 목록이 포함됩니다. 이는 작업, 비밀 또는 실행기를 사용하는 워크플로를 결정하는 데 유용할 수 있으며, 보안 검토를 수행하는 데 유용할 수 있습니다.

잠재적 빌드 실행기 사용량 예측

이 forecast 명령으로 Jenkins 서버에서 완료된 파이프라인 실행의 메트릭을 계산하여 잠재적인 GitHub Actions 사용량을 예측할 수 있습니다.

예측 명령을 실행하기 위한 필수 사전 요소

Jenkins 인스턴스에 대해 forecast 명령을 실행하려면 Jenkins 서버에 paginated-builds 플러그인을 설치해야 합니다. 이 플러그인을 사용하면 GitHub Actions Importer 에서 빌드 수가 많은 작업에 대한 기록 빌드 데이터를 효율적으로 검색할 수 있습니다. Jenkins는 페이지를 매긴 빌드 데이터를 검색하는 방법을 제공하지 않으므로, 이 플러그인을 사용하면 많은 양의 기록 데이터를 가져올 때 발생할 수 있는 Jenkins 서버의 시간 제한을 방지할 수 있습니다. 이 paginated-builds 플러그인은 오픈 소스 REST API 엔드포인트를 노출하여 빌드 데이터를 한 번에 가져오는 대신 페이지에서 가져옵니다.

paginated-builds 플러그인 설치 방법:

  1. Jenkins 인스턴스에서 https://<your-jenkins-instance>/pluginManager/available로 이동합니다.
  2. paginated-builds 플러그인을 검색합니다.
  3. 왼쪽의 확인란을 선택하고 다시 시작하지 않고 설치를 선택합니다.

예측 명령 실행

잠재적인 GitHub Actions을(를) 예측하려면 터미널에서 다음 명령을 실행합니다. 기본적으로 GitHub Actions Importer은(는) 예측 보고서에 이전 7일을 포함합니다.

gh actions-importer forecast jenkins --output-dir tmp/forecast

예측 보고서 검사하기

지정된 출력 디렉터리의 forecast_report.md 파일에 예측 결과가 포함되어 있습니다.

다음은 예상 보고서에 표시될 수 있는 몇 가지 주요 용어입니다:

  • 작업 수는 완료된 작업의 총 개수입니다.
  • 파이프라인 수는 사용된 고유 파이프라인의 수입니다.
  • 실행 시간: 은 러너가 작업에 소비한 시간을 나타냅니다. 이 메트릭을 사용하여 GitHub호스티드 실행기의 비용을 계획하는 데 도움이 될 수 있습니다.
    • 이 메트릭은 GitHub Actions에 지출해야 하는 금액과 상관 관계가 있습니다. 해당 금액은 작업 시간(분) 동안 사용되는 하드웨어에 따라 달라집니다. GitHub Actions 가격 계산기를 사용하여 비용을 추정할 수 있습니다.
  • 큐 시간: 메트릭은 작업이 실행할 수 있는 러너를 기다리는 데 소요되는 시간을 나타냅니다.
  • 동시 작업 메트릭은 특정 시간에 실행 중인 작업의 양을 설명합니다. 이 메트릭을 사용하여 구성해야 하는 실행기 수를 정의할 수 있습니다.

또한 이러한 메트릭은 Jenkins의 각 실행기 큐에 따라 정의됩니다. 다양한 유형의 실행기 관련 메트릭을 볼 수 있으므로, 호스트된 실행기 또는 자체 호스팅 실행기 또는 높거나 낮은 사양의 컴퓨터가 혼합되어 있는 경우에 특히 유용합니다.

Jenkins 파이프라인의 마이그레이션 시험 실행

이 dry-run 명령을 사용하여 Jenkins 파이프라인을 해당 GitHub Actions 워크플로로 변환할 수 있습니다.

시험 실행 명령 실행

이 dry-run 명령을 사용하여 Jenkins 파이프라인을 해당 GitHub Actions 워크플로로 변환할 수 있습니다. 시험 실행은 지정된 디렉터리에 출력 파일을 만들지만 파이프라인을 마이그레이션하기 위한 끌어오기 요청을 열지 않습니다.

Jenkins 파이프라인을 GitHub Actions(으)로 마이그레이션하는 시험 실행을 위해서는 터미널에서 다음 명령을 실행하여 my-jenkins-project을(를) Jenkins 작업의 URL로 대체합니다.

gh actions-importer dry-run jenkins --source-url my-jenkins-project --output-dir tmp/dry-run

변환된 워크플로 점검

지정된 출력 디렉터리에서 드라이런 로그 및 변환된 워크플로 파일을 볼 수 있습니다.

GitHub Actions Importer이(가) 알 수 없는 빌드 단계 또는 부분적으로 성공한 파이프라인과 같이 자동으로 변환할 수 없는 항목이 있는 경우 변환 프로세스를 추가로 사용자 지정하는 사용자 지정 변환기를 만들 수 있습니다. 자세한 내용은 사용자 지정 변환기를 사용하여 GitHub Actions 가져오기 확장을(를) 참조하세요.

Jenkins 파이프라인의 생산 마이그레이션

이 migrate 명령을 사용하여 Jenkins 파이프라인을 동급의 GitHub Actions 워크플로로 변환할 수 있습니다.

마이그레이션 명령 실행

Jenkins 파이프라인을 GitHub Actions로 마이그레이션하려면 터미널에서 다음 명령을 실행하여 target-url 값을 GitHub 리포지토리의 URL로 바꾸고 my-jenkins-project를 Jenkins 작업의 URL로 바꿉니다.

gh actions-importer migrate jenkins --target-url https://github.com/:owner/:repo --output-dir tmp/migrate --source-url my-jenkins-project

명령의 출력에는 변환된 워크플로를 리포지토리에 추가하는 끌어오기 요청에 대한 URL이 포함됩니다. 성공적인 출력의 예는 다음과 유사합니다:

$ gh actions-importer migrate jenkins --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate --source-url http://localhost:8080/job/monas_dev_work/job/monas_freestyle
[2022-08-20 22:08:20] Logs: 'tmp/migrate/log/actions-importer-20220916-014033.log'
[2022-08-20 22:08:20] Pull request: 'https://github.com/octo-org/octo-repo/pull/1'

끌어오기 요청 검사하기

migrate 명령의 성공적인 실행의 출력에는 변환된 워크플로를 리포지토리에 추가하는 새 끌어오기 요청에 대한 링크가 포함되어 있습니다.

끌어오기 요청의 몇 가지 중요 요소는 다음과 같습니다.

  • 끌어오기 요청 설명에서 수동으로 완료해야 하는 단계를 나열하는 섹션은 파이프라인을 GitHub Actions로 마이그레이션을 완료할 수 있습니다. 예를 들어, 이 섹션에서는 워크플로에 사용되는 비밀을 만들도록 지시할 수 있습니다.
  • 변환된 워크플로 파일입니다. 끌어오기 요청에서 Files changed 탭을 선택하여 GitHub 리포지토리에 추가될 워크플로 파일을 봅니다.

끌어오기 요청 검사를 마치면 병합하여 워크플로를 GitHub 리포지토리에 추가할 수 있습니다.

참조

이 섹션에는 GitHub Actions Importer을(를) 사용하여 Jenkins에서 마이그레이션할 때의 환경 변수, 선택적 인수, 지원되는 구문에 대한 참조 정보가 포함되어 있습니다.

환경 변수 사용

GitHub Actions Importer은(는) 인증 구성에 환경 변수를 사용합니다. 이러한 변수는 configure 명령을 사용하여 구성 프로세스를 따르면 설정됩니다. 자세한 정보는