Windows 用のランナーをセットアップする

Windows Runner によって、ユーザー自身の Windows インフラストラクチャ上の Pipelines でビルドを実行できます。セルフホスト Windows Runner で使用するビルド時間に対して課金されなくなります。

前提条件

すべての必要な前提条件をインストールするための chocolatey スクリプトの例を以下に示します。

ビルド時間を短縮するために、nuget、xUnit、nUnit など、Pipelines が必要とするその他の依存関係を事前にインストールすることをお勧めします。

未署名のスクリプトを PowerShell で実行することを許可する

Windows ページファイルとスワップファイルを無効にする

Windows 10 で pagefile.sys と swapfile.sys を無効にするには、次の手順に従います。次の手順がうまくいかない場合は、ディストリビューションのドキュメントをご参照のうえ、ご利用の Windows 環境を構成してください。

1. Windows で、[スタート] を選択して [スタート] メニューに「システムの詳細設定」と入力し、Enter キーを押して開きます。

2. [詳細設定] タブを選択して、[システムのプロパティ] ダイアログの [パフォーマンス] セクションにある [設定] ボタンをクリックします。

3. [詳細設定] タブを選択して、[パフォーマンス オプション] ダイアログの [仮想メモリ] セクションにある [変更] ボタンをクリックします。

4. [仮想メモリ] ダイアログの [各ドライブのページ ファイル サイズ] セクションで [すべてのドライブのページング ファイル サイズを自動で管理] を選択解除し、[ページング ファイルなし] > [設定] ボタンの順に選択します。

5. [OK] を選択して、システムを再起動します。

ランナーの使用

1. ランナー ページに移動します。

   • ワークスペース ランナーについては、[ワークスペース設定] > [ワークスペース ランナー] の順に移動してご確認ください。

   • リポジトリ ランナーについては、[リポジトリ設定] > [ランナー] の順に移動してご確認ください。

2. [ランナーを追加] を選択します。

3. [ランナー インストール] ダイアログの [システムとアーキテクチャ] で [Windows (64bit)] を選択します。

4. [Runner のインストール] ダイアログの Run ステップに表示された zip ファイルをダウンロードします。

5. ファイルを任意のディレクトリに解凍します。次に例を示します。C:\Users\your_user_name\atlassian_runners

6. 管理者として PowerShell を開いて Runner フォルダーの下の bin ディレクトリに移動し、[Runner のインストール] ダイアログの [実行] ステップに記載されたコマンドを実行します。

Windows Runners use PowerShell to run pipeline steps on your Windows machine (host device). This allows the runner to execute applications on the host, but does not provide a clean build environment for every step. Any side effects generated by the step (such as, installing any applications, starting a database service, or editing a file outside of the build directory) would potentially affect the next step to be run (including new pipeline runs). To compensate for this, the runner tries to empty the build directory empty after each step. It is your responsibility to make sure the scripts you run in each step won’t have a major impact on other steps.

Windows Runner の制限事項

制限と回避策

キャッシュ

• Pre-defined Docker cache is not supported — Docker and the Pipelines pre-defined Docker cache are not supported for Windows Runners.

• キャッシュを異なる OS 間で共有する — Windows ランナーや Linux ランナーなど、異なるキャッシュ名をランナー タイプごとに指定することをお勧めします。次に例を示します。

  pipelines: custom: customPipelineWithRunnerAndCache: - step: name: Step 1 runs-on: - 'windows' script: - echo "This step will run on a self hosted windows infrastructure."; caches: - windows_bundler - step: name: Step 2 runs-on: - 'linux' script: - echo "This step will run on a self hosted linux infrastructure."; caches: - linux_bundler - step: name: Step 3 runs-on: - 'linux' script: - echo "This step will run on Atlassian's infrastructure as usual."; caches: - linux_bundler definitions: caches: linux_bundler: vendor/bundle windows_bundler: vendor/bundle

  キャッシュには、他のオペレーティング システムでは動作しないプラットフォーム固有のファイルを含められます。キャッシュを異なるオペレーティング システム間で共有すると、Windows ランナーが Linux 専用に生成されたファイルを使用しようとした際など、エラーが発生する可能性があります。

• Bloated cache folder: Due to performance implications, we do not clean up the cache folder at the end of step execution. This may lead to the size of cache directories increasing rapidly, particularly for a workspace runner. If this occurs, we recommend creating a scheduled task to clean up cache folders on a regular basis. For information on creating scheduled tasks in PowerShell, visit Microsoft Docs — PowerShell New-ScheduledTask.

