30.9. DeploymentConfig [apps.openshift.io/v1]


Description

Deployment Configs は、Pod のテンプレートを定義し、新しいイメージのデプロイまたは設定の変更を管理します。単一のデプロイメント設定は通常、単一のマイクロサービスに類似しています。完全な再起動、カスタマイズ可能なローリング更新、完全にカスタム化された動作、デプロイメント前およびデプロイメント後のフックなど、さまざまなデプロイメントパターンをサポートできます。個々のデプロイメントは、レプリケーションコントローラーとして表されます。

デプロイメントは、その設定が変更されたとき、またはイメージストリーム内のタグが変更されたときにトリガーされます。トリガーを無効にして、デプロイメントを手動で制御できるようにすることができます。戦略は、デプロイメントの実行方法を決定し、いつでも変更できます。latestVersion フィールドは、何らかの方法で新しいデプロイメントがトリガーされたときに更新されます。

タイプ
object
必須
  • spec

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

 

spec

object

DeploymentConfigSpec は、デプロイメントの望ましい状態を表します。

status

object

DeploymentConfigStatus は、現在のデプロイメント状態を表します。

30.9.1.1. .spec

Description
DeploymentConfigSpec は、デプロイメントの望ましい状態を表します。
タイプ
object
Expand
プロパティータイプDescription

minReadySeconds

integer

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

paused

boolean

Paused は、デプロイメント設定が一時停止され、テンプレートの変更または他のトリガーにより引き起こされたテンプレートの変更に新しいデプロイメントが発生しないことを示します。

replicas

integer

レプリカは、必要なレプリカの数です。

revisionHistoryLimit

integer

RevisionHistoryLimit は、ロールバックを可能にするために保持する古い ReplicationController の数です。このフィールドは、明示的なゼロと、指定されていないものを区別できるようにするためのポインターです。デフォルトは 10 です。(これは、レガシーリソースではなく、新しいグループの API リソースを介して作成された DeploymentConfig にのみ適用されます。)

selector

object (string)

Selector は、Replicas 数と一致する必要がある Pod に対するラベルクエリーです。

strategy

object

DeploymentStrategy は、デプロイメントを実行する方法を説明します。

template

PodTemplateSpec

テンプレートは、不十分なレプリカが検出された場合に作成される Pod を説明するオブジェクトです。

test

boolean

テストでは、デプロイメントの実行中を除いて、このデプロイメント設定のレプリカがゼロであることを確認します。これにより、デプロイメント設定を継続的なデプロイメントテストとして使用できます。つまり、イメージでトリガーし、デプロイメントを実行してから、成功または失敗します。ポストストラテジーフックと After アクションを使用して、デプロイメントの成功をアクションと統合できます。

triggers

array

トリガーは、DeploymentConfig の更新によって新しいデプロイメントがどのように発生するかを決定します。トリガーが定義されていない場合、新しいデプロイメントは、新しい LatestVersion を使用した DeploymentConfig への明示的なクライアント更新の結果としてのみ発生します。null の場合、デフォルトで設定変更トリガーが設定されます。

triggers[]

object

DeploymentTriggerPolicy は、新しいデプロイメントをもたらす単一のトリガーのポリシーを記述します。

30.9.1.2. .spec.strategy

Description
DeploymentStrategy は、デプロイメントを実行する方法を説明します。
タイプ
object
Expand
プロパティータイプDescription

activeDeadlineSeconds

integer

ActiveDeadlineSeconds は、システムがアクティブに終了を試みる前に、このデプロイメント設定のデプロイヤー Pod がノード上でアクティブになる可能性がある秒単位の期間です。

annotations

object (string)

Annotations は、カスタムデプロイヤーとライフサイクルのプレ/ポストフック Pod に追加されるキーと値のペアのセットです。

customParams

object

CustomDeploymentStrategyParams は、カスタムデプロイメント戦略への入力です。

labels

object (string)

ラベルは、カスタムデプロイヤーとライフサイクルのプレ/ポストフック Pod に追加されるキーと値のペアのセットです。

recreateParams

object

RecreateDeploymentStrategyParams は、Recreate デプロイメント戦略への入力です。

resources

ResourceRequirements

リソースには、デプロイメントおよびフックを実行するためのリソース要件が含まれています。

rollingParams

object

