チュートリアルLast Updated Oct 28, 202610 分 READ

Amazon ECR へのプライベート Docker イメージの自動デプロイ

Dominic Motuka

Andela、DevOps エンジニア

この記事では、自動化された CI/CD パイプラインを使って、本番環境向けの Docker イメージをビルドし、保管先の Amazon Elastic Container Registry (ECR) にプッシュする方法を紹介します。

このチュートリアルを進めるには、CircleCI の無料アカウントと AWS アカウントが必要です。

Amazon ECR とは

Amazon ECR は、フルマネージドのプライベート Docker コンテナレジストリです。開発者は Docker コンテナイメージを簡単に保存、管理、デプロイできます。Amazon ECR は、Amazon Elastic Container Service (Amazon ECS) や Amazon Elastic Kubernetes Service (Amazon EKS) とシームレスに連携します。ほかのクラウドベンダーと組み合わせて使うこともできます。

Amazon ECR のようなプライベート Docker レジストリを使う理由

  • 多くの場合、開発、テスト、本番の各レジストリを分けておくことが望まれます。
  • フルマネージドなので、独自のコンテナリポジトリを運用したり、基盤となるインフラストラクチャのスケーリングを気にしたりする必要がありません。
  • セキュアです。スキャン機能とロールベースのアクセス制御を備えたプライベートコンテナレジストリは、セキュリティ、ガバナンス (IAM)、管理の効率を高めます。コンテナイメージは HTTPS で転送され、保存時には自動的に暗号化されます。
  • コンテナを実行するシステムの近くでレジストリを運用すると、デプロイの遅延が短くなり、ネットワーク障害の影響も受けにくくなります。

開発者は、アプリケーション開発の過程で作成したイメージをレジストリに保存します。継続的インテグレーションのパイプラインを使えば、コンテナイメージのビルドから、そのアーティファクトを Amazon ECR にプッシュするまでのプロセスを自動化でき、開発をより速く効率的に進められます。

たとえば、コミットをプッシュすると CircleCI でビルドがトリガーされ、新しいイメージが Amazon ECR にプッシュされるパイプラインを考えてみましょう。Amazon ECR は Amazon EventBridge のイベントを発行してデプロイをトリガーできるため、手動の手順は一切必要ありません。

レジストリを使うと、このような完全に自動化されたパイプラインをずっと簡単に構築できます。レジストリに保存されたコンテナイメージは、開発のさまざまな段階で利用できます。

これから、いくつかの手順で、シンプルな Node.js アプリケーションをコンテナ化し、イメージをビルドして Amazon ECR にプッシュするまでを、自動化された CircleCI のワークフローで行います。パイプラインの設定を最小限でわかりやすく保つために、CircleCI の Orb を使います。

Amazon ECR のセットアップ

AWS マネジメントコンソールで IAM を選択します。IAM は、AWS リソースへのアクセスを管理するためのサービスです。

IAM コンソールで IAM users に移動し、Create user をクリックします。ここでは ci-cd-ecr という名前にしましたが、どのような名前でもかまいません。

IAM の Create user ウィザードの Specify user details ステップ。ユーザー名に ci-cd-ecr が入力されている

次に、ユーザーの権限を設定します。Attach policies directly をクリックし、AmazonEC2ContainerRegistryFullAccess を選択します。このポリシーにより、パイプラインはイメージ用のプライベートリポジトリを作成し、そこにイメージをプッシュできるようになります。本番環境のパイプラインでは、パイプラインに必要な Amazon ECR のアクションだけを許可するカスタムポリシーの利用を検討してください。

Attach policies directly を選択し、絞り込んだポリシー一覧で AmazonEC2ContainerRegistryFullAccess だけにチェックを入れた Set permissions ステップ

最後に、内容を確認して Create user をクリックします。

新しいユーザーがプログラムから AWS リソースにアクセスできるようにするには、アクセスキーを作成する必要があります。新しいユーザーのユーザー名をクリックし、Security credentials タブを開いて、Create access key をクリックします。Access key best practices & alternatives ページで Other を選択し、Next をクリックします。必要に応じて説明タグを追加し、Create access key をクリックします。

