本番デプロイの初回セットアップ¶
初回はRunner、SSH鍵、配置先、NGINX、GitLab変数、タグ保護の順に準備します。準備後の公開・切り戻しはCI/CD運用手順を参照してください。
Runnerと接続の準備¶
LinuxのDocker executorでジョブを実行する、本プロジェクト専用のProject Runnerを用意します。別プロジェクトとRunnerホストを共有しません。Settings → CI/CD → Runnersで次を設定してください。
- Runnerのタグを
tectas-productionにする(.gitlab-ci.ymlのdefault.tagsと一致)。 - Protected と Lock to current projects を有効にし、Run untagged jobs を無効にする。
- 本プロジェクトでInstance Runner・Group Runnerを無効にし、同じタグを持つ他のRunnerを割り当てない。
- Docker executorは非privilegedで動かし、ジョブへDockerソケットやホストの機密ディレクトリをマウントしない。
Runnerから社内GitLab・npmレジストリ・PyPI・コンテナーイメージ・Debianパッケージ・Playwright配布先へ接続できる必要があります。社内CAを使う場合はRunnerやイメージに信頼する証明書を設定します。
デプロイジョブのRunnerから本番SSHポートへ接続できるようにします。本番はLinuxとGNU coreutils、Bash、rsync、curl、flock(util-linux)を使用します。公開後の確認は本番サーバー上で実行します。識別ファイルはループバック経由、トップページは公開HTTPS URL経由で取得するため、本番側のDNS・TLS・ネットワーク経路も必要です。
SSH接続を開始するのは、Runnerが起動するジョブ用コンテナーです。コンテナーから本番サーバーへ外向きに接続するため、DockerのSSH用ポート公開は不要です。DEPLOY_HOST にはコンテナーから到達できる本番のホスト名またはIPv4アドレスを指定します。localhost はコンテナー自身を指すため使用しません。
本番SSHサーバーから見えるRunnerの送信元IPを固定し、ファイアウォールと後述の authorized_keys の両方で許可します。NATを使う場合は変換後のIPを指定します。共有NATでは他の端末も同じIPになるため、Runner専用の送信元を用意してください。以下の 203.0.113.10 は説明用です。実際の送信元IPへ置き換えます。
初回は、以下の順にユーザー・SSH鍵・配置先・nginx・GitLab変数・タグ保護を準備します。通常の反映にsudoやnginxの再起動は不要です。
本番のデプロイ用ユーザーとSSH鍵¶
以下は、本番サーバーに専用ユーザー deploy と同名グループを新規作成し、ホームを /home/deploy にする例です。本番側のコマンドは、既存の管理者アカウントで本番サーバーにログインして実行します。Runnerのコンテナー内では実行しません。
1. 本番サーバーでユーザーと必要なコマンドを確認する¶
cat /etc/os-release
id deploy
getent group deploy
command -v bash rsync curl flock sshd
id deploy が「そのようなユーザは存在しません」などを返し、グループも存在しなければ、次のコマンドでユーザー・同名グループ・ホームを作成します。useradd のあるLinuxを対象とし、ログインシェルはSSH経由でデプロイスクリプトを実行できる /bin/bash にします。
sudo useradd --create-home --user-group --shell /bin/bash deploy
id deploy
getent passwd deploy
deploy をsudoグループやdockerグループへ追加する必要はありません。ユーザーが既にある場合は新規作成せず、ホーム・グループ・シェルを確認してください。グループだけが既にある場合は、--user-group の代わりに --gid deploy を指定します。既存の別ユーザーを使用する場合は、以降の deploy・/home/deploy とGitLab変数 DEPLOY_USER をそのユーザーに合わせます。グループ名は id -gn ユーザー名 で確認します。
必要なコマンドが不足している場合は、本番OSのパッケージ管理で導入します。Debian/Ubuntuの場合は次の例を使えます。他のOSではパッケージ名とサービス名を確認してください。
sudo apt-get update
sudo apt-get install -y openssh-server rsync curl util-linux coreutils bash
sudo systemctl status ssh
SSHサービスが動作していることを確認し、ジョブ用コンテナーから本番のSSHポートへ到達できるよう、ファイアウォールなどでRunnerの実際の送信元を許可します。既存のSSH設定で AllowUsers などを指定している場合は、deploy の公開鍵認証も許可されているか確認してください。
2. 本番サーバーでCI専用鍵を作成する¶
以降も本番サーバーの管理者セッションで実行します。CI専用鍵をrootだけがアクセスできる一時保管ディレクトリに作成し、秘密鍵をGitLabへ登録したら削除します。
sudo install -d -o root -g root -m 700 /root/tectas-ci
sudo ssh-keygen -t ed25519 -C "tectas-gitlab-deploy" -f /root/tectas-ci/id_ed25519 -N ""
既存ファイルがある場合は上書きせず、登録済みの鍵か確認してください。id_ed25519 が秘密鍵、id_ed25519.pub が公開鍵です。無人実行用のためパスフレーズは空にしています。秘密鍵はGitへ追加せず、後述の SSH_PRIVATE_KEY_BASE64 に登録します。
3. 本番サーバーで公開鍵を登録する¶
管理者アカウントで本番サーバー上の以下を実行します。authorized_keys に登録するのは、制限オプションと .pub の内容を合わせた1行です。203.0.113.10 を本番から見えるRunnerの送信元IPへ置き換えてください。複数ある場合は from="IP1,IP2" と列挙します。
sudo install -d -o deploy -g deploy -m 700 /home/deploy/.ssh
sudo touch /home/deploy/.ssh/authorized_keys
sudo awk '{ print "\nrestrict,from=\"203.0.113.10\" " $0 }' /root/tectas-ci/id_ed25519.pub | sudo tee -a /home/deploy/.ssh/authorized_keys > /dev/null
sudo chown deploy:deploy /home/deploy/.ssh/authorized_keys
sudo chmod 600 /home/deploy/.ssh/authorized_keys
登録結果は restrict,from="203.0.113.10" ssh-ed25519 AAAA... tectas-gitlab-deploy の形式です。既存の同じ公開鍵が無制限の行でも登録されている場合は、その行を削除して制限付きの1行だけを残します。他の管理用鍵は変更しません。
restrict はPTY割り当て・ポート転送・エージェント転送・X11転送・~/.ssh/rc の実行を禁止します。SSH経由のコマンド実行は許可されるため、restrict と from だけでは、許可元Runnerが侵害された場合の任意コマンド実行を防げません。現在のCIはBashスクリプトとrsyncをSSH経由で実行するため、/bin/bash が必要です。コマンド自体を限定する場合は、サーバー側で管理する強制コマンド(command=)と、クライアントから渡すスクリプトを実行しない方式への変更が別途必要です。OpenSSHの鍵制限仕様を参照してください。
4. GitLabに登録する本番ホスト鍵を取得する¶
本番サーバーの管理者セッションで、SSHサーバーが使用している公開ホスト鍵からknown_hosts形式の1行を出力します。以下はED25519ホスト鍵・SSHポート22の例です。production.example.com をGitLab変数 DEPLOY_HOST に設定するホスト名またはIPv4アドレスに置き換えてください。
sudo awk -v host='production.example.com' '{ print host, $1, $2 }' /etc/ssh/ssh_host_ed25519_key.pub
出力された行全体を、末尾の改行を含めてGitLabの SSH_KNOWN_HOSTS に登録します。SSHポートが22以外の場合は、上の host を [production.example.com]:2222 のように実際のホスト・ポートに合わせます。別のホスト鍵を使用する場合は、SSHサーバーが使用している対応する .pub ファイルを指定してください。
SSH接続はCIのデプロイジョブから行います。ジョブ用コンテナーには openssh-client と rsync を導入し、Masked変数から秘密鍵を復元し、File変数からknown_hostsを読み込む設定が既にあります。秘密鍵は権限600で一時保存し、スクリプト終了時に削除します。
本番ディレクトリとnginx¶
前節で deploy ユーザー・グループを作成した後、本番サーバーで管理者が配置ディレクトリを作成します。以下は DEPLOY_PATH=/var/www/tectas の例です。実際のユーザー・グループに合わせて変更してください。
sudo install -d -o deploy -g deploy -m 755 /var/www/tectas
sudo -u deploy test -w /var/www/tectas && echo "deploy can write the deployment directory"
install: 無効なユーザー: 'deploy' が出た場合は、ユーザー作成が完了していません。前節の id deploy から確認してください。test -w が失敗した場合は、配置先の所有者・権限を確認します。
配置後は次の構造になります。current と previous はシンボリックリンクです。
/var/www/tectas/
releases/<パイプラインID>-<ジョブID>/
current -> releases/公開中の版
previous -> releases/直前の版
初回の切り戻し用に現在の公開ファイルを保存する¶
/var/www/tectas/current が既に公開ファイルを格納した実ディレクトリの場合は、先に次の「currentが実ディレクトリの場合」の手順を使います。その場合、後述の汎用コピー手順は実行しません。
currentが実ディレクトリの場合¶
ls -ld /var/www/tectas/current の先頭が d で、直下に index.html がある場合が該当します。CIスクリプトは current がシンボリックリンクであることを検証するため、実ディレクトリのままでは本番反映できません。
以下は本番サーバーの管理者セッションで実行します。deploy ユーザー・グループとrsyncの準備が済んでいることが前提です。現在の公開ファイルを releases/bootstrap にコピーし、初期保存版の識別ファイルを作成してから、元のディレクトリを current-before-ci に退避し、current をリンクへ置き換えます。nginxの root /var/www/tectas/current; は変更しません。退避からリンク配置までの間は短時間ですが公開パスが存在しないため、切り替え作業はメンテナンス時間に行ってください。作業中は公開ファイルの更新も止めます。
sudo bash <<'MIGRATE_CURRENT'
set -euo pipefail
base='/var/www/tectas'
test -d "$base/current"
test ! -L "$base/current"
test -f "$base/current/index.html"
for target in "$base/releases/bootstrap" "$base/current-before-ci" "$base/.current-bootstrap"; do
if [[ -e "$target" || -L "$target" ]]; then
echo "既に存在するため停止します: $target" >&2
exit 1
fi
done
install -d -o deploy -g deploy -m 755 "$base/releases"
mkdir -- "$base/releases/bootstrap"
rsync -rlt --chmod=D755,F644 --chown=deploy:deploy -- "$base/current/" "$base/releases/bootstrap/"
# 公開済みソースのSHAが不明なため、初期保存版の識別値として40桁のゼロを使います。
printf '%s-0\n' '0000000000000000000000000000000000000000' > "$base/releases/bootstrap/deploy-version.txt"
chown deploy:deploy "$base/releases/bootstrap" "$base/releases/bootstrap/deploy-version.txt"
chmod 755 "$base/releases/bootstrap"
chmod 644 "$base/releases/bootstrap/deploy-version.txt"
test -f "$base/releases/bootstrap/index.html"
ln -sT -- "$base/releases/bootstrap" "$base/.current-bootstrap"
mv -T -- "$base/current" "$base/current-before-ci"
if ! mv -T -- "$base/.current-bootstrap" "$base/current"; then
mv -T -- "$base/current-before-ci" "$base/current"
exit 1
fi
MIGRATE_CURRENT
既にコピー先・退避先・一時リンクのいずれかが存在する場合は、変更前に停止します。その場合は既存の内容を確認し、この手順を繰り返して上書きしないでください。切り替え中にSSH切断などで中断した場合は、current の有無と current-before-ci の状態を確認して復旧します。
完了後、本番で次を確認します。readlink は /var/www/tectas/releases/bootstrap を表示し、HTTP応答の識別値は40桁のゼロと -0 になります。HTTPで取得できない場合は、後述のnginx設定で /deploy-version.txt を配信できるか確認します。元の公開ファイルは current-before-ci に残ります。
ls -ld /var/www/tectas/current
readlink -f /var/www/tectas/current
curl --fail --silent --show-error --noproxy '*' \
--resolve www.tectas.co.jp:443:127.0.0.1 https://www.tectas.co.jp/deploy-version.txt
curl --fail --silent --show-error --output /dev/null https://www.tectas.co.jp/
確認後は「nginxの公開先を切り替える」の設定項目を確認し、GitLab変数の登録へ進みます。以下の汎用コピー手順はスキップします。
別の公開ディレクトリからコピーする場合¶
bootstrap は、CI導入直前に公開しているサイトの保存先です。index.html は新しく作るものではなく、現在nginxが配信している公開ディレクトリのものを、CSS・画像・PDF・各ページと一緒にコピーします。リポジトリの src/ や、未公開の変更をビルドした dist/ はコピー元にしません。
本番サーバーで sudo nginx -T を実行し、本番ドメインのHTTPS用serverブロックにある現在の root を確認します。以下の /実際の公開ディレクトリ をその絶対パスへ置き換えてください。root がシンボリックリンクなら、リンク先のディレクトリを指定します。index.html がなくPHPなどで動的に配信している場合、この静的ファイルのコピーによる切り戻しは使えないため、ここではnginxの公開先を変更せず、旧環境を戻す手順を別途用意してください。
deploy-version.txt はこのCIのヘルスチェック用に作成する識別ファイルで、従来の公開ファイルには通常ありません。公開済みソースの40桁コミットSHAが分かる場合は、下の bootstrap_sha をその値に置き換えます。対応するSHAが不明な既存サイトでは、例の40桁のゼロを初期保存用の識別値として使用できます。これは実際のコミットを表すものではありません。末尾の -0 はCI導入前の保存版を識別する値です。通常のCIでは、ビルドジョブが実際のコミットSHAとパイプラインIDからこのファイルを自動生成します。
以下は本番サーバーの管理者セッションで実行します。元の公開ファイルは残し、新規の bootstrap へコピーします。既に bootstrap がある場合は上書きせず停止するので、既存の保存版を確認してください。
sudo bash <<'BOOTSTRAP'
set -euo pipefail
source_dir='/実際の公開ディレクトリ'
bootstrap_dir='/var/www/tectas/releases/bootstrap'
bootstrap_sha='0000000000000000000000000000000000000000'
source_dir=$(realpath -e -- "$source_dir")
test -f "$source_dir/index.html"
[[ "$bootstrap_sha" =~ ^[a-f0-9]{40}$ ]]
# コピー元の内側への再帰的なコピーを防ぎます。
case "$bootstrap_dir/" in
"$source_dir/"*) echo 'コピー先を含まない公開ディレクトリを指定してください' >&2; exit 1 ;;
esac
install -d -o deploy -g deploy -m 755 /var/www/tectas/releases
mkdir -- "$bootstrap_dir"
rsync -rlt --chmod=D755,F644 --chown=deploy:deploy -- "$source_dir/" "$bootstrap_dir/"
printf '%s-0\n' "$bootstrap_sha" > "$bootstrap_dir/deploy-version.txt"
chown deploy:deploy "$bootstrap_dir" "$bootstrap_dir/deploy-version.txt"
chmod 755 "$bootstrap_dir"
chmod 644 "$bootstrap_dir/deploy-version.txt"
test -f "$bootstrap_dir/index.html"
test -s "$bootstrap_dir/deploy-version.txt"
ln -sT -- "$bootstrap_dir" /var/www/tectas/current
BOOTSTRAP
current が既に存在すると最後のコマンドは失敗します。その場合は既存の公開状態を確認し、リンクを無条件に上書きしないでください。作成できた場合は、次のコマンドでリンクと識別値を確認します。
readlink -f /var/www/tectas/current
cat /var/www/tectas/current/deploy-version.txt
リンク先が /var/www/tectas/releases/bootstrap、識別値が設定した40桁SHA(不明なら40桁のゼロ)と -0 であることを確認します。初回のCIデプロイ時に、この current の参照先が previous に保存され、切り戻し先になります。previous は手動で作成する必要はありません。
nginxの公開先を切り替える¶
セキュリティヘッダーは専用の反映手順に従って既存HTTPS設定へ追加します。ヘッダー設定はCI/CDの公開ディレクトリ外で管理します。下の/deploy-version.txtのように独自のadd_headerを持つlocationには、上位のヘッダーが継承されないため、共通設定のincludeも追加してください。
上記の保存版と current を用意してから、既存のHTTPS用serverブロックに以下を組み込みます。変更前のnginx設定はバックアップしておきます。TLS証明書、ドメイン転送、ログなどの既存設定は維持してください。
root /var/www/tectas/current;
index index.html;
location / {
try_files $uri $uri/ =404;
}
error_page 404 /404.html;
location = /404.html {
internal;
}
location = /deploy-version.txt {
add_header Cache-Control "no-store" always;
open_file_cache off;
}
/deploy-version.txt は外部へ公開せず、nginx側で 127.0.0.1 からのアクセスを許可するIP制限を設定してください。上の設定例にはアクセス制限を含めていないため、実際の環境に合わせて追加します。デプロイスクリプトは --resolve で接続先を 127.0.0.1 に固定し、--noproxy でプロキシを経由せずに識別ファイルを取得します。URLのホスト名は維持するため、TLS証明書の検証は有効です。nginxは PRODUCTION_URL のポートでループバック接続を受け付け、そのホスト名に対応するHTTPSサイトを配信する必要があります。独自ポートを使う場合は、下の確認コマンドのURLと --resolve のポートも合わせて変更します。
既存のPHP用locationやFastCGI設定が残っている場合は、静的配信用の設定に整理します。シンボリックリンクを禁止する設定がある場合は調整し、nginxユーザーが配置先を読み取れることも確認してください。設定変更時は nginx -t に合格してからreloadします。
systemdでnginxを管理している場合は、設定を保存して次を実行します。構文検査が失敗した場合はreloadされません。
sudo nginx -t && sudo systemctl reload nginx
公開先の切り替え後、本番サーバーで以下を実行します。deploy-version.txt が先ほど作成した値と一致することを確認し、ブラウザーでも既存ページ・画像・PDFが表示できることを確認してから初回の公開タグを作成します。nginxの公開先変更だけではCIによる新版の公開は行われません。
curl --fail --silent --show-error --noproxy '*' \
--resolve www.tectas.co.jp:443:127.0.0.1 https://www.tectas.co.jp/deploy-version.txt
curl --fail --silent --show-error --output /dev/null https://www.tectas.co.jp/
GitLabのCI/CD変数¶
CI/CDでは.envファイルを配置しない¶
現在のパイプラインでは、フロント用の.envファイルをGitLab RunnerやNGINXサーバーへ配置しません。作業端末の.env.development.local・.env.preview.local・.env.production.localはGit管理対象外なので、Runnerには渡りません。.env.exampleも自動では読み込まれません。
本番ビルドに使う設定は、GitLabの Settings → CI/CD → Variables へ、キーごとに登録します。PUBLIC_CONTACT_ENABLED、PUBLIC_CONTACT_API_URL、PUBLIC_TURNSTILE_SITE_KEY、PUBLIC_CONTACT_TURNSTILE_ENABLEDは、いずれも種別を Variable、環境スコープを production、Protected を有効にし、値の変数展開を無効にします。.env全体をFile変数として登録する構成ではありません。
例えばフォームを非公開にする場合は、KeyにPUBLIC_CONTACT_ENABLED、Valueにfalseを登録します。公開する場合はtrueとし、API URLと本番用サイトキーも登録してください。各値の意味は後述の公開変数一覧を参照してください。
buildジョブはproduction環境の変数を受け取り、npm run buildで静的HTML・JavaScriptへ埋め込みます。生成したdist/だけをNGINXへ配置するため、NGINXへフロント用の.envを置いたり、NGINXの環境変数を変更したりしても表示設定は変わりません。GitLab変数を変更したら、ビルドから公開までパイプラインを再実行します。deploy-productionだけの再実行では既存の成果物を配置するため、設定は更新されません。
バックエンドの/etc/tectas-contact/contact.envとsecrets.jsonは別管理です。これらはアプリサーバーへ手動配置し、CI/CDへSMTPパスワードやTurnstile秘密鍵を登録しません。
登録する変数¶
Settings → CI/CD → Variablesで以下を登録します。いずれも Protected を有効にし、環境スコープを production にします。値の変数展開は無効にしてください。
| 変数 | 種別 | 設定内容 |
|---|---|---|
DEPLOY_HOST |
Variable | SSH接続先のホスト名またはIPv4アドレス |
DEPLOY_USER |
Variable | デプロイ専用ユーザー |
DEPLOY_PATH |
Variable | /var/www/tectas など、事前作成した絶対パス |
DEPLOY_PORT |
Variable | SSHポート。省略時は 22 |
SSH_PRIVATE_KEY_BASE64 |
Variable | 秘密鍵ファイルをBase64にした改行・空白のない1行。Visibilityは Masked and hidden(未対応なら Masked) |
SSH_KNOWN_HOSTS |
File | 管理者が指紋を照合した接続先ホスト鍵。末尾に改行が必要 |
PRODUCTION_URL |
Variable | 省略時は https://www.tectas.co.jp。検証対象のHTTPSオリジン |
接続先は通常のホスト名またはIPv4、配置パスは空白なしの英数字・/・_・-・. を使用します。配置パスは /var/www/tectas のように2階層以上とし、シンボリックリンクを含めず、末尾の / を付けません。
ホスト鍵は信頼できる管理経路で取得・照合します。ジョブ中の ssh-keyscan やホスト鍵検証の無効化は行いません。SSHポートが22以外の場合、known_hostsには [ホスト名]:ポート 形式のエントリーを登録します。
複数行の秘密鍵はMaskedの要件を満たさないため、秘密鍵ファイル全体を1行のBase64に変換して保存します。Base64は暗号化ではありません。復元後の鍵はマスキングされないため、元の値・復元後の値ともログへ出力せず、CI_DEBUG_TRACE・CI_DEBUG_SERVICES は有効にしません。Maskedでも悪意あるジョブによる持ち出しは防げないため、CI設定の変更権限も制限します。GitLabのマスキング仕様を参照してください。
前述の例では、DEPLOY_USER=deploy、DEPLOY_PATH=/var/www/tectas、DEPLOY_HOST は本番の接続先です。各変数のValueには次の内容を登録します。
SSH_PRIVATE_KEY_BASE64:本番の管理者セッションでsudo base64 -w 0 /root/tectas-ci/id_ed25519を実行して取得した1行全体。変換元は末尾の改行を含む秘密鍵ファイルで、.pubは使いません。取得は画面共有やセッション記録で値が公開されない環境で行い、クリップボードなどの一時コピーも登録後に消去します。SSH_KNOWN_HOSTS:前節のsudo awkで出力したknown_hosts形式の行。本番のホスト名・ポートはDEPLOY_HOST・DEPLOY_PORTと一致させます。
GitLab画面ではAdd variableを開き、Key・Value・Type・Environment scope・Protected・Visibilityを設定して保存します。秘密鍵をVisibleで保存しません。SSH_KNOWN_HOSTS は公開ホスト鍵なのでVisibleで構いません。
登録を保存できたら、初回パイプラインの前に本番の管理者セッションで一時保管した秘密鍵を削除します。以下は本手順で作成した秘密鍵だけを削除します。公開鍵は照合用に残せます。バックアップやスナップショットに秘密鍵が残る場合、ファイル削除だけでは消去できないため、その保管先も確認してください。
sudo rm -- /root/tectas-ci/id_ed25519
sudo test ! -e /root/tectas-ci/id_ed25519 && echo 'temporary private key removed'
登録後はタグ保護を設定し、公開手順に従います。初回のタグパイプラインで専用RunnerからのSSH接続と本番反映を確認します。管理下の許可されていない送信元から同じ鍵では認証できないことも確認し、その試験用コピーは削除します。
既存構成から移行する場合は、専用Runnerの設定と鍵のIP制限を先に適用し、新しい鍵をMasked変数へ登録して本番上の秘密鍵を削除します。この変更を含む新しい保護タグでデプロイを確認後、旧 SSH_PRIVATE_KEY 変数と旧公開鍵の登録を削除して旧鍵を失効させます。旧タグのジョブは旧変数を使うため、移行後の切り戻しも新しいタグの rollback-production で行います。
公開変数の登録手順¶
公開変数も、前述のSSH接続設定と同じ Settings → CI/CD → Variables に登録します。以下の4項目のTypeはすべて Variable です。Fileを選ぶと環境変数には一時ファイルのパスが入り、この実装が期待する設定値にはなりません。ブラウザーへ公開する値なので、SMTPパスワードやTurnstile秘密鍵は含めません。
まず、Maintainer権限を持つ担当者が対象プロジェクトを開き、Settings → CI/CD → VariablesからAdd variableを選びます。画面の名称はGitLabのバージョンによって異なる場合があります。GitLab公式:プロジェクト変数の登録
公開変数4項目に共通する設定は次のとおりです。初期値に任せず、各項目を確認して保存します。
| GitLab画面の項目 | 指定する値 |
|---|---|
| Type | Variable。Fileは選ばない |
| Key | 下表の変数名をそのまま記入 |
| Value | 下表の値を記入。変数名=や値を囲む引用符は付けない |
| Environment scope / Environments | production。本パイプラインの環境名と一致させる |
| Protect variable / Protected | 有効。公開用の保護タグから利用する |
| Visibility | Visible。これらはブラウザーへ公開する設定値 |
| Expand variable reference | 無効。値を別の変数として展開しない |
次の値はフォームを公開して送信を受け付ける構成の例です。URLとサイトキーは実環境のものへ置き換え、各行を別々の変数として登録します。
| Key | Type | Valueの例 | 必須条件・省略時の動作 |
|---|---|---|---|
PUBLIC_CONTACT_ENABLED |
Variable | true |
省略時はtrue。falseでフォームへのリンクと入力欄を非表示にする。APIの送信停止は別設定 |
PUBLIC_CONTACT_API_URL |
Variable | https://www.tectas.co.jp/api/contact |
フォームで送信する場合に必要。自前版はNGINXの公開URL、AWS版は出力されたContactApiUrl。省略時は送信できない |
PUBLIC_TURNSTILE_SITE_KEY |
Variable | 本番ウィジェットのサイトキー | フォームで送信する場合に必要。Turnstileの秘密鍵とは別の値。省略時は送信できない |
PUBLIC_CONTACT_TURNSTILE_ENABLED |
Variable | true |
省略時もtrue。本番CIではfalseを指定するとビルドが失敗する |
フォームを公開しない場合はPUBLIC_CONTACT_ENABLED=falseを登録します。API URLとサイトキーは未登録でも構いません。PUBLIC_CONTACT_TURNSTILE_ENABLEDはtrueまたは未登録にします。フォームを非公開にしても、現在のCIはTurnstile無効化を許可しません。APIも止める場合は、アプリサーバーのSENDING_ENABLED=false、AWS版ならSendingEnabled=falseを別途設定します。
フォームを公開する場合はPUBLIC_CONTACT_ENABLED=trueに加え、配置済みAPIのURLとサイトキーを登録します。フォームを公開したままAPI URLやサイトキーを空欄にすると、画面の送信操作で電話案内になります。自前版・AWS版の選択は接続先URLで行い、API自体の配置・認証情報更新はこのCIの対象外です。
登録後の反映と確認¶
- Variables一覧で公開変数4項目のType・環境スコープ・Protectedを確認します。同じKeyで環境スコープの異なる登録がある場合は、本番に適用される値を確認します。
- 「公開タグとmainの保護」の設定を設定し、最新の
mainへ新しい保護タグを作成・pushします。本体公開用CIはタグ時だけ実行します。文書変更時のmain用CIは文書サイトの手順を参照してください。 buildジョブの成功後、成果物のdist/contact/index.htmlを確認します。公開時はdata-contact-api・data-turnstile-sitekey・data-turnstile-enabledが意図した設定になっていること、非公開時は入力フォームがないことを確認します。- デプロイ成功後、ブラウザーを再読み込みし、フォームのリンクと画面表示を確認します。送信まで確認する場合はテスト宛先で実施します。
buildジョブはproduction環境をaction: prepareで指定しているため、上記の環境スコープの変数を利用できます。NGINXへ.envを置く作業や、公開変数を読み込ませるためのNGINX再起動は不要です。変数の変更後も、以前の成果物は変わりません。新しい設定を反映する際はビルドからデプロイまで実行してください。
公開タグとmainの保護¶
Settings → Repository → Protected tagsで公開用のタグを保護します。例として v* を登録し、Allowed to createには公開を許可する担当者・ロールだけを指定します。CIは保護タグだけを対象にするため、先にこの設定が必要です。保護されていないタグではパイプラインを作成せず、タグパイプラインでProtected変数を使うためにもタグ保護が必要です。このCI設定は名前の形式を制限せず、保護ルールに一致するすべてのタグを対象にします。
main はSettings → RepositoryのBranch rules(バージョンによってはProtected branches)で次のように保護します。
| 項目 | 設定 |
|---|---|
| 対象ブランチ | main |
| Allowed to merge | マージを許可する担当者・ロール |
| Allowed to push and merge | No one(直接pushを禁止) |
| Allow force push | 無効 |
同じブランチに一致する別の保護ルールでも直接pushを許可しないでください。CIの CI_COMMIT_REF_PROTECTED はタグの保護状態を確認するもので、main の保護やpush権限までは検証しません。validate-main はコミットの祖先関係を検証するため、squash・fast-forwardでマージした場合も、マージ後の main に含まれるコミットへタグを作成してください。
この構成ではMR段階のCIがありません。マージ前はローカルで検証し、GitLabの「Pipelines must succeed」をMRの必須条件にする運用は避けてください。タグ作成後のCIが失敗すると、本番反映は実行されません。利用プランが対応している場合は production 環境も保護し、実行できる担当者を限定してください。Settings → CI/CDで古いデプロイを防止する設定(Prevent outdated deployment jobs)も有効にします。
旧構成から確認する点¶
- 既存の配置先を使う場合は、GitLab変数の
DEPLOY_PATHをその実パスへ合わせる。旧例は/var/www/tectas-site、現在の手順の例は/var/www/tectasだが、自動的な移動や変更は行わない。 - 公開先
currentはreleases/配下へのシンボリックリンクとし、index.htmlに加えて識別用のdeploy-version.txtを必要とする。旧リリースに識別ファイルがない場合は、本書の初期保存版の作成を先に行う。 - 以前の「再デプロイ」と、新しい
rollback-productionは同じ操作ではない。新しい切り戻しはサーバーのpreviousへ戻す。過去パイプラインの旧デプロイジョブと混用しない。 - 古いリリースは自動削除しない。
current・previousとキャッシュ参照を確認し、保持期間を過ぎた版を管理者が整理する。 PUBLIC_CONTACT_API_URL・PUBLIC_TURNSTILE_SITE_KEYはproductionスコープの公開設定としてビルド時に埋め込む。Turnstileを無効にした試験成果物は本番へ配置しない。