RollingDeploymentStrategyParams は、Rolling デプロイメント戦略への入力です。

type

string

タイプは、デプロイメント戦略の名前です。

30.9.1.3. .spec.strategy.customParams

Description
CustomDeploymentStrategyParams は、カスタムデプロイメント戦略への入力です。
タイプ
object
Expand
プロパティータイプDescription

command

array (string)

Command は任意であり、コンテナーイメージの CMD を上書きします。

environment

array (EnvVar_v2)

環境は、イメージのコンテナーに与えられる環境を保持します。

image

string

イメージは、デプロイメントを実行できるコンテナーイメージを指定します。

30.9.1.4. .spec.strategy.recreateParams

Description
RecreateDeploymentStrategyParams は、Recreate デプロイメント戦略への入力です。
タイプ
object
Expand
プロパティータイプDescription

mid

object

LifecycleHook は、特定のデプロイメントライフサイクルアクションを定義します。一度に指定できるアクションのタイプは 1 つだけです。

post

object

LifecycleHook は、特定のデプロイメントライフサイクルアクションを定義します。一度に指定できるアクションのタイプは 1 つだけです。

pre

object

LifecycleHook は、特定のデプロイメントライフサイクルアクションを定義します。一度に指定できるアクションのタイプは 1 つだけです。

timeoutSeconds

integer

TimeoutSeconds は、更新を待ってからあきらめるまでの時間です。値が nil の場合は、デフォルトが使用されます。

30.9.1.5. .spec.strategy.recreateParams.mid

Description
LifecycleHook は、特定のデプロイメントライフサイクルアクションを定義します。一度に指定できるアクションのタイプは 1 つだけです。
タイプ
object
必須
  • failurePolicy
Expand
プロパティータイプDescription

execNewPod

object

ExecNewPodHook は、デプロイメントテンプレートの一部であると想定される指定されたコンテナーに基づいて、新しい Pod でコマンドを実行するフック実装です。

failurePolicy

string

FailurePolicy は、フックが失敗した場合に実行するアクションを指定します。

tagImages

array

TagImages は、コンテナーの下で参照されている現在のイメージをイメージストリームタグにタグ付けするようにデプロイヤ-に指示します。

tagImages[]

object

TagImageHook は、特定のコンテナー内のイメージを ImageStreamTag にタグ付けするリクエストです。

30.9.1.6. .spec.strategy.recreateParams.mid.execNewPod

Description
ExecNewPodHook は、デプロイメントテンプレートの一部であると想定される指定されたコンテナーに基づいて、新しい Pod でコマンドを実行するフック実装です。
タイプ
object
必須
  • command
  • containerName
Expand
プロパティータイプDescription

command

array (string)

コマンドは、アクションコマンドおよびその引数です。

containerName

string

ContainerName は、デプロイメント Pod テンプレート内のコンテナーの名前であり、そのコンテナーイメージはフック Pod のコンテナーに使用されます。

env

array (EnvVar_v2)

Env は、フック Pod のコンテナーに提供する環境変数のセットです。

volumes

array (string)

ボリュームは、フック Pod にコピーする必要がある Pod テンプレートからの名前付きボリュームのリストです。Pod 仕様にないボリューム名は無視されます。空のリストは、ボリュームがコピーされないことを意味します。

30.9.1.7. .spec.strategy.recreateParams.mid.tagImages

Description
TagImages は、コンテナーの下で参照されている現在のイメージをイメージストリームタグにタグ付けするようにデプロイヤ-に指示します。
タイプ
array

30.9.1.8. .spec.strategy.recreateParams.mid.tagImages[]

Description
TagImageHook は、特定のコンテナー内のイメージを ImageStreamTag にタグ付けするリクエストです。
タイプ
object
必須
  • containerName
  • 上記を以下のように変更します。
Expand
プロパティータイプDescription

containerName

string

ContainerName は、イメージ値がタグのソースとして使用されるデプロイメント設定内のコンテナーの名前です。コンテナーが 1 つしかない場合、この値はデフォルトでそのコンテナーの名前になります。

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

ObjectReference_v2

To は、コンテナーのイメージを設定するターゲット ImageStreamTag です。

30.9.1.9. .spec.strategy.recreateParams.post

