30.8. Deployment [apps/v1]


Description
デプロイメントにより、Pod と ReplicaSets の宣言型更新が可能になります。
タイプ
object

30.8.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

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

spec

object

DeploymentSpec は、デプロイメントの望ましい動作の仕様です。

status

object

DeploymentStatus は、Deployment の最後に観察されたステータスです。

30.8.1.1. .spec

Description
DeploymentSpec は、デプロイメントの望ましい動作の仕様です。
タイプ
object
必須
  • selector
  • template
Expand
プロパティータイプDescription

minReadySeconds

integer

新しく作成された Pod が使用可能であると見なされるために、コンテナーがクラッシュすることなく準備ができる最小秒数。デフォルトは 0 です (Pod は準備ができ次第利用可能と見なされます)

paused

boolean

展開が一時停止されていることを示します。

progressDeadlineSeconds

integer

デプロイメントが失敗したと見なされる前に、デプロイメントが進行するまでの最大時間 (秒単位)。デプロイメントコントローラーは失敗したデプロイメントの処理を続行し、ProgressDeadlineExceeded 理由のある条件がデプロイメントステータスに表示されます。展開が一時停止している間は、進行状況は推定されないことに注意してください。デフォルトは 600 秒です。

replicas

integer

必要な Pod の数。これは、明示的なゼロと指定されていないものを区別するためのポインターです。デフォルトは 1 です。

revisionHistoryLimit

integer

ロールバックを可能にするために保持する古い ReplicaSet の数。これは、明示的なゼロと指定されていないものを区別するためのポインターです。デフォルトは 10 です。

selector

LabelSelector

Pod のラベルセレクター。これによって Pod が選択される既存の ReplicaSet は、このデプロイメントの影響を受けるものになります。Pod テンプレートのラベルと一致する必要があります。

strategy

object

DeploymentStrategy は、既存の Pod を新しい Pod に置き換える方法を説明しています。

template

PodTemplateSpec

テンプレートには、作成される Pod が記述されています。

30.8.1.2. .spec.strategy

Description
DeploymentStrategy は、既存の Pod を新しい Pod に置き換える方法を説明しています。
タイプ
object
Expand
プロパティータイプDescription

rollingUpdate

object

ローリング更新の望ましい動作を制御するための仕様。

type

string

展開のタイプ。Recreate または RollingUpdate にすることができます。デフォルトは RollingUpdate です。

30.8.1.3. .spec.strategy.rollingUpdate

Description
ローリング更新の望ましい動作を制御するための仕様。
タイプ
object
Expand
プロパティータイプDescription

maxSurge

IntOrString

希望する Pod 数を超えてスケジュールできる Pod の最大数。値は、絶対数 (例:5) または目的の Pod のパーセンテージ (例:10%) にすることができます。MaxUnavailable が 0 の場合、これを 0 にすることはできません。絶対数は、端数を切り上げてパーセンテージから計算されます。デフォルトは 25% です。例: これが 30% に設定されている場合、ローリング更新の開始時に新しい ReplicaSet をすぐにスケールアップして、新旧の Pod の総数が目的の Pod の 130% を超えないようにすることができます。古い Pod が強制終了されると、新しい ReplicaSet をさらにスケールアップして、更新中にいつでも実行されている Pod の総数が目的の Pod の最大 130% になるようにすることができます。

maxUnavailable

IntOrString

更新中に使用できなくなる可能性のある Pod の最大数。値は、絶対数 (例:5) または目的の Pod のパーセンテージ (例:10%) にすることができます。絶対数は、端数を切り捨ててパーセンテージから計算されます。MaxSurge が 0 の場合、これを 0 にすることはできません。デフォルトは 25% です。例: これが 30% に設定されている場合、ローリング更新が開始されるとすぐに、古い ReplicaSet を目的の Pod の 70% に縮小できます。新しい Pod の準備ができたら、古い ReplicaSet をさらにスケールダウンしてから、新しい ReplicaSet をスケールアップして、更新中に常に使用可能な Pod の総数が目的の Pod の少なくとも 70% になるようにします。

30.8.1.4. .status

Description
DeploymentStatus は、Deployment の最後に観察されたステータスです。
タイプ
object
Expand
プロパティータイプDescription

availableReplicas

integer

このデプロイメントの対象となる利用可能な Pod の総数 (少なくとも minReadySeconds の準備ができています)。

collisionCount

integer

Deployment のハッシュ競合の数。Deployment コントローラーは、最新の ReplicaSet の名前を作成する必要がある場合に、このフィールドを競合回避メカニズムとして使用します。

conditions

array

デプロイメントの現在の状態の最新の利用可能な観測を表します。

conditions[]

object

DeploymentCondition は、特定の時点でのデプロイメントの状態を記述します。

observedGeneration

integer

デプロイメントコントローラーにより監視される世代。

readyReplicas

integer

このデプロイメントの対象となる準備ができている Pod の総数。

replicas

integer

このデプロイメントの対象となる非終了 Pod の総数 (ラベルはセレクターと一致します)。

unavailableReplicas

integer

このデプロイメントの対象となる使用できない Pod の総数。これは、デプロイメントで 100% の使用可能な容量を確保するために必要な Pod の総数です。それらは、実行されているがまだ利用できない Pod か、まだ作成されていない Pod のいずれかです。

updatedReplicas

integer

目的のテンプレート仕様を持つ、このデプロイメントの対象となる非終了 Pod の総数。

30.8.1.5. .status.conditions

