buildkite/agent:README に基づく導入ガイド
README、メタデータ、ライセンスに基づく buildkite/agent の導入と確認ガイドです。
プロジェクトの範囲
buildkite/agent の README はプロジェクトを「The Buildkite Agent is an open-source toolkit written in Go for securely running build jobs on any device or network」と説明しています。ここではリポジトリで確認できる事実だけを整理します。star 数やバッジは注目度の手掛かりであり、品質の証明ではありません。「Buildkite Agent」には次の説明があります。The buildkite-agent is a small, reliable, and cross-platform build runner that makes it easy to run automated builds on your own infrastructure.。これは範囲の説明であり、本番検証の結果ではありません。
向いている用途
README の「Docker」にある内容から、用途が合うかを先に判断できます。3.45-ubuntu-20.04, tracks bugfix updates in version 3.45 installed in Ubuntu。目的が違うなら、人気だけで採用する理由にはなりません。プロジェクト名やコマンドは原文のまま残し、一次資料へ戻って用語を確認できるようにしています。 README には次の確認可能な項目もあります。3-ubuntu-20.04, tracks minor and bugfix updates in version 3 installed in。初回テストの材料にはなりますが、実際の環境での確認を省略する理由にはなりません。
動作の考え方
動作の説明は「Dependencies」など複数の箇所に分かれています。確認できる情報は次の通りです。The agent is fairly portable and should run out of the box on most supported platforms without extras. On Linux hosts it requires dbus.。書かれていない構成、性能、セキュリティを推測で補いません。導入時はディレクトリ、設定ファイル、release 履歴を確認してください。
インストールと初回起動
初回導入は README の入口から始めます。確認できるコマンドは次の通りです。 $ buildkite-agent --help Usage: buildkite-agent <command> [options...] Available commands are: acknowledgements Prints the licenses and notices of open source software incorporated into this software. start Starts a Buildkite agent annotate Annotate the build page within the Buildkite UI with text from within a Buildkite job annotation Make changes to an annotation on the currently running build artifact Upload/download artifacts from Buildkit 実行可能なコマンドがない場合は手順を作らず、「Dependencies」で依存関係、待受ポート、初回設定を確認します。
設定と日常運用
日常運用は公式文書の範囲に限ります。「Docker」にはWe also support and publish Docker Images for the following operating systems. Docker images are tagged using the agent SemVer components followed by the operating system.とあります。設定、環境変数、権限、データ保存先は明記されたものだけを扱います。未記載の既定値は隔離環境で確認し、戻せる設定を保存してください。 同じ資料には3.45.6-ubuntu-20.04, tracks the exact version installed in Ubuntu 20.04ともあります。