_ Azure Web Apps にLaravelをデプロイするカスタムデプロイの作成方法

今のプロジェクトで、Laravelでアプリケーションを開発していて、それをAzure Web Apps 上で動かしている。公式のドキュメントでは、Composer Extensionを使って、デプロイした後にcomposer install が自動的に実行するようにしている。けれども、これは下記の観点からオススメしない。

1. デプロイ時に実行される処理を変更できない。
2. インストールされるcomposerのバージョンが、Composer Extensionをインストールした時点での最新。

1については、Composer Extensionがデプロイ時に実行されるスクリプトを上書きしてしまうため、カスタムデプロイを実装できないことを言っている。2は、composerやphpのバージョンの組み合わせで発生する問題がある場合、デプロイ時に混乱する恐れがある。

また、Laravelのアプリをプロダクションとしてデプロイする場合、パフォーマンスを最適化するためのコマンドが用意されているので、それをデプロイ時に実行したい。

ということで、Azure Web Appへのデプロイ時にそういったお好みのコマンドを実行できるようにカスタムデプロイを準備する方法を書きます。

Composer をアプリのリポジトリにインストール

Composer はpharファイル（圧縮されたphp）で配布されているので、それをリポジトリ内にインストールする。上で書いたように、Composer Extensionを利用するとそもそもカスタムデプロイが実行できないため、自前で持つ必要がある。

cd /path/to/your/laravelapp/
mkdir bin
php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
php composer-setup.php --install-dir=bin --filename=composer
git add -A
git commit -m 'Install composer'

Azure Portalからデプロイ先のWeb AppにKuduで入り、コンソールでインストールしても構わない。Slotを利用したデプロイをする場合、Slot作成時に毎度インストール作業が発生するので注意が必要だ。

カスタムデプロイのスクリプトを作成

ゼロから書く必要は無く、npmでKuduScriptコマンドをインストールし、それを使ってPHP用のデプロイスクリプトの雛形を用意する。

cd /path/to/your/laravelapp/
npm install kuduscript -g
kuduscript -y --php
git add -A
git commit -m 'Generate deployment script'

これを実行することで、.depoyment とdeploy.sh が生成される。 .deploymentはどのファイルをデプロイ時に実行するかを指定し、実際に実行される一連の手続きをdeploy.shに書く。

#!/bin/bash

# ----------------------
# KUDU Deployment Script
# Version: 1.0.15
# ----------------------

# Helpers
# -------

exitWithMessageOnError () {
  if [ ! $? -eq 0 ]; then
    echo "An error has occurred during web site deployment."
    echo $1
    exit 1
  fi
}

# Prerequisites
# -------------

# Verify node.js installed
hash node 2>/dev/null
exitWithMessageOnError "Missing node.js executable, please install node.js, if already installed make sure it can be reached from current environment."

# Setup
# -----

SCRIPT_DIR="${BASH_SOURCE[0]%\\*}"
SCRIPT_DIR="${SCRIPT_DIR%/*}"
ARTIFACTS=$SCRIPT_DIR/../artifacts
KUDU_SYNC_CMD=${KUDU_SYNC_CMD//\"}

if [[ ! -n "$DEPLOYMENT_SOURCE" ]]; then
  DEPLOYMENT_SOURCE=$SCRIPT_DIR
fi

if [[ ! -n "$NEXT_MANIFEST_PATH" ]]; then
  NEXT_MANIFEST_PATH=$ARTIFACTS/manifest

  if [[ ! -n "$PREVIOUS_MANIFEST_PATH" ]]; then
    PREVIOUS_MANIFEST_PATH=$NEXT_MANIFEST_PATH
  fi
fi

if [[ ! -n "$DEPLOYMENT_TARGET" ]]; then
  DEPLOYMENT_TARGET=$ARTIFACTS/wwwroot
else
  KUDU_SERVICE=true
fi

if [[ ! -n "$KUDU_SYNC_CMD" ]]; then
  # Install kudu sync
  echo Installing Kudu Sync
  npm install kudusync -g --silent
  exitWithMessageOnError "npm failed"

  if [[ ! -n "$KUDU_SERVICE" ]]; then
    # In case we are running locally this is the correct location of kuduSync
    KUDU_SYNC_CMD=kuduSync
  else
    # In case we are running on kudu service this is the correct location of kuduSync
    KUDU_SYNC_CMD=$APPDATA/npm/node_modules/kuduSync/bin/kuduSync
  fi
fi

# PHP Helpers
# -----------

initializeDeploymentConfig() {
	if [ ! -e "$COMPOSER_ARGS" ]; then
    COMPOSER_ARGS="--no-interaction --prefer-dist --optimize-autoloader --no-progress --no-dev --verbose"
    echo "No COMPOSER_ARGS variable declared in App Settings, using the default settings"
  else
    echo "Using COMPOSER_ARGS variable declared in App Setting"
  fi
  echo "Composer settings: $COMPOSER_ARGS"
}

##################################################################################################################################
# Deployment
# ----------

echo PHP deployment


# 1. Initialize Composer Config
initializeDeploymentConfig

# 2. Use composer
echo "$DEPLOYMENT_SOURCE"
if [ -e "$DEPLOYMENT_SOURCE/composer.json" ]; then
  echo "Found composer.json"
  pushd "$DEPLOYMENT_SOURCE"
  ./bin/composer install $COMPOSER_ARGS
  exitWithMessageOnError "Composer install failed"

  php artisan package:discover
  exitWithMessageOnError "Package discover failed"

  php artisan config:cache
  exitWithMessageOnError "Caching config failed"

  php artisan migrate --force -v --database=sqlsrv
  exitWithMessageOnError "Migration failed"
  popd
fi

# 3. KuduSync
if [[ "$IN_PLACE_DEPLOYMENT" -ne "1" ]]; then
  "$KUDU_SYNC_CMD" -v 50 -f "$DEPLOYMENT_SOURCE" -t "$DEPLOYMENT_TARGET" -n "$NEXT_MANIFEST_PATH" -p "$PREVIOUS_MANIFEST_PATH" -i ".git;.hg;.deployment;deploy.sh"
  exitWithMessageOnError "Kudu Sync failed"
fi

##################################################################################################################################

echo "Finished successfully."

デプロイ！

デプロイすると、deploy.shが実行されるようになります。 ドキュメントは見つけられていないけれど、どうやらローカルgitやGitHubなどgitリポジトリを介したデプロイのみにサポートしているようだ。Zipデプロイを試してみたところ、deploy.shは実行されなかった。

参考

• Azure App Service Web Apps での PHP の構成 | Microsoft Docs
• Deployment hooks · projectkudu/kudu Wiki
• Deployment - Laravel - The PHP Framework For Web Artisans

_ Developer Summit 2018 で普通に仕事してきます。

Developer Summit 2018で普通に仕事してきます。

• 実況パワフルモブプログラミング - Rakuten Super Englishにおけるモブプログラミングという働き方 - デブサミ2018

モブプログラミングで仕事してるって言ってるけど、いったいどんなスタイルなんだろう？

という方々をお迎えして、現場見学会というのは兼ねてより実施していましたが、毎度入館申請とか社内の場所取りとか面倒くさいので、ここいらで一気に片付けてしまいたいと思います。

ごめんなさい、お暇なら是非見に来てね！