GitHub Packages📦 (aka. Container Registry)

GitHub에서 제공하는 Docker Hub 같은 기능이다.
Docker image를 push 해서 저장하고, pull 받아서 사용할 수 있다

사용하게 된 계기

프로젝트에서 CI/CD를 구현할 때 DockerHub를 사용했었다.

그런데 DockerHub 무료 버전에서는 private image를 하나만 올릴 수 있고, 나머지는 public image로 올려야한다.

Public image로 올렸다고 해서 보안상으로 위험한지는 사실 잘 모르겠지만, 그래도 찜찜하긴 했다. GitHub에 올린 소스코드와는 달리, 바로 실행할 수 있는 build 된 파일이 공개되는 거니까!

그러다가 Github Packages의 Container registry를 알게 되었다.

Private image를 제한없이 올릴 수 있는 점도 좋았고, 어차피 CI/CD를 GitHub를 통해서 하고 있으니까 image 저장도 GitHub에 하는 게 응집도(?) 면에서도 더 좋을 것 같았다.

그래서 CI/CD에서 DockerHub 대신 Github Packages를 사용하는 것으로 바꾸었다.

그러면서 사용법도 간단히 정리해보았다.

사용 방법

1. Packages를 사용하기 위한 토큰(비밀번호 역할)을 만든다

https://github.com/settings/tokens/new?scopes=write:packages

read:packages

write:packages

delete:packages

이렇게 권한으로는 3개를 선택한다. (write:package 권한 선택 시 default로 repo 권한도 같이 선택되는데, 위 링크를 사용하면 우회할 수 있다)

2. Token을 이용해 로그인한다

export CR_PAT=토큰값
echo $CR_PAT | docker login ghcr.io -u 깃헙ID --password-stdin

• 여기서 깃헙 ID는 대/소문자를 구분해야한다!
• 그냥 docker login ghcr.io -u 깃헙ID -p 토큰값 으로 해도 로그인 되긴하는데, 보안상 위험하다는 경고 메시지가 뜬다
• GitHub Actions 에서 사용한다면 이렇게 쓰면 된다: echo ${{ secrets.토큰이름 }} | sudo docker login ghcr.io -u 깃헙ID --password-stdin
  

3. push할 이미지의 이름을 ghcr.io/.. 형식으로 바꿔준다

docker tag 원래이미지 ghcr.io/깃헙아이디/이미지명:태그명

ex: docker tag mysql:latest ghcr.io/honeysleepr/carrot_mysql:latest

• 여기서는 깃헙ID를 소문자로 적어야한다
• 애초에 이미지를 만들때 ghcr.io/.. 형식으로 만들었다면 4번으로 바로 넘어가자

4. GitHub Packages로 이미지를 push 한다.

docker push ghcr.io/깃헙아이디/이미지명:태그명

성공적으로 push가 됐다면 본인 깃헙 메인페이지의 Packages 탭에서 이미지를 확인할 수 있다.
https://github.com/honeySleepr?tab=packages

5. 사용하려는 곳에서 이미지를 pull 한다

docker pull ghcr.io/깃헙아이디/이미지명:태그명

• 이때 로그인이 되어있어야한다. (2단계 참고)

6. Docker 이미지를 실행한다

docker run ghcr.io/깃헙아이디/이미지명:태그명

끝!

📚 reference

https://blog.outsider.ne.kr/1530
docs.github.com/en/packages