패키지 레지스트리의 Conan 패키지

Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated Status: Experiment
caution
GitLab의 Conan 패키지 레지스트리는 제한된 기능으로 인해 프로덕션 환경에 사용하기에 준비되지 않았으며 개발 중입니다. 이 epic에는 프로덕션 환경으로 전환하기 위한 남은 작업 및 일정이 자세히 기술되어 있습니다.
note
Conan 레지스트리는 FIPS(Federal Information Processing Standard)와 호환되지 않으며 FIPS 모드가 활성화되면 사용이 중지됩니다.

프로젝트의 패키지 레지스트리에 Conan 패키지를 게시한 다음, 필요할 때마다 해당 패키지를 설치할 수 있습니다.

Conan 패키지를 패키지 레지스트리에 게시하려면 패키지 레지스트리를 원격으로 추가하고 인증합니다.

그런 다음 conan 명령을 실행하고 패키지를 패키지 레지스트리에 게시할 수 있습니다.

Conan 패키지 관리자 클라이언트가 사용하는 구체적인 API 엔드포인트에 대한 문서는 Conan API 문서를 참조하십시오.

Conan 패키지를 빌드하는 방법에 대해서는 Conan 패키지 빌드를 참조하십시오.

Conan 레지스트리를 Conan 원격으로 추가

conan 명령을 실행하려면 프로젝트나 인스턴스에 대해 Conan 레지스트리를 Conan 원격으로 추가해야 합니다. 그런 다음 패키지 레지스트리에 패키지를 게시하고 설치할 수 있습니다.

프로젝트용 원격 추가

프로젝트의 원격을 설정하여 모든 명령에 원격 이름을 지정하지 않고 프로젝트의 패키지를 사용할 수 있습니다.

프로젝트의 원격을 설정하면 패키지 이름에 제한은 없지만 명령에는 사용자 및 채널을 포함한 전체 레시피를 포함해야 합니다. 예: package_name/version@user/channel.

다음과 같이 원격을 추가합니다.

  1. 터미널에서 다음 명령을 실행합니다. 

    conan remote add gitlab https://gitlab.example.com/api/v4/projects/<project_id>/packages/conan

  2. Conan 명령 끝에 --remote=gitlab를 추가하여 해당 원격을 사용합니다.

    예: 

    conan search Hello* --remote=gitlab

인스턴스용 원격 추가

GitLab 인스턴스 전체에 걸쳐 패키지에 액세스하기 위해 하나의 원격을 사용합니다.

하지만 이 원격을 사용할 때 다음과 같은 패키지 이름 규칙을 따라야 합니다.

다음과 같이 원격을 추가합니다.

  1. 터미널에서 다음 명령을 실행합니다. 

    conan remote add gitlab https://gitlab.example.com/api/v4/packages/conan

  2. Conan 명령 끝에 --remote=gitlab를 추가하여 해당 원격을 사용합니다.

    예: 

    conan search 'Hello*' --remote=gitlab

인스턴스용 원격용 패키지 레시피 이름 규칙

표준 Conan 레시피 규칙은 package_name/version@user/channel이지만 인스턴스용 원격을 사용하는 경우 user 레시피는 플러스 기호(+)로 구분된 프로젝트 경로여야 합니다.

레시피 예시:

프로젝트 패키지 지원 여부
foo/bar my-package/1.0.0@foo+bar/stable 예
foo/bar-baz/buz my-package/1.0.0@foo+bar-baz+buz/stable 예
gitlab-org/gitlab-ce my-package/1.0.0@gitlab-org+gitlab-ce/stable 예
gitlab-org/gitlab-ce my-package/1.0.0@foo/stable 아니요

프로젝트 원격은 더 유연한 이름 규칙을 가지고 있습니다.

패키지 레지스트리에 인증

GitLab은 패키지를 업로드하고 개인 및 내부 프로젝트에서 패키지를 설치하려면 인증이 필요합니다. (그러나 공개 프로젝트에서는 인증 없이 패키지를 설치할 수 있습니다.)

패키지 레지스트리에 인증하려면 다음 중 하나가 필요합니다.

note
인증되지 않은 경우 개인 및 내부 프로젝트에서 온 패키지는 숨겨집니다. 따라서 인증되지 않고 개인 또는 내부 프로젝트에서 패키지를 검색하거나 다운로드하려고 하면 Conan 클라이언트에서 unable to find the package in remote 오류가 발생합니다.

