GitHub Actions × Laravel × Deployerで自動デプロイ

Github ActionsでLaravel製アプリケーションの自動デプロイを設定してみました。

前提 & やりたいこと

• 前提

  • サーバーはAWSを使用
  • GitHubにssh接続できる
  • AWS CLIのAccess key IDとSecret access keyが発行済み
  • AWS CLIのAccess key IDとSecret access key、セキュリティグループのidがactionsを設定するリポジトリのSettings -> Secretsに設定されている
  • Deployerで使うsshキーがactionsを設定するリポジトリのSettings -> Secretsに設定されている

• やりたいこと

  • 対象ブランチにプッシュされたら処理が動くようにしたい
  • PHP製デプロイツールのDeployerを使いたい
  • public IPの定期的な変更に対応したい

完成形

/.github/workflows/deploy.yml

name: deploy stg

on:
  push:
    branches: [対象ブランチ名]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: cache vendor
        id: cache
        uses: actions/cache@v1
        with:
          ref: 対象ブランチ名
          path: ./vendor
          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
          restore-keys: |
            ${{ runner.os }}-composer-

      - name: composer install
        if: steps.cache.outputs.cache-hit != 'true'
        run: composer install -n --prefer-dist

      - name: deploy dev
        env:
          ACCESS_KEY: ${{ secrets.AWS_ACCESS_KEY_ID }}
          SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY_ID }}
          SECURITY_GROUP: ${{ secrets.AWS_SECURITY_GROUP_ID }}
        run: |
          IP_ADDRESS=`curl -s https://api.ipify.org/`

          # AWS CLIインストール
          curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
          unzip awscliv2.zip
          sudo ./aws/install
          aws --version

          # AWS CLI設定
          printf "${ACCESS_KEY}\n${SECRET_ACCESS_KEY}\nap-northeast-1\njson\n" | aws configure --profile profileに設定したい名前
          aws configure get aws_access_key_id --profile profileの名前

          # セキュリティグループにルールを追加
          aws --profile profileの名前 ec2 authorize-security-group-ingress --group-id ${SECURITY_GROUP} --protocol tcp --port 22 --cidr "$IP_ADDRESS"/32

          # sshキーをコピー
          mkdir -p /home/runner/.ssh
          touch /home/runner/.ssh/Deployerで設定しているidentitiy file名
          echo "${{ secrets.SSH_DEPLOY_KEY }}" > /home/runner/.ssh/Deployerで設定しているidentitiy file名
          chmod 600 /home/runner/.ssh/Deployerで設定しているidentitiy file名

          # known_hostsに追加
          ssh-keyscan サーバーのIP >> ~/.ssh/known_hosts

          # deployerインストール
          curl -LO https://deployer.org/deployer.phar
          mv deployer.phar ./deployer/dep
          chmod +x ./deployer/dep

          # デプロイ
          cd ./deployer && ./dep deploy Deployerで設定しているステージ名 -vvv

          # セキュリティグループからルールを削除
          aws --profile profileの名前 ec2 revoke-security-group-ingress --group-id ${SECURITY_GROUP} --protocol tcp --port 22 --cidr "$IP_ADDRESS"/32

トリガー

対象ブランチへのプッシュをトリガーにする

on:
  push:
    branches: [対象ブランチ名]

対象ブランチにチェックアウト & vendor以下をキャッシュ

Composerをインストールするのは時間がかかるので、ここではキャッシュを使います

• actions/cache

# path: キャッシュしたいディレクトリorファイルへの絶対パス
# key: キャッシュする際のキー
# restore-keys: keyで指定したキーでキャッシュされたものが見つからなかった時に使われるキー
- uses: actions/checkout@v2
      - name: cache vendor
        id: cache
        uses: actions/cache@v1
        with:
          ref: 対象ブランチ名
          path: ./vendor
          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
          restore-keys: |
            ${{ runner.os }}-composer-

キャッシュされたものがなければcomposer installします

      - name: composer install
        if: steps.cache.outputs.cache-hit != 'true'
        run: composer install -n --prefer-dist

AWS CLI インストール & 設定 & セキュリティグループのルールにIPを追加