ci-cd-ecr ユーザーの Access key best practices and alternatives ページ。ユースケースとして Other が選択されている

完了すると、シークレットアクセスキーを表示またはダウンロードできるのはこのときだけであることを示すバナーとともに、ユーザーの認証情報が表示されます。このページは一度しか表示されないため、後で使う Access key と Secret access key を控えておいてください。または、同じ認証情報が含まれた .csv ファイルをダウンロードすることもできます。

Retrieve access keys ページ。新しいアクセスキー ID、Show リンク付きでマスクされたシークレットアクセスキー、Download .csv file ボタンが表示されている

注: 長期間有効なアクセスキーを使うのが、最も手早く始められる方法です。本番環境のパイプラインでは、代わりに OpenID Connect (OIDC) の利用を検討してください。OIDC を使うと、AWS のキーを保存しなくても、CircleCI が IAM ロールを引き受けられます。

AWS-ECR Orb を使った CircleCI パイプラインのセットアップ

このデモのコードは GitHub で公開しています。次のコマンドでアプリケーションをクローンします。

git clone https://github.com/CIRCLECI-GWP/circleci-ecr-app-demo

.circleci/ フォルダーにある CircleCI の config.yml ファイルを見てみましょう。これから見ていくように、Orb を使えば、わずか 16 行の設定でイメージをビルドして Amazon ECR にプッシュできます。aws-ecr Orb には、次の処理を行うコマンドがあらかじめ用意されています。

  • イメージのビルド
  • Amazon ECR へのログイン
  • Amazon ECR リポジトリの作成 (存在しない場合)
  • Amazon ECR へのイメージのプッシュ

パイプラインの設定全体は次のとおりです。

version: 2.1

orbs:
  aws-cli: circleci/aws-cli@5.4.2
  aws-ecr: circleci/aws-ecr@10.0.0

workflows:
  build_and_push_image:
    jobs:
      - aws-ecr/build_and_push_image:
          context: aws-dev
          auth:
            - aws-cli/setup
          create_repo: true
          dockerfile: Dockerfile
          path: .
          repo: circleci-ecr-app-demo
          tag: "$CIRCLE_SHA1"

この設定ファイルでは、Amazon Elastic Container Registry Orb を使って Docker イメージをビルドし、デプロイします。auth ステップでは、AWS CLI Orb の aws-cli/setup コマンドを使って、aws-ecr Orb が Amazon ECR にログインする前に、コンテキストから AWS の認証情報を設定します。dockerfile: では、Dockerfile のパスを指定します。デモのリポジトリでは、次の Dockerfile を使っています。

# Set the base image to use for subsequent instructions
FROM node:24-alpine

# Add metadata to an image
LABEL app="simple-node-application"
# Directive to set environmental variables key to value pair
ENV NPM_CONFIG_LOGLEVEL=warn

# Set the working directory for any subsequent ADD, COPY, CMD, ENTRYPOINT,
# or RUN instructions that follow it in the Dockerfile
WORKDIR /usr/src/app

# Copy files or folders from source to the dest path in the image's filesystem.
COPY package.json /usr/src/app/
COPY . /usr/src/app/

# Execute any commands on top of the current image as a new layer and commit the results.
RUN npm install --omit=dev

# Define the network ports that this container will listen on at runtime.
EXPOSE 3000

# Configure the container to be run as an executable.
ENTRYPOINT ["npm", "start"]

Amazon ECR 用の認証情報と環境変数の追加

CircleCI のコンテキストを使うと、認証情報を安全に保存し、プロジェクト間で共有できます。コンテナイメージをデプロイするには AWS の認証情報が必要なので、まずコンテキストをセットアップします。

