[Github]Github ActionsでDockerイメージをAWSのECRリポジトリにプッシュする方法

普段ソースコードはGithubで管理しているんですが、AWSのCodePipelineを使用した開発でAWSのECRにGithubのソースコードをdocker buildしてイメージをプッシュしてたんですが、毎回手作業は面倒臭いんで、Github Actionsを使って自動化してみました。

Github Actionsについてはこちらを見てもらえればと思います。

Actions

GitHub Actionsを使用することで、高機能のCI / CDですべてのソフトウェアワークフローを簡単に自動化できます。 GitHubから直接コードをビルド、テスト、デプロイします。コードレビュー、ブランチ管理、問題のトリアージを希望どおりに機能させます。

AWS ECRはコンテナソフトウェアをどこにでも簡単に保存、共有、デプロイできるAWSのサービスです。

Amazon ECR（Docker イメージの保存と取得）| AWS

Amazon Elastic Container Registry (ECR) は、フルマネージド Docker コンテナレジストリです。このレジストリを使うと、コンテナイメージを簡単に保存、共有、デプロイできます。

前提条件
AWS側の作業
1. AWS ECRにプッシュすることができる権限を持つユーザを作成する
2. AWS ECRにリポジトリを作成する
Github側の作業
Dockerイメージをプッシュする
AWS ECR確認
最後に

前提条件

今回は既にDockerfileは作成済みとします。

Dockerfileの作成方法が分からない方は以下の記事を参考にしてもらえればと思います。

[golang][Echo]Dockerfileの作り方

Go言語のWebアプリケーションフレームワークであるEchoで作成したプロジェクトでDockerfileを作成してみまし...

[NuxtJS]Dockerfileの作り方

NuxtJSで作成したプロジェクトでDockerfileを作成してみました。その時のDockerfileをメモしてお...

AWS側の作業

AWS ECRにプッシュすることができる権限を持つユーザを作成する

AWS ECRにプッシュすることができる権限を持つユーザを作成します。

AWS IAMのユーザーページにアクセスし、ユーザーを追加をクリックしします。

ユーザ名を入力し、AWS 認証情報タイプを選択でアクセスキー – プログラムによるアクセスを選択し、次のステップ：アクセス権限をクリックします。

アクセス許可の設定で既存のポリシーを直接アタッチを選択し、AmazonEC2ContainerRegistryFullAccessにチェックを入れて次のステップ：タグをクリックします。

今回はとりあえず、AWS ECRに対して全権限を持っているAmazonEC2ContainerRegistryFullAccessを選択しましたが、ここは必要に応じて権限を弱くしても良いです。最低限AWS ECRにプッシュできればどんな権限設定でも良いと思います。

タグの追加画面では特に入力することはないので、そのまま次のステップ：確認をクリックします。

確認画面で設定内容を確認し、問題なければユーザーの作成をクリックします。

ユーザー追加できました。

この画面で表示されているアクセスキーIDとシークレットアクセスキーは後で使うので忘れずにメモしておきましょう。

AWS ECRにリポジトリを作成する

Github Actionsでプッシュしたイメージを保存するリポジトリを作成します。

Amazon ECRのリポジトリ画面から今回はプライベートリポジトリを作成します。

リポジトリを作成をクリックしてリポジトリ作成画面を開きます。

リポジトリ名を入力し、リポジトリを作成をクリックし、リポジトリを作成します。

いろいろ設定はありますが、基本デフォルトのままで良いと思います。

Github側の作業

Github Actions作成

Github Actionsを作成します。

Githubのリポジトリの画面からActionsをクリックするといろんな雛形が表示されますが、今回は雛形を使用しないので、set up a workflow yourselfのリンクをクリックし、自分で最初からファイルを作成します。

push-ecr.yml作成

name: Push ECR

on:
  push:
    branches: [ main ]

jobs:

  build-and-push:
    # The type of runner that the job will run on
    runs-on: ubuntu-latest

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
      - uses: actions/checkout@v3

      - name: Configure AWS Credentials
        uses: aws-actions/configure-aws-credentials@v1
        with:
          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
          aws-region: ap-northeast-1

      - name: Login to Amazon ECR
        id: login-ecr
        uses: aws-actions/amazon-ecr-login@v1

      - name: Build, tag, and push image to Amazon ECR
        env:
          ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
          ECR_REPOSITORY: ${{ secrets.AWS_ECR_REPO_NAME }}
        run: |
          docker build -t $ECR_REGISTRY/$ECR_REPOSITORY:latest .
          docker push $ECR_REGISTRY/$ECR_REPOSITORY:latest

下記のsecretsの値は別途設定が必要です。