OperatorHub API


OpenShift Container Platform 4.20

OperatorHub API のリファレンスガイド

Red Hat OpenShift Documentation Team

概要

このドキュメントでは、OpenShift Container Platform の OperatorHub API のオブジェクトとその詳細な仕様を説明します。

第1章 OperatorHub API

1.1. CatalogSource [operators.coreos.com/v1alpha1]

説明
CatalogSource は、CSV、CRD、および Operator パッケージのリポジトリーです。
object

1.2. ClusterCatalog [olm.operatorframework.io/v1]

説明
ClusterCatalog を使用すると、ユーザーはファイルベースカタログ (FBC) カタログデータをクラスターで使用できるようになります。FBC の詳細は、https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs を参照してください。
object

1.3. ClusterExtension [olm.operatorframework.io/v1]

説明
ClusterExtension は clusterextensions API のスキーマです。
object

1.4. ClusterServiceVersion [operators.coreos.com/v1alpha1]

説明
ClusterServiceVersion は、タイプ ClusterServiceVersionSpec のカスタムリソースです。
object

1.5. InstallPlan [operators.coreos.com/v1alpha1]

説明
InstallPlan は、一連の Operator のインストールを定義します。
object

1.6. OLMConfig [operators.coreos.com/v1]

説明
OLMConfig は、OLM の設定を担うリソースです。
object

1.7. Operator [operators.coreos.com/v1]

説明
Operator はクラスター Operator を表します。
object

1.8. OperatorCondition [operators.coreos.com/v2]

説明
OperatorCondition は、OperatorCondition タイプのカスタムリソースであり、Operator の状態に関する情報を OLM に伝達するために使用されます。
object

1.9. OperatorGroup [operators.coreos.com/v1]

説明
OperatorGroup は、OLM マネージドオペレーターのマルチテナンシーの単位です。namespace への Operator のインストールを、指定されたターゲット namespace のセットに制限します。
object

1.10. PackageManifest [packages.operators.coreos.com/v1]

説明
PackageManifest は、パッケージに関する情報を保持します。これは、単一のパッケージの下にある 1 つ (または複数) のチャネルへの参照です。
object

1.11. Subscription [operators.coreos.com/v1alpha1]

説明
サブスクリプションは、カタログへの変更を追跡することにより、Operator を最新の状態に保ちます。
object

第2章 CatalogSource [operators.coreos.com/v1alpha1]

説明
CatalogSource は、CSV、CRD、および Operator パッケージのリポジトリーです。
object
必須
  • metadata
  • spec

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

 

status

object

 

2.1.1. .spec

説明
object
必須
  • sourceType
Expand
プロパティー説明

address

string

アドレスは、OLM が既存のレジストリーに接続するために使用できるホストです。形式: <registry-host or ip>:<port> SourceType = SourceTypeGrpc の場合にのみ使用されます。イメージフィールドが設定されている場合は無視されます。

configMap

string

ConfigMap は、configmap-server レジストリーをバックアップするために使用される ConfigMap の名前です。SourceType=SourceTypeConfigmap または SourceTypeInternal の場合にのみ使用されます。

description

string

 

displayName

string

メタデータ

grpcPodConfig

object

GrpcPodConfig は、CatalogSource Pod の Pod 仕様のさまざまなオーバーライドを公開します。SourceType = SourceTypeGrpc かつ Image が設定されている場合にのみ使用されます。

icon

object

 

image

string

イメージは、レジストリーサーバーをインスタンス化するための Operator レジストリーコンテナーイメージです。SourceType=SourceTypeGrpc の場合にのみ使用されます。存在する場合、アドレスフィールドは無視されます。

priority

integer

優先度フィールドは、カタログソースに重みを割り当てて優先順位を付け、依存関係リゾルバーで使用できるようにします。使用法: 重みが大きいほど、依存関係の解決時に、重みが小さいカタログソースよりもこのカタログソースが優先されることを示します。優先度の値の範囲は、int32 の範囲で正から負になります。優先度が割り当てられていないカタログソースのデフォルト値は 0 です。同じ優先度の値を持つカタログソースは、その名前に基づいて辞書式にランク付けされます。

publisher

string

 

runAsRoot

boolean

RunAsRoot を使用すると、管理者は CatalogSource Pod を特権付き Pod で root として実行することを指定できます。これは、root 以外で実行できなかった古いカタログイメージを実行する場合にのみ有効にしてください。

secrets

array (string)

シークレットは、カタログのコンテンツにアクセスするために使用できるシークレットのセットを表します。カタログエントリーごとにそれぞれを試す必要があるため、このリストは小さくしておくことを推奨します。

sourceType

string

SourceType はソースのタイプです

updateStrategy

object

UpdateStrategy は、更新されたカタログソースイメージを検出する方法を定義します。ポーリング期間と埋め込まれた戦略タイプを定義する間隔で設定されます。

2.1.2. .spec.grpcPodConfig

説明
GrpcPodConfig は、CatalogSource Pod の Pod 仕様のさまざまなオーバーライドを公開します。SourceType = SourceTypeGrpc かつ Image が設定されている場合にのみ使用されます。
object
Expand
プロパティー説明

affinity

object

Affinity は、カタログソースの Pod のアフィニティーです。

extractContent

object

ExtractContent は、提供されたインデックスイメージからカタログメタデータを抽出し、既知のバージョンの opm サーバーを使用してそれを公開するように gRPC カタログ Pod を設定します。この機能を利用するには、この CatalogSource が使用するように設定されているカタログインデックスイメージで、ファイルベースのカタログが使用されている 必要があります

memoryTarget

integer-or-string

MemoryTarget は、gRPC カタログ Pod の $GOMEMLIMIT 値を設定します。これはサーバーのソフトメモリー制限です。ランタイムはこの制限を満たすよう試みますが、制限が必ず満たされるという保証はありません。この値が設定されている場合、Pod はサーバーを実行しているコンテナーに次の変更を加えます。- $GOMEMLIMIT 環境変数をこの値 (バイト単位) に設定する - メモリー要求をこの値に設定する

このフィールドは、カタログサーバーのフットプリントを可能な限り削減する場合、または提供されるカタログが非常に大きく、デフォルトの割り当てよりも多くのサイズが必要な場合に設定してください。インデックスイメージにファイルシステムキャッシュがある場合は、インデックスイメージの/tmp/cache/cache/packages.json にあるパッケージキャッシュのサイズを 2 倍にして、この値の近似値を決定してください。

このフィールドはベストエフォートです。設定されていないと、デフォルト値が使用されず、Pod メモリー制限も $GOMEMLIMIT 値も設定されません。

nodeSelector

object (string)

NodeSelector は、Pod がノードに収まるようにするために true である必要があるセレクターです。そのノードでスケジュールされる Pod のノードのラベルと一致する必要があるセレクター。

priorityClassName

string

指定した場合、Pod の優先度を示します。指定しない場合、Pod の優先度はデフォルトになり、デフォルトがない場合はゼロになります。

securityContextConfig

string

SecurityContextConfig は、legacy または restricted のいずれかになります。CatalogSource の Pod に、適切な pod.spec.securityContext 値と pod.spec.container[*].securityContext 値が注入され、Pod が Pod Security Admission (PSA) の restricted モードで実行できるようになります。これらの値がまったく設定されていない場合、Pod は PSA の baseline または privileged namespace でのみ実行できます。SecurityContextConfig が指定されていない場合、モードは namespace の PSA 設定によって決定されます。namespace が restricted モードを適用している場合、Pod は restricted が指定されている場合と同様に設定されます。そうでない場合、Pod は legacy が指定されている場合と同様に設定されます。legacy または restricted 以外の値を指定すると、検証エラーが発生します。restricted モードで実行できない古いカタログイメージを使用する場合は、SecurityContextConfig を legacy に設定する必要があります。

PSA の詳細は、https://kubernetes.io/docs/concepts/security/pod-security-admission/ を参照してください。

tolerations

array

toleration は、カタログソースの Pod の toleration です。

tolerations[]

object

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

2.1.3. .spec.grpcPodConfig.affinity

説明
Affinity は、カタログソースの Pod のアフィニティーです。
object
Expand
プロパティー説明

nodeAffinity

object

Pod のノードアフィニティースケジューリングルールを説明します。

podAffinity

object

Pod アフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置します)。

podAntiAffinity

object

Pod のアンチアフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置しないでください)。

2.1.4. .spec.grpcPodConfig.affinity.nodeAffinity

説明
Pod のノードアフィニティースケジューリングルールを説明します。
object
Expand
プロパティー説明

preferredDuringSchedulingIgnoredDuringExecution

array

スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードが対応する matchExpressions と一致する場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。

preferredDuringSchedulingIgnoredDuringExecution[]

object

空の優先スケジューリング用語は、暗黙の重み 0 を持つすべてのオブジェクトに一致します (つまり、操作なしです)。null の優先スケジューリング用語は、オブジェクトに一致しません (つまり、no-op でもあります)。

requiredDuringSchedulingIgnoredDuringExecution

object

このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (更新など)、システムは最終的に Pod をノードから退避しようとする場合としない場合があります。

2.1.5. .spec.grpcPodConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution

説明
スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードが対応する matchExpressions と一致する場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。
array

2.1.6. .spec.grpcPodConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

説明
空の優先スケジューリング用語は、暗黙の重み 0 を持つすべてのオブジェクトに一致します (つまり、操作なしです)。null の優先スケジューリング用語は、オブジェクトに一致しません (つまり、no-op でもあります)。
object
必須
  • preference
  • weight
Expand
プロパティー説明

preference

object

対応する重みに関連付けられたノードセレクター用語。

weight

integer

対応する nodeSelectorTerm の一致に関連する重み (1〜100 の範囲)。

2.1.7. .spec.grpcPodConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference

説明
対応する重みに関連付けられたノードセレクター用語。
object
Expand
プロパティー説明

matchExpressions

array

ノードのラベルごとのノードセレクター要件のリスト。

matchExpressions[]

object

ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchFields

array

ノードのフィールドごとのノードセレクター要件のリスト。

matchFields[]

object

ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

説明
ノードのラベルごとのノードセレクター要件のリスト。
array
説明
ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

セレクターが適用されるラベルキー。

operator

string

キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。

values

array (string)

文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

2.1.10. .spec.grpcPodConfig.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields

説明
ノードのフィールドごとのノードセレクター要件のリスト。
array
説明
ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

セレクターが適用されるラベルキー。

operator

string

キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。

values

array (string)

文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

2.1.12. .spec.grpcPodConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

説明
このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (更新など)、システムは最終的に Pod をノードから退避しようとする場合としない場合があります。
object
必須
  • nodeSelectorTerms
Expand
プロパティー説明

nodeSelectorTerms

array

必須。ノードセレクター用語のリスト。用語は OR されています。

nodeSelectorTerms[]

object

null または空のノードセレクター用語はオブジェクトに一致しません。これらの要件は AND で結合されます。TopologySelectorTerm タイプは、NodeSelectorTerm のサブセットを実装します。

2.1.13. .spec.grpcPodConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

説明
必須。ノードセレクター用語のリスト。用語は OR されています。
array

2.1.14. .spec.grpcPodConfig.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[]

説明
null または空のノードセレクター用語はオブジェクトに一致しません。これらの要件は AND で結合されます。TopologySelectorTerm タイプは、NodeSelectorTerm のサブセットを実装します。
object
Expand
プロパティー説明

matchExpressions

array

ノードのラベルごとのノードセレクター要件のリスト。

matchExpressions[]

object

ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchFields

array

ノードのフィールドごとのノードセレクター要件のリスト。

matchFields[]

object

ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

説明
ノードのラベルごとのノードセレクター要件のリスト。
array
説明
ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

セレクターが適用されるラベルキー。

operator

string

キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。

values

array (string)

文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

説明
ノードのフィールドごとのノードセレクター要件のリスト。
array
説明
ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

セレクターが適用されるラベルキー。

operator

string

キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。

values

array (string)

文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

2.1.19. .spec.grpcPodConfig.affinity.podAffinity

説明
Pod アフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置します)。
object
Expand
プロパティー説明

preferredDuringSchedulingIgnoredDuringExecution

array

スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードに対応する podAffinityTerm に一致する Pod がある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。

preferredDuringSchedulingIgnoredDuringExecution[]

object

一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。

requiredDuringSchedulingIgnoredDuringExecution

array

このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから退避しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。

requiredDuringSchedulingIgnoredDuringExecution[]

object

この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。

2.1.20. .spec.grpcPodConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution

説明
スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードに対応する podAffinityTerm に一致する Pod がある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。
array

2.1.21. .spec.grpcPodConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

説明
一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。
object
必須
  • podAffinityTerm
  • weight
Expand
プロパティー説明

podAffinityTerm

object

必須。対応する重みに関連付けられた Pod アフィニティー用語。

weight

integer

対応する podAffinityTerm の一致に関連する重み (1〜100 の範囲)。

2.1.22. .spec.grpcPodConfig.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm

説明
必須。対応する重みに関連付けられた Pod アフィニティー用語。
object
必須
  • topologyKey
Expand
プロパティー説明

labelSelector

object

リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。

matchLabelKeys

array (string)

MatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは key in (value) として labelSelector にマージされ、着信 Pod の Pod アフィニティー (アンチアフィニティー) として考慮される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。デフォルト値は空です。matchLabelKeys と labelSelector の両方に同じキーが存在することは禁止されています。また、labelSelector が設定されていない場合、matchLabelKeys は設定できません。

mismatchLabelKeys

array (string)

MismatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは key notin (value) として labelSelector にマージされ、着信 Pod の Pod アフィニティー (アンチアフィニティー) として考慮される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。デフォルト値は空です。mismatchLabelKeys と labelSelector の両方に同じキーが存在することは禁止されています。また、labelSelector が設定されていない場合、mismatchLabelKeys は設定できません。

namespaceSelector

object

用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。

namespaces

array (string)

namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび null namespaceSelector は、"この Pod の namespace" を意味します

topologyKey

string

この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。

説明
リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

説明
用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

2.1.29. .spec.grpcPodConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution

説明
このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから退避しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。
array

2.1.30. .spec.grpcPodConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[]

説明
この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。
object
必須
  • topologyKey
Expand
プロパティー説明

labelSelector

object

リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。

matchLabelKeys

array (string)

MatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは key in (value) として labelSelector にマージされ、着信 Pod の Pod アフィニティー (アンチアフィニティー) として考慮される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。デフォルト値は空です。matchLabelKeys と labelSelector の両方に同じキーが存在することは禁止されています。また、labelSelector が設定されていない場合、matchLabelKeys は設定できません。

mismatchLabelKeys

array (string)

MismatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは key notin (value) として labelSelector にマージされ、着信 Pod の Pod アフィニティー (アンチアフィニティー) として考慮される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。デフォルト値は空です。mismatchLabelKeys と labelSelector の両方に同じキーが存在することは禁止されています。また、labelSelector が設定されていない場合、mismatchLabelKeys は設定できません。

namespaceSelector

object

用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。

namespaces

array (string)

namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび null namespaceSelector は、"この Pod の namespace" を意味します

topologyKey

string

この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。

2.1.31. .spec.grpcPodConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector

説明
リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

2.1.34. .spec.grpcPodConfig.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector

説明
用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

2.1.37. .spec.grpcPodConfig.affinity.podAntiAffinity

説明
Pod のアンチアフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置しないでください)。
object
Expand
プロパティー説明

preferredDuringSchedulingIgnoredDuringExecution

array

スケジューラーは、このフィールドで指定されたアンチアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アンチアフィニティー式など) を満たすノードごとに、の要素を反復処理して合計を計算します。このフィールドと、対応する podAffinityTerm に一致する Pod がノードにある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。

preferredDuringSchedulingIgnoredDuringExecution[]

object

一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。

requiredDuringSchedulingIgnoredDuringExecution

array

このフィールドで指定されたアンチアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアンチアフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから退避しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。

requiredDuringSchedulingIgnoredDuringExecution[]

object

この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。

2.1.38. .spec.grpcPodConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution

説明
スケジューラーは、このフィールドで指定されたアンチアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アンチアフィニティー式など) を満たすノードごとに、の要素を反復処理して合計を計算します。このフィールドと、対応する podAffinityTerm に一致する Pod がノードにある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。
array

2.1.39. .spec.grpcPodConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

説明
一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。
object
必須
  • podAffinityTerm
  • weight
Expand
プロパティー説明

podAffinityTerm

object

必須。対応する重みに関連付けられた Pod アフィニティー用語。

weight

integer

対応する podAffinityTerm の一致に関連する重み (1〜100 の範囲)。

2.1.40. .spec.grpcPodConfig.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm

説明
必須。対応する重みに関連付けられた Pod アフィニティー用語。
object
必須
  • topologyKey
Expand
プロパティー説明

labelSelector

object

リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。

matchLabelKeys

array (string)

MatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは key in (value) として labelSelector にマージされ、着信 Pod の Pod アフィニティー (アンチアフィニティー) として考慮される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。デフォルト値は空です。matchLabelKeys と labelSelector の両方に同じキーが存在することは禁止されています。また、labelSelector が設定されていない場合、matchLabelKeys は設定できません。

mismatchLabelKeys

array (string)

MismatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは key notin (value) として labelSelector にマージされ、着信 Pod の Pod アフィニティー (アンチアフィニティー) として考慮される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。デフォルト値は空です。mismatchLabelKeys と labelSelector の両方に同じキーが存在することは禁止されています。また、labelSelector が設定されていない場合、mismatchLabelKeys は設定できません。

namespaceSelector

object

用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。

namespaces

array (string)

namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび null namespaceSelector は、"この Pod の namespace" を意味します

topologyKey

string

この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。

説明
リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

説明
用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

2.1.47. .spec.grpcPodConfig.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution

説明
このフィールドで指定されたアンチアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアンチアフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから退避しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。
array

2.1.48. .spec.grpcPodConfig.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[]

説明
この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。
object
必須
  • topologyKey
Expand
プロパティー説明

labelSelector

object

リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。

matchLabelKeys

array (string)

MatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは key in (value) として labelSelector にマージされ、着信 Pod の Pod アフィニティー (アンチアフィニティー) として考慮される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。デフォルト値は空です。matchLabelKeys と labelSelector の両方に同じキーが存在することは禁止されています。また、labelSelector が設定されていない場合、matchLabelKeys は設定できません。

mismatchLabelKeys

array (string)

MismatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは key notin (value) として labelSelector にマージされ、着信 Pod の Pod アフィニティー (アンチアフィニティー) として考慮される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。デフォルト値は空です。mismatchLabelKeys と labelSelector の両方に同じキーが存在することは禁止されています。また、labelSelector が設定されていない場合、mismatchLabelKeys は設定できません。

namespaceSelector

object

用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。

namespaces

array (string)

namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび null namespaceSelector は、"この Pod の namespace" を意味します

topologyKey

string

この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。

2.1.49. .spec.grpcPodConfig.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector

説明
リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

2.1.52. .spec.grpcPodConfig.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector

説明
用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

2.1.55. .spec.grpcPodConfig.extractContent

説明
ExtractContent は、提供されたインデックスイメージからカタログメタデータを抽出し、既知のバージョンの opm サーバーを使用してそれを公開するように gRPC カタログ Pod を設定します。この機能を利用するには、この CatalogSource が使用するように設定されているカタログインデックスイメージで、ファイルベースのカタログが使用されている 必要があります
object
必須
  • catalogDir
Expand
プロパティー説明

cacheDir

string

CacheDir は、事前に計算された API キャッシュを保存するディレクトリー (オプション) です。

catalogDir

string

CatalogDir は、ファイルベースのカタログコンテンツを格納するディレクトリーです。

2.1.56. .spec.grpcPodConfig.tolerations

説明
toleration は、カタログソースの Pod の toleration です。
array

2.1.57. .spec.grpcPodConfig.tolerations[]

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

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 以外の場合このフィールドは無視されます) が taint を許容する期間を表します。デフォルトでは設定されていません。つまり、テイントを永久に許容します (退避しないでください)。ゼロ値と負の値は、システムによって 0 (すぐに退避) として扱われます。

value

string

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

2.1.58. .spec.icon

説明
object
必須
  • base64data
  • mediatype
Expand
プロパティー説明

base64data

string

 

mediatype

string

 

2.1.59. .spec.updateStrategy

説明
UpdateStrategy は、更新されたカタログソースイメージを検出する方法を定義します。ポーリング期間と埋め込まれた戦略タイプを定義する間隔で設定されます。
object
Expand
プロパティー説明

registryPoll

object

 

2.1.60. .spec.updateStrategy.registryPoll

説明
object
Expand
プロパティー説明

interval

string

間隔は、最新のカタログソースバージョンのチェック間の時間間隔を決定するために使用されます。カタログ Operator は、カタログソースの新しいバージョンが利用可能かどうかを確認するためにポーリングします。利用可能な場合、最新のイメージがプルされ、gRPC トラフィックは最新のカタログソースに転送されます。

2.1.61. .status

説明
object
Expand
プロパティー説明

conditions

array

CatalogSource の状態を表します。メッセージと理由は元のステータス情報を表し、将来的に条件に基づいて移行される可能性があることに注意してください。導入された新機能はすべて条件を使用します。

conditions[]

object

condition には、この API Resource の現在の状態のある側面の詳細が含まれます。

configMapReference

object

ConfigMapReference (非推奨) は、カタログソースが ConfigMap である場合、カタログソースの設定を含む ConfigMap への参照です。

connectionState

object

ConnectionState は、CatalogSource からレジストリーに対する現在の接続の状態を表します。

latestImageRegistryPoll

string

イメージが最新であることを確認するために CatalogSource イメージレジストリーが最後にポーリングされたとき

message

string

CatalogSource がこの状態にある理由の詳細を示す人間が読めるメッセージ。

reason

string

理由は、CatalogSource が現在の状態に移行した理由です。

registryService

object

RegistryService は、カタログを提供するために使用される GRPC サービスの現在の状態を表します。

2.1.62. .status.conditions

説明
CatalogSource の状態を表します。メッセージと理由は元のステータス情報を表し、将来的に条件に基づいて移行される可能性があることに注意してください。導入された新機能はすべて条件を使用します。
array

2.1.63. .status.conditions[]

説明
condition には、この API Resource の現在の状態のある側面の詳細が含まれます。
object
必須
  • lastTransitionTime
  • message
  • reason
  • status
  • type
Expand
プロパティー説明

lastTransitionTime

string

lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。

message

string

message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。

observedGeneration

integer

observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。

reason

string

reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。

status

string

条件のステータス、True、False、Unknown のいずれか。

type

string

CamelCase または foo.example.com/CamelCase の条件のタイプ。

2.1.64. .status.configMapReference

説明
ConfigMapReference (非推奨) は、カタログソースが ConfigMap である場合、カタログソースの設定を含む ConfigMap への参照です。
object
必須
  • name
  • namespace
Expand
プロパティー説明

lastUpdateTime

string

 

name

string

 

namespace

string

 

resourceVersion

string

 

uid

string

UID は、UUID を含む一意の ID 値を保持するタイプです。UUID のみを使用するわけではないため、これは文字列のエイリアスです。タイプであることは意図を捉え、UID と名前が混同されないようにするのに役立ちます。

2.1.65. .status.connectionState

説明
ConnectionState は、CatalogSource からレジストリーに対する現在の接続の状態を表します。
object
必須
  • lastObservedState
Expand
プロパティー説明

address

string

 

lastConnect

string

 

lastObservedState

string

 

2.1.66. .status.registryService

説明
RegistryService は、カタログを提供するために使用される GRPC サービスの現在の状態を表します。
object
Expand
プロパティー説明

createdAt

string

 

port

string

 

protocol

string

 

serviceName

string

 

serviceNamespace

string

 

2.2. API エンドポイント

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

  • /apis/operators.coreos.com/v1alpha1/catalogsources

    • GET: kind が CatalogSource のオブジェクトをリスト表示します。
  • /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/catalogsources

    • DELETE: CatalogSource のコレクションを削除します。
    • GET: kind が CatalogSource のオブジェクトをリスト表示します。
    • POST:CatalogSource を作成します
  • /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/catalogsources/{name}

    • DELETE: CatalogSource を削除します。
    • GET: 指定された CatalogSource を読み取ります
    • PATCH: 指定された CatalogSource を部分的に更新します
    • PUT: 指定された CatalogSource を置き換えます
  • /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/catalogsources/{name}/status

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

2.2.1. /apis/operators.coreos.com/v1alpha1/catalogsources

HTTP メソッド
GET
説明
kind が CatalogSource のオブジェクトをリスト表示します。
Expand
表2.1 HTTP 応答
HTTP コード応答のボディー

200 - OK

CatalogSourceList スキーマ

401 - Unauthorized

空白

2.2.2. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/catalogsources

HTTP メソッド
DELETE
説明
CatalogSource のコレクションを削除します
Expand
表2.2 HTTP 応答
HTTP コード応答のボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
kind が CatalogSource のオブジェクトをリスト表示します。
Expand
表2.3 HTTP 応答
HTTP コード応答のボディー

200 - OK

CatalogSourceList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
CatalogSource を作成します。
Expand
表2.4 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表2.5 本文パラメーター
パラメーター説明

body

CatalogSource スキーマ

 
Expand
表2.6 HTTP 応答
HTTP コード応答のボディー

200 - OK

CatalogSource スキーマ

201 - Created

CatalogSource スキーマ

202 - Accepted

CatalogSource スキーマ

401 - Unauthorized

空白

2.2.3. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/catalogsources/{name}

Expand
表2.7 グローバルパスパラメーター
パラメーター説明

name

string

CatalogSource の名前

HTTP メソッド
DELETE
説明
CatalogSource を削除します
Expand
表2.8 クエリーパラメーター
パラメーター説明

dryRun

string

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

Expand
表2.9 HTTP 応答
HTTP コード応答のボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された CatalogSource を読み取ります
Expand
表2.10 HTTP 応答
HTTP コード応答のボディー

200 - OK

CatalogSource スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

Expand
表2.12 HTTP 応答
HTTP コード応答のボディー

200 - OK

CatalogSource スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された CatalogSource を置き換えます
Expand
表2.13 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表2.14 本文パラメーター
パラメーター説明

body

CatalogSource スキーマ

 
Expand
表2.15 HTTP 応答
HTTP コード応答のボディー

200 - OK

CatalogSource スキーマ

201 - Created

CatalogSource スキーマ

401 - Unauthorized

空白

2.2.4. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/catalogsources/{name}/status

Expand
表2.16 グローバルパスパラメーター
パラメーター説明

name

string

CatalogSource の名前

HTTP メソッド
GET
説明
指定された CatalogSource のステータスを読み取ります
Expand
表2.17 HTTP 応答
HTTP コード応答のボディー

200 - OK

CatalogSource スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

Expand
表2.19 HTTP 応答
HTTP コード応答のボディー

200 - OK

CatalogSource スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

Expand
表2.21 本文パラメーター
パラメーター説明

body

CatalogSource スキーマ

 
Expand
表2.22 HTTP 応答
HTTP コード応答のボディー

200 - OK

CatalogSource スキーマ

201 - Created

CatalogSource スキーマ

401 - Unauthorized

空白

第3章 ClusterCatalog [olm.operatorframework.io/v1]

説明
ClusterCatalog を使用すると、ユーザーはファイルベースカタログ (FBC) カタログデータをクラスターで使用できるようになります。FBC の詳細は、https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs を参照してください。
object
必須
  • metadata
  • spec

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

spec は ClusterCatalog の望ましい状態です。spec は必須です。コントローラーは、必要なカタログが展開され、カタログコンテンツ HTTP サーバー経由で提供されるようにします。

status

object

status には、ClusterCatalog の状態に関する情報が含まれます。たとえば、カタログコンテンツがカタログコンテンツ HTTP サーバー経由で提供されているかどうか、ClusterCatalog が新しい状態に進んでいるかどうか、カタログコンテンツが取得されたソースへの参照などです。

3.1.1. .spec

説明
spec は ClusterCatalog の望ましい状態です。spec は必須です。コントローラーは、必要なカタログが展開され、カタログコンテンツ HTTP サーバー経由で提供されるようにします。
object
必須
  • source
Expand
プロパティー説明

availabilityMode

string

availabilityMode を使用すると、ユーザーは ClusterCatalog をクラスター上のクライアントがどのように利用できるようにするかを定義できます。availabilityMode はオプションです。

許可される値は "Available"、"Unavailable"、または省略できます。

省略した場合、デフォルト値は "Available" です。

"Available" に設定すると、カタログコンテンツが展開され、カタログコンテンツ HTTP サーバー経由で提供されます。availabilityMode を "Available" に設定すると、クライアントはこの ClusterCatalog とそのコンテンツを使用可能と見なすように指示されます。

"Unavailable" に設定すると、カタログコンテンツはカタログコンテンツ HTTP サーバー経由で提供されなくなります。この availabilityMode に設定されている場合は、ClusterCatalog が存在しない場合と同じように解釈する必要があります。availabilityMode を "Unavailable" に設定すると、ユーザーが ClusterCatalog を完全に削除したくないが、存在しないものとして扱いたい場合に役立ちます。

priority

integer

priority を使用すると、ユーザーは ClusterCatalog の優先度を定義できます。priority はオプションです。

ClusterCatalog の優先度は、クライアントの要件を満たす ClusterCatalog 間で、競合を解消する決定要因 (tie-breaker) としてクライアントによって使用されます。数値が大きいほど優先度が高くなります。

同じ優先度を持つ複数の ClusterCatalog が要件を満たすシナリオをどのように処理するかは、クライアントが決定します。このシナリオで、競合を解消する方法を決定する際は、クライアントがユーザーに追加の入力を促すことが推奨されます。

省略した場合、デフォルトの優先度は 0 になります。これは整数のゼロ値であるためです。

負の数を使用すると、デフォルトよりも低い優先度を指定できます。正の数を使用すると、デフォルトよりも高い優先度を指定できます。

可能な最小値は -2147483648 です。可能な最大値は 2147483647 です。

source

object

source を使用すると、ユーザーはカタログのソースを定義できます。"catalog" には、クラスターにインストールできるコンテンツに関する情報が含まれています。カタログソースを提供すると、カタログの内容が他のクラスター上のコンポーネントによって検出および使用できるようになります。これらのクラスター上のコンポーネントは、GUI ダッシュボードにコンテンツを表示したり、カタログからクラスターにコンテンツをインストールしたりするなど、この情報を使用してさまざまな処理を実行できます。カタログソースには、ファイルベースカタログ (FBC) 形式のカタログメタデータが含まれている必要があります。FBC の詳細は、https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs を参照してください。source は必須フィールドです。

以下は、イメージからカタログを取得する ClusterCatalogSpec の最小限の例です。

source: type: Image image: ref: quay.io/operatorhubio/catalog:latest

3.1.2. .spec.source

説明

source を使用すると、ユーザーはカタログのソースを定義できます。"catalog" には、クラスターにインストールできるコンテンツに関する情報が含まれています。カタログソースを提供すると、カタログの内容が他のクラスター上のコンポーネントによって検出および使用できるようになります。これらのクラスター上のコンポーネントは、GUI ダッシュボードにコンテンツを表示したり、カタログからクラスターにコンテンツをインストールしたりするなど、この情報を使用してさまざまな処理を実行できます。カタログソースには、ファイルベースカタログ (FBC) 形式のカタログメタデータが含まれている必要があります。FBC の詳細は、https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs を参照してください。source は必須フィールドです。

以下は、イメージからカタログを取得する ClusterCatalogSpec の最小限の例です。

source:
  type: Image
  image:
    ref: quay.io/operatorhubio/catalog:latest
Copy to Clipboard Toggle word wrap
object
必須
  • type
Expand
プロパティー説明

image

object

image は、カタログコンテンツが OCI イメージから取得される方法を設定するために使用されます。このフィールドは、タイプが Image の場合は必須であり、それ以外の場合は禁止されます。

type

string

type は、カタログの提供元のソースのタイプへの参照です。type は必須です。

許可される値は "Image" のみです。

"Image" に設定すると、ClusterCatalog コンテンツは OCI イメージから取得されます。イメージソースを使用する場合は、イメージフィールドを設定する必要があり、このタイプに対して定義されている唯一のフィールドである必要があります。

3.1.3. .spec.source.image

説明
image は、カタログコンテンツが OCI イメージから取得される方法を設定するために使用されます。このフィールドは、タイプが Image の場合は必須であり、それ以外の場合は禁止されます。
object
必須
  • ref
Expand
プロパティー説明

pollIntervalMinutes

integer

pollIntervalMinutes を使用すると、ユーザーはイメージソースが新しいコンテンツに対してポーリングする間隔を分単位で設定できます。pollIntervalMinutes はオプションです。ref がダイジェストベースの参照である場合は、pollIntervalMinutes を指定できません。

省略すると、イメージは新しいコンテンツに対してポーリングされません。

ref

string

ref を使用すると、ユーザーは Catalog コンテンツを含むコンテナーイメージへの参照を定義できます。ref は必須です。ref は 1000 文字を超えることはできません。

参照は、ドメイン、名前、識別子の 3 つの部分に分けられます。

ドメインは通常、イメージが配置されているレジストリーです。"." 文字で区切られた英数字 (小文字と大文字) である必要があります。ハイフンの使用は許可されますが、ドメインの最初と最後は英数字である必要があります。使用するポートを指定するには、":" 文字の後に数値を追加することもできます。ポートはドメイン内の最後の値である必要があります。有効なドメイン値の例として、"registry.mydomain.io"、"quay.io"、"my-registry.io:8080" などがあります。

名前は通常、イメージが配置されているレジストリー内のリポジトリーです。"."、"_"、"\__"、"-" 文字のみで区切られた小文字の英数字を含める必要があります。複数の名前は、"/" 文字を使用して連結できます。ドメインと名前は、"/" 文字を使用して結合されます。有効な名前の値の例として、"operatorhubio/catalog"、"catalog"、"my-catalog.prod" などがあります。参照のドメイン部分と名前部分が結合された例として、"quay.io/operatorhubio/catalog" があります。

識別子は通常、イメージ参照のタグまたはダイジェストであり、参照の最後に存在します。名前の終わりと識別子の始まりを区別するために使用される区切り文字で始まります。ダイジェストベースの参照の場合は、"@" 文字が区切り文字になります。タグベースの参照の場合、":" 文字が区切り文字になります。参照には識別子が必要です。

ダイジェストベースの参照には、"@" で区切った直後にアルゴリズム参照が含まれている必要があります。アルゴリズム参照の後には、":" 文字とエンコードされた文字列が続く必要があります。アルゴリズムは、大文字または小文字の英字で始まり、その後に英数字が続く必要があり、"-"、"_"、"+"、"." の文字を含めることができます。有効なアルゴリズム値の例として、"sha256"、"sha256+b64u"、"multihash+base58" などがあります。アルゴリズムに続くエンコードされた文字列は 16 進数 (a-f、A-F、0-9) で、最低 32 文字である必要があります。

タグベースの参照は、単語文字 (英数字 + "\_") で始まり、その後に単語文字または "."、および "-" 文字が続く必要があります。タグは 127 文字以下である必要があります。

有効なダイジェストベースのイメージ参照の例として、"quay.io/operatorhubio/catalog@sha256:200d4ddb2a73594b91358fe6397424e975205bfbe44614f5846033cad64b3f05" があります。有効なタグベースのイメージ参照の例として、"quay.io/operatorhubio/catalog:latest" があります。

3.1.4. .status

説明
status には、ClusterCatalog の状態に関する情報が含まれます。たとえば、カタログコンテンツがカタログコンテンツ HTTP サーバー経由で提供されているかどうか、ClusterCatalog が新しい状態に進んでいるかどうか、カタログコンテンツが取得されたソースへの参照などです。
object
Expand
プロパティー説明

conditions

array

conditions は、この ClusterCatalog の現在の状態を表します。

現在の状態タイプは、Serving と Progressing です。

Serving 状態は、カタログのコンテンツが HTTP(S) Web サーバー経由で提供されているかどうかを表すために使用されます。ステータスが True で理由が Available の場合、カタログのコンテンツは提供されています。ステータスが False で理由が Unavailable の場合、カタログのコンテンツはまだ利用できないため、提供されていません。ステータスが False で理由が UserSpecifiedUnavailable の場合、カタログは意図的に利用不可とマークされているため、カタログのコンテンツは提供されません。

Progressing 状態は、ClusterCatalog が進行中であるか、または新しい状態へ移行する準備が整っているかどうかを示します。ステータスが True で理由が Retrying の場合、ClusterCatalog の処理中にエラーが発生したものの、後続の調整試行によって解決される可能性があることを意味します。ステータスが True で理由が Succeeded の場合、ClusterCatalog は新しい状態に正常に進み、続行する準備ができています。ステータスが False で理由が Blocked の場合、ClusterCatalog の進行にエラーが発生したため、回復には手動による介入が必要です。

Serving 状態が True で理由が Available であり、Progressing 状態が True で理由が Retrying である場合、新しいバージョンのカタログコンテンツの提供を進めている間も、以前に取得されたカタログコンテンツは HTTP(S) Web サーバー経由で引き続き提供されます。これは、最初にこのカタログのソースから最新のコンテンツを取得し、コンテンツの変更をポーリングしたときに、コンテンツに更新があることが確認された場合に発生する可能性があります。

conditions[]

object

condition には、この API Resource の現在の状態のある側面の詳細が含まれます。

lastUnpacked

string

lastUnpacked は、カタログの内容がソース形式から最後に抽出された時刻を表します。たとえば、イメージソースを使用する場合、OCI イメージがプルされ、イメージレイヤーがファイルシステムにバックアップされたキャッシュに書き込まれます。ソース形式からこの抽出を行う行為を "unpacking" と呼びます。

resolvedSource

object

resolvedSource には、ソースタイプに基づいて解決されたソースに関する情報が含まれます。

urls

object

urls には、カタログにアクセスするために使用できる URL が含まれています。

3.1.5. .status.conditions

説明

conditions は、この ClusterCatalog の現在の状態を表します。

現在の状態タイプは、Serving と Progressing です。

Serving 状態は、カタログのコンテンツが HTTP(S) Web サーバー経由で提供されているかどうかを表すために使用されます。ステータスが True で理由が Available の場合、カタログのコンテンツは提供されています。ステータスが False で理由が Unavailable の場合、カタログのコンテンツはまだ利用できないため、提供されていません。ステータスが False で理由が UserSpecifiedUnavailable の場合、カタログは意図的に利用不可とマークされているため、カタログのコンテンツは提供されません。

Progressing 状態は、ClusterCatalog が進行中であるか、または新しい状態へ移行する準備が整っているかどうかを示します。ステータスが True で理由が Retrying の場合、ClusterCatalog の処理中にエラーが発生したものの、後続の調整試行によって解決される可能性があることを意味します。ステータスが True で理由が Succeeded の場合、ClusterCatalog は新しい状態に正常に進み、続行する準備ができています。ステータスが False で理由が Blocked の場合、ClusterCatalog の進行にエラーが発生したため、回復には手動による介入が必要です。

Serving 状態が True で理由が Available であり、Progressing 状態が True で理由が Retrying である場合、新しいバージョンのカタログコンテンツの提供を進めている間も、以前に取得されたカタログコンテンツは HTTP(S) Web サーバー経由で引き続き提供されます。これは、最初にこのカタログのソースから最新のコンテンツを取得し、コンテンツの変更をポーリングしたときに、コンテンツに更新があることが確認された場合に発生する可能性があります。

array

3.1.6. .status.conditions[]

説明
condition には、この API Resource の現在の状態のある側面の詳細が含まれます。
object
必須
  • lastTransitionTime
  • message
  • reason
  • status
  • type
Expand
プロパティー説明

lastTransitionTime

string

lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。

message

string

message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。

observedGeneration

integer

observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。

reason

string

reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。

status

string

条件のステータス、True、False、Unknown のいずれか。

type

string

CamelCase または foo.example.com/CamelCase の条件のタイプ。

3.1.7. .status.resolvedSource

説明
resolvedSource には、ソースタイプに基づいて解決されたソースに関する情報が含まれます。
object
必須
  • image
  • type
Expand
プロパティー説明

image

object

image は、イメージから取得されたカタログの解像度情報を格納するフィールドです。タイプが Image の場合、このフィールドを設定する必要があり、それ以外の場合は禁止されます。

type

string

type は、カタログの提供元のソースのタイプへの参照です。type は必須です。

許可される値は "Image" のみです。

"Image" に設定すると、解決されたイメージソースに関する情報が 'image' フィールドに設定されます。

3.1.8. .status.resolvedSource.image

説明
image は、イメージから取得されたカタログの解像度情報を格納するフィールドです。タイプが Image の場合、このフィールドを設定する必要があり、それ以外の場合は禁止されます。
object
必須
  • ref
Expand
プロパティー説明

ref

string

ref には、解決されたイメージダイジェストベースの参照が含まれます。ダイジェスト形式を使用すると、ユーザーは他のツールを使用して、カタログの内容を抽出するために使用されたものとまったく同じな OCI マニフェストを取得できます。

3.1.9. .status.urls

説明
urls には、カタログにアクセスするために使用できる URL が含まれています。
object
必須
  • base
Expand
プロパティー説明

base

string

base は、カタログのコンテンツにアクセスするためのエンドポイントを提供するクラスター内部 URL です。

クライアントが、アクセスしたいエンドポイントのパスを追加することが期待されます。

現在、単一のエンドポイントのみが提供されており、パス /api/v1 でアクセスできます。

v1 API で提供されるエンドポイントは /all で、このエンドポイントはカタログコンテンツ全体を FBC 形式で返します。

ユーザーとクライアントのニーズが進化するにつれて、新しいエンドポイントが追加される可能性があります。

3.2. API エンドポイント

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

  • /apis/olm.operatorframework.io/v1/clustercatalogs

    • DELETE: ClusterCatalog のコレクションを削除します。
    • GET: 種類が ClusterCatalog のオブジェクトをリスト表示します。
    • POST: ClusterCatalog を作成します。
  • /apis/olm.operatorframework.io/v1/clustercatalogs/{name}

    • DELETE: ClusterCatalog を削除します。
    • GET: 指定された ClusterCatalog を読み取ります。
    • PATCH: 指定された ClusterCatalog を部分的に更新します。
    • PUT: 指定された ClusterCatalog を置き換えます。
  • /apis/olm.operatorframework.io/v1/clustercatalogs/{name}/status

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

3.2.1. /apis/olm.operatorframework.io/v1/clustercatalogs

HTTP メソッド
DELETE
説明
ClusterCatalog のコレクションを削除します。
Expand
表3.1 HTTP 応答
HTTP コード応答のボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
種類が ClusterCatalog のオブジェクトをリスト表示します。
Expand
表3.2 HTTP 応答
HTTP コード応答のボディー

200 - OK

ClusterCatalogList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
ClusterCatalog を作成します。
Expand
表3.3 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表3.4 本文パラメーター
パラメーター説明

body

ClusterCatalog スキーマ

 
Expand
表3.5 HTTP 応答
HTTP コード応答のボディー

200 - OK

ClusterCatalog スキーマ

201 - Created

ClusterCatalog スキーマ

202 - Accepted

ClusterCatalog スキーマ

401 - Unauthorized

空白

3.2.2. /apis/olm.operatorframework.io/v1/clustercatalogs/{name}

Expand
表3.6 グローバルパスパラメーター
パラメーター説明

name

string

ClusterCatalog の名前です。

HTTP メソッド
DELETE
説明
ClusterCatalog を削除します。
Expand
表3.7 クエリーパラメーター
パラメーター説明

dryRun

string

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

Expand
表3.8 HTTP 応答
HTTP コード応答のボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された ClusterCatalog を読み取ります。
Expand
表3.9 HTTP 応答
HTTP コード応答のボディー

200 - OK

ClusterCatalog スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された ClusterCatalog を部分的に更新します。
Expand
表3.10 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表3.11 HTTP 応答
HTTP コード応答のボディー

200 - OK

ClusterCatalog スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された ClusterCatalog を置き換えます。
Expand
表3.12 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表3.13 本文パラメーター
パラメーター説明

body

ClusterCatalog スキーマ

 
Expand
表3.14 HTTP 応答
HTTP コード応答のボディー

200 - OK

ClusterCatalog スキーマ

201 - Created

ClusterCatalog スキーマ

401 - Unauthorized

空白

3.2.3. /apis/olm.operatorframework.io/v1/clustercatalogs/{name}/status

Expand
表3.15 グローバルパスパラメーター
パラメーター説明

name

string

ClusterCatalog の名前です。

HTTP メソッド
GET
説明
指定された ClusterCatalog のステータスを読み取ります。
Expand
表3.16 HTTP 応答
HTTP コード応答のボディー

200 - OK

ClusterCatalog スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された ClusterCatalog のステータスを部分的に更新します。
Expand
表3.17 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表3.18 HTTP 応答
HTTP コード応答のボディー

200 - OK

ClusterCatalog スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された ClusterCatalog のステータスを置き換えます。
Expand
表3.19 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表3.20 本文パラメーター
パラメーター説明

body

ClusterCatalog スキーマ

 
Expand
表3.21 HTTP 応答
HTTP コード応答のボディー

200 - OK

ClusterCatalog スキーマ

201 - Created

ClusterCatalog スキーマ

401 - Unauthorized

空白

第4章 ClusterExtension [olm.operatorframework.io/v1]

説明
ClusterExtension は clusterextensions API のスキーマです。
object

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

標準オブジェクトのメタデータ。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

spec は、ClusterExtension の望ましい状態を定義するオプションフィールドです。

status

object

status は、ClusterExtension の監視状態を定義するオプションフィールドです。

4.1.1. .spec

説明
spec は、ClusterExtension の望ましい状態を定義するオプションフィールドです。
object
必須
  • namespace
  • serviceAccount
  • source
Expand
プロパティー説明

install

object

install は、プリフライトチェック設定などの ClusterExtension のインストールオプションを設定するために使用されるオプションフィールドです。

namespace

string

namespace は Kubernetes namespace への参照です。これは、提供された ServiceAccount が存在する必要がある namespace です。また、拡張機能の namespace スコープのリソースがクラスターに適用されるデフォルトの namespace も指定します。一部の拡張機能には、他の namespace に適用される namespace スコープのリソースが含まれている場合があります。この namespace は存在している必要があります。

namespace は必須かつ変更不可能で、[RFC 1123] で定義されている DNS ラベル標準に従います。小文字の英数字またはハイフン (-) のみを含み、先頭と末尾は英数字で、63 文字以内である必要があります。

[RFC 1123]: https://tools.ietf.org/html/rfc1123

serviceAccount

object

serviceAccount は、拡張機能の管理に必要なクラスターとのすべてのやり取りを実行するために使用される ServiceAccount への参照です。これらのやり取りを実行するには、ServiceAccount に必要なパーミッションを設定する必要があります。ServiceAccount は、spec で参照される namespace に存在する必要があります。serviceAccount は必須です。

source

object

source は必須フィールドで、この ClusterExtension のコンテンツのインストールソースを選択します。選択は、sourceType を設定することによって実行されます。

現在実装されている sourceType は Catalog のみであり、sourcetype を "Catalog" に設定するには、catalog フィールドも定義する必要があります。

以下は、source 定義の最小限の例 (yaml 形式) です。

source: sourceType: Catalog catalog: packageName: example-package

4.1.2. .spec.install

説明
install は、プリフライトチェック設定などの ClusterExtension のインストールオプションを設定するために使用されるオプションフィールドです。
object
Expand
プロパティー説明

preflight

object

preflight は、packageName フィールドで指定されたパッケージのコンテンツをインストールまたはアップグレードする前に実行されるチェックを設定するために使用できるオプションフィールドです。

指定すると、インストール/アップグレードアクションのデフォルトの preflight 設定が置き換えられます。指定しない場合は、デフォルトの設定が使用されます。

4.1.3. .spec.install.preflight

説明

preflight は、packageName フィールドで指定されたパッケージのコンテンツをインストールまたはアップグレードする前に実行されるチェックを設定するために使用できるオプションフィールドです。

指定すると、インストール/アップグレードアクションのデフォルトの preflight 設定が置き換えられます。指定しない場合は、デフォルトの設定が使用されます。

object
必須
  • crdUpgradeSafety
Expand
プロパティー説明

crdUpgradeSafety

object

crdUpgradeSafety は、インストールされたコンテンツのアップグレード前に実行される CRD Upgrade Safety のプリフライトチェックを設定するために使用されます。

CRD Upgrade Safety のプリフライトチェックは、データ損失など、CRD をアップグレードする際に意図しない結果が生じることから保護するためのものです。

4.1.4. .spec.install.preflight.crdUpgradeSafety

説明

crdUpgradeSafety は、インストールされたコンテンツのアップグレード前に実行される CRD Upgrade Safety のプリフライトチェックを設定するために使用されます。

CRD Upgrade Safety のプリフライトチェックは、データ損失など、CRD をアップグレードする際に意図しない結果が生じることから保護するためのものです。

object
必須
  • enforcement
Expand
プロパティー説明

enforcement

string

enforcement は必須フィールドであり、CRD Upgrade Safety のプリフライトチェックの状態を設定するために使用されます。

許可される値は "None" または "Strict" です。デフォルト値は "Strict" です。

"None" に設定すると、アップグレード操作の実行時に CRD Upgrade Safety のプリフライトチェックがスキップされます。データ損失などの予期しない結果が発生する可能性があるため、注意して使用する必要があります。

"Strict" に設定すると、アップグレード操作の実行時に CRD Upgrade Safety のプリフライトチェックが実行されます。

4.1.5. .spec.serviceAccount

説明
serviceAccount は、拡張機能の管理に必要なクラスターとのすべてのやり取りを実行するために使用される ServiceAccount への参照です。これらのやり取りを実行するには、ServiceAccount に必要なパーミッションを設定する必要があります。ServiceAccount は、spec で参照される namespace に存在する必要があります。serviceAccount は必須です。
object
必須
  • name
Expand
プロパティー説明

name

string

name は、packageName フィールドで指定されたパッケージのコンテンツのインストールと管理に使用される ServiceAccount の名前への必須かつ変更不可能な参照です。

この ServiceAccount は installNamespace に存在する必要があります。

name は [RFC 1123] で定義されている DNS サブドメイン標準に従います。小文字の英数字、ハイフン (-)、またはピリオド (.) のみを含み、先頭と末尾は英数字で、長さは 253 文字以下にする必要があります。

有効な値の例: - some-serviceaccount - 123-serviceaccount - 1-serviceaccount-2 - someserviceaccount - some.serviceaccount

無効な値の例: - -some-serviceaccount - some-serviceaccount-

[RFC 1123]: https://tools.ietf.org/html/rfc1123

4.1.6. .spec.source

説明

source は必須フィールドで、この ClusterExtension のコンテンツのインストールソースを選択します。選択は、sourceType を設定することによって実行されます。

現在実装されている sourceType は Catalog のみであり、sourcetype を "Catalog" に設定するには、catalog フィールドも定義する必要があります。

以下は、source 定義の最小限の例 (yaml 形式) です。

source: sourceType: Catalog catalog: packageName: example-package

object
必須
  • sourceType
Expand
プロパティー説明

catalog

object

catalog は、カタログから情報を取得する方法を設定するために使用されます。このフィールドは、sourceType が "Catalog" の場合に必須であり、それ以外の場合は禁止されます。

sourceType

string

sourceType は、インストールソースのタイプへの必須の参照です。

許可される値は "Catalog" です。

このフィールドを "Catalog" に設定すると、インストールする適切なコンテンツバンドルを決定するための情報が、クラスター上に存在する ClusterCatalog リソースから取得されます。Catalog sourceType を使用する場合は、カタログフィールドも設定する必要があります。

4.1.7. .spec.source.catalog

説明
catalog は、カタログから情報を取得する方法を設定するために使用されます。このフィールドは、sourceType が "Catalog" の場合に必須であり、それ以外の場合は禁止されます。
object
必須
  • packageName
Expand
プロパティー説明

channels

array (string)

channels は、packageName フィールドで指定されたパッケージに属するチャネルセットへのオプションの参照です。

"channel" とは、パッケージ作成者が定義した拡張機能の更新ストリームです。

リスト内の各チャネルは、[RFC 1123] で定義されている DNS サブドメイン標準に従う必要があります。小文字の英数字、ハイフン (-)、またはピリオド (.) のみを含み、先頭と末尾は英数字で、長さは 253 文字以下にする必要があります。指定可能なチャネルは 256 以下です。

指定すると、インストール可能なバンドルのセットと自動アップグレードパスを制約するために使用されます。この制約は、version フィールドとの AND 演算になります。例: - 指定されたチャネルが "foo" に設定され、指定されたバージョンが ">=1.0.0, <1.5.0" に設定されている場合、"foo" チャネルに存在し、かつバージョン範囲の比較を満たすバンドルのみが、インストール可能と見なされます。自動アップグレードは、選択されたチャネルによって定義されたアップグレードエッジに制約されます。

指定しない場合は、すべてのチャネルにわたるアップグレードエッジを使用して、有効な自動アップグレードパスが識別されます。

有効な値の例: - 1.1.x - alpha - stable - stable-v1 - v1-stable - dev-preview - preview - community

無効な値の例: - -some-channel - some-channel- - thisisareallylongchannelnamethatisgreaterthanthemaximumlength - original_40 - --default-channel

[RFC 1123]: https://tools.ietf.org/html/rfc1123

packageName

string

packageName は、インストールするパッケージの名前への参照であり、カタログからコンテンツをフィルタリングするために使用されます。

packageName は必須かつ変更不可能で、[RFC 1123] で定義されている DNS サブドメイン標準に従います。小文字の英数字、ハイフン (-)、またはピリオド (.) のみを含み、先頭と末尾は英数字で、長さは 253 文字以下にする必要があります。

有効な値の例: - some-package - 123-package - 1-package-2 - somepackage

無効な値の例: - -some-package - some-package- - thisisareallylongpackagenamethatisgreaterthanthemaximumlength - some.package

[RFC 1123]: https://tools.ietf.org/html/rfc1123

selector

object

selector はオプションのフィールドで、バンドル選択プロセスで使用される ClusterCatalog のセットをフィルタリングするために使用できます。

指定しない場合は、バンドル選択プロセスですべての ClusterCatalog が使用されます。

upgradeConstraintPolicy

string

upgradeConstraintPolicy はオプションのフィールドで、カタログで定義されたアップグレードパスが、packageName フィールドで参照されるパッケージに適用されるかどうかを制御します。

許可される値は、"CatalogProvided"、"SelfCertified、または省略できます。

このフィールドが "CatalogProvided" に設定されている場合、パッケージ作成者によって指定されたアップグレード制約が満たされた場合にのみ自動アップグレードが実行されます。

このフィールドが "SelfCertified" に設定されている場合、パッケージ作成者が指定したアップグレード制約は無視されます。これにより、パッケージの任意のバージョンへのアップグレードとダウングレードが可能になります。これは、データ損失など、未知の潜在的に悲惨な結果につながる可能性があるため、危険な操作と見なされています。このオプションを使用する場合、ユーザーが変更を独自に検証していることが前提となります。

このフィールドを省略した場合、デフォルト値は "CatalogProvided" です。

version

string

version はオプションの semver 制約 (特定のバージョンまたはバージョンの範囲) です。指定しない場合は、利用可能な最新バージョンがインストールされます。

許容されるバージョン範囲は 64 文字以内です。バージョン範囲は、コンマまたはスペースで区切られた値と、比較文字列と呼ばれる 1 つ以上の比較 Operator で構成されます。OR Operator (||) を使用して、追加の比較文字列を追加できます。

# 範囲の比較

バージョン範囲を指定するには、">=3.0, <3.6" のような比較文字列を使用できます。範囲を指定すると、その範囲内で自動更新が行われます。この例の比較文字列は、「3.0.0 以上 3.6.0 未満の任意のバージョンをインストールする」という意味です。また、最初のインストール後にバージョン範囲内でアップグレードが利用可能になった場合は、それらのアップグレードが自動的に実行されるという意図も示されています。

# 固定バージョン

インストールする正確なバージョンを指定するには、特定のバージョンに「固定」するバージョン範囲を使用できます。特定のバージョンに固定すると、自動更新は行われません。固定されたバージョン範囲の例は "0.6.0" です。これは、「バージョン 0.6.0 のみをインストールし、このバージョンからはアップグレードしないこと」を意味します。

# 基本的な比較 Operator

基本的な比較 Operator とその意味: "=" は同等 (特定の Operator にエイリアスされていない)、"!=" は同等ではない。"<" はより小さい。">" はより大きい。">=" は以上。"⇐" は以下。

# ワイルドカードの比較

すべての比較演算では、"x"、"X"、および "" 文字をワイルドカード文字として使用できます。ワイルドカード文字の使用例: "1.2.x"、"1.2.X"、および "1.2." は、">=1.2.0, < 1.3.0" と同等です。">= 1.2.x"、">= 1.2.X"、および ">= 1.2." は、">= 1.2.0" と同等です。"⇐ 2.x"、"⇐ 2.X"、および "⇐ 2." は、"< 3" と同等です。"x"、"X"、および "*" は、">= 0.0.0" と同等です。

# パッチリリースの比較

マイナーバージョンから次のメジャーバージョンまでを指定する場合は、"~" 文字を使用してパッチの比較を実行できます。例: "~1.2.3" は ">=1.2.3, <1.3.0" と同等です。"~1" および "~1.x" は ">=1, <2" と同等です。"~2.3" は ">=2.3、<2.4" と同等です。"~1.2.x" は ">=1.2.0, <1.3.0" と同等です。

# メジャーリリースの比較

stable 1.0.0 バージョンが公開された後、メジャーリリースの比較を行うには、"^" 文字を使用できます。stable バージョンが公開されていない場合は、// マイナーバージョンが安定性レベルを定義します。例: "^1.2.3" は ">=1.2.3, <2.0.0" と同等です。"^1.2.x" は ">=1.2.0, <2.0.0" と同等です。"^2.3" は ">=2.3, <3" と同等です。"^2.x" は ">=2.0.0, <3" と同等です。"^0.2.3" は ">=0.2.3, <0.3.0" と同等です。"^0.2"は ">=0.2.0, <0.3.0" と同等です。"^0.0.3" は ">=0.0.3, <0.0.4" と同等です。"^0.0" は ">=0.0.0, <0.1.0" と同等です。"^0" は ">=0.0.0, <1.0.0" と同等です。

# OR 比較。バージョン範囲内で OR 演算を表すには、"||" 文字を使用できます。一部の例: - ">=1.2.3, <2.0.0 || >3.0.0" - "^0 || ^3 || ^5"

semver の詳細は、https://semver.org/ を参照してください。

4.1.8. .spec.source.catalog.selector

説明

selector はオプションのフィールドで、バンドル選択プロセスで使用される ClusterCatalog のセットをフィルタリングするために使用できます。

指定しない場合は、バンドル選択プロセスですべての ClusterCatalog が使用されます。

object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

4.1.9. .spec.source.catalog.selector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

4.1.10. .spec.source.catalog.selector.matchExpressions[]

説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

4.1.11. .status

説明
status は、ClusterExtension の監視状態を定義するオプションフィールドです。
object
Expand
プロパティー説明

conditions

array

すべての spec.source バリエーションに適用される状態タイプのセットは、Installed と Progressing です。

Installed 状態は、この ClusterExtension に対してバンドルがインストールされているかどうかを表します。Installed が True で、Reason が Succeeded の場合、バンドルは正常にインストールされています。Installed が False で Reason が Failed の場合、バンドルはインストールに失敗しました。

Progressing 条件は、ClusterExtension が新しい状態に向かって進んでいるかどうかを表します。Progressing が True で Reason が Succeeded の場合、ClusterExtension は新しい状態に向けて進行中です。Progressing が True で、Reason が Retrying の場合、ClusterExtension でエラーが発生しましたが、これは後続の調整試行で解決できる可能性があります。Progressing が False で Reason が Blocked の場合、ClusterExtension でエラーが発生し、回復には手動による介入が必要です。

ClusterExtension がカタログから取得される場合、非推奨条件も伝えられることがあります。これらは、パッケージ所有者がユーザーを特定のパッケージ、チャネル、またはバンドルから遠ざけるように指示するものです。リクエストされたバンドルバージョンがカタログ内で非推奨とマークされている場合、BundleDeprecated が設定されます。リクエストされたチャネルがカタログ内で非推奨とマークされている場合、ChannelDeprecated が設定されます。リクエストされたパッケージがカタログ内で非推奨とマークされている場合、PackageDeprecated が設定されます。Deprecated は、非推奨の条件のいずれかが存在する場合に存在するロールアップ条件です。

conditions[]

object

condition には、この API Resource の現在の状態のある側面の詳細が含まれます。

install

object

install は、この ClusterExtension の現在のインストールステータスを表します。

4.1.12. .status.conditions

説明

すべての spec.source バリエーションに適用される状態タイプのセットは、Installed と Progressing です。

Installed 状態は、この ClusterExtension に対してバンドルがインストールされているかどうかを表します。Installed が True で、Reason が Succeeded の場合、バンドルは正常にインストールされています。Installed が False で Reason が Failed の場合、バンドルはインストールに失敗しました。

Progressing 条件は、ClusterExtension が新しい状態に向かって進んでいるかどうかを表します。Progressing が True で Reason が Succeeded の場合、ClusterExtension は新しい状態に向けて進行中です。Progressing が True で、Reason が Retrying の場合、ClusterExtension でエラーが発生しましたが、これは後続の調整試行で解決できる可能性があります。Progressing が False で Reason が Blocked の場合、ClusterExtension でエラーが発生し、回復には手動による介入が必要です。

ClusterExtension がカタログから取得される場合、非推奨条件も伝えられることがあります。これらは、パッケージ所有者がユーザーを特定のパッケージ、チャネル、またはバンドルから遠ざけるように指示するものです。リクエストされたバンドルバージョンがカタログ内で非推奨とマークされている場合、BundleDeprecated が設定されます。リクエストされたチャネルがカタログ内で非推奨とマークされている場合、ChannelDeprecated が設定されます。リクエストされたパッケージがカタログ内で非推奨とマークされている場合、PackageDeprecated が設定されます。Deprecated は、非推奨の条件のいずれかが存在する場合に存在するロールアップ条件です。

array

4.1.13. .status.conditions[]

説明
condition には、この API Resource の現在の状態のある側面の詳細が含まれます。
object
必須
  • lastTransitionTime
  • message
  • reason
  • status
  • type
Expand
プロパティー説明

lastTransitionTime

string

lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。

message

string

message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。

observedGeneration

integer

observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。

reason

string

reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。

status

string

条件のステータス、True、False、Unknown のいずれか。

type

string

CamelCase または foo.example.com/CamelCase の条件のタイプ。

4.1.14. .status.install

説明
install は、この ClusterExtension の現在のインストールステータスを表します。
object
必須
  • bundle
Expand
プロパティー説明

bundle

object

bundle は必須フィールドで、バンドルの識別属性を表します。

"bundle" とは、パッケージをインストールするためにクラスターに適用する必要があるリソースを表す、バージョン管理されたコンテンツのセットです。

4.1.15. .status.install.bundle

説明

bundle は必須フィールドで、バンドルの識別属性を表します。

"bundle" とは、パッケージをインストールするためにクラスターに適用する必要があるリソースを表す、バージョン管理されたコンテンツのセットです。

object
必須
  • name
  • version
Expand
プロパティー説明

name

string

name は必須であり、[RFC 1123] で定義されている DNS サブドメイン標準に従います。小文字の英数字、ハイフン (-)、またはピリオド (.) のみを含み、先頭と末尾は英数字で、長さは 253 文字以下にする必要があります。

version

string

version は必須フィールドであり、このバンドルが表すバージョンへの参照です。version は、https://semver.org/ で定義されているセマンティックバージョン管理標準に従います。

4.2. API エンドポイント

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

  • /apis/olm.operatorframework.io/v1/clusterextensions

    • DELETE: ClusterExtension のコレクションを削除します。
    • GET: 種類が ClusterExtension のオブジェクトをリスト表示します。
    • POST: ClusterExtension を作成します。
  • /apis/olm.operatorframework.io/v1/clusterextensions/{name}

    • DELETE: ClusterExtension を削除します。
    • GET: 指定された ClusterExtension を読み取ります。
    • PATCH: 指定された ClusterExtension を部分的に更新します。
    • PUT: 指定された ClusterExtension を置き換えます。
  • /apis/olm.operatorframework.io/v1/clusterextensions/{name}/status

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

4.2.1. /apis/olm.operatorframework.io/v1/clusterextensions

HTTP メソッド
DELETE
説明
ClusterExtension のコレクションを削除します。
Expand
表4.1 HTTP 応答
HTTP コード応答のボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
種類が ClusterExtension のオブジェクトをリスト表示します。
Expand
表4.2 HTTP 応答
HTTP コード応答のボディー

200 - OK

ClusterExtensionList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
ClusterExtension を作成します。
Expand
表4.3 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表4.4 本文パラメーター
パラメーター説明

body

ClusterExtension スキーマ

 
Expand
表4.5 HTTP 応答
HTTP コード応答のボディー

200 - OK

ClusterExtension スキーマ

201 - Created

ClusterExtension スキーマ

202 - Accepted

ClusterExtension スキーマ

401 - Unauthorized

空白

4.2.2. /apis/olm.operatorframework.io/v1/clusterextensions/{name}

Expand
表4.6 グローバルパスパラメーター
パラメーター説明

name

string

ClusterExtension の名前です。

HTTP メソッド
DELETE
説明
ClusterExtension を削除します。
Expand
表4.7 クエリーパラメーター
パラメーター説明

dryRun

string

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

Expand
表4.8 HTTP 応答
HTTP コード応答のボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された ClusterExtension を読み取ります。
Expand
表4.9 HTTP 応答
HTTP コード応答のボディー

200 - OK

ClusterExtension スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された ClusterExtension を部分的に更新します。
Expand
表4.10 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表4.11 HTTP 応答
HTTP コード応答のボディー

200 - OK

ClusterExtension スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された ClusterExtension を置き換えます。
Expand
表4.12 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表4.13 本文パラメーター
パラメーター説明

body

ClusterExtension スキーマ

 
Expand
表4.14 HTTP 応答
HTTP コード応答のボディー

200 - OK

ClusterExtension スキーマ

201 - Created

ClusterExtension スキーマ

401 - Unauthorized

空白

4.2.3. /apis/olm.operatorframework.io/v1/clusterextensions/{name}/status

Expand
表4.15 グローバルパスパラメーター
パラメーター説明

name

string

ClusterExtension の名前です。

HTTP メソッド
GET
説明
指定された ClusterExtension のステータスを読み取ります。
Expand
表4.16 HTTP 応答
HTTP コード応答のボディー

200 - OK

ClusterExtension スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された ClusterExtension のステータスを部分的に更新します。
Expand
表4.17 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表4.18 HTTP 応答
HTTP コード応答のボディー

200 - OK

ClusterExtension スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された ClusterExtension のステータスを置き換えます。
Expand
表4.19 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表4.20 本文パラメーター
パラメーター説明

body

ClusterExtension スキーマ

 
Expand
表4.21 HTTP 応答
HTTP コード応答のボディー

200 - OK

ClusterExtension スキーマ

201 - Created

ClusterExtension スキーマ

401 - Unauthorized

空白

第5章 ClusterServiceVersion [operators.coreos.com/v1alpha1]

説明
ClusterServiceVersion は、タイプ ClusterServiceVersionSpec のカスタムリソースです。
object
必須
  • metadata
  • spec

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

ClusterServiceVersionSpec 宣言は、特定のバージョンのアプリを管理できる Operator をインストールする方法を OLM に指示します。

status

object

ClusterServiceVersionStatus は、CSV のステータスに関する情報を表します。ステータスは、システムの実際の状態を追跡する場合があります。

5.1.1. .spec

説明
ClusterServiceVersionSpec 宣言は、特定のバージョンのアプリを管理できる Operator をインストールする方法を OLM に指示します。
object
必須
  • displayName
  • install
Expand
プロパティー説明

annotations

object (string)

アノテーションは、任意のメタデータを保存し、取得するために外部ツールで設定できる、リソースとともに保存される構造化されていないキー値のマップです。

apiservicedefinitions

object

APIServiceDefinitions は、ClusterServiceVersion によって実行される Operator によって管理されるか、または必要なすべての拡張機能 apis を宣言します。

cleanup

object

クリーンアップは、CSV が削除されたときのクリーンアップ動作を指定します

customresourcedefinitions

object

CustomResourceDefinitions は、ClusterServiceVersion によって実行される Operator によって管理されるか、または必要な CRD をすべて宣言します。

CRD が Owned リストにある場合、暗黙的に必要になります。

description

string

Operator の説明。Operator の機能、制限、またはユースケースを含めることができます。

displayName

string

Operator の表示形式の名前。

icon

array

この Operator のアイコン。

icon[]

object

 

install

object

NamedInstallStrategy は、インストール戦略が指定されている ClusterServiceVersion リソースのブロックを表します。

installModes

array

InstallModes は、サポートされているインストールタイプを指定します

installModes[]

object

InstallMode は、InstallModeType を CSV がサポートするかどうかを表すフラグに関連付けます。

keywords

array (string)

Operator を説明するキーワードのリスト。

labels

object (string)

オブジェクトの整理と分類 (スコープと選択) に使用できる文字列キーと値のマップ。

links

array

Operator に関連するリンクのリスト。

links[]

object

 

maintainers

array

Operator を保守している組織のリスト。

maintainers[]

object

 

maturity

string

 

minKubeVersion

string

 

nativeAPIs

array

 

nativeAPIs[]

object

GroupVersionKind では、kind をあいまいに識別します。自動的な強制変換を回避するために、GroupVersion を匿名で含めていません。カスタムマーシャリングを回避するために GroupVersion を使用しません。

provider

object

Operator を公開している背後の組織。

relatedImages

array

Operator がそれらの機能を実行するために必要となる可能性のある関連イメージまたは他のコンテナーをリスト表示します。このリストには、オペランドイメージも含める必要があります。すべてのイメージ参照は、タグではなくダイジェスト (SHA) で指定する必要があります。このフィールドはカタログの作成時にのみ使用され、クラスターの実行時には何のロールも果たしません。

relatedImages[]

object

 

replaces

string

これが置き換える CSV の名前。古い CSV の metadata.Name フィールドと一致する必要があります。

selector

object

関連リソースのラベルセレクター。

skips

array (string)

アップグレードグラフでスキップする必要がある 1 つ以上の CSV の名前。スキップする必要がある CSV の metadata.Name フィールドと一致する必要があります。このフィールドはカタログの作成時にのみ使用され、クラスターの実行時には何のロールも果たしません。

version

string

 

webhookdefinitions

array

 

webhookdefinitions[]

object

WebhookDescription は、必要な Webhook に関する詳細を OLM に提供します

5.1.2. .spec.apiservicedefinitions

説明
APIServiceDefinitions は、ClusterServiceVersion によって実行される Operator によって管理されるか、または必要なすべての拡張機能 apis を宣言します。
object
Expand
プロパティー説明

Owned

array

 

owned[]

object

APIServiceDescription は、集約を介して提供される API に関する詳細を OLM に提供します

required

array

 

required[]

object

APIServiceDescription は、集約を介して提供される API に関する詳細を OLM に提供します

5.1.3. .spec.apiservicedefinitions.owned

説明
array

5.1.4. .spec.apiservicedefinitions.owned[]

説明
APIServiceDescription は、集約を介して提供される API に関する詳細を OLM に提供します
object
必須
  • group
  • kind
  • name
  • version
Expand
プロパティー説明

actionDescriptors

array

 

actionDescriptors[]

object

ActionDescriptor は、カスタムリソースインスタンスで実行できる宣言型アクションを記述します

containerPort

integer

 

deploymentName

string

 

description

string

 

displayName

string

 

group

string

 

kind

string

 

name

string

 

resources

array

 

resources[]

object

APIResourceReference は、リファラーが利用する Kubernetes リソースタイプへの参照です。

specDescriptors

array

 

specDescriptors[]

object

SpecDescriptor は、OLM が使用できるように、CRD のスペックブロック内のフィールドを記述します。

statusDescriptors

array

 

statusDescriptors[]

object

StatusDescriptor は、OLM がフィールドを使用できるように、CRD のステータスブロック内のフィールドを記述します

version

string

 

5.1.5. .spec.apiservicedefinitions.owned[].actionDescriptors

説明
array

5.1.6. .spec.apiservicedefinitions.owned[].actionDescriptors[]

説明
ActionDescriptor は、カスタムリソースインスタンスで実行できる宣言型アクションを記述します
object
必須
  • path
Expand
プロパティー説明

description

string

 

displayName

string

 

path

string

 

value

string

RawMessage は、生のエンコードされた JSON 値です。[Marshaler] と [Unmarshaler] を実装します。JSON デコードを遅延したり、JSON エンコードを事前計算したりするために使用できます。

x-descriptors

array (string)

 

5.1.7. .spec.apiservicedefinitions.owned[].resources

説明
array

5.1.8. .spec.apiservicedefinitions.owned[].resources[]

説明
APIResourceReference は、リファラーが利用する Kubernetes リソースタイプへの参照です。
object
必須
  • kind
  • name
  • version
Expand
プロパティー説明

kind

string

参照されるリソースタイプの種類。

name

string

参照されるリソースタイプの複数形の名前 (CustomResourceDefinition.Spec.Names[].Plural)。参照されるリソースタイプがカスタムリソースでない場合は、空の文字列です。

version

string

参照されるリソースタイプの API バージョン。

5.1.9. .spec.apiservicedefinitions.owned[].specDescriptors

説明
array

5.1.10. .spec.apiservicedefinitions.owned[].specDescriptors[]

説明
SpecDescriptor は、OLM が使用できるように、CRD のスペックブロック内のフィールドを記述します。
object
必須
  • path
Expand
プロパティー説明

description

string

 

displayName

string

 

path

string

 

value

string

RawMessage は、生のエンコードされた JSON 値です。[Marshaler] と [Unmarshaler] を実装します。JSON デコードを遅延したり、JSON エンコードを事前計算したりするために使用できます。

x-descriptors

array (string)

 

5.1.11. .spec.apiservicedefinitions.owned[].statusDescriptors

説明
array

5.1.12. .spec.apiservicedefinitions.owned[].statusDescriptors[]

説明
StatusDescriptor は、OLM がフィールドを使用できるように、CRD のステータスブロック内のフィールドを記述します
object
必須
  • path
Expand
プロパティー説明

description

string

 

displayName

string

 

path

string

 

value

string

RawMessage は、生のエンコードされた JSON 値です。[Marshaler] と [Unmarshaler] を実装します。JSON デコードを遅延したり、JSON エンコードを事前計算したりするために使用できます。

x-descriptors

array (string)

 

5.1.13. .spec.apiservicedefinitions.required

説明
array

5.1.14. .spec.apiservicedefinitions.required[]

説明
APIServiceDescription は、集約を介して提供される API に関する詳細を OLM に提供します
object
必須
  • group
  • kind
  • name
  • version
Expand
プロパティー説明

actionDescriptors

array

 

actionDescriptors[]

object

ActionDescriptor は、カスタムリソースインスタンスで実行できる宣言型アクションを記述します

containerPort

integer

 

deploymentName

string

 

description

string

 

displayName

string

 

group

string

 

kind

string

 

name

string

 

resources

array

 

resources[]

object

APIResourceReference は、リファラーが利用する Kubernetes リソースタイプへの参照です。

specDescriptors

array

 

specDescriptors[]

object

SpecDescriptor は、OLM が使用できるように、CRD のスペックブロック内のフィールドを記述します。

statusDescriptors

array

 

statusDescriptors[]

object

StatusDescriptor は、OLM がフィールドを使用できるように、CRD のステータスブロック内のフィールドを記述します

version

string

 

5.1.15. .spec.apiservicedefinitions.required[].actionDescriptors

説明
array

5.1.16. .spec.apiservicedefinitions.required[].actionDescriptors[]

説明
ActionDescriptor は、カスタムリソースインスタンスで実行できる宣言型アクションを記述します
object
必須
  • path
Expand
プロパティー説明

description

string

 

displayName

string

 

path

string

 

value

string

RawMessage は、生のエンコードされた JSON 値です。[Marshaler] と [Unmarshaler] を実装します。JSON デコードを遅延したり、JSON エンコードを事前計算したりするために使用できます。

x-descriptors

array (string)

 

5.1.17. .spec.apiservicedefinitions.required[].resources

説明
array

5.1.18. .spec.apiservicedefinitions.required[].resources[]

説明
APIResourceReference は、リファラーが利用する Kubernetes リソースタイプへの参照です。
object
必須
  • kind
  • name
  • version
Expand
プロパティー説明

kind

string

参照されるリソースタイプの種類。

name

string

参照されるリソースタイプの複数形の名前 (CustomResourceDefinition.Spec.Names[].Plural)。参照されるリソースタイプがカスタムリソースでない場合は、空の文字列です。

version

string

参照されるリソースタイプの API バージョン。

5.1.19. .spec.apiservicedefinitions.required[].specDescriptors

説明
array

5.1.20. .spec.apiservicedefinitions.required[].specDescriptors[]

説明
SpecDescriptor は、OLM が使用できるように、CRD のスペックブロック内のフィールドを記述します。
object
必須
  • path
Expand
プロパティー説明

description

string

 

displayName

string

 

path

string

 

value

string

RawMessage は、生のエンコードされた JSON 値です。[Marshaler] と [Unmarshaler] を実装します。JSON デコードを遅延したり、JSON エンコードを事前計算したりするために使用できます。

x-descriptors

array (string)

 

5.1.21. .spec.apiservicedefinitions.required[].statusDescriptors

説明
array

5.1.22. .spec.apiservicedefinitions.required[].statusDescriptors[]

説明
StatusDescriptor は、OLM がフィールドを使用できるように、CRD のステータスブロック内のフィールドを記述します
object
必須
  • path
Expand
プロパティー説明

description

string

 

displayName

string

 

path

string

 

value

string

RawMessage は、生のエンコードされた JSON 値です。[Marshaler] と [Unmarshaler] を実装します。JSON デコードを遅延したり、JSON エンコードを事前計算したりするために使用できます。

x-descriptors

array (string)

 

5.1.23. .spec.cleanup

説明
クリーンアップは、CSV が削除されたときのクリーンアップ動作を指定します
object
必須
  • enabled
Expand
プロパティー説明

enabled

boolean

 

5.1.24. .spec.customresourcedefinitions

説明

CustomResourceDefinitions は、ClusterServiceVersion によって実行される Operator によって管理されるか、または必要な CRD をすべて宣言します。

CRD が Owned リストにある場合、暗黙的に必要になります。

object
Expand
プロパティー説明

Owned

array

 

owned[]

object

CRDDescription は、CRD に関する詳細を OLM に提供します

required

array

 

required[]

object

CRDDescription は、CRD に関する詳細を OLM に提供します

5.1.25. .spec.customresourcedefinitions.owned

説明
array

5.1.26. .spec.customresourcedefinitions.owned[]

説明
CRDDescription は、CRD に関する詳細を OLM に提供します
object
必須
  • kind
  • name
  • version
Expand
プロパティー説明

actionDescriptors

array

 

actionDescriptors[]

object

ActionDescriptor は、カスタムリソースインスタンスで実行できる宣言型アクションを記述します

description

string

 

displayName

string

 

kind

string

 

name

string

 

resources

array

 

resources[]

object

APIResourceReference は、リファラーが利用する Kubernetes リソースタイプへの参照です。

specDescriptors

array

 

specDescriptors[]

object

SpecDescriptor は、OLM が使用できるように、CRD のスペックブロック内のフィールドを記述します。

statusDescriptors

array

 

statusDescriptors[]

object

StatusDescriptor は、OLM がフィールドを使用できるように、CRD のステータスブロック内のフィールドを記述します

version

string

 

5.1.27. .spec.customresourcedefinitions.owned[].actionDescriptors

説明
array

5.1.28. .spec.customresourcedefinitions.owned[].actionDescriptors[]

説明
ActionDescriptor は、カスタムリソースインスタンスで実行できる宣言型アクションを記述します
object
必須
  • path
Expand
プロパティー説明

description

string

 

displayName

string

 

path

string

 

value

string

RawMessage は、生のエンコードされた JSON 値です。[Marshaler] と [Unmarshaler] を実装します。JSON デコードを遅延したり、JSON エンコードを事前計算したりするために使用できます。

x-descriptors

array (string)

 

5.1.29. .spec.customresourcedefinitions.owned[].resources

説明
array

5.1.30. .spec.customresourcedefinitions.owned[].resources[]

説明
APIResourceReference は、リファラーが利用する Kubernetes リソースタイプへの参照です。
object
必須
  • kind
  • name
  • version
Expand
プロパティー説明

kind

string

参照されるリソースタイプの種類。

name

string

参照されるリソースタイプの複数形の名前 (CustomResourceDefinition.Spec.Names[].Plural)。参照されるリソースタイプがカスタムリソースでない場合は、空の文字列です。

version

string

参照されるリソースタイプの API バージョン。

5.1.31. .spec.customresourcedefinitions.owned[].specDescriptors

説明
array

5.1.32. .spec.customresourcedefinitions.owned[].specDescriptors[]

説明
SpecDescriptor は、OLM が使用できるように、CRD のスペックブロック内のフィールドを記述します。
object
必須
  • path
Expand
プロパティー説明

description

string

 

displayName

string

 

path

string

 

value

string

RawMessage は、生のエンコードされた JSON 値です。[Marshaler] と [Unmarshaler] を実装します。JSON デコードを遅延したり、JSON エンコードを事前計算したりするために使用できます。

x-descriptors

array (string)

 

5.1.33. .spec.customresourcedefinitions.owned[].statusDescriptors

説明
array

5.1.34. .spec.customresourcedefinitions.owned[].statusDescriptors[]

説明
StatusDescriptor は、OLM がフィールドを使用できるように、CRD のステータスブロック内のフィールドを記述します
object
必須
  • path
Expand
プロパティー説明

description

string

 

displayName

string

 

path

string

 

value

string

RawMessage は、生のエンコードされた JSON 値です。[Marshaler] と [Unmarshaler] を実装します。JSON デコードを遅延したり、JSON エンコードを事前計算したりするために使用できます。

x-descriptors

array (string)

 

5.1.35. .spec.customresourcedefinitions.required

説明
array

5.1.36. .spec.customresourcedefinitions.required[]

説明
CRDDescription は、CRD に関する詳細を OLM に提供します
object
必須
  • kind
  • name
  • version
Expand
プロパティー説明

actionDescriptors

array

 

actionDescriptors[]

object

ActionDescriptor は、カスタムリソースインスタンスで実行できる宣言型アクションを記述します

description

string

 

displayName

string

 

kind

string

 

name

string

 

resources

array

 

resources[]

object

APIResourceReference は、リファラーが利用する Kubernetes リソースタイプへの参照です。

specDescriptors

array

 

specDescriptors[]

object

SpecDescriptor は、OLM が使用できるように、CRD のスペックブロック内のフィールドを記述します。

statusDescriptors

array

 

statusDescriptors[]

object

StatusDescriptor は、OLM がフィールドを使用できるように、CRD のステータスブロック内のフィールドを記述します

version

string

 

5.1.37. .spec.customresourcedefinitions.required[].actionDescriptors

説明
array

5.1.38. .spec.customresourcedefinitions.required[].actionDescriptors[]

説明
ActionDescriptor は、カスタムリソースインスタンスで実行できる宣言型アクションを記述します
object
必須
  • path
Expand
プロパティー説明

description

string

 

displayName

string

 

path

string

 

value

string

RawMessage は、生のエンコードされた JSON 値です。[Marshaler] と [Unmarshaler] を実装します。JSON デコードを遅延したり、JSON エンコードを事前計算したりするために使用できます。

x-descriptors

array (string)

 

5.1.39. .spec.customresourcedefinitions.required[].resources

説明
array

5.1.40. .spec.customresourcedefinitions.required[].resources[]

説明
APIResourceReference は、リファラーが利用する Kubernetes リソースタイプへの参照です。
object
必須
  • kind
  • name
  • version
Expand
プロパティー説明

kind

string

参照されるリソースタイプの種類。

name

string

参照されるリソースタイプの複数形の名前 (CustomResourceDefinition.Spec.Names[].Plural)。参照されるリソースタイプがカスタムリソースでない場合は、空の文字列です。

version

string

参照されるリソースタイプの API バージョン。

5.1.41. .spec.customresourcedefinitions.required[].specDescriptors

説明
array

5.1.42. .spec.customresourcedefinitions.required[].specDescriptors[]

説明
SpecDescriptor は、OLM が使用できるように、CRD のスペックブロック内のフィールドを記述します。
object
必須
  • path
Expand
プロパティー説明

description

string

 

displayName

string

 

path

string

 

value

string

RawMessage は、生のエンコードされた JSON 値です。[Marshaler] と [Unmarshaler] を実装します。JSON デコードを遅延したり、JSON エンコードを事前計算したりするために使用できます。

x-descriptors

array (string)

 

5.1.43. .spec.customresourcedefinitions.required[].statusDescriptors

説明
array

5.1.44. .spec.customresourcedefinitions.required[].statusDescriptors[]

説明
StatusDescriptor は、OLM がフィールドを使用できるように、CRD のステータスブロック内のフィールドを記述します
object
必須
  • path
Expand
プロパティー説明

description

string

 

displayName

string

 

path

string

 

value

string

RawMessage は、生のエンコードされた JSON 値です。[Marshaler] と [Unmarshaler] を実装します。JSON デコードを遅延したり、JSON エンコードを事前計算したりするために使用できます。

x-descriptors

array (string)

 

5.1.45. .spec.icon

説明
この Operator のアイコン。
array

5.1.46. .spec.icon[]

説明
object
必須
  • base64data
  • mediatype
Expand
プロパティー説明

base64data

string

 

mediatype

string

 

5.1.47. .spec.install

説明
NamedInstallStrategy は、インストール戦略が指定されている ClusterServiceVersion リソースのブロックを表します。
object
必須
  • strategy
Expand
プロパティー説明

spec

object

StrategyDetailsDeployment は、Deployment InstallStrategy の解析された詳細を表します。

strategy

string

 

5.1.48. .spec.install.spec

説明
StrategyDetailsDeployment は、Deployment InstallStrategy の解析された詳細を表します。
object
必須
  • deployments
Expand
プロパティー説明

clusterPermissions

array

 

clusterPermissions[]

object

StrategyDeploymentPermissions は、インストール戦略に必要な rbac ルールとサービスアカウントを記述します。

deployments

array

 

deployments[]

object

StrategyDeploymentSpec には、ALM が作成する必要のあるデプロイメントの名前、仕様、およびラベルが含まれています。

permissions

array

 

permissions[]

object

StrategyDeploymentPermissions は、インストール戦略に必要な rbac ルールとサービスアカウントを記述します。

5.1.49. .spec.install.spec.clusterPermissions

説明
array

5.1.50. .spec.install.spec.clusterPermissions[]

説明
StrategyDeploymentPermissions は、インストール戦略に必要な rbac ルールとサービスアカウントを記述します。
object
必須
  • rules
  • serviceAccountName
Expand
プロパティー説明

rules

array

 

rules[]

object

PolicyRule は、ポリシールールを説明する情報を保持しますが、ルールが適用されるユーザーやルールが適用される namespace に関する情報は含まれません。

serviceAccountName

string

 

5.1.51. .spec.install.spec.clusterPermissions[].rules

説明
array

5.1.52. .spec.install.spec.clusterPermissions[].rules[]

説明
PolicyRule は、ポリシールールを説明する情報を保持しますが、ルールが適用されるユーザーやルールが適用される namespace に関する情報は含まれません。
object
必須
  • verbs
Expand
プロパティー説明

apiGroups

array (string)

apiGroups は、リソースを含む APIGroup の名前です。複数の API グループが指定されている場合、任意の API グループ内の列挙されたリソースの 1 つに対してリクエストされたアクションはすべて許可されます。"" はコア API グループを表し、"*" はすべての API グループを表します。

nonResourceURLs

array (string)

NonResourceURLs は、ユーザーがアクセスできる必要のある部分的な URL のセットです。*は許可されますが、パスの完全な最終ステップとしてのみです。非リソース URL は namespace 化されていないため、このフィールドは ClusterRoleBinding から参照される ClusterRoles にのみ適用されます。ルールは、API リソース ("pods" や "secrets" など) または非リソース URL パス ("/api" など) のいずれかに適用できますが、両方に適用することはできません。

resourceNames

array (string)

resourceNames は、ルールが適用される名前のオプションのホワイトリストです。空のセットは、すべてが許可されていることを意味します。

resources

array (string)

リソースは、このルールが適用されるリソースのリストです。'*' はすべてのリソースを表します。

verbs

array (string)

Verbs は、このルールに含まれるすべての ResourceKind に適用される Verbs のリストです。'*' はすべての動詞を表します。

5.1.53. .spec.install.spec.deployments

説明
array

5.1.54. .spec.install.spec.deployments[]

説明
StrategyDeploymentSpec には、ALM が作成する必要のあるデプロイメントの名前、仕様、およびラベルが含まれています。
object
必須
  • name
  • spec
Expand
プロパティー説明

ラベル

object (string)

セットは label:value のマップです。ラベルを実装します。

name

string

 

spec

object

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

5.1.55. .spec.install.spec.deployments[].spec

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

minReadySeconds

integer

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

paused

boolean

デプロイメントが一時停止されていることを示します。

progressDeadlineSeconds

integer

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

replicas

integer

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

revisionHistoryLimit

integer

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

selector

object

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

strategy

object

既存の Pod を新しい Pod に置き換えるために使用するデプロイメント戦略。

template

object

テンプレートには、作成される Pod が記述されています。許可される template.spec.restartPolicy 値は "Always" のみです。

5.1.56. .spec.install.spec.deployments[].spec.selector

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

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

5.1.57. .spec.install.spec.deployments[].spec.selector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

5.1.58. .spec.install.spec.deployments[].spec.selector.matchExpressions[]

説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

5.1.59. .spec.install.spec.deployments[].spec.strategy

説明
既存の Pod を新しい Pod に置き換えるために使用するデプロイメント戦略。
object
Expand
プロパティー説明

rollingUpdate

object

ローリング更新の設定パラメーター。DeploymentStrategyType = RollingUpdate の場合にのみ存在します。

type

string

デプロイメントのタイプ。"Recreate" または "RollingUpdate" にすることができます。デフォルトは RollingUpdate です。

5.1.60. .spec.install.spec.deployments[].spec.strategy.rollingUpdate

説明
ローリング更新の設定パラメーター。DeploymentStrategyType = RollingUpdate の場合にのみ存在します。
object
Expand
プロパティー説明

maxSurge

integer-or-string

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

maxUnavailable

integer-or-string

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

5.1.61. .spec.install.spec.deployments[].spec.template

説明
テンプレートには、作成される Pod が記述されています。許可される template.spec.restartPolicy 値は "Always" のみです。
object
Expand
プロパティー説明

metadata

``

標準オブジェクトのメタデータ。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

Pod に期待される動作の仕様。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

5.1.62. .spec.install.spec.deployments[].spec.template.spec

説明
Pod に期待される動作の仕様。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
object
必須
  • containers
Expand
プロパティー説明

activeDeadlineSeconds

integer

システムがアクティブに失敗のマークを付けて関連するコンテナーを強制終了する前に、StartTime を基準にして Pod がノード上でアクティブになる可能性がある秒単位のオプションの期間。その値は正の整数でなければなりません。

affinity

object

指定されている場合、Pod のスケジューリング制約

automountServiceAccountToken

boolean

AutomountServiceAccountToken は、サービスアカウントトークンを自動的にマウントする必要があるかどうかを示します。

containers

array

Pod に属するコンテナーのリスト。現在、コンテナーを追加または削除することはできません。Pod には少なくとも 1 つのコンテナーが必要です。これは更新できません。

containers[]

object

Pod 内で実行する単一のアプリケーションコンテナー。

dnsConfig

object

Pod の DNS パラメーターを指定します。ここで指定されたパラメーターは、DNSPolicy に基づいて生成された DNS 設定にマージされます。

dnsPolicy

string

Pod の DNS ポリシーを設定します。デフォルトは "ClusterFirst" です。有効な値は、'ClusterFirstWithHostNet'、'ClusterFirst'、'Default'、または 'None' です。DNSConfig で指定された DNS パラメーターは、DNSPolicy で選択されたポリシーとマージされます。hostNetwork とともに DNS オプションを設定するには、DNS ポリシーを 'ClusterFirstWithHostNet' に明示的に指定する必要があります。

enableServiceLinks

boolean

EnableServiceLinks は、Docker リンクの構文と一致して、サービスに関する情報を Pod の環境変数に注入する必要があるかどうかを示します。オプション: デフォルトは true です。

ephemeralContainers

array

この Pod で実行されるエフェメラルコンテナーのリスト。エフェメラルコンテナーを既存の Pod で実行して、デバッグなどのユーザーが開始するアクションを実行できます。このリストは、Pod の作成時に指定することはできません。また、Pod の仕様を更新して変更することもできません。エフェメラルコンテナーを既存の Pod に追加するには、Pod のエフェメラルコンテナーサブリソースを使用します。

ephemeralContainers[]

object

EphemeralContainer は、デバッグなど、ユーザーが開始したアクティビティーに対して、既存の Pod に追加できる一時コンテナーです。エフェメラルコンテナーにはリソースやスケジュールの保証がなく、コンテナーの終了時、または Pod の削除または再起動時に再起動されません。エフェメラルコンテナーが原因で Pod がリソース割り当てを超過した場合、kubelet は Pod を退避する可能性があります。

エフェメラルコンテナーを追加するには、既存の Pod の ephemeralcontainers サブリソースを使用します。エフェメラルコンテナーは削除または再起動できません。

hostAliases

array

HostAliases は、指定された場合に Pod の hosts ファイルに注入されるホストおよび IP のオプションのリストです。

hostAliases[]

object

HostAlias は、Pod の hosts ファイルのエントリーとして注入される IP とホスト名の間のマッピングを保持します。

hostIPC

boolean

ホストの ipc namespace を使用します。オプション: デフォルトは false です。

hostNetwork

boolean

この Pod に要求されたホストネットワーク。ホストのネットワーク namespace を使用します。このオプションを設定する場合は、使用するポートを指定する必要があります。デフォルトは false です。

hostPID

boolean

ホストの pid namespace を使用します。オプション: デフォルトは false です。

hostUsers

boolean

ホストのユーザー namespace を使用します。任意: デフォルトは true です。true に設定するか存在しない場合、Pod はホストユーザーの namespace で実行されます。これは、CAP_SYS_MODULE を使用したカーネルモジュールのロードなど、ホストユーザー namespace でのみ利用できる機能が Pod に必要な場合に役立ちます。false に設定すると、Pod 用に新しい userns が作成されます。false に設定すると、コンテナーブレークアウトの脆弱性を軽減するのに役立ち、ユーザーがホスト上で実際に root 権限を持たずにコンテナーを root として実行できるようになります。このフィールドはアルファレベルであり、UserNamespacesSupport 機能を有効にするサーバーでのみ認識されます。

hostname

string

Pod のホスト名を指定します指定しない場合、Pod のホスト名はシステム定義の値に設定されます。

imagePullSecrets

array

ImagePullSecrets は、この PodSpec で使用されるイメージをプルするために使用する、同じ namespace 内のシークレットへの参照のオプションのリストです。指定されている場合、これらのシークレットは、使用するために個々のプラー実装に渡されます。詳細: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

imagePullSecrets[]

object

LocalObjectReference には、同じ namespace 内で参照オブジェクトを見つけるのに十分な情報が含まれます。

initContainers

array

Pod に属する初期化コンテナーのリスト。コンテナーが開始される前に、初期化コンテナーが順番に実行されます。init コンテナーに障害が発生した場合、Pod は障害が発生したと見なされ、restartPolicy に従って処理されます。init コンテナーまたは通常のコンテナーの名前は、すべてのコンテナー間で一意である必要があります。Init コンテナーには、ライフサイクルアクション、準備プローブ、ライブネスプローブ、またはスタートアッププローブがない場合があります。init コンテナーの resourceRequirements は、各リソースタイプの最大の要求/制限を見つけ、その値の最大値または通常のコンテナーの合計を使用することにより、スケジューリング中に考慮されます。同様の方法で、init コンテナーに制限が適用されます。現在、初期化コンテナーを追加または削除することはできません。これは更新できません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/

initContainers[]

object

Pod 内で実行する単一のアプリケーションコンテナー。

nodeName

string

NodeName は、この Pod がスケジュールされるノードを示します。空の場合、この Pod は schedulerName で定義されるスケジューラーによるスケジューリングの候補です。このフィールドが設定されると、このノードの kubelet がこの Pod のライフサイクルを管理するようになります。このフィールドは、Pod が特定のノード上にスケジュールされることを表すために使用しないでください。https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodename

nodeSelector

object (string)

NodeSelector は、Pod がノードに収まるようにするために true である必要があるセレクターです。そのノードでスケジュールされる Pod のノードのラベルと一致する必要があるセレクター。詳細: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

os

object

Pod 内のコンテナーの OS を指定します。これが設定されている場合、一部の Pod およびコンテナーフィールドは制限されます。

OS フィールドが linux に設定されている場合は、-securityContext.windowsOptions のフィールドの設定を解除する必要があります。

OS フィールドが Windows に設定されている場合は、次のフィールドの設定を解除する必要があります。- spec.hostPID - spec.hostIPC - spec.hostUsers - spec.securityContext.appArmorProfile - spec.securityContext.seLinuxOptions - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.securityContext.supplementalGroupsPolicy - spec.containers[].securityContext.appArmorProfile - spec.containers[].securityContext.seLinuxOptions - spec.containers[].securityContext.seccompProfile - spec.containers[].securityContext.capabilities - spec.containers[].securityContext.readOnlyRootFilesystem - spec.containers[].securityContext.privileged - spec.containers[].securityContext.allowPrivilegeEscalation - spec.containers[].securityContext.procMount - spec.containers[].securityContext.runAsUser - spec.containers[].securityContext.runAsGroup

overhead

integer-or-string

オーバーヘッドは、特定の RuntimeClass の Pod の実行に関連するリソースオーバーヘッドを表します。このフィールドは、RuntimeClass アドミッションコントローラーによってアドミッション時に自動入力されます。RuntimeClass アドミッションコントローラーが有効になっている場合は、Pod 作成要求でオーバーヘッドを設定しないでください。RuntimeClass アドミッションコントローラーは、オーバーヘッドがすでに設定されている Pod 作成要求を拒否します。RuntimeClass が PodSpec で設定および選択されている場合、オーバーヘッドは対応する RuntimeClass で定義されている値に設定されます。それ以外の場合は、未設定のままでゼロとして扱われます。詳細: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md

preemptionPolicy

string

PreemptionPolicy は、優先度の低い Pod をプリエンプトするためのポリシーです。Never、PreemptLowerPriority の 1 つ。設定されていない場合、デフォルトは PreemptLowerPriority です。

priority

integer

優先度の値。さまざまなシステムコンポーネントがこのフィールドを使用して、Pod の優先度を検索します。Priority Admission Controller が有効になっている場合、ユーザーはこのフィールドを設定できません。アドミッションコントローラーは、PriorityClassName からこのフィールドに入力します。値が高いと優先順位が高くなります。

priorityClassName

string

指定されている場合、Pod の優先度を示します。"system-node-critical" と "system-cluster-critical" は、最も高い優先度を示す 2 つの特別なキーワードであり、前者が最も高い優先度です。その他の名前は、その名前で PriorityClass オブジェクトを作成して定義する必要があります。指定しない場合、Pod の優先度はデフォルトになり、デフォルトがない場合はゼロになります。

readinessGates

array

指定した場合、すべての準備ゲートが Pod の準備状況に対して評価されます。すべてのコンテナーの準備が整い、準備ゲートで指定されたすべての条件のステータスが "True" になると、Pod の準備が整います。詳細: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates

readinessGates[]

object

PodReadinessGate には、Pod 条件への参照が含まれています

resourceClaims

array

ResourceClaims は、Pod の起動を許可する前にどの ResourceClaim を割り当てて予約する必要があるかを定義します。リソースは、名前ベースでリソースを使用するコンテナーに提供されます。

これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。

このフィールドは変更不可能です。

resourceClaims[]

object

PodResourceClaim は、直接または Pod の ResourceClaim に変換する ResourceClaimTemplate に名前を付けることで、1 つの ResourceClaim のみを参照します。

Pod 内の ResourceClaim を一意に識別する名前を追加します。ResourceClaim へのアクセスが必要なコンテナーは、この名前で参照します。

resources

object

resources は、Pod 内のすべてのコンテナーに必要な CPU およびメモリーリソースの合計量です。"cpu" および "memory" リソース名に対してのみ、リクエストと制限の指定をサポートします。ResourceClaims はサポートされていません。

このフィールドにより、Pod 全体のリソース割り当てを細かく制御できるようになり、Pod 内のコンテナー間でリソースを共有できるようになります。

このフィールドはアルファ版であり、使用するには PodLevelResources フィーチャーゲートを有効にする必要があります。

restartPolicy

string

Pod 内のすべてのコンテナーのポリシーを再起動します。Always、OnFailure、Never のいずれか。コンテキストによっては、これらの値のサブセットのみが使用できます。デフォルトは Always です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy

runtimeClassName

string

RuntimeClassName は、node.k8s.io グループ内の RuntimeClass オブジェクトを参照します。このオブジェクトは、この Pod を実行するために使用する必要があります。指定されたクラスに一致する RuntimeClass リソースがない場合、Pod は実行されません。設定されていないか空の場合は、"レガシー" の RuntimeClass が使用されます。これは、デフォルトのランタイムハンドラーを使用する空の定義を持つ暗黙のクラスです。詳細: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class

schedulerName

string

指定した場合、Pod は指定したスケジューラーによってディスパッチされます。指定しない場合、Pod はデフォルトのスケジューラーによってディスパッチされます。

schedulingGates

array

SchedulingGates は、指定されている場合に Pod のスケジューリングをブロックする不透明な値のリストです。schedulingGates が空でない場合、Pod は SchedulingGated 状態のままになり、スケジューラーは Pod のスケジュールを試行しません。

SchedulingGates を設定できるのは Pod の作成時にのみで、それ以降は削除されます。

schedulingGates[]

object

PodSchedulingGate は Pod に割り当てられ、そのスケジューリングを保護します。

securityContext

object

SecurityContext は、Pod レベルのセキュリティー属性と一般的なコンテナー設定を保持します。オプション: デフォルトは空です。各フィールドのデフォルト値は、タイプの説明を参照してください。

serviceAccount

string

DeprecatedServiceAccount は、ServiceAccountName の非推奨となったエイリアスです。非推奨: 代わりに serviceAccountName を使用してください。

serviceAccountName

string

ServiceAccountName は、この Pod の実行に使用する ServiceAccount の名前です。詳細: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/

setHostnameAsFQDN

boolean

true の場合、Pod のホスト名は、リーフ名 (デフォルト) ではなく、Pod の FQDN として設定されます。Linux コンテナーでは、これはカーネルのホスト名フィールド (struct utsname のノード名フィールド) に FQDN を設定することを意味します。Windows コンテナーでは、これはレジストリーキー HKEY_LOCAL_MACHINE \\ SYSTEM \\ CurrentControlSet \\ Services \\ Tcpip\\Parameters のホスト名のレジストリー値を FQDN に設定することを意味します。Pod に FQDN がない場合、これは効果がありません。デフォルトは false です。

shareProcessNamespace

boolean

Pod 内のすべてのコンテナー間で単一のプロセス namespace を共有します。これが設定されると、コンテナーは同じ Pod 内の他のコンテナーからのプロセスを表示および通知できるようになり、各コンテナーの最初のプロセスには PID1 が割り当てられません。HostPID と ShareProcessNamespace の両方を設定することはできません。オプション: デフォルトは false です。

subdomain

string

指定した場合、完全修飾 Pod のホスト名は "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>" になります。指定しない場合、Pod にはドメイン名がまったくありません。

terminationGracePeriodSeconds

integer

Pod がグレースフルに終了する必要がある秒単位のオプションの期間。削除リクエストで減少する可能性があります。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。この値が nil の場合、代わりにデフォルトの猶予期間が使用されます。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。デフォルトは 30 秒です。

tolerations

array

指定されている場合、Pod の許容範囲。

tolerations[]

object

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

topologySpreadConstraints

array

topologySpreadConstraints は、Pod のグループがトポロジードメイン全体にどのように分散するべきかを説明します。スケジューラーは、制約に従う方法で Pod をスケジュールします。すべての topologySpreadConstraints は AND 演算されます。

topologySpreadConstraints[]

object

topologySpreadConstraint は、指定されたトポロジー間で一致する Pod を分散する方法を指定します。

volumes

array

Pod に属するコンテナーによってマウントできるボリュームのリスト。詳細: https://kubernetes.io/docs/concepts/storage/volumes

volumes[]

object

ボリュームは、Pod 内の任意のコンテナーからアクセスできる Pod 内の名前付きボリュームを表します。

5.1.63. .spec.install.spec.deployments[].spec.template.spec.affinity

説明
指定されている場合、Pod のスケジューリング制約
object
Expand
プロパティー説明

nodeAffinity

object

Pod のノードアフィニティースケジューリングルールを説明します。

podAffinity

object

Pod アフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置します)。

podAntiAffinity

object

Pod のアンチアフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置しないでください)。

5.1.64. .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity

説明
Pod のノードアフィニティースケジューリングルールを説明します。
object
Expand
プロパティー説明

preferredDuringSchedulingIgnoredDuringExecution

array

スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードが対応する matchExpressions と一致する場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。

preferredDuringSchedulingIgnoredDuringExecution[]

object

空の優先スケジューリング用語は、暗黙の重み 0 を持つすべてのオブジェクトに一致します (つまり、操作なしです)。null の優先スケジューリング用語は、オブジェクトに一致しません (つまり、no-op でもあります)。

requiredDuringSchedulingIgnoredDuringExecution

object

このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (更新など)、システムは最終的に Pod をノードから退避しようとする場合としない場合があります。

説明
スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードが対応する matchExpressions と一致する場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。
array
説明
空の優先スケジューリング用語は、暗黙の重み 0 を持つすべてのオブジェクトに一致します (つまり、操作なしです)。null の優先スケジューリング用語は、オブジェクトに一致しません (つまり、no-op でもあります)。
object
必須
  • preference
  • weight
Expand
プロパティー説明

preference

object

対応する重みに関連付けられたノードセレクター用語。

weight

integer

対応する nodeSelectorTerm の一致に関連する重み (1〜100 の範囲)。

説明
対応する重みに関連付けられたノードセレクター用語。
object
Expand
プロパティー説明

matchExpressions

array

ノードのラベルごとのノードセレクター要件のリスト。

matchExpressions[]

object

ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchFields

array

ノードのフィールドごとのノードセレクター要件のリスト。

matchFields[]

object

ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

説明
ノードのラベルごとのノードセレクター要件のリスト。
array
説明
ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

セレクターが適用されるラベルキー。

operator

string

キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。

values

array (string)

文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

説明
ノードのフィールドごとのノードセレクター要件のリスト。
array
説明
ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

セレクターが適用されるラベルキー。

operator

string

キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。

values

array (string)

文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

説明
このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (更新など)、システムは最終的に Pod をノードから退避しようとする場合としない場合があります。
object
必須
  • nodeSelectorTerms
Expand
プロパティー説明

nodeSelectorTerms

array

必須。ノードセレクター用語のリスト。用語は OR されています。

nodeSelectorTerms[]

object

null または空のノードセレクター用語はオブジェクトに一致しません。これらの要件は AND で結合されます。TopologySelectorTerm タイプは、NodeSelectorTerm のサブセットを実装します。

説明
必須。ノードセレクター用語のリスト。用語は OR されています。
array
説明
null または空のノードセレクター用語はオブジェクトに一致しません。これらの要件は AND で結合されます。TopologySelectorTerm タイプは、NodeSelectorTerm のサブセットを実装します。
object
Expand
プロパティー説明

matchExpressions

array

ノードのラベルごとのノードセレクター要件のリスト。

matchExpressions[]

object

ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchFields

array

ノードのフィールドごとのノードセレクター要件のリスト。

matchFields[]

object

ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

説明
ノードのラベルごとのノードセレクター要件のリスト。
array
説明
ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

セレクターが適用されるラベルキー。

operator

string

キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。

values

array (string)

文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

説明
ノードのフィールドごとのノードセレクター要件のリスト。
array
説明
ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

セレクターが適用されるラベルキー。

operator

string

キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。

values

array (string)

文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

5.1.79. .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity

説明
Pod アフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置します)。
object
Expand
プロパティー説明

preferredDuringSchedulingIgnoredDuringExecution

array

スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードに対応する podAffinityTerm に一致する Pod がある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。

preferredDuringSchedulingIgnoredDuringExecution[]

object

一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。

requiredDuringSchedulingIgnoredDuringExecution

array

このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから退避しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。

requiredDuringSchedulingIgnoredDuringExecution[]

object

この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。

説明
スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードに対応する podAffinityTerm に一致する Pod がある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。
array
説明
一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。
object
必須
  • podAffinityTerm
  • weight
Expand
プロパティー説明

podAffinityTerm

object

必須。対応する重みに関連付けられた Pod アフィニティー用語。

weight

integer

対応する podAffinityTerm の一致に関連する重み (1〜100 の範囲)。

説明
必須。対応する重みに関連付けられた Pod アフィニティー用語。
object
必須
  • topologyKey
Expand
プロパティー説明

labelSelector

object

リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。

matchLabelKeys

array (string)

MatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは key in (value) として labelSelector にマージされ、着信 Pod の Pod アフィニティー (アンチアフィニティー) として考慮される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。デフォルト値は空です。matchLabelKeys と labelSelector の両方に同じキーが存在することは禁止されています。また、labelSelector が設定されていない場合、matchLabelKeys は設定できません。

mismatchLabelKeys

array (string)

MismatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは key notin (value) として labelSelector にマージされ、着信 Pod の Pod アフィニティー (アンチアフィニティー) として考慮される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。デフォルト値は空です。mismatchLabelKeys と labelSelector の両方に同じキーが存在することは禁止されています。また、labelSelector が設定されていない場合、mismatchLabelKeys は設定できません。

namespaceSelector

object

用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。

namespaces

array (string)

namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび null namespaceSelector は、"この Pod の namespace" を意味します

topologyKey

string

この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。

説明
リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

説明
用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

説明
このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから退避しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。
array
説明
この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。
object
必須
  • topologyKey
Expand
プロパティー説明

labelSelector

object

リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。

matchLabelKeys

array (string)

MatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは key in (value) として labelSelector にマージされ、着信 Pod の Pod アフィニティー (アンチアフィニティー) として考慮される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。デフォルト値は空です。matchLabelKeys と labelSelector の両方に同じキーが存在することは禁止されています。また、labelSelector が設定されていない場合、matchLabelKeys は設定できません。

mismatchLabelKeys

array (string)

MismatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは key notin (value) として labelSelector にマージされ、着信 Pod の Pod アフィニティー (アンチアフィニティー) として考慮される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。デフォルト値は空です。mismatchLabelKeys と labelSelector の両方に同じキーが存在することは禁止されています。また、labelSelector が設定されていない場合、mismatchLabelKeys は設定できません。

namespaceSelector

object

用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。

namespaces

array (string)

namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび null namespaceSelector は、"この Pod の namespace" を意味します

topologyKey

string

この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。

説明
リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

説明
用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

5.1.97. .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity

説明
Pod のアンチアフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置しないでください)。
object
Expand
プロパティー説明

preferredDuringSchedulingIgnoredDuringExecution

array

スケジューラーは、このフィールドで指定されたアンチアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アンチアフィニティー式など) を満たすノードごとに、の要素を反復処理して合計を計算します。このフィールドと、対応する podAffinityTerm に一致する Pod がノードにある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。

preferredDuringSchedulingIgnoredDuringExecution[]

object

一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。

requiredDuringSchedulingIgnoredDuringExecution

array

このフィールドで指定されたアンチアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアンチアフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから退避しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。

requiredDuringSchedulingIgnoredDuringExecution[]

object

この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。

説明
スケジューラーは、このフィールドで指定されたアンチアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アンチアフィニティー式など) を満たすノードごとに、の要素を反復処理して合計を計算します。このフィールドと、対応する podAffinityTerm に一致する Pod がノードにある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。
array
説明
一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。
object
必須
  • podAffinityTerm
  • weight
Expand
プロパティー説明

podAffinityTerm

object

必須。対応する重みに関連付けられた Pod アフィニティー用語。

weight

integer

対応する podAffinityTerm の一致に関連する重み (1〜100 の範囲)。

説明
必須。対応する重みに関連付けられた Pod アフィニティー用語。
object
必須
  • topologyKey
Expand
プロパティー説明

labelSelector

object

リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。

matchLabelKeys

array (string)

MatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは key in (value) として labelSelector にマージされ、着信 Pod の Pod アフィニティー (アンチアフィニティー) として考慮される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。デフォルト値は空です。matchLabelKeys と labelSelector の両方に同じキーが存在することは禁止されています。また、labelSelector が設定されていない場合、matchLabelKeys は設定できません。

mismatchLabelKeys

array (string)

MismatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは key notin (value) として labelSelector にマージされ、着信 Pod の Pod アフィニティー (アンチアフィニティー) として考慮される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。デフォルト値は空です。mismatchLabelKeys と labelSelector の両方に同じキーが存在することは禁止されています。また、labelSelector が設定されていない場合、mismatchLabelKeys は設定できません。

namespaceSelector

object

用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。

namespaces

array (string)

namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび null namespaceSelector は、"この Pod の namespace" を意味します

topologyKey

string

この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。

説明
リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

説明
用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

説明
このフィールドで指定されたアンチアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアンチアフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから退避しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。
array
説明
この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。
object
必須
  • topologyKey
Expand
プロパティー説明

labelSelector

object

リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。

matchLabelKeys

array (string)

MatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは key in (value) として labelSelector にマージされ、着信 Pod の Pod アフィニティー (アンチアフィニティー) として考慮される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。デフォルト値は空です。matchLabelKeys と labelSelector の両方に同じキーが存在することは禁止されています。また、labelSelector が設定されていない場合、matchLabelKeys は設定できません。

mismatchLabelKeys

array (string)

MismatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは key notin (value) として labelSelector にマージされ、着信 Pod の Pod アフィニティー (アンチアフィニティー) として考慮される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。デフォルト値は空です。mismatchLabelKeys と labelSelector の両方に同じキーが存在することは禁止されています。また、labelSelector が設定されていない場合、mismatchLabelKeys は設定できません。

namespaceSelector

object

用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。

namespaces

array (string)

namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび null namespaceSelector は、"この Pod の namespace" を意味します

topologyKey

string

この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。

説明
リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

説明
用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

5.1.115. .spec.install.spec.deployments[].spec.template.spec.containers

説明
Pod に属するコンテナーのリスト。現在、コンテナーを追加または削除することはできません。Pod には少なくとも 1 つのコンテナーが必要です。これは更新できません。
array

5.1.116. .spec.install.spec.deployments[].spec.template.spec.containers[]

説明
Pod 内で実行する単一のアプリケーションコンテナー。
object
必須
  • name
Expand
プロパティー説明

args

array (string)

エントリーポイントへの引数。これが指定されていない場合は、コンテナーイメージの CMD が使用されます。変数参照 $(VAR_NAME) は、コンテナーの環境を使用して展開されます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。これは更新できません。詳細: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

command

array (string)

エントリーポイント配列。シェル内では実行されません。これが指定されていない場合は、コンテナーイメージの ENTRYPOINT が使用されます。変数参照 $(VAR_NAME) は、コンテナーの環境を使用して展開されます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。これは更新できません。詳細: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

env

array

コンテナーに設定する環境変数のリスト。これは更新できません。

env[]

object

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

envFrom

array

コンテナー内の環境変数に入力するソースのリスト。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。これは更新できません。

envFrom[]

object

EnvFromSource は ConfigMap または Secret のセットのソースを表します

image

string

コンテナーイメージ名詳細: https://kubernetes.io/docs/concepts/containers/images このフィールドはオプションであり、高レベルの設定管理で、Deployments や StatefulSets などのワークロードコントローラーのコンテナーイメージをデフォルトまたはオーバーライドできます。

imagePullPolicy

string

イメージプルポリシーAlways、Never、IfNotPresent のいずれか。デフォルトは、:latest タグが指定されている場合は常に、それ以外の場合は IfNotPresent です。これは更新できません。詳細: https://kubernetes.io/docs/concepts/containers/images#updating-images

lifecycle

object

コンテナーのライフサイクルイベントに対応して管理システムが実行する必要のあるアクション。これは更新できません。

livenessProbe

object

コンテナーの活性度の定期的な調査。プローブが失敗した場合、コンテナーは再起動されます。これは更新できません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

name

string

DNS_LABEL として指定されたコンテナーの名前。Pod 内の各コンテナーには、一意の名前 (DNS_LABEL) が必要です。これは更新できません。

ports

array

コンテナーから公開するポートのリスト。ここでポートを指定しなくても、そのポートが公開されるのを防ぐことはできません。コンテナー内のデフォルトの "0.0.0.0" アドレスをリッスンしているポートは、ネットワークからアクセスできます。戦略的マージパッチを使用してこの配列を変更すると、データが破損する可能性があります。詳細は、https://github.com/kubernetes/kubernetes/issues/108255 を参照してください。これは更新できません。

ports[]

object

ContainerPort は、単一のコンテナー内のネットワークポートを表します。

readinessProbe

object

コンテナーサービスの準備状況の定期的な調査。プローブが失敗すると、コンテナーはサービスエンドポイントから削除されます。これは更新できません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

resizePolicy

array

コンテナーのリソースサイズ変更ポリシー。

resizePolicy[]

object

ContainerResizePolicy は、コンテナーのリソースサイズ変更ポリシーを表します。

resources

object

このコンテナーに必要なコンピューティングリソース。これは更新できません。詳細: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

restartPolicy

string

RestartPolicy は、Pod 内の個々のコンテナーの再起動動作を定義します。このフィールドは init コンテナーに対してのみ設定でき、許可される値は "Always" のみです。init 以外のコンテナーの場合、またはこのフィールドが指定されていない場合、再起動の動作は Pod の再起動ポリシーとコンテナータイプによって定義されます。init コンテナーの RestartPolicy を "Always" に設定すると、次の効果が得られます: この init コンテナーは、すべての通常のコンテナーが終了するまで、終了時に継続的に再起動されます。すべての通常のコンテナーが完了すると、restartPolicy が "Always" のすべての init コンテナーがシャットダウンされます。このライフサイクルは通常の init コンテナーとは異なり、多くの場合、"sidecar" コンテナーと呼ばれます。この init コンテナーは、引き続き init コンテナーシーケンス内で開始されますが、次の init コンテナーに進む前にコンテナーが完了するのを待機しません。代わりに、この init コンテナーが起動した直後、または任意の startupProbe が正常に完了した後に、次の init コンテナーが起動します。

securityContext

object

SecurityContext は、コンテナーを実行する必要があるセキュリティーオプションを定義します。設定されている場合、SecurityContext のフィールドは PodSecurityContext の同等のフィールドをオーバーライドします。詳細: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

startupProbe

object

StartupProbe は、Pod が正常に初期化されたことを示します。指定した場合、これが正常に完了するまで、他のプローブは実行されません。このプローブが失敗すると、livenessProbe が失敗したかのように、Pod が再起動されます。これは、Pod のライフサイクルの開始時に、定常状態の操作中よりもデータのロードやキャッシュのウォームアップに長い時間がかかる可能性がある場合に、さまざまなプローブパラメーターを提供するために使用できます。これは更新できません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

stdin

boolean

このコンテナーがコンテナーランタイムで stdin にバッファーを割り当てる必要があるかどうか。これが設定されていない場合、コンテナー内の stdin からの読み取りは常に EOF になります。デフォルトは false です。

stdinOnce

boolean

コンテナーランタイムが、単一の接続によって開かれた後に stdin チャネルを閉じる必要があるかどうか。stdin が true の場合、stdin ストリームは複数の接続セッションにわたって開いたままになります。stdinOnce が true に設定されている場合、stdin はコンテナーの起動時に開かれ、最初のクライアントが stdin に接続するまで空になり、クライアントが切断されるまで開いたままでデータを受け入れます。切断されると、stdin は閉じられ、コンテナーが再起動されるまで閉じられたままになります。。このフラグが false の場合、stdin から読み取るコンテナープロセスは EOF を受信しません。デフォルトは false です。

terminationMessagePath

string

オプション: コンテナーの終了メッセージが書き込まれるファイルがコンテナーのファイルシステムにマウントされるパス。書き込まれるメッセージは、アサーション失敗メッセージなどの簡単な最終ステータスを目的としています。4096 バイトを超える場合、ノードによって切り捨てられます。すべてのコンテナーの合計メッセージ長は 12kb に制限されます。デフォルトは/dev/termination-log です。これは更新できません。

terminationMessagePolicy

string

終了メッセージの入力方法を示します。ファイルは、terminationMessagePath の内容を使用して、成功と失敗の両方でコンテナーステータスメッセージを入力します。終了メッセージファイルが空で、コンテナーがエラーで終了した場合、FallbackToLogsOnError はコンテナーログ出力の最後のチャンクを使用します。ログ出力は、2048 バイトまたは 80 行のいずれか小さい方に制限されます。デフォルトは File です。これは更新できません。

tty

boolean

このコンテナーがそれ自体に TTY を割り当てる必要があるかどうかには、'stdin' が true である必要もあります。デフォルトは false です。

volumeDevices

array

volumeDevices は、コンテナーによって使用されるブロックデバイスのリストです。

volumeDevices[]

object

volumeDevice は、コンテナー内の raw ブロックデバイスのマッピングを記述します。

volumeMounts

array

コンテナーのファイルシステムにマウントする Pod ボリューム。これは更新できません。

volumeMounts[]

object

VolumeMount は、コンテナー内でのボリュームのマウントを説明します。

workingDir

string

コンテナーの作業ディレクトリー。指定しない場合、コンテナーランタイムのデフォルトが使用されます。これは、コンテナーイメージで設定されている可能性があります。これは更新できません。

5.1.117. .spec.install.spec.deployments[].spec.template.spec.containers[].env

説明
コンテナーに設定する環境変数のリスト。これは更新できません。
array

5.1.118. .spec.install.spec.deployments[].spec.template.spec.containers[].env[]

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

name

string

環境変数の名前。C_IDENTIFIER である必要があります。

value

string

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

valueFrom

object

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

5.1.119. .spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom

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

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 の namespace でシークレットのキーを選択します。

5.1.120. .spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom.configMapKeyRef

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

key

string

選択するキー。

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

5.1.121. .spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom.fieldRef

説明
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 バージョンで選択するフィールドのパス。

5.1.122. .spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom.resourceFieldRef

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

containerName

string

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

divisor

integer-or-string

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

resource

string

必須: 選択するリソース

5.1.123. .spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom.secretKeyRef

説明
Pod の namespace でシークレットのキーを選択します。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

5.1.124. .spec.install.spec.deployments[].spec.template.spec.containers[].envFrom

説明
コンテナー内の環境変数に入力するソースのリスト。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。これは更新できません。
array

5.1.125. .spec.install.spec.deployments[].spec.template.spec.containers[].envFrom[]

説明
EnvFromSource は ConfigMap または Secret のセットのソースを表します
object
Expand
プロパティー説明

configMapRef

object

選択する ConfigMap

prefix

string

各環境変数の名前の先頭に追加するオプションのテキスト。C_IDENTIFIER である必要があります。

secretRef

object

から選択する秘密

5.1.126. .spec.install.spec.deployments[].spec.template.spec.containers[].envFrom[].configMapRef

説明
選択する ConfigMap
object
Expand
プロパティー説明

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

ConfigMap を定義する必要があるかどうかを指定します

5.1.127. .spec.install.spec.deployments[].spec.template.spec.containers[].envFrom[].secretRef

説明
から選択する秘密
object
Expand
プロパティー説明

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

5.1.128. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle

説明
コンテナーのライフサイクルイベントに対応して管理システムが実行する必要のあるアクション。これは更新できません。
object
Expand
プロパティー説明

postStart

object

PostStart は、コンテナーが作成された直後に呼び出されます。ハンドラーに障害が発生した場合、コンテナーは終了し、再始動ポリシーに従って再始動されます。フックが完了するまでのコンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

preStop

object

PreStop は、API リクエスト、または活性/起動プローブの失敗、プリエンプション、リソース競合などの管理イベントが原因でコンテナーが終了する直前に呼び出されます。コンテナーがクラッシュまたは終了した場合、ハンドラーは呼び出されません。Pod の終了猶予期間のカウントダウンは、PreStop フックが実行される前に開始されます。ハンドラーの結果に関係なく、コンテナーは最終的に Pod の終了猶予期間内に終了します (ファイナライザーによって遅延されない限り)。フックが完了するまで、または終了猶予期間に達するまで、コンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

stopSignal

string

stopSignal は、コンテナーが停止される際にコンテナーに送信されるシグナルを定義します。指定しない場合は、使用中のコンテナーランタイムによってデフォルトが定義されます。stopSignal は、空でない .spec.os.name を持つ Pod にのみ設定できます。

5.1.129. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart

説明
PostStart は、コンテナーが作成された直後に呼び出されます。ハンドラーに障害が発生した場合、コンテナーは終了し、再始動ポリシーに従って再始動されます。フックが完了するまでのコンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
object
Expand
プロパティー説明

exec

object

Exec はコンテナー内で実行するコマンドを指定します。

httpGet

object

HTTPGet は、実行する HTTP GET 要求を指定します。

sleep

object

Sleep は、コンテナーがスリープ状態になる期間を表します。

tcpSocket

object

非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、指定している場合は実行時にライフサイクルフックが失敗します。

5.1.130. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.exec

説明
Exec はコンテナー内で実行するコマンドを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

5.1.131. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.httpGet

説明
HTTPGet は、実行する HTTP GET 要求を指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。

httpHeaders

array

リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。

httpHeaders[]

object

HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します

path

string

HTTP サーバーでアクセスするパス。

port

integer-or-string

コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

scheme

string

ホストへの接続に使用するスキーム。デフォルトは HTTP です。

5.1.132. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

5.1.133. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名。これは出力時に正規化されるため、大文字/小文字の名前は同じヘッダーとして認識されます。

value

string

ヘッダーフィールド値

5.1.134. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.sleep

説明
Sleep は、コンテナーがスリープ状態になる期間を表します。
object
必須
  • seconds
Expand
プロパティー説明

seconds

integer

Seconds はスリープする秒数です。

5.1.135. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.tcpSocket

説明
非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、指定している場合は実行時にライフサイクルフックが失敗します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

5.1.136. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop

説明
PreStop は、API リクエスト、または活性/起動プローブの失敗、プリエンプション、リソース競合などの管理イベントが原因でコンテナーが終了する直前に呼び出されます。コンテナーがクラッシュまたは終了した場合、ハンドラーは呼び出されません。Pod の終了猶予期間のカウントダウンは、PreStop フックが実行される前に開始されます。ハンドラーの結果に関係なく、コンテナーは最終的に Pod の終了猶予期間内に終了します (ファイナライザーによって遅延されない限り)。フックが完了するまで、または終了猶予期間に達するまで、コンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
object
Expand
プロパティー説明

exec

object

Exec はコンテナー内で実行するコマンドを指定します。

httpGet

object

HTTPGet は、実行する HTTP GET 要求を指定します。

sleep

object

Sleep は、コンテナーがスリープ状態になる期間を表します。

tcpSocket

object

非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、指定している場合は実行時にライフサイクルフックが失敗します。

5.1.137. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.exec

説明
Exec はコンテナー内で実行するコマンドを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

5.1.138. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.httpGet

説明
HTTPGet は、実行する HTTP GET 要求を指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。

httpHeaders

array

リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。

httpHeaders[]

object

HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します

path

string

HTTP サーバーでアクセスするパス。

port

integer-or-string

コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

scheme

string

ホストへの接続に使用するスキーム。デフォルトは HTTP です。

5.1.139. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

5.1.140. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名。これは出力時に正規化されるため、大文字/小文字の名前は同じヘッダーとして認識されます。

value

string

ヘッダーフィールド値

5.1.141. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.sleep

説明
Sleep は、コンテナーがスリープ状態になる期間を表します。
object
必須
  • seconds
Expand
プロパティー説明

seconds

integer

Seconds はスリープする秒数です。

5.1.142. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.tcpSocket

説明
非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、指定している場合は実行時にライフサイクルフックが失敗します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

5.1.143. .spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe

説明
コンテナーの活性度の定期的な調査。プローブが失敗した場合、コンテナーは再起動されます。これは更新できません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
object
Expand
プロパティー説明

exec

object

Exec はコンテナー内で実行するコマンドを指定します。

failureThreshold

integer

正常に実行された後に失敗とみなされるプローブの連続失敗回数の最小値。デフォルトは 3 です。最小値は 1 です。

grpc

object

GRPC は GRPC HealthCheckRequest を指定します。

httpGet

object

HTTPGet は、実行する HTTP GET 要求を指定します。

initialDelaySeconds

integer

コンテナーが起動してから liveness プローブが開始されるまでの秒数。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

periodSeconds

integer

プローブを実行する頻度 (秒単位)。デフォルトは 10 秒です。最小値は 1 です。

successThreshold

integer

失敗後に、プローブが正常とみなされるための最小の連続成功回数。デフォルトは 1 です。活気と起動のために 1 でなければなりません。最小値は 1 です。

tcpSocket

object

TCPSocket は TCP ポートへの接続を指定します。

terminationGracePeriodSeconds

integer

プローブの障害時に Pod がグレースフルに終了する必要がある秒単位のオプションの期間。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。この値が nil の場合、Pod の terminationGracePeriodSeconds が使用されます。それ以外の場合、この値は Pod 仕様によって提供される値をオーバーライドします。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。これはベータフィールドであり、ProbeTerminationGracePeriod 機能ゲートを有効にする必要があります。最小値は 1 です。未設定の場合は spec.terminationGracePeriodSeconds が使用されます。

timeoutSeconds

integer

プローブがタイムアウトするまでの秒数。デフォルトは 1 秒です。最小値は 1 です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

5.1.144. .spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.exec

説明
Exec はコンテナー内で実行するコマンドを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

5.1.145. .spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.grpc

説明
GRPC は GRPC HealthCheckRequest を指定します。
object
必須
  • port
Expand
プロパティー説明

port

integer

gRPC サービスのポート番号。番号は 1〜65535 の範囲である必要があります。

service

string

Service は、gRPC HealthCheckRequest に配置するサービスの名前です (https://github.com/grpc/grpc/blob/master/doc/health-checking.md を参照)。

これが指定されていない場合、デフォルトの動作は gRPC によって定義されます。

5.1.146. .spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.httpGet

説明
HTTPGet は、実行する HTTP GET 要求を指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。

httpHeaders

array

リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。

httpHeaders[]

object

HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します

path

string

HTTP サーバーでアクセスするパス。

port

integer-or-string

コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

scheme

string

ホストへの接続に使用するスキーム。デフォルトは HTTP です。

5.1.147. .spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

5.1.148. .spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名。これは出力時に正規化されるため、大文字/小文字の名前は同じヘッダーとして認識されます。

value

string

ヘッダーフィールド値

5.1.149. .spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.tcpSocket

説明
TCPSocket は TCP ポートへの接続を指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

5.1.150. .spec.install.spec.deployments[].spec.template.spec.containers[].ports

説明
コンテナーから公開するポートのリスト。ここでポートを指定しなくても、そのポートが公開されるのを防ぐことはできません。コンテナー内のデフォルトの "0.0.0.0" アドレスをリッスンしているポートは、ネットワークからアクセスできます。戦略的マージパッチを使用してこの配列を変更すると、データが破損する可能性があります。詳細は、https://github.com/kubernetes/kubernetes/issues/108255 を参照してください。これは更新できません。
array

5.1.151. .spec.install.spec.deployments[].spec.template.spec.containers[].ports[]

説明
ContainerPort は、単一のコンテナー内のネットワークポートを表します。
object
必須
  • containerPort
Expand
プロパティー説明

containerPort

integer

Pod の IP アドレスで公開するポートの数。これは有効なポート番号である必要があります、0<x<65536。

hostIP

string

外部ポートをバインドするホスト IP。

hostPort

integer

ホストで公開するポートの数。指定する場合、これは有効なポート番号、0<x<65536 である必要があります。HostNetwork が指定されている場合、これは ContainerPort と一致する必要があります。ほとんどのコンテナーはこれを必要としません。

name

string

指定する場合、これは IANA_SVC_NAME であり、Pod 内で一意である必要があります。Pod 内の名前付きポートにはそれぞれ一意の名前を付ける必要があります。サービスが参照できるポートの名前。

protocol

string

ポートのプロトコル。UDP、TCP、または SCTP である必要があります。デフォルトは "TCP" です。

5.1.152. .spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe

説明
コンテナーサービスの準備状況の定期的な調査。プローブが失敗すると、コンテナーはサービスエンドポイントから削除されます。これは更新できません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
object
Expand
プロパティー説明

exec

object

Exec はコンテナー内で実行するコマンドを指定します。

failureThreshold

integer

正常に実行された後に失敗とみなされるプローブの連続失敗回数の最小値。デフォルトは 3 です。最小値は 1 です。

grpc

object

GRPC は GRPC HealthCheckRequest を指定します。

httpGet

object

HTTPGet は、実行する HTTP GET 要求を指定します。

initialDelaySeconds

integer

コンテナーが起動してから liveness プローブが開始されるまでの秒数。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

periodSeconds

integer

プローブを実行する頻度 (秒単位)。デフォルトは 10 秒です。最小値は 1 です。

successThreshold

integer

失敗後に、プローブが正常とみなされるための最小の連続成功回数。デフォルトは 1 です。活気と起動のために 1 でなければなりません。最小値は 1 です。

tcpSocket

object

TCPSocket は TCP ポートへの接続を指定します。

terminationGracePeriodSeconds

integer

プローブの障害時に Pod がグレースフルに終了する必要がある秒単位のオプションの期間。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。この値が nil の場合、Pod の terminationGracePeriodSeconds が使用されます。それ以外の場合、この値は Pod 仕様によって提供される値をオーバーライドします。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。これはベータフィールドであり、ProbeTerminationGracePeriod 機能ゲートを有効にする必要があります。最小値は 1 です。未設定の場合は spec.terminationGracePeriodSeconds が使用されます。

timeoutSeconds

integer

プローブがタイムアウトするまでの秒数。デフォルトは 1 秒です。最小値は 1 です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

5.1.153. .spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.exec

説明
Exec はコンテナー内で実行するコマンドを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

5.1.154. .spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.grpc

説明
GRPC は GRPC HealthCheckRequest を指定します。
object
必須
  • port
Expand
プロパティー説明

port

integer

gRPC サービスのポート番号。番号は 1〜65535 の範囲である必要があります。

service

string

Service は、gRPC HealthCheckRequest に配置するサービスの名前です (https://github.com/grpc/grpc/blob/master/doc/health-checking.md を参照)。

これが指定されていない場合、デフォルトの動作は gRPC によって定義されます。

5.1.155. .spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.httpGet

説明
HTTPGet は、実行する HTTP GET 要求を指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。

httpHeaders

array

リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。

httpHeaders[]

object

HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します

path

string

HTTP サーバーでアクセスするパス。

port

integer-or-string

コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

scheme

string

ホストへの接続に使用するスキーム。デフォルトは HTTP です。

5.1.156. .spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

5.1.157. .spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名。これは出力時に正規化されるため、大文字/小文字の名前は同じヘッダーとして認識されます。

value

string

ヘッダーフィールド値

5.1.158. .spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.tcpSocket

説明
TCPSocket は TCP ポートへの接続を指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

5.1.159. .spec.install.spec.deployments[].spec.template.spec.containers[].resizePolicy

説明
コンテナーのリソースサイズ変更ポリシー。
array

5.1.160. .spec.install.spec.deployments[].spec.template.spec.containers[].resizePolicy[]

説明
ContainerResizePolicy は、コンテナーのリソースサイズ変更ポリシーを表します。
object
必須
  • resourceName
  • restartPolicy
Expand
プロパティー説明

resourceName

string

このリソースサイズ変更ポリシーが適用されるリソースの名前。対応している値は、cpu、memory です。

restartPolicy

string

指定されたリソースのサイズが変更されたときに適用する再起動ポリシー。指定しない場合、デフォルトの NotRequired が設定されます。

5.1.161. .spec.install.spec.deployments[].spec.template.spec.containers[].resources

説明
このコンテナーに必要なコンピューティングリソース。これは更新できません。詳細: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
object
Expand
プロパティー説明

claims

array

Claims には、spec.resourceClaims で定義され、このコンテナーによって使用されるリソースの名前がリストされます。

これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。

このフィールドは変更不可能です。これはコンテナーにのみ設定できます。

claims[]

object

ResourceClaim は、PodSpec.ResourceClaims 内の 1 つのエントリーを参照します。

limits

integer-or-string

limits は、許可されるコンピュートリソースの最大量を示します。詳細: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

requests は、必要なコンピュートリソースの最小量を示します。コンテナーで Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。リクエストは制限を超えることはできません。詳細: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

5.1.162. .spec.install.spec.deployments[].spec.template.spec.containers[].resources.claims

説明

Claims には、spec.resourceClaims で定義され、このコンテナーによって使用されるリソースの名前がリストされます。

これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。

このフィールドは変更不可能です。これはコンテナーにのみ設定できます。

array

5.1.163. .spec.install.spec.deployments[].spec.template.spec.containers[].resources.claims[]

説明
ResourceClaim は、PodSpec.ResourceClaims 内の 1 つのエントリーを参照します。
object
必須
  • name
Expand
プロパティー説明

name

string

name は、このフィールドが使用される Pod の pod.spec.resourceClaims に含まれる、1 つのエントリーの名前と一致する必要があります。これにより、そのリソースがコンテナー内で利用可能になります。

request

string

request は、参照されるクレーム内のリクエストに対して選択された名前です。空の場合、クレームからのすべてのものが利用可能になり、それ以外の場合はこの request の結果のみが利用可能になります。

5.1.164. .spec.install.spec.deployments[].spec.template.spec.containers[].securityContext

説明
SecurityContext は、コンテナーを実行する必要があるセキュリティーオプションを定義します。設定されている場合、SecurityContext のフィールドは PodSecurityContext の同等のフィールドをオーバーライドします。詳細: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
object
Expand
プロパティー説明

allowPrivilegeEscalation

boolean

AllowPrivilegeEscalation は、プロセスがその親プロセスよりも多くの特権を取得できるかどうかを制御します。このブール値は、no_new_privs フラグがコンテナープロセスに設定されるかどうかを直接制御します。コンテナーが 1) 特権で実行されており、CAP_SYS_ADMIN が割り当てられている場合、2) AllowPrivilegeEscalation は常に true です。spec.os.name が windows の場合は、このフィールドは設定できないことに注意してください。

appArmorProfile

object

appArmorProfile は、このコンテナーで使用する AppArmor オプションです。設定されている場合、このプロファイルによって Pod の appArmorProfile がオーバーライドされます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

capabilities

object

コンテナーの実行時に追加/削除する機能。デフォルトは、コンテナーランタイムによって付与されるデフォルトの機能セットです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

privileged

boolean

コンテナーを特権モードで実行します。特権コンテナー内のプロセスは、基本的にホスト上の root と同等です。デフォルトは false です。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

procMount

string

procMount は、コンテナーに使用する proc マウントのタイプを示します。デフォルト値は Default で、読み取り専用パスおよびマスクされたパスのコンテナーランタイムのデフォルトを使用します。これには、ProcMountType 機能フラグを有効にする必要があります。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

readOnlyRootFilesystem

boolean

このコンテナーに読み取り専用のルートファイルシステムがあるかどうか。デフォルトは false です。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

runAsGroup

integer

コンテナープロセスのエントリーポイントを実行するための GID。設定されていない場合は、実行時のデフォルトを使用します。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

runAsNonRoot

boolean

コンテナーが root 以外のユーザーとして実行される必要があることを示します。true の場合、Kubelet は実行時にイメージを検証して、イメージが UID 0(ルート) として実行されないことを確認し、実行される場合はコンテナーの開始に失敗します。未設定または false の場合、そのような検証は実行されません。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。

runAsUser

integer

コンテナープロセスのエントリーポイントを実行するための UID。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

seLinuxOptions

object

コンテナーに適用される SELinux コンテキスト。指定しない場合、コンテナーランタイムはコンテナーごとにランダムな SELinux コンテキストを割り当てます。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

seccompProfile

object

このコンテナーで使用する seccomp オプション。Pod とコンテナーの両方のレベルで seccomp オプションが提供されている場合、コンテナーオプションは Pod オプションをオーバーライドします。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

windowsOptions

object

すべてのコンテナーに適用される Windows 固有の設定。指定しない場合、PodSecurityContext のオプションが使用されます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が linux の場合は、このフィールドを設定できないことに注意してください。

5.1.165. .spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.appArmorProfile

説明
appArmorProfile は、このコンテナーで使用する AppArmor オプションです。設定されている場合、このプロファイルによって Pod の appArmorProfile がオーバーライドされます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
object
必須
  • type
Expand
プロパティー説明

localhostProfile

string

localhostProfile は、使用する必要があるノードにロードされたプロファイルを示します。プロファイルが機能するには、ノードで事前に設定されている必要があります。プロファイルのロードされた名前と一致する必要があります。タイプが "Localhost" の場合にのみ設定する必要があります。

type

string

type は、適用される AppArmor プロファイルの種類を示します。有効なオプション: Localhost - ノードに事前にロードされたプロファイル。RuntimeDefault - コンテナーランタイムのデフォルトのプロファイル。制限なし - AppArmor の強制はありません。

5.1.166. .spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.capabilities

説明
コンテナーの実行時に追加/削除する機能。デフォルトは、コンテナーランタイムによって付与されるデフォルトの機能セットです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
object
Expand
プロパティー説明

add

array (string)

追加された機能

drop

array (string)

削除された機能

5.1.167. .spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.seLinuxOptions

説明
コンテナーに適用される SELinux コンテキスト。指定しない場合、コンテナーランタイムはコンテナーごとにランダムな SELinux コンテキストを割り当てます。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
object
Expand
プロパティー説明

level

string

Level は、コンテナーに適用される SELinux レベルのラベルです。

role

string

Role は、コンテナーに適用される SELinux ロールラベルです。

type

string

Type は、コンテナーに適用される SELinux タイプのラベルです。

user

string

User は、コンテナーに適用される SELinux ユーザーラベルです。

5.1.168. .spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.seccompProfile

説明
このコンテナーで使用する seccomp オプション。Pod とコンテナーの両方のレベルで seccomp オプションが提供されている場合、コンテナーオプションは Pod オプションをオーバーライドします。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
object
必須
  • type
Expand
プロパティー説明

localhostProfile

string

localhostProfile は、ノード上のファイルで定義されたプロファイルを使用する必要があることを示します。プロファイルが機能するには、ノードで事前に設定されている必要があります。kubelet の設定済みの seccomp プロファイルの場所を基準にして、降順のパスである必要があります。タイプが "Localhost" の場合は設定する必要があります。他のタイプには設定しないでください。

type

string

type は、適用される seccomp プロファイルの種類を示します。有効なオプションは以下のとおりです。

Localhost - ノード上のファイルで定義されたプロファイルを使用する必要があります。RuntimeDefault- コンテナーのランタイムデフォルトプロファイルを使用する必要があります。制限なし - プロファイルを適用しないでください。

5.1.169. .spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.windowsOptions

説明
すべてのコンテナーに適用される Windows 固有の設定。指定しない場合、PodSecurityContext のオプションが使用されます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が linux の場合は、このフィールドを設定できないことに注意してください。
object
Expand
プロパティー説明

gmsaCredentialSpec

string

GMSACredentialSpec は、GMSA アドミッション Webhook (https://github.com/kubernetes-sigs/windows-gmsa) が GMSACredentialSpecName フィールドで指定された GMSA クレデンシャル仕様のコンテンツをインライン化する場所です。

gmsaCredentialSpecName

string

GMSACredentialSpecName は、使用する GMSA 認証情報仕様の名前です。

hostProcess

boolean

hostProcess は、コンテナーを 'Host Process' コンテナーとして実行する必要があるかどうかを決定します。Pod のすべてのコンテナーは、同じ有効な HostProcess 値を持っている必要があります (HostProcess コンテナーと非 HostProcess コンテナーを混在させることはできません)。さらに、HostProcess が true の場合、HostNetwork も true に設定する必要があります。

runAsUserName

string

コンテナープロセスのエントリーポイントを実行するための Windows の UserName。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。

5.1.170. .spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe

説明
StartupProbe は、Pod が正常に初期化されたことを示します。指定した場合、これが正常に完了するまで、他のプローブは実行されません。このプローブが失敗すると、livenessProbe が失敗したかのように、Pod が再起動されます。これは、Pod のライフサイクルの開始時に、定常状態の操作中よりもデータのロードやキャッシュのウォームアップに長い時間がかかる可能性がある場合に、さまざまなプローブパラメーターを提供するために使用できます。これは更新できません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
object
Expand
プロパティー説明

exec

object

Exec はコンテナー内で実行するコマンドを指定します。

failureThreshold

integer

正常に実行された後に失敗とみなされるプローブの連続失敗回数の最小値。デフォルトは 3 です。最小値は 1 です。

grpc

object

GRPC は GRPC HealthCheckRequest を指定します。

httpGet

object

HTTPGet は、実行する HTTP GET 要求を指定します。

initialDelaySeconds

integer

コンテナーが起動してから liveness プローブが開始されるまでの秒数。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

periodSeconds

integer

プローブを実行する頻度 (秒単位)。デフォルトは 10 秒です。最小値は 1 です。

successThreshold

integer

失敗後に、プローブが正常とみなされるための最小の連続成功回数。デフォルトは 1 です。活気と起動のために 1 でなければなりません。最小値は 1 です。

tcpSocket

object

TCPSocket は TCP ポートへの接続を指定します。

terminationGracePeriodSeconds

integer

プローブの障害時に Pod がグレースフルに終了する必要がある秒単位のオプションの期間。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。この値が nil の場合、Pod の terminationGracePeriodSeconds が使用されます。それ以外の場合、この値は Pod 仕様によって提供される値をオーバーライドします。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。これはベータフィールドであり、ProbeTerminationGracePeriod 機能ゲートを有効にする必要があります。最小値は 1 です。未設定の場合は spec.terminationGracePeriodSeconds が使用されます。

timeoutSeconds

integer

プローブがタイムアウトするまでの秒数。デフォルトは 1 秒です。最小値は 1 です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

5.1.171. .spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.exec

説明
Exec はコンテナー内で実行するコマンドを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

5.1.172. .spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.grpc

説明
GRPC は GRPC HealthCheckRequest を指定します。
object
必須
  • port
Expand
プロパティー説明

port

integer

gRPC サービスのポート番号。番号は 1〜65535 の範囲である必要があります。

service

string

Service は、gRPC HealthCheckRequest に配置するサービスの名前です (https://github.com/grpc/grpc/blob/master/doc/health-checking.md を参照)。

これが指定されていない場合、デフォルトの動作は gRPC によって定義されます。

5.1.173. .spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.httpGet

説明
HTTPGet は、実行する HTTP GET 要求を指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。

httpHeaders

array

リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。

httpHeaders[]

object

HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します

path

string

HTTP サーバーでアクセスするパス。

port

integer-or-string

コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

scheme

string

ホストへの接続に使用するスキーム。デフォルトは HTTP です。

5.1.174. .spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

5.1.175. .spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名。これは出力時に正規化されるため、大文字/小文字の名前は同じヘッダーとして認識されます。

value

string

ヘッダーフィールド値

5.1.176. .spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.tcpSocket

説明
TCPSocket は TCP ポートへの接続を指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

5.1.177. .spec.install.spec.deployments[].spec.template.spec.containers[].volumeDevices

説明
volumeDevices は、コンテナーによって使用されるブロックデバイスのリストです。
array

5.1.178. .spec.install.spec.deployments[].spec.template.spec.containers[].volumeDevices[]

説明
volumeDevice は、コンテナー内の raw ブロックデバイスのマッピングを記述します。
object
必須
  • devicePath
  • name
Expand
プロパティー説明

devicePath

string

devicePath は、デバイスがマップされるコンテナー内のパスです。

name

string

name は、Pod 内の persistentVolumeClaim の名前と一致する必要があります

5.1.179. .spec.install.spec.deployments[].spec.template.spec.containers[].volumeMounts

説明
コンテナーのファイルシステムにマウントする Pod ボリューム。これは更新できません。
array

5.1.180. .spec.install.spec.deployments[].spec.template.spec.containers[].volumeMounts[]

説明
VolumeMount は、コンテナー内でのボリュームのマウントを説明します。
object
必須
  • mountPath
  • name
Expand
プロパティー説明

mountPath

string

ボリュームをマウントする必要があるコンテナー内のパス。':' を含めることはできません。

mountPropagation

string

mountPropagation は、マウントがホストからコンテナーに、またはその逆にどのように伝播されるかを決定します。設定されていない場合、MountPropagationNone が使用されます。このフィールドは 1.10 のベータ版です。RecursiveReadOnly が IfPossible または Enabled に設定されている場合、MountPropagation は None または未指定 (デフォルトは None) にする必要があります。

name

string

ボリュームの名前に一致する必要があります。

readOnly

boolean

true の場合は読み取り専用、それ以外の場合は読み取り/書き込み (false または指定なし) でマウントされます。デフォルトは false です。

recursiveReadOnly

string

RecursiveReadOnly は、読み取り専用マウントを再帰的に処理するかどうかを指定します。

ReadOnly が false の場合、このフィールドには意味がなく、未指定にする必要があります。

ReadOnly が true で、このフィールドが Disabled に設定されている場合、マウントは再帰的に読み取り専用にはなりません。このフィールドが IfPossible に設定されている場合、コンテナーランタイムでサポートされている場合は、マウントは再帰的に読み取り専用になります。このフィールドが Enabled に設定されている場合で、コンテナーランタイムでサポートされている場合は、マウントが再帰的に読み取り専用になり、そうでない場合は Pod が起動されず、理由を示すエラーが生成されます。

このフィールドが IfPossible または Enabled に設定されている場合、MountPropagation は None に設定する必要があります (または未指定にする必要があります。この場合、デフォルトは None になります)。

このフィールドが指定されていない場合は、無効と同じ扱いになります。

subPath

string

コンテナーのボリュームをマウントする必要があるボリューム内のパス。デフォルトは "" (ボリュームのルート) です。

subPathExpr

string

コンテナーのボリュームをマウントする必要があるボリューム内の拡張パス。SubPath と同様に動作しますが、環境変数参照 $(VAR_NAME) は、コンテナーの環境を使用して展開されます。デフォルトは "" (ボリュームのルート) です。SubPathExpr と SubPath は相互に排他的です。

5.1.181. .spec.install.spec.deployments[].spec.template.spec.dnsConfig

説明
Pod の DNS パラメーターを指定します。ここで指定されたパラメーターは、DNSPolicy に基づいて生成された DNS 設定にマージされます。
object
Expand
プロパティー説明

nameservers

array (string)

DNS ネームサーバーの IP アドレスのリスト。これは、DNSPolicy から生成されたベースネームサーバーに追加されます。重複したネームサーバーは削除されます。

options

array

DNS リゾルバーオプションのリスト。これは、DNSPolicy から生成された基本オプションとマージされます。重複したエントリーは削除されます。オプションで指定された解決オプションは、ベース DNSPolicy に表示されるものをオーバーライドします。

options[]

object

PodDNSConfigOption は、Pod の DNS リゾルバーオプションを定義します。

searches

array (string)

ホスト名ルックアップ用の DNS 検索ドメインのリスト。これは、DNSPolicy から生成された基本検索パスに追加されます。重複する検索パスは削除されます。

5.1.182. .spec.install.spec.deployments[].spec.template.spec.dnsConfig.options

説明
DNS リゾルバーオプションのリスト。これは、DNSPolicy から生成された基本オプションとマージされます。重複したエントリーは削除されます。オプションで指定された解決オプションは、ベース DNSPolicy に表示されるものをオーバーライドします。
array

5.1.183. .spec.install.spec.deployments[].spec.template.spec.dnsConfig.options[]

説明
PodDNSConfigOption は、Pod の DNS リゾルバーオプションを定義します。
object
Expand
プロパティー説明

name

string

名前は、この DNS リゾルバーオプションの名前です。必須。

value

string

値は、この DNS リゾルバーオプションの値です。

5.1.184. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers

説明
この Pod で実行されるエフェメラルコンテナーのリスト。エフェメラルコンテナーを既存の Pod で実行して、デバッグなどのユーザーが開始するアクションを実行できます。このリストは、Pod の作成時に指定することはできません。また、Pod の仕様を更新して変更することもできません。エフェメラルコンテナーを既存の Pod に追加するには、Pod のエフェメラルコンテナーサブリソースを使用します。
array

5.1.185. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[]

説明

EphemeralContainer は、デバッグなど、ユーザーが開始したアクティビティーに対して、既存の Pod に追加できる一時コンテナーです。エフェメラルコンテナーにはリソースやスケジュールの保証がなく、コンテナーの終了時、または Pod の削除または再起動時に再起動されません。エフェメラルコンテナーが原因で Pod がリソース割り当てを超過した場合、kubelet は Pod を退避する可能性があります。

エフェメラルコンテナーを追加するには、既存の Pod の ephemeralcontainers サブリソースを使用します。エフェメラルコンテナーは削除または再起動できません。

object
必須
  • name
Expand
プロパティー説明

args

array (string)

エントリーポイントへの引数。このプロパティが指定されていない場合は、イメージの CMD が使用されます。変数参照 $(VAR_NAME) は、コンテナーの環境を使用して展開されます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。これは更新できません。詳細: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

command

array (string)

エントリーポイント配列。シェル内では実行されません。これが指定されていない場合は、イメージの ENTRYPOINT が使用されます。変数参照 $(VAR_NAME) は、コンテナーの環境を使用して展開されます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。これは更新できません。詳細: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

env

array

コンテナーに設定する環境変数のリスト。これは更新できません。

env[]

object

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

envFrom

array

コンテナー内の環境変数に入力するソースのリスト。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。これは更新できません。

envFrom[]

object

EnvFromSource は ConfigMap または Secret のセットのソースを表します

image

string

コンテナーイメージ名詳細: https://kubernetes.io/docs/concepts/containers/images

imagePullPolicy

string

イメージプルポリシーAlways、Never、IfNotPresent のいずれか。デフォルトは、:latest タグが指定されている場合は常に、それ以外の場合は IfNotPresent です。これは更新できません。詳細: https://kubernetes.io/docs/concepts/containers/images#updating-images

lifecycle

object

エフェメラルコンテナーのライフサイクルは許可されていません。

livenessProbe

object

一時的なコンテナーにはプローブを使用できません。

name

string

DNS_LABEL として指定されたエフェメラルコンテナーの名前。この名前は、すべてのコンテナー、init コンテナー、およびエフェメラルコンテナーの中で一意である必要があります。

ports

array

エフェメラルコンテナーのポートは許可されていません。

ports[]

object

ContainerPort は、単一のコンテナー内のネットワークポートを表します。

readinessProbe

object

一時的なコンテナーにはプローブを使用できません。

resizePolicy

array

コンテナーのリソースサイズ変更ポリシー。

resizePolicy[]

object

ContainerResizePolicy は、コンテナーのリソースサイズ変更ポリシーを表します。

resources

object

エフェメラルコンテナーのリソースは許可されていません。エフェメラルコンテナーは、Pod にすでに割り当てられているスペアリソースを使用します。

restartPolicy

string

Pod 内の各コンテナーの再起動動作を管理するためのコンテナーの再起動ポリシー。これは init コンテナーに対してのみ設定できます。このフィールドは一時コンテナーには設定できません。

securityContext

object

オプション:SecurityContext は、エフェメラルコンテナーを実行する必要があるセキュリティーオプションを定義します。設定されている場合、SecurityContext のフィールドは PodSecurityContext の同等のフィールドをオーバーライドします。

startupProbe

object

一時的なコンテナーにはプローブを使用できません。

stdin

boolean

このコンテナーがコンテナーランタイムで stdin にバッファーを割り当てる必要があるかどうか。これが設定されていない場合、コンテナー内の stdin からの読み取りは常に EOF になります。デフォルトは false です。

stdinOnce

boolean

コンテナーランタイムが、単一の接続によって開かれた後に stdin チャネルを閉じる必要があるかどうか。stdin が true の場合、stdin ストリームは複数の接続セッションにわたって開いたままになります。stdinOnce が true に設定されている場合、stdin はコンテナーの起動時に開かれ、最初のクライアントが stdin に接続するまで空になり、クライアントが切断されるまで開いたままでデータを受け入れます。切断されると、stdin は閉じられ、コンテナーが再起動されるまで閉じられたままになります。。このフラグが false の場合、stdin から読み取るコンテナープロセスは EOF を受信しません。デフォルトは false です。

targetContainerName

string

設定されている場合、このエフェメラルコンテナーがターゲットとする PodSpec からのコンテナーの名前。エフェメラルコンテナーは、このコンテナーの namespace (IPC、PID など) で実行されます。設定されていない場合、エフェメラルコンテナーは Pod 仕様で設定された namespace を使用します。

コンテナーランタイムは、この機能のサポートを実装する必要があります。ランタイムが namespace ターゲットをサポートしていない場合、このフィールドの設定結果は定義されません。

terminationMessagePath

string

オプション: コンテナーの終了メッセージが書き込まれるファイルがコンテナーのファイルシステムにマウントされるパス。書き込まれるメッセージは、アサーション失敗メッセージなどの簡単な最終ステータスを目的としています。4096 バイトを超える場合、ノードによって切り捨てられます。すべてのコンテナーの合計メッセージ長は 12kb に制限されます。デフォルトは/dev/termination-log です。これは更新できません。

terminationMessagePolicy

string

終了メッセージの入力方法を示します。ファイルは、terminationMessagePath の内容を使用して、成功と失敗の両方でコンテナーステータスメッセージを入力します。終了メッセージファイルが空で、コンテナーがエラーで終了した場合、FallbackToLogsOnError はコンテナーログ出力の最後のチャンクを使用します。ログ出力は、2048 バイトまたは 80 行のいずれか小さい方に制限されます。デフォルトは File です。これは更新できません。

tty

boolean

このコンテナーがそれ自体に TTY を割り当てる必要があるかどうかには、'stdin' が true である必要もあります。デフォルトは false です。

volumeDevices

array

volumeDevices は、コンテナーによって使用されるブロックデバイスのリストです。

volumeDevices[]

object

volumeDevice は、コンテナー内の raw ブロックデバイスのマッピングを記述します。

volumeMounts

array

コンテナーのファイルシステムにマウントする Pod ボリューム。エフェメラルコンテナーでは、サブパスをマウントできません。これは更新できません。

volumeMounts[]

object

VolumeMount は、コンテナー内でのボリュームのマウントを説明します。

workingDir

string

コンテナーの作業ディレクトリー。指定しない場合、コンテナーランタイムのデフォルトが使用されます。これは、コンテナーイメージで設定されている可能性があります。これは更新できません。

5.1.186. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env

説明
コンテナーに設定する環境変数のリスト。これは更新できません。
array

5.1.187. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[]

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

name

string

環境変数の名前。C_IDENTIFIER である必要があります。

value

string

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

valueFrom

object

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

5.1.188. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom

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

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 の namespace でシークレットのキーを選択します。

5.1.189. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom.configMapKeyRef

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

key

string

選択するキー。

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

5.1.190. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom.fieldRef

説明
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 バージョンで選択するフィールドのパス。

5.1.191. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom.resourceFieldRef

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

containerName

string

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

divisor

integer-or-string

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

resource

string

必須: 選択するリソース

5.1.192. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom.secretKeyRef

説明
Pod の namespace でシークレットのキーを選択します。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

5.1.193. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].envFrom

説明
コンテナー内の環境変数に入力するソースのリスト。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。これは更新できません。
array

5.1.194. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].envFrom[]

説明
EnvFromSource は ConfigMap または Secret のセットのソースを表します
object
Expand
プロパティー説明

configMapRef

object

選択する ConfigMap

prefix

string

各環境変数の名前の先頭に追加するオプションのテキスト。C_IDENTIFIER である必要があります。

secretRef

object

から選択する秘密

5.1.195. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].envFrom[].configMapRef

説明
選択する ConfigMap
object
Expand
プロパティー説明

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

ConfigMap を定義する必要があるかどうかを指定します

5.1.196. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].envFrom[].secretRef

説明
から選択する秘密
object
Expand
プロパティー説明

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

5.1.197. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle

説明
エフェメラルコンテナーのライフサイクルは許可されていません。
object
Expand
プロパティー説明

postStart

object

PostStart は、コンテナーが作成された直後に呼び出されます。ハンドラーに障害が発生した場合、コンテナーは終了し、再始動ポリシーに従って再始動されます。フックが完了するまでのコンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

preStop

object

PreStop は、API リクエスト、または活性/起動プローブの失敗、プリエンプション、リソース競合などの管理イベントが原因でコンテナーが終了する直前に呼び出されます。コンテナーがクラッシュまたは終了した場合、ハンドラーは呼び出されません。Pod の終了猶予期間のカウントダウンは、PreStop フックが実行される前に開始されます。ハンドラーの結果に関係なく、コンテナーは最終的に Pod の終了猶予期間内に終了します (ファイナライザーによって遅延されない限り)。フックが完了するまで、または終了猶予期間に達するまで、コンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

stopSignal

string

stopSignal は、コンテナーが停止される際にコンテナーに送信されるシグナルを定義します。指定しない場合は、使用中のコンテナーランタイムによってデフォルトが定義されます。stopSignal は、空でない .spec.os.name を持つ Pod にのみ設定できます。

5.1.198. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart

説明
PostStart は、コンテナーが作成された直後に呼び出されます。ハンドラーに障害が発生した場合、コンテナーは終了し、再始動ポリシーに従って再始動されます。フックが完了するまでのコンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
object
Expand
プロパティー説明

exec

object

Exec はコンテナー内で実行するコマンドを指定します。

httpGet

object

HTTPGet は、実行する HTTP GET 要求を指定します。

sleep

object

Sleep は、コンテナーがスリープ状態になる期間を表します。

tcpSocket

object

非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、指定している場合は実行時にライフサイクルフックが失敗します。

5.1.199. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.exec

説明
Exec はコンテナー内で実行するコマンドを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

5.1.200. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.httpGet

説明
HTTPGet は、実行する HTTP GET 要求を指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。

httpHeaders

array

リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。

httpHeaders[]

object

HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します

path

string

HTTP サーバーでアクセスするパス。

port

integer-or-string

コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

scheme

string

ホストへの接続に使用するスキーム。デフォルトは HTTP です。

5.1.201. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array
説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名。これは出力時に正規化されるため、大文字/小文字の名前は同じヘッダーとして認識されます。

value

string

ヘッダーフィールド値

5.1.203. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.sleep

説明
Sleep は、コンテナーがスリープ状態になる期間を表します。
object
必須
  • seconds
Expand
プロパティー説明

seconds

integer

Seconds はスリープする秒数です。

5.1.204. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.tcpSocket

説明
非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、指定している場合は実行時にライフサイクルフックが失敗します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

5.1.205. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop

説明
PreStop は、API リクエスト、または活性/起動プローブの失敗、プリエンプション、リソース競合などの管理イベントが原因でコンテナーが終了する直前に呼び出されます。コンテナーがクラッシュまたは終了した場合、ハンドラーは呼び出されません。Pod の終了猶予期間のカウントダウンは、PreStop フックが実行される前に開始されます。ハンドラーの結果に関係なく、コンテナーは最終的に Pod の終了猶予期間内に終了します (ファイナライザーによって遅延されない限り)。フックが完了するまで、または終了猶予期間に達するまで、コンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
object
Expand
プロパティー説明

exec

object

Exec はコンテナー内で実行するコマンドを指定します。

httpGet

object

HTTPGet は、実行する HTTP GET 要求を指定します。

sleep

object

Sleep は、コンテナーがスリープ状態になる期間を表します。

tcpSocket

object

非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、指定している場合は実行時にライフサイクルフックが失敗します。

5.1.206. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.exec

説明
Exec はコンテナー内で実行するコマンドを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

5.1.207. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.httpGet

説明
HTTPGet は、実行する HTTP GET 要求を指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。

httpHeaders

array

リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。

httpHeaders[]

object

HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します

path

string

HTTP サーバーでアクセスするパス。

port

integer-or-string

コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

scheme

string

ホストへの接続に使用するスキーム。デフォルトは HTTP です。

5.1.208. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

5.1.209. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名。これは出力時に正規化されるため、大文字/小文字の名前は同じヘッダーとして認識されます。

value

string

ヘッダーフィールド値

5.1.210. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.sleep

説明
Sleep は、コンテナーがスリープ状態になる期間を表します。
object
必須
  • seconds
Expand
プロパティー説明

seconds

integer

Seconds はスリープする秒数です。

5.1.211. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.tcpSocket

説明
非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、指定している場合は実行時にライフサイクルフックが失敗します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

5.1.212. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe

説明
一時的なコンテナーにはプローブを使用できません。
object
Expand
プロパティー説明

exec

object

Exec はコンテナー内で実行するコマンドを指定します。

failureThreshold

integer

正常に実行された後に失敗とみなされるプローブの連続失敗回数の最小値。デフォルトは 3 です。最小値は 1 です。

grpc

object

GRPC は GRPC HealthCheckRequest を指定します。

httpGet

object

HTTPGet は、実行する HTTP GET 要求を指定します。

initialDelaySeconds

integer

コンテナーが起動してから liveness プローブが開始されるまでの秒数。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

periodSeconds

integer

プローブを実行する頻度 (秒単位)。デフォルトは 10 秒です。最小値は 1 です。

successThreshold

integer

失敗後に、プローブが正常とみなされるための最小の連続成功回数。デフォルトは 1 です。活気と起動のために 1 でなければなりません。最小値は 1 です。

tcpSocket

object

TCPSocket は TCP ポートへの接続を指定します。

terminationGracePeriodSeconds

integer

プローブの障害時に Pod がグレースフルに終了する必要がある秒単位のオプションの期間。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。この値が nil の場合、Pod の terminationGracePeriodSeconds が使用されます。それ以外の場合、この値は Pod 仕様によって提供される値をオーバーライドします。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。これはベータフィールドであり、ProbeTerminationGracePeriod 機能ゲートを有効にする必要があります。最小値は 1 です。未設定の場合は spec.terminationGracePeriodSeconds が使用されます。

timeoutSeconds

integer

プローブがタイムアウトするまでの秒数。デフォルトは 1 秒です。最小値は 1 です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

5.1.213. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.exec

説明
Exec はコンテナー内で実行するコマンドを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

5.1.214. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.grpc

説明
GRPC は GRPC HealthCheckRequest を指定します。
object
必須
  • port
Expand
プロパティー説明

port

integer

gRPC サービスのポート番号。番号は 1〜65535 の範囲である必要があります。

service

string

Service は、gRPC HealthCheckRequest に配置するサービスの名前です (https://github.com/grpc/grpc/blob/master/doc/health-checking.md を参照)。

これが指定されていない場合、デフォルトの動作は gRPC によって定義されます。

5.1.215. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.httpGet

説明
HTTPGet は、実行する HTTP GET 要求を指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。

httpHeaders

array

リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。

httpHeaders[]

object

HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します

path

string

HTTP サーバーでアクセスするパス。

port

integer-or-string

コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

scheme

string

ホストへの接続に使用するスキーム。デフォルトは HTTP です。

5.1.216. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

5.1.217. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名。これは出力時に正規化されるため、大文字/小文字の名前は同じヘッダーとして認識されます。

value

string

ヘッダーフィールド値

5.1.218. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.tcpSocket

説明
TCPSocket は TCP ポートへの接続を指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

5.1.219. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].ports

説明
エフェメラルコンテナーのポートは許可されていません。
array

5.1.220. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].ports[]

説明
ContainerPort は、単一のコンテナー内のネットワークポートを表します。
object
必須
  • containerPort
Expand
プロパティー説明

containerPort

integer

Pod の IP アドレスで公開するポートの数。これは有効なポート番号である必要があります、0<x<65536。

hostIP

string

外部ポートをバインドするホスト IP。

hostPort

integer

ホストで公開するポートの数。指定する場合、これは有効なポート番号、0<x<65536 である必要があります。HostNetwork が指定されている場合、これは ContainerPort と一致する必要があります。ほとんどのコンテナーはこれを必要としません。

name

string

指定する場合、これは IANA_SVC_NAME であり、Pod 内で一意である必要があります。Pod 内の名前付きポートにはそれぞれ一意の名前を付ける必要があります。サービスが参照できるポートの名前。

protocol

string

ポートのプロトコル。UDP、TCP、または SCTP である必要があります。デフォルトは "TCP" です。

5.1.221. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe

説明
一時的なコンテナーにはプローブを使用できません。
object
Expand
プロパティー説明

exec

object

Exec はコンテナー内で実行するコマンドを指定します。

failureThreshold

integer

正常に実行された後に失敗とみなされるプローブの連続失敗回数の最小値。デフォルトは 3 です。最小値は 1 です。

grpc

object

GRPC は GRPC HealthCheckRequest を指定します。

httpGet

object

HTTPGet は、実行する HTTP GET 要求を指定します。

initialDelaySeconds

integer

コンテナーが起動してから liveness プローブが開始されるまでの秒数。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

periodSeconds

integer

プローブを実行する頻度 (秒単位)。デフォルトは 10 秒です。最小値は 1 です。

successThreshold

integer

失敗後に、プローブが正常とみなされるための最小の連続成功回数。デフォルトは 1 です。活気と起動のために 1 でなければなりません。最小値は 1 です。

tcpSocket

object

TCPSocket は TCP ポートへの接続を指定します。

terminationGracePeriodSeconds

integer

プローブの障害時に Pod がグレースフルに終了する必要がある秒単位のオプションの期間。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。この値が nil の場合、Pod の terminationGracePeriodSeconds が使用されます。それ以外の場合、この値は Pod 仕様によって提供される値をオーバーライドします。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。これはベータフィールドであり、ProbeTerminationGracePeriod 機能ゲートを有効にする必要があります。最小値は 1 です。未設定の場合は spec.terminationGracePeriodSeconds が使用されます。

timeoutSeconds

integer

プローブがタイムアウトするまでの秒数。デフォルトは 1 秒です。最小値は 1 です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

5.1.222. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.exec

説明
Exec はコンテナー内で実行するコマンドを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

5.1.223. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.grpc

説明
GRPC は GRPC HealthCheckRequest を指定します。
object
必須
  • port
Expand
プロパティー説明

port

integer

gRPC サービスのポート番号。番号は 1〜65535 の範囲である必要があります。

service

string

Service は、gRPC HealthCheckRequest に配置するサービスの名前です (https://github.com/grpc/grpc/blob/master/doc/health-checking.md を参照)。

これが指定されていない場合、デフォルトの動作は gRPC によって定義されます。

5.1.224. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.httpGet

説明
HTTPGet は、実行する HTTP GET 要求を指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。

httpHeaders

array

リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。

httpHeaders[]

object

HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します

path

string

HTTP サーバーでアクセスするパス。

port

integer-or-string

コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

scheme

string

ホストへの接続に使用するスキーム。デフォルトは HTTP です。

5.1.225. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

5.1.226. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名。これは出力時に正規化されるため、大文字/小文字の名前は同じヘッダーとして認識されます。

value

string

ヘッダーフィールド値

5.1.227. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.tcpSocket

説明
TCPSocket は TCP ポートへの接続を指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

5.1.228. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].resizePolicy

説明
コンテナーのリソースサイズ変更ポリシー。
array

5.1.229. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].resizePolicy[]

説明
ContainerResizePolicy は、コンテナーのリソースサイズ変更ポリシーを表します。
object
必須
  • resourceName
  • restartPolicy
Expand
プロパティー説明

resourceName

string

このリソースサイズ変更ポリシーが適用されるリソースの名前。対応している値は、cpu、memory です。

restartPolicy

string

指定されたリソースのサイズが変更されたときに適用する再起動ポリシー。指定しない場合、デフォルトの NotRequired が設定されます。

5.1.230. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].resources

説明
エフェメラルコンテナーのリソースは許可されていません。エフェメラルコンテナーは、Pod にすでに割り当てられているスペアリソースを使用します。
object
Expand
プロパティー説明

claims

array

Claims には、spec.resourceClaims で定義され、このコンテナーによって使用されるリソースの名前がリストされます。

これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。

このフィールドは変更不可能です。これはコンテナーにのみ設定できます。

claims[]

object

ResourceClaim は、PodSpec.ResourceClaims 内の 1 つのエントリーを参照します。

limits

integer-or-string

limits は、許可されるコンピュートリソースの最大量を示します。詳細: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

requests は、必要なコンピュートリソースの最小量を示します。コンテナーで Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。リクエストは制限を超えることはできません。詳細: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

5.1.231. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].resources.claims

説明

Claims には、spec.resourceClaims で定義され、このコンテナーによって使用されるリソースの名前がリストされます。

これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。

このフィールドは変更不可能です。これはコンテナーにのみ設定できます。

array

5.1.232. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].resources.claims[]

説明
ResourceClaim は、PodSpec.ResourceClaims 内の 1 つのエントリーを参照します。
object
必須
  • name
Expand
プロパティー説明

name

string

name は、このフィールドが使用される Pod の pod.spec.resourceClaims に含まれる、1 つのエントリーの名前と一致する必要があります。これにより、そのリソースがコンテナー内で利用可能になります。

request

string

request は、参照されるクレーム内のリクエストに対して選択された名前です。空の場合、クレームからのすべてのものが利用可能になり、それ以外の場合はこの request の結果のみが利用可能になります。

5.1.233. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext

説明
オプション:SecurityContext は、エフェメラルコンテナーを実行する必要があるセキュリティーオプションを定義します。設定されている場合、SecurityContext のフィールドは PodSecurityContext の同等のフィールドをオーバーライドします。
object
Expand
プロパティー説明

allowPrivilegeEscalation

boolean

AllowPrivilegeEscalation は、プロセスがその親プロセスよりも多くの特権を取得できるかどうかを制御します。このブール値は、no_new_privs フラグがコンテナープロセスに設定されるかどうかを直接制御します。コンテナーが 1) 特権で実行されており、CAP_SYS_ADMIN が割り当てられている場合、2) AllowPrivilegeEscalation は常に true です。spec.os.name が windows の場合は、このフィールドは設定できないことに注意してください。

appArmorProfile

object

appArmorProfile は、このコンテナーで使用する AppArmor オプションです。設定されている場合、このプロファイルによって Pod の appArmorProfile がオーバーライドされます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

capabilities

object

コンテナーの実行時に追加/削除する機能。デフォルトは、コンテナーランタイムによって付与されるデフォルトの機能セットです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

privileged

boolean

コンテナーを特権モードで実行します。特権コンテナー内のプロセスは、基本的にホスト上の root と同等です。デフォルトは false です。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

procMount

string

procMount は、コンテナーに使用する proc マウントのタイプを示します。デフォルト値は Default で、読み取り専用パスおよびマスクされたパスのコンテナーランタイムのデフォルトを使用します。これには、ProcMountType 機能フラグを有効にする必要があります。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

readOnlyRootFilesystem

boolean

このコンテナーに読み取り専用のルートファイルシステムがあるかどうか。デフォルトは false です。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

runAsGroup

integer

コンテナープロセスのエントリーポイントを実行するための GID。設定されていない場合は、実行時のデフォルトを使用します。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

runAsNonRoot

boolean

コンテナーが root 以外のユーザーとして実行される必要があることを示します。true の場合、Kubelet は実行時にイメージを検証して、イメージが UID 0(ルート) として実行されないことを確認し、実行される場合はコンテナーの開始に失敗します。未設定または false の場合、そのような検証は実行されません。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。

runAsUser

integer

コンテナープロセスのエントリーポイントを実行するための UID。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

seLinuxOptions

object

コンテナーに適用される SELinux コンテキスト。指定しない場合、コンテナーランタイムはコンテナーごとにランダムな SELinux コンテキストを割り当てます。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

seccompProfile

object

このコンテナーで使用する seccomp オプション。Pod とコンテナーの両方のレベルで seccomp オプションが提供されている場合、コンテナーオプションは Pod オプションをオーバーライドします。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

windowsOptions

object

すべてのコンテナーに適用される Windows 固有の設定。指定しない場合、PodSecurityContext のオプションが使用されます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が linux の場合は、このフィールドを設定できないことに注意してください。

5.1.234. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.appArmorProfile

説明
appArmorProfile は、このコンテナーで使用する AppArmor オプションです。設定されている場合、このプロファイルによって Pod の appArmorProfile がオーバーライドされます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
object
必須
  • type
Expand
プロパティー説明

localhostProfile

string

localhostProfile は、使用する必要があるノードにロードされたプロファイルを示します。プロファイルが機能するには、ノードで事前に設定されている必要があります。プロファイルのロードされた名前と一致する必要があります。タイプが "Localhost" の場合にのみ設定する必要があります。

type

string

type は、適用される AppArmor プロファイルの種類を示します。有効なオプション: Localhost - ノードに事前にロードされたプロファイル。RuntimeDefault - コンテナーランタイムのデフォルトのプロファイル。制限なし - AppArmor の強制はありません。

5.1.235. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.capabilities

説明
コンテナーの実行時に追加/削除する機能。デフォルトは、コンテナーランタイムによって付与されるデフォルトの機能セットです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
object
Expand
プロパティー説明

add

array (string)

追加された機能

drop

array (string)

削除された機能

5.1.236. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.seLinuxOptions

説明
コンテナーに適用される SELinux コンテキスト。指定しない場合、コンテナーランタイムはコンテナーごとにランダムな SELinux コンテキストを割り当てます。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
object
Expand
プロパティー説明

level

string

Level は、コンテナーに適用される SELinux レベルのラベルです。

role

string

Role は、コンテナーに適用される SELinux ロールラベルです。

type

string

Type は、コンテナーに適用される SELinux タイプのラベルです。

user

string

User は、コンテナーに適用される SELinux ユーザーラベルです。

5.1.237. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.seccompProfile

説明
このコンテナーで使用する seccomp オプション。Pod とコンテナーの両方のレベルで seccomp オプションが提供されている場合、コンテナーオプションは Pod オプションをオーバーライドします。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
object
必須
  • type
Expand
プロパティー説明

localhostProfile

string

localhostProfile は、ノード上のファイルで定義されたプロファイルを使用する必要があることを示します。プロファイルが機能するには、ノードで事前に設定されている必要があります。kubelet の設定済みの seccomp プロファイルの場所を基準にして、降順のパスである必要があります。タイプが "Localhost" の場合は設定する必要があります。他のタイプには設定しないでください。

type

string

type は、適用される seccomp プロファイルの種類を示します。有効なオプションは以下のとおりです。

Localhost - ノード上のファイルで定義されたプロファイルを使用する必要があります。RuntimeDefault- コンテナーのランタイムデフォルトプロファイルを使用する必要があります。制限なし - プロファイルを適用しないでください。

5.1.238. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.windowsOptions

説明
すべてのコンテナーに適用される Windows 固有の設定。指定しない場合、PodSecurityContext のオプションが使用されます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が linux の場合は、このフィールドを設定できないことに注意してください。
object
Expand
プロパティー説明

gmsaCredentialSpec

string

GMSACredentialSpec は、GMSA アドミッション Webhook (https://github.com/kubernetes-sigs/windows-gmsa) が GMSACredentialSpecName フィールドで指定された GMSA クレデンシャル仕様のコンテンツをインライン化する場所です。

gmsaCredentialSpecName

string

GMSACredentialSpecName は、使用する GMSA 認証情報仕様の名前です。

hostProcess

boolean

hostProcess は、コンテナーを 'Host Process' コンテナーとして実行する必要があるかどうかを決定します。Pod のすべてのコンテナーは、同じ有効な HostProcess 値を持っている必要があります (HostProcess コンテナーと非 HostProcess コンテナーを混在させることはできません)。さらに、HostProcess が true の場合、HostNetwork も true に設定する必要があります。

runAsUserName

string

コンテナープロセスのエントリーポイントを実行するための Windows の UserName。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。

5.1.239. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe

説明
一時的なコンテナーにはプローブを使用できません。
object
Expand
プロパティー説明

exec

object

Exec はコンテナー内で実行するコマンドを指定します。

failureThreshold

integer

正常に実行された後に失敗とみなされるプローブの連続失敗回数の最小値。デフォルトは 3 です。最小値は 1 です。

grpc

object

GRPC は GRPC HealthCheckRequest を指定します。

httpGet

object

HTTPGet は、実行する HTTP GET 要求を指定します。

initialDelaySeconds

integer

コンテナーが起動してから liveness プローブが開始されるまでの秒数。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

periodSeconds

integer

プローブを実行する頻度 (秒単位)。デフォルトは 10 秒です。最小値は 1 です。

successThreshold

integer

失敗後に、プローブが正常とみなされるための最小の連続成功回数。デフォルトは 1 です。活気と起動のために 1 でなければなりません。最小値は 1 です。

tcpSocket

object

TCPSocket は TCP ポートへの接続を指定します。

terminationGracePeriodSeconds

integer

プローブの障害時に Pod がグレースフルに終了する必要がある秒単位のオプションの期間。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。この値が nil の場合、Pod の terminationGracePeriodSeconds が使用されます。それ以外の場合、この値は Pod 仕様によって提供される値をオーバーライドします。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。これはベータフィールドであり、ProbeTerminationGracePeriod 機能ゲートを有効にする必要があります。最小値は 1 です。未設定の場合は spec.terminationGracePeriodSeconds が使用されます。

timeoutSeconds

integer

プローブがタイムアウトするまでの秒数。デフォルトは 1 秒です。最小値は 1 です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

5.1.240. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.exec

説明
Exec はコンテナー内で実行するコマンドを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

5.1.241. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.grpc

説明
GRPC は GRPC HealthCheckRequest を指定します。
object
必須
  • port
Expand
プロパティー説明

port

integer

gRPC サービスのポート番号。番号は 1〜65535 の範囲である必要があります。

service

string

Service は、gRPC HealthCheckRequest に配置するサービスの名前です (https://github.com/grpc/grpc/blob/master/doc/health-checking.md を参照)。

これが指定されていない場合、デフォルトの動作は gRPC によって定義されます。

5.1.242. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.httpGet

説明
HTTPGet は、実行する HTTP GET 要求を指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。

httpHeaders

array

リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。

httpHeaders[]

object

HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します

path

string

HTTP サーバーでアクセスするパス。

port

integer-or-string

コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

scheme

string

ホストへの接続に使用するスキーム。デフォルトは HTTP です。

5.1.243. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

5.1.244. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名。これは出力時に正規化されるため、大文字/小文字の名前は同じヘッダーとして認識されます。

value

string

ヘッダーフィールド値

5.1.245. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.tcpSocket

説明
TCPSocket は TCP ポートへの接続を指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

5.1.246. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].volumeDevices

説明
volumeDevices は、コンテナーによって使用されるブロックデバイスのリストです。
array

5.1.247. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].volumeDevices[]

説明
volumeDevice は、コンテナー内の raw ブロックデバイスのマッピングを記述します。
object
必須
  • devicePath
  • name
Expand
プロパティー説明

devicePath

string

devicePath は、デバイスがマップされるコンテナー内のパスです。

name

string

name は、Pod 内の persistentVolumeClaim の名前と一致する必要があります

5.1.248. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].volumeMounts

説明
コンテナーのファイルシステムにマウントする Pod ボリューム。エフェメラルコンテナーでは、サブパスをマウントできません。これは更新できません。
array

5.1.249. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].volumeMounts[]

説明
VolumeMount は、コンテナー内でのボリュームのマウントを説明します。
object
必須
  • mountPath
  • name
Expand
プロパティー説明

mountPath

string

ボリュームをマウントする必要があるコンテナー内のパス。':' を含めることはできません。

mountPropagation

string

mountPropagation は、マウントがホストからコンテナーに、またはその逆にどのように伝播されるかを決定します。設定されていない場合、MountPropagationNone が使用されます。このフィールドは 1.10 のベータ版です。RecursiveReadOnly が IfPossible または Enabled に設定されている場合、MountPropagation は None または未指定 (デフォルトは None) にする必要があります。

name

string

ボリュームの名前に一致する必要があります。

readOnly

boolean

true の場合は読み取り専用、それ以外の場合は読み取り/書き込み (false または指定なし) でマウントされます。デフォルトは false です。

recursiveReadOnly

string

RecursiveReadOnly は、読み取り専用マウントを再帰的に処理するかどうかを指定します。

ReadOnly が false の場合、このフィールドには意味がなく、未指定にする必要があります。

ReadOnly が true で、このフィールドが Disabled に設定されている場合、マウントは再帰的に読み取り専用にはなりません。このフィールドが IfPossible に設定されている場合、コンテナーランタイムでサポートされている場合は、マウントは再帰的に読み取り専用になります。このフィールドが Enabled に設定されている場合で、コンテナーランタイムでサポートされている場合は、マウントが再帰的に読み取り専用になり、そうでない場合は Pod が起動されず、理由を示すエラーが生成されます。

このフィールドが IfPossible または Enabled に設定されている場合、MountPropagation は None に設定する必要があります (または未指定にする必要があります。この場合、デフォルトは None になります)。

このフィールドが指定されていない場合は、無効と同じ扱いになります。

subPath

string

コンテナーのボリュームをマウントする必要があるボリューム内のパス。デフォルトは "" (ボリュームのルート) です。

subPathExpr

string

コンテナーのボリュームをマウントする必要があるボリューム内の拡張パス。SubPath と同様に動作しますが、環境変数参照 $(VAR_NAME) は、コンテナーの環境を使用して展開されます。デフォルトは "" (ボリュームのルート) です。SubPathExpr と SubPath は相互に排他的です。

5.1.250. .spec.install.spec.deployments[].spec.template.spec.hostAliases

説明
HostAliases は、指定された場合に Pod の hosts ファイルに注入されるホストおよび IP のオプションのリストです。
array

5.1.251. .spec.install.spec.deployments[].spec.template.spec.hostAliases[]

説明
HostAlias は、Pod の hosts ファイルのエントリーとして注入される IP とホスト名の間のマッピングを保持します。
object
必須
  • ip
Expand
プロパティー説明

hostnames

array (string)

上記の IP アドレスのホスト名。

ip

string

ホストファイルエントリーの IP アドレス。

5.1.252. .spec.install.spec.deployments[].spec.template.spec.imagePullSecrets

説明
ImagePullSecrets は、この PodSpec で使用されるイメージをプルするために使用する、同じ namespace 内のシークレットへの参照のオプションのリストです。指定されている場合、これらのシークレットは、使用するために個々のプラー実装に渡されます。詳細: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
array

5.1.253. .spec.install.spec.deployments[].spec.template.spec.imagePullSecrets[]

説明
LocalObjectReference には、同じ namespace 内で参照オブジェクトを見つけるのに十分な情報が含まれます。
object
Expand
プロパティー説明

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

5.1.254. .spec.install.spec.deployments[].spec.template.spec.initContainers

説明
Pod に属する初期化コンテナーのリスト。コンテナーが開始される前に、初期化コンテナーが順番に実行されます。init コンテナーに障害が発生した場合、Pod は障害が発生したと見なされ、restartPolicy に従って処理されます。init コンテナーまたは通常のコンテナーの名前は、すべてのコンテナー間で一意である必要があります。Init コンテナーには、ライフサイクルアクション、準備プローブ、ライブネスプローブ、またはスタートアッププローブがない場合があります。init コンテナーの resourceRequirements は、各リソースタイプの最大の要求/制限を見つけ、その値の最大値または通常のコンテナーの合計を使用することにより、スケジューリング中に考慮されます。同様の方法で、init コンテナーに制限が適用されます。現在、初期化コンテナーを追加または削除することはできません。これは更新できません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
array

5.1.255. .spec.install.spec.deployments[].spec.template.spec.initContainers[]

説明
Pod 内で実行する単一のアプリケーションコンテナー。
object
必須
  • name
Expand
プロパティー説明

args

array (string)

エントリーポイントへの引数。これが指定されていない場合は、コンテナーイメージの CMD が使用されます。変数参照 $(VAR_NAME) は、コンテナーの環境を使用して展開されます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。これは更新できません。詳細: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

command

array (string)

エントリーポイント配列。シェル内では実行されません。これが指定されていない場合は、コンテナーイメージの ENTRYPOINT が使用されます。変数参照 $(VAR_NAME) は、コンテナーの環境を使用して展開されます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。これは更新できません。詳細: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

env

array

コンテナーに設定する環境変数のリスト。これは更新できません。

env[]

object

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

envFrom

array

コンテナー内の環境変数に入力するソースのリスト。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。これは更新できません。

envFrom[]

object

EnvFromSource は ConfigMap または Secret のセットのソースを表します

image

string

コンテナーイメージ名詳細: https://kubernetes.io/docs/concepts/containers/images このフィールドはオプションであり、高レベルの設定管理で、Deployments や StatefulSets などのワークロードコントローラーのコンテナーイメージをデフォルトまたはオーバーライドできます。

imagePullPolicy

string

イメージプルポリシーAlways、Never、IfNotPresent のいずれか。デフォルトは、:latest タグが指定されている場合は常に、それ以外の場合は IfNotPresent です。これは更新できません。詳細: https://kubernetes.io/docs/concepts/containers/images#updating-images

lifecycle

object

コンテナーのライフサイクルイベントに対応して管理システムが実行する必要のあるアクション。これは更新できません。

livenessProbe

object

コンテナーの活性度の定期的な調査。プローブが失敗した場合、コンテナーは再起動されます。これは更新できません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

name

string

DNS_LABEL として指定されたコンテナーの名前。Pod 内の各コンテナーには、一意の名前 (DNS_LABEL) が必要です。これは更新できません。

ports

array

コンテナーから公開するポートのリスト。ここでポートを指定しなくても、そのポートが公開されるのを防ぐことはできません。コンテナー内のデフォルトの "0.0.0.0" アドレスをリッスンしているポートは、ネットワークからアクセスできます。戦略的マージパッチを使用してこの配列を変更すると、データが破損する可能性があります。詳細は、https://github.com/kubernetes/kubernetes/issues/108255 を参照してください。これは更新できません。

ports[]

object

ContainerPort は、単一のコンテナー内のネットワークポートを表します。

readinessProbe

object

コンテナーサービスの準備状況の定期的な調査。プローブが失敗すると、コンテナーはサービスエンドポイントから削除されます。これは更新できません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

resizePolicy

array

コンテナーのリソースサイズ変更ポリシー。

resizePolicy[]

object

ContainerResizePolicy は、コンテナーのリソースサイズ変更ポリシーを表します。

resources

object

このコンテナーに必要なコンピューティングリソース。これは更新できません。詳細: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

restartPolicy

string

RestartPolicy は、Pod 内の個々のコンテナーの再起動動作を定義します。このフィールドは init コンテナーに対してのみ設定でき、許可される値は "Always" のみです。init 以外のコンテナーの場合、またはこのフィールドが指定されていない場合、再起動の動作は Pod の再起動ポリシーとコンテナータイプによって定義されます。init コンテナーの RestartPolicy を "Always" に設定すると、次の効果が得られます: この init コンテナーは、すべての通常のコンテナーが終了するまで、終了時に継続的に再起動されます。すべての通常のコンテナーが完了すると、restartPolicy が "Always" のすべての init コンテナーがシャットダウンされます。このライフサイクルは通常の init コンテナーとは異なり、多くの場合、"sidecar" コンテナーと呼ばれます。この init コンテナーは、引き続き init コンテナーシーケンス内で開始されますが、次の init コンテナーに進む前にコンテナーが完了するのを待機しません。代わりに、この init コンテナーが起動した直後、または任意の startupProbe が正常に完了した後に、次の init コンテナーが起動します。

securityContext

object

SecurityContext は、コンテナーを実行する必要があるセキュリティーオプションを定義します。設定されている場合、SecurityContext のフィールドは PodSecurityContext の同等のフィールドをオーバーライドします。詳細: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

startupProbe

object

StartupProbe は、Pod が正常に初期化されたことを示します。指定した場合、これが正常に完了するまで、他のプローブは実行されません。このプローブが失敗すると、livenessProbe が失敗したかのように、Pod が再起動されます。これは、Pod のライフサイクルの開始時に、定常状態の操作中よりもデータのロードやキャッシュのウォームアップに長い時間がかかる可能性がある場合に、さまざまなプローブパラメーターを提供するために使用できます。これは更新できません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

stdin

boolean

このコンテナーがコンテナーランタイムで stdin にバッファーを割り当てる必要があるかどうか。これが設定されていない場合、コンテナー内の stdin からの読み取りは常に EOF になります。デフォルトは false です。

stdinOnce

boolean

コンテナーランタイムが、単一の接続によって開かれた後に stdin チャネルを閉じる必要があるかどうか。stdin が true の場合、stdin ストリームは複数の接続セッションにわたって開いたままになります。stdinOnce が true に設定されている場合、stdin はコンテナーの起動時に開かれ、最初のクライアントが stdin に接続するまで空になり、クライアントが切断されるまで開いたままでデータを受け入れます。切断されると、stdin は閉じられ、コンテナーが再起動されるまで閉じられたままになります。。このフラグが false の場合、stdin から読み取るコンテナープロセスは EOF を受信しません。デフォルトは false です。

terminationMessagePath

string

オプション: コンテナーの終了メッセージが書き込まれるファイルがコンテナーのファイルシステムにマウントされるパス。書き込まれるメッセージは、アサーション失敗メッセージなどの簡単な最終ステータスを目的としています。4096 バイトを超える場合、ノードによって切り捨てられます。すべてのコンテナーの合計メッセージ長は 12kb に制限されます。デフォルトは/dev/termination-log です。これは更新できません。

terminationMessagePolicy

string

終了メッセージの入力方法を示します。ファイルは、terminationMessagePath の内容を使用して、成功と失敗の両方でコンテナーステータスメッセージを入力します。終了メッセージファイルが空で、コンテナーがエラーで終了した場合、FallbackToLogsOnError はコンテナーログ出力の最後のチャンクを使用します。ログ出力は、2048 バイトまたは 80 行のいずれか小さい方に制限されます。デフォルトは File です。これは更新できません。

tty

boolean

このコンテナーがそれ自体に TTY を割り当てる必要があるかどうかには、'stdin' が true である必要もあります。デフォルトは false です。

volumeDevices

array

volumeDevices は、コンテナーによって使用されるブロックデバイスのリストです。

volumeDevices[]

object

volumeDevice は、コンテナー内の raw ブロックデバイスのマッピングを記述します。

volumeMounts

array

コンテナーのファイルシステムにマウントする Pod ボリューム。これは更新できません。

volumeMounts[]

object

VolumeMount は、コンテナー内でのボリュームのマウントを説明します。

workingDir

string

コンテナーの作業ディレクトリー。指定しない場合、コンテナーランタイムのデフォルトが使用されます。これは、コンテナーイメージで設定されている可能性があります。これは更新できません。

5.1.256. .spec.install.spec.deployments[].spec.template.spec.initContainers[].env

説明
コンテナーに設定する環境変数のリスト。これは更新できません。
array

5.1.257. .spec.install.spec.deployments[].spec.template.spec.initContainers[].env[]

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

name

string

環境変数の名前。C_IDENTIFIER である必要があります。

value

string

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

valueFrom

object

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

5.1.258. .spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom

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

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 の namespace でシークレットのキーを選択します。

5.1.259. .spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom.configMapKeyRef

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

key

string

選択するキー。

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

5.1.260. .spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom.fieldRef

説明
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 バージョンで選択するフィールドのパス。

5.1.261. .spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom.resourceFieldRef

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

containerName

string

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

divisor

integer-or-string

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

resource

string

必須: 選択するリソース

5.1.262. .spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom.secretKeyRef

説明
Pod の namespace でシークレットのキーを選択します。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

5.1.263. .spec.install.spec.deployments[].spec.template.spec.initContainers[].envFrom

説明
コンテナー内の環境変数に入力するソースのリスト。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。これは更新できません。
array

5.1.264. .spec.install.spec.deployments[].spec.template.spec.initContainers[].envFrom[]

説明
EnvFromSource は ConfigMap または Secret のセットのソースを表します
object
Expand
プロパティー説明

configMapRef

object

選択する ConfigMap

prefix

string

各環境変数の名前の先頭に追加するオプションのテキスト。C_IDENTIFIER である必要があります。

secretRef

object

から選択する秘密

5.1.265. .spec.install.spec.deployments[].spec.template.spec.initContainers[].envFrom[].configMapRef

説明
選択する ConfigMap
object
Expand
プロパティー説明

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

ConfigMap を定義する必要があるかどうかを指定します

5.1.266. .spec.install.spec.deployments[].spec.template.spec.initContainers[].envFrom[].secretRef

説明
から選択する秘密
object
Expand
プロパティー説明

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

5.1.267. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle

説明
コンテナーのライフサイクルイベントに対応して管理システムが実行する必要のあるアクション。これは更新できません。
object
Expand
プロパティー説明

postStart

object

PostStart は、コンテナーが作成された直後に呼び出されます。ハンドラーに障害が発生した場合、コンテナーは終了し、再始動ポリシーに従って再始動されます。フックが完了するまでのコンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

preStop

object

PreStop は、API リクエスト、または活性/起動プローブの失敗、プリエンプション、リソース競合などの管理イベントが原因でコンテナーが終了する直前に呼び出されます。コンテナーがクラッシュまたは終了した場合、ハンドラーは呼び出されません。Pod の終了猶予期間のカウントダウンは、PreStop フックが実行される前に開始されます。ハンドラーの結果に関係なく、コンテナーは最終的に Pod の終了猶予期間内に終了します (ファイナライザーによって遅延されない限り)。フックが完了するまで、または終了猶予期間に達するまで、コンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

stopSignal

string

stopSignal は、コンテナーが停止される際にコンテナーに送信されるシグナルを定義します。指定しない場合は、使用中のコンテナーランタイムによってデフォルトが定義されます。stopSignal は、空でない .spec.os.name を持つ Pod にのみ設定できます。

5.1.268. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart

説明
PostStart は、コンテナーが作成された直後に呼び出されます。ハンドラーに障害が発生した場合、コンテナーは終了し、再始動ポリシーに従って再始動されます。フックが完了するまでのコンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
object
Expand
プロパティー説明

exec

object

Exec はコンテナー内で実行するコマンドを指定します。

httpGet

object

HTTPGet は、実行する HTTP GET 要求を指定します。

sleep

object

Sleep は、コンテナーがスリープ状態になる期間を表します。

tcpSocket

object

非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、指定している場合は実行時にライフサイクルフックが失敗します。

5.1.269. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.exec

説明
Exec はコンテナー内で実行するコマンドを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

5.1.270. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.httpGet

説明
HTTPGet は、実行する HTTP GET 要求を指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。

httpHeaders

array

リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。

httpHeaders[]

object

HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します

path

string

HTTP サーバーでアクセスするパス。

port

integer-or-string

コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

scheme

string

ホストへの接続に使用するスキーム。デフォルトは HTTP です。

5.1.271. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

5.1.272. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名。これは出力時に正規化されるため、大文字/小文字の名前は同じヘッダーとして認識されます。

value

string

ヘッダーフィールド値

5.1.273. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.sleep

説明
Sleep は、コンテナーがスリープ状態になる期間を表します。
object
必須
  • seconds
Expand
プロパティー説明

seconds

integer

Seconds はスリープする秒数です。

5.1.274. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.tcpSocket

説明
非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、指定している場合は実行時にライフサイクルフックが失敗します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

5.1.275. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop

説明
PreStop は、API リクエスト、または活性/起動プローブの失敗、プリエンプション、リソース競合などの管理イベントが原因でコンテナーが終了する直前に呼び出されます。コンテナーがクラッシュまたは終了した場合、ハンドラーは呼び出されません。Pod の終了猶予期間のカウントダウンは、PreStop フックが実行される前に開始されます。ハンドラーの結果に関係なく、コンテナーは最終的に Pod の終了猶予期間内に終了します (ファイナライザーによって遅延されない限り)。フックが完了するまで、または終了猶予期間に達するまで、コンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
object
Expand
プロパティー説明

exec

object

Exec はコンテナー内で実行するコマンドを指定します。

httpGet

object

HTTPGet は、実行する HTTP GET 要求を指定します。

sleep

object

Sleep は、コンテナーがスリープ状態になる期間を表します。

tcpSocket

object

非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、指定している場合は実行時にライフサイクルフックが失敗します。

5.1.276. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.exec

説明
Exec はコンテナー内で実行するコマンドを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

5.1.277. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.httpGet

説明
HTTPGet は、実行する HTTP GET 要求を指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。

httpHeaders

array

リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。

httpHeaders[]

object

HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します

path

string

HTTP サーバーでアクセスするパス。

port

integer-or-string

コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

scheme

string

ホストへの接続に使用するスキーム。デフォルトは HTTP です。

5.1.278. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

5.1.279. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名。これは出力時に正規化されるため、大文字/小文字の名前は同じヘッダーとして認識されます。

value

string

ヘッダーフィールド値

5.1.280. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.sleep

説明
Sleep は、コンテナーがスリープ状態になる期間を表します。
object
必須
  • seconds
Expand
プロパティー説明

seconds

integer

Seconds はスリープする秒数です。

5.1.281. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.tcpSocket

説明
非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、指定している場合は実行時にライフサイクルフックが失敗します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

5.1.282. .spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe

説明
コンテナーの活性度の定期的な調査。プローブが失敗した場合、コンテナーは再起動されます。これは更新できません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
object
Expand
プロパティー説明

exec

object

Exec はコンテナー内で実行するコマンドを指定します。

failureThreshold

integer

正常に実行された後に失敗とみなされるプローブの連続失敗回数の最小値。デフォルトは 3 です。最小値は 1 です。

grpc

object

GRPC は GRPC HealthCheckRequest を指定します。

httpGet

object

HTTPGet は、実行する HTTP GET 要求を指定します。

initialDelaySeconds

integer

コンテナーが起動してから liveness プローブが開始されるまでの秒数。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

periodSeconds

integer

プローブを実行する頻度 (秒単位)。デフォルトは 10 秒です。最小値は 1 です。

successThreshold

integer

失敗後に、プローブが正常とみなされるための最小の連続成功回数。デフォルトは 1 です。活気と起動のために 1 でなければなりません。最小値は 1 です。

tcpSocket

object

TCPSocket は TCP ポートへの接続を指定します。

terminationGracePeriodSeconds

integer

プローブの障害時に Pod がグレースフルに終了する必要がある秒単位のオプションの期間。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。この値が nil の場合、Pod の terminationGracePeriodSeconds が使用されます。それ以外の場合、この値は Pod 仕様によって提供される値をオーバーライドします。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。これはベータフィールドであり、ProbeTerminationGracePeriod 機能ゲートを有効にする必要があります。最小値は 1 です。未設定の場合は spec.terminationGracePeriodSeconds が使用されます。

timeoutSeconds

integer

プローブがタイムアウトするまでの秒数。デフォルトは 1 秒です。最小値は 1 です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

5.1.283. .spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.exec

説明
Exec はコンテナー内で実行するコマンドを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

5.1.284. .spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.grpc

説明
GRPC は GRPC HealthCheckRequest を指定します。
object
必須
  • port
Expand
プロパティー説明

port

integer

gRPC サービスのポート番号。番号は 1〜65535 の範囲である必要があります。

service

string

Service は、gRPC HealthCheckRequest に配置するサービスの名前です (https://github.com/grpc/grpc/blob/master/doc/health-checking.md を参照)。

これが指定されていない場合、デフォルトの動作は gRPC によって定義されます。

5.1.285. .spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.httpGet

説明
HTTPGet は、実行する HTTP GET 要求を指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。

httpHeaders

array

リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。

httpHeaders[]

object

HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します

path

string

HTTP サーバーでアクセスするパス。

port

integer-or-string

コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

scheme

string

ホストへの接続に使用するスキーム。デフォルトは HTTP です。

5.1.286. .spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

5.1.287. .spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名。これは出力時に正規化されるため、大文字/小文字の名前は同じヘッダーとして認識されます。

value

string

ヘッダーフィールド値

5.1.288. .spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.tcpSocket

説明
TCPSocket は TCP ポートへの接続を指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

5.1.289. .spec.install.spec.deployments[].spec.template.spec.initContainers[].ports

説明
コンテナーから公開するポートのリスト。ここでポートを指定しなくても、そのポートが公開されるのを防ぐことはできません。コンテナー内のデフォルトの "0.0.0.0" アドレスをリッスンしているポートは、ネットワークからアクセスできます。戦略的マージパッチを使用してこの配列を変更すると、データが破損する可能性があります。詳細は、https://github.com/kubernetes/kubernetes/issues/108255 を参照してください。これは更新できません。
array

5.1.290. .spec.install.spec.deployments[].spec.template.spec.initContainers[].ports[]

説明
ContainerPort は、単一のコンテナー内のネットワークポートを表します。
object
必須
  • containerPort
Expand
プロパティー説明

containerPort

integer

Pod の IP アドレスで公開するポートの数。これは有効なポート番号である必要があります、0<x<65536。

hostIP

string

外部ポートをバインドするホスト IP。

hostPort

integer

ホストで公開するポートの数。指定する場合、これは有効なポート番号、0<x<65536 である必要があります。HostNetwork が指定されている場合、これは ContainerPort と一致する必要があります。ほとんどのコンテナーはこれを必要としません。

name

string

指定する場合、これは IANA_SVC_NAME であり、Pod 内で一意である必要があります。Pod 内の名前付きポートにはそれぞれ一意の名前を付ける必要があります。サービスが参照できるポートの名前。

protocol

string

ポートのプロトコル。UDP、TCP、または SCTP である必要があります。デフォルトは "TCP" です。

5.1.291. .spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe

説明
コンテナーサービスの準備状況の定期的な調査。プローブが失敗すると、コンテナーはサービスエンドポイントから削除されます。これは更新できません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
object
Expand
プロパティー説明

exec

object

Exec はコンテナー内で実行するコマンドを指定します。

failureThreshold

integer

正常に実行された後に失敗とみなされるプローブの連続失敗回数の最小値。デフォルトは 3 です。最小値は 1 です。

grpc

object

GRPC は GRPC HealthCheckRequest を指定します。

httpGet

object

HTTPGet は、実行する HTTP GET 要求を指定します。

initialDelaySeconds

integer

コンテナーが起動してから liveness プローブが開始されるまでの秒数。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

periodSeconds

integer

プローブを実行する頻度 (秒単位)。デフォルトは 10 秒です。最小値は 1 です。

successThreshold

integer

失敗後に、プローブが正常とみなされるための最小の連続成功回数。デフォルトは 1 です。活気と起動のために 1 でなければなりません。最小値は 1 です。

tcpSocket

object

TCPSocket は TCP ポートへの接続を指定します。

terminationGracePeriodSeconds

integer

プローブの障害時に Pod がグレースフルに終了する必要がある秒単位のオプションの期間。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。この値が nil の場合、Pod の terminationGracePeriodSeconds が使用されます。それ以外の場合、この値は Pod 仕様によって提供される値をオーバーライドします。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。これはベータフィールドであり、ProbeTerminationGracePeriod 機能ゲートを有効にする必要があります。最小値は 1 です。未設定の場合は spec.terminationGracePeriodSeconds が使用されます。

timeoutSeconds

integer

プローブがタイムアウトするまでの秒数。デフォルトは 1 秒です。最小値は 1 です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

5.1.292. .spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.exec

説明
Exec はコンテナー内で実行するコマンドを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

5.1.293. .spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.grpc

説明
GRPC は GRPC HealthCheckRequest を指定します。
object
必須
  • port
Expand
プロパティー説明

port

integer

gRPC サービスのポート番号。番号は 1〜65535 の範囲である必要があります。

service

string

Service は、gRPC HealthCheckRequest に配置するサービスの名前です (https://github.com/grpc/grpc/blob/master/doc/health-checking.md を参照)。

これが指定されていない場合、デフォルトの動作は gRPC によって定義されます。

5.1.294. .spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.httpGet

説明
HTTPGet は、実行する HTTP GET 要求を指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。

httpHeaders

array

リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。

httpHeaders[]

object

HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します

path

string

HTTP サーバーでアクセスするパス。

port

integer-or-string

コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

scheme

string

ホストへの接続に使用するスキーム。デフォルトは HTTP です。

5.1.295. .spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

5.1.296. .spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名。これは出力時に正規化されるため、大文字/小文字の名前は同じヘッダーとして認識されます。

value

string

ヘッダーフィールド値

5.1.297. .spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.tcpSocket

説明
TCPSocket は TCP ポートへの接続を指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

5.1.298. .spec.install.spec.deployments[].spec.template.spec.initContainers[].resizePolicy

説明
コンテナーのリソースサイズ変更ポリシー。
array

5.1.299. .spec.install.spec.deployments[].spec.template.spec.initContainers[].resizePolicy[]

説明
ContainerResizePolicy は、コンテナーのリソースサイズ変更ポリシーを表します。
object
必須
  • resourceName
  • restartPolicy
Expand
プロパティー説明

resourceName

string

このリソースサイズ変更ポリシーが適用されるリソースの名前。対応している値は、cpu、memory です。

restartPolicy

string

指定されたリソースのサイズが変更されたときに適用する再起動ポリシー。指定しない場合、デフォルトの NotRequired が設定されます。

5.1.300. .spec.install.spec.deployments[].spec.template.spec.initContainers[].resources

説明
このコンテナーに必要なコンピューティングリソース。これは更新できません。詳細: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
object
Expand
プロパティー説明

claims

array

Claims には、spec.resourceClaims で定義され、このコンテナーによって使用されるリソースの名前がリストされます。

これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。

このフィールドは変更不可能です。これはコンテナーにのみ設定できます。

claims[]

object

ResourceClaim は、PodSpec.ResourceClaims 内の 1 つのエントリーを参照します。

limits

integer-or-string

limits は、許可されるコンピュートリソースの最大量を示します。詳細: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

requests は、必要なコンピュートリソースの最小量を示します。コンテナーで Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。リクエストは制限を超えることはできません。詳細: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

5.1.301. .spec.install.spec.deployments[].spec.template.spec.initContainers[].resources.claims

説明

Claims には、spec.resourceClaims で定義され、このコンテナーによって使用されるリソースの名前がリストされます。

これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。

このフィールドは変更不可能です。これはコンテナーにのみ設定できます。

array

5.1.302. .spec.install.spec.deployments[].spec.template.spec.initContainers[].resources.claims[]

説明
ResourceClaim は、PodSpec.ResourceClaims 内の 1 つのエントリーを参照します。
object
必須
  • name
Expand
プロパティー説明

name

string

name は、このフィールドが使用される Pod の pod.spec.resourceClaims に含まれる、1 つのエントリーの名前と一致する必要があります。これにより、そのリソースがコンテナー内で利用可能になります。

request

string

request は、参照されるクレーム内のリクエストに対して選択された名前です。空の場合、クレームからのすべてのものが利用可能になり、それ以外の場合はこの request の結果のみが利用可能になります。

5.1.303. .spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext

説明
SecurityContext は、コンテナーを実行する必要があるセキュリティーオプションを定義します。設定されている場合、SecurityContext のフィールドは PodSecurityContext の同等のフィールドをオーバーライドします。詳細: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
object
Expand
プロパティー説明

allowPrivilegeEscalation

boolean

AllowPrivilegeEscalation は、プロセスがその親プロセスよりも多くの特権を取得できるかどうかを制御します。このブール値は、no_new_privs フラグがコンテナープロセスに設定されるかどうかを直接制御します。コンテナーが 1) 特権で実行されており、CAP_SYS_ADMIN が割り当てられている場合、2) AllowPrivilegeEscalation は常に true です。spec.os.name が windows の場合は、このフィールドは設定できないことに注意してください。

appArmorProfile

object

appArmorProfile は、このコンテナーで使用する AppArmor オプションです。設定されている場合、このプロファイルによって Pod の appArmorProfile がオーバーライドされます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

capabilities

object

コンテナーの実行時に追加/削除する機能。デフォルトは、コンテナーランタイムによって付与されるデフォルトの機能セットです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

privileged

boolean

コンテナーを特権モードで実行します。特権コンテナー内のプロセスは、基本的にホスト上の root と同等です。デフォルトは false です。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

procMount

string

procMount は、コンテナーに使用する proc マウントのタイプを示します。デフォルト値は Default で、読み取り専用パスおよびマスクされたパスのコンテナーランタイムのデフォルトを使用します。これには、ProcMountType 機能フラグを有効にする必要があります。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

readOnlyRootFilesystem

boolean

このコンテナーに読み取り専用のルートファイルシステムがあるかどうか。デフォルトは false です。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

runAsGroup

integer

コンテナープロセスのエントリーポイントを実行するための GID。設定されていない場合は、実行時のデフォルトを使用します。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

runAsNonRoot

boolean

コンテナーが root 以外のユーザーとして実行される必要があることを示します。true の場合、Kubelet は実行時にイメージを検証して、イメージが UID 0(ルート) として実行されないことを確認し、実行される場合はコンテナーの開始に失敗します。未設定または false の場合、そのような検証は実行されません。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。

runAsUser

integer

コンテナープロセスのエントリーポイントを実行するための UID。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

seLinuxOptions

object

コンテナーに適用される SELinux コンテキスト。指定しない場合、コンテナーランタイムはコンテナーごとにランダムな SELinux コンテキストを割り当てます。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

seccompProfile

object

このコンテナーで使用する seccomp オプション。Pod とコンテナーの両方のレベルで seccomp オプションが提供されている場合、コンテナーオプションは Pod オプションをオーバーライドします。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

windowsOptions

object

すべてのコンテナーに適用される Windows 固有の設定。指定しない場合、PodSecurityContext のオプションが使用されます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が linux の場合は、このフィールドを設定できないことに注意してください。

5.1.304. .spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.appArmorProfile

説明
appArmorProfile は、このコンテナーで使用する AppArmor オプションです。設定されている場合、このプロファイルによって Pod の appArmorProfile がオーバーライドされます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
object
必須
  • type
Expand
プロパティー説明

localhostProfile

string

localhostProfile は、使用する必要があるノードにロードされたプロファイルを示します。プロファイルが機能するには、ノードで事前に設定されている必要があります。プロファイルのロードされた名前と一致する必要があります。タイプが "Localhost" の場合にのみ設定する必要があります。

type

string

type は、適用される AppArmor プロファイルの種類を示します。有効なオプション: Localhost - ノードに事前にロードされたプロファイル。RuntimeDefault - コンテナーランタイムのデフォルトのプロファイル。制限なし - AppArmor の強制はありません。

5.1.305. .spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.capabilities

説明
コンテナーの実行時に追加/削除する機能。デフォルトは、コンテナーランタイムによって付与されるデフォルトの機能セットです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
object
Expand
プロパティー説明

add

array (string)

追加された機能

drop

array (string)

削除された機能

5.1.306. .spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.seLinuxOptions

説明
コンテナーに適用される SELinux コンテキスト。指定しない場合、コンテナーランタイムはコンテナーごとにランダムな SELinux コンテキストを割り当てます。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
object
Expand
プロパティー説明

level

string

Level は、コンテナーに適用される SELinux レベルのラベルです。

role

string

Role は、コンテナーに適用される SELinux ロールラベルです。

type

string

Type は、コンテナーに適用される SELinux タイプのラベルです。

user

string

User は、コンテナーに適用される SELinux ユーザーラベルです。

5.1.307. .spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.seccompProfile

説明
このコンテナーで使用する seccomp オプション。Pod とコンテナーの両方のレベルで seccomp オプションが提供されている場合、コンテナーオプションは Pod オプションをオーバーライドします。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
object
必須
  • type
Expand
プロパティー説明

localhostProfile

string

localhostProfile は、ノード上のファイルで定義されたプロファイルを使用する必要があることを示します。プロファイルが機能するには、ノードで事前に設定されている必要があります。kubelet の設定済みの seccomp プロファイルの場所を基準にして、降順のパスである必要があります。タイプが "Localhost" の場合は設定する必要があります。他のタイプには設定しないでください。

type

string

type は、適用される seccomp プロファイルの種類を示します。有効なオプションは以下のとおりです。

Localhost - ノード上のファイルで定義されたプロファイルを使用する必要があります。RuntimeDefault- コンテナーのランタイムデフォルトプロファイルを使用する必要があります。制限なし - プロファイルを適用しないでください。

5.1.308. .spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.windowsOptions

説明
すべてのコンテナーに適用される Windows 固有の設定。指定しない場合、PodSecurityContext のオプションが使用されます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が linux の場合は、このフィールドを設定できないことに注意してください。
object
Expand
プロパティー説明

gmsaCredentialSpec

string

GMSACredentialSpec は、GMSA アドミッション Webhook (https://github.com/kubernetes-sigs/windows-gmsa) が GMSACredentialSpecName フィールドで指定された GMSA クレデンシャル仕様のコンテンツをインライン化する場所です。

gmsaCredentialSpecName

string

GMSACredentialSpecName は、使用する GMSA 認証情報仕様の名前です。

hostProcess

boolean

hostProcess は、コンテナーを 'Host Process' コンテナーとして実行する必要があるかどうかを決定します。Pod のすべてのコンテナーは、同じ有効な HostProcess 値を持っている必要があります (HostProcess コンテナーと非 HostProcess コンテナーを混在させることはできません)。さらに、HostProcess が true の場合、HostNetwork も true に設定する必要があります。

runAsUserName

string

コンテナープロセスのエントリーポイントを実行するための Windows の UserName。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。

5.1.309. .spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe

説明
StartupProbe は、Pod が正常に初期化されたことを示します。指定した場合、これが正常に完了するまで、他のプローブは実行されません。このプローブが失敗すると、livenessProbe が失敗したかのように、Pod が再起動されます。これは、Pod のライフサイクルの開始時に、定常状態の操作中よりもデータのロードやキャッシュのウォームアップに長い時間がかかる可能性がある場合に、さまざまなプローブパラメーターを提供するために使用できます。これは更新できません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
object
Expand
プロパティー説明

exec

object

Exec はコンテナー内で実行するコマンドを指定します。

failureThreshold

integer

正常に実行された後に失敗とみなされるプローブの連続失敗回数の最小値。デフォルトは 3 です。最小値は 1 です。

grpc

object

GRPC は GRPC HealthCheckRequest を指定します。

httpGet

object

HTTPGet は、実行する HTTP GET 要求を指定します。

initialDelaySeconds

integer

コンテナーが起動してから liveness プローブが開始されるまでの秒数。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

periodSeconds

integer

プローブを実行する頻度 (秒単位)。デフォルトは 10 秒です。最小値は 1 です。

successThreshold

integer

失敗後に、プローブが正常とみなされるための最小の連続成功回数。デフォルトは 1 です。活気と起動のために 1 でなければなりません。最小値は 1 です。

tcpSocket

object

TCPSocket は TCP ポートへの接続を指定します。

terminationGracePeriodSeconds

integer

プローブの障害時に Pod がグレースフルに終了する必要がある秒単位のオプションの期間。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。この値が nil の場合、Pod の terminationGracePeriodSeconds が使用されます。それ以外の場合、この値は Pod 仕様によって提供される値をオーバーライドします。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。これはベータフィールドであり、ProbeTerminationGracePeriod 機能ゲートを有効にする必要があります。最小値は 1 です。未設定の場合は spec.terminationGracePeriodSeconds が使用されます。

timeoutSeconds

integer

プローブがタイムアウトするまでの秒数。デフォルトは 1 秒です。最小値は 1 です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

5.1.310. .spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.exec

説明
Exec はコンテナー内で実行するコマンドを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

5.1.311. .spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.grpc

説明
GRPC は GRPC HealthCheckRequest を指定します。
object
必須
  • port
Expand
プロパティー説明

port

integer

gRPC サービスのポート番号。番号は 1〜65535 の範囲である必要があります。

service

string

Service は、gRPC HealthCheckRequest に配置するサービスの名前です (https://github.com/grpc/grpc/blob/master/doc/health-checking.md を参照)。

これが指定されていない場合、デフォルトの動作は gRPC によって定義されます。

5.1.312. .spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.httpGet

説明
HTTPGet は、実行する HTTP GET 要求を指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。

httpHeaders

array

リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。

httpHeaders[]

object

HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します

path

string

HTTP サーバーでアクセスするパス。

port

integer-or-string

コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

scheme

string

ホストへの接続に使用するスキーム。デフォルトは HTTP です。

5.1.313. .spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

5.1.314. .spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名。これは出力時に正規化されるため、大文字/小文字の名前は同じヘッダーとして認識されます。

value

string

ヘッダーフィールド値

5.1.315. .spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.tcpSocket

説明
TCPSocket は TCP ポートへの接続を指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

5.1.316. .spec.install.spec.deployments[].spec.template.spec.initContainers[].volumeDevices

説明
volumeDevices は、コンテナーによって使用されるブロックデバイスのリストです。
array

5.1.317. .spec.install.spec.deployments[].spec.template.spec.initContainers[].volumeDevices[]

説明
volumeDevice は、コンテナー内の raw ブロックデバイスのマッピングを記述します。
object
必須
  • devicePath
  • name
Expand
プロパティー説明

devicePath

string

devicePath は、デバイスがマップされるコンテナー内のパスです。

name

string

name は、Pod 内の persistentVolumeClaim の名前と一致する必要があります

5.1.318. .spec.install.spec.deployments[].spec.template.spec.initContainers[].volumeMounts

説明
コンテナーのファイルシステムにマウントする Pod ボリューム。これは更新できません。
array

5.1.319. .spec.install.spec.deployments[].spec.template.spec.initContainers[].volumeMounts[]

説明
VolumeMount は、コンテナー内でのボリュームのマウントを説明します。
object
必須
  • mountPath
  • name
Expand
プロパティー説明

mountPath

string

ボリュームをマウントする必要があるコンテナー内のパス。':' を含めることはできません。

mountPropagation

string

mountPropagation は、マウントがホストからコンテナーに、またはその逆にどのように伝播されるかを決定します。設定されていない場合、MountPropagationNone が使用されます。このフィールドは 1.10 のベータ版です。RecursiveReadOnly が IfPossible または Enabled に設定されている場合、MountPropagation は None または未指定 (デフォルトは None) にする必要があります。

name

string

ボリュームの名前に一致する必要があります。

readOnly

boolean

true の場合は読み取り専用、それ以外の場合は読み取り/書き込み (false または指定なし) でマウントされます。デフォルトは false です。

recursiveReadOnly

string

RecursiveReadOnly は、読み取り専用マウントを再帰的に処理するかどうかを指定します。

ReadOnly が false の場合、このフィールドには意味がなく、未指定にする必要があります。

ReadOnly が true で、このフィールドが Disabled に設定されている場合、マウントは再帰的に読み取り専用にはなりません。このフィールドが IfPossible に設定されている場合、コンテナーランタイムでサポートされている場合は、マウントは再帰的に読み取り専用になります。このフィールドが Enabled に設定されている場合で、コンテナーランタイムでサポートされている場合は、マウントが再帰的に読み取り専用になり、そうでない場合は Pod が起動されず、理由を示すエラーが生成されます。

このフィールドが IfPossible または Enabled に設定されている場合、MountPropagation は None に設定する必要があります (または未指定にする必要があります。この場合、デフォルトは None になります)。

このフィールドが指定されていない場合は、無効と同じ扱いになります。

subPath

string

コンテナーのボリュームをマウントする必要があるボリューム内のパス。デフォルトは "" (ボリュームのルート) です。

subPathExpr

string

コンテナーのボリュームをマウントする必要があるボリューム内の拡張パス。SubPath と同様に動作しますが、環境変数参照 $(VAR_NAME) は、コンテナーの環境を使用して展開されます。デフォルトは "" (ボリュームのルート) です。SubPathExpr と SubPath は相互に排他的です。

5.1.320. .spec.install.spec.deployments[].spec.template.spec.os

説明

Pod 内のコンテナーの OS を指定します。これが設定されている場合、一部の Pod およびコンテナーフィールドは制限されます。

OS フィールドが linux に設定されている場合は、-securityContext.windowsOptions のフィールドの設定を解除する必要があります。

OS フィールドが Windows に設定されている場合は、次のフィールドの設定を解除する必要があります。- spec.hostPID - spec.hostIPC - spec.hostUsers - spec.securityContext.appArmorProfile - spec.securityContext.seLinuxOptions - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.securityContext.supplementalGroupsPolicy - spec.containers[].securityContext.appArmorProfile - spec.containers[].securityContext.seLinuxOptions - spec.containers[].securityContext.seccompProfile - spec.containers[].securityContext.capabilities - spec.containers[].securityContext.readOnlyRootFilesystem - spec.containers[].securityContext.privileged - spec.containers[].securityContext.allowPrivilegeEscalation - spec.containers[].securityContext.procMount - spec.containers[].securityContext.runAsUser - spec.containers[].securityContext.runAsGroup

object
必須
  • name
Expand
プロパティー説明

name

string

name は、オペレーティングシステムの名前です。現在サポートされている値は linux および windows です。今後、追加の値が定義される可能性があり、https://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration のいずれかになります。クライアントは、追加の値を処理し、このフィールドで認識されない値を os: null として処理する必要があります。

5.1.321. .spec.install.spec.deployments[].spec.template.spec.readinessGates

説明
指定した場合、すべての準備ゲートが Pod の準備状況に対して評価されます。すべてのコンテナーの準備が整い、準備ゲートで指定されたすべての条件のステータスが "True" になると、Pod の準備が整います。詳細: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates
array

5.1.322. .spec.install.spec.deployments[].spec.template.spec.readinessGates[]

説明
PodReadinessGate には、Pod 条件への参照が含まれています
object
必須
  • conditionType
Expand
プロパティー説明

conditionType

string

ConditionType は、タイプが一致する Pod の条件リスト内の条件を参照します。

5.1.323. .spec.install.spec.deployments[].spec.template.spec.resourceClaims

説明

ResourceClaims は、Pod の起動を許可する前にどの ResourceClaim を割り当てて予約する必要があるかを定義します。リソースは、名前ベースでリソースを使用するコンテナーに提供されます。

これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。

このフィールドは変更不可能です。

array

5.1.324. .spec.install.spec.deployments[].spec.template.spec.resourceClaims[]

説明

PodResourceClaim は、直接または Pod の ResourceClaim に変換する ResourceClaimTemplate に名前を付けることで、1 つの ResourceClaim のみを参照します。

Pod 内の ResourceClaim を一意に識別する名前を追加します。ResourceClaim へのアクセスが必要なコンテナーは、この名前で参照します。

object
必須
  • name
Expand
プロパティー説明

name

string

name は Pod 内でこのリソース要求を一意に識別します。これは DNS_LABEL である必要があります。

resourceClaimName

string

ResourceClaimName は、この Pod と同じ namespace にある ResourceClaim オブジェクトの名前です。

ResourceClaimName と ResourceClaimTemplateName のいずれか 1 つのみを設定する必要があります。

resourceClaimTemplateName

string

ResourceClaimTemplateName は、この Pod と同じ namespace にある ResourceClaimTemplate オブジェクトの名前です。

テンプレートは、この Pod にバインドされる新規 ResourceClaim の作成に使用されます。この Pod が削除されると、ResourceClaim も削除されます。Pod 名とリソース名は、生成されたコンポーネントとともに、ResourceClaim の一意の名前を形成するために使用され、pod.status.resourceClaimStatuses に記録されます。

このフィールドは変更不可能であり、ResourceClaim の作成後にコントロールプレーンによって対応する ResourceClaim に変更が加えられることはありません。

ResourceClaimName と ResourceClaimTemplateName のいずれか 1 つのみを設定する必要があります。

5.1.325. .spec.install.spec.deployments[].spec.template.spec.resources

説明

resources は、Pod 内のすべてのコンテナーに必要な CPU およびメモリーリソースの合計量です。"cpu" および "memory" リソース名に対してのみ、リクエストと制限の指定をサポートします。ResourceClaims はサポートされていません。

このフィールドにより、Pod 全体のリソース割り当てを細かく制御できるようになり、Pod 内のコンテナー間でリソースを共有できるようになります。

このフィールドはアルファ版であり、使用するには PodLevelResources フィーチャーゲートを有効にする必要があります。

object
Expand
プロパティー説明

claims

array

Claims には、spec.resourceClaims で定義され、このコンテナーによって使用されるリソースの名前がリストされます。

これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。

このフィールドは変更不可能です。これはコンテナーにのみ設定できます。

claims[]

object

ResourceClaim は、PodSpec.ResourceClaims 内の 1 つのエントリーを参照します。

limits

integer-or-string

limits は、許可されるコンピュートリソースの最大量を示します。詳細: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

requests は、必要なコンピュートリソースの最小量を示します。コンテナーで Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。リクエストは制限を超えることはできません。詳細: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

5.1.326. .spec.install.spec.deployments[].spec.template.spec.resources.claims

説明

Claims には、spec.resourceClaims で定義され、このコンテナーによって使用されるリソースの名前がリストされます。

これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。

このフィールドは変更不可能です。これはコンテナーにのみ設定できます。

array

5.1.327. .spec.install.spec.deployments[].spec.template.spec.resources.claims[]

説明
ResourceClaim は、PodSpec.ResourceClaims 内の 1 つのエントリーを参照します。
object
必須
  • name
Expand
プロパティー説明

name

string

name は、このフィールドが使用される Pod の pod.spec.resourceClaims に含まれる、1 つのエントリーの名前と一致する必要があります。これにより、そのリソースがコンテナー内で利用可能になります。

request

string

request は、参照されるクレーム内のリクエストに対して選択された名前です。空の場合、クレームからのすべてのものが利用可能になり、それ以外の場合はこの request の結果のみが利用可能になります。

5.1.328. .spec.install.spec.deployments[].spec.template.spec.schedulingGates

説明

SchedulingGates は、指定されている場合に Pod のスケジューリングをブロックする不透明な値のリストです。schedulingGates が空でない場合、Pod は SchedulingGated 状態のままになり、スケジューラーは Pod のスケジュールを試行しません。

SchedulingGates を設定できるのは Pod の作成時にのみで、それ以降は削除されます。

array

5.1.329. .spec.install.spec.deployments[].spec.template.spec.schedulingGates[]

説明
PodSchedulingGate は Pod に割り当てられ、そのスケジューリングを保護します。
object
必須
  • name
Expand
プロパティー説明

name

string

スケジューリングゲートの名前。各スケジューリングゲートには一意の name フィールドが必要です。

5.1.330. .spec.install.spec.deployments[].spec.template.spec.securityContext

説明
SecurityContext は、Pod レベルのセキュリティー属性と一般的なコンテナー設定を保持します。オプション: デフォルトは空です。各フィールドのデフォルト値は、タイプの説明を参照してください。
object
Expand
プロパティー説明

appArmorProfile

object

appArmorProfile は、この Pod 内のコンテナーで使用する AppArmor オプションです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

fsGroup

integer

Pod の全コンテナーに適用される特別な補助グループです。一部のボリュームタイプでは、Kubelet がそのボリュームの所有権を Pod が所有するように変更できます。

1.所有する GID は FSGroup2 になります。setgid ビットが設定されます (ボリュームに作成された新しいファイルは FSGroup によって所有されます)3。許可ビットは rw-rw---- と OR 演算されます

設定されていないと、Kubelet はボリュームの所有権および権限を変更しません。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

fsGroupChangePolicy

string

fsGroupChangePolicy は、Pod 内部で公開する前にボリュームの所有権とアクセス権を変更する動作を定義します。このフィールドは、fsGroup ベースの所有権 (および権限) をサポートするボリュームタイプにのみ適用されます。secret、configmaps、emptydir などのエフェメラルボリュームタイプには影響しません。有効な値は "OnRootMismatch" と "Always" です。指定しない場合は "Always" を使用します。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

runAsGroup

integer

コンテナープロセスのエントリーポイントを実行するための GID。設定されていない場合は、実行時のデフォルトを使用します。SecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値がそのコンテナーに優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

runAsNonRoot

boolean

コンテナーが root 以外のユーザーとして実行される必要があることを示します。true の場合、Kubelet は実行時にイメージを検証して、イメージが UID 0(ルート) として実行されないことを確認し、実行される場合はコンテナーの開始に失敗します。未設定または false の場合、そのような検証は実行されません。SecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。

runAsUser

integer

コンテナープロセスのエントリーポイントを実行するための UID。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。SecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値がそのコンテナーに優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

seLinuxChangePolicy

string

seLinuxChangePolicy は、コンテナーの SELinux ラベルを Pod が使用するすべてのボリュームに適用する方法を定義します。SELinux をサポートしていないノードや、SELinux をサポートしていないボリュームには影響しません。有効な値は "MountOption" と "Recursive" です。

"Recursive" とは、コンテナーランタイムによってすべての Pod ボリューム上のすべてのファイルに再ラベルを付けることを意味します。これは、ボリュームが大きい場合には遅くなる可能性がありますが、同じノード上で同じボリュームを共有する特権 Pod と非特権 Pod を混在させることができます。

"MountOption" は、-o context マウントオプションを使用して、対象となるすべての Pod ボリュームをマウントします。この場合、同じボリュームを共有するすべての Pod が同じ SELinux ラベルを使用する必要があります。特権 Pod と非特権 Pod 間で同じボリュームを共有することはできません。対象となるボリュームは、ツリー内の FibreChannel および iSCSI ボリューム、および CSIDriver インスタンスで spec.seLinuxMount: true を設定することによって CSI ドライバーが SELinux サポートを宣言するすべての CSI ボリュームです。その他のボリュームは常に再帰的に再ラベル付けされます。"MountOption" 値は、SELinuxMount フィーチャーゲートが有効になっている場合にのみ許可されます。

指定されておらず、SELinuxMount フィーチャーゲートが有効になっている場合は、"MountOption" が使用されます。指定されておらず、SELinuxMount フィーチャーゲートが無効になっている場合、ReadWriteOncePod ボリュームには "MountOption" が使用され、他のすべてのボリュームには "Recursive" が使用されます。

このフィールドは、PodSecurityContext またはすべてのコンテナーの SecurityContext のいずれかで SELinux ラベルが設定されている Pod にのみ影響します。

同じボリュームを使用するすべての Pod は同じ seLinuxChangePolicy を使用する必要があります。そうしないと、一部の Pod が ContainerCreating 状態でスタックする可能性があります。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

seLinuxOptions

object

すべてのコンテナーに適用される SELinux コンテキスト。指定しない場合、コンテナーランタイムはコンテナーごとにランダムな SELinux コンテキストを割り当てます。SecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値がそのコンテナーに優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

seccompProfile

object

この Pod のコンテナーで使用する seccomp オプション。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

supplementalGroups

array (integer)

コンテナーのプライマリー GID および fsGroup (指定されている場合) に加えて、各コンテナーで実行される最初のプロセスに適用されるグループのリスト。SupplementalGroupsPolicy 機能が有効になっている場合、supplementalGroupsPolicy フィールドは、コンテナーイメージで定義されるグループメンバーシップに加えて、またはその代わりに、それらを追加するかどうかを決定します。これを指定しないと、追加のグループは追加されませんが、supplementalGroupsPolicy フィールドに応じて、コンテナーイメージで定義されたグループメンバーシップは引き続き使用される場合があります。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

supplementalGroupsPolicy

string

最初のコンテナープロセスの補助グループを計算する方法を定義します。有効な値は "Merge" と "Strict" です。指定しない場合は、"Merge" が使用されます。(Alpha) このフィールドを使用するには、SupplementalGroupsPolicy 機能ゲートを有効にする必要があり、コンテナーランタイムはこの機能のサポートを実装する必要があります。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

sysctls

array

Sysctl は、Pod に使用される namespace 付き sysctl のリストを保持します。(コンテナーランタイムによる) サポートされていない sysctl を持つ Pod は起動に失敗する可能性があります。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

sysctls[]

object

Sysctl は、設定するカーネルパラメーターを定義します

windowsOptions

object

すべてのコンテナーに適用される Windows 固有の設定。指定しない場合、コンテナーの SecurityContext 内のオプションが使用されます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が linux の場合は、このフィールドを設定できないことに注意してください。

5.1.331. .spec.install.spec.deployments[].spec.template.spec.securityContext.appArmorProfile

説明
appArmorProfile は、この Pod 内のコンテナーで使用する AppArmor オプションです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
object
必須
  • type
Expand
プロパティー説明

localhostProfile

string

localhostProfile は、使用する必要があるノードにロードされたプロファイルを示します。プロファイルが機能するには、ノードで事前に設定されている必要があります。プロファイルのロードされた名前と一致する必要があります。タイプが "Localhost" の場合にのみ設定する必要があります。

type

string

type は、適用される AppArmor プロファイルの種類を示します。有効なオプション: Localhost - ノードに事前にロードされたプロファイル。RuntimeDefault - コンテナーランタイムのデフォルトのプロファイル。制限なし - AppArmor の強制はありません。

5.1.332. .spec.install.spec.deployments[].spec.template.spec.securityContext.seLinuxOptions

説明
すべてのコンテナーに適用される SELinux コンテキスト。指定しない場合、コンテナーランタイムはコンテナーごとにランダムな SELinux コンテキストを割り当てます。SecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値がそのコンテナーに優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
object
Expand
プロパティー説明

level

string

Level は、コンテナーに適用される SELinux レベルのラベルです。

role

string

Role は、コンテナーに適用される SELinux ロールラベルです。

type

string

Type は、コンテナーに適用される SELinux タイプのラベルです。

user

string

User は、コンテナーに適用される SELinux ユーザーラベルです。

5.1.333. .spec.install.spec.deployments[].spec.template.spec.securityContext.seccompProfile

説明
この Pod のコンテナーで使用する seccomp オプション。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
object
必須
  • type
Expand
プロパティー説明

localhostProfile

string

localhostProfile は、ノード上のファイルで定義されたプロファイルを使用する必要があることを示します。プロファイルが機能するには、ノードで事前に設定されている必要があります。kubelet の設定済みの seccomp プロファイルの場所を基準にして、降順のパスである必要があります。タイプが "Localhost" の場合は設定する必要があります。他のタイプには設定しないでください。

type

string

type は、適用される seccomp プロファイルの種類を示します。有効なオプションは以下のとおりです。

Localhost - ノード上のファイルで定義されたプロファイルを使用する必要があります。RuntimeDefault- コンテナーのランタイムデフォルトプロファイルを使用する必要があります。制限なし - プロファイルを適用しないでください。

5.1.334. .spec.install.spec.deployments[].spec.template.spec.securityContext.sysctls

説明
Sysctl は、Pod に使用される namespace 付き sysctl のリストを保持します。(コンテナーランタイムによる) サポートされていない sysctl を持つ Pod は起動に失敗する可能性があります。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
array

5.1.335. .spec.install.spec.deployments[].spec.template.spec.securityContext.sysctls[]

説明
Sysctl は、設定するカーネルパラメーターを定義します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

設定するプロパティーの名前

value

string

設定するプロパティーの値

5.1.336. .spec.install.spec.deployments[].spec.template.spec.securityContext.windowsOptions

説明
すべてのコンテナーに適用される Windows 固有の設定。指定しない場合、コンテナーの SecurityContext 内のオプションが使用されます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が linux の場合は、このフィールドを設定できないことに注意してください。
object
Expand
プロパティー説明

gmsaCredentialSpec

string

GMSACredentialSpec は、GMSA アドミッション Webhook (https://github.com/kubernetes-sigs/windows-gmsa) が GMSACredentialSpecName フィールドで指定された GMSA クレデンシャル仕様のコンテンツをインライン化する場所です。

gmsaCredentialSpecName

string

GMSACredentialSpecName は、使用する GMSA 認証情報仕様の名前です。

hostProcess

boolean

hostProcess は、コンテナーを 'Host Process' コンテナーとして実行する必要があるかどうかを決定します。Pod のすべてのコンテナーは、同じ有効な HostProcess 値を持っている必要があります (HostProcess コンテナーと非 HostProcess コンテナーを混在させることはできません)。さらに、HostProcess が true の場合、HostNetwork も true に設定する必要があります。

runAsUserName

string

コンテナープロセスのエントリーポイントを実行するための Windows の UserName。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。

5.1.337. .spec.install.spec.deployments[].spec.template.spec.tolerations

説明
指定されている場合、Pod の許容範囲。
array

5.1.338. .spec.install.spec.deployments[].spec.template.spec.tolerations[]

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

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 以外の場合このフィールドは無視されます) が taint を許容する期間を表します。デフォルトでは設定されていません。つまり、テイントを永久に許容します (退避しないでください)。ゼロ値と負の値は、システムによって 0 (すぐに退避) として扱われます。

value

string

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

5.1.339. .spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints

説明
topologySpreadConstraints は、Pod のグループがトポロジードメイン全体にどのように分散するべきかを説明します。スケジューラーは、制約に従う方法で Pod をスケジュールします。すべての topologySpreadConstraints は AND 演算されます。
array

5.1.340. .spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[]

説明
topologySpreadConstraint は、指定されたトポロジー間で一致する Pod を分散する方法を指定します。
object
必須
  • maxSkew
  • topologyKey
  • whenUnsatisfiable
Expand
プロパティー説明

labelSelector

object

LabelSelector は、一致する Pod を見つけるために使用されます。このラベルセレクターに一致する Pod は、対応するトポロジードメイン内の Pod の数を決定するためにカウントされます。

matchLabelKeys

array (string)

MatchLabelKeys は、分散を計算する Pod を選択するための Pod ラベルキーのセットです。このようなキーは受信 Pod のラベルから値を検索するために使用され、このキーと値のラベルは labelSelector と AND 演算されて、受信 Pod の分散が計算される既存の Pod のグループを選択します。同じキーが MatchLabelKeys と LabelSelector の両方に存在することはできません。LabelSelector が設定されていないと、MatchLabelKeys は設定できません。受信 Pod ラベルに存在しないキーは無視されます。null または空のリストは、labelSelector とのみ一致することを意味します。

これはベータフィールドであり、MatchLabelKeysInPodTopologySpread フィーチャーゲートを有効にする必要があります (デフォルトで有効)。

maxSkew

integer

MaxSkew は、Pod が不均一に分布している可能性の程度を表します。whenUnsatisfiable=DoNotSchedule の場合、これは、ターゲットトポロジー内の一致する Pod の数とグローバル最小値との間の最大許容差です。グローバル最小値は、適格なドメイン内で一致する Pod の最小数です。または、適格なドメインの数が MinDomains 未満の場合はゼロになります。たとえば、3 ゾーンクラスターでは、MaxSkew が 1 に設定され、同じ labelSelector を持つ Pod は 2/2/1 に分散されます。この場合、グローバル最小値は 1 です。| zone1 | zone2 | zone3 | | P P | P P | P | - MaxSkew が 1 の場合、受信 Pod は 2/2/2 になるように zone 3 にのみスケジュールできます。これを zone1(zone2) にスケジュールすると、zone1(zone2) の ActualSkew(3-1) が MaxSkew(1) に違反します。- MaxSkew が 2 の場合、受信 Pod を任意のゾーンにスケジュールできます。whenUnsatisfiable=ScheduleAnyway の場合、それを満たすトポロジーに高い優先順位を与えるために使用されます。必須フィールドです。デフォルト値は 1 で、0 は許可されていません。

minDomains

integer

MinDomains は、対象となるドメインの最小数を示します。トポロジーキーが一致する適格なドメインの数が minDomains より少ない場合、Pod Topology Spread は "グローバル最小値" を 0 として扱い、スキューの計算が実行されます。また、トポロジーキーが一致する適格なドメインの数が minDomains の数以上の場合、この値はスケジュールに影響しません。その結果、対象となるドメインの数が minDomains より少ない場合、スケジューラーはそれらのドメインに対して maxSkew を超える Pod をスケジュールしません。値が nil の場合、制約は MinDomains が 1 と等しいかのように動作します。有効な値は 0 より大きい整数です。値が nil でない場合、WhenUnsatisfiable は DoNotSchedule でなければなりません。

たとえば、3 ゾーンクラスターの場合、MaxSkew は 2 に設定され、MinDomains は 5 に設定され、同じ labelSelector を持つ Pod は 2/2/2 に分散されます ( | zone1 | zone2 | zone3 | | P P | P | P | P P | P P | P P | P |)。ドメインの数は 5 (MinDomains 未満) であるため、"global minimum" は 0 として扱われます。このような場合、同じ labelSelector を持つ新しい Pod をスケジュールすることはできません。新しい Pod が 3 つのゾーンのいずれかにスケジュールされている場合、スキューは 3(3 - 0) と計算され、MaxSkew に違反するためです。

nodeAffinityPolicy

string

nodeAffinityPolicy は、Pod トポロジーの分散スキューを計算するときに Pod の nodeAffinity/nodeSelector をどのように扱うかを示します。オプションは - Honor: nodeAffinity/nodeSelector に一致するノードのみが計算に含まれます。- Ignore: nodeAffinity/nodeSelector は無視されます。すべてのノードが計算に含まれます。

この値が nil の場合、この動作は Honor ポリシーと同じです。

nodeTaintsPolicy

string

NodeTaintsPolicy は、Pod トポロジースプレッドスキューを計算するときにノードのテイントを処理する方法を示します。オプション: - Honor: テイントのないノードと、受信 Pod が許容範囲でテイントがあるノードが含まれます。- Ignore: ノードのテイントは無視されます。すべてのノードが含まれます。

この値が nil の場合、この動作は Ignore ポリシーと同じです。

topologyKey

string

TopologyKey は、ノードラベルのキーです。このキーと同じ値のラベルを持つノードは、同じトポロジーにあると見なされます。各 <key, value> を "バケット" と見なし、バランスの取れた数の Pod を各バケットに配置しようとします。ドメインをトポロジーの特定のインスタンスとして定義します。また、ノードが nodeAffinityPolicy および nodeTaintsPolicy の要件を満たすドメインとして、適格なドメインを定義します。たとえば、TopologyKey が "kubernetes.io/hostname" の場合、各ノードはそのトポロジーのドメインです。また、TopologyKey が "topology.kubernetes.io/zone" の場合は、各ゾーンがそのトポロジーのドメインになります。必須フィールドです。

whenUnsatisfiable

string

WhenUnsatisfiable は、スプレッドの制約を満たさない場合に Pod を処理する方法を示します。-DoNotSchedule (デフォルト) は、スケジューラーにスケジュールしないように指示します。--ScheduleAnyway は、任意の場所で Pod をスケジュールするようにスケジューラーに指示しますが、スキューを減らすのに役立つトポロジーに高い優先順位を与えます。受信 Pod に対する制約は、対象となる Pod へのノード割り当て候補すべてがトポロジーの一部の "MaxSkew" に違反する場合に、"Unsatisfiable" とみなされます。たとえば、3 ゾーンクラスターでは、MaxSkew は 1 に設定され、labelSelector が同じ Pod は 3/1/1 ( | zone1 | zone2 | zone3 | | P P P | P | P |) に分散されます。WhenUnsatisfiable が DoNotSchedule に設定されている場合、zone2(zone3) の ActualSkew(2-1) が MaxSkew(1) を満たすため、受信 Pod は zone2(zone3) にのみスケジュールして 3/2/1(3/1/2) になります。つまり、クラスターは依然として不均衡である可能性がありますが、スケジューラーによってクラスターが さらに 不均衡になることはありません。必須フィールドです。

5.1.341. .spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[].labelSelector

説明
LabelSelector は、一致する Pod を見つけるために使用されます。このラベルセレクターに一致する Pod は、対応するトポロジードメイン内の Pod の数を決定するためにカウントされます。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

5.1.342. .spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[].labelSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

5.1.343. .spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[].labelSelector.matchExpressions[]

説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

5.1.344. .spec.install.spec.deployments[].spec.template.spec.volumes

説明
Pod に属するコンテナーによってマウントできるボリュームのリスト。詳細: https://kubernetes.io/docs/concepts/storage/volumes
array

5.1.345. .spec.install.spec.deployments[].spec.template.spec.volumes[]

説明
ボリュームは、Pod 内の任意のコンテナーからアクセスできる Pod 内の名前付きボリュームを表します。
object
必須
  • name
Expand
プロパティー説明

awsElasticBlockStore

object

awsElasticBlockStore は、kubelet のホストマシンに割り当てられ、Pod に公開される AWS Disk リソースを表します。非推奨: AWSElasticBlockStore は非推奨です。ツリー内 awsElasticBlockStore タイプのすべての操作は、ebs.csi.aws.com CSI ドライバーにリダイレクトされます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

azureDisk

object

azureDisk は、ホスト上の Azure Data Disk マウントを表し、Pod へのバインドマウントを表します。非推奨: AzureDisk は非推奨です。ツリー内 azureDisk タイプのすべての操作は、disk.csi.azure.com CSI ドライバーにリダイレクトされます。

azureFile

object

azureFile は、ホスト上の Azure File Service マウントを表し、マウントを Pod にバインドします。非推奨: AzureFile は非推奨です。ツリー内 azureFile タイプのすべての操作は、file.csi.azure.com CSI ドライバーにリダイレクトされます。

cephfs

object

cephFS は、Pod の有効期間を共有するホストでの Ceph FS マウントを表します。非推奨: CephFS は非推奨であり、ツリー内の cephfs タイプはサポートされなくなりました。

cinder

object

Cinder は、kubelets ホストマシンに接続およびマウントされた Cinder ボリュームを表します。非推奨: Cinder は非推奨です。インツリー cinder タイプのすべての操作は、cinder.csi.openstack.org CSI ドライバーにリダイレクトされます。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md

configMap

object

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

csi

object

csi (Container Storage Interface) は、特定の外部 CSI ドライバーによって処理される一時ストレージを表します。

downwardAPI

object

downwardAPI は、このボリュームに入力する必要がある Pod に関する Downward API を表します

emptyDir

object

emptyDir は、Pod の存続期間を共有する一時ディレクトリーを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

ephemeral

object

ephemeral は、クラスターストレージドライバーによって処理されるボリュームを表します。ボリュームのライフサイクルは、ボリュームを定義する Pod に関連付けられています。ボリュームは、Pod が起動する前に作成され、Pod が削除されると削除されます。

これは、次の場合に使用します。a)Pod の実行中にのみボリュームが必要、b) スナップショットからの復元や容量追跡などの通常のボリュームの機能が必要、c) ストレージドライバーがストレージクラスを通じて指定される、d) ストレージドライバー PersistentVolumeClaim を介した動的ボリュームプロビジョニングをサポートします (このボリュームタイプと PersistentVolumeClaim の間の接続の詳細は、EphemeralVolumeSource を参照してください)。

個々の Pod のライフサイクルより長く持続するボリュームには、PersistentVolumeClaim またはベンダー固有の API の 1 つを使用します。

CSI ドライバーをそのように使用する場合は、軽量のローカルエフェメラルボリュームに CSI を使用します。詳細は、ドライバーのドキュメントを参照してください。

Pod は、両方のタイプのエフェメラルボリュームとパーシステントボリュームを同時に使用できます。

fc

object

fc は、kubelet のホストマシンに接続されてから Pod に公開されるファイバーチャネルリソースを表します。

flexVolume

object

flexVolume は、exec ベースのプラグインを使用してプロビジョニング/接続される汎用ボリュームリソースを表します。非推奨: FlexVolume は非推奨です。代わりに CSIDriver の使用を検討してください。

flocker

object

flocker は、kubelet のホストマシンに接続されている Flocker ボリュームを表します。これは、実行中の Flocker 制御サービスによって異なります非推奨: Flocker は非推奨であり、ツリー内の Flocker タイプはサポートされなくなりました。

gcePersistentDisk

object

gcePersistentDisk は、kubelet のホストマシンに接続されてから Pod に公開される GCE ディスクリソースを表します。非推奨: GCEPersistentDisk は非推奨です。インツリー gcePersistentDisk タイプのすべての操作は、pd.csi.storage.gke.io CSI ドライバーにリダイレクトされます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

gitRepo

object

gitRepo は、特定のリビジョンの git リポジトリーを表します。非推奨: GitRepo は非推奨となりました。git リポジトリーを使用してコンテナーをプロビジョニングするには、Git を使用してリポジトリーのクローンを作成する InitContainer に EmptyDir をマウントしてから、Pod のコンテナーに EmptyDir をマウントします。

glusterfs

object

glusterfs は、Pod の存続期間を共有するホスト上の Glusterfs マウントを表します。非推奨: Glusterfs は非推奨であり、ツリー内の glusterfs タイプはサポートされなくなりました。詳細: https://examples.k8s.io/volumes/glusterfs/README.md

hostPath

object

hostPath は、コンテナーに直接公開されているホストマシン上の既存のファイルまたはディレクトリーを表します。これは通常、ホストマシンの表示を許可されているシステムエージェントまたはその他の特権的なものに使用されます。ほとんどのコンテナーはこれを必要としません。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

image

object

image は、kubelet のホストマシンにプルおよびマウントされた OCI オブジェクト (コンテナーイメージまたはアーティファクト) を表します。ボリュームは、提供される PullPolicy 値に応じて Pod の起動時に解決されます。

- Always: kubelet は常に参照をプルしようとします。プルが失敗すると、コンテナーの作成は失敗します。- Never: kubelet は参照をプルせず、ローカルイメージまたはアーティファクトのみを使用します。参照が存在しない場合、コンテナーの作成は失敗します。- IfNotPresent: 参照がディスク上にまだ存在しない場合、kubelet はプルします。参照が存在しず、プルが失敗すると、コンテナーの作成は失敗します。

Pod が削除されて再作成されるとボリュームが再度解決され、Pod の再作成時に新しいリモートコンテンツが利用可能になります。Pod の起動中にイメージを解決またはプルできない場合、コンテナーの起動がブロックされ、大幅な遅延が発生する可能性があります。失敗した場合は通常のボリュームバックオフを使用して再試行され、理由とメッセージが Pod で報告されます。このボリュームによってマウントされる可能性のあるオブジェクトのタイプは、ホストマシン上のコンテナーランタイム実装によって定義され、少なくともコンテナーイメージフィールドでサポートされているすべての有効なタイプが含まれている必要があります。OCI オブジェクトは、コンテナーイメージの場合と同じ方法でマニフェストレイヤーをマージすることで、単一ディレクトリー (spec.containers[].volumeMounts.mountPath) にマウントされます。ボリュームは、読み取り専用 (ro) および実行不可ファイル (noexec) としてマウントされます。コンテナーのサブパスマウント (spec.containers[].volumeMounts.subpath) は、バージョン 1.33 より前ではサポートされていません。spec.securityContext.fsGroupChangePolicy フィールドは、このボリュームタイプには影響しません。

iscsi

object

iscsi は、kubelet のホストマシンに接続されてから Pod に公開される ISCSI ディスクリソースを表します。詳細: https://examples.k8s.io/volumes/iscsi/README.md

name

string

ボリュームの名前。DNS_LABEL であり、Pod 内で一意である必要があります。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

nfs

object

NFS は、Pod の有効期間を共有するホスト上の NFS マウントを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs

persistentVolumeClaim

object

persistentVolumeClaimVolumeSource は、同じ namespace 内の PersistentVolumeClaim への参照を表します。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

photonPersistentDisk

object

photonPersistentDisk は、kubelets ホストマシンに接続されマウントされた PhotonController 永続ディスクを表します。非推奨: PhotonPersistentDisk は非推奨であり、ツリー内の photonPersistentDisk タイプはサポートされなくなりました。

portworxVolume

object

portworxVolume は、kubelet ホストマシンに接続およびマウントされた portworx ボリュームを表します。非推奨: PortworxVolume は非推奨です。CSIMigrationPortworx フィーチャーゲートがオンの場合、ツリー内 portworxVolume タイプのすべての操作は pxd.portworx.com CSI ドライバーにリダイレクトされます。

projected

object

オールインワンリソースシークレット、configmaps、および Downward API のアイテム

quobyte

object

quobyte は、Pod の有効期限を共有するホストでの Quobyte マウントを表します非推奨: Quobyte は非推奨であり、ツリー内の quobyte タイプはサポートされなくなりました。

rbd

object

rbd は、Pod の有効期間を共有するホストの Rados ブロックデバイスマウントを表します。非推奨: RBD は非推奨であり、ツリー内の rbd タイプはサポートされなくなりました。詳細: https://examples.k8s.io/volumes/rbd/README.md

scaleIO

object

scaleIO は、Kubernetes ノードに接続およびマウントされた ScaleIO 永続ボリュームを表します。非推奨: ScaleIO は非推奨であり、ツリー内の scaleIO タイプはサポートされなくなりました。

secret

object

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

storageos

object

storageOS は、Kubernetes ノードに接続およびマウントされた StorageOS ボリュームを表します。非推奨: StorageOS は非推奨であり、ツリー内の storageos タイプはサポートされなくなりました。

vsphereVolume

object

vsphereVolume は、kubelet ホストマシンに接続およびマウントされた vSphere ボリュームを表します。非推奨: VsphereVolume は非推奨です。ツリー内 vsphereVolume タイプのすべての操作は、csi.vsphere.vmware.com CSI ドライバーにリダイレクトされます。

5.1.346. .spec.install.spec.deployments[].spec.template.spec.volumes[].awsElasticBlockStore

説明
awsElasticBlockStore は、kubelet のホストマシンに割り当てられ、Pod に公開される AWS Disk リソースを表します。非推奨: AWSElasticBlockStore は非推奨です。ツリー内 awsElasticBlockStore タイプのすべての操作は、ebs.csi.aws.com CSI ドライバーにリダイレクトされます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
object
必須
  • volumeID
Expand
プロパティー説明

fsType

string

fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

partition

integer

partition は、マウントするボリューム内のパーティションです。省略した場合、デフォルトではボリューム名でマウントします。例: ボリューム/dev/sda1 の場合、パーティションを "1" として指定します。同様に、/dev/sda のボリュームパーティションは "0" です (または、プロパティーを空のままにしておくこともできます)。

readOnly

boolean

readOnly 値 true は、VolumeMounts の readOnly 設定を強制的に実行します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

volumeID

string

volumeID は、AWS の永続ディスクリソースの一意の ID です (Amazon EBS ボリューム)。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

5.1.347. .spec.install.spec.deployments[].spec.template.spec.volumes[].azureDisk

説明
azureDisk は、ホスト上の Azure Data Disk マウントを表し、Pod へのバインドマウントを表します。非推奨: AzureDisk は非推奨です。ツリー内 azureDisk タイプのすべての操作は、disk.csi.azure.com CSI ドライバーにリダイレクトされます。
object
必須
  • diskName
  • diskURI
Expand
プロパティー説明

cachingMode

string

cachingMode はホストキャッシュモードです (None, Read Only, Read Write)。

diskName

string

diskName は、Blob ストレージ内のデータディスクの名前です。

diskURI

string

diskURI は、Blob ストレージ内のデータディスクの URI です

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

kind

string

kind での期待値は、Shared (ストレージアカウントごとに複数のブロブディスク)、Dedicated (ストレージアカウントごとにブロブ 1 つ)、Managed (Azure の管理データディスク (管理対象のアベイラビリティーセットのみ)) です。デフォルトは Shared です。

readOnly

boolean

readOnly。デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

5.1.348. .spec.install.spec.deployments[].spec.template.spec.volumes[].azureFile

説明
azureFile は、ホスト上の Azure File Service マウントを表し、マウントを Pod にバインドします。非推奨: AzureFile は非推奨です。ツリー内 azureFile タイプのすべての操作は、file.csi.azure.com CSI ドライバーにリダイレクトされます。
object
必須
  • secretName
  • shareName
Expand
プロパティー説明

readOnly

boolean

readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

secretName

string

secretName は、Azure ストレージアカウント名とキーを含むシークレットの名前です。

shareName

string

shareName は Azure 共有名です。

5.1.349. .spec.install.spec.deployments[].spec.template.spec.volumes[].cephfs

説明
cephFS は、Pod の有効期間を共有するホストでの Ceph FS マウントを表します。非推奨: CephFS は非推奨であり、ツリー内の cephfs タイプはサポートされなくなりました。
object
必須
  • monitors
Expand
プロパティー説明

monitors

array (string)

monitors は必須: Monitors は Ceph モニターのコレクションです。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

path

string

パスは任意: 完全な Ceph ツリーではなく、マウントされたルートとして使用されます。デフォルトは / です。

readOnly

boolean

readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

secretFile

string

secretFile は任意: SecretFile はユーザーのキーリングへのパスです。デフォルトは /etc/ceph/user.secret です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

secretRef

object

secretRef は任意: SecretRef はユーザーの認証シークレットへの参照で、デフォルトは空です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

user

string

user 任意: User は rados ユーザー名、デフォルトは admin です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

5.1.350. .spec.install.spec.deployments[].spec.template.spec.volumes[].cephfs.secretRef

説明
secretRef は任意: SecretRef はユーザーの認証シークレットへの参照で、デフォルトは空です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
object
Expand
プロパティー説明

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

5.1.351. .spec.install.spec.deployments[].spec.template.spec.volumes[].cinder

説明
Cinder は、kubelets ホストマシンに接続およびマウントされた Cinder ボリュームを表します。非推奨: Cinder は非推奨です。インツリー cinder タイプのすべての操作は、cinder.csi.openstack.org CSI ドライバーにリダイレクトされます。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md
object
必須
  • volumeID
Expand
プロパティー説明

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md

readOnly

boolean

readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md

secretRef

object

secretRef は任意: OpenStack への接続に使用されるパラメーターを含むシークレットオブジェクトを指します。

volumeID

string

cinder 内のボリュームを識別するために使用される volumeID。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md

5.1.352. .spec.install.spec.deployments[].spec.template.spec.volumes[].cinder.secretRef

説明
secretRef は任意: OpenStack への接続に使用されるパラメーターを含むシークレットオブジェクトを指します。
object
Expand
プロパティー説明

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

5.1.353. .spec.install.spec.deployments[].spec.template.spec.volumes[].configMap

説明
configMap は、このボリュームに入力する必要がある configMap を表します
object
Expand
プロパティー説明

defaultMode

integer

defaultMode は任意: デフォルトで、作成されたファイルのアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。デフォルトは 0644 に設定されます。パス内のディレクトリーはこの設定の影響を受けません。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。

items

array

item が指定されていない場合、参照される ConfigMap の Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。ConfigMap に存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。

items[]

object

文字列キーをボリューム内のパスにマップします。

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

5.1.354. .spec.install.spec.deployments[].spec.template.spec.volumes[].configMap.items

説明
item が指定されていない場合、参照される ConfigMap の Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。ConfigMap に存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
array

5.1.355. .spec.install.spec.deployments[].spec.template.spec.volumes[].configMap.items[]

説明
文字列キーをボリューム内のパスにマップします。
object
必須
  • key
  • path
Expand
プロパティー説明

key

string

key はプロジェクトのキーです。

mode

integer

mode は任意: このファイルにアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。指定しない場合、ボリューム defaultMode が使用されます。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。

path

string

path はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。

5.1.356. .spec.install.spec.deployments[].spec.template.spec.volumes[].csi

説明
csi (Container Storage Interface) は、特定の外部 CSI ドライバーによって処理される一時ストレージを表します。
object
必須
  • driver
Expand
プロパティー説明

driver

string

driver は、このボリュームを処理する CSI ドライバーの名前です。クラスターに登録されている正しい名前は、管理者に相談してください。

fsType

string

マウントする fsType。例: "ext4"、"xfs"、"ntfs"。指定しない場合、空の値が関連する CSI ドライバーに渡され、適用するデフォルトのファイルシステムが決定されます。

nodePublishSecretRef

object

nodePublishSecretRef は、CSI NodePublishVolume および NodeUnpublishVolume 呼び出しを完了するために CSI ドライバーに渡す機密情報を含むシークレットオブジェクトへの参照です。このフィールドはオプションであり、シークレットが不要な場合は空の場合があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレット参照が渡されます。

readOnly

boolean

readOnly は、ボリュームの読み取り専用設定を指定します。デフォルトは false (読み取り/書き込み) です。

volumeAttributes

object (string)

volumeAttributes は、CSI ドライバーに渡されるドライバー固有のプロパティーを格納します。サポートされている値は、ドライバーのドキュメントを参照してください。

5.1.357. .spec.install.spec.deployments[].spec.template.spec.volumes[].csi.nodePublishSecretRef

説明
nodePublishSecretRef は、CSI NodePublishVolume および NodeUnpublishVolume 呼び出しを完了するために CSI ドライバーに渡す機密情報を含むシークレットオブジェクトへの参照です。このフィールドはオプションであり、シークレットが不要な場合は空の場合があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレット参照が渡されます。
object
Expand
プロパティー説明

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

5.1.358. .spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI

説明
downwardAPI は、このボリュームに入力する必要がある Pod に関する Downward API を表します
object
Expand
プロパティー説明

defaultMode

integer

オプション: デフォルトで作成されたファイルで使用するモードビット。オプション: デフォルトで作成されたファイルのパーミッションを設定するために使用されるモードビット。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。デフォルトは 0644 に設定されます。パス内のディレクトリーはこの設定の影響を受けません。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。

items

array

items は、Downward API ボリュームファイルのリストです

items[]

object

DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します

5.1.359. .spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI.items

説明
items は、Downward API ボリュームファイルのリストです
array

5.1.360. .spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI.items[]

説明
DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します
object
必須
  • path
Expand
プロパティー説明

fieldRef

object

必須: Pod のフィールドを選択します。アノテーション、ラベル、名前、namespace、および UID のみがサポートされています。

mode

integer

オプション: このファイルの権限を設定するために使用されるモードビットは、0000 から 0777 までの 8 進数値、または 0 から 511 までの 10 進数値でなければなりません。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。指定しない場合、ボリューム defaultMode が使用されます。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。

path

string

必須: パスは、作成するファイルの相対パス名です。絶対パスまたは '..' パスを含めることはできません。utf-8 でエンコードする必要があります。相対パスの最初の項目は '..' で始まってはなりません。

resourceFieldRef

object

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

5.1.361. .spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI.items[].fieldRef

説明
必須: Pod のフィールドを選択します。アノテーション、ラベル、名前、namespace、および UID のみがサポートされています。
object
必須
  • fieldPath
Expand
プロパティー説明

apiVersion

string

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

fieldPath

string

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

5.1.362. .spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI.items[].resourceFieldRef

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

containerName

string

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

divisor

integer-or-string

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

resource

string

必須: 選択するリソース

5.1.363. .spec.install.spec.deployments[].spec.template.spec.volumes[].emptyDir

説明
emptyDir は、Pod の存続期間を共有する一時ディレクトリーを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
object
Expand
プロパティー説明

medium

string

medium は、このディレクトリーをバックアップする必要があるストレージメディアのタイプを表します。デフォルトは"" です。これは、ノードのデフォルトのメディアを使用することを意味します。空の文字列 (デフォルト) またはメモリーである必要があります。詳細: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

sizeLimit

integer-or-string

sizeLimit は、この EmptyDir ボリュームに必要なローカルストレージの合計量です。サイズ制限はメモリーメディアにも適用されます。メモリーメディア EmptyDir での最大使用量は、ここで指定された SizeLimit と Pod 内のすべてのコンテナーのメモリー制限の合計との間の最小値になります。デフォルトは nil です。これは、制限が未定義であることを意味します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

5.1.364. .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral

説明

ephemeral は、クラスターストレージドライバーによって処理されるボリュームを表します。ボリュームのライフサイクルは、ボリュームを定義する Pod に関連付けられています。ボリュームは、Pod が起動する前に作成され、Pod が削除されると削除されます。

これは、次の場合に使用します。a)Pod の実行中にのみボリュームが必要、b) スナップショットからの復元や容量追跡などの通常のボリュームの機能が必要、c) ストレージドライバーがストレージクラスを通じて指定される、d) ストレージドライバー PersistentVolumeClaim を介した動的ボリュームプロビジョニングをサポートします (このボリュームタイプと PersistentVolumeClaim の間の接続の詳細は、EphemeralVolumeSource を参照してください)。

個々の Pod のライフサイクルより長く持続するボリュームには、PersistentVolumeClaim またはベンダー固有の API の 1 つを使用します。

CSI ドライバーをそのように使用する場合は、軽量のローカルエフェメラルボリュームに CSI を使用します。詳細は、ドライバーのドキュメントを参照してください。

Pod は、両方のタイプのエフェメラルボリュームとパーシステントボリュームを同時に使用できます。

object
Expand
プロパティー説明

volumeClaimTemplate

object

ボリュームをプロビジョニングするためのスタンドアロン PVC を作成するために使用されます。この EphemeralVolumeSource が埋め込まれている Pod が PVC の所有者になります。つまり、PVC は Pod と一緒に削除されます。PVC の名前は <pod name>-<volume name> になります。ここで、<volume name>PodSpec.Volumes アレイエントリーからの名前です。連結された名前が PVC に対して有効でない場合 (たとえば、長すぎる場合)、Pod 検証は Pod を拒否します。

Pod が所有していないその名前の既存の PVC は、無関係なボリュームを誤って使用することを避けるために、Pod に使用され ません。Pod の起動は、無関係の PVC が削除されるまでブロックされます。そのような事前に作成された PVC が Pod で使用されることを意図している場合、Pod が存在すると、PVC は Pod への所有者参照で更新する必要があります。通常、これは必要ありませんが、壊れたクラスターを手動で再構築する場合に役立つことがあります。

このフィールドは読み取り専用であり、作成後に Kubernetes が PVC に変更を加えることはありません。

必須です。nil であってはなりません。

5.1.365. .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate

説明

ボリュームをプロビジョニングするためのスタンドアロン PVC を作成するために使用されます。この EphemeralVolumeSource が埋め込まれている Pod が PVC の所有者になります。つまり、PVC は Pod と一緒に削除されます。PVC の名前は <pod name>-<volume name> になります。ここで、<volume name>PodSpec.Volumes アレイエントリーからの名前です。連結された名前が PVC に対して有効でない場合 (たとえば、長すぎる場合)、Pod 検証は Pod を拒否します。

Pod が所有していないその名前の既存の PVC は、無関係なボリュームを誤って使用することを避けるために、Pod に使用され ません。Pod の起動は、無関係の PVC が削除されるまでブロックされます。そのような事前に作成された PVC が Pod で使用されることを意図している場合、Pod が存在すると、PVC は Pod への所有者参照で更新する必要があります。通常、これは必要ありませんが、壊れたクラスターを手動で再構築する場合に役立つことがあります。

このフィールドは読み取り専用であり、作成後に Kubernetes が PVC に変更を加えることはありません。

必須です。nil であってはなりません。

object
必須
  • spec
Expand
プロパティー説明

metadata

object

PVC の作成時に PVC にコピーされるラベルとアノテーションが含まれる場合があります。他のフィールドは許可されておらず、検証中に拒否されます。

spec

object

PersistentVolumeClaim の仕様。コンテンツ全体が、このテンプレートから作成された PVC に変更されずにコピーされます。PersistentVolumeClaim と同じフィールドがここでも有効です。

5.1.366. .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.metadata

説明
PVC の作成時に PVC にコピーされるラベルとアノテーションが含まれる場合があります。他のフィールドは許可されておらず、検証中に拒否されます。
object

5.1.367. .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec

説明
PersistentVolumeClaim の仕様。コンテンツ全体が、このテンプレートから作成された PVC に変更されずにコピーされます。PersistentVolumeClaim と同じフィールドがここでも有効です。
object
Expand
プロパティー説明

accessModes

array (string)

accessModes には、ボリュームに割り当てる必要のあるアクセスモードが含まれます。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

dataSource

object

dataSource フィールドは、次のいずれかを指定するために使用できます。*既存の VolumeSnapshot オブジェクト (snapshot.storage.k8s.io/VolumeSnapshot)*既存の PVC(PersistentVolumeClaim) プロビジョナーまたは外部コントローラーが指定されたデータソースをサポートできる場合、指定されたデータソースのコンテンツに基づく新しいボリューム。AnyVolumeDataSource フィーチャーゲートが有効になっている場合、dataSource の内容は dataSourceRef にコピーされ、dataSourceRef.namespace が指定されていない場合に dataSourceRef コンテンツが dataSource にコピーされます。namespace が指定されている場合、dataSourceRef は dataSource にコピーされません。

dataSourceRef

object

dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これには、空ではない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のオブジェクトを指定できます。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、dataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性を確保するために、dataSourceRef で namespace が指定されておらず、一方が空でもう一方が空でない場合、両方のフィールド (dataSource と dataSourceRef) が自動的に同じ値に設定されます。dataSourceRef で namespace が指定されている場合、dataSource は同じ値に設定されていないため、空にする必要があります。dataSource と dataSourceRef には 3 つの重要な違いがあります。* dataSource では 2 つの特定のタイプのオブジェクトのみが使用できますが、dataSourceRef ではコアオブジェクト以外および PersistentVolumeClaim オブジェクトを使用できます。* dataSource は使用できない値を無視 (ドロップ) しますが、dataSourceRef はすべての値を保持し、使用できない値が指定された場合はエラーを生成します。* dataSource ではローカルオブジェクトのみが使用できますが、dataSourceRef では任意の namespace のオブジェクトを使用できます。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。(アルファ版) dataSourceRef の namespace フィールドを使用するには、CrossNamespaceVolumeDataSource フィーチャーゲートを有効にする必要があります。

resources

object

resources は、ボリュームに必要な最小リソースを表します。RecoverVolumeExpansionFailure 機能が有効になっている場合、ユーザーは以前の値よりも低いリソース要件を指定できますが、要求のステータスフィールドに記録された容量よりも大きい必要があります。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

selector

object

selector は、バインドを考慮するボリュームに対するラベルクエリーです。

storageClassName

string

storageClassName は、要求に必要な StorageClass の名前です。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

volumeAttributesClassName

string

volumeAttributesClassName は、このクレームで使用される VolumeAttributesClass を設定するために使用できます。指定すると、CSI ドライバーは、対応する VolumeAttributesClass で定義された属性を使用してボリュームを作成または更新します。これは storageClassName とは異なる目的があり、クレームの作成後に変更できます。空の文字列値は、クレームに VolumeAttributesClass が適用されないことを意味しますが、一度設定すると、このフィールドを空の文字列にリセットすることはできません。指定されておらず、PersistentVolumeClaim がバインドされていない場合は、永続ボリュームコントローラーが存在する場合は、デフォルトの VolumeAttributesClass が設定されます。volumeAttributesClass によって参照されるリソースが存在しない場合は、そのようなリソースが存在するまで、この PersistentVolumeClaim は、modifyVolumeStatus フィールドに反映されるように、保留状態に設定されます。詳細は、https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ (ベータ版) を参照してください。このフィールドを使用するには、VolumeAttributesClass フィーチャーゲートを有効にする必要があります (デフォルトではオフ)。

volumeMode

string

volumeMode は、要求に必要なボリュームのタイプを定義します。Filesystem の値は、要求仕様に含まれていない場合に暗示されます。

volumeName

string

volumeName は、この要求をサポートする PersistentVolume へのバインディング参照です。

5.1.368. .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSource

説明
dataSource フィールドは、次のいずれかを指定するために使用できます。*既存の VolumeSnapshot オブジェクト (snapshot.storage.k8s.io/VolumeSnapshot)*既存の PVC(PersistentVolumeClaim) プロビジョナーまたは外部コントローラーが指定されたデータソースをサポートできる場合、指定されたデータソースのコンテンツに基づく新しいボリューム。AnyVolumeDataSource フィーチャーゲートが有効になっている場合、dataSource の内容は dataSourceRef にコピーされ、dataSourceRef.namespace が指定されていない場合に dataSourceRef コンテンツが dataSource にコピーされます。namespace が指定されている場合、dataSourceRef は dataSource にコピーされません。
object
必須
  • kind
  • name
Expand
プロパティー説明

apiGroup

string

APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。

kind

string

kind は参照されているリソースのタイプです。

name

string

name は、参照されているリソースの名前です。

5.1.369. .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef

説明
dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これには、空ではない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のオブジェクトを指定できます。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、dataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性を確保するために、dataSourceRef で namespace が指定されておらず、一方が空でもう一方が空でない場合、両方のフィールド (dataSource と dataSourceRef) が自動的に同じ値に設定されます。dataSourceRef で namespace が指定されている場合、dataSource は同じ値に設定されていないため、空にする必要があります。dataSource と dataSourceRef には 3 つの重要な違いがあります。* dataSource では 2 つの特定のタイプのオブジェクトのみが使用できますが、dataSourceRef ではコアオブジェクト以外および PersistentVolumeClaim オブジェクトを使用できます。* dataSource は使用できない値を無視 (ドロップ) しますが、dataSourceRef はすべての値を保持し、使用できない値が指定された場合はエラーを生成します。* dataSource ではローカルオブジェクトのみが使用できますが、dataSourceRef では任意の namespace のオブジェクトを使用できます。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。(アルファ版) dataSourceRef の namespace フィールドを使用するには、CrossNamespaceVolumeDataSource フィーチャーゲートを有効にする必要があります。
object
必須
  • kind
  • name
Expand
プロパティー説明

apiGroup

string

APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。

kind

string

kind は参照されているリソースのタイプです。

name

string

name は、参照されているリソースの名前です。

namespace

string

Namespace は、参照されるリソースの namespace です。namespace が指定されている場合は、その namespace の所有者が参照を受け入れることができるように、参照された namespace に gateway.networking.k8s.io/ReferenceGrant オブジェクトが必要であることに注意してください。詳細は、ReferenceGrant ドキュメントを参照してください。(アルファ版) このフィールドでは、CrossNamespaceVolumeDataSource フィーチャーゲートを有効にする必要があります。

5.1.370. .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.resources

説明
resources は、ボリュームに必要な最小リソースを表します。RecoverVolumeExpansionFailure 機能が有効になっている場合、ユーザーは以前の値よりも低いリソース要件を指定できますが、要求のステータスフィールドに記録された容量よりも大きい必要があります。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
object
Expand
プロパティー説明

limits

integer-or-string

limits は、許可されるコンピュートリソースの最大量を示します。詳細: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

requests は、必要なコンピュートリソースの最小量を示します。コンテナーで Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。リクエストは制限を超えることはできません。詳細: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

5.1.371. .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector

説明
selector は、バインドを考慮するボリュームに対するラベルクエリーです。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

5.1.374. .spec.install.spec.deployments[].spec.template.spec.volumes[].fc

説明
fc は、kubelet のホストマシンに接続されてから Pod に公開されるファイバーチャネルリソースを表します。
object
Expand
プロパティー説明

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

lun

integer

LUN は任意: FC ターゲットの LUN 番号

readOnly

boolean

readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

targetWWNs

array (string)

targetWWNs は任意: FC ターゲットのワールドワイド名 (WWN)

wwids

array (string)

wwids は任意: FC ボリュームのワールドワイド ID(wwids)wwids または targetWWN と lun の組み合わせのいずれかを設定する必要がありますが、両方を同時に設定できません。

5.1.375. .spec.install.spec.deployments[].spec.template.spec.volumes[].flexVolume

説明
flexVolume は、exec ベースのプラグインを使用してプロビジョニング/接続される汎用ボリュームリソースを表します。非推奨: FlexVolume は非推奨です。代わりに CSIDriver の使用を検討してください。
object
必須
  • driver
Expand
プロパティー説明

driver

string

driver は、このボリュームに使用するドライバーの名前です。

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。デフォルトのファイルシステムは FlexVolume スクリプトに依存します。

options

object (string)

options は任意: このフィールドには追加のコマンドオプションがあれば保持されます。

readOnly

boolean

readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

secretRef

object

secretRef は任意: secretRef は、プラグインスクリプトに渡す機密情報を含むシークレットオブジェクトへの参照です。シークレットオブジェクトが指定されていない場合、これは空になる可能性があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレットがプラグインスクリプトに渡されます。

5.1.376. .spec.install.spec.deployments[].spec.template.spec.volumes[].flexVolume.secretRef

説明
secretRef は任意: secretRef は、プラグインスクリプトに渡す機密情報を含むシークレットオブジェクトへの参照です。シークレットオブジェクトが指定されていない場合、これは空になる可能性があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレットがプラグインスクリプトに渡されます。
object
Expand
プロパティー説明

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

5.1.377. .spec.install.spec.deployments[].spec.template.spec.volumes[].flocker

説明
flocker は、kubelet のホストマシンに接続されている Flocker ボリュームを表します。これは、実行中の Flocker 制御サービスによって異なります非推奨: Flocker は非推奨であり、ツリー内の Flocker タイプはサポートされなくなりました。
object
Expand
プロパティー説明

datasetName

string

datasetName はメタデータとして保存されているデータセットの名前です → Flocker のデータセット上の名前は非推奨として扱うようにしてください。

datasetUUID

string

datasetUUID は、データセットの UUID です。これは Flocker データセットの一意の識別子です

5.1.378. .spec.install.spec.deployments[].spec.template.spec.volumes[].gcePersistentDisk

説明
gcePersistentDisk は、kubelet のホストマシンに接続されてから Pod に公開される GCE ディスクリソースを表します。非推奨: GCEPersistentDisk は非推奨です。インツリー gcePersistentDisk タイプのすべての操作は、pd.csi.storage.gke.io CSI ドライバーにリダイレクトされます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
object
必須
  • pdName
Expand
プロパティー説明

fsType

string

fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

partition

integer

partition は、マウントするボリューム内のパーティションです。省略した場合、デフォルトではボリューム名でマウントします。例: ボリューム/dev/sda1 の場合、パーティションを "1" として指定します。同様に、/dev/sda のボリュームパーティションは "0" です (または、プロパティーを空のままにしておくこともできます)。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

pdName

string

pdName は、GCE の PD リソースの一意の名前です。GCE でディスクを識別するために使用されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

readOnly

boolean

この readOnly は、VolumeMounts で ReadOnly 設定が強制的に指定されます。デフォルトは false です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

5.1.379. .spec.install.spec.deployments[].spec.template.spec.volumes[].gitRepo

説明
gitRepo は、特定のリビジョンの git リポジトリーを表します。非推奨: GitRepo は非推奨となりました。git リポジトリーを使用してコンテナーをプロビジョニングするには、Git を使用してリポジトリーのクローンを作成する InitContainer に EmptyDir をマウントしてから、Pod のコンテナーに EmptyDir をマウントします。
object
必須
  • repository
Expand
プロパティー説明

directory

string

directory は、ターゲットディレクトリー名です。'..' を含まない、または..で始まらないようにする必要があります。もしも '。' が提供されている場合、ボリュームディレクトリーは git リポジトリーになります。それ以外の場合、指定されている場合、ボリュームには、指定された名前のサブディレクトリーに git リポジトリーが含まれます。

repository

string

repository は URL です。

revision

string

revision は、指定されたリビジョンのコミットハッシュです。

5.1.380. .spec.install.spec.deployments[].spec.template.spec.volumes[].glusterfs

説明
glusterfs は、Pod の存続期間を共有するホスト上の Glusterfs マウントを表します。非推奨: Glusterfs は非推奨であり、ツリー内の glusterfs タイプはサポートされなくなりました。詳細: https://examples.k8s.io/volumes/glusterfs/README.md
object
必須
  • endpoints
  • path
Expand
プロパティー説明

endpoints

string

endpoints は、Glusterfs トポロジーの詳細を示すエンドポイント名です。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

path

string

path は Glusterfs ボリュームパスです。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

readOnly

boolean

この readOnly は、Glusterfs ボリュームを読み取り専用のアクセス権限で強制的にマウントします。デフォルトは false です。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

5.1.381. .spec.install.spec.deployments[].spec.template.spec.volumes[].hostPath

説明
hostPath は、コンテナーに直接公開されているホストマシン上の既存のファイルまたはディレクトリーを表します。これは通常、ホストマシンの表示を許可されているシステムエージェントまたはその他の特権的なものに使用されます。ほとんどのコンテナーはこれを必要としません。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
object
必須
  • path
Expand
プロパティー説明

path

string

ホスト上のディレクトリーのパス。パスがシンボリックリンクの場合、実際のパスへのリンクをたどります。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

type

string

HostPath ボリュームのデフォルトのタイプは "" です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

5.1.382. .spec.install.spec.deployments[].spec.template.spec.volumes[].image

説明

image は、kubelet のホストマシンにプルおよびマウントされた OCI オブジェクト (コンテナーイメージまたはアーティファクト) を表します。ボリュームは、提供される PullPolicy 値に応じて Pod の起動時に解決されます。

  • Always: kubelet は常に参照をプルしようとします。プルに失敗すると、コンテナーの作成は失敗します。
  • Never: kubelet は参照をプルせず、ローカルイメージまたはアーティファクトのみを使用します。参照が存在しない場合は、コンテナーの作成に失敗します。
  • IfNotPresent: 参照がディスクに存在しない場合は、kubelet がプルします。参照が存在しず、プルが失敗すると、コンテナーの作成は失敗します。

Pod が削除されて再作成されるとボリュームが再度解決され、Pod の再作成時に新しいリモートコンテンツが利用可能になります。Pod の起動中にイメージを解決またはプルできない場合、コンテナーの起動がブロックされ、大幅な遅延が発生する可能性があります。失敗した場合は通常のボリュームバックオフを使用して再試行され、理由とメッセージが Pod で報告されます。このボリュームによってマウントされる可能性のあるオブジェクトのタイプは、ホストマシン上のコンテナーランタイム実装によって定義され、少なくともコンテナーイメージフィールドでサポートされているすべての有効なタイプが含まれている必要があります。OCI オブジェクトは、コンテナーイメージの場合と同じ方法でマニフェストレイヤーをマージすることで、単一ディレクトリー (spec.containers[].volumeMounts.mountPath) にマウントされます。ボリュームは、読み取り専用 (ro) および実行不可ファイル (noexec) としてマウントされます。コンテナーのサブパスマウント (spec.containers[].volumeMounts.subpath) は、バージョン 1.33 より前ではサポートされていません。spec.securityContext.fsGroupChangePolicy フィールドは、このボリュームタイプには影響しません。

object
Expand
プロパティー説明

pullPolicy

string

OCI オブジェクトをプルするためのポリシー。使用できる値: Always: kubelet は常に参照のプルを試行します。プルに失敗すると、コンテナーの作成は失敗します。Never: kubelet は参照をプルせず、ローカルイメージまたはアーティファクトのみを使用します。参照が存在しない場合は、コンテナーの作成に失敗します。IfNotPresent: 参照がディスクに存在しない場合は、kubelet がプルします。参照が存在しず、プルが失敗すると、コンテナーの作成は失敗します。デフォルトは、:latest タグが指定されている場合は常に、それ以外の場合は IfNotPresent です。

reference

string

必須: 使用するイメージまたはアーティファクトの参照。pod.spec.containers[*].image と同じように動作します。プルシークレットは、ノード認証情報、SA イメージプルシークレット、および Pod 仕様イメージプルシークレットを検索することで、コンテナーイメージの場合と同じ方法でアセンブルされます。詳細: https://kubernetes.io/docs/concepts/containers/images このフィールドはオプションであり、高レベルの設定管理で、Deployments や StatefulSets などのワークロードコントローラーのコンテナーイメージをデフォルトまたはオーバーライドできます。

5.1.383. .spec.install.spec.deployments[].spec.template.spec.volumes[].iscsi

説明
iscsi は、kubelet のホストマシンに接続されてから Pod に公開される ISCSI ディスクリソースを表します。詳細: https://examples.k8s.io/volumes/iscsi/README.md
object
必須
  • iqn
  • lun
  • targetPortal
Expand
プロパティー説明

chapAuthDiscovery

boolean

chapAuthDiscovery は、iSCSI 検出 CHAP 認証をサポートするかどうかを定義します。

chapAuthSession

boolean

chapAuthSession は、iSCSI セッション CHAP 認証をサポートするかどうかを定義します。

fsType

string

fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#iscsi

initiatorName

string

initiatorName は、カスタムの iSCSI イニシエーター名です。iscsiInterface と同時に initiatorName を指定すると、接続用に新しい iSCSI インターフェイス <target portal>:<volume name> が作成されます。

iqn

string

iqn は、ターゲットの iSCSI 修飾名です。

iscsiInterface

string

iscsiInterface は、iSCSI トランスポートを使用するインターフェイス名です。デフォルトは 'default' (tcp) です。

lun

integer

lun は、iSCSI ターゲット Lun 番号を表します。

portals

array (string)

ポータルは iSCSI ターゲットポータルリストです。ポートがデフォルト以外の場合、ポータルは IP または ip_addr:port のいずれかです (通常は TCP ポート 860 および 3260)。

readOnly

boolean

この readOnly は、VolumeMounts で ReadOnly 設定が強制的に指定されます。デフォルトは false です。

secretRef

object

secretRef は、iSCSI ターゲットおよびイニシエーター認証用の CHAP Secret です。

targetPortal

string

targetPortal は iSCSI Target Portal です。ポートがデフォルト以外の場合、ポータルは IP または ip_addr:port のいずれかです (通常は TCP ポート 860 および 3260)。

5.1.384. .spec.install.spec.deployments[].spec.template.spec.volumes[].iscsi.secretRef

説明
secretRef は、iSCSI ターゲットおよびイニシエーター認証用の CHAP Secret です。
object
Expand
プロパティー説明

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

5.1.385. .spec.install.spec.deployments[].spec.template.spec.volumes[].nfs

説明
NFS は、Pod の有効期間を共有するホスト上の NFS マウントを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs
object
必須
  • path
  • server
Expand
プロパティー説明

path

string

NFS サーバーがエクスポートしているパス。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs

readOnly

boolean

ここで readOnly を指定すると、NFS エクスポートが読み取り専用権限で強制的にマウントされます。デフォルトは false です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs

server

string

server は、NFS サーバーのホスト名または IP アドレスです。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs

5.1.386. .spec.install.spec.deployments[].spec.template.spec.volumes[].persistentVolumeClaim

説明
persistentVolumeClaimVolumeSource は、同じ namespace 内の PersistentVolumeClaim への参照を表します。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
object
必須
  • claimName
Expand
プロパティー説明

claimName

string

claimName は、このボリュームを使用する Pod と同じ namespace にある PersistentVolumeClaim の名前です。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

readOnly

boolean

readOnly は、VolumeMounts の ReadOnly 設定が強制的に指定されます。デフォルト: false

5.1.387. .spec.install.spec.deployments[].spec.template.spec.volumes[].photonPersistentDisk

説明
photonPersistentDisk は、kubelets ホストマシンに接続されマウントされた PhotonController 永続ディスクを表します。非推奨: PhotonPersistentDisk は非推奨であり、ツリー内の photonPersistentDisk タイプはサポートされなくなりました。
object
必須
  • pdID
Expand
プロパティー説明

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

pdID

string

pdID は、Photon Controller の永続ディスクを識別する ID です。

5.1.388. .spec.install.spec.deployments[].spec.template.spec.volumes[].portworxVolume

説明
portworxVolume は、kubelet ホストマシンに接続およびマウントされた portworx ボリュームを表します。非推奨: PortworxVolume は非推奨です。CSIMigrationPortworx フィーチャーゲートがオンの場合、ツリー内 portworxVolume タイプのすべての操作は pxd.portworx.com CSI ドライバーにリダイレクトされます。
object
必須
  • volumeID
Expand
プロパティー説明

fsType

string

fSType は、マウントするファイルシステムタイプを表します。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

readOnly

boolean

readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

volumeID

string

volumeID は、Portworx ボリュームを一意に識別します

5.1.389. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected

説明
オールインワンリソースシークレット、configmaps、および Downward API のアイテム
object
Expand
プロパティー説明

defaultMode

integer

defaultMode は、作成されたファイルにデフォルトでアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。パス内のディレクトリーはこの設定の影響を受けません。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。

sources

array

sources は、ボリュームプロジェクションのリストです。このリストの各エントリーは 1 つのソースを処理します。

sources[]

object

サポートされている他のボリュームタイプと一緒にデプロイメントされる可能性のあるプロジェクションこれらのフィールドのいずれかを設定する必要があります。

5.1.390. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources

説明
sources は、ボリュームプロジェクションのリストです。このリストの各エントリーは 1 つのソースを処理します。
array

5.1.391. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[]

説明
サポートされている他のボリュームタイプと一緒にデプロイメントされる可能性のあるプロジェクションこれらのフィールドのいずれかを設定する必要があります。
object
Expand
プロパティー説明

clusterTrustBundle

object

ClusterTrustBundle を使用すると、Pod が自動更新ファイル内の ClusterTrustBundle オブジェクトの .spec.trustBundle フィールドにアクセスできるようになります。

アルファ段階。ClusterTrustBundleProjection フィーチャーゲートによってゲートされます。

ClusterTrustBundle オブジェクトは、名前で選択することも、署名者名とラベルセレクターの組み合わせで選択することもできます。

Kubelet は、Pod ファイルシステムに書き込まれた PEM コンテンツの積極的な正規化を実行します。ブロック間コメントやブロックヘッダーなどの難解な PEM 機能は削除されます。証明書は重複排除されます。ファイル内の証明書の順序は任意です。Kubelet は時間の経過に伴い順序を変更する可能性があります。

configMap

object

プロジェクトへの configMap データの configMap 情報

downwardAPI

object

downwardAPI データのプロジェクトへの downwardAPI 情報

secret

object

投影するシークレットデータに関する情報

serviceAccountToken

object

serviceAccountToken は、投影する serviceAccountToken データに関する情報です。

5.1.392. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].clusterTrustBundle

説明

ClusterTrustBundle を使用すると、Pod が自動更新ファイル内の ClusterTrustBundle オブジェクトの .spec.trustBundle フィールドにアクセスできるようになります。

アルファ段階。ClusterTrustBundleProjection フィーチャーゲートによってゲートされます。

ClusterTrustBundle オブジェクトは、名前で選択することも、署名者名とラベルセレクターの組み合わせで選択することもできます。

Kubelet は、Pod ファイルシステムに書き込まれた PEM コンテンツの積極的な正規化を実行します。ブロック間コメントやブロックヘッダーなどの難解な PEM 機能は削除されます。証明書は重複排除されます。ファイル内の証明書の順序は任意です。Kubelet は時間の経過に伴い順序を変更する可能性があります。

object
必須
  • path
Expand
プロパティー説明

labelSelector

object

このラベルセレクターに一致するすべての ClusterTrustBundle を選択します。signerName が設定されている場合にのみ有効です。名前と相互に排他的です。設定されていない場合は、"何も一致しない" と解釈されます。設定されているが空の場合は、"すべてに一致する" と解釈されます。

name

string

オブジェクト名で単一の ClusterTrustBundle を選択します。signerName および labelSelector とは相互に排他的です。

optional

boolean

true の場合で、参照された ClusterTrustBundle が利用できない場合は、Pod の起動をブロックしないでください。名前を使用する場合、名前付き ClusterTrustBundle が存在しないことが許可されます。signerName を使用する場合、signerName と labelSelector の組み合わせは、0 個の ClusterTrustBundles と一致できます。

path

string

バンドルを書き込むためのボリュームルートからの相対パス。

signerName

string

この署名者名に一致するすべての ClusterTrustBundle を選択します。名前と相互に排他的です。選択されたすべての ClusterTrustBundle の内容が統合され、重複が排除されます。

5.1.393. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].clusterTrustBundle.labelSelector

説明
このラベルセレクターに一致するすべての ClusterTrustBundle を選択します。signerName が設定されている場合にのみ有効です。名前と相互に排他的です。設定されていない場合は、"何も一致しない" と解釈されます。設定されているが空の場合は、"すべてに一致する" と解釈されます。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

5.1.396. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].configMap

説明
プロジェクトへの configMap データの configMap 情報
object
Expand
プロパティー説明

items

array

item が指定されていない場合、参照される ConfigMap の Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。ConfigMap に存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。

items[]

object

文字列キーをボリューム内のパスにマップします。

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

5.1.397. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].configMap.items

説明
item が指定されていない場合、参照される ConfigMap の Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。ConfigMap に存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
array

5.1.398. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].configMap.items[]

説明
文字列キーをボリューム内のパスにマップします。
object
必須
  • key
  • path
Expand
プロパティー説明

key

string

key はプロジェクトのキーです。

mode

integer

mode は任意: このファイルにアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。指定しない場合、ボリューム defaultMode が使用されます。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。

path

string

path はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。

5.1.399. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].downwardAPI

説明
downwardAPI データのプロジェクトへの downwardAPI 情報
object
Expand
プロパティー説明

items

array

Items は DownwardAPIVolume ファイルのリストです

items[]

object

DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します

5.1.400. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].downwardAPI.items

説明
Items は DownwardAPIVolume ファイルのリストです
array

5.1.401. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].downwardAPI.items[]

説明
DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します
object
必須
  • path
Expand
プロパティー説明

fieldRef

object

必須: Pod のフィールドを選択します。アノテーション、ラベル、名前、namespace、および UID のみがサポートされています。

mode

integer

オプション: このファイルの権限を設定するために使用されるモードビットは、0000 から 0777 までの 8 進数値、または 0 から 511 までの 10 進数値でなければなりません。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。指定しない場合、ボリューム defaultMode が使用されます。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。

path

string

必須: パスは、作成するファイルの相対パス名です。絶対パスまたは '..' パスを含めることはできません。utf-8 でエンコードする必要があります。相対パスの最初の項目は '..' で始まってはなりません。

resourceFieldRef

object

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

5.1.402. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].downwardAPI.items[].fieldRef

説明
必須: Pod のフィールドを選択します。アノテーション、ラベル、名前、namespace、および UID のみがサポートされています。
object
必須
  • fieldPath
Expand
プロパティー説明

apiVersion

string

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

fieldPath

string

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

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

containerName

string

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

divisor

integer-or-string

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

resource

string

必須: 選択するリソース

5.1.404. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].secret

説明
投影するシークレットデータに関する情報
object
Expand
プロパティー説明

items

array

items が指定されていない場合、参照されるシークレットの Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。シークレットに存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。

items[]

object

文字列キーをボリューム内のパスにマップします。

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

オプションフィールドは、シークレットかそのキーを定義する必要があるかどうかを指定します。

5.1.405. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].secret.items

説明
items が指定されていない場合、参照されるシークレットの Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。シークレットに存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
array

5.1.406. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].secret.items[]

説明
文字列キーをボリューム内のパスにマップします。
object
必須
  • key
  • path
Expand
プロパティー説明

key

string

key はプロジェクトのキーです。

mode

integer

mode は任意: このファイルにアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。指定しない場合、ボリューム defaultMode が使用されます。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。

path

string

path はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。

5.1.407. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].serviceAccountToken

説明
serviceAccountToken は、投影する serviceAccountToken データに関する情報です。
object
必須
  • path
Expand
プロパティー説明

audience

string

audience は、トークンの対象オーディエンスです。トークンの受信者は、トークンの audience で指定された識別子で自分自身を識別する必要があります。そうでない場合は、トークンを拒否する必要があります。audience はデフォルトで apiserver の識別子に設定されます。

expirationSeconds

integer

expirationSeconds は、サービスアカウントトークンの要求された有効期間です。トークンの有効期限が近づくと、kubelet ボリュームプラグインはサービスアカウントトークンをプロアクティブにローテーションします。トークンが存続時間の 80% より古い場合、またはトークンが 24 時間より古い場合、kubelet はトークンのローテーションを開始します。デフォルトは 1 時間で、少なくとも 10 分である必要があります。

path

string

path は、トークンのデプロイメント先となるファイルのマウントポイントに対する相対パスです。

5.1.408. .spec.install.spec.deployments[].spec.template.spec.volumes[].quobyte

説明
quobyte は、Pod の有効期限を共有するホストでの Quobyte マウントを表します非推奨: Quobyte は非推奨であり、ツリー内の quobyte タイプはサポートされなくなりました。
object
必須
  • registry
  • volume
Expand
プロパティー説明

group

string

アクセスできるボリュームをマップするグループ。デフォルトは no group です。

readOnly

boolean

ここでの readOnly は、Quobyte ボリュームを読み取り専用のアクセス権限で強制的にマウントします。デフォルトは false です。

registry

string

registry は、host:port ペアの文字列として指定された単一または複数の Quobyte Registry サービスを表し (複数のエントリーはコンマで区切る)、ボリュームの中央レジストリーとして機能します。

tenant

string

動的にプロビジョニングされた Quobyte ボリュームで使用されるバックエンドで指定の Quobyte ボリュームを所有するテナント。値はプラグインにより設定されます。

user

string

アクセスできるボリュームをマップするユーザー。デフォルトは serivceaccount user です。

volume

string

volume は、すでに作成されているクオバイトボリュームを名前で参照する文字列です。

5.1.409. .spec.install.spec.deployments[].spec.template.spec.volumes[].rbd

説明
rbd は、Pod の有効期間を共有するホストの Rados ブロックデバイスマウントを表します。非推奨: RBD は非推奨であり、ツリー内の rbd タイプはサポートされなくなりました。詳細: https://examples.k8s.io/volumes/rbd/README.md
object
必須
  • image
  • monitors
Expand
プロパティー説明

fsType

string

fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#rbd

image

string

image は rados イメージ名です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

keyring

string

keyring は、RBDUser のキーリングへのパスです。デフォルトは/etc/ceph/keyring です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

monitors

array (string)

monitors は Ceph モニターのコレクションです。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

pool

string

pool は rados プール名です。デフォルトは rbd です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

readOnly

boolean

この readOnly は、VolumeMounts で ReadOnly 設定が強制的に指定されます。デフォルトは false です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

secretRef

object

secretRef は、RBDUser の認証シークレットの名前です。提供されている場合、キーリングをオーバーライドします。デフォルトは nil です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

user

string

user は rados ユーザー名です。これにより、プール内にイメージを作成できます。デフォルトは admin です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

5.1.410. .spec.install.spec.deployments[].spec.template.spec.volumes[].rbd.secretRef

説明
secretRef は、RBDUser の認証シークレットの名前です。提供されている場合、キーリングをオーバーライドします。デフォルトは nil です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
object
Expand
プロパティー説明

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

5.1.411. .spec.install.spec.deployments[].spec.template.spec.volumes[].scaleIO

説明
scaleIO は、Kubernetes ノードに接続およびマウントされた ScaleIO 永続ボリュームを表します。非推奨: ScaleIO は非推奨であり、ツリー内の scaleIO タイプはサポートされなくなりました。
object
必須
  • gateway
  • secretRef
  • system
Expand
プロパティー説明

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。デフォルトは "xfs" です。

gateway

string

gateway は、ScaleIO API ゲートウェイのホストアドレスです。

protectionDomain

string

protectionDomain は、設定されたストレージの ScaleIO 保護ドメインの名前です。

readOnly

boolean

readOnly。デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

secretRef

object

secretRef は、ScaleIO ユーザーおよびその他の機密情報の秘密を参照します。これが指定されていない場合、ログイン操作は失敗します。

sslEnabled

boolean

sslEnabled Flag は、ゲートウェイとの SSL 通信を有効/無効にします。デフォルトは false です

storageMode

string

storageMode は、ボリュームのストレージを ThickProvisioned にするか ThinProvisioned にするかを示します。デフォルトは ThinProvisioned です。

storagePool

string

storagePool は、保護ドメインに関連付けられた ScaleIO ストレージプールです。

system

string

system は、ScaleIO で設定されたストレージシステムの名前です。

volumeName

string

volumeName は、このボリュームソースに関連付けられている、ScaleIO システムですでに作成されているボリュームの名前です。

5.1.412. .spec.install.spec.deployments[].spec.template.spec.volumes[].scaleIO.secretRef

説明
secretRef は、ScaleIO ユーザーおよびその他の機密情報の秘密を参照します。これが指定されていない場合、ログイン操作は失敗します。
object
Expand
プロパティー説明

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

5.1.413. .spec.install.spec.deployments[].spec.template.spec.volumes[].secret

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

defaultMode

integer

defaultMode は任意: デフォルトで、作成されたファイルのアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。デフォルトは 0644 に設定されます。パス内のディレクトリーはこの設定の影響を受けません。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。

items

array

items が指定されていない場合、参照されるシークレットの Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。シークレットに存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。

items[]

object

文字列キーをボリューム内のパスにマップします。

optional

boolean

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

secretName

string

secretName は、使用する Pod の namespace 内のシークレットの名前です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#secret

5.1.414. .spec.install.spec.deployments[].spec.template.spec.volumes[].secret.items

説明
items が指定されていない場合、参照されるシークレットの Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。シークレットに存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
array

5.1.415. .spec.install.spec.deployments[].spec.template.spec.volumes[].secret.items[]

説明
文字列キーをボリューム内のパスにマップします。
object
必須
  • key
  • path
Expand
プロパティー説明

key

string

key はプロジェクトのキーです。

mode

integer

mode は任意: このファイルにアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。指定しない場合、ボリューム defaultMode が使用されます。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。

path

string

path はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。

5.1.416. .spec.install.spec.deployments[].spec.template.spec.volumes[].storageos

説明
storageOS は、Kubernetes ノードに接続およびマウントされた StorageOS ボリュームを表します。非推奨: StorageOS は非推奨であり、ツリー内の storageos タイプはサポートされなくなりました。
object
Expand
プロパティー説明

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

readOnly

boolean

readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

secretRef

object

secretRef は、StorageOS API クレデンシャルを取得するために使用するシークレットを指定します。指定しない場合、デフォルト値が試行されます。

volumeName

string

volumeName は、人間が判読えきる形式の StorageOS ボリュームの名前です。ボリューム名は namespace 内でのみ一意です。

volumeNamespace

string

volumeNamespace は、StorageOS 内のボリュームのスコープを指定します。namespace が指定されていない場合は、Pod の namespace が使用されます。これにより、Kubernetes の名前スコープを StorageOS 内にミラーリングして、より緊密に統合することができます。VolumeName を任意の名前に設定して、デフォルトの動作をオーバーライドします。StorageOS 内で namespace を使用していない場合は、"デフォルト" に設定します。StorageOS 内に事前に存在しない namespace が作成されます。

5.1.417. .spec.install.spec.deployments[].spec.template.spec.volumes[].storageos.secretRef

説明
secretRef は、StorageOS API クレデンシャルを取得するために使用するシークレットを指定します。指定しない場合、デフォルト値が試行されます。
object
Expand
プロパティー説明

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

5.1.418. .spec.install.spec.deployments[].spec.template.spec.volumes[].vsphereVolume

説明
vsphereVolume は、kubelet ホストマシンに接続およびマウントされた vSphere ボリュームを表します。非推奨: VsphereVolume は非推奨です。ツリー内 vsphereVolume タイプのすべての操作は、csi.vsphere.vmware.com CSI ドライバーにリダイレクトされます。
object
必須
  • volumePath
Expand
プロパティー説明

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

storagePolicyID

string

storagePolicyID は、StoragePolicyName に関連付けられたストレージポリシーベースの管理 (SPBM) プロファイル ID です。

storagePolicyName

string

storagePolicyName は、ストレージポリシーベースの管理 (SPBM) プロファイル名です。

volumePath

string

volumePath は、vSphere ボリューム vmdk を識別するパスです。

5.1.419. .spec.install.spec.permissions

説明
array

5.1.420. .spec.install.spec.permissions[]

説明
StrategyDeploymentPermissions は、インストール戦略に必要な rbac ルールとサービスアカウントを記述します。
object
必須
  • rules
  • serviceAccountName
Expand
プロパティー説明

rules

array

 

rules[]

object

PolicyRule は、ポリシールールを説明する情報を保持しますが、ルールが適用されるユーザーやルールが適用される namespace に関する情報は含まれません。

serviceAccountName

string

 

5.1.421. .spec.install.spec.permissions[].rules

説明
array

5.1.422. .spec.install.spec.permissions[].rules[]

説明
PolicyRule は、ポリシールールを説明する情報を保持しますが、ルールが適用されるユーザーやルールが適用される namespace に関する情報は含まれません。
object
必須
  • verbs
Expand
プロパティー説明

apiGroups

array (string)

apiGroups は、リソースを含む APIGroup の名前です。複数の API グループが指定されている場合、任意の API グループ内の列挙されたリソースの 1 つに対してリクエストされたアクションはすべて許可されます。"" はコア API グループを表し、"*" はすべての API グループを表します。

nonResourceURLs

array (string)

NonResourceURLs は、ユーザーがアクセスできる必要のある部分的な URL のセットです。*は許可されますが、パスの完全な最終ステップとしてのみです。非リソース URL は namespace 化されていないため、このフィールドは ClusterRoleBinding から参照される ClusterRoles にのみ適用されます。ルールは、API リソース ("pods" や "secrets" など) または非リソース URL パス ("/api" など) のいずれかに適用できますが、両方に適用することはできません。

resourceNames

array (string)

resourceNames は、ルールが適用される名前のオプションのホワイトリストです。空のセットは、すべてが許可されていることを意味します。

resources

array (string)

リソースは、このルールが適用されるリソースのリストです。'*' はすべてのリソースを表します。

verbs

array (string)

Verbs は、このルールに含まれるすべての ResourceKind に適用される Verbs のリストです。'*' はすべての動詞を表します。

5.1.423. .spec.installModes

説明
InstallModes は、サポートされているインストールタイプを指定します
array

5.1.424. .spec.installModes[]

説明
InstallMode は、InstallModeType を CSV がサポートするかどうかを表すフラグに関連付けます。
object
必須
  • supported
  • type
Expand
プロパティー説明

supported

boolean

 

type

string

InstallModeType は、CSV インストールでサポートされているタイプのインストールモードです。

5.1.427. .spec.maintainers

説明
Operator を保守している組織のリスト。
array

5.1.428. .spec.maintainers[]

説明
object
Expand
プロパティー説明

email

string

 

name

string

 

5.1.429. .spec.nativeAPIs

説明
array

5.1.430. .spec.nativeAPIs[]

説明
GroupVersionKind では、kind をあいまいに識別します。自動的な強制変換を回避するために、GroupVersion を匿名で含めていません。カスタムマーシャリングを回避するために GroupVersion を使用しません。
object
必須
  • group
  • kind
  • version
Expand
プロパティー説明

group

string

 

kind

string

 

version

string

 

5.1.431. .spec.provider

説明
Operator を公開している背後の組織。
object
Expand
プロパティー説明

name

string

 

url

string

 

5.1.432. .spec.relatedImages

説明
Operator がそれらの機能を実行するために必要となる可能性のある関連イメージまたは他のコンテナーをリスト表示します。このリストには、オペランドイメージも含める必要があります。すべてのイメージ参照は、タグではなくダイジェスト (SHA) で指定する必要があります。このフィールドはカタログの作成時にのみ使用され、クラスターの実行時には何のロールも果たしません。
array

5.1.433. .spec.relatedImages[]

説明
object
必須
  • image
  • name
Expand
プロパティー説明

image

string

 

name

string

 

5.1.434. .spec.selector

説明
関連リソースのラベルセレクター。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

5.1.435. .spec.selector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

5.1.436. .spec.selector.matchExpressions[]

説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

5.1.437. .spec.webhookdefinitions

説明
array

5.1.438. .spec.webhookdefinitions[]

説明
WebhookDescription は、必要な Webhook に関する詳細を OLM に提供します
object
必須
  • admissionReviewVersions
  • generateName
  • sideEffects
  • type
Expand
プロパティー説明

admissionReviewVersions

array (string)

 

containerPort

integer

 

conversionCRDs

array (string)

 

deploymentName

string

 

failurePolicy

string

FailurePolicyType は、アドミッションエンドポイントからの認識されないエラーの処理方法を定義する失敗ポリシーを指定します。

generateName

string

 

matchPolicy

string

MatchPolicyType は、一致ポリシーのタイプを指定します。

objectSelector

object

ラベルセレクターとは、一連のリソースに対するラベルクエリー機能です。matchLabels と matchExpressions の結果は AND を使用して結合されます。ラベルセレクターが空の場合は、全オブジェクトをマッチします。ラベルセレクターが null の場合は、どのオブジェクトもマッチしません。

reinvocationPolicy

string

ReinvocationPolicyType は、アドミッションフックが使用するポリシーのタイプを指定します。

rules

array

 

rules[]

object

RuleWithOperations は、操作とリソースのタプルです。すべてのタプル拡張が有効であることを確認することを推奨します。

sideEffects

string

SideEffectClass は、Webhook が持つ可能性のある副作用のタイプを指定します。

targetPort

integer-or-string

 

timeoutSeconds

integer

 

type

string

WebhookAdmissionType は、OLM でサポートされているアドミッション Webhook のタイプです。

webhookPath

string

 

5.1.439. .spec.webhookdefinitions[].objectSelector

説明
ラベルセレクターとは、一連のリソースに対するラベルクエリー機能です。matchLabels と matchExpressions の結果は AND を使用して結合されます。ラベルセレクターが空の場合は、全オブジェクトをマッチします。ラベルセレクターが null の場合は、どのオブジェクトもマッチしません。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

5.1.440. .spec.webhookdefinitions[].objectSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

5.1.441. .spec.webhookdefinitions[].objectSelector.matchExpressions[]

説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

5.1.442. .spec.webhookdefinitions[].rules

説明
array

5.1.443. .spec.webhookdefinitions[].rules[]

説明
RuleWithOperations は、操作とリソースのタプルです。すべてのタプル拡張が有効であることを確認することを推奨します。
object
Expand
プロパティー説明

apiGroups

array (string)

APIGroups は、リソースが属する API グループです。'' はすべてのグループです。もしも '' が存在する場合、スライスの長さは 1 でなければなりません。必須。

apiVersions

array (string)

APIVersions は、リソースが属する API バージョンです。'' はすべてのバージョンです。もしも '' が存在する場合、スライスの長さは 1 でなければなりません。必須。

operations

array (string)

操作は、アドミッションフックが気にする操作です - これらすべての操作および追加される将来のアドミッション操作に対して、CREATE、UPDATE、DELETE、CONNECT、または*。'*' が存在する場合、スライスの長さは 1 でなければなりません。必須。

resources

array (string)

リソースは、このルールが適用されるリソースのリストです。

例: 'Pod' は Pod を意味します。'pods/log' は、Pod のログサブリソースを意味します。'' はすべてのリソースを意味しますが、サブリソースは意味しません。'pods/' は、Pod のすべてのサブリソースを意味します。'/scale' は、すべてのスケールサブリソースを意味します。'/*' は、すべてのリソースとそのサブリソースを意味します。

ワイルドカードが存在する場合、検証ルールはリソースが互いに重複しないことを保証します。

囲んでいるオブジェクトによっては、サブリソースが許可されない場合があります。必須。

scope

string

scope は、このルールのスコープを指定します。有効な値は、"Cluster"、"Namespaced"、および "" "クラスター" とは、クラスタースコープのリソースのみがこのルールに一致することを意味します。namespace API オブジェクトはクラスタースコープです。"Namespaced" は、namespace 付きのリソースのみがこのルールに一致することを意味します。"" は、スコープの制限がないことを意味します。サブリソースは、親リソースのスコープと一致します。デフォルトは "*" です。

5.1.444. .status

説明
ClusterServiceVersionStatus は、CSV のステータスに関する情報を表します。ステータスは、システムの実際の状態を追跡する場合があります。
object
Expand
プロパティー説明

certsLastUpdated

string

所有している APIService 証明書が最後に更新されたとき

certsRotateAt

string

所有する APIService 証明書が次にローテーションする時間

cleanup

object

CleanupStatus は、CSV が削除を保留している間のクリーンアップのステータスに関する情報を表します

conditions

array

条件のリスト、状態遷移の履歴

conditions[]

object

条件は、ClusterServiceVersion の状態遷移のレコードとしてステータスに表示されます

lastTransitionTime

string

前回、ステータスがあるステータスから別のステータスに移行したとき。

lastUpdateTime

string

前回ステータスを更新しました

message

string

ClusterServiceVersion がこの状態にある理由の詳細を示す人間が読めるメッセージ。

phase

string

ClusterServiceVersion の現在の状態

reason

string

ClusterServiceVersion がこの状態にある理由の詳細を示す簡単な CamelCase メッセージ。例えば'RequirementsNotMet'

requirementStatus

array

この CSV の各要件のステータス

requirementStatus[]

object

 

5.1.445. .status.cleanup

説明
CleanupStatus は、CSV が削除を保留している間のクリーンアップのステータスに関する情報を表します
object
Expand
プロパティー説明

pendingDeletion

array

pendingDeletion は、削除が保留され、ファイナライザーでブロックされているカスタムリソースオブジェクトのリストです。これは、CSV の削除または Operator のアンインストールをブロックしているクリーンアップの進行状況を示します。

pendingDeletion[]

object

ResourceList は、同じグループ/種類のリソースのリストを表します

5.1.446. .status.cleanup.pendingDeletion

説明
pendingDeletion は、削除が保留され、ファイナライザーでブロックされているカスタムリソースオブジェクトのリストです。これは、CSV の削除または Operator のアンインストールをブロックしているクリーンアップの進行状況を示します。
array

5.1.447. .status.cleanup.pendingDeletion[]

説明
ResourceList は、同じグループ/種類のリソースのリストを表します
object
必須
  • group
  • instances
  • kind
Expand
プロパティー説明

group

string

 

instances

array

 

instances[]

object

 

kind

string

 

5.1.448. .status.cleanup.pendingDeletion[].instances

説明
array

5.1.449. .status.cleanup.pendingDeletion[].instances[]

説明
object
必須
  • name
Expand
プロパティー説明

name

string

 

namespace

string

クラスタースコープのリソースの namespace は、空にすることができます。

5.1.450. .status.conditions

説明
条件のリスト、状態遷移の履歴
array

5.1.451. .status.conditions[]

説明
条件は、ClusterServiceVersion の状態遷移のレコードとしてステータスに表示されます
object
Expand
プロパティー説明

lastTransitionTime

string

前回、ステータスがあるステータスから別のステータスに移行したとき。

lastUpdateTime

string

前回ステータスを更新しました

message

string

ClusterServiceVersion がこの状態にある理由の詳細を示す人間が読めるメッセージ。

phase

string

ClusterServiceVersion の条件

reason

string

ClusterServiceVersion がこの状態にある理由の詳細を示す簡単な CamelCase メッセージ。例えば'RequirementsNotMet'

5.1.452. .status.requirementStatus

説明
この CSV の各要件のステータス
array

5.1.453. .status.requirementStatus[]

説明
object
必須
  • group
  • kind
  • message
  • name
  • status
  • version
Expand
プロパティー説明

dependents

array

 

dependents[]

object

DependentStatus は、依存要件のステータスです (無限のネストを防ぐため)。

group

string

 

kind

string

 

message

string

 

name

string

 

status

string

StatusReason は、RequirementStatus または DependentStatus のステータスのキャメルケースの理由です。

uuid

string

 

version

string

 

5.1.454. .status.requirementStatus[].dependents

説明
array

5.1.455. .status.requirementStatus[].dependents[]

説明
DependentStatus は、依存要件のステータスです (無限のネストを防ぐため)。
object
必須
  • group
  • kind
  • status
  • version
Expand
プロパティー説明

group

string

 

kind

string

 

message

string

 

status

string

StatusReason は、RequirementStatus または DependentStatus のステータスのキャメルケースの理由です。

uuid

string

 

version

string

 

5.2. API エンドポイント

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

  • /apis/operators.coreos.com/v1alpha1/clusterserviceversions

    • GET: kind が ClusterServiceVersion のオブジェクトをリスト表示します。
  • /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions

    • DELETE:ClusterServiceVersion のコレクションを削除します
    • GET: kind が ClusterServiceVersion のオブジェクトをリスト表示します。
    • POST:ClusterServiceVersion を作成します
  • /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions/{name}

    • DELETE: ClusterServiceVersion を削除します。
    • GET: 指定された ClusterServiceVersion を読み取ります
    • PATCH: 指定された ClusterServiceVersion を部分的に更新します
    • PUT: 指定された ClusterServiceVersion を置き換えます
  • /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions/{name}/status

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

5.2.1. /apis/operators.coreos.com/v1alpha1/clusterserviceversions

HTTP メソッド
GET
説明
kind が ClusterServiceVersion のオブジェクトをリスト表示します。
Expand
表5.1 HTTP 応答
HTTP コード応答のボディー

200 - OK

ClusterServiceVersionList スキーマ

401 - Unauthorized

空白

5.2.2. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions

HTTP メソッド
DELETE
説明
ClusterServiceVersion のコレクションを削除します
Expand
表5.2 HTTP 応答
HTTP コード応答のボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
kind が ClusterServiceVersion のオブジェクトをリスト表示します。
Expand
表5.3 HTTP 応答
HTTP コード応答のボディー

200 - OK

ClusterServiceVersionList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
ClusterServiceVersion を作成します
Expand
表5.4 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表5.5 本文パラメーター
パラメーター説明

body

ClusterServiceVersion スキーマ

 
Expand
表5.6 HTTP 応答
HTTP コード応答のボディー

200 - OK

ClusterServiceVersion スキーマ

201 - Created

ClusterServiceVersion スキーマ

202 - Accepted

ClusterServiceVersion スキーマ

401 - Unauthorized

空白

5.2.3. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions/{name}

Expand
表5.7 グローバルパスパラメーター
パラメーター説明

name

string

ClusterServiceVersion の名前

HTTP メソッド
DELETE
説明
ClusterServiceVersion を削除します
Expand
表5.8 クエリーパラメーター
パラメーター説明

dryRun

string

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

Expand
表5.9 HTTP 応答
HTTP コード応答のボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された ClusterServiceVersion を読み取ります
Expand
表5.10 HTTP 応答
HTTP コード応答のボディー

200 - OK

ClusterServiceVersion スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

Expand
表5.12 HTTP 応答
HTTP コード応答のボディー

200 - OK

ClusterServiceVersion スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された ClusterServiceVersion を置き換えます
Expand
表5.13 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表5.14 本文パラメーター
パラメーター説明

body

ClusterServiceVersion スキーマ

 
Expand
表5.15 HTTP 応答
HTTP コード応答のボディー

200 - OK

ClusterServiceVersion スキーマ

201 - Created

ClusterServiceVersion スキーマ

401 - Unauthorized

空白

5.2.4. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions/{name}/status

Expand
表5.16 グローバルパスパラメーター
パラメーター説明

name

string

ClusterServiceVersion の名前

HTTP メソッド
GET
説明
指定された ClusterServiceVersion のステータスを読み取ります
Expand
表5.17 HTTP 応答
HTTP コード応答のボディー

200 - OK

ClusterServiceVersion スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

Expand
表5.19 HTTP 応答
HTTP コード応答のボディー

200 - OK

ClusterServiceVersion スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

Expand
表5.21 本文パラメーター
パラメーター説明

body

ClusterServiceVersion スキーマ

 
Expand
表5.22 HTTP 応答
HTTP コード応答のボディー

200 - OK

ClusterServiceVersion スキーマ

201 - Created

ClusterServiceVersion スキーマ

401 - Unauthorized

空白

第6章 InstallPlan [operators.coreos.com/v1alpha1]

説明
InstallPlan は、一連の Operator のインストールを定義します。
object
必須
  • metadata
  • spec

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

InstallPlanSpec は、インストールするアプリケーションリソースのセットを定義します

status

object

InstallPlanStatus は、インストールを完了するために必要な手順のステータスに関する情報を表します。

ステータスは、システムの実際の状態を追跡する場合があります。

6.1.1. .spec

説明
InstallPlanSpec は、インストールするアプリケーションリソースのセットを定義します
object
必須
  • approval
  • 承認
  • clusterServiceVersionNames
Expand
プロパティー説明

approval

string

承認は、InstallPlan のユーザー認可ポリシーです。"Automatic" または "Manual" のいずれかである必要があります。

承認

boolean

 

clusterServiceVersionNames

array (string)

 

generation

integer

 

source

string

 

sourceNamespace

string

 

6.1.2. .status

説明

InstallPlanStatus は、インストールを完了するために必要な手順のステータスに関する情報を表します。

ステータスは、システムの実際の状態を追跡する場合があります。

object
必須
  • catalogSources
  • phase
Expand
プロパティー説明

attenuatedServiceAccountRef

object

AttenuatedServiceAccountRef は、スコープ Operator のインストールを行うために使用されるサービスアカウントを参照します。

bundleLookups

array

BundleLookups は、バンドルコンテンツをクラスターにプルおよびアンパッケージするための進行中のリクエストのセットです。

bundleLookups[]

object

BundleLookup は、バンドルのコンテンツをクラスターにプルしてアンパッケージするためのリクエストです。

catalogSources

array (string)

 

conditions

array

 

conditions[]

object

InstallPlanCondition は、InstallPlan の実行の全体的なステータスを表します。

message

string

メッセージは、計画が現在のステータスになっている理由を理解するために重要な詳細情報を含む、人間が読めるメッセージです。

phase

string

InstallPlanPhase は、InstallPlan 全体の現在のステータスです。

plan

array

 

plan[]

object

ステップは、InstallPlan の個々のステップのステータスを表します。

startTime

string

StartTime は、コントローラーがプランにリストされているリソースをクラスターに適用し始めた時刻です。

6.1.3. .status.attenuatedServiceAccountRef

説明
AttenuatedServiceAccountRef は、スコープ Operator のインストールを行うために使用されるサービスアカウントを参照します。
object
Expand
プロパティー説明

apiVersion

string

参照先の API バージョン。

fieldPath

string

オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。

kind

string

参照先の種類。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespace

string

参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

string

この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

string

参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

6.1.4. .status.bundleLookups

説明
BundleLookups は、バンドルコンテンツをクラスターにプルおよびアンパッケージするための進行中のリクエストのセットです。
array

6.1.5. .status.bundleLookups[]

説明
BundleLookup は、バンドルのコンテンツをクラスターにプルしてアンパッケージするためのリクエストです。
object
必須
  • catalogSourceRef
  • identifier
  • path
  • replaces
Expand
プロパティー説明

catalogSourceRef

object

CatalogSourceRef は、バンドルパスが解決された CatalogSource への参照です。

conditions

array

条件は、BundleLookup の全体的な状態を表します。

conditions[]

object

 

identifier

string

識別子は、カタログ固有の Operator 名 (CSV を含むバンドルの CSV 名) です。

path

string

パスは、プルするバンドルの場所を指します。これは通常、イメージ参照です。

properties

string

開梱されたバンドルの有効なプロパティー。

replaces

string

Replaces は、Path で見つかったものと置き換えるバンドルの名前です。

6.1.6. .status.bundleLookups[].catalogSourceRef

説明
CatalogSourceRef は、バンドルパスが解決された CatalogSource への参照です。
object
Expand
プロパティー説明

apiVersion

string

参照先の API バージョン。

fieldPath

string

オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。

kind

string

参照先の種類。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespace

string

参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

string

この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

string

参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

6.1.7. .status.bundleLookups[].conditions

説明
条件は、BundleLookup の全体的な状態を表します。
array

6.1.8. .status.bundleLookups[].conditions[]

説明
object
必須
  • status
  • type
Expand
プロパティー説明

lastTransitionTime

string

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

lastUpdateTime

string

前回、状態が調査されました。

message

string

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

reason

string

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

status

string

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

type

string

状態のタイプ。

6.1.9. .status.conditions

説明
array

6.1.10. .status.conditions[]

説明
InstallPlanCondition は、InstallPlan の実行の全体的なステータスを表します。
object
Expand
プロパティー説明

lastTransitionTime

string

 

lastUpdateTime

string

 

message

string

 

reason

string

ConditionReason は、状態遷移のキャメルケースの理由です。

status

string

 

type

string

InstallPlanConditionType は、全体として特定の時点での InstallPlan の状態を記述します。

6.1.11. .status.plan

説明
array

6.1.12. .status.plan[]

説明
ステップは、InstallPlan の個々のステップのステータスを表します。
object
必須
  • resolving
  • resource
  • status
Expand
プロパティー説明

optional

boolean

 

resolving

string

 

resource

object

StepResource は、InstallPlan によって追跡されるリソースのステータスを表します。

status

string

StepStatus は、InstallPlan 内の特定のリソースの現在のステータスです。

6.1.13. .status.plan[].resource

説明
StepResource は、InstallPlan によって追跡されるリソースのステータスを表します。
object
必須
  • group
  • kind
  • name
  • sourceName
  • sourceNamespace
  • version
Expand
プロパティー説明

group

string

 

kind

string

 

manifest

string

 

name

string

 

sourceName

string

 

sourceNamespace

string

 

version

string

 

6.2. API エンドポイント

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

  • /apis/operators.coreos.com/v1alpha1/installplans

    • GET: kind が InstallPlan のオブジェクトをリスト表示します。
  • /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans

    • DELETE: InstallPlan のコレクションを削除します。
    • GET: kind が InstallPlan のオブジェクトをリスト表示します。
    • POST:InstallPlan を作成します
  • /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans/{name}

    • DELETE: InstallPlan を削除します。
    • GET: 指定された InstallPlan を読み取ります
    • PATCH: 指定された InstallPlan を部分的に更新します
    • PUT: 指定された InstallPlan を置き換えます
  • /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans/{name}/status

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

6.2.1. /apis/operators.coreos.com/v1alpha1/installplans

HTTP メソッド
GET
説明
kind が InstallPlan のオブジェクトをリスト表示します。
Expand
表6.1 HTTP 応答
HTTP コード応答のボディー

200 - OK

InstallPlanList スキーマ

401 - Unauthorized

空白

6.2.2. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans

HTTP メソッド
DELETE
説明
InstallPlan のコレクションを削除します
Expand
表6.2 HTTP 応答
HTTP コード応答のボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
kind が InstallPlan のオブジェクトをリスト表示します。
Expand
表6.3 HTTP 応答
HTTP コード応答のボディー

200 - OK

InstallPlanList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
InstallPlan を作成します
Expand
表6.4 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表6.5 本文パラメーター
パラメーター説明

body

InstallPlan スキーマ

 
Expand
表6.6 HTTP 応答
HTTP コード応答のボディー

200 - OK

InstallPlan スキーマ

201 - Created

InstallPlan スキーマ

202 - Accepted

InstallPlan スキーマ

401 - Unauthorized

空白

6.2.3. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans/{name}

Expand
表6.7 グローバルパスパラメーター
パラメーター説明

name

string

InstallPlan の名前

HTTP メソッド
DELETE
説明
InstallPlan を削除します
Expand
表6.8 クエリーパラメーター
パラメーター説明

dryRun

string

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

Expand
表6.9 HTTP 応答
HTTP コード応答のボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された InstallPlan を読みます
Expand
表6.10 HTTP 応答
HTTP コード応答のボディー

200 - OK

InstallPlan スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

Expand
表6.12 HTTP 応答
HTTP コード応答のボディー

200 - OK

InstallPlan スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された InstallPlan を置き換えます
Expand
表6.13 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表6.14 本文パラメーター
パラメーター説明

body

InstallPlan スキーマ

 
Expand
表6.15 HTTP 応答
HTTP コード応答のボディー

200 - OK

InstallPlan スキーマ

201 - Created

InstallPlan スキーマ

401 - Unauthorized

空白

6.2.4. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans/{name}/status

Expand
表6.16 グローバルパスパラメーター
パラメーター説明

name

string

InstallPlan の名前

HTTP メソッド
GET
説明
指定された InstallPlan のステータスを読み取ります
Expand
表6.17 HTTP 応答
HTTP コード応答のボディー

200 - OK

InstallPlan スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

Expand
表6.19 HTTP 応答
HTTP コード応答のボディー

200 - OK

InstallPlan スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

Expand
表6.21 本文パラメーター
パラメーター説明

body

InstallPlan スキーマ

 
Expand
表6.22 HTTP 応答
HTTP コード応答のボディー

200 - OK

InstallPlan スキーマ

201 - Created

InstallPlan スキーマ

401 - Unauthorized

空白

第7章 OLMConfig [operators.coreos.com/v1]

説明
OLMConfig は、OLM の設定を担うリソースです。
object
必須
  • metadata

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

OLMConfigSpec は、OLMConfig リソースの仕様です。

status

object

OLMConfigStatus は、OLMConfig リソースのステータスです。

7.1.1. .spec

説明
OLMConfigSpec は、OLMConfig リソースの仕様です。
object
Expand
プロパティー説明

features

object

Features は、設定可能な OLM の機能のリストを格納します。

7.1.2. .spec.features

説明
Features は、設定可能な OLM の機能のリストを格納します。
object
Expand
プロパティー説明

disableCopiedCSVs

boolean

DisableCopiedCSVs は、クラスタースコープでインストールされた Operator の OLM の "Copied CSV" 機能を無効にするために使用されます。クラスタースコープの Operator とは、すべての namespace を対象とする OperatorGroup にインストールされている Operator です。再度有効にすると、OLM によって各クラスタースコープの Operator の "Copied CSV" が再作成されます。

packageServerSyncInterval

string

PackageServerSyncInterval は、packagerserver Pod の同期間隔を定義するために使用されます。パッケージサーバー Pod は、定期的に CatalogSources のステータスをチェックします。このパラメーターでは、期間の形式を使用して期間を指定します (例: "60m")。このパラメーターでは、時間 ("h")、分 ("m")、秒 ("s") のみを指定できます。指定されていない場合、期間はパッケージサーバー内で指定されている値にデフォルトで設定されます。

7.1.3. .status

説明
OLMConfigStatus は、OLMConfig リソースのステータスです。
object
Expand
プロパティー説明

conditions

array

 

conditions[]

object

condition には、この API Resource の現在の状態のある側面の詳細が含まれます。

7.1.4. .status.conditions

説明
array

7.1.5. .status.conditions[]

説明
condition には、この API Resource の現在の状態のある側面の詳細が含まれます。
object
必須
  • lastTransitionTime
  • message
  • reason
  • status
  • type
Expand
プロパティー説明

lastTransitionTime

string

lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。

message

string

message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。

observedGeneration

integer

observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。

reason

string

reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。

status

string

条件のステータス、True、False、Unknown のいずれか。

type

string

CamelCase または foo.example.com/CamelCase の条件のタイプ。

7.2. API エンドポイント

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

  • /apis/operators.coreos.com/v1/olmconfigs

    • DELETE: OLMConfig のコレクションを削除します。
    • GET: kind が OLMConfig のオブジェクトをリスト表示します。
    • POST: OLMConfig を作成します。
  • /apis/operators.coreos.com/v1/olmconfigs/{name}

    • DELETE: OLMConfig を削除します。
    • GET: 指定された OLMConfig を読み取ります。
    • PATCH: 指定された OLMConfig を部分的に更新します。
    • PUT: 指定された OLMConfig を置き換えます。
  • /apis/operators.coreos.com/v1/olmconfigs/{name}/status

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

7.2.1. /apis/operators.coreos.com/v1/olmconfigs

HTTP メソッド
DELETE
説明
OLMConfig のコレクションを削除します。
Expand
表7.1 HTTP 応答
HTTP コード応答のボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
kind が OLMConfig のオブジェクトをリスト表示します。
Expand
表7.2 HTTP 応答
HTTP コード応答のボディー

200 - OK

OLMConfigList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
OLMConfig を作成します。
Expand
表7.3 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表7.4 本文パラメーター
パラメーター説明

body

OLMConfig スキーマ

 
Expand
表7.5 HTTP 応答
HTTP コード応答のボディー

200 - OK

OLMConfig スキーマ

201 - Created

OLMConfig スキーマ

202 - Accepted

OLMConfig スキーマ

401 - Unauthorized

空白

7.2.2. /apis/operators.coreos.com/v1/olmconfigs/{name}

Expand
表7.6 グローバルパスパラメーター
パラメーター説明

name

string

OLMConfig の名前

HTTP メソッド
DELETE
説明
OLMConfig を削除します。
Expand
表7.7 クエリーパラメーター
パラメーター説明

dryRun

string

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

Expand
表7.8 HTTP 応答
HTTP コード応答のボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された OLMConfig を読み取ります。
Expand
表7.9 HTTP 応答
HTTP コード応答のボディー

200 - OK

OLMConfig スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された OLMConfig を部分的に更新します。
Expand
表7.10 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表7.11 HTTP 応答
HTTP コード応答のボディー

200 - OK

OLMConfig スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された OLMConfig を置き換えます。
Expand
表7.12 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表7.13 本文パラメーター
パラメーター説明

body

OLMConfig スキーマ

 
Expand
表7.14 HTTP 応答
HTTP コード応答のボディー

200 - OK

OLMConfig スキーマ

201 - Created

OLMConfig スキーマ

401 - Unauthorized

空白

7.2.3. /apis/operators.coreos.com/v1/olmconfigs/{name}/status

Expand
表7.15 グローバルパスパラメーター
パラメーター説明

name

string

OLMConfig の名前

HTTP メソッド
GET
説明
指定された OLMConfig のステータスを読み取ります。
Expand
表7.16 HTTP 応答
HTTP コード応答のボディー

200 - OK

OLMConfig スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された OLMConfig のステータスを部分的に更新します。
Expand
表7.17 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表7.18 HTTP 応答
HTTP コード応答のボディー

200 - OK

OLMConfig スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された OLMConfig のステータスを置き換えます。
Expand
表7.19 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表7.20 本文パラメーター
パラメーター説明

body

OLMConfig スキーマ

 
Expand
表7.21 HTTP 応答
HTTP コード応答のボディー

200 - OK

OLMConfig スキーマ

201 - Created

OLMConfig スキーマ

401 - Unauthorized

空白

第8章 Operator [operators.coreos.com/v1]

説明
Operator はクラスター Operator を表します。
object

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

OperatorSpec は、Operator の望ましい状態を定義します

status

object

OperatorStatus は、Operator とそのコンポーネントの監視状態を定義します

8.1.1. .spec

説明
OperatorSpec は、Operator の望ましい状態を定義します
object

8.1.2. .status

説明
OperatorStatus は、Operator とそのコンポーネントの監視状態を定義します
object
Expand
プロパティー説明

コンポーネント

object

コンポーネントは、Operator を設定するリソースを記述します。

8.1.3. .status.components

説明
コンポーネントは、Operator を設定するリソースを記述します。
object
必須
  • labelSelector
Expand
プロパティー説明

labelSelector

object

LabelSelector は、Operator のコンポーネントを選択するために使用される一連のリソースに対するラベルクエリーです。

refs

array

参照は、LabelSelector で選択された、Operator のコンポーネントリソースへの参照のセットです。

refs[]

object

RichReference は、ステータス条件が強化されたリソースへの参照です。

8.1.4. .status.components.labelSelector

説明
LabelSelector は、Operator のコンポーネントを選択するために使用される一連のリソースに対するラベルクエリーです。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

8.1.5. .status.components.labelSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

8.1.6. .status.components.labelSelector.matchExpressions[]

説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

8.1.7. .status.components.refs

説明
参照は、LabelSelector で選択された、Operator のコンポーネントリソースへの参照のセットです。
array

8.1.8. .status.components.refs[]

説明
RichReference は、ステータス条件が強化されたリソースへの参照です。
object
Expand
プロパティー説明

apiVersion

string

参照先の API バージョン。

conditions

array

条件は、コンポーネントの最新の状態を表します。

conditions[]

object

状態は、コンポーネントの状態の最新の利用可能な観測を表します。

fieldPath

string

オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。

kind

string

参照先の種類。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespace

string

参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

string

この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

string

参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

8.1.9. .status.components.refs[].conditions

説明
条件は、コンポーネントの最新の状態を表します。
array

8.1.10. .status.components.refs[].conditions[]

説明
状態は、コンポーネントの状態の最新の利用可能な観測を表します。
object
必須
  • status
  • type
Expand
プロパティー説明

lastTransitionTime

string

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

lastUpdateTime

string

前回条件が調査されたとき

message

string

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

reason

string

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

status

string

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

type

string

状態のタイプ。

8.2. API エンドポイント

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

  • /apis/operators.coreos.com/v1/operators

    • DELETE:Operator のコレクションを削除します
    • GET: kind が Operator のオブジェクトをリスト表示します。
    • POST:Operator を作成します
  • /apis/operators.coreos.com/v1/operators/{name}

    • DELETE: Operator を削除します。
    • GET: 指定された Operator を読み取ります
    • PATCH: 指定された Operator を部分的に更新します
    • PUT: 指定された Operator を置き換えます
  • /apis/operators.coreos.com/v1/operators/{name}/status

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

8.2.1. /apis/operators.coreos.com/v1/operators

HTTP メソッド
DELETE
説明
Operator のコレクションを削除します
Expand
表8.1 HTTP 応答
HTTP コード応答のボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
kind が Operator のオブジェクトをリスト表示します。
Expand
表8.2 HTTP 応答
HTTP コード応答のボディー

200 - OK

OperatorList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
Operator を作成する
Expand
表8.3 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表8.4 本文パラメーター
パラメーター説明

body

Operator スキーマ

 
Expand
表8.5 HTTP 応答
HTTP コード応答のボディー

200 - OK

Operator スキーマ

201 - Created

Operator スキーマ

202 - Accepted

Operator スキーマ

401 - Unauthorized

空白

8.2.2. /apis/operators.coreos.com/v1/operators/{name}

Expand
表8.6 グローバルパスパラメーター
パラメーター説明

name

string

Operator の名前

HTTP メソッド
DELETE
説明
Operator を削除する
Expand
表8.7 クエリーパラメーター
パラメーター説明

dryRun

string

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

Expand
表8.8 HTTP 応答
HTTP コード応答のボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された Operator を読み取ります
Expand
表8.9 HTTP 応答
HTTP コード応答のボディー

200 - OK

Operator スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

Expand
表8.11 HTTP 応答
HTTP コード応答のボディー

200 - OK

Operator スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された Operator を置き換えます
Expand
表8.12 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表8.13 本文パラメーター
パラメーター説明

body

Operator スキーマ

 
Expand
表8.14 HTTP 応答
HTTP コード応答のボディー

200 - OK

Operator スキーマ

201 - Created

Operator スキーマ

401 - Unauthorized

空白

8.2.3. /apis/operators.coreos.com/v1/operators/{name}/status

Expand
表8.15 グローバルパスパラメーター
パラメーター説明

name

string

Operator の名前

HTTP メソッド
GET
説明
指定された Operator のステータスを読み取ります
Expand
表8.16 HTTP 応答
HTTP コード応答のボディー

200 - OK

Operator スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

Expand
表8.18 HTTP 応答
HTTP コード応答のボディー

200 - OK

Operator スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

Expand
表8.20 本文パラメーター
パラメーター説明

body

Operator スキーマ

 
Expand
表8.21 HTTP 応答
HTTP コード応答のボディー

200 - OK

Operator スキーマ

201 - Created

Operator スキーマ

401 - Unauthorized

空白

第9章 OperatorCondition [operators.coreos.com/v2]

説明
OperatorCondition は、OperatorCondition タイプのカスタムリソースであり、Operator の状態に関する情報を OLM に伝達するために使用されます。
object
必須
  • metadata

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

標準オブジェクトのメタデータ。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

OperatorConditionSpec を使用すると、Operator は状態を OLM に報告でき、クラスター管理者は Operator によって報告された状態を手動でオーバーライドできます。

status

object

OperatorConditionStatus を使用すると、OLM はどの条件が観察されたかを伝えることができます。

9.1.1. .spec

説明
OperatorConditionSpec を使用すると、Operator は状態を OLM に報告でき、クラスター管理者は Operator によって報告された状態を手動でオーバーライドできます。
object
Expand
プロパティー説明

conditions

array

 

conditions[]

object

condition には、この API Resource の現在の状態のある側面の詳細が含まれます。

deployments

array (string)

 

overrides

array

 

overrides[]

object

condition には、この API Resource の現在の状態のある側面の詳細が含まれます。

serviceAccounts

array (string)

 

9.1.2. .spec.conditions

説明
array

9.1.3. .spec.conditions[]

説明
condition には、この API Resource の現在の状態のある側面の詳細が含まれます。
object
必須
  • lastTransitionTime
  • message
  • reason
  • status
  • type
Expand
プロパティー説明

lastTransitionTime

string

lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。

message

string

message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。

observedGeneration

integer

observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。

reason

string

reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。

status

string

条件のステータス、True、False、Unknown のいずれか。

type

string

CamelCase または foo.example.com/CamelCase の条件のタイプ。

9.1.4. .spec.overrides

説明
array

9.1.5. .spec.overrides[]

説明
condition には、この API Resource の現在の状態のある側面の詳細が含まれます。
object
必須
  • message
  • reason
  • status
  • type
Expand
プロパティー説明

lastTransitionTime

string

lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。

message

string

message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。

observedGeneration

integer

observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。

reason

string

reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。

status

string

条件のステータス、True、False、Unknown のいずれか。

type

string

CamelCase または foo.example.com/CamelCase の条件のタイプ。

9.1.6. .status

説明
OperatorConditionStatus を使用すると、OLM はどの条件が観察されたかを伝えることができます。
object
Expand
プロパティー説明

conditions

array

 

conditions[]

object

condition には、この API Resource の現在の状態のある側面の詳細が含まれます。

9.1.7. .status.conditions

説明
array

9.1.8. .status.conditions[]

説明
condition には、この API Resource の現在の状態のある側面の詳細が含まれます。
object
必須
  • lastTransitionTime
  • message
  • reason
  • status
  • type
Expand
プロパティー説明

lastTransitionTime

string

lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。

message

string

message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。

observedGeneration

integer

observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。

reason

string

reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。

status

string

条件のステータス、True、False、Unknown のいずれか。

type

string

CamelCase または foo.example.com/CamelCase の条件のタイプ。

9.2. API エンドポイント

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

  • /apis/operators.coreos.com/v2/operatorconditions

    • GET: kind が OperatorCondition のオブジェクトをリスト表示します。
  • /apis/operators.coreos.com/v2/namespaces/{namespace}/operatorconditions

    • DELETE:OperatorCondition のコレクションを削除します
    • GET: kind が OperatorCondition のオブジェクトをリスト表示します。
    • POST:OperatorCondition を作成します
  • /apis/operators.coreos.com/v2/namespaces/{namespace}/operatorconditions/{name}

    • DELETE: OperatorCondition を削除します。
    • GET: 指定された OperatorCondition を読み取ります
    • PATCH: 指定された OperatorCondition を部分的に更新します
    • PUT: 指定された OperatorCondition を置き換えます
  • /apis/operators.coreos.com/v2/namespaces/{namespace}/operatorconditions/{name}/status

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

9.2.1. /apis/operators.coreos.com/v2/operatorconditions

HTTP メソッド
GET
説明
kind が OperatorCondition のオブジェクトをリスト表示します。
Expand
表9.1 HTTP 応答
HTTP コード応答のボディー

200 - OK

OperatorConditionList スキーマ

401 - Unauthorized

空白

9.2.2. /apis/operators.coreos.com/v2/namespaces/{namespace}/operatorconditions

HTTP メソッド
DELETE
説明
OperatorCondition のコレクションを削除します
Expand
表9.2 HTTP 応答
HTTP コード応答のボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
kind が OperatorCondition のオブジェクトをリスト表示します。
Expand
表9.3 HTTP 応答
HTTP コード応答のボディー

200 - OK

OperatorConditionList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
OperatorCondition を作成します
Expand
表9.4 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表9.5 本文パラメーター
パラメーター説明

body

OperatorCondition スキーマ

 
Expand
表9.6 HTTP 応答
HTTP コード応答のボディー

200 - OK

OperatorCondition スキーマ

201 - Created

OperatorCondition スキーマ

202 - Accepted

OperatorCondition スキーマ

401 - Unauthorized

空白

9.2.3. /apis/operators.coreos.com/v2/namespaces/{namespace}/operatorconditions/{name}

Expand
表9.7 グローバルパスパラメーター
パラメーター説明

name

string

OperatorCondition の名前

HTTP メソッド
DELETE
説明
OperatorCondition を削除します
Expand
表9.8 クエリーパラメーター
パラメーター説明

dryRun

string

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

Expand
表9.9 HTTP 応答
HTTP コード応答のボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された OperatorCondition を読み取ります
Expand
表9.10 HTTP 応答
HTTP コード応答のボディー

200 - OK

OperatorCondition スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

Expand
表9.12 HTTP 応答
HTTP コード応答のボディー

200 - OK

OperatorCondition スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された OperatorCondition を置き換えます
Expand
表9.13 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表9.14 本文パラメーター
パラメーター説明

body

OperatorCondition スキーマ

 
Expand
表9.15 HTTP 応答
HTTP コード応答のボディー

200 - OK

OperatorCondition スキーマ

201 - Created

OperatorCondition スキーマ

401 - Unauthorized

空白

9.2.4. /apis/operators.coreos.com/v2/namespaces/{namespace}/operatorconditions/{name}/status

Expand
表9.16 グローバルパスパラメーター
パラメーター説明

name

string

OperatorCondition の名前

HTTP メソッド
GET
説明
指定された OperatorCondition のステータスを読み取ります
Expand
表9.17 HTTP 応答
HTTP コード応答のボディー

200 - OK

OperatorCondition スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

Expand
表9.19 HTTP 応答
HTTP コード応答のボディー

200 - OK

OperatorCondition スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

Expand
表9.21 本文パラメーター
パラメーター説明

body

OperatorCondition スキーマ

 
Expand
表9.22 HTTP 応答
HTTP コード応答のボディー

200 - OK

OperatorCondition スキーマ

201 - Created

OperatorCondition スキーマ

401 - Unauthorized

空白

第10章 OperatorGroup [operators.coreos.com/v1]

説明
OperatorGroup は、OLM マネージドオペレーターのマルチテナンシーの単位です。namespace への Operator のインストールを、指定されたターゲット namespace のセットに制限します。
object
必須
  • metadata

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

OperatorGroupSpec は、OperatorGroup リソースの仕様です。

status

object

OperatorGroupStatus は、OperatorGroupResource のステータスです。

10.1.1. .spec

説明
OperatorGroupSpec は、OperatorGroup リソースの仕様です。
object
Expand
プロパティー説明

selector

object

Selector は、OperatorGroup のターゲット namespace を選択します。

serviceAccountName

string

ServiceAccountName は、この Operator グループにオペレーターをデプロイするために使用される管理者指定のサービスアカウントです。

staticProvidedAPIs

boolean

Static は、OperatorGroup の providedAPIs アノテーションを更新しないように OLM に指示します

targetNamespaces

array (string)

TargetNamespaces は、ターゲットとする namespace の明示的なセットです。設定されている場合、セレクターは無視されます。

upgradeStrategy

string

UpgradeStrategy は、namespace 内の Operator のアップグレードストラテジーを定義します。現在サポートされているアップグレードストラテジーは 2 つあります。

Default: clusterServiceVersions が成功フェーズから置換フェーズに移行することだけが OLM によって許可されます。つまり、インストールまたはアップグレードが失敗した場合、Operator が次のバージョンに移行することが OLM によって許可されません。

TechPreviewUnsafeFailForward: clusterServiceVersions が成功フェーズまたは失敗フェーズから置換フェーズに移行することが OLM によって許可されます。また、サブスクリプションが失敗した installPlan を参照しており、既存の Operator セットの新しいアップグレードでカタログが更新された場合に、OLM が新しい installPlan を生成します。

警告: TechPreviewUnsafeFailForward アップグレードストラテジーは安全ではありません。namespace で管理されている Operator セットを深く理解していないと、予期しない動作や回復不可能なデータ損失が発生する可能性があります。

10.1.2. .spec.selector

説明
Selector は、OperatorGroup のターゲット namespace を選択します。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

10.1.3. .spec.selector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

10.1.4. .spec.selector.matchExpressions[]

説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

10.1.5. .status

説明
OperatorGroupStatus は、OperatorGroupResource のステータスです。
object
必須
  • lastUpdated
Expand
プロパティー説明

conditions

array

条件は、OperatorGroup の条件の配列です。

conditions[]

object

condition には、この API Resource の現在の状態のある側面の詳細が含まれます。

lastUpdated

string

LastUpdated は、OperatorGroup のステータスが最後に更新されたときのタイムスタンプです。

namespaces

array (string)

namespaces は、OperatorGroup のターゲット namespaces のセットです。

serviceAccountRef

object

ServiceAccountRef は、指定されたサービスアカウントオブジェクトを参照します。

10.1.6. .status.conditions

説明
条件は、OperatorGroup の条件の配列です。
array

10.1.7. .status.conditions[]

説明
condition には、この API Resource の現在の状態のある側面の詳細が含まれます。
object
必須
  • lastTransitionTime
  • message
  • reason
  • status
  • type
Expand
プロパティー説明

lastTransitionTime

string

lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。

message

string

message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。

observedGeneration

integer

observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。

reason

string

reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。

status

string

条件のステータス、True、False、Unknown のいずれか。

type

string

CamelCase または foo.example.com/CamelCase の条件のタイプ。

10.1.8. .status.serviceAccountRef

説明
ServiceAccountRef は、指定されたサービスアカウントオブジェクトを参照します。
object
Expand
プロパティー説明

apiVersion

string

参照先の API バージョン。

fieldPath

string

オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。

kind

string

参照先の種類。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespace

string

参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

string

この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

string

参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

10.2. API エンドポイント

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

  • /apis/operators.coreos.com/v1/operatorgroups

    • GET: kind が OperatorGroup のオブジェクトをリスト表示します。
  • /apis/operators.coreos.com/v1/namespaces/{namespace}/operatorgroups

    • DELETE:OperatorGroup のコレクションを削除します
    • GET: kind が OperatorGroup のオブジェクトをリスト表示します。
    • POST:OperatorGroup を作成します
  • /apis/operators.coreos.com/v1/namespaces/{namespace}/operatorgroups/{name}

    • DELETE: OperatorGroup を削除します。
    • GET: 指定された OperatorGroup を読み取ります
    • PATCH: 指定された OperatorGroup を部分的に更新します
    • PUT: 指定された OperatorGroup を置き換えます
  • /apis/operators.coreos.com/v1/namespaces/{namespace}/operatorgroups/{name}/status

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

10.2.1. /apis/operators.coreos.com/v1/operatorgroups

HTTP メソッド
GET
説明
kind が OperatorGroup のオブジェクトをリスト表示します。
Expand
表10.1 HTTP 応答
HTTP コード応答のボディー

200 - OK

OperatorGroupList スキーマ

401 - Unauthorized

空白

10.2.2. /apis/operators.coreos.com/v1/namespaces/{namespace}/operatorgroups

HTTP メソッド
DELETE
説明
OperatorGroup のコレクションを削除します
Expand
表10.2 HTTP 応答
HTTP コード応答のボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
kind が OperatorGroup のオブジェクトをリスト表示します。
Expand
表10.3 HTTP 応答
HTTP コード応答のボディー

200 - OK

OperatorGroupList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
OperatorGroup の作成
Expand
表10.4 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表10.5 本文パラメーター
パラメーター説明

body

OperatorGroup スキーマ

 
Expand
表10.6 HTTP 応答
HTTP コード応答のボディー

200 - OK

OperatorGroup スキーマ

201 - Created

OperatorGroup スキーマ

202 - Accepted

OperatorGroup スキーマ

401 - Unauthorized

空白

10.2.3. /apis/operators.coreos.com/v1/namespaces/{namespace}/operatorgroups/{name}

Expand
表10.7 グローバルパスパラメーター
パラメーター説明

name

string

OperatorGroup の名前

HTTP メソッド
DELETE
説明
OperatorGroup を削除します
Expand
表10.8 クエリーパラメーター
パラメーター説明

dryRun

string

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

Expand
表10.9 HTTP 応答
HTTP コード応答のボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された OperatorGroup を読み取ります
Expand
表10.10 HTTP 応答
HTTP コード応答のボディー

200 - OK

OperatorGroup スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

Expand
表10.12 HTTP 応答
HTTP コード応答のボディー

200 - OK

OperatorGroup スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された OperatorGroup を置き換えます
Expand
表10.13 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表10.14 本文パラメーター
パラメーター説明

body

OperatorGroup スキーマ

 
Expand
表10.15 HTTP 応答
HTTP コード応答のボディー

200 - OK

OperatorGroup スキーマ

201 - Created

OperatorGroup スキーマ

401 - Unauthorized

空白

10.2.4. /apis/operators.coreos.com/v1/namespaces/{namespace}/operatorgroups/{name}/status

Expand
表10.16 グローバルパスパラメーター
パラメーター説明

name

string

OperatorGroup の名前

HTTP メソッド
GET
説明
指定された OperatorGroup のステータスを読み取ります
Expand
表10.17 HTTP 応答
HTTP コード応答のボディー

200 - OK

OperatorGroup スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

Expand
表10.19 HTTP 応答
HTTP コード応答のボディー

200 - OK

OperatorGroup スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

Expand
表10.21 本文パラメーター
パラメーター説明

body

OperatorGroup スキーマ

 
Expand
表10.22 HTTP 応答
HTTP コード応答のボディー

200 - OK

OperatorGroup スキーマ

201 - Created

OperatorGroup スキーマ

401 - Unauthorized

空白

第11章 PackageManifest [packages.operators.coreos.com/v1]

説明
PackageManifest は、パッケージに関する情報を保持します。これは、単一のパッケージの下にある 1 つ (または複数) のチャネルへの参照です。
object

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

PackageManifestSpec は、PackageManifest の望ましい状態を定義します

status

object

PackageManifestStatus は、PackageManifest の現在のステータスを表します

11.1.1. .spec

説明
PackageManifestSpec は、PackageManifest の望ましい状態を定義します
object

11.1.2. .status

説明
PackageManifestStatus は、PackageManifest の現在のステータスを表します
object
必須
  • catalogSource
  • catalogSourceDisplayName
  • catalogSourcePublisher
  • catalogSourceNamespace
  • packageName
  • channels
  • defaultChannel
Expand
プロパティー説明

catalogSource

string

CatalogSource は、このパッケージが属する CatalogSource の名前です。

catalogSourceDisplayName

string

 

catalogSourceNamespace

string

CatalogSourceNamespace は、所有する CatalogSource の namespace です。

catalogSourcePublisher

string

 

channels

array

チャネルは、パッケージの宣言されたチャネルであり、安定版 または アルファ版 です。

channels[]

object

PackageChannel は、パッケージの下に単一のチャネルを定義し、そのパッケージのバージョンを指します。

defaultChannel

string

DefaultChannel は、指定されている場合、パッケージのデフォルトチャネルの名前です。他のチャネルが明示的に指定されていない場合、デフォルトのチャネルがインストールされます。パッケージに単一のチャネルがある場合、そのチャネルは暗黙的にデフォルトになります。

deprecation

object

Deprecation は、非推奨のリソースに関する情報を伝えるものです。

packageName

string

PackageName は、パッケージ全体の名前、ala etcd です。

provider

object

AppLink は、アプリケーションへのリンクを定義します

11.1.3. .status.channels

説明
チャネルは、パッケージの宣言されたチャネルであり、安定版 または アルファ版 です。
array

11.1.4. .status.channels[]

説明
PackageChannel は、パッケージの下に単一のチャネルを定義し、そのパッケージのバージョンを指します。
object
必須
  • name
  • currentCSV
  • entries
Expand
プロパティー説明

currentCSV

string

CurrentCSV は、現在チャネル用にこのパッケージのバージョンを保持している CSV への参照を定義します。

currentCSVDesc

object

CSVDescription は、CSV の説明を定義します

deprecation

object

Deprecation は、非推奨のリソースに関する情報を伝えるものです。

entries

array

Entries は、チャネル内のすべての CSV とそのアップグレードエッジをリストします。

entries[]

object

ChannelEntry は、パッケージチャネルのメンバーを定義します。

name

string

名前はチャネルの名前です (例: アルファ または 安定)

11.1.5. .status.channels[].currentCSVDesc

説明
CSVDescription は、CSV の説明を定義します
object
Expand
プロパティー説明

annotations

object (string)

 

apiservicedefinitions

APIServiceDefinitions

 

customresourcedefinitions

CustomResourceDefinitions

 

description

string

LongDescription は CSV の説明です

displayName

string

DisplayName は、CSV の表示名です。

icon

array

アイコンは CSV の base64 エンコードアイコンです

icon[]

object

アイコンは、base64 でエンコードされたアイコンとメディアタイプを定義します

installModes

array (InstallMode)

InstallModes は、サポートされているインストールタイプを指定します

keywords

array (string)

 

links

array

 

links[]

object

AppLink は、アプリケーションへのリンクを定義します

maintainers

array

 

maintainers[]

object

メンテナーはプロジェクトメンテナーを定義します

maturity

string

 

minKubeVersion

string

Operator がインストールするための Kubernetes の最小バージョン

nativeApis

array (GroupVersionKind)

 

provider

object

AppLink は、アプリケーションへのリンクを定義します

relatedImages

array (string)

関連イメージのリスト

version

OperatorVersion

バージョンは CSV のセマンティックバージョンです

11.1.6. .status.channels[].currentCSVDesc.icon

説明
アイコンは CSV の base64 エンコードアイコンです
array

11.1.7. .status.channels[].currentCSVDesc.icon[]

説明
アイコンは、base64 でエンコードされたアイコンとメディアタイプを定義します
object
Expand
プロパティー説明

base64data

string

 

mediatype

string

 

11.1.10. .status.channels[].currentCSVDesc.maintainers

説明
array

11.1.11. .status.channels[].currentCSVDesc.maintainers[]

説明
メンテナーはプロジェクトメンテナーを定義します
object
Expand
プロパティー説明

email

string

 

name

string

 

11.1.12. .status.channels[].currentCSVDesc.provider

説明
AppLink は、アプリケーションへのリンクを定義します
object
Expand
プロパティー説明

name

string

 

url

string

 

11.1.13. .status.channels[].deprecation

説明
Deprecation は、非推奨のリソースに関する情報を伝えるものです。
object
必須
  • message
Expand
プロパティー説明

message

string

Message は、非推奨を説明した人間が判読できるメッセージです。

11.1.14. .status.channels[].entries

説明
Entries は、チャネル内のすべての CSV とそのアップグレードエッジをリストします。
array

11.1.15. .status.channels[].entries[]

説明
ChannelEntry は、パッケージチャネルのメンバーを定義します。
object
必須
  • name
Expand
プロパティー説明

deprecation

object

Deprecation は、非推奨のリソースに関する情報を伝えるものです。

name

string

Name は、このエントリーのバンドルの名前です。

version

string

Version は、このエントリーのバンドルのバージョンです。

11.1.16. .status.channels[].entries[].deprecation

説明
Deprecation は、非推奨のリソースに関する情報を伝えるものです。
object
必須
  • message
Expand
プロパティー説明

message

string

Message は、非推奨を説明した人間が判読できるメッセージです。

11.1.17. .status.deprecation

説明
Deprecation は、非推奨のリソースに関する情報を伝えるものです。
object
必須
  • message
Expand
プロパティー説明

message

string

Message は、非推奨を説明した人間が判読できるメッセージです。

11.1.18. .status.provider

説明
AppLink は、アプリケーションへのリンクを定義します
object
Expand
プロパティー説明

name

string

 

url

string

 

11.2. API エンドポイント

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

  • /apis/packages.operators.coreos.com/v1/packagemanifests

    • GET: kind が PackageManifest のオブジェクトをリスト表示します。
  • /apis/packages.operators.coreos.com/v1/namespaces/{namespace}/packagemanifests

    • GET: kind が PackageManifest のオブジェクトをリスト表示します。
  • /apis/packages.operators.coreos.com/v1/namespaces/{namespace}/packagemanifests/{name}

    • GET: 指定された PackageManifest を読み取ります
  • /apis/packages.operators.coreos.com/v1/namespaces/{namespace}/packagemanifests/{name}/icon

    • GET:GET リクエストを PackageManifest のアイコンに接続します

11.2.1. /apis/packages.operators.coreos.com/v1/packagemanifests

HTTP メソッド
GET
説明
kind が PackageManifest のオブジェクトをリスト表示します。
Expand
表11.1 HTTP 応答
HTTP コード応答のボディー

200 - OK

PackageManifestList スキーマ

11.2.2. /apis/packages.operators.coreos.com/v1/namespaces/{namespace}/packagemanifests

HTTP メソッド
GET
説明
kind が PackageManifest のオブジェクトをリスト表示します。
Expand
表11.2 HTTP 応答
HTTP コード応答のボディー

200 - OK

PackageManifestList スキーマ

11.2.3. /apis/packages.operators.coreos.com/v1/namespaces/{namespace}/packagemanifests/{name}

Expand
表11.3 グローバルパスパラメーター
パラメーター説明

name

string

PackageManifest の名前

HTTP メソッド
GET
説明
指定された PackageManifest を読み取ります
Expand
表11.4 HTTP 応答
HTTP コード応答のボディー

200 - OK

PackageManifest スキーマ

11.2.4. /apis/packages.operators.coreos.com/v1/namespaces/{namespace}/packagemanifests/{name}/icon

Expand
表11.5 グローバルパスパラメーター
パラメーター説明

name

string

PackageManifest の名前

HTTP メソッド
GET
説明
GET リクエストを PackageManifest のアイコンに接続します
Expand
表11.6 HTTP 応答
HTTP コード応答のボディー

200 - OK

string

第12章 Subscription [operators.coreos.com/v1alpha1]

説明
サブスクリプションは、カタログへの変更を追跡することにより、Operator を最新の状態に保ちます。
object
必須
  • metadata
  • spec

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

SubscriptionSpec は、インストール可能なアプリケーションを定義します

status

object

 

12.1.1. .spec

説明
SubscriptionSpec は、インストール可能なアプリケーションを定義します
object
必須
  • name
  • source
  • sourceNamespace
Expand
プロパティー説明

channel

string

 

config

object

SubscriptionConfig には、サブスクリプションに指定された設定が含まれています。

installPlanApproval

string

承認は、InstallPlan のユーザー認可ポリシーです。"Automatic" または "Manual" のいずれかである必要があります。

name

string

 

source

string

 

sourceNamespace

string

 

startingCSV

string

 

12.1.2. .spec.config

説明
SubscriptionConfig には、サブスクリプションに指定された設定が含まれています。
object
Expand
プロパティー説明

affinity

object

指定されている場合、Pod のスケジュール制約がオーバーライドされます。nil サブ属性は、pod.spec 内にある nil サブ属性の元の値を オーバーライドしません。元のサブ属性値を消去するには、空のオブジェクト ({}) を使用します。

annotations

object (string)

Annotations は、Operator 内の各 Deployment、Pod、APIService とともに保存される非構造化キー値マップです。通常、アノテーションは外部ツールによって設定でき、任意のメタデータを保存および取得します。このフィールドは、OLM がサブスクリプションの Deployment、Pod、および APIService それぞれに追加する必要があるアノテーションを事前に定義するために使用します。

env

array

Env は、コンテナーに設定する環境変数のリストです。これは更新できません。

env[]

object

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

envFrom

array

EnvFrom は、コンテナー内の環境変数に入力するソースのリストです。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。変更不可能です。

envFrom[]

object

EnvFromSource は ConfigMap または Secret のセットのソースを表します

nodeSelector

object (string)

NodeSelector は、Pod がノードに収まるようにするために true である必要があるセレクターです。そのノードでスケジュールされる Pod のノードのラベルと一致する必要があるセレクター。詳細: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

resources

object

リソースは、このコンテナーに必要なコンピューティングリソースを表します。変更不可能です。詳細: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

selector

object

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

tolerations

array

許容値は Pod の許容値です。

tolerations[]

object

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

volumeMounts

array

コンテナーに設定する VolumeMounts のリスト。

volumeMounts[]

object

VolumeMount は、コンテナー内でのボリュームのマウントを説明します。

volumes

array

podSpec で設定するボリュームのリスト。

volumes[]

object

ボリュームは、Pod 内の任意のコンテナーからアクセスできる Pod 内の名前付きボリュームを表します。

12.1.3. .spec.config.affinity

説明
指定されている場合、Pod のスケジュール制約がオーバーライドされます。nil サブ属性は、pod.spec 内にある nil サブ属性の元の値を オーバーライドしません。元のサブ属性値を消去するには、空のオブジェクト ({}) を使用します。
object
Expand
プロパティー説明

nodeAffinity

object

Pod のノードアフィニティースケジューリングルールを説明します。

podAffinity

object

Pod アフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置します)。

podAntiAffinity

object

Pod のアンチアフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置しないでください)。

12.1.4. .spec.config.affinity.nodeAffinity

説明
Pod のノードアフィニティースケジューリングルールを説明します。
object
Expand
プロパティー説明

preferredDuringSchedulingIgnoredDuringExecution

array

スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードが対応する matchExpressions と一致する場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。

preferredDuringSchedulingIgnoredDuringExecution[]

object

空の優先スケジューリング用語は、暗黙の重み 0 を持つすべてのオブジェクトに一致します (つまり、操作なしです)。null の優先スケジューリング用語は、オブジェクトに一致しません (つまり、no-op でもあります)。

requiredDuringSchedulingIgnoredDuringExecution

object

このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (更新など)、システムは最終的に Pod をノードから退避しようとする場合としない場合があります。

12.1.5. .spec.config.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution

説明
スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードが対応する matchExpressions と一致する場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。
array

12.1.6. .spec.config.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

説明
空の優先スケジューリング用語は、暗黙の重み 0 を持つすべてのオブジェクトに一致します (つまり、操作なしです)。null の優先スケジューリング用語は、オブジェクトに一致しません (つまり、no-op でもあります)。
object
必須
  • preference
  • weight
Expand
プロパティー説明

preference

object

対応する重みに関連付けられたノードセレクター用語。

weight

integer

対応する nodeSelectorTerm の一致に関連する重み (1〜100 の範囲)。

12.1.7. .spec.config.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference

説明
対応する重みに関連付けられたノードセレクター用語。
object
Expand
プロパティー説明

matchExpressions

array

ノードのラベルごとのノードセレクター要件のリスト。

matchExpressions[]

object

ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchFields

array

ノードのフィールドごとのノードセレクター要件のリスト。

matchFields[]

object

ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

12.1.8. .spec.config.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions

説明
ノードのラベルごとのノードセレクター要件のリスト。
array

12.1.9. .spec.config.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[]

説明
ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

セレクターが適用されるラベルキー。

operator

string

キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。

values

array (string)

文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

12.1.10. .spec.config.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields

説明
ノードのフィールドごとのノードセレクター要件のリスト。
array

12.1.11. .spec.config.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[]

説明
ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

セレクターが適用されるラベルキー。

operator

string

キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。

values

array (string)

文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

12.1.12. .spec.config.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

説明
このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (更新など)、システムは最終的に Pod をノードから退避しようとする場合としない場合があります。
object
必須
  • nodeSelectorTerms
Expand
プロパティー説明

nodeSelectorTerms

array

必須。ノードセレクター用語のリスト。用語は OR されています。

nodeSelectorTerms[]

object

null または空のノードセレクター用語はオブジェクトに一致しません。これらの要件は AND で結合されます。TopologySelectorTerm タイプは、NodeSelectorTerm のサブセットを実装します。

12.1.13. .spec.config.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

説明
必須。ノードセレクター用語のリスト。用語は OR されています。
array

12.1.14. .spec.config.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[]

説明
null または空のノードセレクター用語はオブジェクトに一致しません。これらの要件は AND で結合されます。TopologySelectorTerm タイプは、NodeSelectorTerm のサブセットを実装します。
object
Expand
プロパティー説明

matchExpressions

array

ノードのラベルごとのノードセレクター要件のリスト。

matchExpressions[]

object

ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchFields

array

ノードのフィールドごとのノードセレクター要件のリスト。

matchFields[]

object

ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

説明
ノードのラベルごとのノードセレクター要件のリスト。
array
説明
ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

セレクターが適用されるラベルキー。

operator

string

キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。

values

array (string)

文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

12.1.17. .spec.config.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields

説明
ノードのフィールドごとのノードセレクター要件のリスト。
array
説明
ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

セレクターが適用されるラベルキー。

operator

string

キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。

values

array (string)

文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

12.1.19. .spec.config.affinity.podAffinity

説明
Pod アフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置します)。
object
Expand
プロパティー説明

preferredDuringSchedulingIgnoredDuringExecution

array

スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードに対応する podAffinityTerm に一致する Pod がある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。

preferredDuringSchedulingIgnoredDuringExecution[]

object

一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。

requiredDuringSchedulingIgnoredDuringExecution

array

このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから退避しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。

requiredDuringSchedulingIgnoredDuringExecution[]

object

この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。

12.1.20. .spec.config.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution

説明
スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードに対応する podAffinityTerm に一致する Pod がある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。
array

12.1.21. .spec.config.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

説明
一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。
object
必須
  • podAffinityTerm
  • weight
Expand
プロパティー説明

podAffinityTerm

object

必須。対応する重みに関連付けられた Pod アフィニティー用語。

weight

integer

対応する podAffinityTerm の一致に関連する重み (1〜100 の範囲)。

12.1.22. .spec.config.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm

説明
必須。対応する重みに関連付けられた Pod アフィニティー用語。
object
必須
  • topologyKey
Expand
プロパティー説明

labelSelector

object

リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。

matchLabelKeys

array (string)

MatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは key in (value) として labelSelector にマージされ、着信 Pod の Pod アフィニティー (アンチアフィニティー) として考慮される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。デフォルト値は空です。matchLabelKeys と labelSelector の両方に同じキーが存在することは禁止されています。また、labelSelector が設定されていない場合、matchLabelKeys は設定できません。

mismatchLabelKeys

array (string)

MismatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは key notin (value) として labelSelector にマージされ、着信 Pod の Pod アフィニティー (アンチアフィニティー) として考慮される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。デフォルト値は空です。mismatchLabelKeys と labelSelector の両方に同じキーが存在することは禁止されています。また、labelSelector が設定されていない場合、mismatchLabelKeys は設定できません。

namespaceSelector

object

用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。

namespaces

array (string)

namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび null namespaceSelector は、"この Pod の namespace" を意味します

topologyKey

string

この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。

12.1.23. .spec.config.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector

説明
リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

説明
用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

12.1.29. .spec.config.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution

説明
このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから退避しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。
array

12.1.30. .spec.config.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[]

説明
この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。
object
必須
  • topologyKey
Expand
プロパティー説明

labelSelector

object

リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。

matchLabelKeys

array (string)

MatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは key in (value) として labelSelector にマージされ、着信 Pod の Pod アフィニティー (アンチアフィニティー) として考慮される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。デフォルト値は空です。matchLabelKeys と labelSelector の両方に同じキーが存在することは禁止されています。また、labelSelector が設定されていない場合、matchLabelKeys は設定できません。

mismatchLabelKeys

array (string)

MismatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは key notin (value) として labelSelector にマージされ、着信 Pod の Pod アフィニティー (アンチアフィニティー) として考慮される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。デフォルト値は空です。mismatchLabelKeys と labelSelector の両方に同じキーが存在することは禁止されています。また、labelSelector が設定されていない場合、mismatchLabelKeys は設定できません。

namespaceSelector

object

用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。

namespaces

array (string)

namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび null namespaceSelector は、"この Pod の namespace" を意味します

topologyKey

string

この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。

12.1.31. .spec.config.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector

説明
リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

12.1.32. .spec.config.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

12.1.34. .spec.config.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector

説明
用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

12.1.37. .spec.config.affinity.podAntiAffinity

説明
Pod のアンチアフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置しないでください)。
object
Expand
プロパティー説明

preferredDuringSchedulingIgnoredDuringExecution

array

スケジューラーは、このフィールドで指定されたアンチアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アンチアフィニティー式など) を満たすノードごとに、の要素を反復処理して合計を計算します。このフィールドと、対応する podAffinityTerm に一致する Pod がノードにある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。

preferredDuringSchedulingIgnoredDuringExecution[]

object

一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。

requiredDuringSchedulingIgnoredDuringExecution

array

このフィールドで指定されたアンチアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアンチアフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから退避しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。

requiredDuringSchedulingIgnoredDuringExecution[]

object

この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。

12.1.38. .spec.config.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution

説明
スケジューラーは、このフィールドで指定されたアンチアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アンチアフィニティー式など) を満たすノードごとに、の要素を反復処理して合計を計算します。このフィールドと、対応する podAffinityTerm に一致する Pod がノードにある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。
array

12.1.39. .spec.config.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

説明
一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。
object
必須
  • podAffinityTerm
  • weight
Expand
プロパティー説明

podAffinityTerm

object

必須。対応する重みに関連付けられた Pod アフィニティー用語。

weight

integer

対応する podAffinityTerm の一致に関連する重み (1〜100 の範囲)。

12.1.40. .spec.config.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm

説明
必須。対応する重みに関連付けられた Pod アフィニティー用語。
object
必須
  • topologyKey
Expand
プロパティー説明

labelSelector

object

リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。

matchLabelKeys

array (string)

MatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは key in (value) として labelSelector にマージされ、着信 Pod の Pod アフィニティー (アンチアフィニティー) として考慮される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。デフォルト値は空です。matchLabelKeys と labelSelector の両方に同じキーが存在することは禁止されています。また、labelSelector が設定されていない場合、matchLabelKeys は設定できません。

mismatchLabelKeys

array (string)

MismatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは key notin (value) として labelSelector にマージされ、着信 Pod の Pod アフィニティー (アンチアフィニティー) として考慮される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。デフォルト値は空です。mismatchLabelKeys と labelSelector の両方に同じキーが存在することは禁止されています。また、labelSelector が設定されていない場合、mismatchLabelKeys は設定できません。

namespaceSelector

object

用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。

namespaces

array (string)

namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび null namespaceSelector は、"この Pod の namespace" を意味します

topologyKey

string

この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。

説明
リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

説明
用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

12.1.47. .spec.config.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution

説明
このフィールドで指定されたアンチアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアンチアフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから退避しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。
array

12.1.48. .spec.config.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[]

説明
この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。
object
必須
  • topologyKey
Expand
プロパティー説明

labelSelector

object

リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。

matchLabelKeys

array (string)

MatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは key in (value) として labelSelector にマージされ、着信 Pod の Pod アフィニティー (アンチアフィニティー) として考慮される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。デフォルト値は空です。matchLabelKeys と labelSelector の両方に同じキーが存在することは禁止されています。また、labelSelector が設定されていない場合、matchLabelKeys は設定できません。

mismatchLabelKeys

array (string)

MismatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは key notin (value) として labelSelector にマージされ、着信 Pod の Pod アフィニティー (アンチアフィニティー) として考慮される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。デフォルト値は空です。mismatchLabelKeys と labelSelector の両方に同じキーが存在することは禁止されています。また、labelSelector が設定されていない場合、mismatchLabelKeys は設定できません。

namespaceSelector

object

用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。

namespaces

array (string)

namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび null namespaceSelector は、"この Pod の namespace" を意味します

topologyKey

string

この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。

12.1.49. .spec.config.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector

説明
リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

12.1.52. .spec.config.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector

説明
用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

12.1.55. .spec.config.env

説明
Env は、コンテナーに設定する環境変数のリストです。これは更新できません。
array

12.1.56. .spec.config.env[]

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

name

string

環境変数の名前。C_IDENTIFIER である必要があります。

value

string

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

valueFrom

object

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

12.1.57. .spec.config.env[].valueFrom

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

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 の namespace でシークレットのキーを選択します。

12.1.58. .spec.config.env[].valueFrom.configMapKeyRef

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

key

string

選択するキー。

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

12.1.59. .spec.config.env[].valueFrom.fieldRef

説明
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 バージョンで選択するフィールドのパス。

12.1.60. .spec.config.env[].valueFrom.resourceFieldRef

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

containerName

string

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

divisor

integer-or-string

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

resource

string

必須: 選択するリソース

12.1.61. .spec.config.env[].valueFrom.secretKeyRef

説明
Pod の namespace でシークレットのキーを選択します。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

12.1.62. .spec.config.envFrom

説明
EnvFrom は、コンテナー内の環境変数に入力するソースのリストです。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。変更不可能です。
array

12.1.63. .spec.config.envFrom[]

説明
EnvFromSource は ConfigMap または Secret のセットのソースを表します
object
Expand
プロパティー説明

configMapRef

object

選択する ConfigMap

prefix

string

各環境変数の名前の先頭に追加するオプションのテキスト。C_IDENTIFIER である必要があります。

secretRef

object

から選択する秘密

12.1.64. .spec.config.envFrom[].configMapRef

説明
選択する ConfigMap
object
Expand
プロパティー説明

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

ConfigMap を定義する必要があるかどうかを指定します

12.1.65. .spec.config.envFrom[].secretRef

説明
から選択する秘密
object
Expand
プロパティー説明

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

12.1.66. .spec.config.resources

説明
リソースは、このコンテナーに必要なコンピューティングリソースを表します。変更不可能です。詳細: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
object
Expand
プロパティー説明

claims

array

Claims には、spec.resourceClaims で定義され、このコンテナーによって使用されるリソースの名前がリストされます。

これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。

このフィールドは変更不可能です。これはコンテナーにのみ設定できます。

claims[]

object

ResourceClaim は、PodSpec.ResourceClaims 内の 1 つのエントリーを参照します。

limits

integer-or-string

limits は、許可されるコンピュートリソースの最大量を示します。詳細: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

requests は、必要なコンピュートリソースの最小量を示します。コンテナーで Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。リクエストは制限を超えることはできません。詳細: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

12.1.67. .spec.config.resources.claims

説明

Claims には、spec.resourceClaims で定義され、このコンテナーによって使用されるリソースの名前がリストされます。

これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。

このフィールドは変更不可能です。これはコンテナーにのみ設定できます。

array

12.1.68. .spec.config.resources.claims[]

説明
ResourceClaim は、PodSpec.ResourceClaims 内の 1 つのエントリーを参照します。
object
必須
  • name
Expand
プロパティー説明

name

string

name は、このフィールドが使用される Pod の pod.spec.resourceClaims に含まれる、1 つのエントリーの名前と一致する必要があります。これにより、そのリソースがコンテナー内で利用可能になります。

request

string

request は、参照されるクレーム内のリクエストに対して選択された名前です。空の場合、クレームからのすべてのものが利用可能になり、それ以外の場合はこの request の結果のみが利用可能になります。

12.1.69. .spec.config.selector

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

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

12.1.70. .spec.config.selector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

12.1.71. .spec.config.selector.matchExpressions[]

説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

12.1.72. .spec.config.tolerations

説明
許容値は Pod の許容値です。
array

12.1.73. .spec.config.tolerations[]

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

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 以外の場合このフィールドは無視されます) が taint を許容する期間を表します。デフォルトでは設定されていません。つまり、テイントを永久に許容します (退避しないでください)。ゼロ値と負の値は、システムによって 0 (すぐに退避) として扱われます。

value

string

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

12.1.74. .spec.config.volumeMounts

説明
コンテナーに設定する VolumeMounts のリスト。
array

12.1.75. .spec.config.volumeMounts[]

説明
VolumeMount は、コンテナー内でのボリュームのマウントを説明します。
object
必須
  • mountPath
  • name
Expand
プロパティー説明

mountPath

string

ボリュームをマウントする必要があるコンテナー内のパス。':' を含めることはできません。

mountPropagation

string

mountPropagation は、マウントがホストからコンテナーに、またはその逆にどのように伝播されるかを決定します。設定されていない場合、MountPropagationNone が使用されます。このフィールドは 1.10 のベータ版です。RecursiveReadOnly が IfPossible または Enabled に設定されている場合、MountPropagation は None または未指定 (デフォルトは None) にする必要があります。

name

string

ボリュームの名前に一致する必要があります。

readOnly

boolean

true の場合は読み取り専用、それ以外の場合は読み取り/書き込み (false または指定なし) でマウントされます。デフォルトは false です。

recursiveReadOnly

string

RecursiveReadOnly は、読み取り専用マウントを再帰的に処理するかどうかを指定します。

ReadOnly が false の場合、このフィールドには意味がなく、未指定にする必要があります。

ReadOnly が true で、このフィールドが Disabled に設定されている場合、マウントは再帰的に読み取り専用にはなりません。このフィールドが IfPossible に設定されている場合、コンテナーランタイムでサポートされている場合は、マウントは再帰的に読み取り専用になります。このフィールドが Enabled に設定されている場合で、コンテナーランタイムでサポートされている場合は、マウントが再帰的に読み取り専用になり、そうでない場合は Pod が起動されず、理由を示すエラーが生成されます。

このフィールドが IfPossible または Enabled に設定されている場合、MountPropagation は None に設定する必要があります (または未指定にする必要があります。この場合、デフォルトは None になります)。

このフィールドが指定されていない場合は、無効と同じ扱いになります。

subPath

string

コンテナーのボリュームをマウントする必要があるボリューム内のパス。デフォルトは "" (ボリュームのルート) です。

subPathExpr

string

コンテナーのボリュームをマウントする必要があるボリューム内の拡張パス。SubPath と同様に動作しますが、環境変数参照 $(VAR_NAME) は、コンテナーの環境を使用して展開されます。デフォルトは "" (ボリュームのルート) です。SubPathExpr と SubPath は相互に排他的です。

12.1.76. .spec.config.volumes

説明
podSpec で設定するボリュームのリスト。
array

12.1.77. .spec.config.volumes[]

説明
ボリュームは、Pod 内の任意のコンテナーからアクセスできる Pod 内の名前付きボリュームを表します。
object
必須
  • name
Expand
プロパティー説明

awsElasticBlockStore

object

awsElasticBlockStore は、kubelet のホストマシンに割り当てられ、Pod に公開される AWS Disk リソースを表します。非推奨: AWSElasticBlockStore は非推奨です。ツリー内 awsElasticBlockStore タイプのすべての操作は、ebs.csi.aws.com CSI ドライバーにリダイレクトされます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

azureDisk

object

azureDisk は、ホスト上の Azure Data Disk マウントを表し、Pod へのバインドマウントを表します。非推奨: AzureDisk は非推奨です。ツリー内 azureDisk タイプのすべての操作は、disk.csi.azure.com CSI ドライバーにリダイレクトされます。

azureFile

object

azureFile は、ホスト上の Azure File Service マウントを表し、マウントを Pod にバインドします。非推奨: AzureFile は非推奨です。ツリー内 azureFile タイプのすべての操作は、file.csi.azure.com CSI ドライバーにリダイレクトされます。

cephfs

object

cephFS は、Pod の有効期間を共有するホストでの Ceph FS マウントを表します。非推奨: CephFS は非推奨であり、ツリー内の cephfs タイプはサポートされなくなりました。

cinder

object

Cinder は、kubelets ホストマシンに接続およびマウントされた Cinder ボリュームを表します。非推奨: Cinder は非推奨です。インツリー cinder タイプのすべての操作は、cinder.csi.openstack.org CSI ドライバーにリダイレクトされます。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md

configMap

object

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

csi

object

csi (Container Storage Interface) は、特定の外部 CSI ドライバーによって処理される一時ストレージを表します。

downwardAPI

object

downwardAPI は、このボリュームに入力する必要がある Pod に関する Downward API を表します

emptyDir

object

emptyDir は、Pod の存続期間を共有する一時ディレクトリーを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

ephemeral

object

ephemeral は、クラスターストレージドライバーによって処理されるボリュームを表します。ボリュームのライフサイクルは、ボリュームを定義する Pod に関連付けられています。ボリュームは、Pod が起動する前に作成され、Pod が削除されると削除されます。

これは、次の場合に使用します。a)Pod の実行中にのみボリュームが必要、b) スナップショットからの復元や容量追跡などの通常のボリュームの機能が必要、c) ストレージドライバーがストレージクラスを通じて指定される、d) ストレージドライバー PersistentVolumeClaim を介した動的ボリュームプロビジョニングをサポートします (このボリュームタイプと PersistentVolumeClaim の間の接続の詳細は、EphemeralVolumeSource を参照してください)。

個々の Pod のライフサイクルより長く持続するボリュームには、PersistentVolumeClaim またはベンダー固有の API の 1 つを使用します。

CSI ドライバーをそのように使用する場合は、軽量のローカルエフェメラルボリュームに CSI を使用します。詳細は、ドライバーのドキュメントを参照してください。

Pod は、両方のタイプのエフェメラルボリュームとパーシステントボリュームを同時に使用できます。

fc

object

fc は、kubelet のホストマシンに接続されてから Pod に公開されるファイバーチャネルリソースを表します。

flexVolume

object

flexVolume は、exec ベースのプラグインを使用してプロビジョニング/接続される汎用ボリュームリソースを表します。非推奨: FlexVolume は非推奨です。代わりに CSIDriver の使用を検討してください。

flocker

object

flocker は、kubelet のホストマシンに接続されている Flocker ボリュームを表します。これは、実行中の Flocker 制御サービスによって異なります非推奨: Flocker は非推奨であり、ツリー内の Flocker タイプはサポートされなくなりました。

gcePersistentDisk

object

gcePersistentDisk は、kubelet のホストマシンに接続されてから Pod に公開される GCE ディスクリソースを表します。非推奨: GCEPersistentDisk は非推奨です。インツリー gcePersistentDisk タイプのすべての操作は、pd.csi.storage.gke.io CSI ドライバーにリダイレクトされます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

gitRepo

object

gitRepo は、特定のリビジョンの git リポジトリーを表します。非推奨: GitRepo は非推奨となりました。git リポジトリーを使用してコンテナーをプロビジョニングするには、Git を使用してリポジトリーのクローンを作成する InitContainer に EmptyDir をマウントしてから、Pod のコンテナーに EmptyDir をマウントします。

glusterfs

object

glusterfs は、Pod の存続期間を共有するホスト上の Glusterfs マウントを表します。非推奨: Glusterfs は非推奨であり、ツリー内の glusterfs タイプはサポートされなくなりました。詳細: https://examples.k8s.io/volumes/glusterfs/README.md

hostPath

object

hostPath は、コンテナーに直接公開されているホストマシン上の既存のファイルまたはディレクトリーを表します。これは通常、ホストマシンの表示を許可されているシステムエージェントまたはその他の特権的なものに使用されます。ほとんどのコンテナーはこれを必要としません。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

image

object

image は、kubelet のホストマシンにプルおよびマウントされた OCI オブジェクト (コンテナーイメージまたはアーティファクト) を表します。ボリュームは、提供される PullPolicy 値に応じて Pod の起動時に解決されます。

- Always: kubelet は常に参照をプルしようとします。プルが失敗すると、コンテナーの作成は失敗します。- Never: kubelet は参照をプルせず、ローカルイメージまたはアーティファクトのみを使用します。参照が存在しない場合、コンテナーの作成は失敗します。- IfNotPresent: 参照がディスク上にまだ存在しない場合、kubelet はプルします。参照が存在しず、プルが失敗すると、コンテナーの作成は失敗します。

Pod が削除されて再作成されるとボリュームが再度解決され、Pod の再作成時に新しいリモートコンテンツが利用可能になります。Pod の起動中にイメージを解決またはプルできない場合、コンテナーの起動がブロックされ、大幅な遅延が発生する可能性があります。失敗した場合は通常のボリュームバックオフを使用して再試行され、理由とメッセージが Pod で報告されます。このボリュームによってマウントされる可能性のあるオブジェクトのタイプは、ホストマシン上のコンテナーランタイム実装によって定義され、少なくともコンテナーイメージフィールドでサポートされているすべての有効なタイプが含まれている必要があります。OCI オブジェクトは、コンテナーイメージの場合と同じ方法でマニフェストレイヤーをマージすることで、単一ディレクトリー (spec.containers[].volumeMounts.mountPath) にマウントされます。ボリュームは、読み取り専用 (ro) および実行不可ファイル (noexec) としてマウントされます。コンテナーのサブパスマウント (spec.containers[].volumeMounts.subpath) は、バージョン 1.33 より前ではサポートされていません。spec.securityContext.fsGroupChangePolicy フィールドは、このボリュームタイプには影響しません。

iscsi

object

iscsi は、kubelet のホストマシンに接続されてから Pod に公開される ISCSI ディスクリソースを表します。詳細: https://examples.k8s.io/volumes/iscsi/README.md

name

string

ボリュームの名前。DNS_LABEL であり、Pod 内で一意である必要があります。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

nfs

object

NFS は、Pod の有効期間を共有するホスト上の NFS マウントを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs

persistentVolumeClaim

object

persistentVolumeClaimVolumeSource は、同じ namespace 内の PersistentVolumeClaim への参照を表します。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

photonPersistentDisk

object

photonPersistentDisk は、kubelets ホストマシンに接続されマウントされた PhotonController 永続ディスクを表します。非推奨: PhotonPersistentDisk は非推奨であり、ツリー内の photonPersistentDisk タイプはサポートされなくなりました。

portworxVolume

object

portworxVolume は、kubelet ホストマシンに接続およびマウントされた portworx ボリュームを表します。非推奨: PortworxVolume は非推奨です。CSIMigrationPortworx フィーチャーゲートがオンの場合、ツリー内 portworxVolume タイプのすべての操作は pxd.portworx.com CSI ドライバーにリダイレクトされます。

projected

object

オールインワンリソースシークレット、configmaps、および Downward API のアイテム

quobyte

object

quobyte は、Pod の有効期限を共有するホストでの Quobyte マウントを表します非推奨: Quobyte は非推奨であり、ツリー内の quobyte タイプはサポートされなくなりました。

rbd

object

rbd は、Pod の有効期間を共有するホストの Rados ブロックデバイスマウントを表します。非推奨: RBD は非推奨であり、ツリー内の rbd タイプはサポートされなくなりました。詳細: https://examples.k8s.io/volumes/rbd/README.md

scaleIO

object

scaleIO は、Kubernetes ノードに接続およびマウントされた ScaleIO 永続ボリュームを表します。非推奨: ScaleIO は非推奨であり、ツリー内の scaleIO タイプはサポートされなくなりました。

secret

object

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

storageos

object

storageOS は、Kubernetes ノードに接続およびマウントされた StorageOS ボリュームを表します。非推奨: StorageOS は非推奨であり、ツリー内の storageos タイプはサポートされなくなりました。

vsphereVolume

object

vsphereVolume は、kubelet ホストマシンに接続およびマウントされた vSphere ボリュームを表します。非推奨: VsphereVolume は非推奨です。ツリー内 vsphereVolume タイプのすべての操作は、csi.vsphere.vmware.com CSI ドライバーにリダイレクトされます。

12.1.78. .spec.config.volumes[].awsElasticBlockStore

説明
awsElasticBlockStore は、kubelet のホストマシンに割り当てられ、Pod に公開される AWS Disk リソースを表します。非推奨: AWSElasticBlockStore は非推奨です。ツリー内 awsElasticBlockStore タイプのすべての操作は、ebs.csi.aws.com CSI ドライバーにリダイレクトされます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
object
必須
  • volumeID
Expand
プロパティー説明

fsType

string

fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

partition

integer

partition は、マウントするボリューム内のパーティションです。省略した場合、デフォルトではボリューム名でマウントします。例: ボリューム/dev/sda1 の場合、パーティションを "1" として指定します。同様に、/dev/sda のボリュームパーティションは "0" です (または、プロパティーを空のままにしておくこともできます)。

readOnly

boolean

readOnly 値 true は、VolumeMounts の readOnly 設定を強制的に実行します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

volumeID

string

volumeID は、AWS の永続ディスクリソースの一意の ID です (Amazon EBS ボリューム)。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

12.1.79. .spec.config.volumes[].azureDisk

説明
azureDisk は、ホスト上の Azure Data Disk マウントを表し、Pod へのバインドマウントを表します。非推奨: AzureDisk は非推奨です。ツリー内 azureDisk タイプのすべての操作は、disk.csi.azure.com CSI ドライバーにリダイレクトされます。
object
必須
  • diskName
  • diskURI
Expand
プロパティー説明

cachingMode

string

cachingMode はホストキャッシュモードです (None, Read Only, Read Write)。

diskName

string

diskName は、Blob ストレージ内のデータディスクの名前です。

diskURI

string

diskURI は、Blob ストレージ内のデータディスクの URI です

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

kind

string

kind での期待値は、Shared (ストレージアカウントごとに複数のブロブディスク)、Dedicated (ストレージアカウントごとにブロブ 1 つ)、Managed (Azure の管理データディスク (管理対象のアベイラビリティーセットのみ)) です。デフォルトは Shared です。

readOnly

boolean

readOnly。デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

12.1.80. .spec.config.volumes[].azureFile

説明
azureFile は、ホスト上の Azure File Service マウントを表し、マウントを Pod にバインドします。非推奨: AzureFile は非推奨です。ツリー内 azureFile タイプのすべての操作は、file.csi.azure.com CSI ドライバーにリダイレクトされます。
object
必須
  • secretName
  • shareName
Expand
プロパティー説明

readOnly

boolean

readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

secretName

string

secretName は、Azure ストレージアカウント名とキーを含むシークレットの名前です。

shareName

string

shareName は Azure 共有名です。

12.1.81. .spec.config.volumes[].cephfs

説明
cephFS は、Pod の有効期間を共有するホストでの Ceph FS マウントを表します。非推奨: CephFS は非推奨であり、ツリー内の cephfs タイプはサポートされなくなりました。
object
必須
  • monitors
Expand
プロパティー説明

monitors

array (string)

monitors は必須: Monitors は Ceph モニターのコレクションです。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

path

string

パスは任意: 完全な Ceph ツリーではなく、マウントされたルートとして使用されます。デフォルトは / です。

readOnly

boolean

readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

secretFile

string

secretFile は任意: SecretFile はユーザーのキーリングへのパスです。デフォルトは /etc/ceph/user.secret です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

secretRef

object

secretRef は任意: SecretRef はユーザーの認証シークレットへの参照で、デフォルトは空です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

user

string

user 任意: User は rados ユーザー名、デフォルトは admin です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

12.1.82. .spec.config.volumes[].cephfs.secretRef

説明
secretRef は任意: SecretRef はユーザーの認証シークレットへの参照で、デフォルトは空です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
object
Expand
プロパティー説明

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

12.1.83. .spec.config.volumes[].cinder

説明
Cinder は、kubelets ホストマシンに接続およびマウントされた Cinder ボリュームを表します。非推奨: Cinder は非推奨です。インツリー cinder タイプのすべての操作は、cinder.csi.openstack.org CSI ドライバーにリダイレクトされます。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md
object
必須
  • volumeID
Expand
プロパティー説明

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md

readOnly

boolean

readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md

secretRef

object

secretRef は任意: OpenStack への接続に使用されるパラメーターを含むシークレットオブジェクトを指します。

volumeID

string

cinder 内のボリュームを識別するために使用される volumeID。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md

12.1.84. .spec.config.volumes[].cinder.secretRef

説明
secretRef は任意: OpenStack への接続に使用されるパラメーターを含むシークレットオブジェクトを指します。
object
Expand
プロパティー説明

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

12.1.85. .spec.config.volumes[].configMap

説明
configMap は、このボリュームに入力する必要がある configMap を表します
object
Expand
プロパティー説明

defaultMode

integer

defaultMode は任意: デフォルトで、作成されたファイルのアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。デフォルトは 0644 に設定されます。パス内のディレクトリーはこの設定の影響を受けません。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。

items

array

item が指定されていない場合、参照される ConfigMap の Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。ConfigMap に存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。

items[]

object

文字列キーをボリューム内のパスにマップします。

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

12.1.86. .spec.config.volumes[].configMap.items

説明
item が指定されていない場合、参照される ConfigMap の Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。ConfigMap に存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
array

12.1.87. .spec.config.volumes[].configMap.items[]

説明
文字列キーをボリューム内のパスにマップします。
object
必須
  • key
  • path
Expand
プロパティー説明

key

string

key はプロジェクトのキーです。

mode

integer

mode は任意: このファイルにアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。指定しない場合、ボリューム defaultMode が使用されます。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。

path

string

path はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。

12.1.88. .spec.config.volumes[].csi

説明
csi (Container Storage Interface) は、特定の外部 CSI ドライバーによって処理される一時ストレージを表します。
object
必須
  • driver
Expand
プロパティー説明

driver

string

driver は、このボリュームを処理する CSI ドライバーの名前です。クラスターに登録されている正しい名前は、管理者に相談してください。

fsType

string

マウントする fsType。例: "ext4"、"xfs"、"ntfs"。指定しない場合、空の値が関連する CSI ドライバーに渡され、適用するデフォルトのファイルシステムが決定されます。

nodePublishSecretRef

object

nodePublishSecretRef は、CSI NodePublishVolume および NodeUnpublishVolume 呼び出しを完了するために CSI ドライバーに渡す機密情報を含むシークレットオブジェクトへの参照です。このフィールドはオプションであり、シークレットが不要な場合は空の場合があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレット参照が渡されます。

readOnly

boolean

readOnly は、ボリュームの読み取り専用設定を指定します。デフォルトは false (読み取り/書き込み) です。

volumeAttributes

object (string)

volumeAttributes は、CSI ドライバーに渡されるドライバー固有のプロパティーを格納します。サポートされている値は、ドライバーのドキュメントを参照してください。

12.1.89. .spec.config.volumes[].csi.nodePublishSecretRef

説明
nodePublishSecretRef は、CSI NodePublishVolume および NodeUnpublishVolume 呼び出しを完了するために CSI ドライバーに渡す機密情報を含むシークレットオブジェクトへの参照です。このフィールドはオプションであり、シークレットが不要な場合は空の場合があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレット参照が渡されます。
object
Expand
プロパティー説明

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

12.1.90. .spec.config.volumes[].downwardAPI

説明
downwardAPI は、このボリュームに入力する必要がある Pod に関する Downward API を表します
object
Expand
プロパティー説明

defaultMode

integer

オプション: デフォルトで作成されたファイルで使用するモードビット。オプション: デフォルトで作成されたファイルのパーミッションを設定するために使用されるモードビット。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。デフォルトは 0644 に設定されます。パス内のディレクトリーはこの設定の影響を受けません。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。

items

array

items は、Downward API ボリュームファイルのリストです

items[]

object

DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します

12.1.91. .spec.config.volumes[].downwardAPI.items

説明
items は、Downward API ボリュームファイルのリストです
array

12.1.92. .spec.config.volumes[].downwardAPI.items[]

説明
DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します
object
必須
  • path
Expand
プロパティー説明

fieldRef

object

必須: Pod のフィールドを選択します。アノテーション、ラベル、名前、namespace、および UID のみがサポートされています。

mode

integer

オプション: このファイルの権限を設定するために使用されるモードビットは、0000 から 0777 までの 8 進数値、または 0 から 511 までの 10 進数値でなければなりません。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。指定しない場合、ボリューム defaultMode が使用されます。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。

path

string

必須: パスは、作成するファイルの相対パス名です。絶対パスまたは '..' パスを含めることはできません。utf-8 でエンコードする必要があります。相対パスの最初の項目は '..' で始まってはなりません。

resourceFieldRef

object

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

12.1.93. .spec.config.volumes[].downwardAPI.items[].fieldRef

説明
必須: Pod のフィールドを選択します。アノテーション、ラベル、名前、namespace、および UID のみがサポートされています。
object
必須
  • fieldPath
Expand
プロパティー説明

apiVersion

string

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

fieldPath

string

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

12.1.94. .spec.config.volumes[].downwardAPI.items[].resourceFieldRef

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

containerName

string

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

divisor

integer-or-string

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

resource

string

必須: 選択するリソース

12.1.95. .spec.config.volumes[].emptyDir

説明
emptyDir は、Pod の存続期間を共有する一時ディレクトリーを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
object
Expand
プロパティー説明

medium

string

medium は、このディレクトリーをバックアップする必要があるストレージメディアのタイプを表します。デフォルトは"" です。これは、ノードのデフォルトのメディアを使用することを意味します。空の文字列 (デフォルト) またはメモリーである必要があります。詳細: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

sizeLimit

integer-or-string

sizeLimit は、この EmptyDir ボリュームに必要なローカルストレージの合計量です。サイズ制限はメモリーメディアにも適用されます。メモリーメディア EmptyDir での最大使用量は、ここで指定された SizeLimit と Pod 内のすべてのコンテナーのメモリー制限の合計との間の最小値になります。デフォルトは nil です。これは、制限が未定義であることを意味します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

12.1.96. .spec.config.volumes[].ephemeral

説明

ephemeral は、クラスターストレージドライバーによって処理されるボリュームを表します。ボリュームのライフサイクルは、ボリュームを定義する Pod に関連付けられています。ボリュームは、Pod が起動する前に作成され、Pod が削除されると削除されます。

これは、次の場合に使用します。a)Pod の実行中にのみボリュームが必要、b) スナップショットからの復元や容量追跡などの通常のボリュームの機能が必要、c) ストレージドライバーがストレージクラスを通じて指定される、d) ストレージドライバー PersistentVolumeClaim を介した動的ボリュームプロビジョニングをサポートします (このボリュームタイプと PersistentVolumeClaim の間の接続の詳細は、EphemeralVolumeSource を参照してください)。

個々の Pod のライフサイクルより長く持続するボリュームには、PersistentVolumeClaim またはベンダー固有の API の 1 つを使用します。

CSI ドライバーをそのように使用する場合は、軽量のローカルエフェメラルボリュームに CSI を使用します。詳細は、ドライバーのドキュメントを参照してください。

Pod は、両方のタイプのエフェメラルボリュームとパーシステントボリュームを同時に使用できます。

object
Expand
プロパティー説明

volumeClaimTemplate

object

ボリュームをプロビジョニングするためのスタンドアロン PVC を作成するために使用されます。この EphemeralVolumeSource が埋め込まれている Pod が PVC の所有者になります。つまり、PVC は Pod と一緒に削除されます。PVC の名前は <pod name>-<volume name> になります。ここで、<volume name>PodSpec.Volumes アレイエントリーからの名前です。連結された名前が PVC に対して有効でない場合 (たとえば、長すぎる場合)、Pod 検証は Pod を拒否します。

Pod が所有していないその名前の既存の PVC は、無関係なボリュームを誤って使用することを避けるために、Pod に使用され ません。Pod の起動は、無関係の PVC が削除されるまでブロックされます。そのような事前に作成された PVC が Pod で使用されることを意図している場合、Pod が存在すると、PVC は Pod への所有者参照で更新する必要があります。通常、これは必要ありませんが、壊れたクラスターを手動で再構築する場合に役立つことがあります。

このフィールドは読み取り専用であり、作成後に Kubernetes が PVC に変更を加えることはありません。

必須です。nil であってはなりません。

12.1.97. .spec.config.volumes[].ephemeral.volumeClaimTemplate

説明

ボリュームをプロビジョニングするためのスタンドアロン PVC を作成するために使用されます。この EphemeralVolumeSource が埋め込まれている Pod が PVC の所有者になります。つまり、PVC は Pod と一緒に削除されます。PVC の名前は <pod name>-<volume name> になります。ここで、<volume name>PodSpec.Volumes アレイエントリーからの名前です。連結された名前が PVC に対して有効でない場合 (たとえば、長すぎる場合)、Pod 検証は Pod を拒否します。

Pod が所有していないその名前の既存の PVC は、無関係なボリュームを誤って使用することを避けるために、Pod に使用され ません。Pod の起動は、無関係の PVC が削除されるまでブロックされます。そのような事前に作成された PVC が Pod で使用されることを意図している場合、Pod が存在すると、PVC は Pod への所有者参照で更新する必要があります。通常、これは必要ありませんが、壊れたクラスターを手動で再構築する場合に役立つことがあります。

このフィールドは読み取り専用であり、作成後に Kubernetes が PVC に変更を加えることはありません。

必須です。nil であってはなりません。

object
必須
  • spec
Expand
プロパティー説明

metadata

object

PVC の作成時に PVC にコピーされるラベルとアノテーションが含まれる場合があります。他のフィールドは許可されておらず、検証中に拒否されます。

spec

object

PersistentVolumeClaim の仕様。コンテンツ全体が、このテンプレートから作成された PVC に変更されずにコピーされます。PersistentVolumeClaim と同じフィールドがここでも有効です。

12.1.98. .spec.config.volumes[].ephemeral.volumeClaimTemplate.metadata

説明
PVC の作成時に PVC にコピーされるラベルとアノテーションが含まれる場合があります。他のフィールドは許可されておらず、検証中に拒否されます。
object

12.1.99. .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec

説明
PersistentVolumeClaim の仕様。コンテンツ全体が、このテンプレートから作成された PVC に変更されずにコピーされます。PersistentVolumeClaim と同じフィールドがここでも有効です。
object
Expand
プロパティー説明

accessModes

array (string)

accessModes には、ボリュームに割り当てる必要のあるアクセスモードが含まれます。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

dataSource

object

dataSource フィールドは、次のいずれかを指定するために使用できます。*既存の VolumeSnapshot オブジェクト (snapshot.storage.k8s.io/VolumeSnapshot)*既存の PVC(PersistentVolumeClaim) プロビジョナーまたは外部コントローラーが指定されたデータソースをサポートできる場合、指定されたデータソースのコンテンツに基づく新しいボリューム。AnyVolumeDataSource フィーチャーゲートが有効になっている場合、dataSource の内容は dataSourceRef にコピーされ、dataSourceRef.namespace が指定されていない場合に dataSourceRef コンテンツが dataSource にコピーされます。namespace が指定されている場合、dataSourceRef は dataSource にコピーされません。

dataSourceRef

object

dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これには、空ではない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のオブジェクトを指定できます。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、dataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性を確保するために、dataSourceRef で namespace が指定されておらず、一方が空でもう一方が空でない場合、両方のフィールド (dataSource と dataSourceRef) が自動的に同じ値に設定されます。dataSourceRef で namespace が指定されている場合、dataSource は同じ値に設定されていないため、空にする必要があります。dataSource と dataSourceRef には 3 つの重要な違いがあります。* dataSource では 2 つの特定のタイプのオブジェクトのみが使用できますが、dataSourceRef ではコアオブジェクト以外および PersistentVolumeClaim オブジェクトを使用できます。* dataSource は使用できない値を無視 (ドロップ) しますが、dataSourceRef はすべての値を保持し、使用できない値が指定された場合はエラーを生成します。* dataSource ではローカルオブジェクトのみが使用できますが、dataSourceRef では任意の namespace のオブジェクトを使用できます。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。(アルファ版) dataSourceRef の namespace フィールドを使用するには、CrossNamespaceVolumeDataSource フィーチャーゲートを有効にする必要があります。

resources

object

resources は、ボリュームに必要な最小リソースを表します。RecoverVolumeExpansionFailure 機能が有効になっている場合、ユーザーは以前の値よりも低いリソース要件を指定できますが、要求のステータスフィールドに記録された容量よりも大きい必要があります。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

selector

object

selector は、バインドを考慮するボリュームに対するラベルクエリーです。

storageClassName

string

storageClassName は、要求に必要な StorageClass の名前です。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

volumeAttributesClassName

string

volumeAttributesClassName は、このクレームで使用される VolumeAttributesClass を設定するために使用できます。指定すると、CSI ドライバーは、対応する VolumeAttributesClass で定義された属性を使用してボリュームを作成または更新します。これは storageClassName とは異なる目的があり、クレームの作成後に変更できます。空の文字列値は、クレームに VolumeAttributesClass が適用されないことを意味しますが、一度設定すると、このフィールドを空の文字列にリセットすることはできません。指定されておらず、PersistentVolumeClaim がバインドされていない場合は、永続ボリュームコントローラーが存在する場合は、デフォルトの VolumeAttributesClass が設定されます。volumeAttributesClass によって参照されるリソースが存在しない場合は、そのようなリソースが存在するまで、この PersistentVolumeClaim は、modifyVolumeStatus フィールドに反映されるように、保留状態に設定されます。詳細は、https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ (ベータ版) を参照してください。このフィールドを使用するには、VolumeAttributesClass フィーチャーゲートを有効にする必要があります (デフォルトではオフ)。

volumeMode

string

volumeMode は、要求に必要なボリュームのタイプを定義します。Filesystem の値は、要求仕様に含まれていない場合に暗示されます。

volumeName

string

volumeName は、この要求をサポートする PersistentVolume へのバインディング参照です。

12.1.100. .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.dataSource

説明
dataSource フィールドは、次のいずれかを指定するために使用できます。*既存の VolumeSnapshot オブジェクト (snapshot.storage.k8s.io/VolumeSnapshot)*既存の PVC(PersistentVolumeClaim) プロビジョナーまたは外部コントローラーが指定されたデータソースをサポートできる場合、指定されたデータソースのコンテンツに基づく新しいボリューム。AnyVolumeDataSource フィーチャーゲートが有効になっている場合、dataSource の内容は dataSourceRef にコピーされ、dataSourceRef.namespace が指定されていない場合に dataSourceRef コンテンツが dataSource にコピーされます。namespace が指定されている場合、dataSourceRef は dataSource にコピーされません。
object
必須
  • kind
  • name
Expand
プロパティー説明

apiGroup

string

APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。

kind

string

kind は参照されているリソースのタイプです。

name

string

name は、参照されているリソースの名前です。

12.1.101. .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef

説明
dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これには、空ではない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のオブジェクトを指定できます。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、dataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性を確保するために、dataSourceRef で namespace が指定されておらず、一方が空でもう一方が空でない場合、両方のフィールド (dataSource と dataSourceRef) が自動的に同じ値に設定されます。dataSourceRef で namespace が指定されている場合、dataSource は同じ値に設定されていないため、空にする必要があります。dataSource と dataSourceRef には 3 つの重要な違いがあります。* dataSource では 2 つの特定のタイプのオブジェクトのみが使用できますが、dataSourceRef ではコアオブジェクト以外および PersistentVolumeClaim オブジェクトを使用できます。* dataSource は使用できない値を無視 (ドロップ) しますが、dataSourceRef はすべての値を保持し、使用できない値が指定された場合はエラーを生成します。* dataSource ではローカルオブジェクトのみが使用できますが、dataSourceRef では任意の namespace のオブジェクトを使用できます。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。(アルファ版) dataSourceRef の namespace フィールドを使用するには、CrossNamespaceVolumeDataSource フィーチャーゲートを有効にする必要があります。
object
必須
  • kind
  • name
Expand
プロパティー説明

apiGroup

string

APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。

kind

string

kind は参照されているリソースのタイプです。

name

string

name は、参照されているリソースの名前です。

namespace

string

Namespace は、参照されるリソースの namespace です。namespace が指定されている場合は、その namespace の所有者が参照を受け入れることができるように、参照された namespace に gateway.networking.k8s.io/ReferenceGrant オブジェクトが必要であることに注意してください。詳細は、ReferenceGrant ドキュメントを参照してください。(アルファ版) このフィールドでは、CrossNamespaceVolumeDataSource フィーチャーゲートを有効にする必要があります。

12.1.102. .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.resources

説明
resources は、ボリュームに必要な最小リソースを表します。RecoverVolumeExpansionFailure 機能が有効になっている場合、ユーザーは以前の値よりも低いリソース要件を指定できますが、要求のステータスフィールドに記録された容量よりも大きい必要があります。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
object
Expand
プロパティー説明

limits

integer-or-string

limits は、許可されるコンピュートリソースの最大量を示します。詳細: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

requests は、必要なコンピュートリソースの最小量を示します。コンテナーで Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。リクエストは制限を超えることはできません。詳細: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

12.1.103. .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.selector

説明
selector は、バインドを考慮するボリュームに対するラベルクエリーです。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

12.1.104. .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

12.1.105. .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[]

説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

12.1.106. .spec.config.volumes[].fc

説明
fc は、kubelet のホストマシンに接続されてから Pod に公開されるファイバーチャネルリソースを表します。
object
Expand
プロパティー説明

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

lun

integer

LUN は任意: FC ターゲットの LUN 番号

readOnly

boolean

readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

targetWWNs

array (string)

targetWWNs は任意: FC ターゲットのワールドワイド名 (WWN)

wwids

array (string)

wwids は任意: FC ボリュームのワールドワイド ID(wwids)wwids または targetWWN と lun の組み合わせのいずれかを設定する必要がありますが、両方を同時に設定できません。

12.1.107. .spec.config.volumes[].flexVolume

説明
flexVolume は、exec ベースのプラグインを使用してプロビジョニング/接続される汎用ボリュームリソースを表します。非推奨: FlexVolume は非推奨です。代わりに CSIDriver の使用を検討してください。
object
必須
  • driver
Expand
プロパティー説明

driver

string

driver は、このボリュームに使用するドライバーの名前です。

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。デフォルトのファイルシステムは FlexVolume スクリプトに依存します。

options

object (string)

options は任意: このフィールドには追加のコマンドオプションがあれば保持されます。

readOnly

boolean

readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

secretRef

object

secretRef は任意: secretRef は、プラグインスクリプトに渡す機密情報を含むシークレットオブジェクトへの参照です。シークレットオブジェクトが指定されていない場合、これは空になる可能性があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレットがプラグインスクリプトに渡されます。

12.1.108. .spec.config.volumes[].flexVolume.secretRef

説明
secretRef は任意: secretRef は、プラグインスクリプトに渡す機密情報を含むシークレットオブジェクトへの参照です。シークレットオブジェクトが指定されていない場合、これは空になる可能性があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレットがプラグインスクリプトに渡されます。
object
Expand
プロパティー説明

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

12.1.109. .spec.config.volumes[].flocker

説明
flocker は、kubelet のホストマシンに接続されている Flocker ボリュームを表します。これは、実行中の Flocker 制御サービスによって異なります非推奨: Flocker は非推奨であり、ツリー内の Flocker タイプはサポートされなくなりました。
object
Expand
プロパティー説明

datasetName

string

datasetName はメタデータとして保存されているデータセットの名前です → Flocker のデータセット上の名前は非推奨として扱うようにしてください。

datasetUUID

string

datasetUUID は、データセットの UUID です。これは Flocker データセットの一意の識別子です

12.1.110. .spec.config.volumes[].gcePersistentDisk

説明
gcePersistentDisk は、kubelet のホストマシンに接続されてから Pod に公開される GCE ディスクリソースを表します。非推奨: GCEPersistentDisk は非推奨です。インツリー gcePersistentDisk タイプのすべての操作は、pd.csi.storage.gke.io CSI ドライバーにリダイレクトされます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
object
必須
  • pdName
Expand
プロパティー説明

fsType

string

fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

partition

integer

partition は、マウントするボリューム内のパーティションです。省略した場合、デフォルトではボリューム名でマウントします。例: ボリューム/dev/sda1 の場合、パーティションを "1" として指定します。同様に、/dev/sda のボリュームパーティションは "0" です (または、プロパティーを空のままにしておくこともできます)。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

pdName

string

pdName は、GCE の PD リソースの一意の名前です。GCE でディスクを識別するために使用されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

readOnly

boolean

この readOnly は、VolumeMounts で ReadOnly 設定が強制的に指定されます。デフォルトは false です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

12.1.111. .spec.config.volumes[].gitRepo

説明
gitRepo は、特定のリビジョンの git リポジトリーを表します。非推奨: GitRepo は非推奨となりました。git リポジトリーを使用してコンテナーをプロビジョニングするには、Git を使用してリポジトリーのクローンを作成する InitContainer に EmptyDir をマウントしてから、Pod のコンテナーに EmptyDir をマウントします。
object
必須
  • repository
Expand
プロパティー説明

directory

string

directory は、ターゲットディレクトリー名です。'..' を含まない、または..で始まらないようにする必要があります。もしも '。' が提供されている場合、ボリュームディレクトリーは git リポジトリーになります。それ以外の場合、指定されている場合、ボリュームには、指定された名前のサブディレクトリーに git リポジトリーが含まれます。

repository

string

repository は URL です。

revision

string

revision は、指定されたリビジョンのコミットハッシュです。

12.1.112. .spec.config.volumes[].glusterfs

説明
glusterfs は、Pod の存続期間を共有するホスト上の Glusterfs マウントを表します。非推奨: Glusterfs は非推奨であり、ツリー内の glusterfs タイプはサポートされなくなりました。詳細: https://examples.k8s.io/volumes/glusterfs/README.md
object
必須
  • endpoints
  • path
Expand
プロパティー説明

endpoints

string

endpoints は、Glusterfs トポロジーの詳細を示すエンドポイント名です。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

path

string

path は Glusterfs ボリュームパスです。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

readOnly

boolean

この readOnly は、Glusterfs ボリュームを読み取り専用のアクセス権限で強制的にマウントします。デフォルトは false です。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

12.1.113. .spec.config.volumes[].hostPath

説明
hostPath は、コンテナーに直接公開されているホストマシン上の既存のファイルまたはディレクトリーを表します。これは通常、ホストマシンの表示を許可されているシステムエージェントまたはその他の特権的なものに使用されます。ほとんどのコンテナーはこれを必要としません。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
object
必須
  • path
Expand
プロパティー説明

path

string

ホスト上のディレクトリーのパス。パスがシンボリックリンクの場合、実際のパスへのリンクをたどります。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

type

string

HostPath ボリュームのデフォルトのタイプは "" です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

12.1.114. .spec.config.volumes[].image

説明

image は、kubelet のホストマシンにプルおよびマウントされた OCI オブジェクト (コンテナーイメージまたはアーティファクト) を表します。ボリュームは、提供される PullPolicy 値に応じて Pod の起動時に解決されます。

  • Always: kubelet は常に参照をプルしようとします。プルに失敗すると、コンテナーの作成は失敗します。
  • Never: kubelet は参照をプルせず、ローカルイメージまたはアーティファクトのみを使用します。参照が存在しない場合は、コンテナーの作成に失敗します。
  • IfNotPresent: 参照がディスクに存在しない場合は、kubelet がプルします。参照が存在しず、プルが失敗すると、コンテナーの作成は失敗します。

Pod が削除されて再作成されるとボリュームが再度解決され、Pod の再作成時に新しいリモートコンテンツが利用可能になります。Pod の起動中にイメージを解決またはプルできない場合、コンテナーの起動がブロックされ、大幅な遅延が発生する可能性があります。失敗した場合は通常のボリュームバックオフを使用して再試行され、理由とメッセージが Pod で報告されます。このボリュームによってマウントされる可能性のあるオブジェクトのタイプは、ホストマシン上のコンテナーランタイム実装によって定義され、少なくともコンテナーイメージフィールドでサポートされているすべての有効なタイプが含まれている必要があります。OCI オブジェクトは、コンテナーイメージの場合と同じ方法でマニフェストレイヤーをマージすることで、単一ディレクトリー (spec.containers[].volumeMounts.mountPath) にマウントされます。ボリュームは、読み取り専用 (ro) および実行不可ファイル (noexec) としてマウントされます。コンテナーのサブパスマウント (spec.containers[].volumeMounts.subpath) は、バージョン 1.33 より前ではサポートされていません。spec.securityContext.fsGroupChangePolicy フィールドは、このボリュームタイプには影響しません。

object
Expand
プロパティー説明

pullPolicy

string

OCI オブジェクトをプルするためのポリシー。使用できる値: Always: kubelet は常に参照のプルを試行します。プルに失敗すると、コンテナーの作成は失敗します。Never: kubelet は参照をプルせず、ローカルイメージまたはアーティファクトのみを使用します。参照が存在しない場合は、コンテナーの作成に失敗します。IfNotPresent: 参照がディスクに存在しない場合は、kubelet がプルします。参照が存在しず、プルが失敗すると、コンテナーの作成は失敗します。デフォルトは、:latest タグが指定されている場合は常に、それ以外の場合は IfNotPresent です。

reference

string

必須: 使用するイメージまたはアーティファクトの参照。pod.spec.containers[*].image と同じように動作します。プルシークレットは、ノード認証情報、SA イメージプルシークレット、および Pod 仕様イメージプルシークレットを検索することで、コンテナーイメージの場合と同じ方法でアセンブルされます。詳細: https://kubernetes.io/docs/concepts/containers/images このフィールドはオプションであり、高レベルの設定管理で、Deployments や StatefulSets などのワークロードコントローラーのコンテナーイメージをデフォルトまたはオーバーライドできます。

12.1.115. .spec.config.volumes[].iscsi

説明
iscsi は、kubelet のホストマシンに接続されてから Pod に公開される ISCSI ディスクリソースを表します。詳細: https://examples.k8s.io/volumes/iscsi/README.md
object
必須
  • iqn
  • lun
  • targetPortal
Expand
プロパティー説明

chapAuthDiscovery

boolean

chapAuthDiscovery は、iSCSI 検出 CHAP 認証をサポートするかどうかを定義します。

chapAuthSession

boolean

chapAuthSession は、iSCSI セッション CHAP 認証をサポートするかどうかを定義します。

fsType

string

fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#iscsi

initiatorName

string

initiatorName は、カスタムの iSCSI イニシエーター名です。iscsiInterface と同時に initiatorName を指定すると、接続用に新しい iSCSI インターフェイス <target portal>:<volume name> が作成されます。

iqn

string

iqn は、ターゲットの iSCSI 修飾名です。

iscsiInterface

string

iscsiInterface は、iSCSI トランスポートを使用するインターフェイス名です。デフォルトは 'default' (tcp) です。

lun

integer

lun は、iSCSI ターゲット Lun 番号を表します。

portals

array (string)

ポータルは iSCSI ターゲットポータルリストです。ポートがデフォルト以外の場合、ポータルは IP または ip_addr:port のいずれかです (通常は TCP ポート 860 および 3260)。

readOnly

boolean

この readOnly は、VolumeMounts で ReadOnly 設定が強制的に指定されます。デフォルトは false です。

secretRef

object

secretRef は、iSCSI ターゲットおよびイニシエーター認証用の CHAP Secret です。

targetPortal

string

targetPortal は iSCSI Target Portal です。ポートがデフォルト以外の場合、ポータルは IP または ip_addr:port のいずれかです (通常は TCP ポート 860 および 3260)。

12.1.116. .spec.config.volumes[].iscsi.secretRef

説明
secretRef は、iSCSI ターゲットおよびイニシエーター認証用の CHAP Secret です。
object
Expand
プロパティー説明

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

12.1.117. .spec.config.volumes[].nfs

説明
NFS は、Pod の有効期間を共有するホスト上の NFS マウントを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs
object
必須
  • path
  • server
Expand
プロパティー説明

path

string

NFS サーバーがエクスポートしているパス。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs

readOnly

boolean

ここで readOnly を指定すると、NFS エクスポートが読み取り専用権限で強制的にマウントされます。デフォルトは false です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs

server

string

server は、NFS サーバーのホスト名または IP アドレスです。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs

12.1.118. .spec.config.volumes[].persistentVolumeClaim

説明
persistentVolumeClaimVolumeSource は、同じ namespace 内の PersistentVolumeClaim への参照を表します。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
object
必須
  • claimName
Expand
プロパティー説明

claimName

string

claimName は、このボリュームを使用する Pod と同じ namespace にある PersistentVolumeClaim の名前です。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

readOnly

boolean

readOnly は、VolumeMounts の ReadOnly 設定が強制的に指定されます。デフォルト: false

12.1.119. .spec.config.volumes[].photonPersistentDisk

説明
photonPersistentDisk は、kubelets ホストマシンに接続されマウントされた PhotonController 永続ディスクを表します。非推奨: PhotonPersistentDisk は非推奨であり、ツリー内の photonPersistentDisk タイプはサポートされなくなりました。
object
必須
  • pdID
Expand
プロパティー説明

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

pdID

string

pdID は、Photon Controller の永続ディスクを識別する ID です。

12.1.120. .spec.config.volumes[].portworxVolume

説明
portworxVolume は、kubelet ホストマシンに接続およびマウントされた portworx ボリュームを表します。非推奨: PortworxVolume は非推奨です。CSIMigrationPortworx フィーチャーゲートがオンの場合、ツリー内 portworxVolume タイプのすべての操作は pxd.portworx.com CSI ドライバーにリダイレクトされます。
object
必須
  • volumeID
Expand
プロパティー説明

fsType

string

fSType は、マウントするファイルシステムタイプを表します。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

readOnly

boolean

readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

volumeID

string

volumeID は、Portworx ボリュームを一意に識別します

12.1.121. .spec.config.volumes[].projected

説明
オールインワンリソースシークレット、configmaps、および Downward API のアイテム
object
Expand
プロパティー説明

defaultMode

integer

defaultMode は、作成されたファイルにデフォルトでアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。パス内のディレクトリーはこの設定の影響を受けません。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。

sources

array

sources は、ボリュームプロジェクションのリストです。このリストの各エントリーは 1 つのソースを処理します。

sources[]

object

サポートされている他のボリュームタイプと一緒にデプロイメントされる可能性のあるプロジェクションこれらのフィールドのいずれかを設定する必要があります。

12.1.122. .spec.config.volumes[].projected.sources

説明
sources は、ボリュームプロジェクションのリストです。このリストの各エントリーは 1 つのソースを処理します。
array

12.1.123. .spec.config.volumes[].projected.sources[]

説明
サポートされている他のボリュームタイプと一緒にデプロイメントされる可能性のあるプロジェクションこれらのフィールドのいずれかを設定する必要があります。
object
Expand
プロパティー説明

clusterTrustBundle

object

ClusterTrustBundle を使用すると、Pod が自動更新ファイル内の ClusterTrustBundle オブジェクトの .spec.trustBundle フィールドにアクセスできるようになります。

アルファ段階。ClusterTrustBundleProjection フィーチャーゲートによってゲートされます。

ClusterTrustBundle オブジェクトは、名前で選択することも、署名者名とラベルセレクターの組み合わせで選択することもできます。

Kubelet は、Pod ファイルシステムに書き込まれた PEM コンテンツの積極的な正規化を実行します。ブロック間コメントやブロックヘッダーなどの難解な PEM 機能は削除されます。証明書は重複排除されます。ファイル内の証明書の順序は任意です。Kubelet は時間の経過に伴い順序を変更する可能性があります。

configMap

object

プロジェクトへの configMap データの configMap 情報

downwardAPI

object

downwardAPI データのプロジェクトへの downwardAPI 情報

secret

object

投影するシークレットデータに関する情報

serviceAccountToken

object

serviceAccountToken は、投影する serviceAccountToken データに関する情報です。

12.1.124. .spec.config.volumes[].projected.sources[].clusterTrustBundle

説明

ClusterTrustBundle を使用すると、Pod が自動更新ファイル内の ClusterTrustBundle オブジェクトの .spec.trustBundle フィールドにアクセスできるようになります。

アルファ段階。ClusterTrustBundleProjection フィーチャーゲートによってゲートされます。

ClusterTrustBundle オブジェクトは、名前で選択することも、署名者名とラベルセレクターの組み合わせで選択することもできます。

Kubelet は、Pod ファイルシステムに書き込まれた PEM コンテンツの積極的な正規化を実行します。ブロック間コメントやブロックヘッダーなどの難解な PEM 機能は削除されます。証明書は重複排除されます。ファイル内の証明書の順序は任意です。Kubelet は時間の経過に伴い順序を変更する可能性があります。

object
必須
  • path
Expand
プロパティー説明

labelSelector

object

このラベルセレクターに一致するすべての ClusterTrustBundle を選択します。signerName が設定されている場合にのみ有効です。名前と相互に排他的です。設定されていない場合は、"何も一致しない" と解釈されます。設定されているが空の場合は、"すべてに一致する" と解釈されます。

name

string

オブジェクト名で単一の ClusterTrustBundle を選択します。signerName および labelSelector とは相互に排他的です。

optional

boolean

true の場合で、参照された ClusterTrustBundle が利用できない場合は、Pod の起動をブロックしないでください。名前を使用する場合、名前付き ClusterTrustBundle が存在しないことが許可されます。signerName を使用する場合、signerName と labelSelector の組み合わせは、0 個の ClusterTrustBundles と一致できます。

path

string

バンドルを書き込むためのボリュームルートからの相対パス。

signerName

string

この署名者名に一致するすべての ClusterTrustBundle を選択します。名前と相互に排他的です。選択されたすべての ClusterTrustBundle の内容が統合され、重複が排除されます。

12.1.125. .spec.config.volumes[].projected.sources[].clusterTrustBundle.labelSelector

説明
このラベルセレクターに一致するすべての ClusterTrustBundle を選択します。signerName が設定されている場合にのみ有効です。名前と相互に排他的です。設定されていない場合は、"何も一致しない" と解釈されます。設定されているが空の場合は、"すべてに一致する" と解釈されます。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

12.1.126. .spec.config.volumes[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

12.1.127. .spec.config.volumes[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions[]

説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティー説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

12.1.128. .spec.config.volumes[].projected.sources[].configMap

説明
プロジェクトへの configMap データの configMap 情報
object
Expand
プロパティー説明

items

array

item が指定されていない場合、参照される ConfigMap の Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。ConfigMap に存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。

items[]

object

文字列キーをボリューム内のパスにマップします。

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

12.1.129. .spec.config.volumes[].projected.sources[].configMap.items

説明
item が指定されていない場合、参照される ConfigMap の Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。ConfigMap に存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
array

12.1.130. .spec.config.volumes[].projected.sources[].configMap.items[]

説明
文字列キーをボリューム内のパスにマップします。
object
必須
  • key
  • path
Expand
プロパティー説明

key

string

key はプロジェクトのキーです。

mode

integer

mode は任意: このファイルにアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。指定しない場合、ボリューム defaultMode が使用されます。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。

path

string

path はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。

12.1.131. .spec.config.volumes[].projected.sources[].downwardAPI

説明
downwardAPI データのプロジェクトへの downwardAPI 情報
object
Expand
プロパティー説明

items

array

Items は DownwardAPIVolume ファイルのリストです

items[]

object

DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します

12.1.132. .spec.config.volumes[].projected.sources[].downwardAPI.items

説明
Items は DownwardAPIVolume ファイルのリストです
array

12.1.133. .spec.config.volumes[].projected.sources[].downwardAPI.items[]

説明
DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します
object
必須
  • path
Expand
プロパティー説明

fieldRef

object

必須: Pod のフィールドを選択します。アノテーション、ラベル、名前、namespace、および UID のみがサポートされています。

mode

integer

オプション: このファイルの権限を設定するために使用されるモードビットは、0000 から 0777 までの 8 進数値、または 0 から 511 までの 10 進数値でなければなりません。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。指定しない場合、ボリューム defaultMode が使用されます。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。

path

string

必須: パスは、作成するファイルの相対パス名です。絶対パスまたは '..' パスを含めることはできません。utf-8 でエンコードする必要があります。相対パスの最初の項目は '..' で始まってはなりません。

resourceFieldRef

object

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

12.1.134. .spec.config.volumes[].projected.sources[].downwardAPI.items[].fieldRef

説明
必須: Pod のフィールドを選択します。アノテーション、ラベル、名前、namespace、および UID のみがサポートされています。
object
必須
  • fieldPath
Expand
プロパティー説明

apiVersion

string

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

fieldPath

string

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

12.1.135. .spec.config.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef

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

containerName

string

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

divisor

integer-or-string

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

resource

string

必須: 選択するリソース

12.1.136. .spec.config.volumes[].projected.sources[].secret

説明
投影するシークレットデータに関する情報
object
Expand
プロパティー説明

items

array

items が指定されていない場合、参照されるシークレットの Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。シークレットに存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。

items[]

object

文字列キーをボリューム内のパスにマップします。

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

オプションフィールドは、シークレットかそのキーを定義する必要があるかどうかを指定します。

12.1.137. .spec.config.volumes[].projected.sources[].secret.items

説明
items が指定されていない場合、参照されるシークレットの Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。シークレットに存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
array

12.1.138. .spec.config.volumes[].projected.sources[].secret.items[]

説明
文字列キーをボリューム内のパスにマップします。
object
必須
  • key
  • path
Expand
プロパティー説明

key

string

key はプロジェクトのキーです。

mode

integer

mode は任意: このファイルにアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。指定しない場合、ボリューム defaultMode が使用されます。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。

path

string

path はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。

12.1.139. .spec.config.volumes[].projected.sources[].serviceAccountToken

説明
serviceAccountToken は、投影する serviceAccountToken データに関する情報です。
object
必須
  • path
Expand
プロパティー説明

audience

string

audience は、トークンの対象オーディエンスです。トークンの受信者は、トークンの audience で指定された識別子で自分自身を識別する必要があります。そうでない場合は、トークンを拒否する必要があります。audience はデフォルトで apiserver の識別子に設定されます。

expirationSeconds

integer

expirationSeconds は、サービスアカウントトークンの要求された有効期間です。トークンの有効期限が近づくと、kubelet ボリュームプラグインはサービスアカウントトークンをプロアクティブにローテーションします。トークンが存続時間の 80% より古い場合、またはトークンが 24 時間より古い場合、kubelet はトークンのローテーションを開始します。デフォルトは 1 時間で、少なくとも 10 分である必要があります。

path

string

path は、トークンのデプロイメント先となるファイルのマウントポイントに対する相対パスです。

12.1.140. .spec.config.volumes[].quobyte

説明
quobyte は、Pod の有効期限を共有するホストでの Quobyte マウントを表します非推奨: Quobyte は非推奨であり、ツリー内の quobyte タイプはサポートされなくなりました。
object
必須
  • registry
  • volume
Expand
プロパティー説明

group

string

アクセスできるボリュームをマップするグループ。デフォルトは no group です。

readOnly

boolean

ここでの readOnly は、Quobyte ボリュームを読み取り専用のアクセス権限で強制的にマウントします。デフォルトは false です。

registry

string

registry は、host:port ペアの文字列として指定された単一または複数の Quobyte Registry サービスを表し (複数のエントリーはコンマで区切る)、ボリュームの中央レジストリーとして機能します。

tenant

string

動的にプロビジョニングされた Quobyte ボリュームで使用されるバックエンドで指定の Quobyte ボリュームを所有するテナント。値はプラグインにより設定されます。

user

string

アクセスできるボリュームをマップするユーザー。デフォルトは serivceaccount user です。

volume

string

volume は、すでに作成されているクオバイトボリュームを名前で参照する文字列です。

12.1.141. .spec.config.volumes[].rbd

説明
rbd は、Pod の有効期間を共有するホストの Rados ブロックデバイスマウントを表します。非推奨: RBD は非推奨であり、ツリー内の rbd タイプはサポートされなくなりました。詳細: https://examples.k8s.io/volumes/rbd/README.md
object
必須
  • image
  • monitors
Expand
プロパティー説明

fsType

string

fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#rbd

image

string

image は rados イメージ名です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

keyring

string

keyring は、RBDUser のキーリングへのパスです。デフォルトは/etc/ceph/keyring です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

monitors

array (string)

monitors は Ceph モニターのコレクションです。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

pool

string

pool は rados プール名です。デフォルトは rbd です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

readOnly

boolean

この readOnly は、VolumeMounts で ReadOnly 設定が強制的に指定されます。デフォルトは false です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

secretRef

object

secretRef は、RBDUser の認証シークレットの名前です。提供されている場合、キーリングをオーバーライドします。デフォルトは nil です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

user

string

user は rados ユーザー名です。これにより、プール内にイメージを作成できます。デフォルトは admin です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

12.1.142. .spec.config.volumes[].rbd.secretRef

説明
secretRef は、RBDUser の認証シークレットの名前です。提供されている場合、キーリングをオーバーライドします。デフォルトは nil です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
object
Expand
プロパティー説明

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

12.1.143. .spec.config.volumes[].scaleIO

説明
scaleIO は、Kubernetes ノードに接続およびマウントされた ScaleIO 永続ボリュームを表します。非推奨: ScaleIO は非推奨であり、ツリー内の scaleIO タイプはサポートされなくなりました。
object
必須
  • gateway
  • secretRef
  • system
Expand
プロパティー説明

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。デフォルトは "xfs" です。

gateway

string

gateway は、ScaleIO API ゲートウェイのホストアドレスです。

protectionDomain

string

protectionDomain は、設定されたストレージの ScaleIO 保護ドメインの名前です。

readOnly

boolean

readOnly。デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

secretRef

object

secretRef は、ScaleIO ユーザーおよびその他の機密情報の秘密を参照します。これが指定されていない場合、ログイン操作は失敗します。

sslEnabled

boolean

sslEnabled Flag は、ゲートウェイとの SSL 通信を有効/無効にします。デフォルトは false です

storageMode

string

storageMode は、ボリュームのストレージを ThickProvisioned にするか ThinProvisioned にするかを示します。デフォルトは ThinProvisioned です。

storagePool

string

storagePool は、保護ドメインに関連付けられた ScaleIO ストレージプールです。

system

string

system は、ScaleIO で設定されたストレージシステムの名前です。

volumeName

string

volumeName は、このボリュームソースに関連付けられている、ScaleIO システムですでに作成されているボリュームの名前です。

12.1.144. .spec.config.volumes[].scaleIO.secretRef

説明
secretRef は、ScaleIO ユーザーおよびその他の機密情報の秘密を参照します。これが指定されていない場合、ログイン操作は失敗します。
object
Expand
プロパティー説明

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

12.1.145. .spec.config.volumes[].secret

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

defaultMode

integer

defaultMode は任意: デフォルトで、作成されたファイルのアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。デフォルトは 0644 に設定されます。パス内のディレクトリーはこの設定の影響を受けません。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。

items

array

items が指定されていない場合、参照されるシークレットの Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。シークレットに存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。

items[]

object

文字列キーをボリューム内のパスにマップします。

optional

boolean

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

secretName

string

secretName は、使用する Pod の namespace 内のシークレットの名前です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#secret

12.1.146. .spec.config.volumes[].secret.items

説明
items が指定されていない場合、参照されるシークレットの Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。シークレットに存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
array

12.1.147. .spec.config.volumes[].secret.items[]

説明
文字列キーをボリューム内のパスにマップします。
object
必須
  • key
  • path
Expand
プロパティー説明

key

string

key はプロジェクトのキーです。

mode

integer

mode は任意: このファイルにアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。指定しない場合、ボリューム defaultMode が使用されます。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。

path

string

path はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。

12.1.148. .spec.config.volumes[].storageos

説明
storageOS は、Kubernetes ノードに接続およびマウントされた StorageOS ボリュームを表します。非推奨: StorageOS は非推奨であり、ツリー内の storageos タイプはサポートされなくなりました。
object
Expand
プロパティー説明

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

readOnly

boolean

readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

secretRef

object

secretRef は、StorageOS API クレデンシャルを取得するために使用するシークレットを指定します。指定しない場合、デフォルト値が試行されます。

volumeName

string

volumeName は、人間が判読えきる形式の StorageOS ボリュームの名前です。ボリューム名は namespace 内でのみ一意です。

volumeNamespace

string

volumeNamespace は、StorageOS 内のボリュームのスコープを指定します。namespace が指定されていない場合は、Pod の namespace が使用されます。これにより、Kubernetes の名前スコープを StorageOS 内にミラーリングして、より緊密に統合することができます。VolumeName を任意の名前に設定して、デフォルトの動作をオーバーライドします。StorageOS 内で namespace を使用していない場合は、"デフォルト" に設定します。StorageOS 内に事前に存在しない namespace が作成されます。

12.1.149. .spec.config.volumes[].storageos.secretRef

説明
secretRef は、StorageOS API クレデンシャルを取得するために使用するシークレットを指定します。指定しない場合、デフォルト値が試行されます。
object
Expand
プロパティー説明

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

12.1.150. .spec.config.volumes[].vsphereVolume

説明
vsphereVolume は、kubelet ホストマシンに接続およびマウントされた vSphere ボリュームを表します。非推奨: VsphereVolume は非推奨です。ツリー内 vsphereVolume タイプのすべての操作は、csi.vsphere.vmware.com CSI ドライバーにリダイレクトされます。
object
必須
  • volumePath
Expand
プロパティー説明

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

storagePolicyID

string

storagePolicyID は、StoragePolicyName に関連付けられたストレージポリシーベースの管理 (SPBM) プロファイル ID です。

storagePolicyName

string

storagePolicyName は、ストレージポリシーベースの管理 (SPBM) プロファイル名です。

volumePath

string

volumePath は、vSphere ボリューム vmdk を識別するパスです。

12.1.151. .status

説明
object
必須
  • lastUpdated
Expand
プロパティー説明

catalogHealth

array

catalogHealth には、関連する CatalogSources のステータスに関するサブスクリプションのビューが含まれています。これは、CatalogSources に関連する SubscriptionStatusConditions を決定するために使用されます。

catalogHealth[]

object

SubscriptionCatalogHealth は、サブスクリプションが認識している CatalogSource の状態を記述します。

conditions

array

条件は、サブスクリプションの現在の状態に関する最新の利用可能な観測のリストです。

conditions[]

object

SubscriptionCondition は、サブスクリプションの状態に利用可能な最新の観測値を表します。

currentCSV

string

CurrentCSV は、サブスクリプションが進行中の CSV です。

installPlanGeneration

integer

InstallPlanGeneration は、現在の世代のインストールプランです。

installPlanRef

object

InstallPlanRef は、サブスクリプションの現在の CSV を含む最新の InstallPlan への参照です。

installedCSV

string

InstalledCSV は、サブスクリプションによって現在インストールされている CSV です。

installplan

object

インストールは、サブスクリプション用に生成された最新の InstallPlan への参照です。非推奨:InstallPlanRef

lastUpdated

string

LastUpdated は、サブスクリプションステータスが最後に更新された時刻を表します。

reason

string

理由は、サブスクリプションが現在の状態に移行した理由です。

state

string

状態は、サブスクリプションの現在の状態を表します

12.1.152. .status.catalogHealth

説明
catalogHealth には、関連する CatalogSources のステータスに関するサブスクリプションのビューが含まれています。これは、CatalogSources に関連する SubscriptionStatusConditions を決定するために使用されます。
array

12.1.153. .status.catalogHealth[]

説明
SubscriptionCatalogHealth は、サブスクリプションが認識している CatalogSource の状態を記述します。
object
必須
  • catalogSourceRef
  • healthy
  • lastUpdated
Expand
プロパティー説明

catalogSourceRef

object

CatalogSourceRef は、CatalogSource への参照です。

healthy

boolean

CatalogSource が正常である場合、正常は真です。それ以外の場合は false。

lastUpdated

string

LastUpdated は、CatalogSourceHealth が最後に変更された時刻を表します

12.1.154. .status.catalogHealth[].catalogSourceRef

説明
CatalogSourceRef は、CatalogSource への参照です。
object
Expand
プロパティー説明

apiVersion

string

参照先の API バージョン。

fieldPath

string

オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。

kind

string

参照先の種類。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespace

string

参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

string

この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

string

参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

12.1.155. .status.conditions

説明
条件は、サブスクリプションの現在の状態に関する最新の利用可能な観測のリストです。
array

12.1.156. .status.conditions[]

説明
SubscriptionCondition は、サブスクリプションの状態に利用可能な最新の観測値を表します。
object
必須
  • status
  • type
Expand
プロパティー説明

lastHeartbeatTime

string

LastHeartbeatTime は、特定の条件で更新を取得した最後の時間です

lastTransitionTime

string

lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。

message

string

Message は、最後の遷移に関する詳細を示す人間が判読できるメッセージです。

reason

string

Reason は、条件の最後の遷移の 1 ワードの CamelCase 理由です。

status

string

ステータスは、条件のステータスであり、True、False、Unknown のいずれかです。

type

string

タイプは、サブスクリプション条件のタイプです。

12.1.157. .status.installPlanRef

説明
InstallPlanRef は、サブスクリプションの現在の CSV を含む最新の InstallPlan への参照です。
object
Expand
プロパティー説明

apiVersion

string

参照先の API バージョン。

fieldPath

string

オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。

kind

string

参照先の種類。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespace

string

参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

string

この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

string

参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

12.1.158. .status.installplan

説明
インストールは、サブスクリプション用に生成された最新の InstallPlan への参照です。非推奨:InstallPlanRef
object
必須
  • apiVersion
  • kind
  • name
  • uuid
Expand
プロパティー説明

apiVersion

string

 

kind

string

 

name

string

 

uuid

string

UID は、UUID を含む一意の ID 値を保持するタイプです。UUID のみを使用するわけではないため、これは文字列のエイリアスです。タイプであることは意図を捉え、UID と名前が混同されないようにするのに役立ちます。

12.2. API エンドポイント

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

  • /apis/operators.coreos.com/v1alpha1/subscriptions

    • GET: kind が Subscription のオブジェクトをリスト表示します。
  • /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/subscriptions

    • DELETE: サブスクリプションのコレクションを削除します。
    • GET: kind が Subscription のオブジェクトをリスト表示します。
    • POST: サブスクリプションを作成します
  • /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/subscriptions/{name}

    • DELETE: サブスクリプションを削除します。
    • GET: 指定されたサブスクリプションを読み取ります
    • PATCH: 指定されたサブスクリプションを部分的に更新します
    • PUT: 指定されたサブスクリプションを置き換えます
  • /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/subscriptions/{name}/status

    • GET: 指定されたサブスクリプションのステータスを読み取ります
    • PATCH: 指定されたサブスクリプションのステータスを部分的に更新します
    • PUT: 指定されたサブスクリプションのステータスを置き換えます

12.2.1. /apis/operators.coreos.com/v1alpha1/subscriptions

HTTP メソッド
GET
説明
kind が Subscription のオブジェクトをリスト表示します。
Expand
表12.1 HTTP 応答
HTTP コード応答のボディー

200 - OK

SubscriptionList スキーマ

401 - Unauthorized

空白

12.2.2. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/subscriptions

HTTP メソッド
DELETE
説明
サブスクリプションのコレクションを削除する
Expand
表12.2 HTTP 応答
HTTP コード応答のボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
kind が Subscription のオブジェクトをリスト表示します。
Expand
表12.3 HTTP 応答
HTTP コード応答のボディー

200 - OK

SubscriptionList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
サブスクリプションの作成
Expand
表12.4 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表12.5 本文パラメーター
パラメーター説明

body

Subscription スキーマ

 
Expand
表12.6 HTTP 応答
HTTP コード応答のボディー

200 - OK

Subscription スキーマ

201 - Created

Subscription スキーマ

202 - Accepted

Subscription スキーマ

401 - Unauthorized

空白

12.2.3. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/subscriptions/{name}

Expand
表12.7 グローバルパスパラメーター
パラメーター説明

name

string

サブスクリプションの名前。

HTTP メソッド
DELETE
説明
サブスクリプションの削除
Expand
表12.8 クエリーパラメーター
パラメーター説明

dryRun

string

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

Expand
表12.9 HTTP 応答
HTTP コード応答のボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定されたサブスクリプションを読む
Expand
表12.10 HTTP 応答
HTTP コード応答のボディー

200 - OK

Subscription スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定されたサブスクリプションを部分的に更新します
Expand
表12.11 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表12.12 HTTP 応答
HTTP コード応答のボディー

200 - OK

Subscription スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定されたサブスクリプションを置き換えます
Expand
表12.13 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表12.14 本文パラメーター
パラメーター説明

body

Subscription スキーマ

 
Expand
表12.15 HTTP 応答
HTTP コード応答のボディー

200 - OK

Subscription スキーマ

201 - Created

Subscription スキーマ

401 - Unauthorized

空白

12.2.4. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/subscriptions/{name}/status

Expand
表12.16 グローバルパスパラメーター
パラメーター説明

name

string

サブスクリプションの名前。

HTTP メソッド
GET
説明
指定されたサブスクリプションのステータスを読み取ります
Expand
表12.17 HTTP 応答
HTTP コード応答のボディー

200 - OK

Subscription スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定されたサブスクリプションのステータスを部分的に更新します
Expand
表12.18 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表12.19 HTTP 応答
HTTP コード応答のボディー

200 - OK

Subscription スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定されたサブスクリプションのステータスを置き換えます
Expand
表12.20 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

Expand
表12.21 本文パラメーター
パラメーター説明

body

Subscription スキーマ

 
Expand
表12.22 HTTP 応答
HTTP コード応答のボディー

200 - OK

Subscription スキーマ

201 - Created

Subscription スキーマ

401 - Unauthorized

空白

Legal Notice

Copyright © 2025 Red Hat

OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).

Modified versions must remove all Red Hat trademarks.

Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.

Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

Theme

© 2025 Red Hat