CircleCI のダッシュボードで、サイドバーの Org をクリックして組織の設定を開きます。次に、Contexts を選択します。Create context をクリックし、コンテキストに一意の名前を付けます。作成したコンテキストは、Security が All members に設定された状態で一覧に表示されます。これは、組織内の誰もが実行時にこのコンテキストにアクセスできることを示しています。このチュートリアルの .circleci/config.yml で指定しているとおり、コンテキスト名は aws-dev にする必要があります。

コンテキスト名に aws-dev を入力した CircleCI の Create Context ダイアログ

次に、aws-dev コンテキストを選択します。

Environment variables セクションで Add をクリックします。このコンテキストに関連付ける変数名と値を入力し、ダイアログの Add environment variable をクリックして保存します。aws-dev コンテキストには、次の 4 つの環境変数が必要です。

  • AWS_ACCESS_KEY_ID: 先ほど作成した IAM ユーザー ci-cd-ecr の AWS アクセスキー ID
  • AWS_SECRET_ACCESS_KEY: 先ほど作成した IAM ユーザー ci-cd-ecr の AWS シークレットアクセスキー
  • AWS_ACCOUNT_ID: ECR レジストリを所有する AWS アカウントの 12 桁の ID
  • AWS_DEFAULT_REGION: ECR のリソースを配置する AWS リージョン (例: us-east-2)

AWS_ACCESS_KEY_ID、AWS_ACCOUNT_ID、AWS_DEFAULT_REGION、AWS_SECRET_ACCESS_KEY がマスクされた値で一覧表示された aws-dev コンテキストのページ

注: $CIRCLE_SHA1 は、すべての CircleCI プロジェクトで使えるデフォルトの変数なので、設定する必要はありません。これは、現在のビルドの最後のコミットの SHA1 ハッシュです。Git のコミットハッシュを使うと、コンテナの中身を追跡できます。理想的には、コンテナから Docker イメージへ、さらにその Dockerfile とイメージに含まれるコードへとさかのぼれます。自動化された実行環境では、Docker イメージがビルドされるきっかけとなったコミットまでたどることができます。

アプリケーションと CircleCI の接続

次に、GitHub にリポジトリをセットアップし、プロジェクトを CircleCI にリンクします。手順については、プロジェクトを GitHub にプッシュする方法 (英語) をご覧ください。

CircleCI にログインし、Create project をクリックします。プロジェクト名を入力して Next をクリックします。Create your first pipeline で、求められたら GitHub を接続し、リポジトリ (この例では circleci-ecr-app-demo) を選択します。デフォルトのパイプライン名と All pushes トリガーはそのままにして、Next をクリックします。CircleCI は、リポジトリにすでにある .circleci/config.yml ファイルを検出します。Next をクリックし、セットアップ内容を確認して Go to project をクリックします。

Pipeline ステップの CircleCI Create a project フロー。circleci-ecr-app-demo リポジトリと All pushes トリガーが選択されている

組織でまだ CircleCI GitHub OAuth アプリを使っている場合は、その連携方法に合わせたプロジェクトの作成の手順に従ってください。

GitHub App のフローでは、次にプッシュしたときにパイプラインが実行されるので、リポジトリにコミットをプッシュして開始します。最初のワークフローが実行され、正常に完了します。

CircleCI で成功した aws-ecr/build_and_push_image ジョブ。Spin up environment から Build Docker Image with buildx まで、すべてのステップが緑色になっている

これで、プロジェクトを更新するたびに、CI パイプラインが自動的に新しいイメージをビルドして ECR にプッシュします。リポジトリの情報を確認するには、AWS マネジメントコンソールにアクセスしてください。

まとめ

CircleCI と Amazon ECR の両方の設定が完了したので、イメージをビルドしてリポジトリにプッシュできるようになりました。

わずか数行のコードで、Docker イメージをビルドして Amazon ECR にプッシュできました。CircleCI の Orb を使うと、ビルド済みのコマンド、ジョブ、Executor を CircleCI の設定ファイルにインポートできるため、時間を節約しながら、クラウドサービスやその他のツールと簡単に連携できます。