フォージ

どのようなものか

フォージは、ソフトウェアフォージ、コードフォージ、Gitフォージとも呼
ばれる、チームがリポジトリーの拠点と決めるサーバーと、その周りのサー
ビスです。Gitの完全なクローンには、全履歴があるため、原理上、どの複
製も他より上位ではありません。実際のチームには、プッシュする場所、読
み書きできる人を決める場所、コードについて話す場所が必要です。それ
が、フォージです。

フォージの内部には、チェックアウトしたファイルを持たず、履歴だけを保
持するベアリポジトリーを置きます。Gitの転送プロトコルの、一つ以上に
対応します。Gitの本では、同じマシンのディレクトリーを使うローカルプ
ロトコル、HTTP、SSH、そしてポート9418のデーモンで動き、認証を一切行
わないGit独自のプロトコルの四つを挙げています。それ以外の機能はこの
土台の上に追加され、どこまで備えるかはフォージによって大きく異なりま
す。

Forgejoの文書は、機能の多い側を示します。課題管理、プルリクエスト、
統合Wiki、多くの言語のエコシステム向けパッケージレジストリー、ジョブ
を実行するForgejo
Actions、リポジトリーのミラー、他サービスからの移行、ブランチとタグ
の保護、ウェブフックです。Soft
Serveは、反対側です。自らを「自前でホストできるコマンドライン向けの
Gitサーバー」と説明します。`soft`という単一のバイナリーが、SSH、
HTTP、Gitプロトコルでリポジトリーを配信し、SSH公開鍵で権限を管理し、
共同開発者、非公開リポジトリー、ウェブフックに対応します。どちらも
フォージで、チームの仕事をどこまで引き受けるかが違います。

相互に通信する動きもあります。ActivityPubを拡張したForgeFedは、ソフ
トウェアプロジェクトのホスティングと共同作業のプラットフォームを、連
合させるプロトコルです。リポジトリー、チケットやパッチの管理ツール、
プロジェクト、チームを、活動を送り合うアクターとして表します。フォー
ジとプロジェクト管理ツールのネットワークに、共通の言葉を作るのが目的
です。あるサーバーの人が、別のサーバーのリポジトリーへチケットを出
せ、リポジトリーも移動できます。古い複製は、読み取り専用で保存し、新
しい拠点を示します。

なぜ重要なのか

フォージは、方針を強制できる場所です。開発者のマシンの規則は、その設
定が正しい間しか効きませんが、サーバーのフックは、全プッシュで動きま
す。Gitの`pre-receive`は、各参照の古いID、新しいID、名前を、標準入力
から読みます。ゼロ以外で終了すれば、どの参照も更新しません。大きい
フォージのブランチ保護、必須レビュー、署名付きコミットの検査も、同じ
考えを細かくしたものです。チームが受け入れないと決めたものを、共有の
複製が拒みます。

フォージを選ぶことは、誰がコードを保持するかを決めることでもありま
す。ホスティングサービスは、運用費と稼働の維持を引き受ける代わりに、
コード、権限一覧、議論が、他人のハードウェアと条件の下に置かれます。
自前でホストする場合は、コードを自社の管理下に置く代わりに、運用の費
用と責任を自社で負います。どちらも無料ではなく、顧客へデータの置き場
所を説明する会社には、特に重要です。

Gitにないデータも持ちます。コミットとタグは、全クローンと一緒に移り
ますが、課題、レビューのスレッド、権限一覧、サーバー側フックは、
フォージだけにあります。その違いが、バックアップの対象と、移行で運ぶ
ものを決めます。

実際の活用例

この会社も、自社のフォージを運用します。このサイトの三つのプロジェク
トが、必要な仕事を示します。

以前は、会社のソースコードを第三者のサービスへ置いていました。会社の
Gitフォージを配備するプロジェクトは、フォージを運用するとは、認証、
権限管理、ストレージ、バックアップ、公開の窓口まで運用することだ、と
いう認識から始まります。Soft
Serveという、OSが稼働を管理する一つのバイナリーを使います。SSHを第一
とし、管理用ウェブ画面を持たないため、選びました。既定で非公開で、匿
名も鍵なしも拒み、宣言した全リポジトリーを非公開にします。SSHは、
ポート23231のループバックだけへバインドし、外からは踏み台を通りま
す。HTTPSとSSH上のGitを、一つの公開ポートへまとめるマルチプレクサー
も実装しましたが、無効のままです。使わない待ち受けも、攻撃面になるた
めです。結果は、会社のコードを会社のハードウェアでホストすることだ
と、明記します。

このサイトのリポジトリーも、そこにあります。指示書は、SSH経由のSoft
Serveを、正本のリモートとし、以前のサービスの複製を、旧来のミラーと
します。ホストされたCIはなく、品質ゲートは、ローカルとGitフックで動
くとも明記します。

