ワークロード API

completionDeadlineSeconds

integer

completeDeadlineSeconds は、ビルド Pod がシステムでスケジュールされた時間から数えて、システムがアクティブにビルドを終了しようとする前に、ノードでビルドがアクティブになる可能性がある秒単位の任意の期間です。値は正の整数でなければなりません

failedBuildsHistoryLimit

integer

failedBuildsHistoryLimit は、保持するために失敗した古いビルドの数です。BuildConfig が作成されると、この値が設定されていない限り、最近失敗した 5 つのビルドが保持されます。BuildConfig の作成後に削除すると、失敗したビルドはすべて保持されます。

mountTrustedCA

boolean

mountTrustedCA バインドは、クラスターのプロキシー設定で定義されているように、クラスターの信頼できる認証局をビルドにマウントします。これにより、プライベートアーティファクトリーポジトリーや HTTPS プロキシーなど、カスタム PKI 認証局により署名されたビルド信頼コンポーネント内のプロセスが可能になります。

このフィールドを true に設定すると、ビルド内の /etc/pki/ca-trust のコンテンツはビルドコンテナーにより管理され、このディレクトリーまたはそのサブディレクトリーへの変更 (たとえば、Dockerfile RUN 命令内) はビルドの出力イメージに永続化されなくなります。

nodeSelector

object (string)

nodeSelector は、ビルド Pod がノードに収まるようにするために true である必要があるセレクターです。nil の場合は、クラスターのデフォルトのビルドの nodeselector 値をオーバーライドできます。空のマップまたは任意の値のマップに設定されている場合、デフォルトのビルドの nodeselector 値は無視されます。

output

object

BuildOutput は、ビルドストラテジーへの入力であり、ストラテジーが生成する必要のあるコンテナーイメージを記述します。

postCommit

object

BuildPostCommitSpec は、ビルドポストコミットフック仕様を保持します。フックは、イメージの最後のレイヤーがコミットされた直後、イメージがレジストリーにプッシュされる前に、ビルド出力イメージを実行している一時コンテナーでコマンドを実行します。コマンドは、現在の作業ディレクトリー ($ PWD) をイメージの WORKDIR に設定して実行されます。

フックの実行が失敗すると、ビルドは失敗としてマークされます。スクリプトまたはコマンドがゼロ以外の終了コードを返す場合、または一時コンテナーの開始に関連するその他のエラーがある場合は失敗します。

フックを設定するには、5 つの異なる方法があります。例として、以下のすべての形式は同等であり、rake test --verbose を実行します。

1.シェルスクリプト:

"postCommit": { "script": "rake test --verbose", }

上記は、以下と同等の便利な形式です。

"postCommit": { "command": ["/bin/sh", "-ic"], "args": ["rake test --verbose"] }

2.イメージエントリーポイントとしてのコマンド:

"postCommit": { "commit": ["rake", "test", "--verbose"] }

