8.4. Build [config.openshift.io/v1]


Description
ビルドは、クラスター全体の OpenShift ビルドの動作を設定します。これには、BuildConfig オブジェクトでオーバーライドできるデフォルト設定と、すべてのビルドに適用されるオーバーライドが含まれます。正規名はクラスターです。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
タイプ
object
必須
  • spec

8.4.1. 仕様

Expand
プロパティータイプ説明

apiVersion

string

APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これを更新することはできません。CamelCase詳細については、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

metadata

ObjectMeta_v2

標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。

spec

object

spec ビルドコントローラー設定のユーザーが設定できる値を保持します。

8.4.1.1. .spec

Description
spec ビルドコントローラー設定のユーザーが設定できる値を保持します。
タイプ
object
Expand
プロパティータイプDescription

additionalTrustedCA

object

AdditionalTrustedCA は、ビルド中のイメージのプッシュとプルで信頼される必要がある追加の CA を含む ConfigMap への参照です。この設定マップの namespace は openshift-config です。非推奨: イメージのプルおよびプッシュ用の追加の CA は、代わりに image.config.openshift.io/cluster に設定する必要があります。

buildDefaults

object

buildDefaults ビルドのデフォルト情報を制御します。

buildOverrides

object

buildOverrides ビルドの上書き設定を制御します。

8.4.1.2. .spec.additionalTrustedCA

Description
AdditionalTrustedCA は、ビルド中のイメージのプッシュとプルで信頼される必要がある追加の CA を含む ConfigMap への参照です。この設定マップの namespace は openshift-config です。非推奨: イメージのプルおよびプッシュ用の追加の CA は、代わりに image.config.openshift.io/cluster に設定する必要があります。
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照される設定マップの metadata.name です。

8.4.1.3. .spec.buildDefaults

Description
buildDefaults ビルドのデフォルト情報を制御します。
タイプ
object
Expand
プロパティータイプDescription

defaultProxy

object

DefaultProxy には、イメージのプル/プッシュやソースのダウンロードなど、すべてのビルド操作のデフォルトのプロキシー設定が含まれています。ビルド設定の戦略で HTTP_PROXYHTTPS_PROXY、および NO_PROXY 環境変数を設定することにより、値を上書きできます。

env

array

Env は、指定された変数がビルドに存在しない場合にビルドに適用されるデフォルトの環境変数のセットです。

env[]

object

EnvVar は、コンテナーに存在する環境変数を表します。

gitProxy

object

gitProxy Git 操作のプロキシー設定のみが含まれます。設定されている場合、これは gitclone などのすべての git コマンドのプロキシー設定を上書きします。ここで設定されていない値は、DefaultProxy から継承されます。

imageLabels

array

ImageLabels は、結果のイメージに適用される Docker ラベルのリストです。ユーザーは、Build/BuildConfig で同じ名前のラベルを指定することにより、デフォルトのラベルを上書きできます。

imageLabels[]

object

 

resources

object

resources ビルドを実行するためのリソース要件を定義します。

8.4.1.4. .spec.buildDefaults.defaultProxy

Description
DefaultProxy には、イメージのプル/プッシュやソースのダウンロードなど、すべてのビルド操作のデフォルトのプロキシー設定が含まれています。ビルド設定の戦略で HTTP_PROXYHTTPS_PROXY、および NO_PROXY 環境変数を設定することにより、値を上書きできます。
タイプ
object
Expand
プロパティータイプDescription

httpProxy

string

httpProxy は、HTTP リクエストのプロキシーの URL です。空は未設定を意味し、env 変数にはなりません。

httpsProxy

string

httpsProxy は、HTTPS リクエストのプロキシーの URL です。空は未設定を意味し、env 変数にはなりません。

noProxy

string

noProxy は、プロキシーを使用してはならないホスト名や CIDR、IP のコンマ区切りのリストです。空は未設定を意味し、env 変数にはなりません。

readinessEndpoints

array (string)

readinessEndpoints は、プロキシーの準備ができていることを確認するために使用されるエンドポイントのリストです。

trustedCA

object

