グローバル オプション
bitbucket-pipelines.yml の options セクションでは、ステップの最大実行時間や Pipelines Docker コンテナーに割り当てられるリソースなど、リポジトリのすべてのパイプラインに対して、いくつかのグローバル オプションを設定できます。その他のオプションはグローバルに設定できますが、Git クローン オプション、Docker イメージ オプション、キャッシュとサービスのコンテナー オプションなど、bitbucket-pipelines.yml に専用のセクションを保持します。
パイプラインのグローバル オプション
以下のグローバル オプションは、options プロパティで設定されています。
オプション
すべてのパイプラインに適用するグローバル設定を含みます。
プロパティ — options
必須 — いいえ
データ タイプ — 改行で区切られたキーと値のペアのブロック (YAML 仕様 - ブロック マッピング)
指定可能な親プロパティ — YAML ルート (options は必ず最上位のプロパティとなります)
指定可能な子プロパティ — max-time、docker、size、および runtime プロパティが 1 つ以上必要です。
例 — options オプションを使用して、パイプラインのグローバル オプションを設定する
1
2
3
4
5
6
7
8
9
10
11
options:
max-time: 30
docker: true
size: 2x
pipelines:
default:
- step:
name: Hello world example
script:
- echo "Hello, World!"Docker
グローバル docker オプションは、パイプラインのすべてのステップに Docker サービスを追加します。この Docker サービスは、Docker コマンドを実行するためにいずれのパイプライン ステップでも使用できます。Bitbucket Pipeline での Docker の使用に関する情報は、「Bitbucket Pipelines で Docker コマンドを実行する」をご参照ください。
プロパティ — docker
必須 — いいえ
データ タイプ — ブール値
指定可能な値 — true または false
既定値 — false
指定可能な親プロパティ — options
例 — docker を使用して、Docker コマンドをすべてのパイプライン ステップで有効にする
1
2
3
4
5
6
7
8
9
10
options:
docker: true
pipelines:
default:
- step:
name: Hello world example
script:
- docker version
- docker run hello-world例 — services を使用して、単一ステップで Docker コマンドを有効にする
1
2
3
4
5
6
7
8
pipelines:
default:
- step:
script:
- docker version
- docker run hello-world
services:
- docker最長時間
max-time オプションは、タイムアウトする前にステップを実行できる最大時間 (分単位) を設定します。max-time オプションは、グローバル options プロパティと個々のパイプライン ステップの両方で設定できます。パイプライン ステップの既定の最大時間は 120 分です。
プロパティ — max-time
必須 — いいえ
データ タイプ — 整数
指定可能な値 — 1 と 720 の間の正の整数
既定値 — 120
例 — max-time オプションを使用して、パイプラインの各ステップに指定可能な最大時間を設定する
1
2
3
4
5
6
7
8
9
options:
max-time: 30
pipelines:
default:
- step:
name: Sleeping step
script:
- sleep 120m # This step will timeout after 30 minutes例 — max-time オプションを使用して、パイプラインの個別のステップに指定可能な最大時間を設定する
1
2
3
4
5
6
7
8
9
10
11
12
13
options:
max-time: 60
pipelines:
default:
- step:
name: Sleeping step
script:
- sleep 120m # This step will timeout after 60 minutes
- step:
name: quick step
max-time: 5
script:
- sleep 120m # This step will timeout after 5 minutesサイズ
size オプションは、Bitbucket Cloud インフラストラクチャまたは Linux Docker セルフホストランナーで実行する場合、ステップまたはパイプライン全体に追加のリソースを割り当てます。
このオプションは、ホストマシン上で利用可能なすべてのリソースを使用する Windows PowerShell、macOS シェル、Linux シェルランナーなどのシェルベースのランナーには影響しません。
デフォルトでは、Bitbucket Cloud インフラストラクチャまたは Linux Docker セルフホスト ランナー上で実行されるステップは、ボリュームをマウントするために、4GB のメモリ、4 つの CPU (他のタスクと共有される場合があります)、step あたり 64 GB のディスク容量にアクセスできます。
2x のサイズを指定すると、step またはパイプラインの空きメモリは 2 倍になります。割り当てられたメモリは step の script と step. の services の両方で共有されることに注意してください。
4x を超える size オプションを選択すると、追加の CPU リソースとディスク容量も確保されます。step に 4x 以上の size が割り当てられていると、該当する数の CPU への専用アクセスが保証され、ボリュームをマウントするためのより多くのディスク容量が得られます。
4x ステップでは 1x ステップのビルド時間の 4 倍、2x ステップは 1x ステップのビルド時間の 2 倍を使用します。
サイズに基づくリソース割り当て
サイズ | CPU | メモリ | ボリューム サイズ |
|---|---|---|---|
1x | 4 (共有) | 4 | 64 ギガバイト |
2x | 4 (共有) | 8 | 64 ギガバイト |
4x | 8 (専用) | 16 | 256 ギガバイト |
8x | 16 (専用) | 32 | 256 ギガバイト |
16x | 32 (専用) | 64 | 256 ギガバイト |
プロパティ — size
必須 — いいえ
データ タイプ — 文字列
指定可能な値 — 次のいずれか:
Bitbucket Cloud で実行されるパイプライン ステップの場合、1x、2x、4x、8x、または 16x
セルフホストのパイプライン ランナーで実行されるパイプライン ステップの場合、1x、2x、4x、8x、または 16x
4x、8x、および 16x のパイプライン サイズ オプションは、有料の Bitbucket Cloud プラン (Standard または Premium) で実行されているビルドでのみ利用できます。
既定値 — 1x
例 — size オプションを使用して、すべてのパイプライン ステップで利用可能なメモリを増やす
1
2
3
4
5
6
7
8
options:
size: 2x
pipelines:
default:
- step:
script:
- echo "2x memory is probably not needed for an echo command"例 — size オプションを使用して、パイプライン ステップで利用可能なメモリを増やす
1
2
3
4
5
6
pipelines:
default:
- step:
size: 2x
script:
- echo "This step gets double the memory!"ランタイム
ステップに適用されるランタイム設定です。
プロパティ — runtime
必須 — いいえ
データ タイプ — 改行で区切られたキーと値のペアのブロック (YAML 仕様 - ブロック マッピング)
指定可能な親プロパティ — options と step
指定可能な子プロパティ — cloud (必須)
例 - ランタイムを使用して、4x、8x、および 16x のすべてのステップで atlassian-ip-ranges を、すべてのステップで arm を有効にする
1
2
3
4
5
6
7
8
9
10
11
options:
runtime:
cloud:
atlassian-ip-ranges: true
arch: arm
pipelines:
default:
- step:
size: 4x
script:
- echo "I use atlassian-ip-ranges"例 - ランタイムを使用して、特定のステップで atlassian-ip-ranges と arm を有効にする
1
2
3
4
5
6
7
8
9
10
pipelines:
default:
- step:
size: 4x
runtime:
cloud:
atlassian-ip-ranges: true
arch: arm
script:
- echo "I use atlassian-ip-ranges"
クラウド ランタイム設定
クラウド ステップに適用されるランタイム設定です。
プロパティ — cloud
必須 — いいえ
データ タイプ — 改行で区切られたキーと値のペアのブロック (YAML 仕様 - ブロック マッピング)
指定可能な親プロパティ — runtime
指定可能な子プロパティ — atlassian-ip-ranges (オプション)、arch (オプション)
クラウド ランタイム設定用のアトラシアン IP 範囲
このオプションでは、入出力トラフィックのステップを実行するときに、既定の aws-ip-ranges と atlassian-ip-ranges のどちらを使用するかを指定します。
プロパティ — atlassian-ip-ranges
必須 — いいえ
データ タイプ — ブール値
指定可能な値 — true または false
既定値 — false
指定可能な親プロパティ — cloud
クラウド ランタイム設定のアーキテクチャ
このオプションは、ステップを実行するときに使用するアーキテクチャを制御します
プロパティ — arch
必須 — いいえ
データ タイプ — 文字列
指定可能な値 — arm または x86
既定値 — x86
指定可能な親プロパティ — cloud
arm オプションは、Bitbucket Cloud の Standard または Premium プランで実行されているビルドでのみ利用できます。
エクスポート - Bitbucket Premium のみ
パイプライン定義を同じワークスペース内の他のリポジトリと共有するかどうかを指定します。
プロパティ — export
必須 — いいえ
データ タイプ — ブール値
指定可能な値 — true または false
既定値 — false
指定可能な親プロパティ — YAML ルート (export は必ず最上位のプロパティとなります)
例 — エクスポート オプションで definitions セクションの pipelines をエクスポートする
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
export: true
definitions:
caches:
services:
pipelines:
export-pipeline:
- step:
script:
- echo hello
pipelines
default:
- step:
script:
- echo hello
この内容はお役に立ちましたか?