30.3. Build [build.openshift.io/v1]

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_v2

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

上記を以下のように変更します。

ObjectReference_v2

このビルドの出力をプッシュする任意の場所を定義します。種類は 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_v2

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

type

string

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

asFile

string

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

configMap

LocalObjectReference_v2

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_v2

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

paths

array

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

paths[]

object

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

pullSecret

LocalObjectReference_v2

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

destinationDir

string

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

sourcePath

string

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

destinationDir

string

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

secret

LocalObjectReference_v2

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_v2)

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

exposeDockerSocket

boolean

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

forcePull

boolean

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

from

ObjectReference_v2

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

pullSecret

LocalObjectReference_v2

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

secrets

array

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

secrets[]

object

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

mountPath

string

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

secretSource

LocalObjectReference_v2

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

buildArgs

array (EnvVar_v2)

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

dockerfilePath

string

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

env

array (EnvVar_v2)

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

forcePull

boolean

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

from

ObjectReference_v2

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_v2

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 を表します

secret

SecretVolumeSource

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

type

string

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

env

array (EnvVar_v2)

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

jenkinsfile

string

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

jenkinsfilePath

string

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

env

array (EnvVar_v2)

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

forcePull

boolean

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

from

ObjectReference_v2

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

incremental

boolean

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

pullSecret

LocalObjectReference_v2

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 を表します

secret

SecretVolumeSource

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

type

string

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

bitbucketWebHook

object

BitbucketWebHookCause には、ビルドをトリガーした Bitbucket Webhook に関する情報があります。

genericWebHook

object

GenericWebHookCause は、ビルドをトリガーした汎用 WebHook に関する情報を保持します。

githubWebHook

object

GitHubWebHookCause には、ビルドをトリガーした GitHub Webhook に関する情報があります。

gitlabWebHook

object

GitLabWebHookCause には、ビルドをトリガーした GitLab Webhook に関する情報があります。

imageChangeBuild

object

ImageChangeCause には、ビルドをトリガーしたイメージに関する情報が含まれています

message

string

message は、ビルドがトリガーされた理由に関する人間が読めるメッセージを格納するために使用されます。たとえば、"Manually triggered by user"、"Configuration change" などです。

revision

object

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

secret

string

Secret は、ビルドのトリガーとなった難読化された Webhook シークレットです。

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

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

revision

object

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

secret

string

secret は、ビルドをトリガーした難読化された Webhook シークレットです。

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

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

revision

object

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

secret

string

secret は、ビルドをトリガーした難読化された Webhook シークレットです。

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

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

revision

object

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

secret

string

Secret は、ビルドのトリガーとなった難読化された Webhook シークレットです。

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

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

fromRef

ObjectReference_v2

fromRef には、ビルドをトリガーしたイメージに関する詳細情報が含まれています。

imageID

string

imageID は、新しいビルドをトリガーしたイメージの ID です。

cancelled

boolean

cancelled は、ビルドに対してキャンセルイベントがトリガーされたかどうかを示します。

completionTimestamp

時間

completeTimestamp は、ビルドが失敗したか成功したかに関係なく、この Build が終了したサーバー時間を表すタイムスタンプです。これは、Build を実行している Pod が終了した時刻を反映しています。これは RFC3339 形式で表されます。これは UTC です。

conditions

array

Conditions は、ビルドの現在の状態について利用可能な最新の観測値を表します。

conditions[]

object

BuildCondition は、特定の時点でのビルドの状態を記述します。

config

ObjectReference_v2

config は、この Build のベースとなる BuildConfig への ObjectReference です。

duration

integer

duration には time.Duration オブジェクトが含まれ、ビルド時間を記述します。

logSnippet

string

logSnippet は、ビルドログの最後の数行です。この値は、失敗したビルドに対してのみ設定されます。

message

string

message は、ビルドがこのステータスになる理由の詳細を示す、人が判読できるメッセージです。

output

object

BuildStatusOutput には、ビルドされたイメージのステータスが含まれます。

outputDockerImageReference

string

outputDockerImageReference には、このビルドによりビルドされるコンテナーイメージへの参照が含まれています。その値は Build.Spec.Output.To から計算され、イメージをプッシュおよびプルするのに使用できるように、レジストリーアドレスを含める必要があります。

phase

string

フェーズは、ビルドライフサイクルのポイントです。可能な値は、"New"、"Pending"、"Running"、"Complete"、"Failed"、"Error"、および "Cancelled" です。

reason

string

reason は、障害を説明する簡単な CamelCase 文字列であり、CLI でのマシン解析と整理された表示を目的としています。

stages

array

stages には、開始時間、期間 (ミリ秒単位)、各ステージ内で発生したステップなど、ビルド中に発生する各ステージに関する詳細が含まれます。

stages[]

object

StageInfo には、ビルドステージに関する詳細が含まれています。

startTimestamp

時間

startTimestamp は、この Build が Pod で実行を開始したときのサーバー時間を表すタイムスタンプです。これは RFC3339 形式で表されます。これは UTC です。

lastTransitionTime

時間

最後にある状態から別の状態に遷移した時間。

lastUpdateTime