GitHub ActionsのIPからのssh接続を許可するために、セキュリティグループのルールを編集する必要があります。そのためにAWS CLIをインストールします。

• インストール
• 設定

設定時に必要なAccess key IDとSecret access key、後ほどセキュリティグループのルールを編集する際に必要になるgroup-idは対象リポジトリのSettings -> Secretsから取ってきます

        env:
          ACCESS_KEY: ${{ secrets.AWS_ACCESS_KEY_ID }}
          SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY_ID }}
          SECURITY_GROUP: ${{ secrets.AWS_SECURITY_GROUP_ID }}

公式ドキュメントに沿ってインストール, 設定, ルールの追加を行います

• インストール
• 設定
• セキュリティグループのルールに許可IPを追加

          # public IP 取得
          IP_ADDRESS=`curl -s https://api.ipify.org/`

          # AWS CLIインストール
          curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
          unzip awscliv2.zip
          sudo ./aws/install
          aws --version

          # AWS CLI設定
          printf "${ACCESS_KEY}\n${SECRET_ACCESS_KEY}\nap-northeast-1\njson\n" | aws configure --profile profileに設定したい名前
          aws configure get aws_access_key_id --profile profileの名前

          # セキュリティグループにルールを追加
          aws --profile profileの名前 ec2 authorize-security-group-ingress --group-id ${SECURITY_GROUP} --protocol tcp --port 22 --cidr "$IP_ADDRESS"/32

ssh設定

servers.ymlについては後述します。

          # sshキーをコピー
          mkdir -p /home/runner/.ssh
          touch /home/runner/.ssh/servers.ymlで設定しているidentitiy file名
          echo "${{ secrets.SSH_DEPLOY_KEY }}" > /home/runner/.ssh/servers.ymlで設定しているidentitiy file名
          chmod 600 /home/runner/.ssh/Dservers.ymlで設定しているidentitiy file名

          # known_hostsに追加
          ssh-keyscan サーバーのIP >> ~/.ssh/known_hosts

Deployerインストール & デプロイ

Deployerの設定

• Deployer
• Deployer 公式ドキュメント

hostの設定はservers.ymlというファイルに分けており、actions用に以下のように記述しています。
sshの設定で "servers.ymlで設定しているidentitiy file名" と書いてある部分は、以下のidentityFileに設定したファイル名です。

servers.yml

development:
  hostname: サーバーのIP
  stage: 任意のステージ名
  user: ユーザー名
  port: 22
  identityFile: /home/runner/.ssh/file_name
  deploy_path: デプロイパス
  branch: 対象ブランチ
  repository: [e-mail]:xxx/xxx.git

deploy.phpでは

deploy.php

inventory('./config/servers.yml');

のように呼び出しています。
actionsを使用する時のdeploy.phpの注意点ですが、git_ttyをfalseに設定しておいてください。

set('git_tty', false);

ただ、デフォルトでfalseになっているようなので、とくに何もなければ明示的に記述しなくても大丈夫そうです。

Deployerインストール & デプロイ

          # deployerインストール
          curl -LO https://deployer.org/deployer.phar
          mv deployer.phar ./deployer/dep
          chmod +x ./deployer/dep

          # デプロイ
          cd ./deployer && ./dep deploy servers.ymlで設定しているステージ名 -vvv

セキュリティグループのルールに追加したIPを削除

デプロイのためにssh接続を許可したIPをセキュリティグループから削除します

• セキュリティグループのルールから許可IPを削除

          # セキュリティグループからルールを削除
          aws --profile profileの名前 ec2 revoke-security-group-ingress --group-id ${SECURITY_GROUP} --protocol tcp --port 22 --cidr "$IP_ADDRESS"/32

これで終わりです

参考

• GitHubでssh接続する手順~公開鍵・秘密鍵の生成から~
• SSHのknown_hostsをスマートに更新する
• GithubのActionsでLaravelのデプロイ
• GitHub ActionsでEC2へのデプロイ自動化(CI/CD)
• cache アクション
• Github Actions でブランチの操作を行う
• actions/cache
• Configuring the AWS CLI
• Installing, updating, and uninstalling the AWS CLI version 2 on Linux
• Named profiles
• authorize-security-group-ingress
• revoke-security-group-ingress