GitLab 원격지에 자격 증명 추가

귀하는 모든 Conan 명령에 토큰을 명시적으로 추가할 필요가 없도록 GitLab 원격지에 토큰을 연결할 수 있습니다.

필수 조건:

터미널에서 다음 명령을 실행합니다. 이 예에서의 원격 이름은 gitlab입니다. 귀하의 원격 이름을 사용하십시오. 

conan user <gitlab_username 또는 deploy_token_username> -r gitlab -p <개인_액세스_토큰 또는 deploy_token>

이제 --remote=gitlab로 명령을 실행할 때 귀하의 사용자 이름과 암호가 요청에 포함됩니다.

참고: GitLab과의 권한 부여가 정기적으로 만료되므로 가끔 개인 액세스 토큰을 다시 입력해야 할 수 있습니다.

프로젝트에 대한 기본 원격지 설정(선택 사항)

특정 원격지를 지정하지 않고 GitLab 패키지 레지스트리와 상호 작용하려면 Conan에게 항상 해당 패키지 레지스트리를 사용하도록 지시할 수 있습니다.

터미널에서 다음 명령을 실행합니다. 

conan remote add_ref Hello/0.1@mycompany/beta gitlab

참고: 패키지 레시피에는 버전이 포함되어 있으므로 Hello/0.1@user/channel의 기본 원격지는 Hello/0.2@user/channel에 대해 작동하지 않습니다.

기본 사용자 또는 원격지를 설정하지 않은 경우에도 명령에 사용자와 원격지를 포함할 수 있습니다. 

