ＧｉｔＨｕｂで回すＷｅｂサイト制作

• 思えば、Ｗｅｂサイト制作の現場は、下記のような移り変わりであった気がする。
  • エンジニアが作業した（場合によってはＨＴＭＬも書く）。
  • デザイナーさんが作業するようになった（ちょっとはサーバー側の事情も考慮してくれる）。
  • 既存のデザインに対して営業さんがちょこっと修正するようになった（今回の動機）。
• エンジニア・デザイナーさんであれば、ＦＴＰ（今時はＳＦＴＰ／ＳＣＰ）使ってサーバーにアップロードしてくれた。あるいは強制できた。
• 流石に営業さんにそういうツールを使ってもらうのは通じず。

• そのために、ＣＳＭ（Content Management System）導入することもしばしば。

• しかし世の中にはもっとカジュアル（ＨＴＭＬ一枚程度）にＷｅｂサイト運用したいこともしばしば。

• 今回、そんなライトな要求に対してＧｉｔＨｕｂで回す＆自動デプロイを実施するための仕組みを作ってみた。

検証環境

• 下記ソフトウェアの利用を前提に検証を実施した。いずれも現時点で最新のリリースに基づいて検証しているが、ある程度古い環境、より新しい環境でも問題無いと思われる。
• ただし、ＯＳについては古いＯＳ（ＣｅｎｔＯＳ６等）ではこの手順では実施できない点に注意。
• 上記以外の環境では、以下の点に相違が発生する。当該環境に応じて読み替えたし。
  • インストール方法
  • インストールされるディレクトリ
• 逆に以下の点は参考にできる。
  • 設定パラメータとその意味
  • 運用事例

• ただし、スナップクラフト固有の問題を回避するためのワークアラウンドだけは別で。

検証目標

• ＧｉｔＨｕｂに対して以下の設定を行う。

  • ＷｅｂフックのＵＲＬの指定
  • 秘密鍵の指定
  • デプロイ用のＳＳＨ鍵の設置
• 上記設定のためにサーバー側のセットアップを行う。
• もちろんＷｅｂフックを受けて実際にデプロイを実施する。
• なおＡｐａｃｈｅの細かい設定については説明しない。

ミドルウェアの初期セットアップ

自作スクリプトの設置

ディレクトリ作成

mkdir -p /root/.webhook/bin
mkdir -p /root/.webhook/run
mkdir -p /etc/httpd/libexec
restorecon -RFv /root/.webhook
restorecon -RFv /etc/httpd/libexec

/root/.webhook/run/activate_id_update-contents

touch /root/.webhook/run/activate_id_update-contents
restorecon -Fv /root/.webhook/run/activate_id_update-contents

/root/.webhook/bin/mecho

#!/bin/sh
: APPEND=no

while getopts fo: OPT; do
        case $OPT in
        a)  APPEND=yes
                ;;
        o)  OUTFILE=$OPTARG
                ;;
        \?) continue
                ;;
        esac
done
shift $((OPTIND - 1))

if [ x"$OUTFILE" = x"" -o x"$OUTFILE" = x"-" ]; then
        echo $*
else
        if [ x"$APPEND" = x"yes" ]; then
                echo $* >> "$OUTFILE"
        else
                echo $* >  "$OUTFILE"
        fi
fi

上記ファイル作成後、下記コマンドを実行すること。

chmod 0755     /root/.webhook/bin/mecho
restorecon -Fv /root/.webhook/bin/mecho

/etc/httpd/libexec/update-contents.sh

#!/bin/sh
cd /var/www/html

git pull -q
if [ x"$1" = x"refs/heads/master" ]; then
        git checkout -qf master
        restorecon -RF .
fi

ＯＳ

基本的な（とは何かは議論しない）セットアップは実施済みであることとする。

ファイアウォール設定

sudo firewall-cmd --add-service=https --permanent
sudo firewall-cmd --reload