trustedCA は、CA 証明書バンドルを含む ConfigMap への参照です。trustedCA フィールドは、プロキシーバリデーターによってのみ使用される必要があります。バリデーターは、必要なキー ca-bundle.crt から証明書バンドルを読み取り、それをシステムのデフォルトのトラストバンドルとマージし、マージされたトラストバンドルを trusted-ca-bundle という名前の ConfigMap に書き込みます。openshift-config-managed" 名前空間。プロキシー接続を期待するクライアントは、プロキシーへのすべての HTTPS 要求に trusted-ca-bundle を使用する必要があり、非プロキシー HTTPS 要求にも trusted-ca-bundle を使用できます。trustedCA が参照する ConfigMap のネームスペースは openshift-config です。ConfigMap の例 (yaml) は次のとおりです。apiVersion:v1 種類:ConfigMap メタデータ: 名前:user-ca-bundle 名前空間:openshift-config データ:ca-bundle.crt:| -----BEGINCERTIFICATE----- カスタム CA 証明書バンドル。----- 証明書の終了 -----

8.4.1.5. .spec.buildDefaults.defaultProxy.trustedCA

Description
trustedCA は、CA 証明書バンドルを含む ConfigMap への参照です。trustedCA フィールドは、プロキシーバリデーターによってのみ使用される必要があります。バリデーターは、必要なキー ca-bundle.crt から証明書バンドルを読み取り、それをシステムのデフォルトのトラストバンドルとマージし、マージされたトラストバンドルを trusted-ca-bundle という名前の ConfigMap に書き込みます。openshift-config-managed" 名前空間。プロキシー接続を期待するクライアントは、プロキシーへのすべての HTTPS 要求に trusted-ca-bundle を使用する必要があり、非プロキシー HTTPS 要求にも trusted-ca-bundle を使用できます。trustedCA が参照する ConfigMap のネームスペースは openshift-config です。ConfigMap の例 (yaml) は次のとおりです。apiVersion:v1 種類:ConfigMap メタデータ: 名前:user-ca-bundle 名前空間:openshift-config データ:ca-bundle.crt:| -----BEGINCERTIFICATE----- カスタム CA 証明書バンドル。----- 証明書の終了 -----
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照される設定マップの metadata.name です。

8.4.1.6. .spec.buildDefaults.env

Description
Env は、指定された変数がビルドに存在しない場合にビルドに適用されるデフォルトの環境変数のセットです。
タイプ
array

8.4.1.7. .spec.buildDefaults.env[]

Description
EnvVar は、コンテナーに存在する環境変数を表します。
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

環境変数の名前。C_IDENTIFIER でなければなりません。

value

string

変数参照 $(VAR_NAME) は、コンテナー内で以前に定義された環境変数と任意のサービス環境変数を使用して展開されます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、(VAR_NAME) は文字列リテラル $(VAR_NAME) を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。デフォルトは "" です。

valueFrom

object

環境変数の値のソースです。値が空でない場合は使用できません。

8.4.1.8. .spec.buildDefaults.env[].valueFrom

Description
環境変数の値のソースです。値が空でない場合は使用できません。
タイプ
object
Expand
プロパティータイプDescription

configMapKeyRef

object

ConfigMap のキーを選択します。

fieldRef

object

Pod のフィールドを選択します:metadata.name、metadata.namespace、metadata.labels '<KEY>'metadata.annotations '<KEY>'、spec.nodeName、spec.serviceAccountName、status.hostIP、status.podIP、status.podIPs。

resourceFieldRef

object

コンテナーのリソースを選択します。現在、リソースの制限とリクエスト (limits.cpu、limits.memory、limits.ephemeral-storage、requests.cpu、requests.memory、requests.ephemeral-storage) のみがサポートされています。

secretKeyRef

object

Pod の名前空間でシークレットのキーを選択します

8.4.1.9. .spec.buildDefaults.env[].valueFrom.configMapKeyRef

Description
ConfigMap のキーを選択します。
タイプ
object
必須
  • key
Expand
プロパティータイプDescription

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

8.4.1.10. .spec.buildDefaults.env[].valueFrom.fieldRef

Description
Pod のフィールドを選択します:metadata.name、metadata.namespace、metadata.labels '<KEY>'metadata.annotations '<KEY>'、spec.nodeName、spec.serviceAccountName、status.hostIP、status.podIP、status.podIPs。
タイプ
object
必須
  • fieldPath
Expand
プロパティータイプ説明

apiVersion

string