• キャッシュ フォルダーの場所は制限されていないため、キャッシュは、c:\windows を含めてデバイスの任意のディレクトリに保存できます。キャッシュを定義する場所の技術的な影響にご留意のうえ、ホスト マシンが復旧可能であることをご確認ください。

テスト レポート

.Net テスト レポートには、いくつかの追加セットアップが必要です。詳細についてはサポート ドキュメント「Pipelines のテスト レポート」をご参照ください

Git LFS

In order to use Git LFS, you need to install Git LFS on your hosted machine. If you use chocolatey, you can install Git LFS with the following PowerShell commands:

条件付きステップ

ステップ条件で定義された glob パスは、Windows でステップが実行されている場合でも、スラッシュ (/) のみをサポートしてバックスラッシュ (\) はサポートしません。したがって、以下の例のようになります。

SSH キー

次のような場合、Bitbucket Pipelines で SSH キーをセットアップすることができます。

• ビルドで Bitbucket やその他のホスティング サービスとの認証を行い、非公開の依存関係を取得する必要があります。

• デプロイで成果物をアップロードする前にリモート ホストまたはサービスとの認証を行う必要があります。

• SSH、SFTP、または SCP などのツールによってビルドする場合

セキュリティ上の理由から、ランナーは SSH キーをビルド環境に自動で追加しません。必要な場合は、保護された変数によって SSH キーをランナーに渡せます。

セキュアなリポジトリ変数を OpenSSH で使用して SSH キーを追加するには、次の手順に従います。

1. 以下のような OpenSSH をインストールします。

   choco install openssh

2. PowerShell で次のような新しい SSH キーを生成します。

   ssh-keygen -t rsa -b 4096 -N '' -f ~/.ssh/my_ssh_key

3. 非公開キーを base64 にエンコードします。現在、Pipelines では環境変数の改行はサポートされていません。次に例を示します。

   [convert]::ToBase64String((Get-Content -path "~/.ssh/my_ssh_key" -Encoding byte))

4. エンコードされたキーを保護された変数として追加します。エンコードされたキーを PowerShell からコピーして、次のようにセキュアな Bitbucket Pipelines 環境変数としてリポジトリに追加します。

   1. Bitbucket のリポジトリで、[リポジトリ設定] > [リポジトリ変数] の順に選択します。

   2. PowerShell から、base64 エンコード済みの非公開キーをコピーします。

   3. エンコード済みのキーを環境変数の値としてペーストします。[セキュア] が選択されていることを確認します。

5. 公開キーをリモート ホストにインストールします。Pipelines がそのホストを認証できるようになる前に、リモート ホストに公開キーをインストールする必要があります。Pipelines ビルドに他の Bitbucket リポジトリに対するアクセス権を付与する場合は、公開キーをそのリポジトリに追加する必要があります。

   SSH によってリモート ホストに公開キーをコピーするには、ssh-copy-id コマンドを使用します。このコマンドは、キーをリモート ホスト上の ~/.ssh/authorized_keys ファイルに追加します。

   ssh-copy-id -i my_ssh_key <username>@<remote_host>

   <username> はリモート ホスト上のユーザーです。

   サーバーへの SSH アクセスをテストするには、次の手順に従います。

   ssh -i ~/.ssh/my_ssh_key user@host

6. ホスト キーを取得して、ホスト VM (仮想マシン) の ~/.ssh/known_hosts ファイルに追加します。
   known_hosts ファイルには、ユーザーがアクセスする SSH サーバーの DSA ホスト キーが格納されます。適切なリモート ホストに接続していることを確認することが重要です。

   1. 任意のリモート サーバーの DSA ホスト キーを取得します。これを行うには、次のコマンドを実行します。

      ssh-keyscan -t rsa server.example.com

   2. これらのキーをホスト仮想マシンの ~/.ssh/known_hosts ファイルに追加します。無関係な行はすべて削除できます。

7. SSH キーを bitbucket-pipelines.yml ファイルに追加してデコードします。次に例を示します。

   pipelines: default: - step: runs-on: - self.hosted - windows script: - ([Text.Encoding]::ASCII.GetString([Convert]::FromBase64String($Env:MY_SSH_KEY))) | Out-File -Encoding "ASCII" id_rsa - ssh -T -i ./id_rsa git@bitbucket.org