Description
LifecycleHook は、特定のデプロイメントライフサイクルアクションを定義します。一度に指定できるアクションのタイプは 1 つだけです。
タイプ
object
必須
  • failurePolicy
Expand
プロパティータイプDescription

execNewPod

object

ExecNewPodHook は、デプロイメントテンプレートの一部であると想定される指定されたコンテナーに基づいて、新しい Pod でコマンドを実行するフック実装です。

failurePolicy

string

FailurePolicy は、フックが失敗した場合に実行するアクションを指定します。

tagImages

array

TagImages は、コンテナーの下で参照されている現在のイメージをイメージストリームタグにタグ付けするようにデプロイヤ-に指示します。

tagImages[]

object

TagImageHook は、特定のコンテナー内のイメージを ImageStreamTag にタグ付けするリクエストです。

30.9.1.10. .spec.strategy.recreateParams.post.execNewPod

Description
ExecNewPodHook は、デプロイメントテンプレートの一部であると想定される指定されたコンテナーに基づいて、新しい Pod でコマンドを実行するフック実装です。
タイプ
object
必須
  • command
  • containerName
Expand
プロパティータイプDescription

command

array (string)

コマンドは、アクションコマンドおよびその引数です。

containerName

string

ContainerName は、デプロイメント Pod テンプレート内のコンテナーの名前であり、そのコンテナーイメージはフック Pod のコンテナーに使用されます。

env

array (EnvVar_v2)

Env は、フック Pod のコンテナーに提供する環境変数のセットです。

volumes

array (string)

ボリュームは、フック Pod にコピーする必要がある Pod テンプレートからの名前付きボリュームのリストです。Pod 仕様にないボリューム名は無視されます。空のリストは、ボリュームがコピーされないことを意味します。

30.9.1.11. .spec.strategy.recreateParams.post.tagImages

Description
TagImages は、コンテナーの下で参照されている現在のイメージをイメージストリームタグにタグ付けするようにデプロイヤ-に指示します。
タイプ
array

30.9.1.12. .spec.strategy.recreateParams.post.tagImages[]

Description
TagImageHook は、特定のコンテナー内のイメージを ImageStreamTag にタグ付けするリクエストです。
タイプ
object
必須
  • containerName
  • 上記を以下のように変更します。
Expand
プロパティータイプDescription

containerName

string

ContainerName は、イメージ値がタグのソースとして使用されるデプロイメント設定内のコンテナーの名前です。コンテナーが 1 つしかない場合、この値はデフォルトでそのコンテナーの名前になります。

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

ObjectReference_v2

To は、コンテナーのイメージを設定するターゲット ImageStreamTag です。

30.9.1.13. .spec.strategy.recreateParams.pre

Description
LifecycleHook は、特定のデプロイメントライフサイクルアクションを定義します。一度に指定できるアクションのタイプは 1 つだけです。
タイプ
object
必須
  • failurePolicy
Expand
プロパティータイプDescription

execNewPod

object

ExecNewPodHook は、デプロイメントテンプレートの一部であると想定される指定されたコンテナーに基づいて、新しい Pod でコマンドを実行するフック実装です。

failurePolicy

string

FailurePolicy は、フックが失敗した場合に実行するアクションを指定します。

tagImages

array

TagImages は、コンテナーの下で参照されている現在のイメージをイメージストリームタグにタグ付けするようにデプロイヤ-に指示します。

tagImages[]

object

TagImageHook は、特定のコンテナー内のイメージを ImageStreamTag にタグ付けするリクエストです。

30.9.1.14. .spec.strategy.recreateParams.pre.execNewPod

Description
ExecNewPodHook は、デプロイメントテンプレートの一部であると想定される指定されたコンテナーに基づいて、新しい Pod でコマンドを実行するフック実装です。
タイプ
object
必須
  • command
  • containerName
Expand
プロパティータイプDescription

command

array (string)

コマンドは、アクションコマンドおよびその引数です。

containerName

string

ContainerName は、デプロイメント Pod テンプレート内のコンテナーの名前であり、そのコンテナーイメージはフック Pod のコンテナーに使用されます。

env

array (EnvVar_v2)

Env は、フック Pod のコンテナーに提供する環境変数のセットです。

volumes

array (string)