時間

この状態が最後に更新された時刻。

message

string

遷移の詳細を示す人が判読できるメッセージ。

reason

string

条件の最後の遷移の理由。

status

string

状態のステータス、True、False、Unknown のいずれか。

type

string

ビルド条件のタイプ。

上記を以下のように変更します。

object

BuildStatusOutputTo は、プッシュ先のイメージレジストリーに関するビルドされたイメージのステータスを記述します。

imageDigest

string

imageDigest は、ビルドされたコンテナーイメージのダイジェストです。ダイジェストは、プッシュ先のレジストリー内のイメージを一意に識別します。

プッシュが正常に完了した場合でも、このフィールドが常に設定されるとは限らないことに注意してください。たとえば、レジストリーがダイジェストを返さない場合や、ビルダーが理解できない形式で返す場合などです。

durationMilliseconds

integer

durationMilliseconds は、ステージが完了するまでにかかった時間をミリ秒単位で識別します。注: 明示的なビルドステップですべてのアクションが考慮されるわけではないため、ステージの期間は、ステージ内のステップの期間の合計を超える可能性があります。

name

string

name は、発生する各ビルドステージの一意の識別子です。

startTime

時間

startTime は、この Stage が開始したときのサーバー時間を表すタイムスタンプです。これは RFC3339 形式で表されます。これは UTC です。

手順

array

ステップには、開始時間やミリ秒単位の期間など、ビルドステージ中に発生する各ステップの詳細が含まれています。

steps[]

object

StepInfo には、ビルドステップに関する詳細が含まれています。

durationMilliseconds

integer

durationMilliseconds は、ステップが完了するまでにかかった時間をミリ秒単位で識別します。

name

string

name は、各ビルドステップの一意の識別子です。

startTime

時間

startTime は、このステップが開始したときのサーバー時間を表すタイムスタンプです。RFC3339 形式で表され、UTC で表示されます。

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが時計でない場合、このフィールドは無視されます。機能ゲート WatchBookmarks が apiserver で有効になっていない場合、このフィールドは無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

pretty

string

'true' の場合、出力はきれいに印刷されます。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。

200 - OK

BuildList スキーマ

401 - Unauthorized

空白

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが時計でない場合、このフィールドは無視されます。機能ゲート WatchBookmarks が apiserver で有効になっていない場合、このフィールドは無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

pretty

string

'true' の場合、出力はきれいに印刷されます。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

pretty

string

'true' の場合、出力はきれいに印刷されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。

gracePeriodSeconds

integer

オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

orphanDependents

boolean

非推奨: PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、孤立したファイナライザーがオブジェクトのファイナライザー一覧で追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。

propagationPolicy

string

ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定することはできません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシー。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

body

DeleteOptions スキーマ

200 - OK

Status スキーマ

401 - Unauthorized

空白

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが時計でない場合、このフィールドは無視されます。機能ゲート WatchBookmarks が apiserver で有効になっていない場合、このフィールドは無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。

200 - OK

BuildList スキーマ

401 - Unauthorized

空白

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

body

Build スキーマ

200 - OK

Build スキーマ

201 - Created

Build スキーマ

202 - Accepted

Build スキーマ

401 - Unauthorized

空白

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが時計でない場合、このフィールドは無視されます。機能ゲート WatchBookmarks が apiserver で有効になっていない場合、このフィールドは無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

pretty

string

'true' の場合、出力はきれいに印刷されます。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

name

string

ビルドの名前

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

pretty

string

'true' の場合、出力はきれいに印刷されます。

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

gracePeriodSeconds

integer

オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。

orphanDependents

boolean

非推奨: PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、孤立したファイナライザーがオブジェクトのファイナライザー一覧で追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。

propagationPolicy

string

ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定することはできません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシー。

body

DeleteOptions スキーマ

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

200 - OK

Build スキーマ

401 - Unauthorized

空白

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、適用要求 (application/apply-patch) には必須ですが、非適用パッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) にはオプションです。

force

boolean

Force は Apply リクエストを強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合、強制フラグを設定解除する必要があります。

body

Patch schema

200 - OK

Build スキーマ

401 - Unauthorized

空白

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

body

Build スキーマ

200 - OK

Build スキーマ

201 - Created

Build スキーマ

401 - Unauthorized

空白

name

string

ビルドの名前

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが時計でない場合、このフィールドは無視されます。機能ゲート WatchBookmarks が apiserver で有効になっていない場合、このフィールドは無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

pretty

string

'true' の場合、出力はきれいに印刷されます。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

name

string

ビルドの名前

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

pretty

string

'true' の場合、出力はきれいに印刷されます。

body

Build スキーマ

200 - OK

Build スキーマ

201 - Created

Build スキーマ

401 - Unauthorized

空白

name

string

ビルドの名前

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

path

string

Path は、Pod への現在のプロキシーリクエストに使用する URL パスです。

200 - OK

string

401 - Unauthorized

空白

name

string

ビルドの名前

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

path

string

リソースへのパス

path

string

Path は、Pod への現在のプロキシーリクエストに使用する URL パスです。

200 - OK

string

401 - Unauthorized

空白