FieldPath が記述されているスキーマのバージョン。デフォルトは v1 です。

fieldPath

string

指定された API バージョンで選択するフィールドのパス。

8.4.1.11. .spec.buildDefaults.env[].valueFrom.resourceFieldRef

Description
コンテナーのリソースを選択します。現在、リソースの制限とリクエスト (limits.cpu、limits.memory、limits.ephemeral-storage、requests.cpu、requests.memory、requests.ephemeral-storage) のみがサポートされています。
タイプ
object
必須
  • resource
Expand
プロパティータイプDescription

containerName

string

コンテナー名: ボリュームには必須、env 変数にはオプション

divisor

integer-or-string

公開されたリソースの出力形式を指定します。デフォルトは 1 です。

resource

string

必須: 選択するリソース

8.4.1.12. .spec.buildDefaults.env[].valueFrom.secretKeyRef

Description
Pod の名前空間でシークレットのキーを選択します
タイプ
object
必須
  • key
Expand
プロパティータイプDescription

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

8.4.1.13. .spec.buildDefaults.gitProxy

Description
gitProxy Git 操作のプロキシー設定のみが含まれます。設定されている場合、これは gitclone などのすべての git コマンドのプロキシー設定を上書きします。ここで設定されていない値は、DefaultProxy から継承されます。
タイプ
object
Expand
プロパティータイプDescription

httpProxy

string

httpProxy は、HTTP リクエストのプロキシーの URL です。空は未設定を意味し、env 変数にはなりません。

httpsProxy

string

httpsProxy は、HTTPS リクエストのプロキシーの URL です。空は未設定を意味し、env 変数にはなりません。

noProxy

string

noProxy は、プロキシーを使用してはならないホスト名や CIDR、IP のコンマ区切りのリストです。空は未設定を意味し、env 変数にはなりません。

readinessEndpoints

array (string)

readinessEndpoints は、プロキシーの準備ができていることを確認するために使用されるエンドポイントのリストです。

trustedCA

object

trustedCA は、CA 証明書バンドルを含む ConfigMap への参照です。trustedCA フィールドは、プロキシーバリデーターによってのみ使用される必要があります。バリデーターは、必要なキー ca-bundle.crt から証明書バンドルを読み取り、それをシステムのデフォルトのトラストバンドルとマージし、マージされたトラストバンドルを trusted-ca-bundle という名前の ConfigMap に書き込みます。openshift-config-managed" 名前空間。プロキシー接続を期待するクライアントは、プロキシーへのすべての HTTPS 要求に trusted-ca-bundle を使用する必要があり、非プロキシー HTTPS 要求にも trusted-ca-bundle を使用できます。trustedCA が参照する ConfigMap のネームスペースは openshift-config です。ConfigMap の例 (yaml) は次のとおりです。apiVersion:v1 種類:ConfigMap メタデータ: 名前:user-ca-bundle 名前空間:openshift-config データ:ca-bundle.crt:| -----BEGINCERTIFICATE----- カスタム CA 証明書バンドル。----- 証明書の終了 -----

8.4.1.14. .spec.buildDefaults.gitProxy.trustedCA

Description
trustedCA は、CA 証明書バンドルを含む ConfigMap への参照です。trustedCA フィールドは、プロキシーバリデーターによってのみ使用される必要があります。バリデーターは、必要なキー ca-bundle.crt から証明書バンドルを読み取り、それをシステムのデフォルトのトラストバンドルとマージし、マージされたトラストバンドルを trusted-ca-bundle という名前の ConfigMap に書き込みます。openshift-config-managed" 名前空間。プロキシー接続を期待するクライアントは、プロキシーへのすべての HTTPS 要求に trusted-ca-bundle を使用する必要があり、非プロキシー HTTPS 要求にも trusted-ca-bundle を使用できます。trustedCA が参照する ConfigMap のネームスペースは openshift-config です。ConfigMap の例 (yaml) は次のとおりです。apiVersion:v1 種類:ConfigMap メタデータ: 名前:user-ca-bundle 名前空間:openshift-config データ:ca-bundle.crt:| -----BEGINCERTIFICATE----- カスタム CA 証明書バンドル。----- 証明書の終了 -----
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照される設定マップの metadata.name です。

8.4.1.15. .spec.buildDefaults.imageLabels