ボリュームは、フック Pod にコピーする必要がある Pod テンプレートからの名前付きボリュームのリストです。Pod 仕様にないボリューム名は無視されます。空のリストは、ボリュームがコピーされないことを意味します。

30.9.1.15. .spec.strategy.recreateParams.pre.tagImages

Description
TagImages は、コンテナーの下で参照されている現在のイメージをイメージストリームタグにタグ付けするようにデプロイヤ-に指示します。
タイプ
array

30.9.1.16. .spec.strategy.recreateParams.pre.tagImages[]

Description
TagImageHook は、特定のコンテナー内のイメージを ImageStreamTag にタグ付けするリクエストです。
タイプ
object
必須
  • containerName
  • 上記を以下のように変更します。
Expand
プロパティータイプDescription

containerName

string

ContainerName は、イメージ値がタグのソースとして使用されるデプロイメント設定内のコンテナーの名前です。コンテナーが 1 つしかない場合、この値はデフォルトでそのコンテナーの名前になります。

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

ObjectReference_v2

To は、コンテナーのイメージを設定するターゲット ImageStreamTag です。

30.9.1.17. .spec.strategy.rollingParams

Description
RollingDeploymentStrategyParams は、Rolling デプロイメント戦略への入力です。
タイプ
object
Expand
プロパティータイプDescription

intervalSeconds

integer

IntervalSeconds は、更新後のデプロイメントステータスのポーリングの間に待機する時間です。値が nil の場合は、デフォルトが使用されます。

maxSurge

IntOrString

MaxSurge は、元の Pod 数を超えてスケジュールできる Pod の最大数です。値は、絶対数 (例: 5) または更新開始時の Pod 全体のパーセンテージ (例: 10%) にすることができます。絶対数は、端数を切り上げてパーセンテージから計算されます。

MaxUnavailable が 0 の場合は、これを 0 にすることができません。デフォルトでは、25% が使用されます。

例: これが 30% に設定されている場合は、ローリング更新が開始するとすぐに新しい RC を 30% スケールアップできます。古い Pod が強制的に終了されると、新しい RC をさらにスケールアップして、更新中にいつでも実行されている Pod の総数が元の Pod の最大 130% になるようにすることができます。

maxUnavailable

IntOrString

MaxUnavailable は、更新中に使用できなくなる可能性のある Pod の最大数です。値は、絶対数 (例: 5) または更新開始時の Pod 全体のパーセンテージ (例: 10%) にすることができます。絶対数は、端数を切り捨ててパーセンテージから計算されます。

MaxSurge が 0 の場合は、これを 0 にすることはできません。デフォルトでは、25% が使用されます。

例: これが 30% に設定されている場合は、ローリング更新が開始されるとすぐに古い RC を 30% 縮小できます。新しい Pod の準備ができたら、古い RC をさらにスケールダウンしてから、新しい RC をスケールアップして、更新中に常に元の Pod 数の 70% 以上を使用できるようにします。

post

object

LifecycleHook は、特定のデプロイメントライフサイクルアクションを定義します。一度に指定できるアクションのタイプは 1 つだけです。

pre

object

LifecycleHook は、特定のデプロイメントライフサイクルアクションを定義します。一度に指定できるアクションのタイプは 1 つだけです。

timeoutSeconds

integer

TimeoutSeconds は、更新を待ってからあきらめるまでの時間です。値が nil の場合は、デフォルトが使用されます。

updatePeriodSeconds

integer

UpdatePeriodSeconds は、個々の Pod の更新の間に待機する時間です。値が nil の場合は、デフォルトが使用されます。

30.9.1.18. .spec.strategy.rollingParams.post

Description
LifecycleHook は、特定のデプロイメントライフサイクルアクションを定義します。一度に指定できるアクションのタイプは 1 つだけです。
タイプ
object
必須
  • failurePolicy
Expand
プロパティータイプDescription

execNewPod

object

ExecNewPodHook は、デプロイメントテンプレートの一部であると想定される指定されたコンテナーに基づいて、新しい Pod でコマンドを実行するフック実装です。

failurePolicy

string

FailurePolicy は、フックが失敗した場合に実行するアクションを指定します。

tagImages

array

TagImages は、コンテナーの下で参照されている現在のイメージをイメージストリームタグにタグ付けするようにデプロイヤ-に指示します。

tagImages[]

object

