ドキュメント
circleci.com
Start Building for Free

CircleCI セルフホストランナーの Windows へのインストール

1 month ago1 min read
クラウド
Server v3.x
On This Page

このページでは、CircleCI セルフホストランナーを Windows にインストールする方法を説明します。 以下のインストール方法は、Windows Server 2019 と Windows Server 2016 の両方について、Datacenter エディションでテスト済みです。 デスクトップエクスペリエンスとリモートデスクトップサービスを備えたその他のサーバ SKU でも動作するはずです。

ここでは、CircleCI ローンチエージェントとその依存関係 (Chocolatey、Git、Gzip) を Windows サーバーにインストールします。

セットアップ中、CircleCI ジョブを実行する新しいローカル管理者ユーザーを作成します。 そのため、Windows サーバーで、ローカルユーザーを作成し、そのユーザーのリモートログオンを許可できる必要があります。

また、このセットアップをドメイン環境で行う際には、Windows サーバーがドメインメンバーである必要があります。 セルフホストランナーインスタンスは、ドメインコントローラーとして動作している Windows サーバーでは実行できません。

インストール手順

  1. GitHub から Install-CircleCIRunner.ps1 script をダウンロードし、アクセスしやすい場所に配置します。

  2. PowerShell を管理者として開き、スクリプト ファイルを配置したディレクトリに移動します。

  3. 以下を PowerShell で実行します。

    Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072;
    ./Install-CircleCIRunner.ps1

    PowerShell インターフェイスにインストール結果が出力されます。

  4. インストール中、セルフホストランナー (launch-agent-config.yaml) の設定ファイルがメモ帳で開かれます。 必要な情報をファイルに記入してください( セルフホストランナーの設定リファレンスを参照してください)。 設定ファイルはインストールディレクトリ (デフォルトは C:\Program Files\CircleCI) にあります。

セットアップが完了すると、ローンチエージェントが自動的に起動し、処理対象のジョブの検索を開始します。

ジョブでセルフホストランナーを参照する

セルフホストランナーのセットアップが完了したら、 .circleci/config.yml ファイルのフィールドを設定してジョブでセルフホストランナーを参照する必要があります。 セルフホストランナーを使って実行するジョブについて、以下のフィールドを指定します。

  • machine: true

  • resource_class: your-namespace/your-resource

以下に、ジョブのセットアップ方法の簡単な例を示します。

version: 2.1
workflows:
  testing:
    jobs:
      - runner
jobs:
  runner:
    machine: true
    resource_class: your-namespace/your-resource
    steps:
      - run: echo "Hi I'm on Runners!"

この設定ファイルを VCS プロバイダーにプッシュすると、セルフホストランナーを使ってジョブが実行されます。

アンインストール・再インストール手順

CircleCI セルフホストランナーをアンインストールすると、システムの再インストールの準備をします。

  1. GitHub から Uninstall-CircleCIRunner.ps1 script をダウンロードし、アクセスしやすい場所に配置します。

  2. PowerShell を管理者として開き、スクリプト ファイルを配置したディレクトリに移動します。

  3. 以下を PowerShell で実行します。

    ./Uninstall-CircleCIRunner.ps1

Windows セルフホストランナーの Continuous モードと Single task モード

Windows セルフホストランナーはデフォルトでは、セルフホストランナーがジョブの実行に使用する基盤テクノロジーの信頼性を高めるために、 Single task モード で実行されます。 Windows セルフホストランナーではこちらが、推奨モード です。

Windows セルフホストランナーは、continuous モードで実行することとも可能ですが、その場合、クリーンなジョブ環境が保証されません。 ジョブが期待どおりに実行されず、失敗する可能性があります。


ドキュメントの改善にご協力ください

このガイドは、CircleCI の他のドキュメントと同様にオープンソースであり、 GitHub でご利用いただけます。 ご協力いただき、ありがとうございます。

サポートが必要ですか

CircleCI のサポートエンジニアによる、サービスに関する問題、請求およびアカウントについての質問への対応、設定の構築に関する問題解決のサポートを行っています。 サポートチケットを送信して、CircleCI のサポートエンジニアにお問い合わせください。日本語でお問い合わせいただけます。

または、 サポートサイト から、サポート記事やコミュニティフォーラム、トレーニングリソースをご覧いただけます。