セルフホストランナーのセットアップ

さくらのクラウドのスタートアップスクリプト「セルフホストランナーのセットアップ」に関するページです。

1. 概要

GitHub Actionsワークフロー中で使用するランナーとして独自のランナーをホストできる、GitHub セルフホストランナー を簡単にセットアップできるスタートアップスクリプトです。

項目 概要・バージョン
対応OS Ubuntu 18.04 , Ubuntu 20.04
GitHubリポジトリ インストール時にURL入力(必須)
トークン インストール時に入力(必須)
GitHub上に表示されるランナーの名前 インストール時に入力(省略可)

2. 事前準備とスクリプトの処理内容

お客様作業

項目 概要
URLとトークンの取得 GitHubのリポジトリから、URLとトークンをコピーしておきます。

スタートアップスクリプトの内部処理

項目 概要
Dockerのインストール 公式のリファレンスにしたがってDockerのインストールをおこないます
runnerユーザの追加 セルフホストランナーが実行されるユーザを追加します
セルフホストランナーのインストール 公式のスクリプトconfig.shとsvc.shを実行してインストールを行います(/opt/actions-runner)

3. 利用手順

「セルフホストランナーのセットアップ」スタートアップスクリプトは以下の手順で作成・設定を行います。

GitHub上でトークンを取得

GitHubのリポジトリのSettings > Actions > Runners > Add Runner > Configureから、URLとトークンをコピーしておきます。

サーバの作成手順(1)

メニューの「サーバ」をクリックし、右上の「追加」をクリックします。

サーバ作成時に、シンプルモードのチェックを外します。

アーカイブは、[Ubuntu 18.04]または[Ubuntu 20.04]を選択します。

サーバの作成手順(2):スタートアップスクリプトの指定

「スタートアップスクリプト」のラジオボタンで「shell」を選択し、「配置するスタートアップスクリプト」で「SelfHostedRunner」を選択します。

登録先のリポジトリ、またはオーガニゼーション

GitHubから取得したURLを入力します。

トークン

GitHubから取得したトークンを入力します。

ランナーの名前

GitHub上に表示されるランナーの名前です。この項目を省略するとUUIDが生成され、その値が表示されます。