TagImageHook は、特定のコンテナー内のイメージを ImageStreamTag にタグ付けするリクエストです。

30.9.1.19. .spec.strategy.rollingParams.post.execNewPod

Description
ExecNewPodHook は、デプロイメントテンプレートの一部であると想定される指定されたコンテナーに基づいて、新しい Pod でコマンドを実行するフック実装です。
タイプ
object
必須
  • command
  • containerName
Expand
プロパティータイプDescription

command

array (string)

コマンドは、アクションコマンドおよびその引数です。

containerName

string

ContainerName は、デプロイメント Pod テンプレート内のコンテナーの名前であり、そのコンテナーイメージはフック Pod のコンテナーに使用されます。

env

array (EnvVar_v2)

Env は、フック Pod のコンテナーに提供する環境変数のセットです。

volumes

array (string)

ボリュームは、フック Pod にコピーする必要がある Pod テンプレートからの名前付きボリュームのリストです。Pod 仕様にないボリューム名は無視されます。空のリストは、ボリュームがコピーされないことを意味します。

30.9.1.20. .spec.strategy.rollingParams.post.tagImages

Description
TagImages は、コンテナーの下で参照されている現在のイメージをイメージストリームタグにタグ付けするようにデプロイヤ-に指示します。
タイプ
array

30.9.1.21. .spec.strategy.rollingParams.post.tagImages[]

Description
TagImageHook は、特定のコンテナー内のイメージを ImageStreamTag にタグ付けするリクエストです。
タイプ
object
必須
  • containerName
  • 上記を以下のように変更します。
Expand
プロパティータイプDescription

containerName

string

ContainerName は、イメージ値がタグのソースとして使用されるデプロイメント設定内のコンテナーの名前です。コンテナーが 1 つしかない場合、この値はデフォルトでそのコンテナーの名前になります。

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

ObjectReference_v2

To は、コンテナーのイメージを設定するターゲット ImageStreamTag です。

30.9.1.22. .spec.strategy.rollingParams.pre

Description
LifecycleHook は、特定のデプロイメントライフサイクルアクションを定義します。一度に指定できるアクションのタイプは 1 つだけです。
タイプ
object
必須
  • failurePolicy
Expand
プロパティータイプDescription

execNewPod

object

ExecNewPodHook は、デプロイメントテンプレートの一部であると想定される指定されたコンテナーに基づいて、新しい Pod でコマンドを実行するフック実装です。

failurePolicy

string

FailurePolicy は、フックが失敗した場合に実行するアクションを指定します。

tagImages

array

TagImages は、コンテナーの下で参照されている現在のイメージをイメージストリームタグにタグ付けするようにデプロイヤ-に指示します。

tagImages[]

object

TagImageHook は、特定のコンテナー内のイメージを ImageStreamTag にタグ付けするリクエストです。

30.9.1.23. .spec.strategy.rollingParams.pre.execNewPod

Description
ExecNewPodHook は、デプロイメントテンプレートの一部であると想定される指定されたコンテナーに基づいて、新しい Pod でコマンドを実行するフック実装です。
タイプ
object
必須
  • command
  • containerName
Expand
プロパティータイプDescription

command

array (string)

コマンドは、アクションコマンドおよびその引数です。

containerName

string

ContainerName は、デプロイメント Pod テンプレート内のコンテナーの名前であり、そのコンテナーイメージはフック Pod のコンテナーに使用されます。

env

array (EnvVar_v2)

Env は、フック Pod のコンテナーに提供する環境変数のセットです。

volumes

array (string)

ボリュームは、フック Pod にコピーする必要がある Pod テンプレートからの名前付きボリュームのリストです。Pod 仕様にないボリューム名は無視されます。空のリストは、ボリュームがコピーされないことを意味します。

30.9.1.24. .spec.strategy.rollingParams.pre.tagImages

Description
TagImages は、コンテナーの下で参照されている現在のイメージをイメージストリームタグにタグ付けするようにデプロイヤ-に指示します。
タイプ
array

30.9.1.25. .spec.strategy.rollingParams.pre.tagImages[]

Description
TagImageHook は、特定のコンテナー内のイメージを ImageStreamTag にタグ付けするリクエストです。
タイプ
object
必須
  • containerName
  • 上記を以下のように変更します。
Expand
プロパティータイプDescription

containerName