Description
デプロイメントの現在の状態の最新の利用可能な観測を表します。
タイプ
array

30.8.1.6. .status.conditions[]

Description
DeploymentCondition は、特定の時点でのデプロイメントの状態を記述します。
タイプ
object
必須
  • type
  • status
Expand
プロパティータイプ説明

lastTransitionTime

時間

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

lastUpdateTime

時間

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

message

string

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

reason

string

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

status

string

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

type

string

デプロイメント条件のタイプ。

30.8.2. API エンドポイント

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

  • /apis/apps/v1/deployments

    • GET: Deployment 種類のオブジェクトを一覧表示または監視する
  • /apis/apps/v1/watch/deployments

    • GET: Deployment のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で watch パラメーターを使用してください。
  • /apis/apps/v1/namespaces/{namespace}/deployments

    • DELETE: Deployment のコレクションを削除する
    • GET: Deployment 種類のオブジェクトを一覧表示または監視する
    • POST: Deployment を作成する
  • /apis/apps/v1/watch/namespaces/{namespace}/deployments

    • GET: Deployment のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で watch パラメーターを使用してください。
  • /apis/apps/v1/namespaces/{namespace}/deployments/{name}

    • DELETE: Deployment を削除する
    • GET: 指定された Deployment を読み取る
    • PATCH: 指定された Deployment を部分的に更新する
    • PUT: 指定されたデプロイメントを置き換える
  • /apis/apps/v1/watch/namespaces/{namespace}/deployments/{name}

    • GET: Deployment 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で watch パラメーターを使用し、fieldSelector パラメーターで単一の項目にフィルター処理します。
  • /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status

    • GET: 指定されたデプロイメントのステータスを読み取る
    • PATCH: 指定された Deployment のステータスを部分的に更新する
    • PUT: 指定された Deployment のステータスを置き換える

30.8.2.1. /apis/apps/v1/deployments

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

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

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

HTTP メソッド
GET
Description
Deployment 種類のオブジェクトを一覧表示または監視する
Expand
表30.169 HTTP 応答
HTTP コードレスポンス本文

200 - OK

DeploymentList スキーマ

401 - Unauthorized

空白

30.8.2.2. /apis/apps/v1/watch/deployments

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

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

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

HTTP メソッド
GET
Description
Deployment のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で watch パラメーターを使用してください。
Expand
表30.171 HTTP 応答
HTTP コードレスポンス本文

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

30.8.2.3. /apis/apps/v1/namespaces/{namespace}/deployments

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

namespace

string

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

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

pretty

string

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

HTTP メソッド
DELETE
Description
Deployment のコレクションを削除する
Expand
表30.174 クエリーパラメーター
パラメータータイプ説明

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

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

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

body

DeleteOptions スキーマ

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

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
Description
Deployment 種類のオブジェクトを一覧表示または監視する
Expand
表30.177 クエリーパラメーター
パラメータータイプ説明

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
表30.178 HTTP 応答
HTTP コードレスポンス本文

200 - OK

DeploymentList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
Description
デプロイメントを作成する
Expand
表30.179 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

fieldManager

string

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

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

body

Deployment スキーマ

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

200 - OK

Deployment スキーマ

201 - Created

Deployment スキーマ

202 - Accepted

Deployment スキーマ

401 - Unauthorized

空白

30.8.2.4. /apis/apps/v1/watch/namespaces/{namespace}/deployments

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

namespace

string

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

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

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

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

HTTP メソッド
GET
Description
Deployment のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で watch パラメーターを使用してください。
Expand
表30.184 HTTP 応答
HTTP コードレスポンス本文

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

30.8.2.5. /apis/apps/v1/namespaces/{namespace}/deployments/{name}

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

name

string

デプロイメントの名前。

namespace

string

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

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

pretty

string

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

HTTP メソッド
DELETE
Description
デプロイメントを削除する
Expand
表30.187 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

gracePeriodSeconds

integer

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

orphanDependents

boolean

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

propagationPolicy

string

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

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

body

DeleteOptions スキーマ

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

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
Description
指定された Deployment を読み取る
Expand
表30.190 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Deployment スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
Description
指定された Deployment を読み込む。
Expand
表30.191 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

fieldManager

string

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

force

boolean

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

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

body

Patch schema

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

200 - OK

Deployment スキーマ

201 - Created

Deployment スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
Description
指定されたデプロイメントを置き換える
Expand
表30.194 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

fieldManager

string

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

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

body

Deployment スキーマ

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

200 - OK

Deployment スキーマ

201 - Created

Deployment スキーマ

401 - Unauthorized

空白

30.8.2.6. /apis/apps/v1/watch/namespaces/{namespace}/deployments/{name}

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

name

string

デプロイメントの名前。

namespace

string

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

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

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

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

HTTP メソッド
GET
Description
Deployment 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で watch パラメーターを使用し、fieldSelector パラメーターで単一の項目にフィルター処理します。
Expand
表30.199 HTTP 応答
HTTP コードレスポンス本文

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

30.8.2.7. /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status

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

name

string

デプロイメントの名前。

namespace

string

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

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

pretty

string

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

HTTP メソッド
GET
Description
指定された Deployment のステータスを読み取る
Expand
表30.202 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Deployment スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

force

boolean

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

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

body

Patch schema

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

200 - OK

Deployment スキーマ

201 - Created

Deployment スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

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

body

Deployment スキーマ

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

200 - OK

Deployment スキーマ

201 - Created

Deployment スキーマ

401 - Unauthorized

空白

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

Theme

© 2025 Red Hat