`CONAN_LOGIN_USERNAME=<gitlab_username or deploy_token_username> CONAN_PASSWORD=<personal_access_token or deploy_token> <conan command> --remote=gitlab

Conan 패키지 게시

Conan 패키지를 패키지 레지스트리에 게시하여 프로젝트에 액세스할 수 있는 누구나 해당 패키지를 의존성으로 사용할 수 있도록 합니다.

필수 조건:

패키지를 게시하려면 conan upload 명령을 사용합니다. 

conan upload Hello/0.1@mycompany/beta --all

CI/CD를 사용하여 Conan 패키지 게시

  • GitLab 12.7에서 소개.
  • GitLab Premium에서 GitLab Free로 13.3에서 이동.

GitLab CI/CD에서 Conan 명령을 사용하려면 명령에서 개인 액세스 토큰 대신 CI_JOB_TOKEN을 사용할 수 있습니다.

.gitlab-ci.yml 파일에 각 Conan 명령에 CONAN_LOGIN_USERNAME 및 CONAN_PASSWORD를 제공할 수 있습니다. 예: 

image: conanio/gcc7

create_package:
  stage: deploy
  script:
    - conan remote add gitlab ${CI_API_V4_URL}/projects/$CI_PROJECT_ID/packages/conan
    - conan new <package-name>/0.1 -t
    - conan create . <group-name>+<project-name>/stable
    - CONAN_LOGIN_USERNAME=ci_user CONAN_PASSWORD=${CI_JOB_TOKEN} conan upload <package-name>/0.1@<group-name>+<project-name>/stable --all --remote=gitlab
  environment: production

CI 파일의 기초가 되는 추가적인 Conan 이미지는 Conan docs에서 확인할 수 있습니다.

동일한 레시피로 패키지 다시 게시

기존 패키지와 동일한 레시피(package-name/version@user/channel)를 가진 패키지를 게시하면 중복 파일이 성공적으로 업로드되어 UI를 통해 액세스할 수 있습니다. 그러나 패키지를 설치하면 가장 최근에 게시된 패키지만 반환됩니다.

Conan 패키지 설치

패키지 레지스트리에서 Conan 패키지를 설치하여 의존성으로 사용할 수 있습니다. 패키지를 인스턴스 또는 프로젝트 범위에서 설치할 수 있습니다. 동일한 레시피를 가진 여러 패키지가 있는 경우 가장 최근에 게시된 패키지가 검색됩니다.

Conan 패키지는 종종 conanfile.txt 파일을 사용하여 의존성으로 설치됩니다.

필수 조건:

  • Conan 원격지는 Conan 원격지로 설정되어 있어야 합니다.
  • 비공개 및 내부 프로젝트의 경우 패키지 레지스트리와의 인증을 구성해야 합니다.
  1. 패키지를 의존성으로 설치하려는 프로젝트에서 conanfile.txt를 엽니다. 또는 프로젝트의 루트에 conanfile.txt라는 파일을 만듭니다.

  2. 파일의 [requires] 섹션에 Conan 레시피를 추가합니다. 

    [requires]
Hello/0.1@mycompany/beta

[generators]
cmake

  3. 프로젝트의 루트에서 build 디렉토리를 만들고 해당 디렉토리로 이동합니다. 

    mkdir build && cd build

  4. conanfile.txt에 나열된 의존성을 설치합니다. 

    conan install .. <options>

참고: 이 튜토리얼에서 만든 패키지를 설치하려고 하면 해당 패키지가 이미 존재하기 때문에 설치 명령에 영향을 미치지 않습니다. 캐시에 저장된 패키지를 정리하기 위해 ~/.conan/data를 삭제하세요.

Conan 패키지 제거

GitLab 패키지 레지스트리에서 Conan 패키지를 제거하는 두 가지 방법이 있습니다.

  • 명령 줄을 사용하여 Conan 클라이언트를 통해: 

    conan remove Hello/0.2@user/channel --remote=gitlab

    이 명령에 원격지를 명시적으로 포함해야만 로컬 시스템 캐시에서만 패키지가 제거되는 것을 방지할 수 있습니다.

    참고: 이 명령은 패키지 레지스트리에서 모든 레시피 및 이진 패키지 파일을 제거합니다.

  • GitLab 사용자 인터페이스에서:

    프로젝트의 배포 > 패키지 레지스트리로 이동합니다. 패키지를 선택해 저장소 제거를 클릭하세요 ().

패키지 레지스트리에서 Conan 패키지 검색

전체 또는 부분적인 패키지 이름 또는 정확한 레시피로 검색하려면 conan search 명령을 실행하세요.

  • 특정 패키지 이름을 가진 모든 패키지를 검색하려면: 

    conan search Hello --remote=gitlab

  • He로 시작하는 모든 패키지와 같은 부분적인 이름을 검색하려면: 

    conan search He* --remote=gitlab

검색 범위는 Conan 원격지 구성에 따라 달라집니다:

  • 인스턴스용 원격지를 구성한 경우(인스턴스용 원격지 추가), 검색은 권한이 있는 모든 프로젝트를 포함합니다. 이는 개인 프로젝트와 모든 공개 프로젝트를 포함합니다.
  • 프로젝트용 원격지를 구성한 경우(프로젝트용 원격지 추가), 해당 프로젝트의 모든 패키지를 포함합니다. 단, 해당 프로젝트에 액세스할 수 있는 경우에 한합니다.

참고: 검색 결과의 제한은 500개의 패키지이며, 결과는 최근에 게시된 패키지를 기준으로 정렬됩니다.

패키지 레지스트리에서 Conan 패키지 정보 가져오기

conan info 명령은 패키지에 대한 정보를 반환합니다: 

conan info Hello/0.1@mycompany/beta

지원되는 CLI 명령어

GitLab Conan 리포지토리에서는 다음과 같은 Conan CLI 명령어를 지원합니다:

  • conan upload: 레시피 및 패키지 파일을 패키지 레지스트리에 업로드합니다.
  • conan install: 패키지 레지스트리에서 Conan 패키지를 설치합니다. 이는 conanfile.txt 파일 사용을 포함합니다.
  • conan search: 패키지 레지스트리에서 공개 패키지 및 보기 권한이 있는 개인 패키지를 검색합니다.
  • conan info: 패키지 레지스트리의 특정 패키지에 대한 정보를 확인합니다.
  • conan remove: 패키지 레지스트리에서 패키지를 삭제합니다.

문제 해결

자세한 출력 설정

Conan 문제 해결 시 더 자세한 출력을 위해서: 

export CONAN_TRACE_FILE=/tmp/conan_trace.log # Or SET in windows
conan <command>

Conan documentation에서 더 많은 로깅 팁을 찾을 수 있습니다.

SSL 오류

자체 서명된 인증서를 사용하는 경우 Conan의 SSL 오류를 관리하는 두 가지 방법이 있습니다:

  • conan remote 명령을 사용하여 SSL 확인을 비활성화합니다.
  • 서버 crt 파일을 cacert.pem 파일에 추가합니다.

Conan Documentation에서 자세히 알아보세요.