string

ContainerName は、イメージ値がタグのソースとして使用されるデプロイメント設定内のコンテナーの名前です。コンテナーが 1 つしかない場合、この値はデフォルトでそのコンテナーの名前になります。

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

ObjectReference_v2

To は、コンテナーのイメージを設定するターゲット ImageStreamTag です。

30.9.1.26. .spec.triggers

Description
トリガーは、DeploymentConfig の更新によって新しいデプロイメントがどのように発生するかを決定します。トリガーが定義されていない場合、新しいデプロイメントは、新しい LatestVersion を使用した DeploymentConfig への明示的なクライアント更新の結果としてのみ発生します。null の場合、デフォルトで設定変更トリガーが設定されます。
タイプ
array

30.9.1.27. .spec.triggers[]

Description
DeploymentTriggerPolicy は、新しいデプロイメントをもたらす単一のトリガーのポリシーを記述します。
タイプ
object
Expand
プロパティータイプDescription

imageChangeParams

object

DeploymentTriggerImageChangeParams は、ImageChange トリガーへのパラメーターを表します。

type

string

トリガーの種類

30.9.1.28. .spec.triggers[].imageChangeParams

Description
DeploymentTriggerImageChangeParams は、ImageChange トリガーへのパラメーターを表します。
タイプ
object
必須
  • from
Expand
プロパティータイプDescription

自動

boolean

自動とは、新しいタグ値を検出すると、Pod テンプレート内のイメージが更新されることを意味します。

containerNames

array (string)

ContainerNames は、タグの更新を Pod 内の指定されたコンテナー名のセットに制限するために使用されます。複数のトリガーが同じコンテナーを指している場合、結果の動作は未定義です。将来の API バージョンでは、これは検証エラーになります。ContainerNames が有効なコンテナーを指していない場合、トリガーは無視されます。将来の API バージョンでは、これは検証エラーになります。

from

ObjectReference_v2

From は、変更を監視するためのイメージストリームタグへの参照です。From.Name が唯一の必須サブフィールドです。- From.Namespace が空白の場合、現在のデプロイメントトリガーの namespace が使用されます。

lastTriggeredImage

string

LastTriggeredImage は、トリガーされる最後のイメージです。

30.9.1.29. .status

Description
DeploymentConfigStatus は、現在のデプロイメント状態を表します。
タイプ
object
必須
  • latestVersion
  • observedGeneration
  • replicas
  • updatedReplicas
  • availableReplicas
  • unavailableReplicas
Expand
プロパティータイプDescription

availableReplicas

integer

AvailableReplicas は、このデプロイメント設定の対象となる使用可能な Pod の総数です。

conditions

array

条件は、デプロイメント設定の現在の状態について利用可能な最新の観測値を表します。

conditions[]

object

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

詳細

object

DeploymentDetails は、デプロイメントの原因に関する情報をキャプチャーします。

latestVersion

integer

LatestVersion は、デプロイメント設定に関連付けられている現在のデプロイメントが同期していないかどうかを判別するのに使用されます。

observedGeneration

integer

ObservedGeneration は、デプロイメント設定コントローラーによって観察された最新の世代です。

readyReplicas

integer

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

replicas

integer

レプリカは、このデプロイメント設定の対象となる Pod の総数です。

unavailableReplicas

integer

UnavailableReplicas は、このデプロイメント設定の対象となる使用できない Pod の総数です。

updatedReplicas

integer

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

30.9.1.30. .status.conditions

Description
条件は、デプロイメント設定の現在の状態について利用可能な最新の観測値を表します。
タイプ
array

30.9.1.31. .status.conditions[]

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

lastTransitionTime

時間

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

lastUpdateTime

時間

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

message

string

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

reason

string

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

status

string

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

type

string

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

30.9.1.32. .status.details

Description
DeploymentDetails は、デプロイメントの原因に関する情報をキャプチャーします。
タイプ
object
必須
  • causes
Expand
プロパティータイプDescription

causes

array

原因は、新しいデプロイメントを作成するためのすべての原因に関連付けられた拡張データです

causes[]

object

DeploymentCause は、デプロイメントの特定の原因に関する情報をキャプチャーします。

message

string

このデプロイメントがユーザーによって手動でトリガーされた場合、メッセージはユーザー指定の変更メッセージです

30.9.1.33. .status.details.causes

Description
原因は、新しいデプロイメントを作成するためのすべての原因に関連付けられた拡張データです
タイプ
array

30.9.1.34. .status.details.causes[]

Description
DeploymentCause は、デプロイメントの特定の原因に関する情報をキャプチャーします。
タイプ
object
必須
  • type
Expand
プロパティータイプDescription

imageTrigger

object

DeploymentCauseImageTrigger は、イメージ変更トリガーに起因するデプロイメントの原因に関する詳細を表します

type

string

新しいデプロイメントの作成につながったトリガーのタイプ

30.9.1.35. .status.details.causes[].imageTrigger

Description
DeploymentCauseImageTrigger は、イメージ変更トリガーに起因するデプロイメントの原因に関する詳細を表します
タイプ
object
必須
  • from
Expand
プロパティータイプDescription

from

ObjectReference_v2

From は、デプロイメントをトリガーした変更されたオブジェクトへの参照です。フィールドには、DockerImage、ImageStreamTag、または ImageStreamImage の種類があります。

30.9.2. API エンドポイント

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

  • /apis/apps.openshift.io/v1/deploymentconfigs

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

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

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

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

    • DELETE: DeploymentConfig を削除する
    • GET: 指定された DeploymentConfig を読み取ります。
    • PATCH: 指定された DeploymentConfig を一部更新します。
    • PUT: 指定された DeploymentConfig を置き換えます。
  • /apis/apps.openshift.io/v1/watch/namespaces/{namespace}/deploymentconfigs/{name}

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

    • GET: 指定された DeploymentConfig のステータスを読み取る
    • PATCH: 指定された DeploymentConfig のステータスを部分的に更新する
    • PUT: 指定された DeploymentConfig のステータスを置き換える

30.9.2.1. /apis/apps.openshift.io/v1/deploymentconfigs

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

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

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

200 - OK

DeploymentConfigList スキーマ

401 - Unauthorized

空白

30.9.2.2. /apis/apps.openshift.io/v1/watch/deploymentconfigs

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

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

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

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

30.9.2.3. /apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs

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

namespace

string

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

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

pretty

string

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

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

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.216 ボディパラメーター
パラメータータイプ説明

body

DeleteOptions スキーマ

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

200 - OK

Status スキーマ

401 - Unauthorized

空白

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

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

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

200 - OK

DeploymentConfigList スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

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

body

DeploymentConfig schema

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

200 - OK

DeploymentConfig schema

201 - Created

DeploymentConfig schema

202 - Accepted

DeploymentConfig schema

401 - Unauthorized

空白

30.9.2.4. /apis/apps.openshift.io/v1/watch/namespaces/{namespace}/deploymentconfigs

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

namespace

string

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

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

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

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

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

30.9.2.5. /apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}

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

name

string

DeploymentConfig の名前

namespace

string

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

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

pretty

string

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

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

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.229 ボディパラメーター
パラメータータイプ説明

body

DeleteOptions スキーマ

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

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
Description
指定された DeploymentConfig を読み込む。
Expand
表30.231 HTTP 応答
HTTP コードレスポンス本文

200 - OK

DeploymentConfig schema

401 - Unauthorized

空白

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

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.233 ボディパラメーター
パラメータータイプ説明

body

Patch schema

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

200 - OK

DeploymentConfig schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

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

body

DeploymentConfig schema

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

200 - OK

DeploymentConfig schema

201 - Created

DeploymentConfig schema

401 - Unauthorized

空白

30.9.2.6. /apis/apps.openshift.io/v1/watch/namespaces/{namespace}/deploymentconfigs/{name}

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

name

string

DeploymentConfig の名前

namespace

string

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

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

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

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

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

30.9.2.7. /apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/status

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

name

string

DeploymentConfig の名前

namespace

string

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

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

pretty

string

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

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

200 - OK

DeploymentConfig schema

401 - Unauthorized

空白

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

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.245 ボディパラメーター
パラメータータイプ説明

body

Patch schema

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

200 - OK

DeploymentConfig schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

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

body

DeploymentConfig schema

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

200 - OK

DeploymentConfig schema

201 - Created

DeploymentConfig schema

401 - Unauthorized

空白

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

Theme

© 2025 Red Hat