Dockerレジストリの利用

Dockerサポートについて

Dockerイメージをインストールあるいは公開する際に、Dockerレジストリは現在Windowsイメージのような外部レイヤーをサポートしません。

Docker Engine v25 は、GitHub Enterprise Server の Docker レジストリと互換性がありません。 代わりに Container registry を使用することをお勧めします。 移行については、「Dockeerレジストリからコンテナレジストリへの移行」を参照してください。

GitHub Packages への認証を行う

非公開パッケージ、内部パッケージ、公開パッケージを発行、インストール、削除するには、アクセス トークンが必要です。

GitHub Packages、あるいは GitHub API で認証を受けるのに、personal access token (classic) を利用できます。 personal access token (classic) を作成するときは、必要に応じてさまざまなスコープをトークンに割り当てることができます。 personal access token (classic) のパッケージ関連のスコープについては、「GitHub Packagesの権限について」を参照してください。

GitHub Actionsワークフロー内でGitHub Packagesレジストリに認証を受けるには、以下の方法が使えます。

• GITHUB_TOKEN では、ワークフロー リポジトリに関連付けられているパッケージを発行します。
• 他のプライベート リポジトリに関連付けられたパッケージをインストールするために、少なくとも read:packages スコープが設定された personal access token (classic) (リポジトリにパッケージへの読み取りアクセス権が付与されている場合は、GITHUB_TOKEN を使用できます)。 「パッケージのアクセス制御と可視性の設定」を参照してください)。

GitHub Actions ワークフローで使われる GITHUB_TOKEN の詳細については、「自動トークン認証」を参照してください。

personal access token で認証を行う

GitHub Packages でパッケージを発行およびインストールするには、適切なスコープで personal access token (classic) を使う必要があります。 詳しくは、「GitHub Packages の概要」をご覧ください。

docker login コマンドを使い、Docker で GitHub Packages の認証を受けることができます。

資格情報のセキュリティ保護を保つため、personal access tokenは自分のコンピューターのローカル ファイルに保存し、ローカル ファイルからトークンを読み取る Docker の --password-stdin フラグを使うことをお勧めします。

インスタンスのサブドメイン分離が有効な場合:

cat ~/TOKEN.txt | docker login docker.HOSTNAME -u USERNAME --password-stdin

インスタンスのサブドメイン分離が無効になっている場合:

cat ~/TOKEN.txt | docker login HOSTNAME -u USERNAME --password-stdin

このログイン コマンドの例を使うには、USERNAME を GitHub のユーザー名に、HOSTNAME を お使いの GitHub Enterprise Server インスタンス の URL に、~/TOKEN.txt を GitHub の personal access token へのファイル パスに置き換えます。

詳細については、Docker ログインに関するページを参照してください。

イメージを公開する

GitHub Packages は、リポジトリごとに複数の最上位 Docker イメージをサポートしています。 リポジトリは任意の数のイメージタグを持つことができます。 10GB以上のDockerイメージの公開やインストールの際には、サービスのパフォーマンスが低下するかもしれず、各レイヤーは5GBが上限です。 詳細については、Docker ドキュメントの「Docker tag」(Docker タグ) を参照してください。

パッケージを公開した後は、GitHub上でそのパッケージを見ることができます。 詳しくは、「パッケージの表示」をご覧ください。

1. docker images を使って、Docker イメージのイメージ名と ID を確認してください。

   $ docker images
   > <&nbsp>
   > REPOSITORY        TAG        IMAGE ID       CREATED      SIZE
   > IMAGE_NAME        VERSION    IMAGE_ID       4 weeks ago  1.11MB
   

2. Docker イメージ ID を使って Docker イメージにタグを付けます。OWNER はリポジトリを所有する個人用アカウントまたは organization の名前に、REPOSITORY はプロジェクトを含むリポジトリの名前に、IMAGE_NAME はパッケージまたはイメージの名前に、HOSTNAME は お使いの GitHub Enterprise Server インスタンス のホスト名に、VERSION はビルド時のパッケージのバージョンに置き換えます。

   インスタンスのサブドメイン分離が有効な場合:

   docker tag IMAGE_ID docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION
   

   インスタンスのサブドメイン分離が無効になっている場合:

   docker tag IMAGE_ID HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION
   

3. パッケージの Docker イメージをまだ構築していない場合は、イメージをビルドします。OWNER はリポジトリを所有する個人用アカウントまたは organization の名前に、REPOSITORY はプロジェクトが含まれるリポジトリの名前に、IMAGE_NAME はパッケージまたはイメージの名前に、VERSION はビルド時のパッケージのバージョンに、HOSTNAME は お使いの GitHub Enterprise Server インスタンス のホスト名に、現在の作業ディレクトリにない場合は PATH をイメージに置き換えます。

   インスタンスのサブドメイン分離が有効な場合:

   docker build -t docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH
   

   インスタンスのサブドメイン分離が無効になっている場合:

   docker build -t HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH
   

4. GitHub Packagesにイメージを公開してください。

   インスタンスのサブドメイン分離が有効な場合:

   docker push docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION
   

   インスタンスのサブドメイン分離が無効になっている場合:

   docker push HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION
   

   Note

   イメージのプッシュは IMAGE_NAME:SHA を使うのではなく、IMAGE_NAME:VERSION を使って行ってください。

Dockerイメージのプッシュの例

これらの例では、インスタンスのサブドメイン分離が有効であることを前提としています。

monalisa イメージのバージョン 1.0 を、イメージ ID を使って octocat/octo-app に公開できます。

$ docker images

> REPOSITORY           TAG      IMAGE ID      CREATED      SIZE
> monalisa             1.0      c75bebcdd211  4 weeks ago  1.11MB

# Tag the image with OWNER/REPO/IMAGE_NAME
$ docker tag c75bebcdd211 docker.HOSTNAME/octocat/octo-app/monalisa:1.0

# Push the image to GitHub Packages
$ docker push docker.HOSTNAME/octocat/octo-app/monalisa:1.0

新しい Docker イメージを初めて公開し、monalisa という名前にできます。

# Build the image with docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION
# Assumes Dockerfile resides in the current working directory (.)
$ docker build -t docker.HOSTNAME/octocat/octo-app/monalisa:1.0 .

# Push the image to GitHub Packages
$ docker push docker.HOSTNAME/octocat/octo-app/monalisa:1.0

画像のダウンロード

docker pull コマンドを使って、GitHub Packages から Docker イメージをインストールできます。OWNER はリポジトリを所有する個人用アカウントまたは organization の名前に、REPOSITORY はプロジェクトを含むリポジトリの名前に、IMAGE_NAME はパッケージまたはイメージの名前に、HOSTNAME は お使いの GitHub Enterprise Server インスタンス のホスト名に、TAG_NAME はインストールするイメージのタグに置き換えます。

インスタンスのサブドメイン分離が有効な場合:

docker pull docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME

インスタンスのサブドメイン分離が無効になっている場合:

docker pull HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME

参考資料

• パッケージを削除および復元する