サーバー側フックは、実際のGit
pushを受信する環境でテストする必要があります。そのため、信頼する前
に、本物のベアリポジトリーとプッシュで予行しました。ベアリポジトリー
を作り、フックを入れ、クローン、コミット、プッシュを行い、受け入れと
拒否の両方を検査します。ファイルでは見えない二つの欠陥が見つかりまし
た。二つ目が、教訓になります。Gitがフックを動かす際、リポジトリーの
ディレクトリーを示す変数をエクスポートし、そこから起動したテストが引
き継ぎました。処理の境界でこれらの環境変数を除去するまで、正しいコー
ドでも十九件のテストが失敗しました。限界も明記します。強制更新とブラ
ンチ削除というプッシュは、この予行では作りません。

これらはすべて、会社が公開するほかのサービスとともに、512
MBの単一コアのホストで稼働します。七つのTLSドメイン、onionサービス、
Gemini、Gopher、不正なアクセス元の遮断などです。バックアップの自動化
は別に実装されています。ただし、自動化の実装と、バックアップが実際に
稼働していることは別です。ウェブ画面を持つフォージなら、この予算で動
く常駐アプリが、もう一つ増えます。そのため、設計時点で除外しました。
記録した一日分のサンプルでは、このホストの使用可能メモリーの最小値
は、464
MB中、約310 MBでした。

問題が起きるところ

一部のフォージは、匿名の訪問者へ、既定で読み取り権限を与えます。Soft
Serveの文書も、初期状態では、`anon-access`と`allow-keyless`で管理す
る、匿名の読み取り専用接続を許すとします。非公開なら、最初を
`no-access`、二つ目をfalseにし、鍵を読み込んでいないマシンから試す価
値があります。Git自身のデーモンは、さらに単純です。Gitの本は、全員が
クローンできるか、まったく配信しないかの、どちらかだと述べます。

別のディレクトリーでGitを呼ぶフックが、違うリポジトリーを操作しま
す。プッシュ中、受信フックはベアリポジトリー内で動き、Gitは`GIT_DIR`
などを渡して、フック内のGitコマンドが、そのリポジトリーを見つけられ
るようにします。フックが起動するすべての処理に、これらの環境変数が引
き継がれます。別の場所にチェックアウトしたコードのテストも例外ではあ
りません。githooksのマニュアルは、別のリポジトリーを使う前に、これら
の変数を除去するよう述べます。プッシュされた各コミットを、使い捨ての
ディレクトリーで試す、最小限の`pre-receive`フックでは、サブシェルの
中で行います。

```sh
while read -r _ newrev _; do
  git cat-file -e "$newrev^{commit}" 2>/dev/null || continue
  tree=$(mktemp -d)
  git archive "$newrev" | tar -x -C "$tree"
  (
    unset $(git rev-parse --local-env-vars)
    cd "$tree" && ./run-tests
  ) || exit 1
done
```

復元したフォージに、コードは戻っても、規則が戻りません。どのクローン
でも、失ったサーバーのリポジトリーを埋め直せます。しかし、Gitの本
は、サーバー側フックなどの設定が元の側に残り、課題、レビュー、鍵、権
限一覧は、最初からクローンにないと警告します。バックアップとは、デー
タディレクトリーと設定を保存し、どこかへ両方を復元し、拒むべきプッ
シュを、実際に拒むか確かめることです。

開く待ち受けごとに、防御が必要です。Soft
Serveの設定例には、SSHが23231、HTTPが23232、Gitデーモンが9418、統計
サーバーが23233とあります。SSHでしかプッシュしないなら、ほかを止める
か、ループバックへ限定し、使う分だけを開けておけます。

別のフォージへ移ると、コードは運べても、議論が残ります。ミラープッ
シュがコピーするのは、ブランチとタグを含む、`refs/`以下の全参照だけ
です。課題、レビューのスレッド、ラベル、権限一覧には、新しいフォージ
の移行ツールか、ForgeFedなどが必要です。ForgeFedはコミット、タグ、チ
ケット、マージリクエスト、コメントを運び、古いリポジトリーをアーカイ
ブして、新しい場所を示します。

参考資料

  * ForgeFed仕様 — アクター、活動、古いリポジトリーを保存する移行の
流れを含む、フォージ間の連合プロトコルです。

  * Soft Serve —
`anon-access`と`allow-keyless`の設定も含めて、SSHを重視した単一バイ
ナリーのGitサーバーを説明する、プロジェクト自身の文書です。

  * Forgejoの文書 —
インストールとバックアップからActionsとミラーまで、機能のそろった自
前のフォージの、管理者と利用者向けの案内です。

  * githooks — `pre-receive`と、プッシュのフックが引き継ぐ環境を含
む、Gitが実行する全フックです。

  * プロトコル — Gitがマシン間でデータを移す四つの方法と、設定とセ
キュリティの負担です。

  * ActivityPub — ForgeFedが拡張する、W3Cの勧告です。

hこのページのウェブ版	URL:https://engineer.company/ja/glossary/forge/	engineer.company	70