Ａｐａｃｈｅ

sudo yum -y install https://centos7.iuscommunity.org/ius-release.rpm
sudo yum -y install httpd24u httpd24u-tools

/etc/httpd/conf/httpd.conf

ProxyPass /hooks/ http://localhost:9000/hooks/
<Proxy *>
    Require all granted
</Proxy>

スナップクラフト

sudo yum -y install snapd
sudo systemctl enable --now snapd.socket
sudo ln -s /var/lib/snapd/snap /snap
sudo systemctl reboot

※スナップクラフトの有効化のために一度再起動しておくこと。

Ｗｅｂｈｏｏｋ

sudo snap install webhook

※スナップクラフトが稼働してる状態で上記コマンドを実行すること。

/etc/systemd/system/snap.webhook.webhook.service.d/override.conf

systemctl edit snap.webhook.webhook.service コマンドを呼び出して以下の設定を行う。

[Service]
EnvironmentFile=-/etc/sysconfig/webhook
ExecStart=
ExecStart=/usr/bin/snap run webhook $OPTIONS

※Ｗｅｂｈｏｏｋ起動のための設定オプションの指定ができなかったので、/etc/sysconfig/webhook を参照するように改変してみた。

/etc/sysconfig/webhook

OPTIONS="-hooks /etc/httpd/conf/hooks.yaml -hotreload -ip 127.0.0.1 -port 9000"

/etc/httpd/conf/hooks.yaml

- id: update-contents
  command-working-directory:    "/root"
  execute-command:              "/root/.webhook/bin/mecho"
  pass-arguments-to-command:
    - source: string
      name: "-o"
    - source: string
      name: "/root/.webhook/run/activate_id_update-contents"
    - source: payload
      name: ref
  response-message: |
    Updated, Done.
  trigger-rule-mismatch-http-response-code: 400
  trigger-rule:
    and:
      - match:
          type: payload-hash-sha1
          secret: "ＧｉｔＨｕｂに設定するシークレット"
          parameter:
            source: header
            name: "X-Hub-Signature"
      - match:
            type: value
            value: push
            parameter:
                source: header
                name: "X-GitHub-Event"

後始末

sudo restorecon -RFv /etc/systemd/system/snap.webhook.webhook.service.d/ /etc/sysconfig/webhook /etc/httpd/conf/webhook.yaml

ＩｎＣｒｏｎ

sudo yum -y install epel-release
sudo yum -y install incron

sudo systemctl enable incrond
sudo systemctl start incrond

/etc/incron.d/update-contents

/root/.webhook/run/activate_id_update-contents  IN_CLOSE_WRITE,loopable=false   /etc/httpd/libexec/update-contents.sh $$(cat $@)

上記ファイル設定後、以下のコマンドを実行する。

restorecon -Fv /etc/incron.d/update-contents

デプロイ用ＳＳＨ鍵の準備

sudo ssh-keygen -t ssh-ed25519 -C root@$(hostname) -N "" -f /root/.ssh/id_ed25519

以下の点に注意すること。

• root 鍵が必要とするため注意。

• パスフレーズの設定は行わない。

よくある質問とその答え

Ｑ．ProxyPass設定したならProxyReverseの設定は必須では？

Ａ．ｗｅｂｈｏｏｋに高度な応答（リダイレクトやらクッキーやら）機能が無いので必要ないです。

Ｑ．ウェブフックへのアクセス制限したいのだが？

Ａ．https://api.github.com/meta の応答（ＪＳＯＮ）見ると接続元ＩＰアドレスがリストアップしてますねー（棒）。 REST API v3 - Meta を参考に設定してみてください。 時々変更してるとは思いますが頑張ってメンテナンスしてください。

Ｑ．

参考文献

• webhook is a lightweight incoming webhook server to run shell commands.

• webhookについて

• webhooks - GitHub Developer Guide

• ワークフローをトリガーするイベント

• ユニット定義ファイルの使い方