Description
ImageLabels は、結果のイメージに適用される Docker ラベルのリストです。ユーザーは、Build/BuildConfig で同じ名前のラベルを指定することにより、デフォルトのラベルを上書きできます。
タイプ
array

8.4.1.16. .spec.buildDefaults.imageLabels[]

Description
タイプ
object
Expand
プロパティータイプ説明

name

string

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

value

string

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

8.4.1.17. .spec.buildDefaults.resources

Description
resources ビルドを実行するためのリソース要件を定義します。
タイプ
object
Expand
プロパティータイプDescription

limits

integer-or-string

制限は、許容されるコンピュートリソースの最大量を記述します。詳細については、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

requests

integer-or-string

要求は、必要なコンピュートリソースの最小量を記述します。コンテナーについて Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。詳細については、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

8.4.1.18. .spec.buildOverrides

Description
buildOverrides ビルドの上書き設定を制御します。
タイプ
object
Expand
プロパティータイプDescription

forcePull

ブール値

ForcePull は、設定されている場合、ビルド内の同等の値をオーバーライドします。つまり、false はすべてのビルドの強制プルを無効にし、true は、各ビルドがそれ自体を指定する内容に関係なく、すべてのビルドの強制プルを有効にします。

imageLabels

array

ImageLabels は、結果のイメージに適用される Docker ラベルのリストです。ユーザーが Build/BuildConfig でこのリストにあるものと同じ名前のラベルを指定した場合、ユーザーのラベルは上書きされます。

imageLabels[]

object

 

nodeSelector

object (string)

NodeSelector は、ビルド Pod がノードに適合するために true である必要があるセレクターです。

tolerations

array

Tolerations は、ビルド Pod に設定されている既存の許容値を上書きする許容値のリストです。

tolerations[]

object

この toleration が割り当てられる Pod は、マッチング Operator <operator> を使用してトリプル <key,value,effect> と一致するテイントを許容します。

8.4.1.19. .spec.buildOverrides.imageLabels

Description
ImageLabels は、結果のイメージに適用される Docker ラベルのリストです。ユーザーが Build/BuildConfig でこのリストにあるものと同じ名前のラベルを指定した場合、ユーザーのラベルは上書きされます。
タイプ
array

8.4.1.20. .spec.buildOverrides.imageLabels[]

Description
タイプ
object
Expand
プロパティータイプ説明

name

string

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

value

string

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

8.4.1.21. .spec.buildOverrides.tolerations

Description
Tolerations は、ビルド Pod に設定されている既存の許容値を上書きする許容値のリストです。
タイプ
array

8.4.1.22. .spec.buildOverrides.tolerations[]

Description
この toleration が割り当てられる Pod は、マッチング Operator <operator> を使用してトリプル <key,value,effect> と一致するテイントを許容します。
タイプ
object
Expand
プロパティータイプDescription

effect

string

effect は、照合するテイントの効果を示します。空の場合は、すべてのテイント効果に一致します。指定されている場合、許可される値は NoSchedule、PreferNoSchedule、および NoExecute です。

key

string

key は toleration が適用されるテイントキーです。空の場合は、すべてのテイントキーに一致します。キーが空の場合、Operator は Exists である必要があります。この組み合わせは、すべての値とすべてのキーに一致することを意味します。

operator

string

Operator はキーと値の関係を表します。有効な Operator は Exists および Equal です。デフォルトは Equal です。Exists は、値のワイルドカードと同等であるため、Pod は特定のカテゴリーのすべてのテイントに耐えることができます。

tolerationSeconds

integer

tolerationSeconds は、toleration (effect は NoExecute でなければならず、NoExecute 以外の場合このフィールドは無視されます) がテイントを許容する期間を表します。デフォルトでは設定されていません。つまり、テイントを永久に許容します (エビクトしないでください)。ゼロ値と負の値は、システムによって 0 (すぐにエビクト) として扱われます。

value

string

value は、toleration が一致するテイントの値です。Operator が Exists の場合、値は空である必要があります。それ以外の場合は、通常の文字列のみになります。