Docker (https://docs.docker.com/engine/reference/builder/#entrypoint) に記載されているように、コマンドは exec 形式のイメージエントリーポイントをオーバーライドします。

3.デフォルトのエントリーポイントに引数を渡します。

"postCommit": { "args": ["rake", "test", "--verbose"] }

この形式は、イメージエントリーポイントが引数を処理できる場合にのみ役立ちます。

4.引数を指定したシェルスクリプト:

"postCommit": { "script": "rake test $1", "args": ["--verbose"] }

このフォームは、引数を渡す必要があるが、シェルスクリプトで正しく引用するのが困難な場合に有益です。上記のスクリプトでは、$0 は "/bin/sh" で、$1、$2 などは Args の位置引数となります。

5.引数のあるコマンド:

"postCommit": { "command": ["rake", "test"], "args": ["--verbose"] }

この形式は、Command スライスに引数を追加するのと同じです。

スクリプトとコマンドの両方を同時に提供することは無効です。どのフィールドも指定されていないと、フックは実行されません。

resources

ResourceRequirements

resources は、ビルドを実行するためのリソース要件を計算します。

revision

object

SourceRevision は、ビルドのソースからのリビジョンまたはコミット情報です

runPolicy

string

RunPolicy は、このビルド設定から作成された新しいビルドの実行がどのようにスケジュールされるかを記述します。これは任意です。指定されていない場合は、デフォルトで "Serial" になります。

serviceAccount

string

serviceAccount は、このビルドで作成された Pod を実行するのに使用する ServiceAccount の名前です。Pod は、ServiceAccount によって参照されるシークレットを使用できます。

source

object

BuildSource は、ビルドに使用される SCM です。

strategy

object

BuildStrategy には、ビルドを実行する方法の詳細が含まれています。

successfulBuildsHistoryLimit

integer

successfulBuildsHistoryLimit は、保持する古い成功したビルドの数です。BuildConfig が作成されると、この値が設定されていない限り、最近成功した 5 つのビルドが保持されます。BuildConfig の作成後に削除すると、成功したすべてのビルドが保持されます。

triggers

array

トリガーは、BuildConfig から新しいビルドを起動する方法を決定します。トリガーが定義されていない場合、新しいビルドは、明示的なクライアントビルドの作成の結果としてのみ発生します。

triggers[]

object

BuildTriggerPolicy は、新しいビルドをもたらす単一のトリガーのポリシーを記述します。

imageLabels

array

imageLabels は、結果として生成されるイメージに適用されるラベルのリストを定義します。同じ名前のラベルが複数ある場合は、リストの最後のラベルが使用されます。

imageLabels[]

object

ImageLabel は、結果のイメージに適用されるラベルを表します。

pushSecret

LocalObjectReference

PushSecret は、認証が有効な Docker レジストリー (または Docker Hub) への Docker プッシュを実行するための認証を設定するために使用される Secret の名前です。

to

ObjectReference

このビルドの出力をプッシュする任意の場所を定義します。種類は 'ImageStreamTag' または 'DockerImage' のいずれかである必要があります。この値は、プッシュ先のコンテナーイメージリポジトリーを検索するのに使用されます。ImageStreamTag の場合は、Namespace が指定されていない限り、ImageStreamTag はビルドの namespace で検索されます。

name

string

name は、ラベルの名前を定義します。ゼロ以外の長さを持つ必要があります。

value

string

値は、ラベルのリテラル値を定義します。

args

array (string)

args は、Command、Script、またはコンテナーイメージのデフォルトのエントリーポイントのいずれかに提供される引数のリストです。引数は、実行するコマンドの直後に配置されます。

command

array (string)

command は実行するコマンドです。スクリプトでは指定できない場合があります。これは、イメージに /bin/sh がない場合、またはシェルを使用しない場合に必要になることがあります。その他の場合は、Script を使用することが便利な方法になります。

script

string

script は、/bin/sh -ic で実行されるシェルスクリプトです。Command で指定できない場合があります。シェルスクリプトがビルド後のフックを実行するのに適切な場合、たとえば rake test を使用して単体テストを実行する場合は、Script を使用します。イメージのエントリーポイントを制御する必要がある場合、またはイメージに /bin/sh がない場合は、Command または Args、あるいはその両方を使用します。-i フラグは、Software Collections (SCL) を使用する CentOS イメージおよび RHEL イメージをサポートし、シェルで適切なコレクションを有効にするために必要です。たとえば、Ruby イメージでは、これは、ruby、bundle、およびその他のバイナリーを PATH で使用できるようにするために必要です。

git

object

GitSourceRevision は、ビルド用の git ソースからのコミット情報です。

type

string

ビルドソースのタイプ。'Source'、'Dockerfile'、'Binary'、または 'Images' のいずれかになります。

author

object

SourceControlUser は、ソース管理のユーザーの ID を定義します。

commit

string

commit は、特定のコミットを識別するコミットハッシュです。

committer

object

SourceControlUser は、ソース管理のユーザーの ID を定義します。

message

string

メッセージは特定のコミットの説明です

email

string

ソース管理ユーザーの電子メール

name

string

ソース管理ユーザーの名前

email

string

ソース管理ユーザーの電子メール

name

string

ソース管理ユーザーの名前

バイナリー

object

BinaryBuildSource は、Docker および Source ビルドストラテジーに使用されるバイナリーファイルを記述します。ファイルは抽出され、ビルドソースとして使用されます。

configMaps

array

configMaps は、ビルドに使用される configMap とその宛先のリストを表します。

configMaps[]

object

ConfigMapBuildSource は、ビルド時にのみ使用される configmap とその宛先ディレクトリーを記述します。ここで参照されている configmap の内容は、マウントする代わりに宛先ディレクトリーにコピーされます。

contextDir

string

contextDir は、アプリケーションのソースコードが存在するサブディレクトリーを指定します。これにより、リポジトリーのルート以外のディレクトリーにビルド可能なソースを含めることができます。

dockerfile

string

dockerfile は、ビルドする必要のある Dockerfile の生のコンテンツです。このオプションを指定すると、戦略ベースイメージに基づいて FROM が変更され、戦略環境からの追加の ENV スタンザが FROM から、残りの Dockerfile スタンザの間に追加されます。Dockerfile ソースタイプは、git などの他のオプションとともに使用できます。その場合、Git リポジトリーでは、コンテキストディレクトリーで固有の Dockerfile が置き換えられます。

git

object

GitBuildSource は、Git SCM のパラメーターを定義します

images

array

images は、ビルドのソースを提供するのに使用される一連のイメージを記述します

images[]

object

ImageSource は、イメージから抽出されるか、マルチステージビルド中に使用されるビルドソースを記述するのに使用されます。タイプ ImageStreamTag、ImageStreamImage、または DockerImage の参照を使用できます。プルシークレットを指定して、外部レジストリーからイメージをプルするか、内部レジストリーからプルする場合はデフォルトのサービスアカウントシークレットを上書きできます。イメージソースを使用して、イメージからコンテンツを抽出し、リポジトリーソースと一緒にビルドコンテキストに配置するか、マルチステージコンテナーイメージのビルド中に直接使用して、リポジトリーソースのコンテンツを上書きせずにコンテンツをコピーできるようにします。('paths' および 'as' フィールドを参照してください)。

secrets

array

secrets は、ビルドにのみ使用されるシークレットとその宛先のリストを表します。

secrets[]

object

SecretBuildSource は、ビルド時にのみ使用されるシークレットとその宛先ディレクトリーを記述します。ここで参照されているシークレットの内容は、マウントする代わりに宛先ディレクトリーにコピーされます。

sourceSecret

LocalObjectReference

sourceSecret は、プライベートリポジトリーのクローンを作成するための認証を設定するのに使用される Secret の名前です。シークレットには、リモートリポジトリーの有効な認証情報が含まれています。ここで、データのキーは使用される認証方法を表し、値は base64 でエンコードされた認証情報です。サポートされている認証方法は ssh-privatekey です。

type

string

受け入れるビルド入力のタイプ

asFile

string

asFile は、提供されたバイナリー入力がビルド入力内の単一ファイルと見なされる必要があることを示します。たとえば、"webapp.war" を指定すると、提供されたバイナリーがビルダーの /webapp.war として配置されます。空のままにした場合、Docker および Source ビルド戦略は、このファイルが zip、tar、または tar.gz ファイルであると想定し、ソースとして抽出します。カスタム戦略は、このバイナリーを標準入力として受け取ります。このファイル名にはスラッシュを含めたり、'..' または '.' にすることはできません。

configMap

LocalObjectReference

configMap は、ビルドで使用する既存の configmap への参照です。

destinationDir

string

destinationDir は、ビルド時に configmap のファイルを使用できるディレクトリーです。ソースビルド戦略の場合、これらはアセンブルスクリプトが実行されるコンテナーに挿入されます。コンテナーイメージのビルド戦略では、これらは Dockerfile が配置されているビルドディレクトリーにコピーされるため、ユーザーはコンテナーイメージのビルド中にそれらを追加またはコピーできます。

httpProxy

string

httpProxy は、http 経由で git リポジトリーに到達するのに使用されるプロキシーです。

httpsProxy

string

httpsProxy は、https 経由で git リポジトリーに到達するのに使用されるプロキシーです。

noProxy

string

noProxy は、プロキシーを使用してはならないドメインのリストです。

ref

string

ref は、ビルドするブランチ/タグ/参照です。

uri

string

uri は、ビルドされるソースを指します。ソースの構造は、実行するビルドのタイプによって異なります

as

array (string)

マルチステージコンテナーイメージのビルド中にこのソースが代わりに使用されるイメージ名のリスト。たとえば、"COPY --from=nginx:latest" を使用する Dockerfile は、直接プルを試みる前に、このフィールドに "nginx:latest" が含まれるイメージソースを最初にチェックします。Dockerfile がイメージソースを参照していない場合、それは無視されます。このフィールドとパスの両方を設定できます。その場合、コンテンツは 2 回使用されます。

from

ObjectReference

from は、ソースをコピーする ImageStreamTag、ImageStreamImage、または DockerImage への参照です。

paths

array

パスは、イメージからコピーするソースパスおよび宛先パスのリストです。このコンテンツは、ビルドを開始する前にビルドコンテキストにコピーされます。パスが設定されていない場合、ビルドコンテキストは変更されません。

paths[]

object

ImageSourcePath は、ビルドディレクトリー内のソースイメージとその宛先からコピーされるパスを記述します。

pullSecret

LocalObjectReference

pullSecret は、レジストリーからイメージをプルするのに使用されるシークレットへの参照です。イメージが OpenShift レジストリーからプルされる場合は、このフィールドを設定する必要がありません。

destinationDir

string

destinationDir は、イメージからコピーされたファイルが配置されるビルドディレクトリー内の相対ディレクトリーです。

sourcePath

string

sourcePath は、ビルドディレクトリーにコピーするイメージ内のファイルまたはディレクトリーの絶対パスです。ソースパスの末尾は /. であり、ディレクトリーのコンテンツがコピーされますが、ディレクトリー自体は宛先で作成されません。

destinationDir

string

destinationDir は、ビルド時にシークレットのファイルを使用できるディレクトリーです。ソースビルド戦略の場合、これらはアセンブルスクリプトが実行されるコンテナーに挿入されます。その後、スクリプトが終了すると、挿入されたすべてのファイルの長さがゼロに切り捨てられます。コンテナーイメージのビルド戦略では、これらは Dockerfile が配置されているビルドディレクトリーにコピーされるため、ユーザーはコンテナーイメージのビルド中にそれらを追加またはコピーできます。

secret

LocalObjectReference

secret は、ビルドで使用する既存のシークレットへの参照です。

customStrategy

object

CustomBuildStrategy は、カスタムビルドに固有の入力パラメーターを定義します。

dockerStrategy

object

DockerBuildStrategy は、コンテナーイメージビルドに固有の入力パラメーターを定義します。

jenkinsPipelineStrategy

object

JenkinsPipelineBuildStrategy は、Jenkins Pipeline ビルドに固有のパラメーターを保持します。非推奨: OpenShift Pipelines を使用する

sourceStrategy

object

SourceBuildStrategy は、ソースビルドに固有の入力パラメーターを定義します。

type

string

タイプはビルド戦略の一種です。

buildAPIVersion

string

buildAPIVersion は、シリアル化されてカスタムビルダーに渡される Build オブジェクトに対して要求された API バージョンです。

env

array (EnvVar)

env には、ビルダーコンテナーに渡す追加の環境変数が含まれています。

exposeDockerSocket

boolean

exposeDockerSocket を使用すると、コンテナー内から Docker コマンドを実行 (およびコンテナーイメージをビルド) できます。

forcePull

boolean

forcePull は、コントローラーがビルド Pod を設定して、ビルダーのイメージを常にプルするか、ローカルに存在しない場合にのみプルするかを記述します。

from

ObjectReference

from は、コンテナーイメージのプル元となる DockerImage、ImageStreamTag、または ImageStreamImage への参照です。

pullSecret

LocalObjectReference

pullSecret は、プライベート Docker レジストリーからコンテナーイメージをプルするための認証を設定するために使用される Secret の名前です。

secrets

array

secrets は、ビルド Pod に含まれる追加のシークレットのリストです

secrets[]

object

SecretSpec は、ビルド Pod とそれに対応するマウントポイントに含まれるシークレットを指定します

mountPath

string

mountPath は、シークレットをマウントするパスです。

secretSource

LocalObjectReference

secretSource はシークレットへの参照です

buildArgs

array (EnvVar)

buildArgs には、Dockerfile で解決されるビルド引数が含まれています。詳細は、https://docs.docker.com/engine/reference/builder/#/arg を参照してください。注意: 'name' フィールドおよび 'value' フィールドのみがサポートされます。'valueFrom' フィールドの設定は無視されます。

dockerfilePath

string

dockerfilePath は、コンテキストのルート (contextDir) を基準にした、コンテナーイメージの構築に使用される Dockerfile のパスです。設定されていない場合は、デフォルトで Dockerfile になります。

env

array (EnvVar)

env には、ビルダーコンテナーに渡す追加の環境変数が含まれています。

forcePull

boolean

forcePull は、ビルダーがビルドする前にレジストリーからイメージをプルする必要があるかどうかを記述します。

from

ObjectReference

from は、ビルド用の Dockerfile 内の FROM イメージをオーバーライドする DockerImage、ImageStreamTag、または ImageStreamImage への参照です。Dockerfile がマルチステージビルドを使用する場合、これはファイルの最後の FROM ディレクティブのイメージを置き換えます。

imageOptimizationPolicy

string

imageOptimizationPolicy は、イメージを構築するときにシステムが使用できる最適化を記述して、イメージの構築に費やされる最終的なサイズまたは時間を削減します。デフォルトのポリシーは 'None' です。これは、最終的なビルドイメージがコンテナーイメージビルド API によって作成されたイメージと同等になることを意味します。実験的なポリシー 'SkipLayers' は、各イメージステップの間に新しいレイヤーをコミットすることを回避し、Dockerfile が 'None' ポリシーとの互換性を提供できない場合は失敗します。追加の実験的なポリシー 'SkipLayersAndWarn' は 'SkipLayers' と同じですが、互換性を維持できない場合は単に警告します。

noCache

boolean

noCache が true に設定されている場合、コンテナーイメージのビルドは --no-cache=true フラグを指定して実行する必要があることを示します

pullSecret

LocalObjectReference

pullSecret は、プライベート Docker レジストリーからコンテナーイメージをプルするための認証を設定するために使用される Secret の名前です。

volumes

array

ボリュームは、ビルドのランタイム環境にマウントできる入力ボリュームのリストです。ビルドでサポートされているのは、Kubernetes Volume ソースのサブセットのみです。詳細: https://kubernetes.io/docs/concepts/storage/volumes

volumes[]

object

BuildVolume は、buildah のランタイム環境にマウントできるように、Pod をビルドするのに使用できるようになるボリュームを記述します。Kubernetes ボリュームソースのサブセットのみがサポートされています。

mounts

array

mounts は、イメージビルドコンテナー内のボリュームの場所を表します

mounts[]

object

BuildVolumeMount は、buildah のランタイム環境内でのボリュームのマウントを説明します。

name

string

name は、この BuildVolume の一意の識別子です。Kubernetes DNS ラベル標準に準拠し、Pod 内で一意である必要があります。名前が、ビルドコントローラーにより追加された名前と競合するとビルドが失敗し、エラーの原因となった名前の詳細を示すエラーメッセージが表示されます。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

source

object

BuildVolumeSource は、マウントするボリュームのソースを表します。サポートされているタイプの 1 つだけを常に指定できます。

destinationPath

string

destinationPath は、ボリュームをマウントする必要がある buildah ランタイム環境内のパスです。ビルドイメージ内の一時マウントとバッキングボリュームは両方とも読み取り専用でマウントされます。絶対パスである必要があり、'..' または ':' を含めることはできません。また、ビルダープロセスにより生成された宛先パスと競合してはなりません。このパスが、ビルドコントローラーにより追加されたパスと競合すると、ビルドが失敗し、エラーの原因となったパスの詳細を示すエラーメッセージが表示されます。

configMap

ConfigMapVolumeSource

configMap は、このボリュームに入力する必要がある ConfigMap を表します

csi

CSIVolumeSource

csi は、このケイパビリティーをサポートする外部 CSI ドライバーが提供する一時ストレージを表します。

secret

SecretVolumeSource

secret は、このボリュームに入力する必要がある Secret を表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#secret

type

string

type は、ボリュームソースの BuildVolumeSourceType です。Type は、入力されたボリュームソースと一致する必要があります。有効なタイプは、Secret、ConfigMap です。

env

array (EnvVar)

env には、ビルドパイプラインに渡す追加の環境変数が含まれています。

jenkinsfile

string

Jenkinsfile は、Jenkins パイプラインビルドを定義する Jenkinsfile の任意の raw コンテンツを定義します。

jenkinsfilePath

string

JenkinsfilePath は、コンテキストのルート (contextDir) を基準にしてパイプラインを設定するのに使用される Jenkinsfile の任意のパスです。JenkinsfilePath と Jenkinsfile の両方が指定されていない場合、これはデフォルトで、指定された contextDir のルートにある Jenkinsfile になります。

env

array (EnvVar)

env には、ビルダーコンテナーに渡す追加の環境変数が含まれています。

forcePull

boolean

forcePull は、ビルダーがビルドする前にレジストリーからイメージをプルする必要があるかどうかを記述します。

from

ObjectReference

from は、コンテナーイメージのプル元となる DockerImage、ImageStreamTag、または ImageStreamImage への参照です。

incremental

boolean

増分フラグは、true の場合、ソースビルドに増分ビルドを強制します。

pullSecret

LocalObjectReference

pullSecret は、プライベート Docker レジストリーからコンテナーイメージをプルするための認証を設定するために使用される Secret の名前です。

scripts

string

Source はソーススクリプトの場所です

volumes

array

ボリュームは、ビルドのランタイム環境にマウントできる入力ボリュームのリストです。ビルドでサポートされているのは、Kubernetes Volume ソースのサブセットのみです。詳細: https://kubernetes.io/docs/concepts/storage/volumes

volumes[]

object

BuildVolume は、buildah のランタイム環境にマウントできるように、Pod をビルドするのに使用できるようになるボリュームを記述します。Kubernetes ボリュームソースのサブセットのみがサポートされています。

mounts

array

mounts は、イメージビルドコンテナー内のボリュームの場所を表します

mounts[]

object

BuildVolumeMount は、buildah のランタイム環境内でのボリュームのマウントを説明します。

name

string

name は、この BuildVolume の一意の識別子です。Kubernetes DNS ラベル標準に準拠し、Pod 内で一意である必要があります。名前が、ビルドコントローラーにより追加された名前と競合するとビルドが失敗し、エラーの原因となった名前の詳細を示すエラーメッセージが表示されます。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

source

object

BuildVolumeSource は、マウントするボリュームのソースを表します。サポートされているタイプの 1 つだけを常に指定できます。

destinationPath

string

destinationPath は、ボリュームをマウントする必要がある buildah ランタイム環境内のパスです。ビルドイメージ内の一時マウントとバッキングボリュームは両方とも読み取り専用でマウントされます。絶対パスである必要があり、'..' または ':' を含めることはできません。また、ビルダープロセスにより生成された宛先パスと競合してはなりません。このパスが、ビルドコントローラーにより追加されたパスと競合すると、ビルドが失敗し、エラーの原因となったパスの詳細を示すエラーメッセージが表示されます。

configMap

ConfigMapVolumeSource

configMap は、このボリュームに入力する必要がある ConfigMap を表します

csi

CSIVolumeSource

csi は、このケイパビリティーをサポートする外部 CSI ドライバーが提供する一時ストレージを表します。

secret

SecretVolumeSource

secret は、このボリュームに入力する必要がある Secret を表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#secret

type

string

type は、ボリュームソースの BuildVolumeSourceType です。Type は、入力されたボリュームソースと一致する必要があります。有効なタイプは、Secret、ConfigMap です。

bitbucket

object

WebHookTrigger は、Webhook タイプの投稿を使用して呼び出されるトリガーです。

generic

object

WebHookTrigger は、Webhook タイプの投稿を使用して呼び出されるトリガーです。

github

object

WebHookTrigger は、Webhook タイプの投稿を使用して呼び出されるトリガーです。

gitlab

object

WebHookTrigger は、Webhook タイプの投稿を使用して呼び出されるトリガーです。

imageChange

object

ImageChangeTrigger を使用すると、ImageStream が変更されたときにビルドをトリガーできます

type

string

type は、ビルドトリガーのタイプです。有効な値は以下のとおりです。

- GitHub GitHubWebHookBuildTriggerType は、GitHub Webhook 呼び出しでビルドを起動するトリガーを表します

- Generic GenericWebHookBuildTriggerType は、汎用 Webhook 呼び出しでビルドを起動するトリガーを表します

- GitLab GitLabWebHookBuildTriggerType は、GitLab Webhook 呼び出しでビルドを起動するトリガーを表します

- Bitbucket BitbucketWebHookBuildTriggerType は、Bitbucket Webhook 呼び出しでビルドを起動するトリガーを表します

- ImageChange ImageChangeBuildTriggerType は、新しいバージョンのイメージの可用性に基づいてビルドを起動するトリガーを表します

- ConfigChange ConfigChangeBuildTriggerType は、最初のビルド設定の作成時にビルドをトリガーします。警告: 将来、動作が変更され、設定の変更時にビルドがトリガーされます

allowEnv

boolean

allowEnv は、Webhook が環境変数を設定できるかどうかを判別します。GenericWebHook に対してのみ true に設定できます。

secret

string

リクエストの検証に使用されるシークレット。非推奨: 代わりに SecretReference を使用してください。

secretReference

object

SecretLocalReference には、使用されているローカルシークレットを指す情報が含まれています

name

string

Name は、参照されている同じ namespace 内のリソースの名前です。

allowEnv

boolean

allowEnv は、Webhook が環境変数を設定できるかどうかを判別します。GenericWebHook に対してのみ true に設定できます。

secret

string

リクエストの検証に使用されるシークレット。非推奨: 代わりに SecretReference を使用してください。

secretReference

object

SecretLocalReference には、使用されているローカルシークレットを指す情報が含まれています

name

string

Name は、参照されている同じ namespace 内のリソースの名前です。

allowEnv

boolean

allowEnv は、Webhook が環境変数を設定できるかどうかを判別します。GenericWebHook に対してのみ true に設定できます。

secret

string

リクエストの検証に使用されるシークレット。非推奨: 代わりに SecretReference を使用してください。

secretReference

object

SecretLocalReference には、使用されているローカルシークレットを指す情報が含まれています

name

string

Name は、参照されている同じ namespace 内のリソースの名前です。

allowEnv

boolean

allowEnv は、Webhook が環境変数を設定できるかどうかを判別します。GenericWebHook に対してのみ true に設定できます。

secret

string

リクエストの検証に使用されるシークレット。非推奨: 代わりに SecretReference を使用してください。

secretReference

object

SecretLocalReference には、使用されているローカルシークレットを指す情報が含まれています

name

string

Name は、参照されている同じ namespace 内のリソースの名前です。

from

ObjectReference

from は、更新時にビルドをトリガーする ImageStreamTag への参照です。これはオプションです。From が指定されていない場合は、ビルドストラテジーの From イメージが使用されます。ビルド設定では、From 参照が空の ImageChangeTrigger を 1 つだけ許可します。

lastTriggeredImageID

string

lastTriggeredImageID は、ビルド用に最後に使用されたイメージ ID を保存するために ImageChangeController によって内部的に使用されます。このフィールドは非推奨であり、将来のリリースで削除される予定です。非推奨

paused

boolean

このトリガーが一時的に無効になっている場合、paused は true です。任意。

imageChangeTriggers

array

ImageChangeTriggers は、BuildConfigSpec で指定された ImageChangeTrigger のランタイム状態をキャプチャーします。これには、OpenShift APIServer によって lastTriggeredImageID に対して調整された値が含まれます。この配列には、仕様のイメージ変更トリガーごとに 1 つのエントリーがあります。各トリガーステータスは、トリガーのソースとして機能する ImageStreamTag を参照します。

imageChangeTriggers[]

object

ImageChangeTriggerStatus は、BuildConfigSpec.Triggers 構造体で指定された関連する ImageChangeTrigger ポリシーの最新の解決済みステータスを追跡します。

lastVersion

integer

lastVersion は、最後にトリガーされたビルドの数を通知するのに使用されます。

from

object

ImageStreamTagReference は、namespace および名前によりイメージ変更トリガーの ImageStreamTag を参照します。

lastTriggerTime

time

lastTriggerTime は、この特定の ImageStreamTag が Build の開始をトリガーした最後の時間です。このフィールドは、このトリガーが具体的に Build を開始したときにのみ更新されます。

lastTriggeredImageID

string

lastTriggeredImageID は、この BuildConfig のビルドが開始したときの ImageStreamTag の sha/id を表します。lastTriggeredImageID は、この ImageStreamTag が Build が開始される理由ではない場合でも、この BuildConfig のビルドが開始されるたびに更新されます。

name

string

name は、ImageChangeTrigger の ImageStreamTag の名前です。

namespace

string

namespace は、ImageChangeTrigger の ImageStreamTag が配置されている namespace です。

200 - OK

BuildConfigList スキーマ

401 - Unauthorized

空白

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

200 - OK

Status スキーマ

401 - Unauthorized

空白

200 - OK

BuildConfigList スキーマ

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

body

BuildConfig スキーマ

200 - OK

BuildConfig スキーマ

201 - Created

BuildConfig スキーマ

202 - Accepted

BuildConfig スキーマ

401 - Unauthorized

空白

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

name

string

BuildConfig の名前

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

200 - OK

BuildConfig スキーマ

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

200 - OK

BuildConfig スキーマ

201 - Created

BuildConfig スキーマ

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

body

BuildConfig スキーマ

200 - OK

BuildConfig スキーマ

201 - Created

BuildConfig スキーマ

401 - Unauthorized

空白

name

string

BuildConfig の名前

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

completionDeadlineSeconds

integer

completeDeadlineSeconds は、ビルド Pod がシステムでスケジュールされた時間から数えて、システムがアクティブにビルドを終了しようとする前に、ノードでビルドがアクティブになる可能性がある秒単位の任意の期間です。値は正の整数でなければなりません

mountTrustedCA

boolean

mountTrustedCA バインドは、クラスターのプロキシー設定で定義されているように、クラスターの信頼できる認証局をビルドにマウントします。これにより、プライベートアーティファクトリーポジトリーや HTTPS プロキシーなど、カスタム PKI 認証局により署名されたビルド信頼コンポーネント内のプロセスが可能になります。

このフィールドを true に設定すると、ビルド内の /etc/pki/ca-trust のコンテンツはビルドコンテナーにより管理され、このディレクトリーまたはそのサブディレクトリーへの変更 (たとえば、Dockerfile RUN 命令内) はビルドの出力イメージに永続化されなくなります。

nodeSelector

object (string)

nodeSelector は、ビルド Pod がノードに収まるようにするために true である必要があるセレクターです。nil の場合は、クラスターのデフォルトのビルドの nodeselector 値をオーバーライドできます。空のマップまたは任意の値のマップに設定されている場合、デフォルトのビルドの nodeselector 値は無視されます。

output

object

BuildOutput は、ビルドストラテジーへの入力であり、ストラテジーが生成する必要のあるコンテナーイメージを記述します。

postCommit

object

BuildPostCommitSpec は、ビルドポストコミットフック仕様を保持します。フックは、イメージの最後のレイヤーがコミットされた直後、イメージがレジストリーにプッシュされる前に、ビルド出力イメージを実行している一時コンテナーでコマンドを実行します。コマンドは、現在の作業ディレクトリー ($ PWD) をイメージの WORKDIR に設定して実行されます。

フックの実行が失敗すると、ビルドは失敗としてマークされます。スクリプトまたはコマンドがゼロ以外の終了コードを返す場合、または一時コンテナーの開始に関連するその他のエラーがある場合は失敗します。

フックを設定するには、5 つの異なる方法があります。例として、以下のすべての形式は同等であり、rake test --verbose を実行します。

1.シェルスクリプト:

"postCommit": { "script": "rake test --verbose", }

上記は、以下と同等の便利な形式です。

"postCommit": { "command": ["/bin/sh", "-ic"], "args": ["rake test --verbose"] }

2.イメージエントリーポイントとしてのコマンド:

"postCommit": { "commit": ["rake", "test", "--verbose"] }

Docker (https://docs.docker.com/engine/reference/builder/#entrypoint) に記載されているように、コマンドは exec 形式のイメージエントリーポイントをオーバーライドします。

3.デフォルトのエントリーポイントに引数を渡します。

"postCommit": { "args": ["rake", "test", "--verbose"] }

この形式は、イメージエントリーポイントが引数を処理できる場合にのみ役立ちます。

4.引数を指定したシェルスクリプト:

"postCommit": { "script": "rake test $1", "args": ["--verbose"] }

このフォームは、引数を渡す必要があるが、シェルスクリプトで正しく引用するのが困難な場合に有益です。上記のスクリプトでは、$0 は "/bin/sh" で、$1、$2 などは Args の位置引数となります。

5.引数のあるコマンド:

"postCommit": { "command": ["rake", "test"], "args": ["--verbose"] }

この形式は、Command スライスに引数を追加するのと同じです。

スクリプトとコマンドの両方を同時に提供することは無効です。どのフィールドも指定されていないと、フックは実行されません。

resources

ResourceRequirements

resources は、ビルドを実行するためのリソース要件を計算します。

revision

object

SourceRevision は、ビルドのソースからのリビジョンまたはコミット情報です

serviceAccount

string

serviceAccount は、このビルドで作成された Pod を実行するのに使用する ServiceAccount の名前です。Pod は、ServiceAccount によって参照されるシークレットを使用できます。

source

object

BuildSource は、ビルドに使用される SCM です。

strategy

object

BuildStrategy には、ビルドを実行する方法の詳細が含まれています。

triggeredBy

array

triggeredBy は、ビルド設定の最新の更新を開始したトリガーを記述し、そのトリガーに関する情報を含みます。

triggeredBy[]

object

BuildTriggerCause は、トリガーされたビルドに関する情報を保持します。これは、oc describe の各ビルドおよびビルド設定のビルドトリガーデータを表示するのに使用されます。また、ビルド設定の最新の更新につながったトリガーを説明するためにも使用されます。

imageLabels

array

imageLabels は、結果として生成されるイメージに適用されるラベルのリストを定義します。同じ名前のラベルが複数ある場合は、リストの最後のラベルが使用されます。

imageLabels[]

object

ImageLabel は、結果のイメージに適用されるラベルを表します。

pushSecret

LocalObjectReference

PushSecret は、認証が有効な Docker レジストリー (または Docker Hub) への Docker プッシュを実行するための認証を設定するために使用される Secret の名前です。

to

ObjectReference

このビルドの出力をプッシュする任意の場所を定義します。種類は 'ImageStreamTag' または 'DockerImage' のいずれかである必要があります。この値は、プッシュ先のコンテナーイメージリポジトリーを検索するのに使用されます。ImageStreamTag の場合は、Namespace が指定されていない限り、ImageStreamTag はビルドの namespace で検索されます。

name

string

name は、ラベルの名前を定義します。ゼロ以外の長さを持つ必要があります。

value

string

値は、ラベルのリテラル値を定義します。

args

array (string)

args は、Command、Script、またはコンテナーイメージのデフォルトのエントリーポイントのいずれかに提供される引数のリストです。引数は、実行するコマンドの直後に配置されます。

command

array (string)

command は実行するコマンドです。スクリプトでは指定できない場合があります。これは、イメージに /bin/sh がない場合、またはシェルを使用しない場合に必要になることがあります。その他の場合は、Script を使用することが便利な方法になります。

script

string

script は、/bin/sh -ic で実行されるシェルスクリプトです。Command で指定できない場合があります。シェルスクリプトがビルド後のフックを実行するのに適切な場合、たとえば rake test を使用して単体テストを実行する場合は、Script を使用します。イメージのエントリーポイントを制御する必要がある場合、またはイメージに /bin/sh がない場合は、Command または Args、あるいはその両方を使用します。-i フラグは、Software Collections (SCL) を使用する CentOS イメージおよび RHEL イメージをサポートし、シェルで適切なコレクションを有効にするために必要です。たとえば、Ruby イメージでは、これは、ruby、bundle、およびその他のバイナリーを PATH で使用できるようにするために必要です。

git

object

GitSourceRevision は、ビルド用の git ソースからのコミット情報です。

type

string

ビルドソースのタイプ。'Source'、'Dockerfile'、'Binary'、または 'Images' のいずれかになります。

author

object

SourceControlUser は、ソース管理のユーザーの ID を定義します。

commit

string

commit は、特定のコミットを識別するコミットハッシュです。

committer

object

SourceControlUser は、ソース管理のユーザーの ID を定義します。

message

string

メッセージは特定のコミットの説明です

email

string

ソース管理ユーザーの電子メール

name

string

ソース管理ユーザーの名前

email

string

ソース管理ユーザーの電子メール

name

string

ソース管理ユーザーの名前

バイナリー

object

BinaryBuildSource は、Docker および Source ビルドストラテジーに使用されるバイナリーファイルを記述します。ファイルは抽出され、ビルドソースとして使用されます。

configMaps

array

configMaps は、ビルドに使用される configMap とその宛先のリストを表します。

configMaps[]

object

ConfigMapBuildSource は、ビルド時にのみ使用される configmap とその宛先ディレクトリーを記述します。ここで参照されている configmap の内容は、マウントする代わりに宛先ディレクトリーにコピーされます。

contextDir

string

contextDir は、アプリケーションのソースコードが存在するサブディレクトリーを指定します。これにより、リポジトリーのルート以外のディレクトリーにビルド可能なソースを含めることができます。

dockerfile

string

dockerfile は、ビルドする必要のある Dockerfile の生のコンテンツです。このオプションを指定すると、戦略ベースイメージに基づいて FROM が変更され、戦略環境からの追加の ENV スタンザが FROM から、残りの Dockerfile スタンザの間に追加されます。Dockerfile ソースタイプは、git などの他のオプションとともに使用できます。その場合、Git リポジトリーでは、コンテキストディレクトリーで固有の Dockerfile が置き換えられます。

git

object

GitBuildSource は、Git SCM のパラメーターを定義します

images

array

images は、ビルドのソースを提供するのに使用される一連のイメージを記述します

images[]

object

ImageSource は、イメージから抽出されるか、マルチステージビルド中に使用されるビルドソースを記述するのに使用されます。タイプ ImageStreamTag、ImageStreamImage、または DockerImage の参照を使用できます。プルシークレットを指定して、外部レジストリーからイメージをプルするか、内部レジストリーからプルする場合はデフォルトのサービスアカウントシークレットを上書きできます。イメージソースを使用して、イメージからコンテンツを抽出し、リポジトリーソースと一緒にビルドコンテキストに配置するか、マルチステージコンテナーイメージのビルド中に直接使用して、リポジトリーソースのコンテンツを上書きせずにコンテンツをコピーできるようにします。('paths' および 'as' フィールドを参照してください)。

secrets

array

secrets は、ビルドにのみ使用されるシークレットとその宛先のリストを表します。

secrets[]

object

SecretBuildSource は、ビルド時にのみ使用されるシークレットとその宛先ディレクトリーを記述します。ここで参照されているシークレットの内容は、マウントする代わりに宛先ディレクトリーにコピーされます。

sourceSecret

LocalObjectReference

sourceSecret は、プライベートリポジトリーのクローンを作成するための認証を設定するのに使用される Secret の名前です。シークレットには、リモートリポジトリーの有効な認証情報が含まれています。ここで、データのキーは使用される認証方法を表し、値は base64 でエンコードされた認証情報です。サポートされている認証方法は ssh-privatekey です。

type

string

受け入れるビルド入力のタイプ

asFile

string

asFile は、提供されたバイナリー入力がビルド入力内の単一ファイルと見なされる必要があることを示します。たとえば、"webapp.war" を指定すると、提供されたバイナリーがビルダーの /webapp.war として配置されます。空のままにした場合、Docker および Source ビルド戦略は、このファイルが zip、tar、または tar.gz ファイルであると想定し、ソースとして抽出します。カスタム戦略は、このバイナリーを標準入力として受け取ります。このファイル名にはスラッシュを含めたり、'..' または '.' にすることはできません。

configMap

LocalObjectReference

configMap は、ビルドで使用する既存の configmap への参照です。

destinationDir

string

destinationDir は、ビルド時に configmap のファイルを使用できるディレクトリーです。ソースビルド戦略の場合、これらはアセンブルスクリプトが実行されるコンテナーに挿入されます。コンテナーイメージのビルド戦略では、これらは Dockerfile が配置されているビルドディレクトリーにコピーされるため、ユーザーはコンテナーイメージのビルド中にそれらを追加またはコピーできます。

httpProxy

string

httpProxy は、http 経由で git リポジトリーに到達するのに使用されるプロキシーです。

httpsProxy

string

httpsProxy は、https 経由で git リポジトリーに到達するのに使用されるプロキシーです。

noProxy

string

noProxy は、プロキシーを使用してはならないドメインのリストです。

ref

string

ref は、ビルドするブランチ/タグ/参照です。

uri

string

uri は、ビルドされるソースを指します。ソースの構造は、実行するビルドのタイプによって異なります

as

array (string)

マルチステージコンテナーイメージのビルド中にこのソースが代わりに使用されるイメージ名のリスト。たとえば、"COPY --from=nginx:latest" を使用する Dockerfile は、直接プルを試みる前に、このフィールドに "nginx:latest" が含まれるイメージソースを最初にチェックします。Dockerfile がイメージソースを参照していない場合、それは無視されます。このフィールドとパスの両方を設定できます。その場合、コンテンツは 2 回使用されます。

from

ObjectReference

from は、ソースをコピーする ImageStreamTag、ImageStreamImage、または DockerImage への参照です。

paths

array

パスは、イメージからコピーするソースパスおよび宛先パスのリストです。このコンテンツは、ビルドを開始する前にビルドコンテキストにコピーされます。パスが設定されていない場合、ビルドコンテキストは変更されません。

paths[]

object

ImageSourcePath は、ビルドディレクトリー内のソースイメージとその宛先からコピーされるパスを記述します。

pullSecret

LocalObjectReference

pullSecret は、レジストリーからイメージをプルするのに使用されるシークレットへの参照です。イメージが OpenShift レジストリーからプルされる場合は、このフィールドを設定する必要がありません。

destinationDir

string

destinationDir は、イメージからコピーされたファイルが配置されるビルドディレクトリー内の相対ディレクトリーです。

sourcePath

string

sourcePath は、ビルドディレクトリーにコピーするイメージ内のファイルまたはディレクトリーの絶対パスです。ソースパスの末尾は /. であり、ディレクトリーのコンテンツがコピーされますが、ディレクトリー自体は宛先で作成されません。

destinationDir

string

destinationDir は、ビルド時にシークレットのファイルを使用できるディレクトリーです。ソースビルド戦略の場合、これらはアセンブルスクリプトが実行されるコンテナーに挿入されます。その後、スクリプトが終了すると、挿入されたすべてのファイルの長さがゼロに切り捨てられます。コンテナーイメージのビルド戦略では、これらは Dockerfile が配置されているビルドディレクトリーにコピーされるため、ユーザーはコンテナーイメージのビルド中にそれらを追加またはコピーできます。

secret

LocalObjectReference

secret は、ビルドで使用する既存のシークレットへの参照です。

customStrategy

object

CustomBuildStrategy は、カスタムビルドに固有の入力パラメーターを定義します。

dockerStrategy

object

DockerBuildStrategy は、コンテナーイメージビルドに固有の入力パラメーターを定義します。

jenkinsPipelineStrategy

object

JenkinsPipelineBuildStrategy は、Jenkins Pipeline ビルドに固有のパラメーターを保持します。非推奨: OpenShift Pipelines を使用する

sourceStrategy

object

SourceBuildStrategy は、ソースビルドに固有の入力パラメーターを定義します。

type

string

タイプはビルド戦略の一種です。

buildAPIVersion

string

buildAPIVersion は、シリアル化されてカスタムビルダーに渡される Build オブジェクトに対して要求された API バージョンです。

env

array (EnvVar)

env には、ビルダーコンテナーに渡す追加の環境変数が含まれています。

exposeDockerSocket

boolean

exposeDockerSocket を使用すると、コンテナー内から Docker コマンドを実行 (およびコンテナーイメージをビルド) できます。

forcePull

boolean

forcePull は、コントローラーがビルド Pod を設定して、ビルダーのイメージを常にプルするか、ローカルに存在しない場合にのみプルするかを記述します。

from

ObjectReference

from は、コンテナーイメージのプル元となる DockerImage、ImageStreamTag、または ImageStreamImage への参照です。

pullSecret

LocalObjectReference

pullSecret は、プライベート Docker レジストリーからコンテナーイメージをプルするための認証を設定するために使用される Secret の名前です。

secrets

array

secrets は、ビルド Pod に含まれる追加のシークレットのリストです

secrets[]

object

SecretSpec は、ビルド Pod とそれに対応するマウントポイントに含まれるシークレットを指定します

mountPath

string

mountPath は、シークレットをマウントするパスです。

secretSource

LocalObjectReference

secretSource はシークレットへの参照です

buildArgs

array (EnvVar)

buildArgs には、Dockerfile で解決されるビルド引数が含まれています。詳細は、https://docs.docker.com/engine/reference/builder/#/arg を参照してください。注意: 'name' フィールドおよび 'value' フィールドのみがサポートされます。'valueFrom' フィールドの設定は無視されます。

dockerfilePath

string

dockerfilePath は、コンテキストのルート (contextDir) を基準にした、コンテナーイメージの構築に使用される Dockerfile のパスです。設定されていない場合は、デフォルトで Dockerfile になります。

env

array (EnvVar)

env には、ビルダーコンテナーに渡す追加の環境変数が含まれています。

forcePull

boolean

forcePull は、ビルダーがビルドする前にレジストリーからイメージをプルする必要があるかどうかを記述します。

from

ObjectReference

from は、ビルド用の Dockerfile 内の FROM イメージをオーバーライドする DockerImage、ImageStreamTag、または ImageStreamImage への参照です。Dockerfile がマルチステージビルドを使用する場合、これはファイルの最後の FROM ディレクティブのイメージを置き換えます。

imageOptimizationPolicy

string

imageOptimizationPolicy は、イメージを構築するときにシステムが使用できる最適化を記述して、イメージの構築に費やされる最終的なサイズまたは時間を削減します。デフォルトのポリシーは 'None' です。これは、最終的なビルドイメージがコンテナーイメージビルド API によって作成されたイメージと同等になることを意味します。実験的なポリシー 'SkipLayers' は、各イメージステップの間に新しいレイヤーをコミットすることを回避し、Dockerfile が 'None' ポリシーとの互換性を提供できない場合は失敗します。追加の実験的なポリシー 'SkipLayersAndWarn' は 'SkipLayers' と同じですが、互換性を維持できない場合は単に警告します。

noCache

boolean

noCache が true に設定されている場合、コンテナーイメージのビルドは --no-cache=true フラグを指定して実行する必要があることを示します

pullSecret

LocalObjectReference

pullSecret は、プライベート Docker レジストリーからコンテナーイメージをプルするための認証を設定するために使用される Secret の名前です。

volumes

array

ボリュームは、ビルドのランタイム環境にマウントできる入力ボリュームのリストです。ビルドでサポートされているのは、Kubernetes Volume ソースのサブセットのみです。詳細: https://kubernetes.io/docs/concepts/storage/volumes

volumes[]

object

BuildVolume は、buildah のランタイム環境にマウントできるように、Pod をビルドするのに使用できるようになるボリュームを記述します。Kubernetes ボリュームソースのサブセットのみがサポートされています。

mounts

array

mounts は、イメージビルドコンテナー内のボリュームの場所を表します

mounts[]

object

BuildVolumeMount は、buildah のランタイム環境内でのボリュームのマウントを説明します。

name

string

name は、この BuildVolume の一意の識別子です。Kubernetes DNS ラベル標準に準拠し、Pod 内で一意である必要があります。名前が、ビルドコントローラーにより追加された名前と競合するとビルドが失敗し、エラーの原因となった名前の詳細を示すエラーメッセージが表示されます。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

source

object

BuildVolumeSource は、マウントするボリュームのソースを表します。サポートされているタイプの 1 つだけを常に指定できます。

destinationPath

string

destinationPath は、ボリュームをマウントする必要がある buildah ランタイム環境内のパスです。ビルドイメージ内の一時マウントとバッキングボリュームは両方とも読み取り専用でマウントされます。絶対パスである必要があり、'..' または ':' を含めることはできません。また、ビルダープロセスにより生成された宛先パスと競合してはなりません。このパスが、ビルドコントローラーにより追加されたパスと競合すると、ビルドが失敗し、エラーの原因となったパスの詳細を示すエラーメッセージが表示されます。

configMap

ConfigMapVolumeSource

configMap は、このボリュームに入力する必要がある ConfigMap を表します

csi

CSIVolumeSource

csi は、このケイパビリティーをサポートする外部 CSI ドライバーが提供する一時ストレージを表します。

secret

SecretVolumeSource

secret は、このボリュームに入力する必要がある Secret を表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#secret

type

string

type は、ボリュームソースの BuildVolumeSourceType です。Type は、入力されたボリュームソースと一致する必要があります。有効なタイプは、Secret、ConfigMap です。

env

array (EnvVar)

env には、ビルドパイプラインに渡す追加の環境変数が含まれています。

jenkinsfile

string

Jenkinsfile は、Jenkins パイプラインビルドを定義する Jenkinsfile の任意の raw コンテンツを定義します。

jenkinsfilePath

string

JenkinsfilePath は、コンテキストのルート (contextDir) を基準にしてパイプラインを設定するのに使用される Jenkinsfile の任意のパスです。JenkinsfilePath と Jenkinsfile の両方が指定されていない場合、これはデフォルトで、指定された contextDir のルートにある Jenkinsfile になります。

env

array (EnvVar)

env には、ビルダーコンテナーに渡す追加の環境変数が含まれています。

forcePull

boolean

forcePull は、ビルダーがビルドする前にレジストリーからイメージをプルする必要があるかどうかを記述します。

from

ObjectReference

from は、コンテナーイメージのプル元となる DockerImage、ImageStreamTag、または ImageStreamImage への参照です。

incremental

boolean

増分フラグは、true の場合、ソースビルドに増分ビルドを強制します。

pullSecret

LocalObjectReference

pullSecret は、プライベート Docker レジストリーからコンテナーイメージをプルするための認証を設定するために使用される Secret の名前です。

scripts

string

Source はソーススクリプトの場所です

volumes

array

ボリュームは、ビルドのランタイム環境にマウントできる入力ボリュームのリストです。ビルドでサポートされているのは、Kubernetes Volume ソースのサブセットのみです。詳細: https://kubernetes.io/docs/concepts/storage/volumes

volumes[]

object

BuildVolume は、buildah のランタイム環境にマウントできるように、Pod をビルドするのに使用できるようになるボリュームを記述します。Kubernetes ボリュームソースのサブセットのみがサポートされています。

mounts

array

mounts は、イメージビルドコンテナー内のボリュームの場所を表します

mounts[]

object

BuildVolumeMount は、buildah のランタイム環境内でのボリュームのマウントを説明します。

name

string

name は、この BuildVolume の一意の識別子です。Kubernetes DNS ラベル標準に準拠し、Pod 内で一意である必要があります。名前が、ビルドコントローラーにより追加された名前と競合するとビルドが失敗し、エラーの原因となった名前の詳細を示すエラーメッセージが表示されます。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

source

object

BuildVolumeSource は、マウントするボリュームのソースを表します。サポートされているタイプの 1 つだけを常に指定できます。

destinationPath

string

destinationPath は、ボリュームをマウントする必要がある buildah ランタイム環境内のパスです。ビルドイメージ内の一時マウントとバッキングボリュームは両方とも読み取り専用でマウントされます。絶対パスである必要があり、'..' または ':' を含めることはできません。また、ビルダープロセスにより生成された宛先パスと競合してはなりません。このパスが、ビルドコントローラーにより追加されたパスと競合すると、ビルドが失敗し、エラーの原因となったパスの詳細を示すエラーメッセージが表示されます。

configMap

ConfigMapVolumeSource

configMap は、このボリュームに入力する必要がある ConfigMap を表します

csi

CSIVolumeSource

csi は、このケイパビリティーをサポートする外部 CSI ドライバーが提供する一時ストレージを表します。