ランナーを登録する
登録を行うと、マシンが CodeCHAMPREP で作成したランナーに接続されます。 ランナーの 認証トークン、で始まる ccrt_.
1. CodeCHAMPREPでランナーを作成します
Section titled “1. CodeCHAMPREPでランナーを作成します”- プロジェクト(またはグループ)を開き、以下の場所へ移動してください [設定] > [CI/CD] > [ランナー].
- 選択 新しいランナー.
- どのジョブを受け付けるかを選択します:
- タグ: ジョブは
tags:これらすべてを満たすランナーでのみ実行します。 - タグのないジョブを実行します:タグのないジョブも受け付けるかどうか。
- 保護済み: 保護されたブランチおよびタグのジョブのみを実行します。
- タグ: ジョブは
- 選択 ランナーを作成する をクリックしてトークンをコピーしてください。トークンは一度だけ表示されます。
トークンをパスワードのように扱います。トークンを持っている人なら誰でも、あなたのジョブを引き受けることができます。
2. マシンの登録
Section titled “2. マシンの登録”最も簡単な方法は、マシン上のターミナルで次のように実行することです:
champrep-code-runner register --url https://code.champrep.comランナーは、トークン(表示はされません)とエグゼキュータを要求します。トークンを確認した後、 ランナーの設定ファイルに保存します。
スクリプトで実行する場合は、トークンを標準入力またはファイルから渡すようにしてください。そうすれば、 シェル履歴やプロセス一覧にトークンが表示されることはありません:
printf '%s\n' "$RUNNER_TOKEN" | champrep-code-runner register \ --url https://code.champrep.com --token-stdin \ --name build-01 --executor shellchamprep-code-runner register --url https://code.champrep.com \ --token-file /root/runner-token --executor docker --docker-image alpine:3.24Windows では、管理者権限の PowerShell プロンプトから次のように入力してください:
$env:RUNNER_TOKEN | champrep-code-runner.exe register ` --url https://code.champrep.com --token-stdin --name win-build-01 ` --executor shell --shell pwsh
一般的なオプション
Section titled “一般的なオプション”| オプション | 意味 |
|---|---|
--url | ご自身の CodeCHAMPREP アドレス(例: https://code.champrep.com. |
--token-stdin / --token-file PATH | 標準入力またはファイルからトークンを読み込みます。 |
--name NAME | このマシン上のランナー名(デフォルト:ホスト名)。 |
--executor | shell, docker または kubernetes. |
--shell | シェルエグゼキュータの場合: bash, sh, pwsh または powershell. |
--docker-image IMAGE | Docker および Kubernetes エグゼキュータのデフォルトのジョブイメージ。 |
--kubernetes-namespace NS | このネームスペースで Kubernetes ジョブを実行します。 |
--limit N | このランナーでは、同時に実行できるジョブは最大 N 個です。 |
--non-interactive | プロンプトを表示せず、値が欠落している場合は失敗としてください。 |
--config PATH | この設定ファイルを使用してください(以下を参照)。 |
CHPCODE_RUNNER_URL 、 CHPCODE_RUNNER_TOKEN を置き換えることができます --url および トークンオプション。
設定の保存場所
Section titled “設定の保存場所”| 次のように実行した場合、 | ファイル |
|---|---|
| root (Linux、macOS) | /etc/champrep-runner/config.toml |
| 管理者権限のプロンプトまたはサービス(Windows) | %ProgramData%\champrep-runner\config.toml |
| その他のユーザー | ~/.champrep-runner/config.toml |
CHPCODE_RUNNER_CONFIG または --config 別のファイルを選択してください。そのファイルは 所有者のみが読み取り可能になっています。1台のマシンに複数のランナーを配置できます:別の 設定で再度登録してください --name.
3. 起動してください
Section titled “3. 起動してください”champrep-code-runner run # in this terminalchamprep-code-runner service install # or as a service that starts at boot参照 ランナーコマンド ステータスを確認したり、 停止したり、その他の操作を行うために。