8.4.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/config.openshift.io/v1/builds

    • 削除: ビルドのコレクションを削除します
    • GET: ビルドの種類のオブジェクトを一覧表示します
    • POST: ビルドを作成します
  • /apis/config.openshift.io/v1/builds/{name}

    • 削除: ビルドを削除します
    • GET: 指定されたビルドを読み取ります
    • PATCH: 指定されたビルドを部分的に更新します
    • PUT: 指定されたビルドを置き換えます
  • /apis/config.openshift.io/v1/builds/{name}/status

    • GET: 指定されたビルドのステータスを読み取ります
    • PATCH: 指定されたビルドのステータスを部分的に更新します
    • PUT: 指定されたビルドのステータスを置き換えます

8.4.2.1. /apis/config.openshift.io/v1/builds

Expand
表8.63 グローバルクエリーパラメーター
パラメータータイプ説明

pretty

string

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

HTTP メソッド
DELETE
Description
ビルドのコレクションを削除します
Expand
表8.64 クエリーパラメーター
パラメータータイプ説明

allowWatchBookmarks

boolean

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

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 を指定します。

Expand
表8.65 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Status_v2 schema

401 - Unauthorized

空白

HTTP メソッド
GET
Description
種類のオブジェクトを一覧表示する Build
Expand
表8.66 クエリーパラメーター
パラメータータイプ説明

allowWatchBookmarks

boolean

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

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 を指定します。

Expand
表8.67 HTTP 応答
HTTP コードレスポンス本文

200 - OK

BuildList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
Description
ビルドを作成する
Expand
表8.68 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

fieldManager

string

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

Expand
表8.69 ボディパラメーター
パラメータータイプ説明

body

Build スキーマ

 
Expand
表8.70 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Build スキーマ

201 - Created

Build スキーマ

202 - Accepted

Build スキーマ

401 - Unauthorized

空白

8.4.2.2. /apis/config.openshift.io/v1/builds/{name}

Expand
表8.71 グローバルパスパラメーター
パラメータータイプ説明

name

string

ビルドの名前

Expand
表8.72 グローバルクエリーパラメーター
パラメータータイプ説明

pretty

string

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

HTTP メソッド
DELETE
Description
ビルドを削除する
Expand
表8.73 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

gracePeriodSeconds

integer

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

orphanDependents

boolean

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

propagationPolicy

string

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

Expand
表8.74 ボディパラメーター
パラメータータイプ説明

body

DeleteOptions_v2 schema

 
Expand
表8.75 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Status_v2 schema

202 - Accepted

Status_v2 schema

401 - Unauthorized

空白

HTTP メソッド
GET
Description
指定されたビルドを読み取る
Expand
表8.76 クエリーパラメーター
パラメータータイプ説明

resourceVersion

string

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

Defaults to unset

Expand
表8.77 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Build スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
Description
指定されたビルドを部分的に更新します
Expand
表8.78 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

fieldManager

string

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

Expand
表8.79 ボディパラメーター
パラメータータイプ説明

body

Patch schema

 
Expand
表8.80 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Build スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
Description
指定されたビルドを置き換えます
Expand
表8.81 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

fieldManager

string

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

Expand
表8.82 ボディパラメーター
パラメータータイプ説明

body

Build スキーマ

 
Expand
表8.83 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Build スキーマ

201 - Created

Build スキーマ

401 - Unauthorized

空白

8.4.2.3. /apis/config.openshift.io/v1/builds/{name}/status

Expand
表8.84 グローバルパスパラメーター
パラメータータイプ説明

name

string

ビルドの名前

Expand
表8.85 グローバルクエリーパラメーター
パラメータータイプ説明

pretty

string

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

HTTP メソッド
GET
Description
指定されたビルドのステータスを読み取ります
Expand
表8.86 クエリーパラメーター
パラメータータイプ説明

resourceVersion

string

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

Defaults to unset

Expand
表8.87 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Build スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
Description
指定されたビルドのステータスを部分的に更新します
Expand
表8.88 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

fieldManager

string

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

Expand
表8.89 ボディパラメーター
パラメータータイプ説明

body

Patch schema

 
Expand
表8.90 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Build スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
Description
指定されたビルドのステータスを置き換えます
Expand
表8.91 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

fieldManager

string

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

Expand
表8.92 ボディパラメーター
パラメータータイプ説明

body

Build スキーマ

 
Expand
表8.93 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Build スキーマ

201 - Created

Build スキーマ

401 - Unauthorized

空白

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat