モニタリング API


OpenShift Container Platform 4.12

モニタリング API のリファレンスガイド

Red Hat OpenShift Documentation Team

概要

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

第1章 モニタリング API

1.1. Alertmanager [monitoring.coreos.com/v1]

説明
Alertmanager は、Alertmanager クラスターについて説明します。
object

1.2. AlertmanagerConfig [monitoring.coreos.com/v1beta1]

説明
AlertmanagerConfig は、1 つの Alertmanager クラスターを設定する複数の名前空間に集約される名前空間 AlertmanagerConfig を定義します。
タイプ
object

1.3. PodMonitor [monitoring.coreos.com/v1]

説明
PodMonitor は、一連の Pod の監視を定義します。
object

1.4. Probe [monitoring.coreos.com/v1]

説明
プローブは、一連の静的ターゲットまたは入力の監視を定義します。
object

1.5. Prometheus [monitoring.coreos.com/v1]

説明
Prometheus は、Prometheus デプロイメントを定義します。
object

1.6. PrometheusRule [monitoring.coreos.com/v1]

説明
PrometheusRule は、Prometheus インスタンスの記録とアラートのルールを定義します
object

1.7. ServiceMonitor [monitoring.coreos.com/v1]

説明
ServiceMonitor は、一連のサービスの監視を定義します。
object

1.8. ThanosRuler [monitoring.coreos.com/v1]

説明
ThanosRuler は、ThanosRuler デプロイメントを定義します。
object

第2章 Alertmanager [monitoring.coreos.com/v1]

説明
Alertmanager は、Alertmanager クラスターについて説明します。
object
必須
  • 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

Alertmanager クラスターの望ましい動作の仕様。詳細: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

status

object

Alertmanager クラスターの最新の観測ステータス。read-onlyapiserver からのリクエストには含まれず、PrometheusOperatorAPI 自体からのみ含まれます。詳細: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

2.1.1. .spec

説明
Alertmanager クラスターの望ましい動作の仕様。詳細: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
object
Expand
プロパティー説明

additionalPeers

array (string)

AdditionalPeers を使用すると、ピアリングする追加の Alertmanager のセットを挿入して、可用性の高いクラスターを形成できます。

affinity

object

指定した場合、Pod のスケジューリング制約。

alertmanagerConfigNamespaceSelector

object

AlertmanagerConfig 検出用に選択される namespace。nil の場合は、自身の namespace だけが確認されます。

alertmanagerConfigSelector

object

Alertmanager をマージおよび設定するために選択される AlertmanagerConfigs。

alertmanagerConfiguration

object

EXPERIMENTAL: alertmanagerConfiguration は、Alertmanager の設定を指定します。定義されている場合は、configSecret フィールドよりも優先されます。このフィールドは今後のリリースで変更される可能性があります。

baseImage

string

タグなしで Pod をデプロイするために使用されるベースイメージ。非推奨: 代わりに image を使用してください

clusterAdvertiseAddress

string

ClusterAdvertiseAddress は、クラスターでアドバタイズする明示的なアドレスです。RFC1918 [1] (パブリック) 以外のアドレスに提供する必要があります。[1] RFC1918: https://tools.ietf.org/html/rfc1918

clusterGossipInterval

string

ゴシップ試行の間隔。

clusterPeerTimeout

string

クラスターピアリングのタイムアウト。

clusterPushpullInterval

string

プッシュプル試行の間隔。

configMaps

array (string)

ConfigMaps は、Alertmanager オブジェクトと同じ namespace にある ConfigMap のリストであり、Alertmanager Pod にマウントする必要があります。各 ConfigMap は、configmap-<configmap-name> という名前のボリュームとして StatefulSet 定義に追加されます。ConfigMaps は、'alertmanager' コンテナーの /etc/alertmanager/configmaps/<configmap-name> にマウントされます。

configSecret

string

ConfigSecret は、Alertmanager オブジェクトと同じ namespace にある Kubernetes シークレットの名前であり、この Alertmanager インスタンスの設定が含まれています。空の場合、デフォルトで alertmanager-<alertmanager-name> になります。Alertmanager 設定は、alertmanager.yaml キーの下で使用できる必要があります。元のシークレットの追加鍵は生成されたシークレットにコピーされます。シークレットまたは alertmanager.yaml キーのいずれかが欠落している場合、Operator は空のレシーバー 1 つを含む最小限の Alertmanager 設定をプロビジョニングします (実質的にアラート通知がドロップされます)。

containers

array

コンテナーを使用すると、追加のコンテナーを挿入できます。これは、Alertmanager Pod に認証プロキシーを追加できるようにすることを目的としています。ここで説明するコンテナーは、同じ名前を共有し、戦略的マージパッチを介して変更が行われる場合、Operator が生成したコンテナーを変更します。現在のコンテナー名は、alertmanagerconfig-reloader です。コンテナーのオーバーライドは、メンテナーがサポートする範囲外であり、そうすることで、この動作が予告なしにいつでも中断する可能性があることを認めます。

containers[]

object

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

externalUrl

string

Alertmanager インスタンスの外部 URL は、で利用できます。これは、正しい URL を生成するために必要です。これは、Alertmanager が DNS 名のルートから提供されていない場合に必要です。

forceEnableClusterMode

boolean

ForceEnableClusterMode は、単一のレプリカで実行しているときに Alertmanager がクラスターモードを非アクティブ化しないようにします。ユースケースは、たとえば、それぞれに単一のレプリカを持つ Kubernetes クラスター全体に Alertmanager クラスターをスパンすることです。

hostAliases

array

Pod の hostAliases 設定

hostAliases[]

object

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

image

string

指定した場合のイメージは、baseImage、tag、sha の組み合わせよりも優先されます。PrometheusOperator が、設定されている Alertmanager のバージョンを確実に認識できるようにするには、バージョンを指定する必要があります。

imagePullSecrets

array

レジストリーから prometheus および alertmanager イメージをプルするために使用する、同じ namespace 内のシークレットへの参照のオプションのリストは、http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod を参照してください。

imagePullSecrets[]

object

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

initContainers

array

InitContainers を使用すると、Pod 定義に initContainers を追加できます。これらは、たとえば、外部ソースから Alertmanager 設定に挿入するためのシークレットをフェッチするために使用できます。initContainer の実行中にエラーが発生すると、Pod が再起動します。詳細: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ initContainers を secret フェッチ以外の用途に使用することは、メンテナーがサポートする範囲から完全に外れており、そうすることによって、この動作が予告なしにいつでも壊れる可能性があることに同意したことになります。

initContainers[]

object

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

listenLocal

boolean

ListenLocal は、Alertmanager サーバーがループバックでリッスンするようにし、Pod IP に対してバインドしないようにします。これは Alertmanager UI 専用であり、ゴシップ通信ではないことに注意してください。

logFormat

string

設定する Alertmanager のログ形式。

logLevel

string

設定する Alertmanager のログレベル。

minReadySeconds

integer

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

nodeSelector

object (string)

Pod がスケジュールされているノードを定義します。

paused

boolean

true に設定すると、削除アクションを除いて、基になるマネージドオブジェクトに対するすべてのアクションが実行されません。

podMetadata

object

PodMetadata は、alertmanagerPod に伝達されるラベルとアノテーションを設定します。

portName

string

Pod および管理サービスに使用されるポート名。これはデフォルトで Web になります

priorityClassName

string

Pod に割り当てられた優先度クラス

replicas

integer

サイズは、alertmanager クラスターの予想サイズです。コントローラーは最終的に、実行中のクラスターのサイズを予想されるサイズと等しくします。

resources

object

単一 Pod のリソース要求と制限を定義します。

retention

string

期間 Alertmanager はのデータを保持します。デフォルトは '120h' で、正規表現 [0-9]+(ms|s|m|h) (ミリ秒、秒、分、時間) と一致する必要があります。

routePrefix

string

ルート接頭辞 Alertmanager は、の HTTP ハンドラーを登録します。これは、ExternalURL を使用していて、プロキシーがリクエストの HTTP ルートを書き換えていて、実際の ExternalURL がまだ真であるが、サーバーが別のルート接頭辞でリクエストを処理する場合に便利です。たとえば、kubectl プロキシー で使用します。

secrets

array (string)

シークレットは、Alertmanager オブジェクトと同じ namespace にあるシークレットのリストであり、Alertmanager Pod にマウントされます。各シークレットは、secret-<secret-name> という名前のボリュームとして StatefulSet 定義に追加されます。シークレットは、'alertmanager' コンテナーの /etc/alertmanager/secrets/<secret-name> にマウントされます。

securityContext

object

SecurityContext は、Pod レベルのセキュリティー属性と一般的なコンテナー設定を保持します。これはデフォルトでデフォルトの PodSecurityContext になります。

serviceAccountName

string

ServiceAccountName は、Prometheus Pod の実行に使用する ServiceAccount の名前です。

sha

string

デプロイする Alertmanager コンテナーイメージの SHA。デフォルトは バージョン の値です。タグに似ていますが、SHA は不変のコンテナーイメージを明示的にデプロイします。SHA が設定されている場合、バージョンとタグは無視されます。非推奨: 代わりに 'image' を使用します。イメージダイジェストは、イメージ URL の一部として指定できます。

storage

object

ストレージは、Alertmanager インスタンスによるストレージの使用方法の定義です。

tag

string

デプロイする Alertmanager コンテナーイメージのタグ。デフォルトは バージョン の値です。タグが設定されている場合、バージョンは無視されます。非推奨: 代わりに 'image' を使用します。イメージタグは、イメージ URL の一部として指定できます。

tolerations

array

指定されている場合、Pod の許容範囲。

tolerations[]

object

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

topologySpreadConstraints

array

指定した場合、Pod のトポロジー拡散制約。

topologySpreadConstraints[]

object

TopologySpreadConstraint は、指定されたトポロジー間で一致する Pod を拡散する方法を指定します。

version

string

クラスターのバージョンをオンにする必要があります。

volumeMounts

array

VolumeMounts を使用すると、出力 StatefulSet 定義に追加の VolumeMounts を設定できます。指定された VolumeMounts は、StorageSpec オブジェクトの結果として生成される alertmanager コンテナー内の他の VolumeMounts に追加されます。

volumeMounts[]

object

VolumeMount は、コンテナー内でのボリュームのマウントを説明します。

volumes

array

ボリュームを使用すると、出力の StatefulSet 定義に追加のボリュームを設定できます。指定されたボリュームは、StorageSpec オブジェクトの結果として生成される他のボリュームに追加されます。

volumes[]

object

ボリュームは、Pod 内の任意のコンテナーからアクセスできる Pod 内の名前付きボリュームを表します。

web

object

Alertmanager を起動するときの Web コマンドラインフラグを定義します。

2.1.2. .spec.affinity

説明
指定した場合、Pod のスケジューリング制約。
object
Expand
プロパティー説明

nodeAffinity

object

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

podAffinity

object

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

podAntiAffinity

object

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

2.1.3. .spec.affinity.nodeAffinity

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

preferredDuringSchedulingIgnoredDuringExecution

array

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

preferredDuringSchedulingIgnoredDuringExecution[]

object

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

requiredDuringSchedulingIgnoredDuringExecution

object

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

2.1.4. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution

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

2.1.5. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

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

preference

object

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

weight

integer

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

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

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

matchExpressions

array

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

matchExpressions[]

object

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

matchFields

array

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

matchFields[]

object

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

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

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

2.1.8. .spec.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 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

2.1.9. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields

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

2.1.10. .spec.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 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

2.1.11. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

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

nodeSelectorTerms

array

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

nodeSelectorTerms[]

object

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

2.1.12. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

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

2.1.13. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[]

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

matchExpressions

array

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

matchExpressions[]

object

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

matchFields

array

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

matchFields[]

object

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

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

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

2.1.15. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].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 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

2.1.16. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields

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

2.1.17. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].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 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

2.1.18. .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 が実行されているノードの値と一致するノードで実行されていることを意味します。

2.1.19. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution

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

2.1.20. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

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

podAffinityTerm

object

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

weight

integer

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

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

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

labelSelector

object

リソースのセット (この場合は Pod) に対するラベルクエリー。

namespaceSelector

object

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

namespaces

array (string)

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

topologyKey

string

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

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

説明
リソースのセット (この場合は 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.25. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.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.28. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution

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

2.1.29. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[]

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

labelSelector

object

リソースのセット (この場合は Pod) に対するラベルクエリー。

namespaceSelector

object

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

namespaces

array (string)

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

topologyKey

string

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

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

説明
リソースのセット (この場合は 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 で結合されます。

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

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

2.1.32. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

2.1.33. .spec.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 で結合されます。

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

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

2.1.35. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

2.1.36. .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 が実行されているノードの値と一致するノードで実行されていることを意味します。

2.1.37. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution

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

2.1.38. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

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

podAffinityTerm

object

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

weight

integer

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

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

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

labelSelector

object

リソースのセット (この場合は Pod) に対するラベルクエリー。

namespaceSelector

object

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

namespaces

array (string)

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

topologyKey

string

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

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

説明
リソースのセット (この場合は 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.43. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.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.46. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution

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

2.1.47. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[]

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

labelSelector

object

リソースのセット (この場合は Pod) に対するラベルクエリー。

namespaceSelector

object

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

namespaces

array (string)

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

topologyKey

string

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

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

説明
リソースのセット (この場合は 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 で結合されます。

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

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

2.1.50. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

2.1.51. .spec.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 で結合されます。

2.1.52. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

2.1.54. .spec.alertmanagerConfigNamespaceSelector

説明
AlertmanagerConfig 検出用に選択される namespace。nil の場合は、自身の 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 で結合されます。

2.1.55. .spec.alertmanagerConfigNamespaceSelector.matchExpressions

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

2.1.56. .spec.alertmanagerConfigNamespaceSelector.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

2.1.57. .spec.alertmanagerConfigSelector

説明
Alertmanager をマージおよび設定するために選択される AlertmanagerConfigs。
object
Expand
プロパティー説明

matchExpressions

array

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

matchExpressions[]

object

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

matchLabels

object (string)

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

2.1.58. .spec.alertmanagerConfigSelector.matchExpressions

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

2.1.59. .spec.alertmanagerConfigSelector.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

2.1.60. .spec.alertmanagerConfiguration

説明
EXPERIMENTAL: alertmanagerConfiguration は、Alertmanager の設定を指定します。定義されている場合は、configSecret フィールドよりも優先されます。このフィールドは今後のリリースで変更される可能性があります。
object
Expand
プロパティー説明

global

object

Alertmanager 設定のグローバルパラメーターを定義します。

name

string

Alertmanager 設定を生成するために使用される AlertmanagerConfig リソースの名前。Alertmanager オブジェクトと同じ namespace で定義する必要があります。Operator は、ルートおよび抑制ルールに対して namespace ラベルを強制しません。

templates

array

カスタム通知テンプレート。

templates[]

object

SecretOrConfigMap を使用すると、データを Secret または ConfigMap として指定できます。フィールドは相互に排他的です。

2.1.61. .spec.alertmanagerConfiguration.global

説明
Alertmanager 設定のグローバルパラメーターを定義します。
object
Expand
プロパティー説明

httpConfig

object

HTTP クライアント設定

resolveTimeout

string

ResolveTimeout は、アラートに EndsAt が含まれていない場合に alertmanager が使用するデフォルト値です。この時間が経過した後、アラートが更新されていない場合はアラートを解決済みとして宣言できます。Prometheus からのアラートには常に EndsAt が含まれるため、これはアラートには影響しません。

2.1.62. .spec.alertmanagerConfiguration.global.httpConfig

説明
HTTP クライアント設定
object
Expand
プロパティー説明

authorization

object

クライアントの認証ヘッダー設定。これは BasicAuth と相互に排他的であり、Alertmanagerv0.22+ 以降でのみ使用できます。

basicAuth

object

クライアントの BasicAuth。これは、承認と相互に排他的です。両方が定義されている場合、BasicAuth が優先されます。

bearerTokenSecret

object

クライアントが認証に使用するベアラートークンを含むシークレットのキー。シークレットは、Alertmanager オブジェクトと同じ namespace にあり、Prometheus Operator からアクセスできる必要があります。

followRedirects

boolean

FollowRedirects は、クライアントが HTTP 3xx リダイレクトに従うかどうかを指定します。

oauth2

object

ターゲットのトークンを取得するために使用される OAuth2 クライアント認証情報。

proxyURL

string

オプションのプロキシー URL。

tlsConfig

object

クライアントの TLS 設定。

2.1.63. .spec.alertmanagerConfiguration.global.httpConfig.authorization

説明
クライアントの認証ヘッダー設定。これは BasicAuth と相互に排他的であり、Alertmanagerv0.22+ 以降でのみ使用できます。
object
Expand
プロパティー説明

credentials

object

リクエストのクレデンシャルを含むシークレットのキー

type

string

認証タイプを設定します。デフォルトは Bearer で、Basic はエラーを引き起こします

2.1.64. .spec.alertmanagerConfiguration.global.httpConfig.authorization.credentials

説明
リクエストのクレデンシャルを含むシークレットのキー
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

2.1.65. .spec.alertmanagerConfiguration.global.httpConfig.basicAuth

説明
クライアントの BasicAuth。これは、承認と相互に排他的です。両方が定義されている場合、BasicAuth が優先されます。
object
Expand
プロパティー説明

password

object

認証用のパスワードを含むサービスモニター名前空間のシークレット。

username

object

認証用のユーザー名を含むサービスモニター名前空間のシークレット。

2.1.66. .spec.alertmanagerConfiguration.global.httpConfig.basicAuth.password

説明
認証用のパスワードを含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

2.1.67. .spec.alertmanagerConfiguration.global.httpConfig.basicAuth.username

説明
認証用のユーザー名を含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

2.1.68. .spec.alertmanagerConfiguration.global.httpConfig.bearerTokenSecret

説明
クライアントが認証に使用するベアラートークンを含むシークレットのキー。シークレットは、Alertmanager オブジェクトと同じ namespace にあり、Prometheus Operator からアクセスできる必要があります。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

2.1.69. .spec.alertmanagerConfiguration.global.httpConfig.oauth2

説明
ターゲットのトークンを取得するために使用される OAuth2 クライアント認証情報。
object
必須
  • clientId
  • clientSecret
  • tokenUrl
Expand
プロパティー説明

clientId

object

OAuth2 クライアント ID を含むシークレットまたは設定マップ

clientSecret

object

OAuth2 クライアントシークレットを含むシークレット

endpointParams

object (string)

トークン URL に追加するパラメーター

scopes

array (string)

トークンリクエストに使用される OAuth2 スコープ

tokenUrl

string

トークンをフェッチする URL

2.1.70. .spec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId

説明
OAuth2 クライアント ID を含むシークレットまたは設定マップ
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

2.1.71. .spec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

2.1.72. .spec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

2.1.73. .spec.alertmanagerConfiguration.global.httpConfig.oauth2.clientSecret

説明
OAuth2 クライアントシークレットを含むシークレット
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

2.1.74. .spec.alertmanagerConfiguration.global.httpConfig.tlsConfig

説明
クライアントの TLS 設定。
object
Expand
プロパティー説明

ca

object

ターゲットに使用する CA 証明書を含む構造体。

cert

object

ターゲットのクライアント証明書ファイルを含む構造体。

insecureSkipVerify

boolean

ターゲット証明書の検証を無効にします。

keySecret

object

ターゲットのクライアントキーファイルを含むシークレット。

serverName

string

ターゲットのホスト名を確認するために使用されます。

2.1.75. .spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca

説明
ターゲットに使用する CA 証明書を含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

2.1.76. .spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

2.1.77. .spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

2.1.78. .spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert

説明
ターゲットのクライアント証明書ファイルを含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

2.1.79. .spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

2.1.80. .spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

2.1.81. .spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.keySecret

説明
ターゲットのクライアントキーファイルを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

2.1.82. .spec.alertmanagerConfiguration.templates

説明
カスタム通知テンプレート。
array

2.1.83. .spec.alertmanagerConfiguration.templates[]

説明
SecretOrConfigMap を使用すると、データを Secret または ConfigMap として指定できます。フィールドは相互に排他的です。
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

2.1.84. .spec.alertmanagerConfiguration.templates[].configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

2.1.85. .spec.alertmanagerConfiguration.templates[].secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

2.1.86. .spec.containers

説明
コンテナーを使用すると、追加のコンテナーを挿入できます。これは、Alertmanager Pod に認証プロキシーを追加できるようにすることを目的としています。ここで説明するコンテナーは、同じ名前を共有し、戦略的マージパッチを介して変更が行われる場合、Operator が生成したコンテナーを変更します。現在のコンテナー名は、alertmanagerconfig-reloader です。コンテナーのオーバーライドは、メンテナーがサポートする範囲外であり、そうすることで、この動作が予告なしにいつでも中断する可能性があることを認めます。
array

2.1.87. .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 のソースを表します

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

resources

object

このコンテナーに必要なコンピューティングリソース。これは更新できません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

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

コンテナーの作業ディレクトリー。指定しない場合、コンテナーランタイムのデフォルトが使用されます。これは、コンテナーイメージで設定されている可能性があります。これを更新することはできません。

2.1.88. .spec.containers[].env

説明
コンテナーに設定する環境変数のリスト。これは更新できません。
array

2.1.89. .spec.containers[].env[]

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

name

string

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

value

string

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

valueFrom

object

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

2.1.90. .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 でシークレットのキーを選択します

2.1.91. .spec.containers[].env[].valueFrom.configMapKeyRef

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

key

string

選択するキー。

name

string

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

任意

boolean

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

2.1.92. .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 バージョンで選択するフィールドのパス。

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

必須: 選択するリソース

2.1.94. .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 TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

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

2.1.95. .spec.containers[].envFrom

説明
コンテナー内の環境変数に入力するソースのリスト。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。これは更新できません。
array

2.1.96. .spec.containers[].envFrom[]

説明
EnvFromSource は、一連の ConfigMap のソースを表します
object
Expand
プロパティー説明

configMapRef

object

選択する ConfigMap

prefix

string

ConfigMap の各キーの前に追加するオプションの識別子。C_IDENTIFIER でなければなりません。

secretRef

object

から選択する秘密

2.1.97. .spec.containers[].envFrom[].configMapRef

説明
選択する ConfigMap
object
Expand
プロパティー説明

name

string

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

任意

boolean

ConfigMap を定義する必要があるかどうかを指定します

2.1.98. .spec.containers[].envFrom[].secretRef

説明
から選択する秘密
object
Expand
プロパティー説明

name

string

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

任意

boolean

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

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

2.1.100. .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 リクエストを指定します。

tcpSocket

object

非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。

2.1.101. .spec.containers[].lifecycle.postStart.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

2.1.102. .spec.containers[].lifecycle.postStart.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

2.1.103. .spec.containers[].lifecycle.postStart.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

2.1.104. .spec.containers[].lifecycle.postStart.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

2.1.105. .spec.containers[].lifecycle.postStart.tcpSocket

説明
非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

2.1.106. .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 リクエストを指定します。

tcpSocket

object

非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。

2.1.107. .spec.containers[].lifecycle.preStop.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

2.1.108. .spec.containers[].lifecycle.preStop.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

2.1.109. .spec.containers[].lifecycle.preStop.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

2.1.110. .spec.containers[].lifecycle.preStop.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

2.1.111. .spec.containers[].lifecycle.preStop.tcpSocket

説明
非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

2.1.112. .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 ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。

httpGet

object

HTTPGet は、実行する http リクエストを指定します。

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

2.1.113. .spec.containers[].livenessProbe.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

2.1.114. .spec.containers[].livenessProbe.grpc

説明
GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
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 によって定義されます。

2.1.115. .spec.containers[].livenessProbe.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

2.1.116. .spec.containers[].livenessProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

2.1.117. .spec.containers[].livenessProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

2.1.118. .spec.containers[].livenessProbe.tcpSocket

説明
TCPSocket は、TCP ポートを含むアクションを指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

2.1.119. .spec.containers[].ports

説明
コンテナーから公開するポートのリスト。ここでポートを指定しなくても、そのポートが公開されるのを防ぐことはできません。コンテナー内のデフォルトの "0.0.0.0" アドレスをリッスンしているポートは、ネットワークからアクセスできます。戦略的マージパッチを使用してこの配列を変更すると、データが破損する可能性があります。詳細は、https://github.com/kubernetes/kubernetes/issues/108255 を参照してください。これは更新できません。
array

2.1.120. .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" です。

2.1.121. .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 ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。

httpGet

object

HTTPGet は、実行する http リクエストを指定します。

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

2.1.122. .spec.containers[].readinessProbe.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

2.1.123. .spec.containers[].readinessProbe.grpc

説明
GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
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 によって定義されます。

2.1.124. .spec.containers[].readinessProbe.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

2.1.125. .spec.containers[].readinessProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

2.1.126. .spec.containers[].readinessProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

2.1.127. .spec.containers[].readinessProbe.tcpSocket

説明
TCPSocket は、TCP ポートを含むアクションを指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

2.1.128. .spec.containers[].resources

説明
このコンテナーに必要なコンピューティングリソース。これは更新できません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。
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/ を参照してください。

2.1.129. .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 の場合は、このフィールドは設定できないことに注意してください。

capabilities

object

コンテナーの実行時に追加/削除する機能。デフォルトは、コンテナーランタイムによって付与されるデフォルトの機能セットです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

privileged

boolean

コンテナーを特権モードで実行します。特権コンテナー内のプロセスは、基本的にホスト上の root と同等です。デフォルトは false です。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

procMount

string

procMount は、コンテナーに使用する proc マウントのタイプを示します。デフォルトは DefaultProcMount で、読み取り専用パスとマスクされたパスにコンテナーランタイムのデフォルトを使用します。これには、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 の場合は、このフィールドを設定できないことに注意してください。

2.1.130. .spec.containers[].securityContext.capabilities

説明
コンテナーの実行時に追加/削除する機能。デフォルトは、コンテナーランタイムによって付与されるデフォルトの機能セットです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
object
Expand
プロパティー説明

add

array (string)

追加された機能

drop

array (string)

削除された機能

2.1.131. .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 ユーザーラベルです。

2.1.132. .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- コンテナーのランタイムデフォルトプロファイルを使用する必要があります。制限なし - プロファイルを適用しないでください。

2.1.133. .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' コンテナーとして実行する必要があるかどうかを決定します。このフィールドはアルファレベルであり、WindowsHostProcessContainers 機能フラグを有効にするコンポーネントによってのみ尊重されます。機能フラグなしでこのフィールドを設定すると、Pod の検証時にエラーが発生します。Pod のすべてのコンテナーは、同じ有効な HostProcess 値を持っている必要があります (HostProcess コンテナーと非 HostProcess コンテナーを混在させることはできません)。さらに、HostProcess が true の場合、HostNetwork も true に設定する必要があります。

runAsUserName

string

コンテナープロセスのエントリーポイントを実行するための Windows の UserName。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。

2.1.134. .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 ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。

httpGet

object

HTTPGet は、実行する http リクエストを指定します。

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

2.1.135. .spec.containers[].startupProbe.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

2.1.136. .spec.containers[].startupProbe.grpc

説明
GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
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 によって定義されます。

2.1.137. .spec.containers[].startupProbe.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

2.1.138. .spec.containers[].startupProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

2.1.139. .spec.containers[].startupProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

2.1.140. .spec.containers[].startupProbe.tcpSocket

説明
TCPSocket は、TCP ポートを含むアクションを指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

2.1.141. .spec.containers[].volumeDevices

説明
volumeDevices は、コンテナーによって使用されるブロックデバイスのリストです。
array

2.1.142. .spec.containers[].volumeDevices[]

説明
volumeDevice は、コンテナー内の raw ブロックデバイスのマッピングを記述します。
object
必須
  • devicePath
  • name
Expand
プロパティー説明

devicePath

string

devicePath は、デバイスがマップされるコンテナー内のパスです。

name

string

name は、Pod 内の persistentVolumeClaim の名前と一致する必要があります

2.1.143. .spec.containers[].volumeMounts

説明
コンテナーのファイルシステムにマウントする Pod ボリューム。これは更新できません。
array

2.1.144. .spec.containers[].volumeMounts[]

説明
VolumeMount は、コンテナー内でのボリュームのマウントを説明します。
object
必須
  • mountPath
  • name
Expand
プロパティー説明

mountPath

string

ボリュームをマウントする必要があるコンテナー内のパス。':' を含めることはできません。

mountPropagation

string

mountPropagation は、マウントがホストからコンテナーに、またはその逆にどのように伝播されるかを決定します。設定されていない場合、MountPropagationNone が使用されます。このフィールドは 1.10 のベータ版です。

name

string

ボリュームの名前に一致する必要があります。

readOnly

boolean

true の場合は読み取り専用、それ以外の場合は読み取り/書き込み (false または指定なし) でマウントされます。デフォルトは false です。

subPath

string

コンテナーのボリュームをマウントする必要があるボリューム内のパス。デフォルトは "" (ボリュームのルート) です。

subPathExpr

string

コンテナーのボリュームをマウントする必要があるボリューム内の拡張パス。SubPath と同様に動作しますが、環境変数参照 $(VAR_NAME) は、コンテナーの環境を使用してデプロイメントされます。デフォルトは "" (ボリュームのルート) です。SubPathExpr と SubPath は相互に排他的です。

2.1.145. .spec.hostAliases

説明
Pod の hostAliases 設定
array

2.1.146. .spec.hostAliases[]

説明
HostAlias は、Pod の hosts ファイルのエントリーとして挿入される IP とホスト名の間のマッピングを保持します。
object
必須
  • hostnames
  • ip
Expand
プロパティー説明

hostnames

array (string)

上記の IP アドレスのホスト名。

ip

string

ホストファイルエントリーの IP アドレス。

2.1.147. .spec.imagePullSecrets

説明
レジストリーから prometheus および alertmanager イメージをプルするために使用する、同じ namespace 内のシークレットへの参照のオプションのリストは、http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod を参照してください。
array

2.1.148. .spec.imagePullSecrets[]

説明
LocalObjectReference には、同じ namespace 内で参照オブジェクトを見つけるのに十分な情報が含まれます。
object
Expand
プロパティー説明

name

string

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

2.1.149. .spec.initContainers

説明
InitContainers を使用すると、Pod 定義に initContainers を追加できます。これらは、たとえば、外部ソースから Alertmanager 設定に挿入するためのシークレットをフェッチするために使用できます。initContainer の実行中にエラーが発生すると、Pod が再起動します。詳細: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ initContainers を secret フェッチ以外の用途に使用することは、メンテナーがサポートする範囲から完全に外れており、そうすることによって、この動作が予告なしにいつでも壊れる可能性があることに同意したことになります。
array

2.1.150. .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 のソースを表します

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

resources

object

このコンテナーに必要なコンピューティングリソース。これは更新できません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

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

コンテナーの作業ディレクトリー。指定しない場合、コンテナーランタイムのデフォルトが使用されます。これは、コンテナーイメージで設定されている可能性があります。これを更新することはできません。

2.1.151. .spec.initContainers[].env

説明
コンテナーに設定する環境変数のリスト。これは更新できません。
array

2.1.152. .spec.initContainers[].env[]

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

name

string

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

value

string

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

valueFrom

object

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

2.1.153. .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 でシークレットのキーを選択します

2.1.154. .spec.initContainers[].env[].valueFrom.configMapKeyRef

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

key

string

選択するキー。

name

string

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

任意

boolean

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

2.1.155. .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 バージョンで選択するフィールドのパス。

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

必須: 選択するリソース

2.1.157. .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 TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

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

2.1.158. .spec.initContainers[].envFrom

説明
コンテナー内の環境変数に入力するソースのリスト。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。これは更新できません。
array

2.1.159. .spec.initContainers[].envFrom[]

説明
EnvFromSource は、一連の ConfigMap のソースを表します
object
Expand
プロパティー説明

configMapRef

object

選択する ConfigMap

prefix

string

ConfigMap の各キーの前に追加するオプションの識別子。C_IDENTIFIER でなければなりません。

secretRef

object

から選択する秘密

2.1.160. .spec.initContainers[].envFrom[].configMapRef

説明
選択する ConfigMap
object
Expand
プロパティー説明

name

string

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

任意

boolean

ConfigMap を定義する必要があるかどうかを指定します

2.1.161. .spec.initContainers[].envFrom[].secretRef

説明
から選択する秘密
object
Expand
プロパティー説明

name

string

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

任意

boolean

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

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

2.1.163. .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 リクエストを指定します。

tcpSocket

object

非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。

2.1.164. .spec.initContainers[].lifecycle.postStart.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

2.1.165. .spec.initContainers[].lifecycle.postStart.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

2.1.166. .spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

2.1.167. .spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

2.1.168. .spec.initContainers[].lifecycle.postStart.tcpSocket

説明
非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

2.1.169. .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 リクエストを指定します。

tcpSocket

object

非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。

2.1.170. .spec.initContainers[].lifecycle.preStop.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

2.1.171. .spec.initContainers[].lifecycle.preStop.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

2.1.172. .spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

2.1.173. .spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

2.1.174. .spec.initContainers[].lifecycle.preStop.tcpSocket

説明
非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

2.1.175. .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 ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。

httpGet

object

HTTPGet は、実行する http リクエストを指定します。

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

2.1.176. .spec.initContainers[].livenessProbe.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

2.1.177. .spec.initContainers[].livenessProbe.grpc

説明
GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
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 によって定義されます。

2.1.178. .spec.initContainers[].livenessProbe.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

2.1.179. .spec.initContainers[].livenessProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

2.1.180. .spec.initContainers[].livenessProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

2.1.181. .spec.initContainers[].livenessProbe.tcpSocket

説明
TCPSocket は、TCP ポートを含むアクションを指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

2.1.182. .spec.initContainers[].ports

説明
コンテナーから公開するポートのリスト。ここでポートを指定しなくても、そのポートが公開されるのを防ぐことはできません。コンテナー内のデフォルトの "0.0.0.0" アドレスをリッスンしているポートは、ネットワークからアクセスできます。戦略的マージパッチを使用してこの配列を変更すると、データが破損する可能性があります。詳細は、https://github.com/kubernetes/kubernetes/issues/108255 を参照してください。これは更新できません。
array

2.1.183. .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" です。

2.1.184. .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 ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。

httpGet

object

HTTPGet は、実行する http リクエストを指定します。

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

2.1.185. .spec.initContainers[].readinessProbe.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

2.1.186. .spec.initContainers[].readinessProbe.grpc

説明
GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
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 によって定義されます。

2.1.187. .spec.initContainers[].readinessProbe.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

2.1.188. .spec.initContainers[].readinessProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

2.1.189. .spec.initContainers[].readinessProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

2.1.190. .spec.initContainers[].readinessProbe.tcpSocket

説明
TCPSocket は、TCP ポートを含むアクションを指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

2.1.191. .spec.initContainers[].resources

説明
このコンテナーに必要なコンピューティングリソース。これは更新できません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。
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/ を参照してください。

2.1.192. .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 の場合は、このフィールドは設定できないことに注意してください。

capabilities

object

コンテナーの実行時に追加/削除する機能。デフォルトは、コンテナーランタイムによって付与されるデフォルトの機能セットです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

privileged

boolean

コンテナーを特権モードで実行します。特権コンテナー内のプロセスは、基本的にホスト上の root と同等です。デフォルトは false です。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

procMount

string

procMount は、コンテナーに使用する proc マウントのタイプを示します。デフォルトは DefaultProcMount で、読み取り専用パスとマスクされたパスにコンテナーランタイムのデフォルトを使用します。これには、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 の場合は、このフィールドを設定できないことに注意してください。

2.1.193. .spec.initContainers[].securityContext.capabilities

説明
コンテナーの実行時に追加/削除する機能。デフォルトは、コンテナーランタイムによって付与されるデフォルトの機能セットです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
object
Expand
プロパティー説明

add

array (string)

追加された機能

drop

array (string)

削除された機能

2.1.194. .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 ユーザーラベルです。

2.1.195. .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- コンテナーのランタイムデフォルトプロファイルを使用する必要があります。制限なし - プロファイルを適用しないでください。

2.1.196. .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' コンテナーとして実行する必要があるかどうかを決定します。このフィールドはアルファレベルであり、WindowsHostProcessContainers 機能フラグを有効にするコンポーネントによってのみ尊重されます。機能フラグなしでこのフィールドを設定すると、Pod の検証時にエラーが発生します。Pod のすべてのコンテナーは、同じ有効な HostProcess 値を持っている必要があります (HostProcess コンテナーと非 HostProcess コンテナーを混在させることはできません)。さらに、HostProcess が true の場合、HostNetwork も true に設定する必要があります。

runAsUserName

string

コンテナープロセスのエントリーポイントを実行するための Windows の UserName。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。

2.1.197. .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 ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。

httpGet

object

HTTPGet は、実行する http リクエストを指定します。

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

2.1.198. .spec.initContainers[].startupProbe.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

2.1.199. .spec.initContainers[].startupProbe.grpc

説明
GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
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 によって定義されます。

2.1.200. .spec.initContainers[].startupProbe.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

2.1.201. .spec.initContainers[].startupProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

2.1.202. .spec.initContainers[].startupProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

2.1.203. .spec.initContainers[].startupProbe.tcpSocket

説明
TCPSocket は、TCP ポートを含むアクションを指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

2.1.204. .spec.initContainers[].volumeDevices

説明
volumeDevices は、コンテナーによって使用されるブロックデバイスのリストです。
array

2.1.205. .spec.initContainers[].volumeDevices[]

説明
volumeDevice は、コンテナー内の raw ブロックデバイスのマッピングを記述します。
object
必須
  • devicePath
  • name
Expand
プロパティー説明

devicePath

string

devicePath は、デバイスがマップされるコンテナー内のパスです。

name

string

name は、Pod 内の persistentVolumeClaim の名前と一致する必要があります

2.1.206. .spec.initContainers[].volumeMounts

説明
コンテナーのファイルシステムにマウントする Pod ボリューム。これは更新できません。
array

2.1.207. .spec.initContainers[].volumeMounts[]

説明
VolumeMount は、コンテナー内でのボリュームのマウントを説明します。
object
必須
  • mountPath
  • name
Expand
プロパティー説明

mountPath

string

ボリュームをマウントする必要があるコンテナー内のパス。':' を含めることはできません。

mountPropagation

string

mountPropagation は、マウントがホストからコンテナーに、またはその逆にどのように伝播されるかを決定します。設定されていない場合、MountPropagationNone が使用されます。このフィールドは 1.10 のベータ版です。

name

string

ボリュームの名前に一致する必要があります。

readOnly

boolean

true の場合は読み取り専用、それ以外の場合は読み取り/書き込み (false または指定なし) でマウントされます。デフォルトは false です。

subPath

string

コンテナーのボリュームをマウントする必要があるボリューム内のパス。デフォルトは "" (ボリュームのルート) です。

subPathExpr

string

コンテナーのボリュームをマウントする必要があるボリューム内の拡張パス。SubPath と同様に動作しますが、環境変数参照 $(VAR_NAME) は、コンテナーの環境を使用してデプロイメントされます。デフォルトは "" (ボリュームのルート) です。SubPathExpr と SubPath は相互に排他的です。

2.1.208. .spec.podMetadata

Description
PodMetadata は、alertmanagerPod に伝達されるラベルとアノテーションを設定します。
タイプ
object
Expand
プロパティー説明

annotations

object (string)

アノテーションは、任意のメタデータを保存し、取得するために外部ツールで設定できる、リソースとともに保存される構造化されていないキー値のマップです。これらはクエリーできないため、オブジェクトを変更する場合に維持する必要があります。詳細: http://kubernetes.io/docs/user-guide/annotations

labels

object (string)

オブジェクトの整理と分類 (スコープと選択) に使用できる文字列キーと値のマップ。レプリケーションコントローラーおよびサービスのセレクターと一致する場合があります。詳細: http://kubernetes.io/docs/user-guide/labels

name

string

name は namespace 内で一意である必要があります。リソースの作成時に必要ですが、リソースによっては、クライアントが適切な名前の生成を自動的に要求することを許可する場合があります。name は、主にべき等性と設定定義の作成を目的としています。これを更新することはできません。詳細: http://kubernetes.io/docs/user-guide/identifiers#names

2.1.209. .spec.resources

説明
単一 Pod のリソース要求と制限を定義します。
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/ を参照してください。

2.1.210. .spec.securityContext

説明
SecurityContext は、Pod レベルのセキュリティー属性と一般的なコンテナー設定を保持します。これはデフォルトでデフォルトの PodSecurityContext になります。
object
Expand
プロパティー説明

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 の場合、このフィールドは設定できないことに注意してください。

seLinuxOptions

object

すべてのコンテナーに適用される SELinux コンテキスト。指定しない場合、コンテナーランタイムはコンテナーごとにランダムな SELinux コンテキストを割り当てます。SecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値がそのコンテナーに優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

seccompProfile

object

この Pod のコンテナーで使用する seccomp オプション。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

supplementalGroups

配列 (整数)

コンテナーのプライマリー GID に加えて、各コンテナーで実行される最初のプロセスに適用されるグループのリスト。指定しない場合、グループはどのコンテナーにも追加されません。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 の場合は、このフィールドを設定できないことに注意してください。

2.1.211. .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 ユーザーラベルです。

2.1.212. .spec.securityContext.seccompProfile

説明
この Pod のコンテナーで使用する seccomp オプション。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
object
必須
  • type
Expand
プロパティー説明

localhostProfile

string

localhostProfile は、ノード上のファイルで定義されたプロファイルを使用する必要があることを示します。プロファイルが機能するには、ノードで事前に設定されている必要があります。kubelet の設定済みの seccomp プロファイルの場所を基準にして、降順のパスである必要があります。タイプが "Localhost" の場合にのみ設定する必要があります。

type

string

type は、適用される seccomp プロファイルの種類を示します。有効なオプションは次のとおりです。Localhost- ノード上のファイルで定義されたプロファイルを使用する必要があります。RuntimeDefault- コンテナーのランタイムデフォルトプロファイルを使用する必要があります。制限なし - プロファイルを適用しないでください。

2.1.213. .spec.securityContext.sysctls

説明
Sysctl は、Pod に使用される namespace 付き sysctl のリストを保持します。(コンテナーランタイムによる) サポートされていない sysctl を持つ Pod は起動に失敗する可能性があります。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
array

2.1.214. .spec.securityContext.sysctls[]

説明
Sysctl は、設定するカーネルパラメーターを定義します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

設定するプロパティーの名前

value

string

設定するプロパティーの値

2.1.215. .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' コンテナーとして実行する必要があるかどうかを決定します。このフィールドはアルファレベルであり、WindowsHostProcessContainers 機能フラグを有効にするコンポーネントによってのみ尊重されます。機能フラグなしでこのフィールドを設定すると、Pod の検証時にエラーが発生します。Pod のすべてのコンテナーは、同じ有効な HostProcess 値を持っている必要があります (HostProcess コンテナーと非 HostProcess コンテナーを混在させることはできません)。さらに、HostProcess が true の場合、HostNetwork も true に設定する必要があります。

runAsUserName

string

コンテナープロセスのエントリーポイントを実行するための Windows の UserName。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。

2.1.216. .spec.storage

説明
ストレージは、Alertmanager インスタンスによるストレージの使用方法の定義です。
object
Expand
プロパティー説明

disableMountSubPath

ブール値

非推奨:subPath の使用は、将来のリリースでデフォルトで無効になります。このオプションは不要になります。DisableMountSubPath を使用すると、ボリュームマウントでの subPath の使用を削除できます。

emptyDir

object

PrometheusStatefulSets によって使用される EmptyDirVolumeSource。指定した場合、volumeClaimTemplate の代わりに使用されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir

ephemeral

object

Prometheus StatefulSets によって使用される EphemeralVolumeSource。これは、k8s 1.21 のベータフィールドであり、k8s 1.19 以降、k8s 1.19 以降では、GenericEphemeralVolume フィーチャーゲートを有効にする必要があります。詳細: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes

volumeClaimTemplate

object

PrometheusStatefulSets で使用される PVC 仕様。

2.1.217. .spec.storage.emptyDir

Description
PrometheusStatefulSets によって使用される EmptyDirVolumeSource。指定した場合、volumeClaimTemplate の代わりに使用されます。詳細: 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 です。これは、制限が未定義であることを意味します。詳細: http://kubernetes.io/docs/user-guide/volumes#emptydir

2.1.218. .spec.storage.ephemeral

説明
Prometheus StatefulSets によって使用される EphemeralVolumeSource。これは、k8s 1.21 のベータフィールドであり、k8s 1.19 以降、k8s 1.19 以降では、GenericEphemeralVolume フィーチャーゲートを有効にする必要があります。詳細: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes
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 であってはなりません。

2.1.219. .spec.storage.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 と同じフィールドがここでも有効です。

2.1.220. .spec.storage.ephemeral.volumeClaimTemplate.metadata

説明
PVC の作成時に PVC にコピーされるラベルとアノテーションが含まれる場合があります。他のフィールドは許可されておらず、検証中に拒否されます。
object

2.1.221. .spec.storage.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 機能ゲートが有効になっている場合、このフィールドは常に DataSourceRef フィールドと同じ内容になります。

dataSourceRef

object

dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これは、空でない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のローカルオブジェクトである可能性があります。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、DataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性のために、両方のフィールド (DataSource と DataSourceRef) は、一方が空でもう一方が空でない場合、自動的に同じ値に設定されます。DataSource と DataSourceRef には 2 つの重要な違いがあります。*DataSource は 2 つの特定のタイプのオブジェクトのみを許可しますが、DataSourceRef は非コアオブジェクトと PersistentVolumeClaim オブジェクトを許可します。* DataSource は許可されていない値を無視 (ドロップ) しますが、DataSourceRef はすべての値を保持し、許可されていない値が指定されている場合はエラーを生成します。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。

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

volumeMode

string

volumeMode は、要求に必要なボリュームのタイプを定義します。Filesystem の値は、要求仕様に含まれていない場合に暗示されます。

volumeName

string

volumeName は、この要求をサポートする PersistentVolume へのバインディング参照です。

2.1.222. .spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource

説明
dataSource フィールドは、次のいずれかを指定するために使用できます。*既存の VolumeSnapshot オブジェクト (snapshot.storage.k8s.io/VolumeSnapshot)*既存の PVC(PersistentVolumeClaim) プロビジョナーまたは外部コントローラーが指定されたデータソースをサポートできる場合、指定されたデータソースのコンテンツに基づく新しいボリューム。AnyVolumeDataSource 機能ゲートが有効になっている場合、このフィールドは常に DataSourceRef フィールドと同じ内容になります。
タイプ
object
必須
  • kind
  • name
Expand
プロパティー説明

apiGroup

string

APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。

kind

string

kind は参照されているリソースのタイプです。

name

string

name は、参照されているリソースの名前です。

2.1.223. .spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef

説明
dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これは、空でない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のローカルオブジェクトである可能性があります。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、DataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性のために、両方のフィールド (DataSource と DataSourceRef) は、一方が空でもう一方が空でない場合、自動的に同じ値に設定されます。DataSource と DataSourceRef には 2 つの重要な違いがあります。*DataSource は 2 つの特定のタイプのオブジェクトのみを許可しますが、DataSourceRef は非コアオブジェクトと PersistentVolumeClaim オブジェクトを許可します。* DataSource は許可されていない値を無視 (ドロップ) しますが、DataSourceRef はすべての値を保持し、許可されていない値が指定されている場合はエラーを生成します。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。
object
必須
  • kind
  • name
Expand
プロパティー説明

apiGroup

string

APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。

kind

string

kind は参照されているリソースのタイプです。

name

string

name は、参照されているリソースの名前です。

2.1.224. .spec.storage.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/ を参照してください。

2.1.225. .spec.storage.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 で結合されます。

2.1.226. .spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions

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

2.1.227. .spec.storage.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

2.1.228. .spec.storage.volumeClaimTemplate

Description
PrometheusStatefulSets で使用される PVC 仕様。
タイプ
object
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

object

EmbeddedMetadata には、EmbeddedResource に関連するメタデータが含まれています。

spec

object

仕様は、Pod 作成者によって要求されたボリュームの望ましい特性を定義します。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

status

object

ステータスは、永続的なボリュームクレームの現在の情報/ステータスを表します。read-only詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

2.1.229. .spec.storage.volumeClaimTemplate.metadata

説明
EmbeddedMetadata には、EmbeddedResource に関連するメタデータが含まれています。
object
Expand
プロパティー説明

annotations

object (string)

アノテーションは、任意のメタデータを保存し、取得するために外部ツールで設定できる、リソースとともに保存される構造化されていないキー値のマップです。これらはクエリーできないため、オブジェクトを変更する場合に維持する必要があります。詳細: http://kubernetes.io/docs/user-guide/annotations

labels

object (string)

オブジェクトの整理と分類 (スコープと選択) に使用できる文字列キーと値のマップ。レプリケーションコントローラーおよびサービスのセレクターと一致する場合があります。詳細: http://kubernetes.io/docs/user-guide/labels

name

string

name は namespace 内で一意である必要があります。リソースの作成時に必要ですが、リソースによっては、クライアントが適切な名前の生成を自動的に要求することを許可する場合があります。name は、主にべき等性と設定定義の作成を目的としています。これを更新することはできません。詳細: http://kubernetes.io/docs/user-guide/identifiers#names

2.1.230. .spec.storage.volumeClaimTemplate.spec

Description
仕様は、Pod 作成者によって要求されたボリュームの望ましい特性を定義します。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
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 機能ゲートが有効になっている場合、このフィールドは常に DataSourceRef フィールドと同じ内容になります。

dataSourceRef

object

dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これは、空でない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のローカルオブジェクトである可能性があります。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、DataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性のために、両方のフィールド (DataSource と DataSourceRef) は、一方が空でもう一方が空でない場合、自動的に同じ値に設定されます。DataSource と DataSourceRef には 2 つの重要な違いがあります。*DataSource は 2 つの特定のタイプのオブジェクトのみを許可しますが、DataSourceRef は非コアオブジェクトと PersistentVolumeClaim オブジェクトを許可します。* DataSource は許可されていない値を無視 (ドロップ) しますが、DataSourceRef はすべての値を保持し、許可されていない値が指定されている場合はエラーを生成します。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。

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

volumeMode

string

volumeMode は、要求に必要なボリュームのタイプを定義します。Filesystem の値は、要求仕様に含まれていない場合に暗示されます。

volumeName

string

volumeName は、この要求をサポートする PersistentVolume へのバインディング参照です。

2.1.231. .spec.storage.volumeClaimTemplate.spec.dataSource

説明
dataSource フィールドは、次のいずれかを指定するために使用できます。*既存の VolumeSnapshot オブジェクト (snapshot.storage.k8s.io/VolumeSnapshot)*既存の PVC(PersistentVolumeClaim) プロビジョナーまたは外部コントローラーが指定されたデータソースをサポートできる場合、指定されたデータソースのコンテンツに基づく新しいボリューム。AnyVolumeDataSource 機能ゲートが有効になっている場合、このフィールドは常に DataSourceRef フィールドと同じ内容になります。
タイプ
object
必須
  • kind
  • name
Expand
プロパティー説明

apiGroup

string

APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。

kind

string

kind は参照されているリソースのタイプです。

name

string

name は、参照されているリソースの名前です。

2.1.232. .spec.storage.volumeClaimTemplate.spec.dataSourceRef

説明
dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これは、空でない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のローカルオブジェクトである可能性があります。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、DataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性のために、両方のフィールド (DataSource と DataSourceRef) は、一方が空でもう一方が空でない場合、自動的に同じ値に設定されます。DataSource と DataSourceRef には 2 つの重要な違いがあります。*DataSource は 2 つの特定のタイプのオブジェクトのみを許可しますが、DataSourceRef は非コアオブジェクトと PersistentVolumeClaim オブジェクトを許可します。* DataSource は許可されていない値を無視 (ドロップ) しますが、DataSourceRef はすべての値を保持し、許可されていない値が指定されている場合はエラーを生成します。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。
object
必須
  • kind
  • name
Expand
プロパティー説明

apiGroup

string

APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。

kind

string

kind は参照されているリソースのタイプです。

name

string

name は、参照されているリソースの名前です。

2.1.233. .spec.storage.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/ を参照してください。

2.1.234. .spec.storage.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 で結合されます。

2.1.235. .spec.storage.volumeClaimTemplate.spec.selector.matchExpressions

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

2.1.236. .spec.storage.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

2.1.237. .spec.storage.volumeClaimTemplate.status

Description
ステータスは、永続的なボリュームクレームの現在の情報/ステータスを表します。read-only詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
object
Expand
プロパティー説明

accessModes

array (string)

accessModes には、PVC をサポートするボリュームが実際に持つアクセスモードが含まれます。詳細は、https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 を参照してください。

allocatedResources

integer-or-string

allocatedResources は、AllocatedResources 内のストレージリソースで、PVC に割り当てられた容量を追跡します。ボリューム拡張操作が要求された場合、実際の容量よりも大きくなる場合があります。ストレージクォータには、allocatedResources と PVC.spec.resources を比較して大きい方の値が使用されます。allocatedResources が設定されていない場合、PVC.spec.resources のみがクォータの計算に使用されます。ボリューム拡張容量要求が下げられ、進行中の拡張操作がなく、実際のボリューム容量が要求された容量以下である場合にのみ、allocatedResources が引き下げられます。これはアルファフィールドであるため、RecoverVolumeExpansionFailure 機能を有効にする必要があります。

capacity

integer-or-string

capacity は、基礎となるボリュームの実際のリソースを表します。

conditions

array

conditions は永続ボリューム要求の現在の条件です。基礎となる永続ボリュームのサイズを変更すると、Condition は 'ResizeStarted' に設定されます。

conditions[]

object

PersistentVolumeClaimCondition コンテーションで pvc の状態についての詳細

phase

string

phase は PersistentVolumeClaim の現在のフェーズを表します。

resizeStatus

string

resizeStatus は、サイズ変更操作のステータスを格納します。ResizeStatus はデフォルトでは設定されませんが、拡張が完了すると、サイズ変更コントローラーまたは kubelet によって、resizeStatus が空の文字列に設定されます。これはアルファフィールドであるため、RecoverVolumeExpansionFailure 機能を有効にする必要があります。

2.1.238. .spec.storage.volumeClaimTemplate.status.conditions

説明
conditions は永続ボリューム要求の現在の条件です。基礎となる永続ボリュームのサイズを変更すると、Condition は 'ResizeStarted' に設定されます。
array

2.1.239. .spec.storage.volumeClaimTemplate.status.conditions[]

Description
PersistentVolumeClaimCondition コンテーションで pvc の状態についての詳細
タイプ
object
必須
  • status
  • type
Expand
プロパティー説明

lastProbeTime

string

lastProbeTime は、条件を調査した時間です。

lastTransitionTime

string

lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。

message

string

message は、最後の遷移に関する詳細を示し、人間が判読できるメッセージです。

reason

string

一意であり、これは、条件の最後の遷移理由を示す、マシンが理解できる短い文字列である必要があります。"ResizeStarted" と報告された場合は、基礎となる永続ボリュームのサイズが変更されていることを意味します。

status

string

 

type

string

PersistentVolumeClaimConditionType は、PersistentVolumeClaimCondition.Type の有効な値です。

2.1.240. .spec.tolerations

説明
指定されている場合、Pod の許容範囲。
array

2.1.241. .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 の場合、値は空である必要があります。それ以外の場合は、通常の文字列のみになります。

2.1.242. .spec.topologySpreadConstraints

説明
指定した場合、Pod のトポロジー拡散制約。
array

2.1.243. .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 のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。null または空のリストは、labelSelector とのみ一致することを意味します。

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 に違反するためです。これはベータフィールドであり、MinDomainsInPodTopologySpread フィーチャーゲートを有効にする必要があります (デフォルトで有効)。

nodeAffinityPolicy

string

nodeAffinityPolicy は、Pod トポロジーの分散スキューを計算するときに Pod の nodeAffinity/nodeSelector をどのように扱うかを示します。オプションは - Honor: nodeAffinity/nodeSelector に一致するノードのみが計算に含まれます。- Ignore: nodeAffinity/nodeSelector は無視されます。すべてのノードが計算に含まれます。この値が nil の場合、この動作は Honor ポリシーと同じです。これは、NodeInclusionPolicyInPodTopologySpread 機能フラグによって有効にされるアルファレベルの機能です。

nodeTaintsPolicy

string

NodeTaintsPolicy は、Pod トポロジースプレッドスキューを計算するときにノードのテイントを処理する方法を示します。オプション: - Honor: テイントのないノードと、受信 Pod が許容範囲でテイントがあるノードが含まれます。- Ignore: ノードのテイントは無視されます。すべてのノードが含まれます。この値が nil の場合、この動作は Ignore ポリシーと同じです。これは、NodeInclusionPolicyInPodTopologySpread 機能フラグによって有効にされるアルファレベルの機能です。

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) になります。つまり、クラスターは依然として不均衡である可能性がありますが、スケジューラーによってクラスターが さらに 不均衡になることはありません。必須フィールドです。

2.1.244. .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 で結合されます。

2.1.245. .spec.topologySpreadConstraints[].labelSelector.matchExpressions

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

2.1.246. .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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

2.1.247. .spec.volumeMounts

説明
VolumeMounts を使用すると、出力 StatefulSet 定義に追加の VolumeMounts を設定できます。指定された VolumeMounts は、StorageSpec オブジェクトの結果として生成される alertmanager コンテナー内の他の VolumeMounts に追加されます。
array

2.1.248. .spec.volumeMounts[]

説明
VolumeMount は、コンテナー内でのボリュームのマウントを説明します。
object
必須
  • mountPath
  • name
Expand
プロパティー説明

mountPath

string

ボリュームをマウントする必要があるコンテナー内のパス。':' を含めることはできません。

mountPropagation

string

mountPropagation は、マウントがホストからコンテナーに、またはその逆にどのように伝播されるかを決定します。設定されていない場合、MountPropagationNone が使用されます。このフィールドは 1.10 のベータ版です。

name

string

ボリュームの名前に一致する必要があります。

readOnly

boolean

true の場合は読み取り専用、それ以外の場合は読み取り/書き込み (false または指定なし) でマウントされます。デフォルトは false です。

subPath

string

コンテナーのボリュームをマウントする必要があるボリューム内のパス。デフォルトは "" (ボリュームのルート) です。

subPathExpr

string

コンテナーのボリュームをマウントする必要があるボリューム内の拡張パス。SubPath と同様に動作しますが、環境変数参照 $(VAR_NAME) は、コンテナーの環境を使用してデプロイメントされます。デフォルトは "" (ボリュームのルート) です。SubPathExpr と SubPath は相互に排他的です。

2.1.249. .spec.volumes

説明
ボリュームを使用すると、出力の StatefulSet 定義に追加のボリュームを設定できます。指定されたボリュームは、StorageSpec オブジェクトの結果として生成される他のボリュームに追加されます。
array

2.1.250. .spec.volumes[]

説明
ボリュームは、Pod 内の任意のコンテナーからアクセスできる Pod 内の名前付きボリュームを表します。
object
必須
  • name
Expand
プロパティー説明

awsElasticBlockStore

object

awsElasticBlockStore は、kubelet のホストマシンに割り当てられ、Pod に公開される AWS Disk リソースを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

azureDisk

object

azureDisk は、ホスト上の Azure Data Disk マウントを表し、Pod へのバインドマウントを表します。

azureFile

object

azureFile は、ホスト上の Azure File Service マウントを表し、マウントを Pod にバインドします。

cephfs

object

cephFS は、Pod の有効期間を共有するホストでの Ceph FS マウントを表します。

cinder

object

Cinder は、kubelets ホストマシンに接続およびマウントされた Cinder ボリュームを表します。詳細: 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 ベースのプラグインを使用してプロビジョニング/接続される汎用ボリュームリソースを表します。

flocker

object

flocker は、kubelet のホストマシンに接続されている Flocker ボリュームを表します。これは、実行中の Flocker 制御サービスによって異なります

gcePersistentDisk

object

gcePersistentDisk は、kubelet のホストマシンに接続されてから Pod に公開される GCE ディスクリソースを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

gitRepo

object

gitRepo は、特定のリビジョンの git リポジトリーを表します。非推奨:GitRepo は非推奨です。git レポジトリを使用してコンテナーをプロビジョニングするには、Git を使用してレポジトリのクローンを作成する InitContainer に EmptyDir をマウントしてから、Pod のコンテナーに EmptyDir をマウントします。

glusterfs

object

glusterfs は、Pod の存続期間を共有するホスト上の Glusterfs マウントを表します。詳細: https://examples.k8s.io/volumes/glusterfs/README.md

hostPath

object

hostPath は、コンテナーに直接公開されているホストマシン上の既存のファイルまたはディレクトリーを表します。これは通常、ホストマシンの表示を許可されているシステムエージェントまたはその他の特権的なものに使用されます。ほとんどのコンテナーはこれを必要としません。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) ホストディレクトリーのマウントを使用できる人、およびホストディレクトリーを読み取り/書き込みでマウントできる人/できない人を制限する必要があります。

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 永続ディスクを表します。

portworxVolume

object

portworxVolume は、kubelet ホストマシンに接続およびマウントされた portworx ボリュームを表します。

projected

object

オールインワンリソースシークレット、configmaps、および Downward API のアイテム

quobyte

object

quobyte は、Pod の有効期限を共有するホストでの Quobyte マウントを表します

rbd

object

rbd は、Pod の有効期間を共有するホストの Rados ブロックデバイスマウントを表します。詳細: https://examples.k8s.io/volumes/rbd/README.md

scaleIO

object

scaleIO は、Kubernetes ノードに接続およびマウントされた ScaleIO 永続ボリュームを表します。

secret

object

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

storageos

object

storageOS は、Kubernetes ノードに接続およびマウントされた StorageOS ボリュームを表します。

vsphereVolume

object

vsphereVolume は、kubelet ホストマシンに接続およびマウントされた vSphere ボリュームを表します。

2.1.251. .spec.volumes[].awsElasticBlockStore

説明
awsElasticBlockStore は、kubelet のホストマシンに割り当てられ、Pod に公開される AWS Disk リソースを表します。詳細: 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 TODO: ファイルシステムのエラーによるマシンの侵害を防ぐにはどうすればよいですか ?

パーティション

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

2.1.252. .spec.volumes[].azureDisk

説明
azureDisk は、ホスト上の Azure Data Disk マウントを表し、Pod へのバインドマウントを表します。
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 設定が強制的に実行されます。

2.1.253. .spec.volumes[].azureFile

説明
azureFile は、ホスト上の Azure File Service マウントを表し、マウントを Pod にバインドします。
object
必須
  • secretName
  • shareName
Expand
プロパティー説明

readOnly

boolean

readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

secretName

string

secretName は、Azure ストレージアカウント名とキーを含むシークレットの名前です。

shareName

string

shareName は Azure 共有名です。

2.1.254. .spec.volumes[].cephfs

説明
cephFS は、Pod の有効期間を共有するホストでの Ceph FS マウントを表します。
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

2.1.255. .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 TODO: その他の便利なルール度を追加。apiVersion、kind、uid

2.1.256. .spec.volumes[].cinder

説明
Cinder は、kubelets ホストマシンに接続およびマウントされた Cinder ボリュームを表します。詳細: 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

2.1.257. .spec.volumes[].cinder.secretRef

説明
secretRef は任意: OpenStack への接続に使用されるパラメーターを含むシークレットオブジェクトを指します。
object
Expand
プロパティー説明

name

string

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

2.1.258. .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 TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

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

2.1.259. .spec.volumes[].configMap.items

説明
item が指定されていない場合、参照される ConfigMap の Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。ConfigMap に存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
array

2.1.260. .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 はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。

2.1.261. .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 ドライバーに渡されるドライバー固有のプロパティーを格納します。サポートされている値は、ドライバーのドキュメントを参照してください。

2.1.262. .spec.volumes[].csi.nodePublishSecretRef

説明
nodePublishSecretRef は、CSI NodePublishVolume および NodeUnpublishVolume 呼び出しを完了するために CSI ドライバーに渡す機密情報を含むシークレットオブジェクトへの参照です。このフィールドはオプションであり、シークレットが不要な場合は空の場合があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレット参照が渡されます。
object
Expand
プロパティー説明

name

string

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

2.1.263. .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 フィールドを含むファイルを作成するための情報を表します

2.1.264. .spec.volumes[].downwardAPI.items

説明
items は、Downward API ボリュームファイルのリストです
array

2.1.265. .spec.volumes[].downwardAPI.items[]

説明
DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します
object
必須
  • path
Expand
プロパティー説明

fieldRef

object

必須:Pod のフィールドを選択します。アノテーション、ラベル、名前、名前空間のみがサポートされます。

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) のみがサポートされています。

2.1.266. .spec.volumes[].downwardAPI.items[].fieldRef

Description
必須:Pod のフィールドを選択します。アノテーション、ラベル、名前、名前空間のみがサポートされます。
タイプ
object
必須
  • fieldPath
Expand
プロパティー説明

apiVersion

string

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

fieldPath

string

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

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

必須: 選択するリソース

2.1.268. .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 です。これは、制限が未定義であることを意味します。詳細: http://kubernetes.io/docs/user-guide/volumes#emptydir

2.1.269. .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 であってはなりません。

2.1.270. .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 と同じフィールドがここでも有効です。

2.1.271. .spec.volumes[].ephemeral.volumeClaimTemplate.metadata

説明
PVC の作成時に PVC にコピーされるラベルとアノテーションが含まれる場合があります。他のフィールドは許可されておらず、検証中に拒否されます。
object

2.1.272. .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 機能ゲートが有効になっている場合、このフィールドは常に DataSourceRef フィールドと同じ内容になります。

dataSourceRef

object

dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これは、空でない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のローカルオブジェクトである可能性があります。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、DataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性のために、両方のフィールド (DataSource と DataSourceRef) は、一方が空でもう一方が空でない場合、自動的に同じ値に設定されます。DataSource と DataSourceRef には 2 つの重要な違いがあります。*DataSource は 2 つの特定のタイプのオブジェクトのみを許可しますが、DataSourceRef は非コアオブジェクトと PersistentVolumeClaim オブジェクトを許可します。* DataSource は許可されていない値を無視 (ドロップ) しますが、DataSourceRef はすべての値を保持し、許可されていない値が指定されている場合はエラーを生成します。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。

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

volumeMode

string

volumeMode は、要求に必要なボリュームのタイプを定義します。Filesystem の値は、要求仕様に含まれていない場合に暗示されます。

volumeName

string

volumeName は、この要求をサポートする PersistentVolume へのバインディング参照です。

2.1.273. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSource

説明
dataSource フィールドは、次のいずれかを指定するために使用できます。*既存の VolumeSnapshot オブジェクト (snapshot.storage.k8s.io/VolumeSnapshot)*既存の PVC(PersistentVolumeClaim) プロビジョナーまたは外部コントローラーが指定されたデータソースをサポートできる場合、指定されたデータソースのコンテンツに基づく新しいボリューム。AnyVolumeDataSource 機能ゲートが有効になっている場合、このフィールドは常に DataSourceRef フィールドと同じ内容になります。
タイプ
object
必須
  • kind
  • name
Expand
プロパティー説明

apiGroup

string

APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。

kind

string

kind は参照されているリソースのタイプです。

name

string

name は、参照されているリソースの名前です。

2.1.274. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef

説明
dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これは、空でない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のローカルオブジェクトである可能性があります。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、DataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性のために、両方のフィールド (DataSource と DataSourceRef) は、一方が空でもう一方が空でない場合、自動的に同じ値に設定されます。DataSource と DataSourceRef には 2 つの重要な違いがあります。*DataSource は 2 つの特定のタイプのオブジェクトのみを許可しますが、DataSourceRef は非コアオブジェクトと PersistentVolumeClaim オブジェクトを許可します。* DataSource は許可されていない値を無視 (ドロップ) しますが、DataSourceRef はすべての値を保持し、許可されていない値が指定されている場合はエラーを生成します。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。
object
必須
  • kind
  • name
Expand
プロパティー説明

apiGroup

string

APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。

kind

string

kind は参照されているリソースのタイプです。

name

string

name は、参照されているリソースの名前です。

2.1.275. .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/ を参照してください。

2.1.276. .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 で結合されます。

2.1.277. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions

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

2.1.278. .spec.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

2.1.279. .spec.volumes[].fc

説明
fc は、kubelet のホストマシンに接続されてから Pod に公開されるファイバーチャネルリソースを表します。
object
Expand
プロパティー説明

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。TODO: ファイルシステムのエラーがマシンを危険にさらすのを防ぐにはどうすればよいですか ?

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 の組み合わせのいずれかを設定する必要がありますが、両方を同時に設定できません。

2.1.280. .spec.volumes[].flexVolume

説明
flexVolume は、exec ベースのプラグインを使用してプロビジョニング/接続される汎用ボリュームリソースを表します。
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 は、プラグインスクリプトに渡す機密情報を含むシークレットオブジェクトへの参照です。シークレットオブジェクトが指定されていない場合、これは空になる可能性があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレットがプラグインスクリプトに渡されます。

2.1.281. .spec.volumes[].flexVolume.secretRef

説明
secretRef は任意: secretRef は、プラグインスクリプトに渡す機密情報を含むシークレットオブジェクトへの参照です。シークレットオブジェクトが指定されていない場合、これは空になる可能性があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレットがプラグインスクリプトに渡されます。
object
Expand
プロパティー説明

name

string

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

2.1.282. .spec.volumes[].flocker

説明
flocker は、kubelet のホストマシンに接続されている Flocker ボリュームを表します。これは、実行中の Flocker 制御サービスによって異なります
object
Expand
プロパティー説明

datasetName

string

datasetName はメタデータとして保存されているデータセットの名前です → Flocker のデータセット上の名前は非推奨として扱うようにしてください。

datasetUUID

string

datasetUUID は、データセットの UUID です。これは Flocker データセットの一意の識別子です

2.1.283. .spec.volumes[].gcePersistentDisk

説明
gcePersistentDisk は、kubelet のホストマシンに接続されてから Pod に公開される GCE ディスクリソースを表します。詳細: 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 TODO: ファイルシステムのエラーによるマシンの侵害を防ぐにはどうすればよいですか ?

パーティション

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

2.1.284. .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 は、指定されたリビジョンのコミットハッシュです。

2.1.285. .spec.volumes[].glusterfs

説明
glusterfs は、Pod の存続期間を共有するホスト上の 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

2.1.286. .spec.volumes[].hostPath

説明
hostPath は、コンテナーに直接公開されているホストマシン上の既存のファイルまたはディレクトリーを表します。これは通常、ホストマシンの表示を許可されているシステムエージェントまたはその他の特権的なものに使用されます。ほとんどのコンテナーはこれを必要としません。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) ホストディレクトリーのマウントを使用できる人、およびホストディレクトリーを読み取り/書き込みでマウントできる人/できない人を制限する必要があります。
object
必須
  • path
Expand
プロパティー説明

path

string

ホスト上のディレクトリーのパス。パスがシンボリックリンクの場合、実際のパスへのリンクをたどります。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

type

string

HostPath ボリュームのデフォルトのタイプは "" です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

2.1.287. .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 TODO: ファイルシステムのエラーによるマシンの侵害を防ぐにはどうすればよいですか ?

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

2.1.288. .spec.volumes[].iscsi.secretRef

説明
secretRef は、iSCSI ターゲットおよびイニシエーター認証用の CHAP Secret です。
object
Expand
プロパティー説明

name

string

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

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

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

2.1.291. .spec.volumes[].photonPersistentDisk

説明
photonPersistentDisk は、kubelets ホストマシンに接続されマウントされた PhotonController 永続ディスクを表します。
object
必須
  • pdID
Expand
プロパティー説明

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

pdID

string

pdID は、Photon Controller の永続ディスクを識別する ID です。

2.1.292. .spec.volumes[].portworxVolume

説明
portworxVolume は、kubelet ホストマシンに接続およびマウントされた portworx ボリュームを表します。
object
必須
  • volumeID
Expand
プロパティー説明

fsType

string

fSType は、マウントするファイルシステムタイプを表します。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

readOnly

boolean

readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

volumeID

string

volumeID は、Portworx ボリュームを一意に識別します

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

source は、ボリュームプロジェクションのリストです。

sources[]

object

サポートされている他のボリュームタイプと一緒にデプロイメントされる可能性のあるプロジェクション

2.1.294. .spec.volumes[].projected.sources

説明
source は、ボリュームプロジェクションのリストです。
array

2.1.295. .spec.volumes[].projected.sources[]

説明
サポートされている他のボリュームタイプと一緒にデプロイメントされる可能性のあるプロジェクション
object
Expand
プロパティー説明

configMap

object

プロジェクトへの configMap データの configMap 情報

downwardAPI

object

downwardAPI データのプロジェクトへの downwardAPI 情報

secret

object

投影するシークレットデータに関する情報

serviceAccountToken

object

serviceAccountToken は、投影する serviceAccountToken データに関する情報です。

2.1.296. .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 TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

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

2.1.297. .spec.volumes[].projected.sources[].configMap.items

説明
item が指定されていない場合、参照される ConfigMap の Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。ConfigMap に存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
array

2.1.298. .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 はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。

2.1.299. .spec.volumes[].projected.sources[].downwardAPI

説明
downwardAPI データのプロジェクトへの downwardAPI 情報
object
Expand
プロパティー説明

items

array

Items は DownwardAPIVolume ファイルのリストです

items[]

object

DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します

2.1.300. .spec.volumes[].projected.sources[].downwardAPI.items

説明
Items は DownwardAPIVolume ファイルのリストです
array

2.1.301. .spec.volumes[].projected.sources[].downwardAPI.items[]

説明
DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します
object
必須
  • path
Expand
プロパティー説明

fieldRef

object

必須:Pod のフィールドを選択します。アノテーション、ラベル、名前、名前空間のみがサポートされます。

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) のみがサポートされています。

2.1.302. .spec.volumes[].projected.sources[].downwardAPI.items[].fieldRef

Description
必須:Pod のフィールドを選択します。アノテーション、ラベル、名前、名前空間のみがサポートされます。
タイプ
object
必須
  • fieldPath
Expand
プロパティー説明

apiVersion

string

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

fieldPath

string

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

2.1.303. .spec.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

必須: 選択するリソース

2.1.304. .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 TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

オプションフィールドは、シークレットかそのキーを定義する必要があるかどうかを指定します。

2.1.305. .spec.volumes[].projected.sources[].secret.items

説明
items が指定されていない場合、参照されるシークレットの Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。シークレットに存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
array

2.1.306. .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 はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。

2.1.307. .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 は、トークンのデプロイメント先となるファイルのマウントポイントに対する相対パスです。

2.1.308. .spec.volumes[].quobyte

説明
quobyte は、Pod の有効期限を共有するホストでの 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 は、すでに作成されているクオバイトボリュームを名前で参照する文字列です。

2.1.309. .spec.volumes[].rbd

説明
rbd は、Pod の有効期間を共有するホストの Rados ブロックデバイスマウントを表します。詳細: 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 TODO: ファイルシステムのエラーによるマシンの侵害を防ぐにはどうすればよいですか ?

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

2.1.310. .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 TODO: その他の便利なルール度を追加。apiVersion、kind、uid

2.1.311. .spec.volumes[].scaleIO

説明
scaleIO は、Kubernetes ノードに接続およびマウントされた 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 システムですでに作成されているボリュームの名前です。

2.1.312. .spec.volumes[].scaleIO.secretRef

説明
secretRef は、ScaleIO ユーザーおよびその他の機密情報の秘密を参照します。これが指定されていない場合、ログイン操作は失敗します。
object
Expand
プロパティー説明

name

string

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

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

2.1.314. .spec.volumes[].secret.items

説明
items が指定されていない場合、参照されるシークレットの Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。シークレットに存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
array

2.1.315. .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 はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。

2.1.316. .spec.volumes[].storageos

説明
storageOS は、Kubernetes ノードに接続およびマウントされた 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 が作成されます。

2.1.317. .spec.volumes[].storageos.secretRef

説明
secretRef は、StorageOS API クレデンシャルを取得するために使用するシークレットを指定します。指定しない場合、デフォルト値が試行されます。
object
Expand
プロパティー説明

name

string

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

2.1.318. .spec.volumes[].vsphereVolume

説明
vsphereVolume は、kubelet ホストマシンに接続およびマウントされた vSphere ボリュームを表します。
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 を識別するパスです。

2.1.319. .spec.web

説明
Alertmanager 起動時の Web コマンドラインフラグを定義します。
object
Expand
プロパティー説明

httpConfig

object

Web サーバーの HTTP パラメーターを定義します。

tlsConfig

object

HTTPS の TLS パラメーターを定義します。

2.1.320. .spec.web.httpConfig

説明
Web サーバーの HTTP パラメーターを定義します。
object
Expand
プロパティー説明

headers

object

HTTP 応答に追加できるヘッダーのリスト。

http2

boolean

HTTP/2 サポートを有効にします。HTTP/2 は TLS でのみサポートされることに注意してください。TLSConfig が設定されていない場合、HTTP/2 は無効になります。フィールドの値が変わるたびに、ローリング更新がトリガーされます。

2.1.321. .spec.web.httpConfig.headers

説明
HTTP 応答に追加できるヘッダーのリスト。
object
Expand
プロパティー説明

contentSecurityPolicy

string

HTTP 応答に Content-Security-Policy ヘッダーを設定します。空白の場合は設定しません。

strictTransportSecurity

string

HTTP 応答に Strict-Transport-Security ヘッダーを設定します。空白の場合は設定しません。このヘッダーは、ブラウザーは同じドメインとサブドメインでホストされている Prometheus やその他のアプリケーションを HTTPS 経由で読み込むよう強制する可能性があるため、注意して使用してください。https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security

xContentTypeOptions

string

X-Content-Type-Options ヘッダーを HTTP 応答に設定します。空白の場合は設定しません。許可される値は nosniff です。https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options

xFrameOptions

string

X-Frame-Options ヘッダーを HTTP 応答に設定します。空白の場合は設定しません。許可される値は、deny と sameorigin です。https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options

xXSSProtection

string

すべての応答に X-XSS-Protection ヘッダーを設定します。空白の場合は設定しません。https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection

2.1.322. .spec.web.tlsConfig

説明
HTTPS の TLS パラメーターを定義します。
object
必須
  • cert
  • keySecret
Expand
プロパティー説明

cert

object

サーバーの TLS 証明書が含まれています。

cipherSuites

array (string)

TLS1.2 までの TLS バージョンでサポートされている暗号スイートのリスト。空の場合、Go のデフォルトの暗号スイートが使用されます。利用可能な暗号スイートは、go のドキュメントに記載されています: https://golang.org/pkg/crypto/tls/#pkg-constants

clientAuthType

string

クライアント認証のサーバーポリシー。ClientAuth ポリシーにマップします。clientAuth オプションの詳細については、https://golang.org/pkg/crypto/tls/#ClientAuthType をご覧ください。

client_ca

object

サーバーへのクライアント証明書認証用の CA 証明書が含まれています。

curvePreferences

array (string)

ECDHE ハンドシェイクで使用される楕円曲線を優先順に使用します。利用可能な曲線は、go のドキュメントに記載されています: https://golang.org/pkg/crypto/tls/#CurveID

keySecret

object

サーバーの TLS キーを含むシークレット。

maxVersion

string

許容可能な最大 TLS バージョン。デフォルトは TLS13 です。

minVersion

string

許容可能な最小 TLS バージョン。デフォルトは TLS12 です。

preferServerCipherSuites

boolean

サーバーがクライアントの最も優先される暗号スイートを選択するか、サーバーの最も優先される暗号スイートを選択するかを制御します。true の場合、cipherSuites の要素の順序で表されるサーバーの設定が使用されます。

2.1.323. .spec.web.tlsConfig.cert

説明
サーバーの TLS 証明書が含まれています。
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

2.1.324. .spec.web.tlsConfig.cert.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

2.1.325. .spec.web.tlsConfig.cert.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

2.1.326. .spec.web.tlsConfig.client_ca

説明
サーバーへのクライアント証明書認証用の CA 証明書が含まれています。
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

2.1.327. .spec.web.tlsConfig.client_ca.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

2.1.328. .spec.web.tlsConfig.client_ca.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

2.1.329. .spec.web.tlsConfig.keySecret

説明
サーバーの TLS キーを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

2.1.330. .status

説明
Alertmanager クラスターの最新の観測ステータス。read-onlyapiserver からのリクエストには含まれず、PrometheusOperatorAPI 自体からのみ含まれます。詳細: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
object
必須
  • availableReplicas
  • paused
  • replicas
  • unavailableReplicas
  • updatedReplicas
Expand
プロパティー説明

availableReplicas

integer

この Alertmanager クラスターのターゲットとなる利用可能な Pod (少なくとも minReadySeconds の準備ができている) の総数。

paused

boolean

基になるマネージドオブジェクトに対してアクションが実行されているかどうかを表します。削除アクションのみが実行されます。

replicas

integer

この Alertmanager クラスターのターゲットとなる終了していない Pod の総数 (ラベルはセレクターと一致します)。

unavailableReplicas

integer

この Alertmanager クラスターの対象となる使用できない Pod の総数。

updatedReplicas

integer

目的のバージョン仕様を持つ、この Alertmanager クラスターのターゲットとなる非終了 Pod の総数。

2.2. API エンドポイント

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

  • /apis/monitoring.coreos.com/v1/alertmanagers

    • GET: 種類が Alertmanager のオブジェクトをリスト表示します。
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/alertmanagers

    • DELETE: Alertmanager のコレクションを削除します。
    • GET: 種類が Alertmanager のオブジェクトをリスト表示します。
    • POST: Alertmanager を作成します。
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/alertmanagers/{name}

    • DELETE: Alertmanager を削除します。
    • GET: 指定された Alertmanager を読み取ります。
    • PATCH: 指定された Alertmanager を部分的に更新します。
    • PUT: 指定された Alertmanager を置き換えます

2.2.1. /apis/monitoring.coreos.com/v1/alertmanagers

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

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

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

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

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

HTTP メソッド
GET
説明
種類が Alertmanager のオブジェクトをリスト表示します。
Expand
表2.2 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

AlertmanagerList スキーマ

401 - Unauthorized

空白

2.2.2. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/alertmanagers

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

namespace

string

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

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
Alertmanager のコレクションを削除します
Expand
表2.5 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

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

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

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

Expand
表2.6 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
種類 Alertmanager のオブジェクトをリスト表示します
Expand
表2.7 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

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

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

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

Expand
表2.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

AlertmanagerList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
Alertmanager を作成する
Expand
表2.9 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表2.10 ボディーパラメーター
パラメーター説明

ボディー

Alertmanager スキーマ

 
Expand
表2.11 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Alertmanager スキーマ

201 - Created

Alertmanager スキーマ

202 - Accepted

Alertmanager スキーマ

401 - Unauthorized

空白

2.2.3. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/alertmanagers/{name}

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

name

string

Alertmanager の名前

namespace

string

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

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

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

dryRun

string

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

gracePeriodSeconds

integer

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

orphanDependents

boolean

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

propagationPolicy

string

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

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

body

DeleteOptions スキーマ

 
Expand
表2.16 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された Alertmanager を読み取ります
Expand
表2.17 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表2.18 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Alertmanager スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表2.20 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表2.21 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Alertmanager スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表2.23 ボディーパラメーター
パラメーター説明

ボディー

Alertmanager スキーマ

 
Expand
表2.24 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Alertmanager スキーマ

201 - Created

Alertmanager スキーマ

401 - Unauthorized

空白

第3章 AlertmanagerConfig [monitoring.coreos.com/v1beta1]

説明
AlertmanagerConfig は、1 つの Alertmanager クラスターを設定する複数の名前空間に集約される名前空間 AlertmanagerConfig を定義します。
タイプ
object
必須
  • 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

AlertmanagerConfigSpec は、Alertmanager 設定の望ましい動作の仕様です。定義上、Alertmanager 設定は、namespace ラベルが AlertmanagerConfig リソースの namespace と等しいアラートにのみ適用されます。

3.1.1. .spec

説明
AlertmanagerConfigSpec は、Alertmanager 設定の望ましい動作の仕様です。定義上、Alertmanager 設定は、namespace ラベルが AlertmanagerConfig リソースの namespace と等しいアラートにのみ適用されます。
object
Expand
プロパティー説明

inhibitRules

array

禁止ルールのリスト。ルールは、リソースの namespace に一致するアラートにのみ適用されます。

inhibitRules[]

object

InhibitRule は、他のアラートがすでに発生しているときにアラートをミュートできるようにする禁止ルールを定義します。https://prometheus.io/docs/alerting/latest/configuration/#inhibit_rule を参照してください

receivers

array

受信者のリスト。

receivers[]

object

Receiver は 1 つ以上の通知統合を定義します。

route

object

リソースの namespace に一致するアラートの Alertmanager ルート定義。存在する場合は、生成された Alertmanager 設定に第 1 レベルのルートとして追加されます。

timeIntervals

array

いつルートをミュートまたはアクティブにするかを指定する TimeInterval のリスト。

timeIntervals[]

object

TimeInterval は、通知をミュートまたはアクティブにする期間を指定します。

3.1.2. .spec.inhibitRules

説明
禁止ルールのリスト。ルールは、リソースの namespace に一致するアラートにのみ適用されます。
array

3.1.3. .spec.inhibitRules[]

説明
InhibitRule は、他のアラートがすでに発生しているときにアラートをミュートできるようにする禁止ルールを定義します。https://prometheus.io/docs/alerting/latest/configuration/#inhibit_rule を参照してください
object
Expand
プロパティー説明

equal

array (string)

抑制を有効にするには、ソースアラートとターゲットアラートで同じ値を持っている必要があるラベル。

sourceMatch

array

抑制を有効にするために 1 つ以上のアラートが存在する必要があるマッチャー。Operator は、アラートがリソースの namespace と一致することを強制します。

sourceMatch[]

object

マッチャーは、アラートのラベルを照合する方法を定義します。

targetMatch

array

ミュートするには、アラートで実行する必要のあるマッチャー。Operator は、アラートがリソースの namespace と一致することを強制します。

targetMatch[]

object

マッチャーは、アラートのラベルを照合する方法を定義します。

3.1.4. .spec.inhibitRules[].sourceMatch

説明
抑制を有効にするために 1 つ以上のアラートが存在する必要があるマッチャー。Operator は、アラートがリソースの namespace と一致することを強制します。
array

3.1.5. .spec.inhibitRules[].sourceMatch[]

説明
マッチャーは、アラートのラベルを照合する方法を定義します。
object
必須
  • name
Expand
プロパティー説明

matchType

string

一致 Operator。= (等しい)、!= (等しくない)、=~ (正規表現に一致)、! ~ (正規表現に一致しない) のいずれかです。ネガティブ Operator (!= および !~) には、Alertmanager v0.22.0 以降が必要です。

name

string

一致するラベル

value

string

一致するラベル値。

3.1.6. .spec.inhibitRules[].targetMatch

説明
ミュートするには、アラートで実行する必要のあるマッチャー。Operator は、アラートがリソースの namespace と一致することを強制します。
array

3.1.7. .spec.inhibitRules[].targetMatch[]

説明
マッチャーは、アラートのラベルを照合する方法を定義します。
object
必須
  • name
Expand
プロパティー説明

matchType

string

一致 Operator。= (等しい)、!= (等しくない)、=~ (正規表現に一致)、! ~ (正規表現に一致しない) のいずれかです。ネガティブ Operator (!= および !~) には、Alertmanager v0.22.0 以降が必要です。

name

string

一致するラベル

value

string

一致するラベル値。

3.1.8. .spec.receivers

説明
受信者のリスト。
array

3.1.9. .spec.receivers[]

説明
Receiver は 1 つ以上の通知統合を定義します。
object
必須
  • name
Expand
プロパティーDescription

emailConfigs

array

電子メール設定のリスト。

emailConfigs[]

object

EmailConfig は、E メールを介して通知を設定します。

name

string

受信者の名前。リストのすべてのアイテムで一意である必要があります。

opsgenieConfigs

array

OpsGenie 設定のリスト。

opsgenieConfigs[]

object

OpsGenieConfig は、OpsGenie を介して通知を設定します。See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config

pagerdutyConfigs

array

PagerDuty 設定のリスト。

pagerdutyConfigs[]

object

PagerDutyConfig は、PagerDuty を介して通知を設定します。See https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config

pushoverConfigs

array

プッシュオーバー設定のリスト。

pushoverConfigs[]

object

PushoverConfig は、Pushover を介して通知を設定します。See https://prometheus.io/docs/alerting/latest/configuration/#pushover_config

slackConfigs

array

Slack 設定のリスト。

slackConfigs[]

object

SlackConfig は、Slack を介して通知を設定します。See https://prometheus.io/docs/alerting/latest/configuration/#slack_config

snsConfigs

array

SNS 設定のリスト

snsConfigs[]

object

SNSConfig は AWS SNS 経由で通知を設定します。https://prometheus.io/docs/alerting/latest/configuration/#sns_configs を参照してください。

telegramConfigs

array

Telegram 設定のリスト。

telegramConfigs[]

object

TelegramConfig は Telegram 経由で通知を設定します。https://prometheus.io/docs/alerting/latest/configuration/#telegram_config を参照してください。

victoropsConfigs

array

VictorOps 設定のリスト。

victoropsConfigs[]

object

VictorOpsConfig は、VictorOps を介して通知を設定します。See https://prometheus.io/docs/alerting/latest/configuration/#victorops_config

webhookConfigs

array

Webhook 設定のリスト。

webhookConfigs[]

object

WebhookConfig は、Webhook ペイロードをサポートする汎用レシーバーを介して通知を設定します。See https://prometheus.io/docs/alerting/latest/configuration/#webhook_config

wechatConfigs

array

WeChat 設定のリスト。

wechatConfigs[]

object

WeChatConfig は、WeChat を介して通知を設定します。https://prometheus.io/docs/alerting/latest/configuration/#wechat_config を参照してください

3.1.10. .spec.receivers[].emailConfigs

説明
電子メール設定のリスト。
array

3.1.11. .spec.receivers[].emailConfigs[]

説明
EmailConfig は、E メールを介して通知を設定します。
object
Expand
プロパティー説明

authIdentity

string

認証に使用する ID。

authPassword

object

認証に使用するパスワードを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。

authSecret

object

CRAM-MD5 シークレットを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。

authUsername

string

認証に使用するユーザー名。

from

string

送信者アドレス。

headers

array

さらなるヘッダーは、ヘッダーのキーと値のペアを電子メールで送信します。通知の実装によって以前に設定されたヘッダーをオーバーライドします。

headers[]

object

KeyValue は、(キー、値) タプルを定義します。

hello

string

SMTP サーバーを識別するためのホスト名。

html

string

電子メール通知の HTML 本文。

requireTLS

boolean

SMTP TLS 要件。Go は、リモート SMTP エンドポイントへの暗号化されていない接続をサポートしていないことに注意してください。

sendResolved

boolean

解決されたアラートについて通知するかどうか。

smarthost

string

送信されたメールが通過する SMTP ホストとポート。例: example.com:25

text

string

電子メール通知の本文。

tlsConfig

object

TLS 設定

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

string

通知を送信するメールアドレスを追加します。

3.1.12. .spec.receivers[].emailConfigs[].authPassword

説明
認証に使用するパスワードを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。
object
必須
  • key
  • name
Expand
プロパティー説明

key

string

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

name

string

選択元となるオブジェクトの namespace 内にあるシークレットの名前。

3.1.13. .spec.receivers[].emailConfigs[].authSecret

説明
CRAM-MD5 シークレットを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。
object
必須
  • key
  • name
Expand
プロパティー説明

key

string

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

name

string

選択元となるオブジェクトの namespace 内にあるシークレットの名前。

3.1.14. .spec.receivers[].emailConfigs[].headers

説明
さらなるヘッダーは、ヘッダーのキーと値のペアを電子メールで送信します。通知の実装によって以前に設定されたヘッダーをオーバーライドします。
array

3.1.15. .spec.receivers[].emailConfigs[].headers[]

説明
KeyValue は、(キー、値) タプルを定義します。
object
必須
  • key
  • value
Expand
プロパティー説明

key

string

タプルのキー。

value

string

タプルの値。

3.1.16. .spec.receivers[].emailConfigs[].tlsConfig

説明
TLS 設定
object
Expand
プロパティー説明

ca

object

ターゲットに使用する CA 証明書を含む構造体。

cert

object

ターゲットのクライアント証明書ファイルを含む構造体。

insecureSkipVerify

boolean

ターゲット証明書の検証を無効にします。

keySecret

object

ターゲットのクライアントキーファイルを含むシークレット。

serverName

string

ターゲットのホスト名を確認するために使用されます。

3.1.17. .spec.receivers[].emailConfigs[].tlsConfig.ca

Description
ターゲットに使用する CA 証明書を含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.18. .spec.receivers[].emailConfigs[].tlsConfig.ca.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.19. .spec.receivers[].emailConfigs[].tlsConfig.ca.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.20. .spec.receivers[].emailConfigs[].tlsConfig.cert

Description
ターゲットのクライアント証明書ファイルを含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.21. .spec.receivers[].emailConfigs[].tlsConfig.cert.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.22. .spec.receivers[].emailConfigs[].tlsConfig.cert.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.23. .spec.receivers[].emailConfigs[].tlsConfig.keySecret

説明
ターゲットのクライアントキーファイルを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.24. .spec.receivers[].opsgenieConfigs

説明
OpsGenie 設定のリスト。
array

3.1.25. .spec.receivers[].opsgenieConfigs[]

説明
OpsGenieConfig は、OpsGenie を介して通知を設定します。See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config
object
Expand
プロパティー説明

アクション

string

アラートで使用できるアクションのコンマ区切りリスト。

apiKey

object

OpsGenie API キーを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。

apiURL

string

OpsGenie API リクエストを送信する URL。

description

string

インシデントの説明。

詳細

array

インシデントに関する詳細を提供する任意のキーと値のペアのセット。

details[]

object

KeyValue は、(キー、値) タプルを定義します。

entity

string

どのドメインアラートが関連しているかを指定するために使用できるオプションのフィールド。

httpConfig

object

HTTP クライアント設定

message

string

アラートテキストは 130 文字に制限されています。

note

string

追加のアラートノート。

priority

string

アラートの優先度。可能な値は、P1、P2、P3、P4、および P5 です。

responders

array

通知を担当するレスポンダーのリスト。

responders[]

object

OpsGenieConfigResponder は、インシデントへのレスポンダーを定義します。idname、または username のいずれかを定義する必要があります。

sendResolved

boolean

解決されたアラートについて通知するかどうか。

source

string

通知の送信者へのバックリンク。

tags

string

通知に添付されたタグのコンマ区切りリスト。

3.1.26. .spec.receivers[].opsgenieConfigs[].apiKey

説明
OpsGenie API キーを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。
object
必須
  • key
  • name
Expand
プロパティー説明

key

string

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

name

string

選択元となるオブジェクトの namespace 内にあるシークレットの名前。

3.1.27. .spec.receivers[].opsgenieConfigs[].details

説明
インシデントに関する詳細を提供する任意のキーと値のペアのセット。
array

3.1.28. .spec.receivers[].opsgenieConfigs[].details[]

説明
KeyValue は、(キー、値) タプルを定義します。
object
必須
  • key
  • value
Expand
プロパティー説明

key

string

タプルのキー。

value

string

タプルの値。

3.1.29. .spec.receivers[].opsgenieConfigs[].httpConfig

説明
HTTP クライアント設定
object
Expand
プロパティー説明

authorization

object

クライアントの認証ヘッダー設定。これは BasicAuth と相互に排他的であり、Alertmanagerv0.22+ 以降でのみ使用できます。

basicAuth

object

クライアントの BasicAuth。これは、承認と相互に排他的です。両方が定義されている場合、BasicAuth が優先されます。

bearerTokenSecret

object

クライアントが認証に使用するベアラートークンを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。

followRedirects

boolean

FollowRedirects は、クライアントが HTTP 3xx リダイレクトに従うかどうかを指定します。

oauth2

object

ターゲットのトークンを取得するために使用される OAuth2 クライアント認証情報。

proxyURL

string

オプションのプロキシー URL。

tlsConfig

object

クライアントの TLS 設定。

3.1.30. .spec.receivers[].opsgenieConfigs[].httpConfig.authorization

説明
クライアントの認証ヘッダー設定。これは BasicAuth と相互に排他的であり、Alertmanagerv0.22+ 以降でのみ使用できます。
object
Expand
プロパティー説明

credentials

object

リクエストのクレデンシャルを含むシークレットのキー

type

string

認証タイプを設定します。デフォルトは Bearer で、Basic はエラーを引き起こします

3.1.31. .spec.receivers[].opsgenieConfigs[].httpConfig.authorization.credentials

Description
リクエストのクレデンシャルを含むシークレットのキー
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.32. .spec.receivers[].opsgenieConfigs[].httpConfig.basicAuth

説明
クライアントの BasicAuth。これは、承認と相互に排他的です。両方が定義されている場合、BasicAuth が優先されます。
object
Expand
プロパティー説明

password

object

認証用のパスワードを含むサービスモニター名前空間のシークレット。

username

object

認証用のユーザー名を含むサービスモニター名前空間のシークレット。

3.1.33. .spec.receivers[].opsgenieConfigs[].httpConfig.basicAuth.password

Description
認証用のパスワードを含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.34. .spec.receivers[].opsgenieConfigs[].httpConfig.basicAuth.username

Description
認証用のユーザー名を含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.35. .spec.receivers[].opsgenieConfigs[].httpConfig.bearerTokenSecret

説明
クライアントが認証に使用するベアラートークンを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。
object
必須
  • key
  • name
Expand
プロパティー説明

key

string

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

name

string

選択元となるオブジェクトの namespace 内にあるシークレットの名前。

3.1.36. .spec.receivers[].opsgenieConfigs[].httpConfig.oauth2

説明
ターゲットのトークンを取得するために使用される OAuth2 クライアント認証情報。
object
必須
  • clientId
  • clientSecret
  • tokenUrl
Expand
プロパティー説明

clientId

object

OAuth2 クライアント ID を含むシークレットまたは設定マップ

clientSecret

object

OAuth2 クライアントシークレットを含むシークレット

endpointParams

object (string)

トークン URL に追加するパラメーター

scopes

array (string)

トークンリクエストに使用される OAuth2 スコープ

tokenUrl

string

トークンをフェッチする URL

3.1.37. .spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.clientId

説明
OAuth2 クライアント ID を含むシークレットまたは設定マップ
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.38. .spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.clientId.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.39. .spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.clientId.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.40. .spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.clientSecret

説明
OAuth2 クライアントシークレットを含むシークレット
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.41. .spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig

説明
クライアントの TLS 設定。
object
Expand
プロパティー説明

ca

object

ターゲットに使用する CA 証明書を含む構造体。

cert

object

ターゲットのクライアント証明書ファイルを含む構造体。

insecureSkipVerify

boolean

ターゲット証明書の検証を無効にします。

keySecret

object

ターゲットのクライアントキーファイルを含むシークレット。

serverName

string

ターゲットのホスト名を確認するために使用されます。

3.1.42. .spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.ca

Description
ターゲットに使用する CA 証明書を含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.43. .spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.ca.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.44. .spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.ca.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.45. .spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.cert

Description
ターゲットのクライアント証明書ファイルを含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.46. .spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.cert.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.47. .spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.cert.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.48. .spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.keySecret

説明
ターゲットのクライアントキーファイルを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.49. .spec.receivers[].opsgenieConfigs[].responders

説明
通知を担当するレスポンダーのリスト。
array

3.1.50. .spec.receivers[].opsgenieConfigs[].responders[]

説明
OpsGenieConfigResponder は、インシデントへのレスポンダーを定義します。idname、または username のいずれかを定義する必要があります。
object
必須
  • type
Expand
プロパティー説明

id

string

レスポンダーの ID。

name

string

レスポンダーの名前。

type

string

レスポンダーのタイプ。

username

string

レスポンダーのユーザー名。

3.1.51. .spec.receivers[].pagerdutyConfigs

説明
PagerDuty 設定のリスト。
array

3.1.52. .spec.receivers[].pagerdutyConfigs[]

説明
PagerDutyConfig は、PagerDuty を介して通知を設定します。See https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config
object
Expand
プロパティー説明

class

string

イベントのクラス/タイプ。

client

string

クライアントの識別。

clientURL

string

通知の送信者への被リンク。

component

string

影響を受けるシステムの壊れている部分またはコンポーネント。

description

string

インシデントの説明。

詳細

array

インシデントに関する詳細を提供する任意のキーと値のペア。

details[]

object

KeyValue は、(キー、値) タプルを定義します。

group

string

ソースのクラスターまたはグループ。

httpConfig

object

HTTP クライアント設定

pagerDutyImageConfigs

array

アタッチするイメージ詳細リスト。インシデントに関する詳細情報を提供します。

pagerDutyImageConfigs[]

object

PagerDutyImageConfig はインシデントにイメージをアタッチします

pagerDutyLinkConfigs

array

アタッチするリンク詳細リスト。インシデントに関する詳細情報を提供します。

pagerDutyLinkConfigs[]

object

PagerDutyLinkConfig はインシデントにテキストリンクをアタッチします

routingKey

object

PagerDuty 統合キーを含むシークレットのキー (Events API v2 を使用する場合)。このフィールドまたは serviceKey のいずれかを定義する必要があります。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。

sendResolved

boolean

解決されたアラートについて通知するかどうか。

serviceKey

object

PagerDuty サービスキーを含むシークレットのキー (統合タイプ "Prometheus" を使用する場合)。このフィールドまたは routingKey のいずれかを定義する必要があります。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。

severity

string

インシデントの重大度。

url

string

リクエストを送信する URL。

3.1.53. .spec.receivers[].pagerdutyConfigs[].details

説明
インシデントに関する詳細を提供する任意のキーと値のペア。
array

3.1.54. .spec.receivers[].pagerdutyConfigs[].details[]

説明
KeyValue は、(キー、値) タプルを定義します。
object
必須
  • key
  • value
Expand
プロパティー説明

key

string

タプルのキー。

value

string

タプルの値。

3.1.55. .spec.receivers[].pagerdutyConfigs[].httpConfig

説明
HTTP クライアント設定
object
Expand
プロパティー説明

authorization

object

クライアントの認証ヘッダー設定。これは BasicAuth と相互に排他的であり、Alertmanagerv0.22+ 以降でのみ使用できます。

basicAuth

object

クライアントの BasicAuth。これは、承認と相互に排他的です。両方が定義されている場合、BasicAuth が優先されます。

bearerTokenSecret

object

クライアントが認証に使用するベアラートークンを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。

followRedirects

boolean

FollowRedirects は、クライアントが HTTP 3xx リダイレクトに従うかどうかを指定します。

oauth2

object

ターゲットのトークンを取得するために使用される OAuth2 クライアント認証情報。

proxyURL

string

オプションのプロキシー URL。

tlsConfig

object

クライアントの TLS 設定。

3.1.56. .spec.receivers[].pagerdutyConfigs[].httpConfig.authorization

説明
クライアントの認証ヘッダー設定。これは BasicAuth と相互に排他的であり、Alertmanagerv0.22+ 以降でのみ使用できます。
object
Expand
プロパティー説明

credentials

object

リクエストのクレデンシャルを含むシークレットのキー

type

string

認証タイプを設定します。デフォルトは Bearer で、Basic はエラーを引き起こします

3.1.57. .spec.receivers[].pagerdutyConfigs[].httpConfig.authorization.credentials

Description
リクエストのクレデンシャルを含むシークレットのキー
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.58. .spec.receivers[].pagerdutyConfigs[].httpConfig.basicAuth

説明
クライアントの BasicAuth。これは、承認と相互に排他的です。両方が定義されている場合、BasicAuth が優先されます。
object
Expand
プロパティー説明

password

object

認証用のパスワードを含むサービスモニター名前空間のシークレット。

username

object

認証用のユーザー名を含むサービスモニター名前空間のシークレット。

3.1.59. .spec.receivers[].pagerdutyConfigs[].httpConfig.basicAuth.password

Description
認証用のパスワードを含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.60. .spec.receivers[].pagerdutyConfigs[].httpConfig.basicAuth.username

Description
認証用のユーザー名を含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.61. .spec.receivers[].pagerdutyConfigs[].httpConfig.bearerTokenSecret

説明
クライアントが認証に使用するベアラートークンを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。
object
必須
  • key
  • name
Expand
プロパティー説明

key

string

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

name

string

選択元となるオブジェクトの namespace 内にあるシークレットの名前。

3.1.62. .spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2

説明
ターゲットのトークンを取得するために使用される OAuth2 クライアント認証情報。
object
必須
  • clientId
  • clientSecret
  • tokenUrl
Expand
プロパティー説明

clientId

object

OAuth2 クライアント ID を含むシークレットまたは設定マップ

clientSecret

object

OAuth2 クライアントシークレットを含むシークレット

endpointParams

object (string)

トークン URL に追加するパラメーター

scopes

array (string)

トークンリクエストに使用される OAuth2 スコープ

tokenUrl

string

トークンをフェッチする URL

3.1.63. .spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.clientId

説明
OAuth2 クライアント ID を含むシークレットまたは設定マップ
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.64. .spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.clientId.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.65. .spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.clientId.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.66. .spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.clientSecret

説明
OAuth2 クライアントシークレットを含むシークレット
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.67. .spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig

説明
クライアントの TLS 設定。
object
Expand
プロパティー説明

ca

object

ターゲットに使用する CA 証明書を含む構造体。

cert

object

ターゲットのクライアント証明書ファイルを含む構造体。

insecureSkipVerify

boolean

ターゲット証明書の検証を無効にします。

keySecret

object

ターゲットのクライアントキーファイルを含むシークレット。

serverName

string

ターゲットのホスト名を確認するために使用されます。

3.1.68. .spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.ca

Description
ターゲットに使用する CA 証明書を含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.69. .spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.ca.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.70. .spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.ca.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.71. .spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.cert

Description
ターゲットのクライアント証明書ファイルを含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.72. .spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.cert.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.73. .spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.cert.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.74. .spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.keySecret

説明
ターゲットのクライアントキーファイルを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.75. .spec.receivers[].pagerdutyConfigs[].pagerDutyImageConfigs

説明
アタッチするイメージ詳細リスト。インシデントに関する詳細情報を提供します。
array

3.1.76. .spec.receivers[].pagerdutyConfigs[].pagerDutyImageConfigs[]

説明
PagerDutyImageConfig はインシデントにイメージをアタッチします
object
Expand
プロパティー説明

alt

string

alt はイメージのオプションの代替テキストです。

href

string

オプションの URL。イメージをクリック可能なリンクにします。

src

string

インシデントにアタッチされているイメージの src

3.1.77. .spec.receivers[].pagerdutyConfigs[].pagerDutyLinkConfigs

説明
アタッチするリンク詳細リスト。インシデントに関する詳細情報を提供します。
array

3.1.78. .spec.receivers[].pagerdutyConfigs[].pagerDutyLinkConfigs[]

説明
PagerDutyLinkConfig はインシデントにテキストリンクをアタッチします
object
Expand
プロパティー説明

alt

string

リンクの目的を説明するテキスト。リンクのテキストとして使用できます。

href

string

Href はアタッチするリンクの URL です

3.1.79. .spec.receivers[].pagerdutyConfigs[].routingKey

説明
PagerDuty 統合キーを含むシークレットのキー (Events API v2 を使用する場合)。このフィールドまたは serviceKey のいずれかを定義する必要があります。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。
object
必須
  • key
  • name
Expand
プロパティー説明

key

string

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

name

string

選択元となるオブジェクトの namespace 内にあるシークレットの名前。

3.1.80. .spec.receivers[].pagerdutyConfigs[].serviceKey

説明
PagerDuty サービスキーを含むシークレットのキー (統合タイプ "Prometheus" を使用する場合)。このフィールドまたは routingKey のいずれかを定義する必要があります。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。
object
必須
  • key
  • name
Expand
プロパティー説明

key

string

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

name

string

選択元となるオブジェクトの namespace 内にあるシークレットの名前。

3.1.81. .spec.receivers[].pushoverConfigs

説明
プッシュオーバー設定のリスト。
array

3.1.82. .spec.receivers[].pushoverConfigs[]

説明
PushoverConfig は、Pushover を介して通知を設定します。See https://prometheus.io/docs/alerting/latest/configuration/#pushover_config
object
Expand
プロパティーDescription

expire

string

ユーザーが通知を承認しない限り、通知が再試行され続ける期間。

html

boolean

通知メッセージが HTML かプレーンテキストか。

httpConfig

object

HTTP クライアント設定

message

string

通知メッセージ。

priority

string

優先度、https://pushover.net/api#priority を参照

retry

string

プッシュオーバーサーバーが同じ通知をユーザーに送信する頻度。30 秒以上である必要があります。

sendResolved

boolean

解決されたアラートについて通知するかどうか。

sound

string

ユーザーのデフォルトのサウンド選択を上書きするためにデバイスクライアントによってサポートされるサウンドの 1 つの名前

title

string

通知のタイトル。

token

object

登録されたアプリケーションの API トークンを含むシークレットのキー 。https://pushover.net/apps を参照してください。シークレットは、AlertmanagerConfig オブジェクトと同じ名前空間にあり、PrometheusOperator からアクセスできる必要があります。

url

string

メッセージの横に表示される補足 URL。

urlTitle

string

補足 URL のタイトル、それ以外の場合は URL のみが表示されます

userKey

object

受信者ユーザーのユーザーキーを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ名前空間にあり、PrometheusOperator からアクセスできる必要があります。

3.1.83. .spec.receivers[].pushoverConfigs[].httpConfig

説明
HTTP クライアント設定
object
Expand
プロパティー説明

authorization

object

クライアントの認証ヘッダー設定。これは BasicAuth と相互に排他的であり、Alertmanagerv0.22+ 以降でのみ使用できます。

basicAuth

object

クライアントの BasicAuth。これは、承認と相互に排他的です。両方が定義されている場合、BasicAuth が優先されます。

bearerTokenSecret

object

クライアントが認証に使用するベアラートークンを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。

followRedirects

boolean

FollowRedirects は、クライアントが HTTP 3xx リダイレクトに従うかどうかを指定します。

oauth2

object

ターゲットのトークンを取得するために使用される OAuth2 クライアント認証情報。

proxyURL

string

オプションのプロキシー URL。

tlsConfig

object

クライアントの TLS 設定。

3.1.84. .spec.receivers[].pushoverConfigs[].httpConfig.authorization

説明
クライアントの認証ヘッダー設定。これは BasicAuth と相互に排他的であり、Alertmanagerv0.22+ 以降でのみ使用できます。
object
Expand
プロパティー説明

credentials

object

リクエストのクレデンシャルを含むシークレットのキー

type

string

認証タイプを設定します。デフォルトは Bearer で、Basic はエラーを引き起こします

3.1.85. .spec.receivers[].pushoverConfigs[].httpConfig.authorization.credentials

Description
リクエストのクレデンシャルを含むシークレットのキー
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.86. .spec.receivers[].pushoverConfigs[].httpConfig.basicAuth

説明
クライアントの BasicAuth。これは、承認と相互に排他的です。両方が定義されている場合、BasicAuth が優先されます。
object
Expand
プロパティー説明

password

object

認証用のパスワードを含むサービスモニター名前空間のシークレット。

username

object

認証用のユーザー名を含むサービスモニター名前空間のシークレット。

3.1.87. .spec.receivers[].pushoverConfigs[].httpConfig.basicAuth.password

Description
認証用のパスワードを含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.88. .spec.receivers[].pushoverConfigs[].httpConfig.basicAuth.username

Description
認証用のユーザー名を含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.89. .spec.receivers[].pushoverConfigs[].httpConfig.bearerTokenSecret

説明
クライアントが認証に使用するベアラートークンを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。
object
必須
  • key
  • name
Expand
プロパティー説明

key

string

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

name

string

選択元となるオブジェクトの namespace 内にあるシークレットの名前。

3.1.90. .spec.receivers[].pushoverConfigs[].httpConfig.oauth2

説明
ターゲットのトークンを取得するために使用される OAuth2 クライアント認証情報。
object
必須
  • clientId
  • clientSecret
  • tokenUrl
Expand
プロパティー説明

clientId

object

OAuth2 クライアント ID を含むシークレットまたは設定マップ

clientSecret

object

OAuth2 クライアントシークレットを含むシークレット

endpointParams

object (string)

トークン URL に追加するパラメーター

scopes

array (string)

トークンリクエストに使用される OAuth2 スコープ

tokenUrl

string

トークンをフェッチする URL

3.1.91. .spec.receivers[].pushoverConfigs[].httpConfig.oauth2.clientId

説明
OAuth2 クライアント ID を含むシークレットまたは設定マップ
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.92. .spec.receivers[].pushoverConfigs[].httpConfig.oauth2.clientId.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.93. .spec.receivers[].pushoverConfigs[].httpConfig.oauth2.clientId.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.94. .spec.receivers[].pushoverConfigs[].httpConfig.oauth2.clientSecret

説明
OAuth2 クライアントシークレットを含むシークレット
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.95. .spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig

説明
クライアントの TLS 設定。
object
Expand
プロパティー説明

ca

object

ターゲットに使用する CA 証明書を含む構造体。

cert

object

ターゲットのクライアント証明書ファイルを含む構造体。

insecureSkipVerify

boolean

ターゲット証明書の検証を無効にします。

keySecret

object

ターゲットのクライアントキーファイルを含むシークレット。

serverName

string

ターゲットのホスト名を確認するために使用されます。

3.1.96. .spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.ca

Description
ターゲットに使用する CA 証明書を含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.97. .spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.ca.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.98. .spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.ca.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.99. .spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.cert

Description
ターゲットのクライアント証明書ファイルを含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.100. .spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.cert.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.101. .spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.cert.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.102. .spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.keySecret

説明
ターゲットのクライアントキーファイルを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.103. .spec.receivers[].pushoverConfigs[].token

説明
登録されたアプリケーションの API トークンを含むシークレットのキー 。https://pushover.net/apps を参照してください。シークレットは、AlertmanagerConfig オブジェクトと同じ名前空間にあり、PrometheusOperator からアクセスできる必要があります。
object
必須
  • key
  • name
Expand
プロパティー説明

key

string

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

name

string

選択元となるオブジェクトの namespace 内にあるシークレットの名前。

3.1.104. .spec.receivers[].pushoverConfigs[].userKey

説明
受信者ユーザーのユーザーキーを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ名前空間にあり、PrometheusOperator からアクセスできる必要があります。
object
必須
  • key
  • name
Expand
プロパティー説明

key

string

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

name

string

選択元となるオブジェクトの namespace 内にあるシークレットの名前。

3.1.105. .spec.receivers[].slackConfigs

説明
Slack 設定のリスト。
array

3.1.106. .spec.receivers[].slackConfigs[]

説明
SlackConfig は、Slack を介して通知を設定します。See https://prometheus.io/docs/alerting/latest/configuration/#slack_config
object
Expand
プロパティー説明

actions

array

各通知とともに送信される Slack アクションのリスト。

actions[]

object

SlackAction は、通知ごとに送信される単一の Slack アクションを設定します。詳細については、https://api.slack.com/docs/message-attachments#action_fields および https://api.slack.com/docs/message-buttons を参照してください。

apiURL

object

Slack Webhook URL を含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。

callbackId

string

 

channel

string

通知を送信するチャネルまたはユーザー。

color

string

 

fallback

string

 

fields

array

各通知で送信される Slack フィールドのリスト。

fields[]

object

SlackField は、通知ごとに送信される単一の Slack フィールドを設定します。各フィールドには、タイトル、値、およびオプションで、そのフィールドが short として指定された他のフィールドの横に表示されるのに十分短いかどうかを示すブール値が含まれている必要があります。詳細については、https://api.slack.com/docs/message-attachments#fields を参照してください。

footer

string

 

httpConfig

object

HTTP クライアント設定

iconEmoji

string

 

iconURL

string

 

imageURL

string

 

linkNames

boolean

 

mrkdwnIn

array (string)

 

pretext

string

 

sendResolved

boolean

解決されたアラートについて通知するかどうか。

shortFields

boolean

 

text

string

 

thumbURL

string

 

title

string

 

titleLink

string

 

username

string

 

3.1.107. .spec.receivers[].slackConfigs[].actions

説明
各通知とともに送信される Slack アクションのリスト。
array

3.1.108. .spec.receivers[].slackConfigs[].actions[]

説明
SlackAction は、通知ごとに送信される単一の Slack アクションを設定します。詳細については、https://api.slack.com/docs/message-attachments#action_fields および https://api.slack.com/docs/message-buttons を参照してください。
object
必須
  • text
  • type
Expand
プロパティー説明

confirm

object

SlackConfirmationField は、ボタンのクリックをもう一度確認するようにユーザーに求めることで、破壊的なアクションや特に際立った決定からユーザーを保護します。詳細については、https://api.slack.com/docs/interactive-message-field-guide#confirmation_fields を参照してください。

name

string

 

style

string

 

text

string

 

type

string

 

url

string

 

value

string

 

3.1.109. .spec.receivers[].slackConfigs[].actions[].confirm

説明
SlackConfirmationField は、ボタンのクリックをもう一度確認するようにユーザーに求めることで、破壊的なアクションや特に際立った決定からユーザーを保護します。詳細については、https://api.slack.com/docs/interactive-message-field-guide#confirmation_fields を参照してください。
object
必須
  • text
Expand
プロパティー説明

dismissText

string

 

okText

string

 

text

string

 

title

string

 

3.1.110. .spec.receivers[].slackConfigs[].apiURL

説明
Slack Webhook URL を含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。
object
必須
  • key
  • name
Expand
プロパティー説明

key

string

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

name

string

選択元となるオブジェクトの namespace 内にあるシークレットの名前。

3.1.111. .spec.receivers[].slackConfigs[].fields

説明
各通知で送信される Slack フィールドのリスト。
array

3.1.112. .spec.receivers[].slackConfigs[].fields[]

説明
SlackField は、通知ごとに送信される単一の Slack フィールドを設定します。各フィールドには、タイトル、値、およびオプションで、そのフィールドが short として指定された他のフィールドの横に表示されるのに十分短いかどうかを示すブール値が含まれている必要があります。詳細については、https://api.slack.com/docs/message-attachments#fields を参照してください。
object
必須
  • title
  • value
Expand
プロパティー説明

short

boolean

 

title

string

 

value

string

 

3.1.113. .spec.receivers[].slackConfigs[].httpConfig

説明
HTTP クライアント設定
object
Expand
プロパティー説明

authorization

object

クライアントの認証ヘッダー設定。これは BasicAuth と相互に排他的であり、Alertmanagerv0.22+ 以降でのみ使用できます。

basicAuth

object

クライアントの BasicAuth。これは、承認と相互に排他的です。両方が定義されている場合、BasicAuth が優先されます。

bearerTokenSecret

object

クライアントが認証に使用するベアラートークンを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。

followRedirects

boolean

FollowRedirects は、クライアントが HTTP 3xx リダイレクトに従うかどうかを指定します。

oauth2

object

ターゲットのトークンを取得するために使用される OAuth2 クライアント認証情報。

proxyURL

string

オプションのプロキシー URL。

tlsConfig

object

クライアントの TLS 設定。

3.1.114. .spec.receivers[].slackConfigs[].httpConfig.authorization

説明
クライアントの認証ヘッダー設定。これは BasicAuth と相互に排他的であり、Alertmanagerv0.22+ 以降でのみ使用できます。
object
Expand
プロパティー説明

credentials

object

リクエストのクレデンシャルを含むシークレットのキー

type

string

認証タイプを設定します。デフォルトは Bearer で、Basic はエラーを引き起こします

3.1.115. .spec.receivers[].slackConfigs[].httpConfig.authorization.credentials

Description
リクエストのクレデンシャルを含むシークレットのキー
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.116. .spec.receivers[].slackConfigs[].httpConfig.basicAuth

説明
クライアントの BasicAuth。これは、承認と相互に排他的です。両方が定義されている場合、BasicAuth が優先されます。
object
Expand
プロパティー説明

password

object

認証用のパスワードを含むサービスモニター名前空間のシークレット。

username

object

認証用のユーザー名を含むサービスモニター名前空間のシークレット。

3.1.117. .spec.receivers[].slackConfigs[].httpConfig.basicAuth.password

Description
認証用のパスワードを含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.118. .spec.receivers[].slackConfigs[].httpConfig.basicAuth.username

Description
認証用のユーザー名を含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.119. .spec.receivers[].slackConfigs[].httpConfig.bearerTokenSecret

説明
クライアントが認証に使用するベアラートークンを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。
object
必須
  • key
  • name
Expand
プロパティー説明

key

string

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

name

string

選択元となるオブジェクトの namespace 内にあるシークレットの名前。

3.1.120. .spec.receivers[].slackConfigs[].httpConfig.oauth2

説明
ターゲットのトークンを取得するために使用される OAuth2 クライアント認証情報。
object
必須
  • clientId
  • clientSecret
  • tokenUrl
Expand
プロパティー説明

clientId

object

OAuth2 クライアント ID を含むシークレットまたは設定マップ

clientSecret

object

OAuth2 クライアントシークレットを含むシークレット

endpointParams

object (string)

トークン URL に追加するパラメーター

scopes

array (string)

トークンリクエストに使用される OAuth2 スコープ

tokenUrl

string

トークンをフェッチする URL

3.1.121. .spec.receivers[].slackConfigs[].httpConfig.oauth2.clientId

説明
OAuth2 クライアント ID を含むシークレットまたは設定マップ
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.122. .spec.receivers[].slackConfigs[].httpConfig.oauth2.clientId.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.123. .spec.receivers[].slackConfigs[].httpConfig.oauth2.clientId.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.124. .spec.receivers[].slackConfigs[].httpConfig.oauth2.clientSecret

説明
OAuth2 クライアントシークレットを含むシークレット
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.125. .spec.receivers[].slackConfigs[].httpConfig.tlsConfig

説明
クライアントの TLS 設定。
object
Expand
プロパティー説明

ca

object

ターゲットに使用する CA 証明書を含む構造体。

cert

object

ターゲットのクライアント証明書ファイルを含む構造体。

insecureSkipVerify

boolean

ターゲット証明書の検証を無効にします。

keySecret

object

ターゲットのクライアントキーファイルを含むシークレット。

serverName

string

ターゲットのホスト名を確認するために使用されます。

3.1.126. .spec.receivers[].slackConfigs[].httpConfig.tlsConfig.ca

Description
ターゲットに使用する CA 証明書を含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.127. .spec.receivers[].slackConfigs[].httpConfig.tlsConfig.ca.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.128. .spec.receivers[].slackConfigs[].httpConfig.tlsConfig.ca.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.129. .spec.receivers[].slackConfigs[].httpConfig.tlsConfig.cert

Description
ターゲットのクライアント証明書ファイルを含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.130. .spec.receivers[].slackConfigs[].httpConfig.tlsConfig.cert.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.131. .spec.receivers[].slackConfigs[].httpConfig.tlsConfig.cert.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.132. .spec.receivers[].slackConfigs[].httpConfig.tlsConfig.keySecret

説明
ターゲットのクライアントキーファイルを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.133. .spec.receivers[].snsConfigs

説明
SNS 設定のリスト
array

3.1.134. .spec.receivers[].snsConfigs[]

説明
SNSConfig は AWS SNS 経由で通知を設定します。https://prometheus.io/docs/alerting/latest/configuration/#sns_configs を参照してください。
object
Expand
プロパティー説明

apiURL

string

SNS API URL (https://sns.us-east-2.amazonaws.com)。指定しない場合は、SNS SDK の SNS API URL が使用されます。

attributes

object (string)

SNS メッセージの属性。

httpConfig

object

HTTP クライアント設定

message

string

SNS 通知のメッセージ内容。

phoneNumber

string

メッセージが SMS を介して E.164 形式で送信される場合の電話番号。この値を指定しない場合は、TopicARN または TargetARN の値を指定する必要があります。

sendResolved

boolean

解決されたアラートについて通知するかどうか。

sigv4

object

リクエストに署名するために使用する AWS の Signature Verification 4 署名プロセスを設定します。

サブジェクト (subject)

string

メールエンドポイントに送信されるメッセージの件名。

targetARN

string

メッセージがモバイル通知経由で送信される場合のモバイルプラットフォームエンドポイント ARN。この値を指定しない場合は、topic_arn または PhoneNumber の値を指定する必要があります。

topicARN

string

SNS トピック ARN (arn:aws:sns:us-east-2:698519295917:My-Topic)。この値を指定しない場合は、PhoneNumber または TargetARN の値を指定する必要があります。

3.1.135. .spec.receivers[].snsConfigs[].httpConfig

説明
HTTP クライアント設定
object
Expand
プロパティー説明

authorization

object

クライアントの認証ヘッダー設定。これは BasicAuth と相互に排他的であり、Alertmanagerv0.22+ 以降でのみ使用できます。

basicAuth

object

クライアントの BasicAuth。これは、承認と相互に排他的です。両方が定義されている場合、BasicAuth が優先されます。

bearerTokenSecret

object

クライアントが認証に使用するベアラートークンを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。

followRedirects

boolean

FollowRedirects は、クライアントが HTTP 3xx リダイレクトに従うかどうかを指定します。

oauth2

object

ターゲットのトークンを取得するために使用される OAuth2 クライアント認証情報。

proxyURL

string

オプションのプロキシー URL。

tlsConfig

object

クライアントの TLS 設定。

3.1.136. .spec.receivers[].snsConfigs[].httpConfig.authorization

説明
クライアントの認証ヘッダー設定。これは BasicAuth と相互に排他的であり、Alertmanagerv0.22+ 以降でのみ使用できます。
object
Expand
プロパティー説明

credentials

object

リクエストのクレデンシャルを含むシークレットのキー

type

string

認証タイプを設定します。デフォルトは Bearer で、Basic はエラーを引き起こします

3.1.137. .spec.receivers[].snsConfigs[].httpConfig.authorization.credentials

説明
リクエストのクレデンシャルを含むシークレットのキー
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.138. .spec.receivers[].snsConfigs[].httpConfig.basicAuth

説明
クライアントの BasicAuth。これは、承認と相互に排他的です。両方が定義されている場合、BasicAuth が優先されます。
object
Expand
プロパティー説明

password

object

認証用のパスワードを含むサービスモニター名前空間のシークレット。

username

object

認証用のユーザー名を含むサービスモニター名前空間のシークレット。

3.1.139. .spec.receivers[].snsConfigs[].httpConfig.basicAuth.password

説明
認証用のパスワードを含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.140. .spec.receivers[].snsConfigs[].httpConfig.basicAuth.username

説明
認証用のユーザー名を含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.141. .spec.receivers[].snsConfigs[].httpConfig.bearerTokenSecret

説明
クライアントが認証に使用するベアラートークンを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。
object
必須
  • key
  • name
Expand
プロパティー説明

key

string

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

name

string

選択元となるオブジェクトの namespace 内にあるシークレットの名前。

3.1.142. .spec.receivers[].snsConfigs[].httpConfig.oauth2

説明
ターゲットのトークンを取得するために使用される OAuth2 クライアント認証情報。
object
必須
  • clientId
  • clientSecret
  • tokenUrl
Expand
プロパティー説明

clientId

object

OAuth2 クライアント ID を含むシークレットまたは設定マップ

clientSecret

object

OAuth2 クライアントシークレットを含むシークレット

endpointParams

object (string)

トークン URL に追加するパラメーター

scopes

array (string)

トークンリクエストに使用される OAuth2 スコープ

tokenUrl

string

トークンをフェッチする URL

3.1.143. .spec.receivers[].snsConfigs[].httpConfig.oauth2.clientId

説明
OAuth2 クライアント ID を含むシークレットまたは設定マップ
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.144. .spec.receivers[].snsConfigs[].httpConfig.oauth2.clientId.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.145. .spec.receivers[].snsConfigs[].httpConfig.oauth2.clientId.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.146. .spec.receivers[].snsConfigs[].httpConfig.oauth2.clientSecret

説明
OAuth2 クライアントシークレットを含むシークレット
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.147. .spec.receivers[].snsConfigs[].httpConfig.tlsConfig

説明
クライアントの TLS 設定。
object
Expand
プロパティー説明

ca

object

ターゲットに使用する CA 証明書を含む構造体。

cert

object

ターゲットのクライアント証明書ファイルを含む構造体。

insecureSkipVerify

boolean

ターゲット証明書の検証を無効にします。

keySecret

object

ターゲットのクライアントキーファイルを含むシークレット。

serverName

string

ターゲットのホスト名を確認するために使用されます。

3.1.148. .spec.receivers[].snsConfigs[].httpConfig.tlsConfig.ca

説明
ターゲットに使用する CA 証明書を含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.149. .spec.receivers[].snsConfigs[].httpConfig.tlsConfig.ca.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.150. .spec.receivers[].snsConfigs[].httpConfig.tlsConfig.ca.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.151. .spec.receivers[].snsConfigs[].httpConfig.tlsConfig.cert

説明
ターゲットのクライアント証明書ファイルを含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.152. .spec.receivers[].snsConfigs[].httpConfig.tlsConfig.cert.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.153. .spec.receivers[].snsConfigs[].httpConfig.tlsConfig.cert.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.154. .spec.receivers[].snsConfigs[].httpConfig.tlsConfig.keySecret

説明
ターゲットのクライアントキーファイルを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.155. .spec.receivers[].snsConfigs[].sigv4

説明
リクエストに署名するために使用する AWS の Signature Verification 4 署名プロセスを設定します。
object
Expand
プロパティー説明

accessKey

object

AccessKey は AWS API キーです。空欄にした場合には、環境変数 AWS_ACCESS_KEY_ID が使用されます。

profile

string

profile は、認証に使用される名前付き AWS プロファイルです。

region

string

region は AWS リージョンです。空白の場合は、デフォルトの認証情報チェーンのリージョンが使用されます。

roleArn

string

roleArn は、認証に使用される名前付き AWS プロファイルです。

secretKey

object

secretKey は AWS API シークレットです。空欄にした場合には、環境変数 AWS_SECRET_ACCESS_KEY が使用されます。

3.1.156. .spec.receivers[].snsConfigs[].sigv4.accessKey

説明
AccessKey は AWS API キーです。空欄にした場合には、環境変数 AWS_ACCESS_KEY_ID が使用されます。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.157. .spec.receivers[].snsConfigs[].sigv4.secretKey

説明
secretKey は AWS API シークレットです。空欄にした場合には、環境変数 AWS_SECRET_ACCESS_KEY が使用されます。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.158. .spec.receivers[].telegramConfigs

説明
Telegram 設定のリスト。
array

3.1.159. .spec.receivers[].telegramConfigs[]

説明
TelegramConfig は Telegram 経由で通知を設定します。https://prometheus.io/docs/alerting/latest/configuration/#telegram_config を参照してください。
object
Expand
プロパティー説明

apiURL

string

Telegram API の URL (https://api.telegram.org)。指定しない場合は、デフォルトの API URL が使用されます。

botToken

object

シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。

chatID

integer

Telegram チャット ID。

disableNotifications

boolean

Telegram 通知を無効にします

httpConfig

object

HTTP クライアント設定

message

string

メッセージテンプレート

parseMode

string

Telegram メッセージの解析モード

sendResolved

boolean

解決されたアラートについて通知するかどうか。

3.1.160. .spec.receivers[].telegramConfigs[].botToken

説明
シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。
object
必須
  • key
  • name
Expand
プロパティー説明

key

string

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

name

string

選択元となるオブジェクトの namespace 内にあるシークレットの名前。

3.1.161. .spec.receivers[].telegramConfigs[].httpConfig

説明
HTTP クライアント設定
object
Expand
プロパティー説明

authorization

object

クライアントの認証ヘッダー設定。これは BasicAuth と相互に排他的であり、Alertmanagerv0.22+ 以降でのみ使用できます。

basicAuth

object

クライアントの BasicAuth。これは、承認と相互に排他的です。両方が定義されている場合、BasicAuth が優先されます。

bearerTokenSecret

object

クライアントが認証に使用するベアラートークンを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。

followRedirects

boolean

FollowRedirects は、クライアントが HTTP 3xx リダイレクトに従うかどうかを指定します。

oauth2

object

ターゲットのトークンを取得するために使用される OAuth2 クライアント認証情報。

proxyURL

string

オプションのプロキシー URL。

tlsConfig

object

クライアントの TLS 設定。

3.1.162. .spec.receivers[].telegramConfigs[].httpConfig.authorization

説明
クライアントの認証ヘッダー設定。これは BasicAuth と相互に排他的であり、Alertmanagerv0.22+ 以降でのみ使用できます。
object
Expand
プロパティー説明

credentials

object

リクエストのクレデンシャルを含むシークレットのキー

type

string

認証タイプを設定します。デフォルトは Bearer で、Basic はエラーを引き起こします

3.1.163. .spec.receivers[].telegramConfigs[].httpConfig.authorization.credentials

説明
リクエストのクレデンシャルを含むシークレットのキー
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.164. .spec.receivers[].telegramConfigs[].httpConfig.basicAuth

説明
クライアントの BasicAuth。これは、承認と相互に排他的です。両方が定義されている場合、BasicAuth が優先されます。
object
Expand
プロパティー説明

password

object

認証用のパスワードを含むサービスモニター名前空間のシークレット。

username

object

認証用のユーザー名を含むサービスモニター名前空間のシークレット。

3.1.165. .spec.receivers[].telegramConfigs[].httpConfig.basicAuth.password

説明
認証用のパスワードを含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.166. .spec.receivers[].telegramConfigs[].httpConfig.basicAuth.username

説明
認証用のユーザー名を含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.167. .spec.receivers[].telegramConfigs[].httpConfig.bearerTokenSecret

説明
クライアントが認証に使用するベアラートークンを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。
object
必須
  • key
  • name
Expand
プロパティー説明

key

string

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

name

string

選択元となるオブジェクトの namespace 内にあるシークレットの名前。

3.1.168. .spec.receivers[].telegramConfigs[].httpConfig.oauth2

説明
ターゲットのトークンを取得するために使用される OAuth2 クライアント認証情報。
object
必須
  • clientId
  • clientSecret
  • tokenUrl
Expand
プロパティー説明

clientId

object

OAuth2 クライアント ID を含むシークレットまたは設定マップ

clientSecret

object

OAuth2 クライアントシークレットを含むシークレット

endpointParams

object (string)

トークン URL に追加するパラメーター

scopes

array (string)

トークンリクエストに使用される OAuth2 スコープ

tokenUrl

string

トークンをフェッチする URL

3.1.169. .spec.receivers[].telegramConfigs[].httpConfig.oauth2.clientId

説明
OAuth2 クライアント ID を含むシークレットまたは設定マップ
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.170. .spec.receivers[].telegramConfigs[].httpConfig.oauth2.clientId.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.171. .spec.receivers[].telegramConfigs[].httpConfig.oauth2.clientId.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.172. .spec.receivers[].telegramConfigs[].httpConfig.oauth2.clientSecret

説明
OAuth2 クライアントシークレットを含むシークレット
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.173. .spec.receivers[].telegramConfigs[].httpConfig.tlsConfig

説明
クライアントの TLS 設定。
object
Expand
プロパティー説明

ca

object

ターゲットに使用する CA 証明書を含む構造体。

cert

object

ターゲットのクライアント証明書ファイルを含む構造体。

insecureSkipVerify

boolean

ターゲット証明書の検証を無効にします。

keySecret

object

ターゲットのクライアントキーファイルを含むシークレット。

serverName

string

ターゲットのホスト名を確認するために使用されます。

3.1.174. .spec.receivers[].telegramConfigs[].httpConfig.tlsConfig.ca

説明
ターゲットに使用する CA 証明書を含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.175. .spec.receivers[].telegramConfigs[].httpConfig.tlsConfig.ca.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.176. .spec.receivers[].telegramConfigs[].httpConfig.tlsConfig.ca.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.177. .spec.receivers[].telegramConfigs[].httpConfig.tlsConfig.cert

説明
ターゲットのクライアント証明書ファイルを含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.178. .spec.receivers[].telegramConfigs[].httpConfig.tlsConfig.cert.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.179. .spec.receivers[].telegramConfigs[].httpConfig.tlsConfig.cert.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.180. .spec.receivers[].telegramConfigs[].httpConfig.tlsConfig.keySecret

説明
ターゲットのクライアントキーファイルを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.181. .spec.receivers[].victoropsConfigs

説明
VictorOps 設定のリスト。
array

3.1.182. .spec.receivers[].victoropsConfigs[]

説明
VictorOpsConfig は、VictorOps を介して通知を設定します。See https://prometheus.io/docs/alerting/latest/configuration/#victorops_config
object
Expand
プロパティー説明

apiKey

object

VictorOps API と通信するときに使用する API キーを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。

apiUrl

string

VictorOps API の URL。

customFields

array

通知用の追加のカスタムフィールド。

customFields[]

object

KeyValue は、(キー、値) タプルを定義します。

entityDisplayName

string

警告された問題の要約が含まれています。

httpConfig

object

HTTP クライアントの設定。

messageType

string

アラートの動作を説明します (クリティカル、警告、情報)。

monitoringTool

string

状態メッセージの送信元の監視ツール。

routingKey

string

アラートをチームにマップするために使用されるキー。

sendResolved

boolean

解決されたアラートについて通知するかどうか。

stateMessage

string

警告された問題の長い説明が含まれています。

3.1.183. .spec.receivers[].victoropsConfigs[].apiKey

説明
VictorOps API と通信するときに使用する API キーを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。
object
必須
  • key
  • name
Expand
プロパティー説明

key

string

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

name

string

選択元となるオブジェクトの namespace 内にあるシークレットの名前。

3.1.184. .spec.receivers[].victoropsConfigs[].customFields

説明
通知用の追加のカスタムフィールド。
array

3.1.185. .spec.receivers[].victoropsConfigs[].customFields[]

説明
KeyValue は、(キー、値) タプルを定義します。
object
必須
  • key
  • value
Expand
プロパティー説明

key

string

タプルのキー。

value

string

タプルの値。

3.1.186. .spec.receivers[].victoropsConfigs[].httpConfig

説明
HTTP クライアントの設定。
object
Expand
プロパティー説明

authorization

object

クライアントの認証ヘッダー設定。これは BasicAuth と相互に排他的であり、Alertmanagerv0.22+ 以降でのみ使用できます。

basicAuth

object

クライアントの BasicAuth。これは、承認と相互に排他的です。両方が定義されている場合、BasicAuth が優先されます。

bearerTokenSecret

object

クライアントが認証に使用するベアラートークンを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。

followRedirects

boolean

FollowRedirects は、クライアントが HTTP 3xx リダイレクトに従うかどうかを指定します。

oauth2

object

ターゲットのトークンを取得するために使用される OAuth2 クライアント認証情報。

proxyURL

string

オプションのプロキシー URL。

tlsConfig

object

クライアントの TLS 設定。

3.1.187. .spec.receivers[].victoropsConfigs[].httpConfig.authorization

説明
クライアントの認証ヘッダー設定。これは BasicAuth と相互に排他的であり、Alertmanagerv0.22+ 以降でのみ使用できます。
object
Expand
プロパティー説明

credentials

object

リクエストのクレデンシャルを含むシークレットのキー

type

string

認証タイプを設定します。デフォルトは Bearer で、Basic はエラーを引き起こします

3.1.188. .spec.receivers[].victoropsConfigs[].httpConfig.authorization.credentials

Description
リクエストのクレデンシャルを含むシークレットのキー
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.189. .spec.receivers[].victoropsConfigs[].httpConfig.basicAuth

説明
クライアントの BasicAuth。これは、承認と相互に排他的です。両方が定義されている場合、BasicAuth が優先されます。
object
Expand
プロパティー説明

password

object

認証用のパスワードを含むサービスモニター名前空間のシークレット。

username

object

認証用のユーザー名を含むサービスモニター名前空間のシークレット。

3.1.190. .spec.receivers[].victoropsConfigs[].httpConfig.basicAuth.password

Description
認証用のパスワードを含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.191. .spec.receivers[].victoropsConfigs[].httpConfig.basicAuth.username

Description
認証用のユーザー名を含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.192. .spec.receivers[].victoropsConfigs[].httpConfig.bearerTokenSecret

説明
クライアントが認証に使用するベアラートークンを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。
object
必須
  • key
  • name
Expand
プロパティー説明

key

string

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

name

string

選択元となるオブジェクトの namespace 内にあるシークレットの名前。

3.1.193. .spec.receivers[].victoropsConfigs[].httpConfig.oauth2

説明
ターゲットのトークンを取得するために使用される OAuth2 クライアント認証情報。
object
必須
  • clientId
  • clientSecret
  • tokenUrl
Expand
プロパティー説明

clientId

object

OAuth2 クライアント ID を含むシークレットまたは設定マップ

clientSecret

object

OAuth2 クライアントシークレットを含むシークレット

endpointParams

object (string)

トークン URL に追加するパラメーター

scopes

array (string)

トークンリクエストに使用される OAuth2 スコープ

tokenUrl

string

トークンをフェッチする URL

3.1.194. .spec.receivers[].victoropsConfigs[].httpConfig.oauth2.clientId

説明
OAuth2 クライアント ID を含むシークレットまたは設定マップ
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.195. .spec.receivers[].victoropsConfigs[].httpConfig.oauth2.clientId.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.196. .spec.receivers[].victoropsConfigs[].httpConfig.oauth2.clientId.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.197. .spec.receivers[].victoropsConfigs[].httpConfig.oauth2.clientSecret

説明
OAuth2 クライアントシークレットを含むシークレット
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.198. .spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig

説明
クライアントの TLS 設定。
object
Expand
プロパティー説明

ca

object

ターゲットに使用する CA 証明書を含む構造体。

cert

object

ターゲットのクライアント証明書ファイルを含む構造体。

insecureSkipVerify

boolean

ターゲット証明書の検証を無効にします。

keySecret

object

ターゲットのクライアントキーファイルを含むシークレット。

serverName

string

ターゲットのホスト名を確認するために使用されます。

3.1.199. .spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.ca

Description
ターゲットに使用する CA 証明書を含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.200. .spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.ca.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.201. .spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.ca.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.202. .spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.cert

Description
ターゲットのクライアント証明書ファイルを含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.203. .spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.cert.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.204. .spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.cert.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.205. .spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.keySecret

説明
ターゲットのクライアントキーファイルを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.206. .spec.receivers[].webhookConfigs

説明
Webhook 設定のリスト。
array

3.1.207. .spec.receivers[].webhookConfigs[]

説明
WebhookConfig は、Webhook ペイロードをサポートする汎用レシーバーを介して通知を設定します。See https://prometheus.io/docs/alerting/latest/configuration/#webhook_config
object
Expand
プロパティー説明

httpConfig

object

HTTP クライアント設定

maxAlerts

integer

Webhook メッセージごとに送信されるアラートの最大数。0 の場合、すべてのアラートが含まれます。

sendResolved

boolean

解決されたアラートについて通知するかどうか。

url

string

HTTP POST リクエストを送信する URL。urlSecreturl よりも優先されます。urlSecreturl のいずれかを定義する必要があります。

urlSecret

object

HTTP リクエストを送信する Webhook URL を含むシークレットのキー。urlSecreturl よりも優先されます。urlSecreturl のいずれかを定義する必要があります。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。

3.1.208. .spec.receivers[].webhookConfigs[].httpConfig

説明
HTTP クライアント設定
object
Expand
プロパティー説明

authorization

object

クライアントの認証ヘッダー設定。これは BasicAuth と相互に排他的であり、Alertmanagerv0.22+ 以降でのみ使用できます。

basicAuth

object

クライアントの BasicAuth。これは、承認と相互に排他的です。両方が定義されている場合、BasicAuth が優先されます。

bearerTokenSecret

object

クライアントが認証に使用するベアラートークンを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。

followRedirects

boolean

FollowRedirects は、クライアントが HTTP 3xx リダイレクトに従うかどうかを指定します。

oauth2

object

ターゲットのトークンを取得するために使用される OAuth2 クライアント認証情報。

proxyURL

string

オプションのプロキシー URL。

tlsConfig

object

クライアントの TLS 設定。

3.1.209. .spec.receivers[].webhookConfigs[].httpConfig.authorization

説明
クライアントの認証ヘッダー設定。これは BasicAuth と相互に排他的であり、Alertmanagerv0.22+ 以降でのみ使用できます。
object
Expand
プロパティー説明

credentials

object

リクエストのクレデンシャルを含むシークレットのキー

type

string

認証タイプを設定します。デフォルトは Bearer で、Basic はエラーを引き起こします

3.1.210. .spec.receivers[].webhookConfigs[].httpConfig.authorization.credentials

Description
リクエストのクレデンシャルを含むシークレットのキー
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.211. .spec.receivers[].webhookConfigs[].httpConfig.basicAuth

説明
クライアントの BasicAuth。これは、承認と相互に排他的です。両方が定義されている場合、BasicAuth が優先されます。
object
Expand
プロパティー説明

password

object

認証用のパスワードを含むサービスモニター名前空間のシークレット。

username

object

認証用のユーザー名を含むサービスモニター名前空間のシークレット。

3.1.212. .spec.receivers[].webhookConfigs[].httpConfig.basicAuth.password

Description
認証用のパスワードを含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.213. .spec.receivers[].webhookConfigs[].httpConfig.basicAuth.username

Description
認証用のユーザー名を含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.214. .spec.receivers[].webhookConfigs[].httpConfig.bearerTokenSecret

説明
クライアントが認証に使用するベアラートークンを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。
object
必須
  • key
  • name
Expand
プロパティー説明

key

string

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

name

string

選択元となるオブジェクトの namespace 内にあるシークレットの名前。

3.1.215. .spec.receivers[].webhookConfigs[].httpConfig.oauth2

説明
ターゲットのトークンを取得するために使用される OAuth2 クライアント認証情報。
object
必須
  • clientId
  • clientSecret
  • tokenUrl
Expand
プロパティー説明

clientId

object

OAuth2 クライアント ID を含むシークレットまたは設定マップ

clientSecret

object

OAuth2 クライアントシークレットを含むシークレット

endpointParams

object (string)

トークン URL に追加するパラメーター

scopes

array (string)

トークンリクエストに使用される OAuth2 スコープ

tokenUrl

string

トークンをフェッチする URL

3.1.216. .spec.receivers[].webhookConfigs[].httpConfig.oauth2.clientId

説明
OAuth2 クライアント ID を含むシークレットまたは設定マップ
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.217. .spec.receivers[].webhookConfigs[].httpConfig.oauth2.clientId.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.218. .spec.receivers[].webhookConfigs[].httpConfig.oauth2.clientId.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.219. .spec.receivers[].webhookConfigs[].httpConfig.oauth2.clientSecret

説明
OAuth2 クライアントシークレットを含むシークレット
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.220. .spec.receivers[].webhookConfigs[].httpConfig.tlsConfig

説明
クライアントの TLS 設定。
object
Expand
プロパティー説明

ca

object

ターゲットに使用する CA 証明書を含む構造体。

cert

object

ターゲットのクライアント証明書ファイルを含む構造体。

insecureSkipVerify

boolean

ターゲット証明書の検証を無効にします。

keySecret

object

ターゲットのクライアントキーファイルを含むシークレット。

serverName

string

ターゲットのホスト名を確認するために使用されます。

3.1.221. .spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.ca

Description
ターゲットに使用する CA 証明書を含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.222. .spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.ca.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.223. .spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.ca.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.224. .spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.cert

Description
ターゲットのクライアント証明書ファイルを含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.225. .spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.cert.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.226. .spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.cert.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.227. .spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.keySecret

説明
ターゲットのクライアントキーファイルを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.228. .spec.receivers[].webhookConfigs[].urlSecret

説明
HTTP リクエストを送信する Webhook URL を含むシークレットのキー。urlSecreturl よりも優先されます。urlSecreturl のいずれかを定義する必要があります。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。
object
必須
  • key
  • name
Expand
プロパティー説明

key

string

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

name

string

選択元となるオブジェクトの namespace 内にあるシークレットの名前。

3.1.229. .spec.receivers[].wechatConfigs

説明
WeChat 設定のリスト。
array

3.1.230. .spec.receivers[].wechatConfigs[]

説明
WeChatConfig は、WeChat を介して通知を設定します。https://prometheus.io/docs/alerting/latest/configuration/#wechat_config を参照してください
object
Expand
プロパティー説明

agentID

string

 

apiSecret

object

WeChat API キーを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。

apiURL

string

WeChat API の URL。

corpID

string

認証用の corp id。

httpConfig

object

HTTP クライアント設定

message

string

WeChat API で定義された API リクエストデータ。

messageType

string

 

sendResolved

boolean

解決されたアラートについて通知するかどうか。

toParty

string

 

toTag

string

 

toUser

string

 

3.1.231. .spec.receivers[].wechatConfigs[].apiSecret

説明
WeChat API キーを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。
object
必須
  • key
  • name
Expand
プロパティー説明

key

string

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

name

string

選択元となるオブジェクトの namespace 内にあるシークレットの名前。

3.1.232. .spec.receivers[].wechatConfigs[].httpConfig

説明
HTTP クライアント設定
object
Expand
プロパティー説明

authorization

object

クライアントの認証ヘッダー設定。これは BasicAuth と相互に排他的であり、Alertmanagerv0.22+ 以降でのみ使用できます。

basicAuth

object

クライアントの BasicAuth。これは、承認と相互に排他的です。両方が定義されている場合、BasicAuth が優先されます。

bearerTokenSecret

object

クライアントが認証に使用するベアラートークンを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。

followRedirects

boolean

FollowRedirects は、クライアントが HTTP 3xx リダイレクトに従うかどうかを指定します。

oauth2

object

ターゲットのトークンを取得するために使用される OAuth2 クライアント認証情報。

proxyURL

string

オプションのプロキシー URL。

tlsConfig

object

クライアントの TLS 設定。

3.1.233. .spec.receivers[].wechatConfigs[].httpConfig.authorization

説明
クライアントの認証ヘッダー設定。これは BasicAuth と相互に排他的であり、Alertmanagerv0.22+ 以降でのみ使用できます。
object
Expand
プロパティー説明

credentials

object

リクエストのクレデンシャルを含むシークレットのキー

type

string

認証タイプを設定します。デフォルトは Bearer で、Basic はエラーを引き起こします

3.1.234. .spec.receivers[].wechatConfigs[].httpConfig.authorization.credentials

Description
リクエストのクレデンシャルを含むシークレットのキー
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.235. .spec.receivers[].wechatConfigs[].httpConfig.basicAuth

説明
クライアントの BasicAuth。これは、承認と相互に排他的です。両方が定義されている場合、BasicAuth が優先されます。
object
Expand
プロパティー説明

password

object

認証用のパスワードを含むサービスモニター名前空間のシークレット。

username

object

認証用のユーザー名を含むサービスモニター名前空間のシークレット。

3.1.236. .spec.receivers[].wechatConfigs[].httpConfig.basicAuth.password

Description
認証用のパスワードを含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.237. .spec.receivers[].wechatConfigs[].httpConfig.basicAuth.username

Description
認証用のユーザー名を含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.238. .spec.receivers[].wechatConfigs[].httpConfig.bearerTokenSecret

説明
クライアントが認証に使用するベアラートークンを含むシークレットのキー。シークレットは、AlertmanagerConfig オブジェクトと同じ namespace に配置され、Prometheus Operator からアクセスできる必要があります。
object
必須
  • key
  • name
Expand
プロパティー説明

key

string

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

name

string

選択元となるオブジェクトの namespace 内にあるシークレットの名前。

3.1.239. .spec.receivers[].wechatConfigs[].httpConfig.oauth2

説明
ターゲットのトークンを取得するために使用される OAuth2 クライアント認証情報。
object
必須
  • clientId
  • clientSecret
  • tokenUrl
Expand
プロパティー説明

clientId

object

OAuth2 クライアント ID を含むシークレットまたは設定マップ

clientSecret

object

OAuth2 クライアントシークレットを含むシークレット

endpointParams

object (string)

トークン URL に追加するパラメーター

scopes

array (string)

トークンリクエストに使用される OAuth2 スコープ

tokenUrl

string

トークンをフェッチする URL

3.1.240. .spec.receivers[].wechatConfigs[].httpConfig.oauth2.clientId

説明
OAuth2 クライアント ID を含むシークレットまたは設定マップ
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.241. .spec.receivers[].wechatConfigs[].httpConfig.oauth2.clientId.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.242. .spec.receivers[].wechatConfigs[].httpConfig.oauth2.clientId.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.243. .spec.receivers[].wechatConfigs[].httpConfig.oauth2.clientSecret

説明
OAuth2 クライアントシークレットを含むシークレット
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.244. .spec.receivers[].wechatConfigs[].httpConfig.tlsConfig

説明
クライアントの TLS 設定。
object
Expand
プロパティー説明

ca

object

ターゲットに使用する CA 証明書を含む構造体。

cert

object

ターゲットのクライアント証明書ファイルを含む構造体。

insecureSkipVerify

boolean

ターゲット証明書の検証を無効にします。

keySecret

object

ターゲットのクライアントキーファイルを含むシークレット。

serverName

string

ターゲットのホスト名を確認するために使用されます。

3.1.245. .spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.ca

Description
ターゲットに使用する CA 証明書を含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.246. .spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.ca.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.247. .spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.ca.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.248. .spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.cert

Description
ターゲットのクライアント証明書ファイルを含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

3.1.249. .spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.cert.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

3.1.250. .spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.cert.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.251. .spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.keySecret

説明
ターゲットのクライアントキーファイルを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

3.1.252. .spec.route

説明
リソースの namespace に一致するアラートの Alertmanager ルート定義。存在する場合は、生成された Alertmanager 設定に第 1 レベルのルートとして追加されます。
object
Expand
プロパティー説明

continue

boolean

アラートが後続の兄弟ノードとの一致を継続する必要があるかどうかを示すブール値。Prometheus Operator は、第 1 レベルのルートに対して常に true にオーバーライドされます。

groupBy

array (string)

グループ化するラベルのリスト。ラベルは繰り返せません (一意のリスト)。特殊ラベル "…​" (使用できるすべてのラベルの集約) が指定されている場合、それがリスト内の唯一の要素である必要があります。

groupInterval

string

更新された通知を送信するまでの待機時間。正規表現 `^(()y)?(([0-9])w)?(()d)?(([0-9])h)?(()m)?(([0-9])s)?(([0-9]+)ms)?$` に一致する必要があります。例: "5m"

groupWait

string

最初の通知を送信するまでの待機時間。正規表現 `^(()y)?(([0-9])w)?(()d)?(([0-9])h)?(()m)?(([0-9])s)?(([0-9]+)ms)?$` に一致する必要があります。例: "30s"

matchers

array

アラートのラベルが一致する必要があるマッチャーのリスト。第 1 レベルのルートの場合、Operator は namespace ラベル上の既存の等式および正規表現マッチャーを削除し、namespace: <object namespace> マッチャーを追加します。

matchers[]

object

マッチャーは、アラートのラベルを照合する方法を定義します。

muteTimeIntervals

array (string)

注記: このコメントは上記のフィールド定義に適用されますが下部に表示され、それ以外の場合は生成されたマニフェストに含まれます。CRD スキーマは現時点では自己参照タイプをサポートしていません (https://github.com/kubernetes/kubernetes/issues/62872 を参照)。制限を回避するには、代替タイプを使用する必要があります。欠点は、Kube API では、データが有効な JSON 表現であるという事実以外を検証できないことです。MuteTimeIntervals は、一致したときにこのルートをミュートする TimeInterval の名前のリストです。

receiver

string

このルートの受信者の名前。空でない場合は、レシーバー フィールドにリストされているはずです。

repeatInterval

string

最後の通知を繰り返すまでの待機時間。正規表現 `^(()y)?(([0-9])w)?(()d)?(([0-9])h)?(()m)?(([0-9])s)?(([0-9]+)ms)?$` に一致する必要があります。例: "4h"

routes

array (undefined)

子ルート。

3.1.253. .spec.route.matchers

説明
アラートのラベルが一致する必要があるマッチャーのリスト。第 1 レベルのルートの場合、Operator は namespace ラベル上の既存の等式および正規表現マッチャーを削除し、namespace: <object namespace> マッチャーを追加します。
array

3.1.254. .spec.route.matchers[]

説明
マッチャーは、アラートのラベルを照合する方法を定義します。
object
必須
  • name
Expand
プロパティー説明

matchType

string

一致 Operator。= (等しい)、!= (等しくない)、=~ (正規表現に一致)、! ~ (正規表現に一致しない) のいずれかです。ネガティブ Operator (!= および !~) には、Alertmanager v0.22.0 以降が必要です。

name

string

一致するラベル

value

string

一致するラベル値。

3.1.255. .spec.timeIntervals

説明
いつルートをミュートまたはアクティブにするかを指定する TimeInterval のリスト。
array

3.1.256. .spec.timeIntervals[]

説明
TimeInterval は、通知をミュートまたはアクティブにする期間を指定します。
object
Expand
プロパティー説明

name

string

時間間隔の名前。

timeIntervals

array

timeIntervals は TimePeriod のリストです。

timeIntervals[]

object

TimePeriod は期間を表します。

3.1.257. .spec.timeIntervals[].timeIntervals

説明
timeIntervals は TimePeriod のリストです。
array

3.1.258. .spec.timeIntervals[].timeIntervals[]

説明
TimePeriod は期間を表します。
object
Expand
プロパティー説明

daysOfMonth

array

daysOfMonth は DayOfMonthRange のリストです

daysOfMonth[]

object

DayOfMonthRange は 1 から始まるその月の日の範囲です。

months

array (string)

months は MonthRange のリストです

times

array

times は TimeRange のリストです

times[]

object

TimeRange は開始時刻と終了時刻を 24 時間形式で定義します

weekdays

array (string)

weekdays は WeekdayRange のリストです

years

array (string)

years は YearRange のリストです

3.1.259. .spec.timeIntervals[].timeIntervals[].daysOfMonth

説明
daysOfMonth は DayOfMonthRange のリストです
array

3.1.260. .spec.timeIntervals[].timeIntervals[].daysOfMonth[]

説明
DayOfMonthRange は 1 から始まるその月の日の範囲です。
object
Expand
プロパティー説明

end

integer

包含範囲の終了

start

integer

包含範囲の開始

3.1.261. .spec.timeIntervals[].timeIntervals[].times

説明
times は TimeRange のリストです
array

3.1.262. .spec.timeIntervals[].timeIntervals[].times[]

説明
TimeRange は開始時刻と終了時刻を 24 時間形式で定義します
object
Expand
プロパティー説明

endTime

string

endTime は 24 時間形式で示した終了時刻です。

startTime

string

startTime は 24 時間形式で示した開始時刻です。

3.2. API エンドポイント

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

  • /apis/monitoring.coreos.com/v1beta1/alertmanagerconfigs

    • GET: 種類が AlertmanagerConfig のオブジェクトをリスト表示します。
  • /apis/monitoring.coreos.com/v1beta1/namespaces/{namespace}/alertmanagerconfigs

    • DELETE: AlertmanagerConfig のコレクションを削除します。
    • GET: 種類が AlertmanagerConfig のオブジェクトをリスト表示します。
    • POST:AlertmanagerConfig を作成します。
  • /apis/monitoring.coreos.com/v1beta1/namespaces/{namespace}/alertmanagerconfigs/{name}

    • DELETE: AlertmanagerConfig を削除します。
    • GET: 指定された AlertmanagerConfig を読み取ります。
    • PATCH: 指定された AlertmanagerConfig を部分的に更新します。
    • PUT: 指定された AlertmanagerConfig を置き換えます。

3.2.1. /apis/monitoring.coreos.com/v1beta1/alertmanagerconfigs

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

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

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

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

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

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

200 - OK

AlertmanagerConfigList スキーマ

401 - Unauthorized

空白

3.2.2. /apis/monitoring.coreos.com/v1beta1/namespaces/{namespace}/alertmanagerconfigs

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

namespace

string

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

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
AlertmanagerConfig のコレクションを削除します
Expand
表3.5 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

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

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

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

Expand
表3.6 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
種類 AlertmanagerConfig のオブジェクトをリスト表示します
Expand
表3.7 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

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

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

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

Expand
表3.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

AlertmanagerConfigList スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表3.10 ボディーパラメーター
パラメーター説明

ボディー

AlertmanagerConfig スキーマ

 
Expand
表3.11 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

AlertmanagerConfig スキーマ

201 - Created

AlertmanagerConfig スキーマ

202 - Accepted

AlertmanagerConfig スキーマ

401 - Unauthorized

空白

3.2.3. /apis/monitoring.coreos.com/v1beta1/namespaces/{namespace}/alertmanagerconfigs/{name}

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

name

string

AlertmanagerConfig の名前

namespace

string

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

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

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

dryRun

string

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

gracePeriodSeconds

integer

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

orphanDependents

boolean

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

propagationPolicy

string

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

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

body

DeleteOptions スキーマ

 
Expand
表3.16 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された AlertmanagerConfig を読み取ります
Expand
表3.17 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表3.18 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

AlertmanagerConfig スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表3.20 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表3.21 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

AlertmanagerConfig スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表3.23 ボディーパラメーター
パラメーター説明

ボディー

AlertmanagerConfig スキーマ

 
Expand
表3.24 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

AlertmanagerConfig スキーマ

201 - Created

AlertmanagerConfig スキーマ

401 - Unauthorized

空白

第4章 PodMonitor [monitoring.coreos.com/v1]

説明
PodMonitor は、一連の Pod の監視を定義します。
object
必須
  • spec

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

Prometheus によるターゲット発見のための望ましい Pod 選択の仕様。

4.1.1. .spec

説明
Prometheus によるターゲット発見のための望ましい Pod 選択の仕様。
object
必須
  • podMetricsEndpoints
  • selector
Expand
プロパティー説明

attachMetadata

object

ノードメタデータを検出されたターゲットにアタッチします。ロール:pod についてのみ有効です。Prometheus バージョン 2.26.0 以降でのみ有効です。

jobLabel

string

ジョブ名の取得に使用するラベル。

labelLimit

integer

サンプルに受け入れられるラベルの数のスクレープごとの制限。Prometheus バージョン 2.27.0 以降でのみ有効です。

labelNameLengthLimit

integer

サンプルで受け入れられるラベル名の長さのスクレープごとの制限。Prometheus バージョン 2.27.0 以降でのみ有効です。

labelValueLengthLimit

integer

サンプルに受け入れられるラベル値の長さのスクレープごとの制限。Prometheus バージョン 2.27.0 以降でのみ有効です。

namespaceSelector

object

Endpoints オブジェクトが検出される名前空間を選択するためのセレクター。

podMetricsEndpoints

array

この PodMonitor の一部として許可されているエンドポイントのリスト。

podMetricsEndpoints[]

object

PodMetricsEndpoint は、Prometheus メトリックを提供する KubernetesPod のスクレイプ可能なエンドポイントを定義します。

podTargetLabels

array (string)

PodTargetLabels は、KubernetesPod のラベルをターゲットに転送します。

sampleLimit

integer

SampleLimit は、受け入れられるスクレイプされたサンプルの数に対するスクレイプごとの制限を定義します。

selector

object

Pod オブジェクトを選択するためのセレクター。

targetLimit

integer

TargetLimit は、受け入れられるスクレイプされたターゲットの数の制限を定義します。

4.1.2. .spec.attachMetadata

説明
ノードメタデータを検出されたターゲットにアタッチします。ロール:pod についてのみ有効です。Prometheus バージョン 2.26.0 以降でのみ有効です。
object
Expand
プロパティー説明

node

boolean

true に設定すると、Prometheus にはノードを取得するパーミッションが必要です。

4.1.3. .spec.namespaceSelector

Description
Endpoints オブジェクトが検出される名前空間を選択するためのセレクター。
タイプ
object
Expand
プロパティー説明

any

boolean

それらを制限するリストとは対照的に、すべての namespace が選択されているかどうかを説明するブール値。

matchNames

array (string)

選択する namespace 名のリスト。

4.1.4. .spec.podMetricsEndpoints

Description
この PodMonitor の一部として許可されているエンドポイントのリスト。
タイプ
array

4.1.5. .spec.podMetricsEndpoints[]

Description
PodMetricsEndpoint は、Prometheus メトリックを提供する KubernetesPod のスクレイプ可能なエンドポイントを定義します。
タイプ
object
Expand
プロパティー説明

authorization

object

このエンドポイントの承認セクション

basicAuth

object

BasicAuth を使用すると、エンドポイントは基本認証を介して認証できます。詳細: https://prometheus.io/docs/operating/configuration/#endpoint

bearerTokenSecret

object

ターゲットをスクレイピングするためのベアラトークンを読み取るためにマウントする秘密。シークレットは Pod モニターと同じ名前空間にあり、PrometheusOperator からアクセスできる必要があります。

enableHttp2

boolean

HTTP2 を有効にするかどうか。

filterRunning

boolean

実行されていない Pod を削除する。(Failed、Succeeded)。デフォルトでは有効です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase

followRedirects

boolean

FollowRedirects は、収集リクエストが HTTP 3xx リダイレクトされるかどうかを設定します。

honorLabels

ブール値

HonorLabels は、ターゲットラベルとの衝突時にメトリックのラベルを選択します。

honorTimestamps

ブール値

HonorTimestamps は、Prometheus がスクレイピングされたデータに存在するタイムスタンプを尊重するかどうかを制御します。

interval

string

指定されていない場合に Prometheus のグローバルスクレイプ間隔が使用される場合にスクレイプする間隔。

metricRelabelings

array

取り込み前にサンプルに適用する MetricRelabelConfigs。

metricRelabelings[]

object

RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の <metric_relabel_configs> セクションを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs

oauth2

object

URL の OAuth2。Prometheus バージョン 2.27.0 以降でのみ有効です。

params

object

オプションの HTTPURL パラメーター

params{}

array (string)

 

path

string

メトリックをスクレイプするための HTTP パス。空の場合、Prometheus はデフォルト値 (例: /metrics) を使用します。

port

string

このエンドポイントが参照する Pod ポートの名前。targetPort と相互に排他的です。

proxyUrl

string

ProxyURL 例: http://proxyserver:2195 このエンドポイントを介してスクレイプをプロキシーに送信します。

relabelings

array

スクレイピングする前にサンプルに適用する RelabelConfigs。Operator は、いくつかの標準 Kubernetes フィールドのラベルの再設定を自動的に追加します。元のスクレイプジョブの名前は、\__tmp_prometheus_job_name ラベルから取得できます。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

relabelings[]

object

RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の <metric_relabel_configs> セクションを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs

scheme

string

スクレイピングに使用する HTTP スキーム。

scrapeTimeout

string

スクレイプが終了した後のタイムアウト(指定されていない場合)は、Prometheus グローバルスクレイプ間隔が使用されます。

targetPort

integer-or-string

非推奨: 代わりに port を使用してください。

tlsConfig

object

エンドポイントをスクレイピングするときに使用する TLS 設定。

4.1.6. .spec.podMetricsEndpoints[].authorization

Description
このエンドポイントの承認セクション
object
Expand
プロパティー説明

credentials

object

リクエストのクレデンシャルを含むシークレットのキー

type

string

認証タイプを設定します。デフォルトは Bearer で、Basic はエラーを引き起こします

4.1.7. .spec.podMetricsEndpoints[].authorization.credentials

Description
リクエストのクレデンシャルを含むシークレットのキー
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

4.1.8. .spec.podMetricsEndpoints[].basicAuth

Description
BasicAuth を使用すると、エンドポイントは基本認証を介して認証できます。詳細: https://prometheus.io/docs/operating/configuration/#endpoint
object
Expand
プロパティー説明

password

object

認証用のパスワードを含むサービスモニター名前空間のシークレット。

username

object

認証用のユーザー名を含むサービスモニター名前空間のシークレット。

4.1.9. .spec.podMetricsEndpoints[].basicAuth.password

Description
認証用のパスワードを含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

4.1.10. .spec.podMetricsEndpoints[].basicAuth.username

Description
認証用のユーザー名を含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

4.1.11. .spec.podMetricsEndpoints[].bearerTokenSecret

Description
ターゲットをスクレイピングするためのベアラトークンを読み取るためにマウントする秘密。シークレットは Pod モニターと同じ名前空間にあり、PrometheusOperator からアクセスできる必要があります。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

4.1.12. .spec.podMetricsEndpoints[].metricRelabelings

Description
取り込み前にサンプルに適用する MetricRelabelConfigs。
array

4.1.13. .spec.podMetricsEndpoints[].metricRelabelings[]

Description
RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の <metric_relabel_configs> セクションを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
タイプ
object
Expand
プロパティー説明

action

string

正規表現のマッチングに基づいて実行するアクション。デフォルトは置換です。大文字および小文字のアクションには、Prometheus >= 2.36 が必要です。

modulus

integer

ソースラベル値のハッシュを取得するためのモジュラス。

regex

string

抽出された値が一致する正規表現。デフォルトは (.*) です。

replacement

string

正規表現が一致する場合に正規表現置換が実行される置換値。正規表現キャプチャグループが利用可能です。デフォルトは $1 です。

separator

string

連結されたソースラベル値の間に配置されたセパレータ。デフォルトは ';' です。

sourceLabels

array (string)

ソースラベルは、既存のラベルから値を選択します。それらのコンテンツは、設定されたセパレーターを使用して連結され、置換、保持、および削除アクションの設定された正規表現と照合されます。

targetLabel

string

結果の値が置換アクションで書き込まれるラベル。置換アクションには必須です。正規表現キャプチャグループが利用可能です。

4.1.14. .spec.podMetricsEndpoints[].oauth2

Description
URL の OAuth2。Prometheus バージョン 2.27.0 以降でのみ有効です。
object
必須
  • clientId
  • clientSecret
  • tokenUrl
Expand
プロパティー説明

clientId

object

OAuth2 クライアント ID を含むシークレットまたは設定マップ

clientSecret

object

OAuth2 クライアントシークレットを含むシークレット

endpointParams

object (string)

トークン URL に追加するパラメーター

scopes

array (string)

トークンリクエストに使用される OAuth2 スコープ

tokenUrl

string

トークンをフェッチする URL

4.1.15. .spec.podMetricsEndpoints[].oauth2.clientId

Description
OAuth2 クライアント ID を含むシークレットまたは設定マップ
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

4.1.16. .spec.podMetricsEndpoints[].oauth2.clientId.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

4.1.17. .spec.podMetricsEndpoints[].oauth2.clientId.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

4.1.18. .spec.podMetricsEndpoints[].oauth2.clientSecret

Description
OAuth2 クライアントシークレットを含むシークレット
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

4.1.19. .spec.podMetricsEndpoints[].params

Description
オプションの HTTPURL パラメーター
タイプ
object

4.1.20. .spec.podMetricsEndpoints[].relabelings

Description
スクレイピングする前にサンプルに適用する RelabelConfigs。Operator は、いくつかの標準 Kubernetes フィールドのラベルの再設定を自動的に追加します。元のスクレイプジョブの名前は、\__tmp_prometheus_job_name ラベルから取得できます。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
array

4.1.21. .spec.podMetricsEndpoints[].relabelings[]

Description
RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の <metric_relabel_configs> セクションを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
タイプ
object
Expand
プロパティー説明

action

string

正規表現のマッチングに基づいて実行するアクション。デフォルトは置換です。大文字および小文字のアクションには、Prometheus >= 2.36 が必要です。

modulus

integer

ソースラベル値のハッシュを取得するためのモジュラス。

regex

string

抽出された値が一致する正規表現。デフォルトは (.*) です。

replacement

string

正規表現が一致する場合に正規表現置換が実行される置換値。正規表現キャプチャグループが利用可能です。デフォルトは $1 です。

separator

string

連結されたソースラベル値の間に配置されたセパレータ。デフォルトは ';' です。

sourceLabels

array (string)

ソースラベルは、既存のラベルから値を選択します。それらのコンテンツは、設定されたセパレーターを使用して連結され、置換、保持、および削除アクションの設定された正規表現と照合されます。

targetLabel

string

結果の値が置換アクションで書き込まれるラベル。置換アクションには必須です。正規表現キャプチャグループが利用可能です。

4.1.22. .spec.podMetricsEndpoints[].tlsConfig

Description
エンドポイントをスクレイピングするときに使用する TLS 設定。
object
Expand
プロパティー説明

ca

object

ターゲットに使用する CA 証明書を含む構造体。

cert

object

ターゲットのクライアント証明書ファイルを含む構造体。

insecureSkipVerify

boolean

ターゲット証明書の検証を無効にします。

keySecret

object

ターゲットのクライアントキーファイルを含むシークレット。

serverName

string

ターゲットのホスト名を確認するために使用されます。

4.1.23. .spec.podMetricsEndpoints[].tlsConfig.ca

Description
ターゲットに使用する CA 証明書を含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

4.1.24. .spec.podMetricsEndpoints[].tlsConfig.ca.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

4.1.25. .spec.podMetricsEndpoints[].tlsConfig.ca.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

4.1.26. .spec.podMetricsEndpoints[].tlsConfig.cert

Description
ターゲットのクライアント証明書ファイルを含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

4.1.27. .spec.podMetricsEndpoints[].tlsConfig.cert.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

4.1.28. .spec.podMetricsEndpoints[].tlsConfig.cert.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

4.1.29. .spec.podMetricsEndpoints[].tlsConfig.keySecret

説明
ターゲットのクライアントキーファイルを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

4.1.30. .spec.selector

Description
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 で結合されます。

4.1.31. .spec.selector.matchExpressions

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

4.1.32. .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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

4.2. API エンドポイント

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

  • /apis/monitoring.coreos.com/v1/podmonitors

    • GET: 種類が PodMonitor のオブジェクトをリスト表示します。
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/podmonitors

    • DELETE: PodMonitor のコレクションを削除します。
    • GET: 種類が PodMonitor のオブジェクトをリスト表示します。
    • POST: PodMonitor を作成します。
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/podmonitors/{name}

    • DELETE: PodMonitor を削除します。
    • GET: 指定された PodMonitor を読み取ります。
    • PATCH: 指定された PodMonitor を部分的に更新します。
    • PUT: 指定された PodMonitor を置き換えます。

4.2.1. /apis/monitoring.coreos.com/v1/podmonitors

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

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

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

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

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

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

200 - OK

PodMonitorList スキーマ

401 - Unauthorized

空白

4.2.2. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/podmonitors

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

namespace

string

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

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
PodMonitor のコレクションを削除します
Expand
表4.5 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

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

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

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

Expand
表4.6 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
PodMonitor の種類のオブジェクトをリスト表示します
Expand
表4.7 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

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

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

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

Expand
表4.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

PodMonitorList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
PodMonitor を作成する
Expand
表4.9 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表4.10 ボディーパラメーター
パラメーター説明

ボディー

PodMonitor スキーマ

 
Expand
表4.11 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

PodMonitor スキーマ

201 - Created

PodMonitor スキーマ

202 - Accepted

PodMonitor スキーマ

401 - Unauthorized

空白

4.2.3. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/podmonitors/{name}

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

name

string

PodMonitor の名前

namespace

string

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

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

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

dryRun

string

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

gracePeriodSeconds

integer

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

orphanDependents

boolean

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

propagationPolicy

string

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

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

body

DeleteOptions スキーマ

 
Expand
表4.16 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された PodMonitor を読み取ります
Expand
表4.17 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表4.18 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

PodMonitor スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表4.20 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表4.21 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

PodMonitor スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表4.23 ボディーパラメーター
パラメーター説明

ボディー

PodMonitor スキーマ

 
Expand
表4.24 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

PodMonitor スキーマ

201 - Created

PodMonitor スキーマ

401 - Unauthorized

空白

第5章 Probe [monitoring.coreos.com/v1]

説明
プローブは、一連の静的ターゲットまたは入力の監視を定義します。
object
必須
  • 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

Prometheus によるターゲット発見のための望ましいイングレス選択の仕様。

5.1.1. .spec

説明
Prometheus によるターゲット発見のための望ましいイングレス選択の仕様。
object
Expand
プロパティー説明

authorization

object

このエンドポイントの承認セクション

basicAuth

object

BasicAuth を使用すると、エンドポイントは基本認証を介して認証できます。詳細: https://prometheus.io/docs/operating/configuration/#endpoint

bearerTokenSecret

object

ターゲットをスクレイピングするためのベアラトークンを読み取るためにマウントする秘密。シークレットは、プローブと同じ namespace にあり、Prometheus Operator からアクセスできる必要があります。

interval

string

設定されたプローバーを使用してターゲットがプローブされる間隔。指定しない場合、Prometheus のグローバルスクレイプ間隔が使用されます。

jobName

string

デフォルトでスクレイプされたメトリックに割り当てられたジョブ名。

labelLimit

integer

サンプルに受け入れられるラベルの数のスクレープごとの制限。Prometheus バージョン 2.27.0 以降でのみ有効です。

labelNameLengthLimit

integer

サンプルで受け入れられるラベル名の長さのスクレープごとの制限。Prometheus バージョン 2.27.0 以降でのみ有効です。

labelValueLengthLimit

integer

サンプルに受け入れられるラベル値の長さのスクレープごとの制限。Prometheus バージョン 2.27.0 以降でのみ有効です。

metricRelabelings

array

取り込み前にサンプルに適用する MetricRelabelConfigs。

metricRelabelings[]

object

RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の <metric_relabel_configs> セクションを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs

module

string

ターゲットをプローブする方法を指定するプローブに使用するモジュール。ブラックボックスエクスポーターでのモジュール設定の例: https://github.com/prometheus/blackbox_exporter/blob/master/example.yml

oauth2

object

URL の OAuth2。Prometheus バージョン 2.27.0 以降でのみ有効です。

prober

object

ターゲットのプロービングに使用するプローバーの仕様。prober.URL パラメーターは必須です。空のままにすると、ターゲットをプローブできません。

sampleLimit

integer

SampleLimit は、受け入れられるスクレイプされたサンプルの数に対するスクレイプごとの制限を定義します。

scrapeTimeout

string

Prometheus エクスポーターからメトリックをスクレイピングするためのタイムアウト。指定しない場合、Prometheus のグローバルスクレイプ間隔が使用されます。

targetLimit

integer

TargetLimit は、受け入れられるスクレイプされたターゲットの数の制限を定義します。

ターゲット

object

targets は、プローブする静的または動的に検出されたターゲットのセットを定義します。

tlsConfig

object

エンドポイントをスクレイピングするときに使用する TLS 設定。

5.1.2. .spec.authorization

説明
このエンドポイントの承認セクション
object
Expand
プロパティー説明

credentials

object

リクエストのクレデンシャルを含むシークレットのキー

type

string

認証タイプを設定します。デフォルトは Bearer で、Basic はエラーを引き起こします

5.1.3. .spec.authorization.credentials

Description
リクエストのクレデンシャルを含むシークレットのキー
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

5.1.4. .spec.basicAuth

説明
BasicAuth を使用すると、エンドポイントは基本認証を介して認証できます。詳細: https://prometheus.io/docs/operating/configuration/#endpoint
object
Expand
プロパティー説明

password

object

認証用のパスワードを含むサービスモニター名前空間のシークレット。

username

object

認証用のユーザー名を含むサービスモニター名前空間のシークレット。

5.1.5. .spec.basicAuth.password

Description
認証用のパスワードを含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

5.1.6. .spec.basicAuth.username

Description
認証用のユーザー名を含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

5.1.7. .spec.bearerTokenSecret

説明
ターゲットをスクレイピングするためのベアラトークンを読み取るためにマウントする秘密。シークレットは、プローブと同じ namespace にあり、Prometheus Operator からアクセスできる必要があります。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

5.1.8. .spec.metricRelabelings

説明
取り込み前にサンプルに適用する MetricRelabelConfigs。
array

5.1.9. .spec.metricRelabelings[]

Description
RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の <metric_relabel_configs> セクションを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
タイプ
object
Expand
プロパティー説明

action

string

正規表現のマッチングに基づいて実行するアクション。デフォルトは置換です。大文字および小文字のアクションには、Prometheus >= 2.36 が必要です。

modulus

integer

ソースラベル値のハッシュを取得するためのモジュラス。

regex

string

抽出された値が一致する正規表現。デフォルトは (.*) です。

replacement

string

正規表現が一致する場合に正規表現置換が実行される置換値。正規表現キャプチャグループが利用可能です。デフォルトは $1 です。

separator

string

連結されたソースラベル値の間に配置されたセパレータ。デフォルトは ';' です。

sourceLabels

array (string)

ソースラベルは、既存のラベルから値を選択します。それらのコンテンツは、設定されたセパレーターを使用して連結され、置換、保持、および削除アクションの設定された正規表現と照合されます。

targetLabel

string

結果の値が置換アクションで書き込まれるラベル。置換アクションには必須です。正規表現キャプチャグループが利用可能です。

5.1.10. .spec.oauth2

説明
URL の OAuth2。Prometheus バージョン 2.27.0 以降でのみ有効です。
object
必須
  • clientId
  • clientSecret
  • tokenUrl
Expand
プロパティー説明

clientId

object

OAuth2 クライアント ID を含むシークレットまたは設定マップ

clientSecret

object

OAuth2 クライアントシークレットを含むシークレット

endpointParams

object (string)

トークン URL に追加するパラメーター

scopes

array (string)

トークンリクエストに使用される OAuth2 スコープ

tokenUrl

string

トークンをフェッチする URL

5.1.11. .spec.oauth2.clientId

Description
OAuth2 クライアント ID を含むシークレットまたは設定マップ
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

5.1.12. .spec.oauth2.clientId.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

5.1.13. .spec.oauth2.clientId.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

5.1.14. .spec.oauth2.clientSecret

Description
OAuth2 クライアントシークレットを含むシークレット
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

5.1.15. .spec.prober

説明
ターゲットのプロービングに使用するプローバーの仕様。prober.URL パラメーターは必須です。空のままにすると、ターゲットをプローブできません。
object
必須
  • url
Expand
プロパティー説明

path

string

メトリックを収集するためのパス。デフォルトは /probe です。

proxyUrl

string

オプションの ProxyURL。

scheme

string

スクレイピングに使用する HTTP スキーム。デフォルトは http です。

url

string

プローバーの必須 URL。

5.1.16. .spec.targets

説明
targets は、プローブする静的または動的に検出されたターゲットのセットを定義します。
object
Expand
プロパティー説明

ingress

object

ingress は、プローブする Ingress オブジェクトとラベル再設定の設定を定義します。staticConfig も定義されている場合は、staticConfig が優先されます。

staticConfig

object

staticConfig は、プローブするターゲットの静的リストとラベル再設定の設定を定義します。ingress も定義されている場合は、staticConfig が優先されます。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#statuc_config

5.1.17. .spec.targets.ingress

説明
ingress は、プローブする Ingress オブジェクトとラベル再設定の設定を定義します。staticConfig も定義されている場合は、staticConfig が優先されます。
object
Expand
プロパティー説明

namespaceSelector

object

Ingress オブジェクトの選択元となる namespace。

relabelingConfigs

array

スクレイピングされる前にターゲットのラベルセットに適用する RelabelConfigs。元の ingress アドレスは、__tmp_prometheus_ingress_address ラベルから取得できます。プローブ対象の URL をカスタマイズするために使用できます。元のスクレイプジョブの名前は、\__tmp_prometheus_job_name ラベルから取得できます。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

relabelingConfigs[]

object

RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の <metric_relabel_configs> セクションを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs

selector

object

Ingress オブジェクトを選択するためのセレクター。

5.1.18. .spec.targets.ingress.namespaceSelector

説明
Ingress オブジェクトの選択元となる namespace。
object
Expand
プロパティー説明

any

boolean

それらを制限するリストとは対照的に、すべての namespace が選択されているかどうかを説明するブール値。

matchNames

array (string)

選択する namespace 名のリスト。

5.1.19. .spec.targets.ingress.relabelingConfigs

説明
スクレイピングされる前にターゲットのラベルセットに適用する RelabelConfigs。元の ingress アドレスは、__tmp_prometheus_ingress_address ラベルから取得できます。プローブ対象の URL をカスタマイズするために使用できます。元のスクレイプジョブの名前は、\__tmp_prometheus_job_name ラベルから取得できます。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
array

5.1.20. .spec.targets.ingress.relabelingConfigs[]

Description
RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の <metric_relabel_configs> セクションを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
タイプ
object
Expand
プロパティー説明

action

string

正規表現のマッチングに基づいて実行するアクション。デフォルトは置換です。大文字および小文字のアクションには、Prometheus >= 2.36 が必要です。

modulus

integer

ソースラベル値のハッシュを取得するためのモジュラス。

regex

string

抽出された値が一致する正規表現。デフォルトは (.*) です。

replacement

string

正規表現が一致する場合に正規表現置換が実行される置換値。正規表現キャプチャグループが利用可能です。デフォルトは $1 です。

separator

string

連結されたソースラベル値の間に配置されたセパレータ。デフォルトは ';' です。

sourceLabels

array (string)

ソースラベルは、既存のラベルから値を選択します。それらのコンテンツは、設定されたセパレーターを使用して連結され、置換、保持、および削除アクションの設定された正規表現と照合されます。

targetLabel

string

結果の値が置換アクションで書き込まれるラベル。置換アクションには必須です。正規表現キャプチャグループが利用可能です。

5.1.21. .spec.targets.ingress.selector

説明
Ingress オブジェクトを選択するためのセレクター。
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.22. .spec.targets.ingress.selector.matchExpressions

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

5.1.23. .spec.targets.ingress.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.24. .spec.targets.staticConfig

説明
staticConfig は、プローブするターゲットの静的リストとラベル再設定の設定を定義します。ingress も定義されている場合は、staticConfig が優先されます。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#statuc_config
object
Expand
プロパティー説明

labels

object (string)

ターゲットからスクレイプされたすべてのメトリックに割り当てられたラベル。

relabelingConfigs

array

スクレイピングされる前にターゲットのラベルセットに適用する RelabelConfigs。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

relabelingConfigs[]

object

RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の <metric_relabel_configs> セクションを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs

static

array (string)

プローブ対象のホストのリスト。

5.1.25. .spec.targets.staticConfig.relabelingConfigs

説明
スクレイピングされる前にターゲットのラベルセットに適用する RelabelConfigs。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
array

5.1.26. .spec.targets.staticConfig.relabelingConfigs[]

Description
RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の <metric_relabel_configs> セクションを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
タイプ
object
Expand
プロパティー説明

action

string

正規表現のマッチングに基づいて実行するアクション。デフォルトは置換です。大文字および小文字のアクションには、Prometheus >= 2.36 が必要です。

modulus

integer

ソースラベル値のハッシュを取得するためのモジュラス。

regex

string

抽出された値が一致する正規表現。デフォルトは (.*) です。

replacement

string

正規表現が一致する場合に正規表現置換が実行される置換値。正規表現キャプチャグループが利用可能です。デフォルトは $1 です。

separator

string

連結されたソースラベル値の間に配置されたセパレータ。デフォルトは ';' です。

sourceLabels

array (string)

ソースラベルは、既存のラベルから値を選択します。それらのコンテンツは、設定されたセパレーターを使用して連結され、置換、保持、および削除アクションの設定された正規表現と照合されます。

targetLabel

string

結果の値が置換アクションで書き込まれるラベル。置換アクションには必須です。正規表現キャプチャグループが利用可能です。

5.1.27. .spec.tlsConfig

説明
エンドポイントをスクレイピングするときに使用する TLS 設定。
object
Expand
プロパティー説明

ca

object

ターゲットに使用する CA 証明書を含む構造体。

cert

object

ターゲットのクライアント証明書ファイルを含む構造体。

insecureSkipVerify

boolean

ターゲット証明書の検証を無効にします。

keySecret

object

ターゲットのクライアントキーファイルを含むシークレット。

serverName

string

ターゲットのホスト名を確認するために使用されます。

5.1.28. .spec.tlsConfig.ca

Description
ターゲットに使用する CA 証明書を含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

5.1.29. .spec.tlsConfig.ca.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

5.1.30. .spec.tlsConfig.ca.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

5.1.31. .spec.tlsConfig.cert

Description
ターゲットのクライアント証明書ファイルを含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

5.1.32. .spec.tlsConfig.cert.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

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

任意

boolean

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

5.1.33. .spec.tlsConfig.cert.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

5.1.34. .spec.tlsConfig.keySecret

説明
ターゲットのクライアントキーファイルを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

5.2. API エンドポイント

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

  • /apis/monitoring.coreos.com/v1/probes

    • GET: 種類が Probe のオブジェクトをリスト表示します。
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes

    • DELETE: Probe のコレクションを削除します。
    • GET: 種類が Probe のオブジェクトをリスト表示します。
    • POST: Probe を作成します。
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes/{name}

    • DELETE: Probe を削除します。
    • GET: 指定された Probe を読み取ります。
    • PATCH: 指定された Probe を部分的に更新します。
    • PUT: 指定された Probe を置き換えます。

5.2.1. /apis/monitoring.coreos.com/v1/probes

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

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

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

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

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

HTTP メソッド
GET
説明
種類が Probe のオブジェクトをリスト表示します。
Expand
表5.2 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ProbeList スキーマ

401 - Unauthorized

空白

5.2.2. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes

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

namespace

string

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

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

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

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

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

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

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

Expand
表5.6 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
種類のオブジェクトをリスト表示するプローブ
Expand
表5.7 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

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

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

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

Expand
表5.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ProbeList スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表5.10 ボディーパラメーター
パラメーター説明

ボディー

Probe スキーマ

 
Expand
表5.11 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Probe スキーマ

201 - Created

Probe スキーマ

202 - Accepted

Probe スキーマ

401 - Unauthorized

空白

5.2.3. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes/{name}

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

name

string

プローブの名前

namespace

string

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

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

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

dryRun

string

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

gracePeriodSeconds

integer

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

orphanDependents

boolean

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

propagationPolicy

string

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

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

body

DeleteOptions スキーマ

 
Expand
表5.16 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定されたプローブを読み取る
Expand
表5.17 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表5.18 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Probe スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表5.20 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表5.21 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Probe スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表5.23 ボディーパラメーター
パラメーター説明

ボディー

Probe スキーマ

 
Expand
表5.24 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Probe スキーマ

201 - Created

Probe スキーマ

401 - Unauthorized

空白

第6章 Prometheus [monitoring.coreos.com/v1]

説明
Prometheus は、Prometheus デプロイメントを定義します。
object
必須
  • 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

Prometheus クラスターの望ましい動作の仕様。詳細: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

status

object

Prometheus クラスターの最新の観測ステータス。read-only詳細: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

6.1.1. .spec

説明
Prometheus クラスターの望ましい動作の仕様。詳細: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
object
Expand
プロパティー説明

additionalAlertManagerConfigs

object

AdditionalAlertManagerConfigs を使用すると、追加の PrometheusAlertManager 設定を含むシークレットのキーを指定できます。指定された AlertManager 設定は、PrometheusOperator によって生成された設定に追加されます。指定するジョブ設定は、Prometheus の公式ドキュメント https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alertmanager_config で指定されている形式である必要があります。AlertManager 設定が追加されると、ユーザーはそれが有効であることを確認する責任があります。この機能を使用すると、Prometheus のアップグレードが中断される可能性があることに注意してください。アップグレード後に互換性のない AlertManager 設定が Prometheus を壊さないように、Prometheus リリースノートを確認することを推奨します。

additionalAlertRelabelConfigs

object

AdditionalAlertRelabelConfigs を使用すると、追加の Prometheus アラート再ラベル付け設定を含むシークレットのキーを指定できます。指定されたアラートのラベル変更設定は、PrometheusOperator によって生成された設定に追加されます。指定するアラートの再ラベル付け設定は、Prometheus の公式ドキュメントで指定されている形式である必要があります: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs。アラートの再ラベル付け設定が追加されると、ユーザーはそれが有効であることを確認する責任があります。この機能を使用すると、Prometheus のアップグレードが中断される可能性があることに注意してください。Prometheus のリリースノートを確認して、アップグレード後に互換性のないアラートのラベル変更設定によって Prometheus が破損しないようにすることを推奨します。

additionalArgs

array

additionalArgs を使用すると、'prometheus' コンテナーに追加の引数を設定できます。これは、専用の設定オプションではまだサポートされていない隠しフラグを有効にする場合などに使用されます。引数はそのまま Prometheus コンテナーに渡されますが、引数が無効であったり、指定された Prometheus バージョンでサポートされていない場合は問題が発生する可能性があります。引数が競合する場合 (たとえば、Operator 自体によってすでに設定されている引数)、または無効な引数を指定すると、調整は失敗し、エラーが記録されます。

additionalArgs[]

object

AdditionalArgs リストの一部である引数。

additionalScrapeConfigs

object

AdditionalScrapeConfigs を使用すると、追加の Prometheus スクレイプ設定を含むシークレットのキーを指定できます。指定されたスクレープ設定は、Prometheus Operator によって生成された設定に追加されます。指定するジョブ設定は、Prometheus の公式ドキュメント https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config で指定されている形式である必要があります。スクレイプ設定が追加されると、ユーザーはそれが有効であることを確認する責任があります。この機能を使用すると、Prometheus のアップグレードが中断される可能性があることに注意してください。アップグレード後に互換性のないスクレイプ設定が Prometheus を壊さないように、Prometheus リリースノートを確認することを推奨します。

affinity

object

指定した場合、Pod のスケジューリング制約。

alerting

object

アラートに関する詳細を定義します。

allowOverlappingBlocks

boolean

AllowOverlappingBlocks は、Prometheus での垂直圧縮と垂直クエリーマージを有効にします。これは Prometheus でまだ実験段階であるため、今後のリリースで変更される可能性があります。

apiserverConfig

object

APIServerConfig を使用すると、apiserver にアクセスするためのホストメソッドと認証メソッドを指定できます。空のままにすると、Prometheus はクラスター内で実行されると想定され、API サーバーを自動的に検出し、Pod の CA 証明書とベアラートークンファイル (/var/run/secrets/kubernetes.io/serviceaccount/) を使用します。

arbitraryFSAccessThroughSMs

object

ArbitraryFSAccessThroughSMs は、サービスモニターに基づく設定が、Prometheus コンテナーのファイルシステム上の任意のファイル (ベアラートークンファイルなど) にアクセスできるかどうかを設定します。

baseImage

string

Prometheus デプロイメントに使用するベースイメージ。非推奨: 代わりに image を使用してください

configMaps

array (string)

ConfigMaps は、Prometheus オブジェクトと同じ namespace にある ConfigMap のリストであり、Prometheus Pod にマウントされます。各 ConfigMap は、configmap-<configmap-name> という名前のボリュームとして StatefulSet 定義に追加されます。configMaps は、'prometheus' コンテナーの /etc/prometheus/configmaps/<configmap-name> にマウントされます。

containers

array

コンテナーを使用すると、追加のコンテナーを挿入したり、Operator が生成したコンテナーを変更したりできます。これを使用して、PrometheusPod に認証プロキシーを追加したり、Operator が生成したコンテナーの動作を変更したりできます。ここで説明するコンテナーは、同じ名前を共有し、戦略的マージパッチを介して変更が行われる場合、Operator が生成したコンテナーを変更します。現在のコンテナー名は、prometheusconfig-reloader、および thanos-sidecar です。コンテナーのオーバーライドは、メンテナーがサポートする範囲外であり、そうすることで、この動作が予告なしにいつでも中断する可能性があることを認めます。

containers[]

object

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

disableCompaction

ブール値

プロメテウスの圧縮を無効にします。

enableAdminAPI

ブール値

prometheusWeb 管理 API へのアクセスを有効にします。デフォルト値は false です。警告: 管理 API を有効にすると、エンドポイントの変更、データの削除、Prometheus のシャットダウンなどが可能になります。これを有効にする場合は注意が必要です。ユーザーは、これらのアクションの実行を許可されたクライアントのみが許可できるように、プロキシーを介して追加の認証許可を追加することを推奨します。詳細については、https://prometheus.io/docs/prometheus/latest/querying/api/#tsdb-admin-apis を参照してください。

enableFeatures

array (string)

Prometheus で無効になっている機能へのアクセスを有効にします。デフォルトでは、機能は有効になっていません。無効化された機能を有効にすることは、メンテナーがサポートする範囲外であり、そうすることで、この動作が予告なしにいつでも中断する可能性があることを認めます。詳細については、https://prometheus.io/docs/prometheus/latest/disabled_features/ を参照してください。

enableRemoteWriteReceiver

boolean

Prometheus を Prometheus リモート書き込みプロトコルのレシーバーとして使用できるようにします。デフォルト値は false です。警告: これは効率的なサンプル取り込み方法とはみなされていません。特定の低ボリュームのユースケースでは注意して使用してください。スクレイピングによる取り込みの代わりに使用して、Prometheus をプッシュベースのメトリクス収集システムに変換するには適していません。詳細については、https://prometheus.io/docs/prometheus/latest/querying/api/#remote-write-receiver Prometheus バージョン 2.33.0 以降でのみ有効です。

enforcedBodySizeLimit

string

EnforcedBodySizeLimit は、Prometheus によって受け入れられる非圧縮応答本体の最大サイズを定義します。この数バイトよりも大きい本文で応答するターゲットは、スクレイプが失敗する原因になります。例:100MB。定義されている場合、制限はすべてのサービス/Pod モニターおよびプローブに適用されます。これは実験的な機能であり、この動作は将来変更または削除される可能性があります。Prometheus バージョン 2.28.0 以降でのみ有効です。

enforcedLabelLimit

integer

サンプルに受け入れられるラベルの数のスクレープごとの制限。メトリックの再ラベル付け後にこの数を超えるラベルが存在する場合、スクレイプ全体が失敗として扱われます。0 は制限がないことを意味します。Prometheus バージョン 2.27.0 以降でのみ有効です。

enforcedLabelNameLengthLimit

integer

サンプルで受け入れられるラベル名の長さのスクレープごとの制限。ラベル名がメトリックの再ラベル付け後にこの番号よりも長い場合、スクレイプ全体が失敗として扱われます。0 は制限がないことを意味します。Prometheus バージョン 2.27.0 以降でのみ有効です。

enforcedLabelValueLengthLimit

integer

サンプルに受け入れられるラベル値の長さのスクレープごとの制限。ラベル値がメトリックの再ラベル付け後にこの数値よりも長い場合、スクレイプ全体が失敗として扱われます。0 は制限がないことを意味します。Prometheus バージョン 2.27.0 以降でのみ有効です。

enforcedNamespaceLabel

string

EnforcedNamespaceLabel 設定されている場合、ラベルは 1.すべてのユーザーメトリック (ServiceMonitorPodMonitor、および ProbeConfig オブジェクトによって作成されます) および 2.すべての PrometheusRule オブジェクト (prometheusRulesExcludedFromEnforce で除外されているオブジェクトを除く) に追加され、*アラートおよび記録ルールと*式で使用されるメトリック (expr)。ラベル名はこのフィールドの値です。ラベル値は、作成されたオブジェクトの名前空間です (上記)。

enforcedSampleLimit

integer

EnforcedSampleLimit は、受け入れられるスクレイプされたサンプルの数に対するグローバル制限を定義します。これは、ServiceMonitor または/および PodMonitor ごとに設定された SampleLimit をオーバーライドします。これは、管理者が SampleLimit を適用して、サンプル/シリーズの総数を目的の制限未満に保つために使用することを目的としています。SampleLimit が低い場合は、代わりにその値が使用されることに注意してください。

enforcedTargetLimit

integer

EnforcedTargetLimit は、スクレイプされたターゲットの数に対するグローバル制限を定義します。これは、ServiceMonitor または/および PodMonitor ごとに設定された TargetLimit をオーバーライドします。これは、管理者が TargetLimit を適用して、ターゲットの総数を目的の制限未満に保つために使用することを目的としています。TargetLimit が低い場合は、いずれかの値がゼロである場合を除いて、代わりにその値が使用されることに注意してください。ゼロ以外の値が使用されます。両方の値がゼロの場合、制限は適用されません。

evaluationInterval

string

連続する評価の間隔。デフォルト: "30s"

excludedFromEnforcement

array

元の namespace ラベルの適用から除外される PodMonitor、ServiceMonitor、Probe、および PrometheusRule オブジェクトへの参照のリスト。enforcedNamespaceLabel が true に設定されている場合にのみ適用されます。

excludedFromEnforcement[]

object

ObjectReference は、PodMonitor、ServiceMonitor、Probe、または PrometheusRule オブジェクトを参照します。

exemplars

object

実行時に再読み込み可能な Exemplar 関連の設定。有効にするには、exemplar-storage 機能フラグを有効にする必要があります。

externalLabels

object (string)

外部システム (フェデレーション、リモートストレージ、Alertmanager) と通信するときに、任意の時系列またはアラートに追加するラベル。

externalUrl

string

Prometheus インスタンスの外部 URL はで利用できます。これは、正しい URL を生成するために必要です。これは、Prometheus が DNS 名のルートから提供されていない場合に必要です。

hostAliases

array

Pod の hostAliases 設定

hostAliases[]

object

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

hostNetwork

boolean

true の場合、ホストのネットワーク namespace を使用します。これを有効にする場合は、セキュリティーへの影響を理解するようにしてください。hostNetwork が有効になっている場合、DNS ポリシーは自動的に ClusterFirstWithHostNet に設定されます。

ignoreNamespaceSelectors

boolean

IgnoreNamespaceSelectors を true に設定すると、すべての PodMonitor、ServiceMonitor、および Probe オブジェクトの NamespaceSelector 設定が無視されます。PodMonitor、ServiceMonitor、および Probe オブジェクトの namespace 内のターゲットのみを検出します。デフォルトは false です。

image

string

指定した場合のイメージは、baseImage、tag、sha の組み合わせよりも優先されます。PrometheusOperator が、設定されている Prometheus のバージョンを確実に認識できるようにするには、バージョンを指定する必要があります。

imagePullSecrets

array

レジストリーから prometheus および alertmanager イメージをプルするために使用する、同じ namespace 内のシークレットへの参照のオプションのリストは、http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod を参照してください。

imagePullSecrets[]

object

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

initContainers

array

InitContainers を使用すると、Pod 定義に initContainers を追加できます。これらは、たとえば、外部ソースから Prometheus 設定に注入するためのシークレットをフェッチするために使用できます。initContainer の実行中にエラーが発生すると、Pod が再起動します。詳細: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ ここで説明する InitContainers は、同じ名前を共有し、戦略的なマージパッチを介して変更が行われる場合は、オペレーターが生成した init コンテナーを変更します。現在の init コンテナー名は init-config-reloader です。init コンテナーのオーバーライドは、メンテナーがサポートする範囲外であり、そうすることで、この動作が予告なしにいつでも中断する可能性があることを認めます。

initContainers[]

object

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

listenLocal

ブール値

ListenLocal は、Prometheus サーバーがループバックでリッスンするようにし、PodIP に対してバインドしないようにします。

logFormat

string

設定する Prometheus のログ形式。

logLevel

string

設定する Prometheus のログレベル。

minReadySeconds

integer

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

nodeSelector

object (string)

Pod がスケジュールされているノードを定義します。

overrideHonorLabels

boolean

true の場合、Prometheus はスクレイプされたデータのラベルの名前を exported_<label value> に変更して、サービスおよび Pod モニターから作成されたすべてのターゲットについてラベルの競合を解決します。それ以外の場合は、サービスまたは Pod モニターの HonorLabels フィールドが適用されます。

overrideHonorTimestamps

boolean

true の場合、Prometheus はサービスおよび Pod モニターから作成されたすべてのターゲットのタイムスタンプを無視します。それ以外の場合は、サービスまたは Pod モニターの HonorTimestamps フィールドが適用されます。

paused

boolean

Prometheus のデプロイメントが一時停止されると、基になるオブジェクトに対して削除以外のアクションは実行されません。

podMetadata

object

PodMetadata は、プロメテウス Pod に伝播されるラベルとアノテーションを設定します。

podMonitorNamespaceSelector

object

PodMonitor 検出に一致する名前空間のラベル。nil の場合は、自分の名前空間のみを確認してください。

podMonitorSelector

object

ターゲット発見のために選択される 実験的 な PodMonitors。非 推奨: this も serviceMonitorSelector も指定されていない場合、設定は管理されません。

portName

string

Pod および管理サービスに使用されるポート名。これはデフォルトで Web になります

priorityClassName

string

Pod に割り当てられた優先度クラス

probeNamespaceSelector

object

プローブ検出用に選択される 実験的 な名前空間。nil の場合は、自分の名前空間のみを確認してください。

probeSelector

object

ターゲット発見のために選択される 実験的 プローブ。

prometheusExternalLabelName

string

Prometheus インスタンス名を示すために使用される Prometheus 外部ラベルの名前。デフォルトは prometheus の値です。値が空の文字列 ("") に設定されている場合、外部ラベルは追加され ません

prometheusRulesExcludedFromEnforce

array

PrometheusRulesExcludedFromEnforce- 名前空間ラベルの追加の強制から除外されるプロメテウスルールのリスト。enforcedNamespaceLabel が true に設定されている場合にのみ機能します。各ペアに ruleNamespace と ruleName の両方が設定されていることを確認してください非推奨:代わりに excludedFromEnforcement を使用してください。

prometheusRulesExcludedFromEnforce[]

object

PrometheusRuleExcludeConfig を使用すると、ユーザーは、アラートとメトリックの namespace ラベルを適用するときに、除外された PrometheusRule 名とその namespace を無視するように設定できます。

query

object

QuerySpec は、Prometheus の起動時にクエリーコマンドラインフラグを定義します。

queryLogFile

string

QueryLogFile は、PromQL クエリーがログに記録されるファイルを指定します。ファイル名に空のパスが含まれる場合 (例: 'query.log')、Prometheus Pod はファイルを /var/log/prometheus の emptyDir ボリュームにマウントします。完全なパスが指定されている場合 (例: '/var/log/prometheus/query.log')、指定されたディレクトリーにボリュームをマウントし、書き込み可能にする必要があります。これは、セキュリティー上の理由から、Prometheus コンテナーが読み取り専用のルートファイルシステムで実行されるためです。または、場所を /dev/stdout などの stdout の場所に設定して、クエリー情報をデフォルトの Prometheus ログストリームに記録することもできます。これは、Prometheus>=2.16.0 のバージョンでのみ使用できます。詳細については、Prometheus のドキュメント (https://prometheus.io/docs/guides/query-log/) を参照してください。

remoteRead

array

remoteRead は、リモート読み取り設定のリストです。

remoteRead[]

object

RemoteReadSpec は、Prometheus がリモートエンドポイントからサンプルを読み戻すための設定を定義します。

remoteWrite

array

remoteWrite は、リモート書き込み設定のリストです。

remoteWrite[]

object

RemoteWriteSpec は、Prometheus からリモートエンドポイントにサンプルを書き込むための設定を定義します。

replicaExternalLabelName

string

レプリカ名を示すために使用される Prometheus 外部ラベルの名前。デフォルトは prometheus_replica の値です。値が空の文字列 ("") に設定されている場合、外部ラベルは追加され ません

replicas

integer

Prometheus デプロイメント用にデプロイする各シャードのレプリカの数。レプリカの数にシャードを掛けたものが、作成された Pod の総数です。

resources

object

単一 Pod のリソース要求と制限を定義します。

retention

string

期間 Prometheus はのデータを保持するものとします。retentionSize が設定されていない場合はデフォルトで 24h であり、正規表現 [0-9]+(ms|s|m|h|d|w|y) (ミリ秒秒分数日週年) と一致する必要があります。

retentionSize

string

ブロックが使用するディスク容量の最大量。

routePrefix

string

ルート接頭辞 Prometheus は、の HTTP ハンドラーを登録します。これは、ExternalURL を使用していて、プロキシーがリクエストの HTTP ルートを書き換えていて、実際の ExternalURL がまだ真であるが、サーバーが別のルート接頭辞でリクエストを処理する場合に便利です。たとえば、kubectl プロキシー で使用します。

ruleNamespaceSelector

object

PrometheusRules 検出用に選択される名前空間。指定しない場合、Prometheus オブジェクトと同じ名前空間のみが使用されます。

ruleSelector

object

アラート/記録ルールをロードするためにマウントする PrometheusRules を選択するためのセレクター。Prometheus Operator v0.24.0 まで (除く)Prometheus Operator は、従来のルール ConfigMaps を RuleSelector によって選択された PrometheusRule カスタムリソースに移行します。移行したくない設定マップと一致しないことを確認してください。

rules

object

/--rules.*/コマンドライン引数。

scrapeInterval

string

連続するスクレイプの間隔。デフォルト: "30s"

scrapeTimeout

string

エラーが発生する前にターゲットが応答するのを待つ秒数。

secrets

array (string)

シークレットは、Prometheus オブジェクトと同じ namespace にあるシークレットのリストであり、Prometheus Pod にマウントされます。各シークレットは、secret-<secret-name> という名前のボリュームとして StatefulSet 定義に追加されます。シークレットは、'prometheus' コンテナーの /etc/prometheus/secrets/<secret-name> にマウントされます。

securityContext

object

SecurityContext は、Pod レベルのセキュリティー属性と一般的なコンテナー設定を保持します。これはデフォルトでデフォルトの PodSecurityContext になります。

serviceAccountName

string

ServiceAccountName は、Prometheus Pod の実行に使用する ServiceAccount の名前です。

serviceMonitorNamespaceSelector

object

ServiceMonitor 検出に一致する名前空間のラベル。nil の場合は、自分の名前空間のみを確認してください。

serviceMonitorSelector

object

ターゲット検出用に選択される ServiceMonitor。非 推奨: this も podMonitorSelector も指定されていない場合、設定は管理されません。

sha

string

デプロイする Prometheus コンテナーイメージの SHA。デフォルトは バージョン の値です。タグに似ていますが、SHA は不変のコンテナーイメージを明示的にデプロイします。SHA が設定されている場合、バージョンとタグは無視されます。非推奨: 代わりに 'image' を使用します。イメージダイジェストは、イメージ URL の一部として指定できます。

shards

integer

実験: ターゲットを配布するシャードの数。レプリカの数にシャードを掛けたものが、作成された Pod の総数です。シャードを縮小しても、データは残りのインスタンスに再シャーディングされないことに注意してください。手動で移動する必要があります。シャードを増やしてもデータはリシャードされませんが、同じインスタンスから引き続き使用できます。グローバルにクエリーを実行するには、Thanos サイドカーと Thanos クエリーアを使用するか、中央の場所にデータをリモートで書き込みます。シャーディングは、アドレス ターゲットメタラベルのコンテンツに対して行われます。

storage

object

ストレージの使用方法を指定するストレージ仕様。

tag

string

デプロイする Prometheus コンテナーイメージのタグ。デフォルトは バージョン の値です。タグが設定されている場合、バージョンは無視されます。非推奨: 代わりに 'image' を使用します。イメージタグは、イメージ URL の一部として指定できます。

thanos

object

Thanos 設定では、Thanos 環境で Prometheus サーバーのさまざまな側面を設定できます。このセクションは実験的なものであり、どのリリースでも非推奨の通知なしに大幅に変更される可能性があります。これは実験的なものであり、どのリリースでも下位互換性がなくても大幅に変更される可能性があります。

tolerations

array

指定されている場合、Pod の許容範囲。

tolerations[]

object

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

topologySpreadConstraints

array

指定した場合、Pod のトポロジー拡散制約。

topologySpreadConstraints[]

object

topologySpreadConstraint は、指定されたトポロジー間で一致する Pod を分散する方法を指定します。

tsdb

object

ランタイムでのリロードが可能な時系列データベース (TSDB) の設定を定義します。

version

string

デプロイする Prometheus のバージョン。

volumeMounts

array

VolumeMounts を使用すると、出力 StatefulSet 定義に追加の VolumeMounts を設定できます。指定された VolumeMounts は、StorageSpec オブジェクトの結果として生成されるプロメテウスコンテナー内の他の VolumeMounts に追加されます。

volumeMounts[]

object

VolumeMount は、コンテナー内でのボリュームのマウントを説明します。

volumes

array

ボリュームを使用すると、出力の StatefulSet 定義に追加のボリュームを設定できます。指定されたボリュームは、StorageSpec オブジェクトの結果として生成される他のボリュームに追加されます。

volumes[]

object

ボリュームは、Pod 内の任意のコンテナーからアクセスできる Pod 内の名前付きボリュームを表します。

walCompression

ブール値

Snappy を使用して先行書き込みログの圧縮を有効にします。このフラグは、Prometheus>=2.11.0 のバージョンでのみ使用できます。

web

object

WebSpec は、Prometheus の起動時に Web コマンドラインフラグを定義します。

6.1.2. .spec.additionalAlertManagerConfigs

Description
AdditionalAlertManagerConfigs を使用すると、追加の PrometheusAlertManager 設定を含むシークレットのキーを指定できます。指定された AlertManager 設定は、PrometheusOperator によって生成された設定に追加されます。指定するジョブ設定は、Prometheus の公式ドキュメント https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alertmanager_config で指定されている形式である必要があります。AlertManager 設定が追加されると、ユーザーはそれが有効であることを確認する責任があります。この機能を使用すると、Prometheus のアップグレードが中断される可能性があることに注意してください。アップグレード後に互換性のない AlertManager 設定が Prometheus を壊さないように、Prometheus リリースノートを確認することを推奨します。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

6.1.3. .spec.additionalAlertRelabelConfigs

Description
AdditionalAlertRelabelConfigs を使用すると、追加の Prometheus アラート再ラベル付け設定を含むシークレットのキーを指定できます。指定されたアラートのラベル変更設定は、PrometheusOperator によって生成された設定に追加されます。指定するアラートの再ラベル付け設定は、Prometheus の公式ドキュメントで指定されている形式である必要があります: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs。アラートの再ラベル付け設定が追加されると、ユーザーはそれが有効であることを確認する責任があります。この機能を使用すると、Prometheus のアップグレードが中断される可能性があることに注意してください。Prometheus のリリースノートを確認して、アップグレード後に互換性のないアラートのラベル変更設定によって Prometheus が破損しないようにすることを推奨します。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

6.1.4. .spec.additionalArgs

説明
additionalArgs を使用すると、'prometheus' コンテナーに追加の引数を設定できます。これは、専用の設定オプションではまだサポートされていない隠しフラグを有効にする場合などに使用されます。引数はそのまま Prometheus コンテナーに渡されますが、引数が無効であったり、指定された Prometheus バージョンでサポートされていない場合は問題が発生する可能性があります。引数が競合する場合 (たとえば、Operator 自体によってすでに設定されている引数)、または無効な引数を指定すると、調整は失敗し、エラーが記録されます。
array

6.1.5. .spec.additionalArgs[]

説明
AdditionalArgs リストの一部である引数。
object
必須
  • name
Expand
プロパティー説明

name

string

引数の名前 (例: "scrape.discovery-reload-interval")。

value

string

引数の値 (例: 30s)。名前のみの引数は空にできます (例: --storage.tsdb.no-lockfile)

6.1.6. .spec.additionalScrapeConfigs

説明
AdditionalScrapeConfigs を使用すると、追加の Prometheus スクレイプ設定を含むシークレットのキーを指定できます。指定されたスクレープ設定は、Prometheus Operator によって生成された設定に追加されます。指定するジョブ設定は、Prometheus の公式ドキュメント https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config で指定されている形式である必要があります。スクレイプ設定が追加されると、ユーザーはそれが有効であることを確認する責任があります。この機能を使用すると、Prometheus のアップグレードが中断される可能性があることに注意してください。アップグレード後に互換性のないスクレイプ設定が Prometheus を壊さないように、Prometheus リリースノートを確認することを推奨します。
object
必須
  • key
Expand
プロパティー説明

key

string

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

name

string

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

任意

boolean

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

6.1.7. .spec.affinity

説明
指定した場合、Pod のスケジューリング制約。
object
Expand
プロパティー説明

nodeAffinity

object

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

podAffinity

object

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

podAntiAffinity

object

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

6.1.8. .spec.affinity.nodeAffinity

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

preferredDuringSchedulingIgnoredDuringExecution

array

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

preferredDuringSchedulingIgnoredDuringExecution[]

object

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

requiredDuringSchedulingIgnoredDuringExecution

object

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

6.1.9. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution

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

6.1.10. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

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

preference

object

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

weight

integer

対応する nodeSelectorTerm の一致に関連する重み (1〜100 の範囲)。

6.1.11. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference

説明
対応する重みに関連付けられたノードセレクター用語。
object
Expand
プロパティー説明

matchExpressions

array

ノードのラベルごとのノードセレクター要件のリスト。

matchExpressions[]

object

ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchFields

array

ノードのフィールドごとのノードセレクター要件のリスト。

matchFields[]

object

ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

6.1.12. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions

説明
ノードのラベルごとのノードセレクター要件のリスト。
array

6.1.13. .spec.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 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

6.1.14. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields

説明
ノードのフィールドごとのノードセレクター要件のリスト。
array

6.1.15. .spec.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 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

6.1.16. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

説明
このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (更新など)、システムは最終的に Pod をノードから削除しようとする場合としない場合があります。
object
必須
  • nodeSelectorTerms
Expand
プロパティー説明

nodeSelectorTerms

array

必須。ノードセレクター用語のリスト。用語は OR されています。

nodeSelectorTerms[]

object

null または空のノードセレクター用語はオブジェクトに一致しません。これらの要件は AND で結合されます。TopologySelectorTerm タイプは、NodeSelectorTerm のサブセットを実装します。

6.1.17. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

説明
必須。ノードセレクター用語のリスト。用語は OR されています。
array

6.1.18. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[]

説明
null または空のノードセレクター用語はオブジェクトに一致しません。これらの要件は AND で結合されます。TopologySelectorTerm タイプは、NodeSelectorTerm のサブセットを実装します。
object
Expand
プロパティー説明

matchExpressions

array

ノードのラベルごとのノードセレクター要件のリスト。

matchExpressions[]

object

ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchFields

array

ノードのフィールドごとのノードセレクター要件のリスト。

matchFields[]

object

ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

6.1.19. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions

説明
ノードのラベルごとのノードセレクター要件のリスト。
array

6.1.20. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].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 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

6.1.21. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields

説明
ノードのフィールドごとのノードセレクター要件のリスト。
array

6.1.22. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].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 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

6.1.23. .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 が実行されているノードの値と一致するノードで実行されていることを意味します。

6.1.24. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution

説明
スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードに対応する podAffinityTerm に一致する Pod がある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。
array

6.1.25. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

説明
一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。
object
必須
  • podAffinityTerm
  • weight
Expand
プロパティー説明

podAffinityTerm

object

必須。対応する重みに関連付けられた Pod アフィニティー用語。

weight

integer

対応する podAffinityTerm の一致に関連する重み (1〜100 の範囲)。

6.1.26. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm

説明
必須。対応する重みに関連付けられた Pod アフィニティー用語。
object
必須
  • topologyKey
Expand
プロパティー説明

labelSelector

object

リソースのセット (この場合は Pod) に対するラベルクエリー。

namespaceSelector

object

用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。

namespaces

array (string)

namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび nullnamespaceSelector は、"この Pod の namespace" を意味します

topologyKey

string

この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。

6.1.27. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector

説明
リソースのセット (この場合は 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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

6.1.30. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

6.1.33. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution

説明
このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから削除しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。
array

6.1.34. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[]

説明
この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。
object
必須
  • topologyKey
Expand
プロパティー説明

labelSelector

object

リソースのセット (この場合は Pod) に対するラベルクエリー。

namespaceSelector

object

用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。

namespaces

array (string)

namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび nullnamespaceSelector は、"この Pod の namespace" を意味します

topologyKey

string

この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。

6.1.35. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector

説明
リソースのセット (この場合は 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 で結合されます。

6.1.36. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

6.1.37. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

6.1.38. .spec.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 で結合されます。

6.1.39. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

6.1.40. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

6.1.41. .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 が実行されているノードの値と一致するノードで実行されていることを意味します。

6.1.42. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution

説明
スケジューラーは、このフィールドで指定された非アフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アンチアフィニティー式など) を満たすノードごとに、の要素を反復処理して合計を計算します。このフィールドと、対応する podAffinityTerm に一致する Pod がノードにある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。
array

6.1.43. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

説明
一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。
object
必須
  • podAffinityTerm
  • weight
Expand
プロパティー説明

podAffinityTerm

object

必須。対応する重みに関連付けられた Pod アフィニティー用語。

weight

integer

対応する podAffinityTerm の一致に関連する重み (1〜100 の範囲)。

6.1.44. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm

説明
必須。対応する重みに関連付けられた Pod アフィニティー用語。
object
必須
  • topologyKey
Expand
プロパティー説明

labelSelector

object

リソースのセット (この場合は Pod) に対するラベルクエリー。

namespaceSelector

object

用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。

namespaces

array (string)

namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび nullnamespaceSelector は、"この Pod の namespace" を意味します

topologyKey

string

この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。

6.1.45. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector

説明
リソースのセット (この場合は 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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

6.1.48. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

6.1.51. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution

説明
このフィールドで指定された非アフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定された非アフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから削除しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。
array

6.1.52. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[]

説明
この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。
object
必須
  • topologyKey
Expand
プロパティー説明

labelSelector

object

リソースのセット (この場合は Pod) に対するラベルクエリー。

namespaceSelector

object

用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。

namespaces

array (string)

namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび nullnamespaceSelector は、"この Pod の namespace" を意味します

topologyKey

string

この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。

6.1.53. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector

説明
リソースのセット (この場合は 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 で結合されます。

6.1.54. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

6.1.55. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

6.1.56. .spec.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 で結合されます。

6.1.57. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

6.1.59. .spec.alerting

Description
アラートに関する詳細を定義します。
タイプ
object
必須
  • alertmanagers
Expand
プロパティー説明

alertmanagers

array

AlertmanagerEndpoints Prometheus がアラートを発する対象。

alertmanagers[]

object

AlertmanagerEndpoints は、アラートを発生させるアラートマネージャー IP を含む単一の Endpoints オブジェクトの選択を定義します。

6.1.60. .spec.alerting.alertmanagers

説明
AlertmanagerEndpoints Prometheus がアラートを発する対象。
array

6.1.61. .spec.alerting.alertmanagers[]

Description
AlertmanagerEndpoints は、アラートを発生させるアラートマネージャー IP を含む単一の Endpoints オブジェクトの選択を定義します。
タイプ
object
必須
  • name
  • namespace
  • port
Expand
プロパティー説明

apiVersion

string

Prometheus がアラートの送信に使用する Alertmanager API のバージョン。"v1" または "v2" を使用できます。

authorization

object

この alertmanager エンドポイントの承認セクション

bearerTokenFile

string

Alertmanager への認証時に使用するファイルシステムから読み取る BearerTokenFile。

name

string

名前空間内の Endpoints オブジェクトの名前。

namespace

string

Endpoints オブジェクトの名前空間。

pathPrefix

string

HTTP パスアラートの接頭辞はにプッシュされます。

port

integer-or-string

AlertmanagerAPI が公開されているポート。

scheme

string

アラートを発するときに使用するスキーム。

timeout

string

タイムアウトは、アラートをプッシュするときのターゲットごとの Alertmanager タイムアウトです。

tlsConfig

object

alertmanager 接続に使用する TLS 設定。

6.1.62. .spec.alerting.alertmanagers[].authorization

Description
この alertmanager エンドポイントの承認セクション
タイプ
object
Expand
プロパティー説明

credentials

object

リクエストのクレデンシャルを含むシークレットのキー

type

string

認証タイプを設定します。デフォルトは Bearer で、Basic はエラーを引き起こします

6.1.63. .spec.alerting.alertmanagers[].authorization.credentials

Description
リクエストのクレデンシャルを含むシークレットのキー
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.64. .spec.alerting.alertmanagers[].tlsConfig

Description
alertmanager 接続に使用する TLS 設定。
タイプ
object
Expand
プロパティー説明

ca

object

ターゲットに使用する CA 証明書を含む構造体。

caFile

string

ターゲットに使用する Prometheus コンテナー内の CA 証明書へのパス。

cert

object

ターゲットのクライアント証明書ファイルを含む構造体。

certFile

string

ターゲットの Prometheus コンテナー内のクライアント証明書ファイルへのパス。

insecureSkipVerify

boolean

ターゲット証明書の検証を無効にします。

keyFile

string

ターゲットの Prometheus コンテナー内のクライアントキーファイルへのパス。

keySecret

object

ターゲットのクライアントキーファイルを含むシークレット。

serverName

string

ターゲットのホスト名を確認するために使用されます。

6.1.65. .spec.alerting.alertmanagers[].tlsConfig.ca

Description
ターゲットに使用する CA 証明書を含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

6.1.66. .spec.alerting.alertmanagers[].tlsConfig.ca.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

6.1.67. .spec.alerting.alertmanagers[].tlsConfig.ca.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.68. .spec.alerting.alertmanagers[].tlsConfig.cert

Description
ターゲットのクライアント証明書ファイルを含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

6.1.69. .spec.alerting.alertmanagers[].tlsConfig.cert.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

6.1.70. .spec.alerting.alertmanagers[].tlsConfig.cert.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.71. .spec.alerting.alertmanagers[].tlsConfig.keySecret

説明
ターゲットのクライアントキーファイルを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.72. .spec.apiserverConfig

Description
APIServerConfig を使用すると、apiserver にアクセスするためのホストメソッドと認証メソッドを指定できます。空のままにすると、Prometheus はクラスター内で実行されると想定され、API サーバーを自動的に検出し、Pod の CA 証明書とベアラートークンファイル (/var/run/secrets/kubernetes.io/serviceaccount/) を使用します。
タイプ
object
必須
  • host
Expand
プロパティー説明

authorization

object

apiserver にアクセスするための承認セクション

basicAuth

object

BasicAuth を使用すると、エンドポイントは基本認証を介して認証できます

bearerToken

string

apiserver にアクセスするためのベアラートークン。

bearerTokenFile

string

apiserver にアクセスするためのベアラトークンを読み取るためのファイル。

host

string

apiserver のホスト。ホスト名または IP とそれに続くオプションのポート番号で設定される有効な文字列

tlsConfig

object

apiserver へのアクセスに使用する TLS 設定。

6.1.73. .spec.apiserverConfig.authorization

Description
apiserver にアクセスするための承認セクション
タイプ
object
Expand
プロパティー説明

credentials

object

リクエストのクレデンシャルを含むシークレットのキー

credentialsFile

string

クレデンシャルと相互に排他的な (SafeAuthorization からの) シークレットを読み取るファイル

type

string

認証タイプを設定します。デフォルトは Bearer で、Basic はエラーを引き起こします

6.1.74. .spec.apiserverConfig.authorization.credentials

Description
リクエストのクレデンシャルを含むシークレットのキー
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.75. .spec.apiserverConfig.basicAuth

Description
BasicAuth を使用すると、エンドポイントは基本認証を介して認証できます
タイプ
object
Expand
プロパティー説明

password

object

認証用のパスワードを含むサービスモニター名前空間のシークレット。

username

object

認証用のユーザー名を含むサービスモニター名前空間のシークレット。

6.1.76. .spec.apiserverConfig.basicAuth.password

Description
認証用のパスワードを含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.77. .spec.apiserverConfig.basicAuth.username

Description
認証用のユーザー名を含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.78. .spec.apiserverConfig.tlsConfig

Description
apiserver へのアクセスに使用する TLS 設定。
タイプ
object
Expand
プロパティー説明

ca

object

ターゲットに使用する CA 証明書を含む構造体。

caFile

string

ターゲットに使用する Prometheus コンテナー内の CA 証明書へのパス。

cert

object

ターゲットのクライアント証明書ファイルを含む構造体。

certFile

string

ターゲットの Prometheus コンテナー内のクライアント証明書ファイルへのパス。

insecureSkipVerify

boolean

ターゲット証明書の検証を無効にします。

keyFile

string

ターゲットの Prometheus コンテナー内のクライアントキーファイルへのパス。

keySecret

object

ターゲットのクライアントキーファイルを含むシークレット。

serverName

string

ターゲットのホスト名を確認するために使用されます。

6.1.79. .spec.apiserverConfig.tlsConfig.ca

Description
ターゲットに使用する CA 証明書を含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

6.1.80. .spec.apiserverConfig.tlsConfig.ca.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

6.1.81. .spec.apiserverConfig.tlsConfig.ca.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.82. .spec.apiserverConfig.tlsConfig.cert

Description
ターゲットのクライアント証明書ファイルを含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

6.1.83. .spec.apiserverConfig.tlsConfig.cert.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

6.1.84. .spec.apiserverConfig.tlsConfig.cert.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.85. .spec.apiserverConfig.tlsConfig.keySecret

説明
ターゲットのクライアントキーファイルを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.86. .spec.arbitraryFSAccessThroughSMs

Description
ArbitraryFSAccessThroughSMs は、サービスモニターに基づく設定が、Prometheus コンテナーのファイルシステム上の任意のファイル (ベアラートークンファイルなど) にアクセスできるかどうかを設定します。
タイプ
object
Expand
プロパティー説明

deny

boolean

 

6.1.87. .spec.containers

説明
コンテナーを使用すると、追加のコンテナーを挿入したり、Operator が生成したコンテナーを変更したりできます。これを使用して、PrometheusPod に認証プロキシーを追加したり、Operator が生成したコンテナーの動作を変更したりできます。ここで説明するコンテナーは、同じ名前を共有し、戦略的マージパッチを介して変更が行われる場合、Operator が生成したコンテナーを変更します。現在のコンテナー名は、prometheusconfig-reloader、および thanos-sidecar です。コンテナーのオーバーライドは、メンテナーがサポートする範囲外であり、そうすることで、この動作が予告なしにいつでも中断する可能性があることを認めます。
array

6.1.88. .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 のソースを表します

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

resources

object

このコンテナーに必要なコンピューティングリソース。これは更新できません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

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

コンテナーの作業ディレクトリー。指定しない場合、コンテナーランタイムのデフォルトが使用されます。これは、コンテナーイメージで設定されている可能性があります。これを更新することはできません。

6.1.89. .spec.containers[].env

説明
コンテナーに設定する環境変数のリスト。これは更新できません。
array

6.1.90. .spec.containers[].env[]

説明
EnvVar は、コンテナーに存在する環境変数を表します。
object
必須
  • name
Expand
プロパティー説明

name

string

環境変数の名前。C_IDENTIFIER でなければなりません。

value

string

変数参照 $(VAR_NAME) は、コンテナー内で以前に定義された環境変数と任意のサービス環境変数を使用してデプロイメントされます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。デフォルトは "" です。

valueFrom

object

環境変数の値のソースです。値が空でない場合は使用できません。

6.1.91. .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 でシークレットのキーを選択します

6.1.92. .spec.containers[].env[].valueFrom.configMapKeyRef

説明
ConfigMap のキーを選択します。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

6.1.93. .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 バージョンで選択するフィールドのパス。

6.1.94. .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

必須: 選択するリソース

6.1.95. .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 TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.96. .spec.containers[].envFrom

説明
コンテナー内の環境変数に入力するソースのリスト。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。これは更新できません。
array

6.1.97. .spec.containers[].envFrom[]

説明
EnvFromSource は、一連の ConfigMap のソースを表します
object
Expand
プロパティー説明

configMapRef

object

選択する ConfigMap

prefix

string

ConfigMap の各キーの前に追加するオプションの識別子。C_IDENTIFIER でなければなりません。

secretRef

object

から選択する秘密

6.1.98. .spec.containers[].envFrom[].configMapRef

説明
選択する ConfigMap
object
Expand
プロパティー説明

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap を定義する必要があるかどうかを指定します

6.1.99. .spec.containers[].envFrom[].secretRef

説明
から選択する秘密
object
Expand
プロパティー説明

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットを定義する必要があるかどうかを指定します

6.1.100. .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

6.1.101. .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 リクエストを指定します。

tcpSocket

object

非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。

6.1.102. .spec.containers[].lifecycle.postStart.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

6.1.103. .spec.containers[].lifecycle.postStart.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

6.1.104. .spec.containers[].lifecycle.postStart.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

6.1.105. .spec.containers[].lifecycle.postStart.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

6.1.106. .spec.containers[].lifecycle.postStart.tcpSocket

説明
非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

6.1.107. .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 リクエストを指定します。

tcpSocket

object

非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。

6.1.108. .spec.containers[].lifecycle.preStop.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

6.1.109. .spec.containers[].lifecycle.preStop.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

6.1.110. .spec.containers[].lifecycle.preStop.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

6.1.111. .spec.containers[].lifecycle.preStop.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

6.1.112. .spec.containers[].lifecycle.preStop.tcpSocket

説明
非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

6.1.113. .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 ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。

httpGet

object

HTTPGet は、実行する http リクエストを指定します。

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

6.1.114. .spec.containers[].livenessProbe.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

6.1.115. .spec.containers[].livenessProbe.grpc

説明
GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
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 によって定義されます。

6.1.116. .spec.containers[].livenessProbe.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

6.1.117. .spec.containers[].livenessProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

6.1.118. .spec.containers[].livenessProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

6.1.119. .spec.containers[].livenessProbe.tcpSocket

説明
TCPSocket は、TCP ポートを含むアクションを指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

6.1.120. .spec.containers[].ports

説明
コンテナーから公開するポートのリスト。ここでポートを指定しなくても、そのポートが公開されるのを防ぐことはできません。コンテナー内のデフォルトの "0.0.0.0" アドレスをリッスンしているポートは、ネットワークからアクセスできます。戦略的マージパッチを使用してこの配列を変更すると、データが破損する可能性があります。詳細は、https://github.com/kubernetes/kubernetes/issues/108255 を参照してください。これは更新できません。
array

6.1.121. .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" です。

6.1.122. .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 ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。

httpGet

object

HTTPGet は、実行する http リクエストを指定します。

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

6.1.123. .spec.containers[].readinessProbe.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

6.1.124. .spec.containers[].readinessProbe.grpc

説明
GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
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 によって定義されます。

6.1.125. .spec.containers[].readinessProbe.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

6.1.126. .spec.containers[].readinessProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

6.1.127. .spec.containers[].readinessProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

6.1.128. .spec.containers[].readinessProbe.tcpSocket

説明
TCPSocket は、TCP ポートを含むアクションを指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

6.1.129. .spec.containers[].resources

説明
このコンテナーに必要なコンピューティングリソース。これは更新できません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。
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/ を参照してください。

6.1.130. .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 の場合は、このフィールドは設定できないことに注意してください。

capabilities

object

コンテナーの実行時に追加/削除する機能。デフォルトは、コンテナーランタイムによって付与されるデフォルトの機能セットです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

privileged

boolean

コンテナーを特権モードで実行します。特権コンテナー内のプロセスは、基本的にホスト上の root と同等です。デフォルトは false です。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

procMount

string

procMount は、コンテナーに使用する proc マウントのタイプを示します。デフォルトは DefaultProcMount で、読み取り専用パスとマスクされたパスにコンテナーランタイムのデフォルトを使用します。これには、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 の場合は、このフィールドを設定できないことに注意してください。

6.1.131. .spec.containers[].securityContext.capabilities

説明
コンテナーの実行時に追加/削除する機能。デフォルトは、コンテナーランタイムによって付与されるデフォルトの機能セットです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
object
Expand
プロパティー説明

add

array (string)

追加された機能

drop

array (string)

削除された機能

6.1.132. .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 ユーザーラベルです。

6.1.133. .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- コンテナーのランタイムデフォルトプロファイルを使用する必要があります。制限なし - プロファイルを適用しないでください。

6.1.134. .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' コンテナーとして実行する必要があるかどうかを決定します。このフィールドはアルファレベルであり、WindowsHostProcessContainers 機能フラグを有効にするコンポーネントによってのみ尊重されます。機能フラグなしでこのフィールドを設定すると、Pod の検証時にエラーが発生します。Pod のすべてのコンテナーは、同じ有効な HostProcess 値を持っている必要があります (HostProcess コンテナーと非 HostProcess コンテナーを混在させることはできません)。さらに、HostProcess が true の場合、HostNetwork も true に設定する必要があります。

runAsUserName

string

コンテナープロセスのエントリーポイントを実行するための Windows の UserName。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。

6.1.135. .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 ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。

httpGet

object

HTTPGet は、実行する http リクエストを指定します。

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

6.1.136. .spec.containers[].startupProbe.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

6.1.137. .spec.containers[].startupProbe.grpc

説明
GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
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 によって定義されます。

6.1.138. .spec.containers[].startupProbe.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

6.1.139. .spec.containers[].startupProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

6.1.140. .spec.containers[].startupProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

6.1.141. .spec.containers[].startupProbe.tcpSocket

説明
TCPSocket は、TCP ポートを含むアクションを指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

6.1.142. .spec.containers[].volumeDevices

説明
volumeDevices は、コンテナーによって使用されるブロックデバイスのリストです。
array

6.1.143. .spec.containers[].volumeDevices[]

説明
volumeDevice は、コンテナー内の raw ブロックデバイスのマッピングを記述します。
object
必須
  • devicePath
  • name
Expand
プロパティー説明

devicePath

string

devicePath は、デバイスがマップされるコンテナー内のパスです。

name

string

name は、Pod 内の persistentVolumeClaim の名前と一致する必要があります

6.1.144. .spec.containers[].volumeMounts

説明
コンテナーのファイルシステムにマウントする Pod ボリューム。これは更新できません。
array

6.1.145. .spec.containers[].volumeMounts[]

説明
VolumeMount は、コンテナー内でのボリュームのマウントを説明します。
object
必須
  • mountPath
  • name
Expand
プロパティー説明

mountPath

string

ボリュームをマウントする必要があるコンテナー内のパス。':' を含めることはできません。

mountPropagation

string

mountPropagation は、マウントがホストからコンテナーに、またはその逆にどのように伝播されるかを決定します。設定されていない場合、MountPropagationNone が使用されます。このフィールドは 1.10 のベータ版です。

name

string

ボリュームの名前に一致する必要があります。

readOnly

boolean

true の場合は読み取り専用、それ以外の場合は読み取り/書き込み (false または指定なし) でマウントされます。デフォルトは false です。

subPath

string

コンテナーのボリュームをマウントする必要があるボリューム内のパス。デフォルトは "" (ボリュームのルート) です。

subPathExpr

string

コンテナーのボリュームをマウントする必要があるボリューム内の拡張パス。SubPath と同様に動作しますが、環境変数参照 $(VAR_NAME) は、コンテナーの環境を使用してデプロイメントされます。デフォルトは "" (ボリュームのルート) です。SubPathExpr と SubPath は相互に排他的です。

6.1.146. .spec.excludedFromEnforcement

説明
元の namespace ラベルの適用から除外される PodMonitor、ServiceMonitor、Probe、および PrometheusRule オブジェクトへの参照のリスト。enforcedNamespaceLabel が true に設定されている場合にのみ適用されます。
array

6.1.147. .spec.excludedFromEnforcement[]

説明
ObjectReference は、PodMonitor、ServiceMonitor、Probe、または PrometheusRule オブジェクトを参照します。
object
必須
  • namespace
  • resource
Expand
プロパティー説明

group

string

参照先のグループ。指定しない場合は、デフォルトで monitoring.coreos.com になります。

name

string

参照先の名前。設定されていない場合、すべてのリソースが一致します。

namespace

string

参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resource

string

参照先のリソース。

6.1.148. .spec.exemplars

説明
実行時に再読み込み可能な Exemplar 関連の設定。有効にするには、exemplar-storage 機能フラグを有効にする必要があります。
object
Expand
プロパティー説明

maxSize

integer

すべてのシリーズでメモリーに保存されるエグザンプラーの最大数。設定されていない場合、Prometheus はデフォルト値を使用します。値が 0 または 0 未満の場合、ストレージは無効になります。

6.1.149. .spec.hostAliases

説明
Pod の hostAliases 設定
array

6.1.150. .spec.hostAliases[]

説明
HostAlias は、Pod の hosts ファイルのエントリーとして挿入される IP とホスト名の間のマッピングを保持します。
object
必須
  • hostnames
  • ip
Expand
プロパティー説明

hostnames

array (string)

上記の IP アドレスのホスト名。

ip

string

ホストファイルエントリーの IP アドレス。

6.1.151. .spec.imagePullSecrets

説明
レジストリーから prometheus および alertmanager イメージをプルするために使用する、同じ namespace 内のシークレットへの参照のオプションのリストは、http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod を参照してください。
array

6.1.152. .spec.imagePullSecrets[]

説明
LocalObjectReference には、同じ namespace 内で参照オブジェクトを見つけるのに十分な情報が含まれます。
object
Expand
プロパティー説明

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

6.1.153. .spec.initContainers

説明
InitContainers を使用すると、Pod 定義に initContainers を追加できます。これらは、たとえば、外部ソースから Prometheus 設定に注入するためのシークレットをフェッチするために使用できます。initContainer の実行中にエラーが発生すると、Pod が再起動します。詳細: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ ここで説明する InitContainers は、同じ名前を共有し、戦略的なマージパッチを介して変更が行われる場合は、オペレーターが生成した init コンテナーを変更します。現在の init コンテナー名は init-config-reloader です。init コンテナーのオーバーライドは、メンテナーがサポートする範囲外であり、そうすることで、この動作が予告なしにいつでも中断する可能性があることを認めます。
array

6.1.154. .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 のソースを表します

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

resources

object

このコンテナーに必要なコンピューティングリソース。これは更新できません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

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

コンテナーの作業ディレクトリー。指定しない場合、コンテナーランタイムのデフォルトが使用されます。これは、コンテナーイメージで設定されている可能性があります。これを更新することはできません。

6.1.155. .spec.initContainers[].env

説明
コンテナーに設定する環境変数のリスト。これは更新できません。
array

6.1.156. .spec.initContainers[].env[]

説明
EnvVar は、コンテナーに存在する環境変数を表します。
object
必須
  • name
Expand
プロパティー説明

name

string

環境変数の名前。C_IDENTIFIER でなければなりません。

value

string

変数参照 $(VAR_NAME) は、コンテナー内で以前に定義された環境変数と任意のサービス環境変数を使用してデプロイメントされます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。デフォルトは "" です。

valueFrom

object

環境変数の値のソースです。値が空でない場合は使用できません。

6.1.157. .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 でシークレットのキーを選択します

6.1.158. .spec.initContainers[].env[].valueFrom.configMapKeyRef

説明
ConfigMap のキーを選択します。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

6.1.159. .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 バージョンで選択するフィールドのパス。

6.1.160. .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

必須: 選択するリソース

6.1.161. .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 TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.162. .spec.initContainers[].envFrom

説明
コンテナー内の環境変数に入力するソースのリスト。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。これは更新できません。
array

6.1.163. .spec.initContainers[].envFrom[]

説明
EnvFromSource は、一連の ConfigMap のソースを表します
object
Expand
プロパティー説明

configMapRef

object

選択する ConfigMap

prefix

string

ConfigMap の各キーの前に追加するオプションの識別子。C_IDENTIFIER でなければなりません。

secretRef

object

から選択する秘密

6.1.164. .spec.initContainers[].envFrom[].configMapRef

説明
選択する ConfigMap
object
Expand
プロパティー説明

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap を定義する必要があるかどうかを指定します

6.1.165. .spec.initContainers[].envFrom[].secretRef

説明
から選択する秘密
object
Expand
プロパティー説明

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットを定義する必要があるかどうかを指定します

6.1.166. .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

6.1.167. .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 リクエストを指定します。

tcpSocket

object

非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。

6.1.168. .spec.initContainers[].lifecycle.postStart.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

6.1.169. .spec.initContainers[].lifecycle.postStart.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

6.1.170. .spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

6.1.171. .spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

6.1.172. .spec.initContainers[].lifecycle.postStart.tcpSocket

説明
非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

6.1.173. .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 リクエストを指定します。

tcpSocket

object

非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。

6.1.174. .spec.initContainers[].lifecycle.preStop.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

6.1.175. .spec.initContainers[].lifecycle.preStop.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

6.1.176. .spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

6.1.177. .spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

6.1.178. .spec.initContainers[].lifecycle.preStop.tcpSocket

説明
非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

6.1.179. .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 ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。

httpGet

object

HTTPGet は、実行する http リクエストを指定します。

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

6.1.180. .spec.initContainers[].livenessProbe.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

6.1.181. .spec.initContainers[].livenessProbe.grpc

説明
GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
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 によって定義されます。

6.1.182. .spec.initContainers[].livenessProbe.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

6.1.183. .spec.initContainers[].livenessProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

6.1.184. .spec.initContainers[].livenessProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

6.1.185. .spec.initContainers[].livenessProbe.tcpSocket

説明
TCPSocket は、TCP ポートを含むアクションを指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

6.1.186. .spec.initContainers[].ports

説明
コンテナーから公開するポートのリスト。ここでポートを指定しなくても、そのポートが公開されるのを防ぐことはできません。コンテナー内のデフォルトの "0.0.0.0" アドレスをリッスンしているポートは、ネットワークからアクセスできます。戦略的マージパッチを使用してこの配列を変更すると、データが破損する可能性があります。詳細は、https://github.com/kubernetes/kubernetes/issues/108255 を参照してください。これは更新できません。
array

6.1.187. .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" です。

6.1.188. .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 ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。

httpGet

object

HTTPGet は、実行する http リクエストを指定します。

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

6.1.189. .spec.initContainers[].readinessProbe.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

6.1.190. .spec.initContainers[].readinessProbe.grpc

説明
GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
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 によって定義されます。

6.1.191. .spec.initContainers[].readinessProbe.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

6.1.192. .spec.initContainers[].readinessProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

6.1.193. .spec.initContainers[].readinessProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

6.1.194. .spec.initContainers[].readinessProbe.tcpSocket

説明
TCPSocket は、TCP ポートを含むアクションを指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

6.1.195. .spec.initContainers[].resources

説明
このコンテナーに必要なコンピューティングリソース。これは更新できません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。
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/ を参照してください。

6.1.196. .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 の場合は、このフィールドは設定できないことに注意してください。

capabilities

object

コンテナーの実行時に追加/削除する機能。デフォルトは、コンテナーランタイムによって付与されるデフォルトの機能セットです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

privileged

boolean

コンテナーを特権モードで実行します。特権コンテナー内のプロセスは、基本的にホスト上の root と同等です。デフォルトは false です。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

procMount

string

procMount は、コンテナーに使用する proc マウントのタイプを示します。デフォルトは DefaultProcMount で、読み取り専用パスとマスクされたパスにコンテナーランタイムのデフォルトを使用します。これには、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 の場合は、このフィールドを設定できないことに注意してください。

6.1.197. .spec.initContainers[].securityContext.capabilities

説明
コンテナーの実行時に追加/削除する機能。デフォルトは、コンテナーランタイムによって付与されるデフォルトの機能セットです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
object
Expand
プロパティー説明

add

array (string)

追加された機能

drop

array (string)

削除された機能

6.1.198. .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 ユーザーラベルです。

6.1.199. .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- コンテナーのランタイムデフォルトプロファイルを使用する必要があります。制限なし - プロファイルを適用しないでください。

6.1.200. .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' コンテナーとして実行する必要があるかどうかを決定します。このフィールドはアルファレベルであり、WindowsHostProcessContainers 機能フラグを有効にするコンポーネントによってのみ尊重されます。機能フラグなしでこのフィールドを設定すると、Pod の検証時にエラーが発生します。Pod のすべてのコンテナーは、同じ有効な HostProcess 値を持っている必要があります (HostProcess コンテナーと非 HostProcess コンテナーを混在させることはできません)。さらに、HostProcess が true の場合、HostNetwork も true に設定する必要があります。

runAsUserName

string

コンテナープロセスのエントリーポイントを実行するための Windows の UserName。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。

6.1.201. .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 ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。

httpGet

object

HTTPGet は、実行する http リクエストを指定します。

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

6.1.202. .spec.initContainers[].startupProbe.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

6.1.203. .spec.initContainers[].startupProbe.grpc

説明
GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
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 によって定義されます。

6.1.204. .spec.initContainers[].startupProbe.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

6.1.205. .spec.initContainers[].startupProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

6.1.206. .spec.initContainers[].startupProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

6.1.207. .spec.initContainers[].startupProbe.tcpSocket

説明
TCPSocket は、TCP ポートを含むアクションを指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

6.1.208. .spec.initContainers[].volumeDevices

説明
volumeDevices は、コンテナーによって使用されるブロックデバイスのリストです。
array

6.1.209. .spec.initContainers[].volumeDevices[]

説明
volumeDevice は、コンテナー内の raw ブロックデバイスのマッピングを記述します。
object
必須
  • devicePath
  • name
Expand
プロパティー説明

devicePath

string

devicePath は、デバイスがマップされるコンテナー内のパスです。

name

string

name は、Pod 内の persistentVolumeClaim の名前と一致する必要があります

6.1.210. .spec.initContainers[].volumeMounts

説明
コンテナーのファイルシステムにマウントする Pod ボリューム。これは更新できません。
array

6.1.211. .spec.initContainers[].volumeMounts[]

説明
VolumeMount は、コンテナー内でのボリュームのマウントを説明します。
object
必須
  • mountPath
  • name
Expand
プロパティー説明

mountPath

string

ボリュームをマウントする必要があるコンテナー内のパス。':' を含めることはできません。

mountPropagation

string

mountPropagation は、マウントがホストからコンテナーに、またはその逆にどのように伝播されるかを決定します。設定されていない場合、MountPropagationNone が使用されます。このフィールドは 1.10 のベータ版です。

name

string

ボリュームの名前に一致する必要があります。

readOnly

boolean

true の場合は読み取り専用、それ以外の場合は読み取り/書き込み (false または指定なし) でマウントされます。デフォルトは false です。

subPath

string

コンテナーのボリュームをマウントする必要があるボリューム内のパス。デフォルトは "" (ボリュームのルート) です。

subPathExpr

string

コンテナーのボリュームをマウントする必要があるボリューム内の拡張パス。SubPath と同様に動作しますが、環境変数参照 $(VAR_NAME) は、コンテナーの環境を使用してデプロイメントされます。デフォルトは "" (ボリュームのルート) です。SubPathExpr と SubPath は相互に排他的です。

6.1.212. .spec.podMetadata

Description
PodMetadata は、プロメテウス Pod に伝播されるラベルとアノテーションを設定します。
タイプ
object
Expand
プロパティー説明

annotations

object (string)

アノテーションは、任意のメタデータを保存し、取得するために外部ツールで設定できる、リソースとともに保存される構造化されていないキー値のマップです。これらはクエリーできないため、オブジェクトを変更する場合に維持する必要があります。詳細: http://kubernetes.io/docs/user-guide/annotations

labels

object (string)

オブジェクトの整理と分類 (スコープと選択) に使用できる文字列キーと値のマップ。レプリケーションコントローラーおよびサービスのセレクターと一致する場合があります。詳細: http://kubernetes.io/docs/user-guide/labels

name

string

name は namespace 内で一意である必要があります。リソースの作成時に必要ですが、リソースによっては、クライアントが適切な名前の生成を自動的に要求することを許可する場合があります。name は、主にべき等性と設定定義の作成を目的としています。これを更新することはできません。詳細: http://kubernetes.io/docs/user-guide/identifiers#names

6.1.213. .spec.podMonitorNamespaceSelector

Description
PodMonitor 検出に一致する名前空間のラベル。nil の場合は、自分の名前空間のみを確認してください。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

6.1.214. .spec.podMonitorNamespaceSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

6.1.215. .spec.podMonitorNamespaceSelector.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

6.1.216. .spec.podMonitorSelector

Description
ターゲット発見のために選択される 実験的 な PodMonitors。非 推奨: this も serviceMonitorSelector も指定されていない場合、設定は管理されません。
タイプ
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

6.1.217. .spec.podMonitorSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

6.1.218. .spec.podMonitorSelector.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

6.1.219. .spec.probeNamespaceSelector

Description
プローブ検出用に選択される 実験的 な名前空間。nil の場合は、自分の名前空間のみを確認してください。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

6.1.220. .spec.probeNamespaceSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

6.1.221. .spec.probeNamespaceSelector.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

6.1.222. .spec.probeSelector

Description
ターゲット発見のために選択される 実験的 プローブ。
タイプ
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

6.1.223. .spec.probeSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

6.1.224. .spec.probeSelector.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

6.1.225. .spec.prometheusRulesExcludedFromEnforce

Description
PrometheusRulesExcludedFromEnforce- 名前空間ラベルの追加の強制から除外されるプロメテウスルールのリスト。enforcedNamespaceLabel が true に設定されている場合にのみ機能します。各ペアに ruleNamespace と ruleName の両方が設定されていることを確認してください非推奨:代わりに excludedFromEnforcement を使用してください。
array

6.1.226. .spec.prometheusRulesExcludedFromEnforce[]

説明
PrometheusRuleExcludeConfig を使用すると、ユーザーは、アラートとメトリックの namespace ラベルを適用するときに、除外された PrometheusRule 名とその namespace を無視するように設定できます。
object
必須
  • ruleName
  • ruleNamespace
Expand
プロパティー説明

ruleName

string

RuleNamespace- 除外されたルールの名前

ruleNamespace

string

RuleNamespace- 除外されたルールの名前空間

6.1.227. .spec.query

Description
QuerySpec は、Prometheus の起動時にクエリーコマンドラインフラグを定義します。
タイプ
object
Expand
プロパティー説明

lookbackDelta

string

デルタの違いにより、式の評価中にメトリックを取得できます。

maxConcurrency

integer

一度に実行できる同時クエリーの数。

maxSamples

integer

1 つのクエリーがメモリーにロードできるサンプルの最大数。これより多くのサンプルをメモリーにロードするとクエリーは失敗するため、クエリーが返すことができるサンプルの数も制限されることに注意してください。

timeout

string

クエリーが中止されるまでにかかる最大時間。

6.1.228. .spec.remoteRead

説明
remoteRead は、リモート読み取り設定のリストです。
array

6.1.229. .spec.remoteRead[]

説明
RemoteReadSpec は、Prometheus がリモートエンドポイントからサンプルを読み戻すための設定を定義します。
object
必須
  • url
Expand
プロパティー説明

authorization

object

リモート読み取りの承認セクション

basicAuth

object

URL の BasicAuth。

bearerToken

string

リモート読み取り用のベアラトークン。

bearerTokenFile

string

リモート読み取り用のベアラトークンを読み取るファイル。

headers

object (string)

各リモート読み取り要求と併せて送信されるカスタム HTTP ヘッダー。Prometheus 自体によって設定されたヘッダーは上書きできないことに注意してください。Prometheus バージョン 2.26.0 以降でのみ有効です。

name

string

リモート読み取りキューの名前。指定する場合は一意である必要があります。この名前は、読み取り設定を区別するためにメトリックとロギングで使用されます。Prometheus バージョン 2.15.0 以降でのみ有効です。

oauth2

object

URL の OAuth2。Prometheus バージョン 2.27.0 以降でのみ有効です。

proxyUrl

string

オプションの ProxyURL。

readRecent

boolean

ローカルストレージに完全なデータが必要な時間範囲のクエリーに対して読み取りを行う必要があるかどうか。

remoteTimeout

string

リモート読み取りエンドポイントへの要求のタイムアウト。

requiredMatchers

object (string)

リモート読み取りエンドポイントを照会するためにセレクターに存在する必要がある等式マッチャーのオプションのリスト。

tlsConfig

object

リモート読み取りに使用する TLS 設定。

url

string

クエリーの実行元となるエンドポイントの URL。

6.1.230. .spec.remoteRead[].authorization

Description
リモート読み取りの承認セクション
タイプ
object
Expand
プロパティー説明

credentials

object

リクエストのクレデンシャルを含むシークレットのキー

credentialsFile

string

クレデンシャルと相互に排他的な (SafeAuthorization からの) シークレットを読み取るファイル

type

string

認証タイプを設定します。デフォルトは Bearer で、Basic はエラーを引き起こします

6.1.231. .spec.remoteRead[].authorization.credentials

Description
リクエストのクレデンシャルを含むシークレットのキー
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.232. .spec.remoteRead[].basicAuth

Description
URL の BasicAuth。
タイプ
object
Expand
プロパティー説明

password

object

認証用のパスワードを含むサービスモニター名前空間のシークレット。

username

object

認証用のユーザー名を含むサービスモニター名前空間のシークレット。

6.1.233. .spec.remoteRead[].basicAuth.password

Description
認証用のパスワードを含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.234. .spec.remoteRead[].basicAuth.username

Description
認証用のユーザー名を含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.235. .spec.remoteRead[].oauth2

Description
URL の OAuth2。Prometheus バージョン 2.27.0 以降でのみ有効です。
object
必須
  • clientId
  • clientSecret
  • tokenUrl
Expand
プロパティー説明

clientId

object

OAuth2 クライアント ID を含むシークレットまたは設定マップ

clientSecret

object

OAuth2 クライアントシークレットを含むシークレット

endpointParams

object (string)

トークン URL に追加するパラメーター

scopes

array (string)

トークンリクエストに使用される OAuth2 スコープ

tokenUrl

string

トークンをフェッチする URL

6.1.236. .spec.remoteRead[].oauth2.clientId

Description
OAuth2 クライアント ID を含むシークレットまたは設定マップ
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

6.1.237. .spec.remoteRead[].oauth2.clientId.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

6.1.238. .spec.remoteRead[].oauth2.clientId.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.239. .spec.remoteRead[].oauth2.clientSecret

Description
OAuth2 クライアントシークレットを含むシークレット
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.240. .spec.remoteRead[].tlsConfig

Description
リモート読み取りに使用する TLS 設定。
タイプ
object
Expand
プロパティー説明

ca

object

ターゲットに使用する CA 証明書を含む構造体。

caFile

string

ターゲットに使用する Prometheus コンテナー内の CA 証明書へのパス。

cert

object

ターゲットのクライアント証明書ファイルを含む構造体。

certFile

string

ターゲットの Prometheus コンテナー内のクライアント証明書ファイルへのパス。

insecureSkipVerify

boolean

ターゲット証明書の検証を無効にします。

keyFile

string

ターゲットの Prometheus コンテナー内のクライアントキーファイルへのパス。

keySecret

object

ターゲットのクライアントキーファイルを含むシークレット。

serverName

string

ターゲットのホスト名を確認するために使用されます。

6.1.241. .spec.remoteRead[].tlsConfig.ca

Description
ターゲットに使用する CA 証明書を含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

6.1.242. .spec.remoteRead[].tlsConfig.ca.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

6.1.243. .spec.remoteRead[].tlsConfig.ca.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.244. .spec.remoteRead[].tlsConfig.cert

Description
ターゲットのクライアント証明書ファイルを含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

6.1.245. .spec.remoteRead[].tlsConfig.cert.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

6.1.246. .spec.remoteRead[].tlsConfig.cert.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.247. .spec.remoteRead[].tlsConfig.keySecret

説明
ターゲットのクライアントキーファイルを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.248. .spec.remoteWrite

説明
remoteWrite は、リモート書き込み設定のリストです。
array

6.1.249. .spec.remoteWrite[]

説明
RemoteWriteSpec は、Prometheus からリモートエンドポイントにサンプルを書き込むための設定を定義します。
object
必須
  • url
Expand
プロパティー説明

authorization

object

リモート書き込みの承認セクション

basicAuth

object

URL の BasicAuth。

bearerToken

string

リモート書き込み用のベアラトークン。

bearerTokenFile

string

リモート書き込み用のベアラトークンを読み取るファイル。

ヘッダー

object (string)

各リモート書き込み要求とともに送信されるカスタム HTTP ヘッダー。Prometheus 自体によって設定されたヘッダーは上書きできないことに注意してください。Prometheus バージョン 2.25.0 以降でのみ有効です。

metadataConfig

object

metadataConfig は、リモートストレージへのシリーズメタデータの送信を設定します。

name

string

リモート書き込みキューの名前。指定する場合は一意である必要があります。この名前は、キューを区別するためにメトリックとロギングで使用されます。Prometheus バージョン 2.15.0 以降でのみ有効です。

oauth2

object

URL の OAuth2。Prometheus バージョン 2.27.0 以降でのみ有効です。

proxyUrl

string

オプションの ProxyURL。

queueConfig

object

QueueConfig を使用すると、リモート書き込みキューパラメーターを調整できます。

remoteTimeout

string

リモート書き込みエンドポイントへの要求のタイムアウト。

sendExemplars

boolean

リモート書き込みを介したエグザンプラの送信を有効にします。そもそもエグザンプラをスクレイプするには、enableFeature オプションを使用してエグザンプラストレージ自体を有効にする必要があることに注意してください。Prometheus バージョン 2.27.0 以降でのみ有効です。

sigv4

object

Sigv4 により、AWS の署名検証 4 を設定できます

tlsConfig

object

リモート書き込みに使用する TLS 設定。

url

string

サンプルの送信先のエンドポイントの URL。

writeRelabelConfigs

array

リモート書き込み再ラベル付け設定のリスト。

writeRelabelConfigs[]

object

RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の <metric_relabel_configs> セクションを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs

6.1.250. .spec.remoteWrite[].authorization

Description
リモート書き込みの承認セクション
タイプ
object
Expand
プロパティー説明

credentials

object

リクエストのクレデンシャルを含むシークレットのキー

credentialsFile

string

クレデンシャルと相互に排他的な (SafeAuthorization からの) シークレットを読み取るファイル

type

string

認証タイプを設定します。デフォルトは Bearer で、Basic はエラーを引き起こします

6.1.251. .spec.remoteWrite[].authorization.credentials

Description
リクエストのクレデンシャルを含むシークレットのキー
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.252. .spec.remoteWrite[].basicAuth

Description
URL の BasicAuth。
タイプ
object
Expand
プロパティー説明

password

object

認証用のパスワードを含むサービスモニター名前空間のシークレット。

username

object

認証用のユーザー名を含むサービスモニター名前空間のシークレット。

6.1.253. .spec.remoteWrite[].basicAuth.password

Description
認証用のパスワードを含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.254. .spec.remoteWrite[].basicAuth.username

Description
認証用のユーザー名を含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.255. .spec.remoteWrite[].metadataConfig

説明
metadataConfig は、リモートストレージへのシリーズメタデータの送信を設定します。
object
Expand
プロパティー説明

send

boolean

メトリクスメタデータをリモートストレージに送信するかどうかを定義します。

sendInterval

string

メトリクスメタデータをリモートストレージに送信する頻度を定義します。

6.1.256. .spec.remoteWrite[].oauth2

Description
URL の OAuth2。Prometheus バージョン 2.27.0 以降でのみ有効です。
object
必須
  • clientId
  • clientSecret
  • tokenUrl
Expand
プロパティー説明

clientId

object

OAuth2 クライアント ID を含むシークレットまたは設定マップ

clientSecret

object

OAuth2 クライアントシークレットを含むシークレット

endpointParams

object (string)

トークン URL に追加するパラメーター

scopes

array (string)

トークンリクエストに使用される OAuth2 スコープ

tokenUrl

string

トークンをフェッチする URL

6.1.257. .spec.remoteWrite[].oauth2.clientId

Description
OAuth2 クライアント ID を含むシークレットまたは設定マップ
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

6.1.258. .spec.remoteWrite[].oauth2.clientId.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

6.1.259. .spec.remoteWrite[].oauth2.clientId.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.260. .spec.remoteWrite[].oauth2.clientSecret

Description
OAuth2 クライアントシークレットを含むシークレット
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.261. .spec.remoteWrite[].queueConfig

説明
QueueConfig を使用すると、リモート書き込みキューパラメーターを調整できます。
object
Expand
プロパティー説明

batchSendDeadline

string

BatchSendDeadline は、サンプルがバッファーで待機する最大時間です。

capacity

integer

容量は、ドロップを開始する前にシャードごとにバッファリングするサンプルの数です。

maxBackoff

string

MaxBackoff は、最大再試行遅延です。

maxRetries

integer

MaxRetries は、回復可能なエラーでバッチを再試行する最大回数です。

maxSamplesPerSend

integer

MaxSamplesPerSend は、送信ごとのサンプルの最大数です。

maxShards

integer

MaxShards は、シャードの最大数、つまり同時実行の量です。

minBackoff

string

MinBackoff は、最初の再試行遅延です。再試行するたびに 2 倍になります。

minShards

integer

MinShards は、シャードの最小数、つまり同時実行の量です。

retryOnRateLimit

boolean

remote-write ストレージから 429 ステータスコードを受信すると再試行します。これは実験的な機能であり、将来変更される可能性があります。

6.1.262. .spec.remoteWrite[].sigv4

説明
Sigv4 により、AWS の署名検証 4 を設定できます
object
Expand
プロパティー説明

accessKey

object

AccessKey は AWS API キーです。空欄にした場合には、環境変数 AWS_ACCESS_KEY_ID が使用されます。

profile

string

profile は、認証に使用される名前付き AWS プロファイルです。

region

string

region は AWS リージョンです。空白の場合は、デフォルトの認証情報チェーンのリージョンが使用されます。

roleArn

string

roleArn は、認証に使用される名前付き AWS プロファイルです。

secretKey

object

secretKey は AWS API シークレットです。空欄にした場合には、環境変数 AWS_SECRET_ACCESS_KEY が使用されます。

6.1.263. .spec.remoteWrite[].sigv4.accessKey

説明
AccessKey は AWS API キーです。空欄にした場合には、環境変数 AWS_ACCESS_KEY_ID が使用されます。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.264. .spec.remoteWrite[].sigv4.secretKey

説明
secretKey は AWS API シークレットです。空欄にした場合には、環境変数 AWS_SECRET_ACCESS_KEY が使用されます。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.265. .spec.remoteWrite[].tlsConfig

Description
リモート書き込みに使用する TLS 設定。
タイプ
object
Expand
プロパティー説明

ca

object

ターゲットに使用する CA 証明書を含む構造体。

caFile

string

ターゲットに使用する Prometheus コンテナー内の CA 証明書へのパス。

cert

object

ターゲットのクライアント証明書ファイルを含む構造体。

certFile

string

ターゲットの Prometheus コンテナー内のクライアント証明書ファイルへのパス。

insecureSkipVerify

boolean

ターゲット証明書の検証を無効にします。

keyFile

string

ターゲットの Prometheus コンテナー内のクライアントキーファイルへのパス。

keySecret

object

ターゲットのクライアントキーファイルを含むシークレット。

serverName

string

ターゲットのホスト名を確認するために使用されます。

6.1.266. .spec.remoteWrite[].tlsConfig.ca

Description
ターゲットに使用する CA 証明書を含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

6.1.267. .spec.remoteWrite[].tlsConfig.ca.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

6.1.268. .spec.remoteWrite[].tlsConfig.ca.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.269. .spec.remoteWrite[].tlsConfig.cert

Description
ターゲットのクライアント証明書ファイルを含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

6.1.270. .spec.remoteWrite[].tlsConfig.cert.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

6.1.271. .spec.remoteWrite[].tlsConfig.cert.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.272. .spec.remoteWrite[].tlsConfig.keySecret

説明
ターゲットのクライアントキーファイルを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.273. .spec.remoteWrite[].writeRelabelConfigs

説明
リモート書き込み再ラベル付け設定のリスト。
array

6.1.274. .spec.remoteWrite[].writeRelabelConfigs[]

Description
RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の <metric_relabel_configs> セクションを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
タイプ
object
Expand
プロパティー説明

action

string

正規表現のマッチングに基づいて実行するアクション。デフォルトは置換です。大文字および小文字のアクションには、Prometheus >= 2.36 が必要です。

modulus

integer

ソースラベル値のハッシュを取得するためのモジュラス。

regex

string

抽出された値が一致する正規表現。デフォルトは (.*) です。

replacement

string

正規表現が一致する場合に正規表現置換が実行される置換値。正規表現キャプチャグループが利用可能です。デフォルトは $1 です。

separator

string

連結されたソースラベル値の間に配置されたセパレータ。デフォルトは ';' です。

sourceLabels

array (string)

ソースラベルは、既存のラベルから値を選択します。それらのコンテンツは、設定されたセパレーターを使用して連結され、置換、保持、および削除アクションの設定された正規表現と照合されます。

targetLabel

string

結果の値が置換アクションで書き込まれるラベル。置換アクションには必須です。正規表現キャプチャグループが利用可能です。

6.1.275. .spec.resources

説明
単一 Pod のリソース要求と制限を定義します。
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/ を参照してください。

6.1.276. .spec.ruleNamespaceSelector

Description
PrometheusRules 検出用に選択される名前空間。指定しない場合、Prometheus オブジェクトと同じ名前空間のみが使用されます。
タイプ
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

6.1.277. .spec.ruleNamespaceSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

6.1.278. .spec.ruleNamespaceSelector.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

6.1.279. .spec.ruleSelector

Description
アラート/記録ルールをロードするためにマウントする PrometheusRules を選択するためのセレクター。Prometheus Operator v0.24.0 まで (除く)Prometheus Operator は、従来のルール ConfigMaps を RuleSelector によって選択された PrometheusRule カスタムリソースに移行します。移行したくない設定マップと一致しないことを確認してください。
タイプ
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

6.1.280. .spec.ruleSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

6.1.281. .spec.ruleSelector.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

6.1.282. .spec.rules

Description
/--rules.*/コマンドライン引数。
タイプ
object
Expand
プロパティー説明

alert

object

/--rules.alert.*/コマンドライン引数

6.1.283. .spec.rules.alert

Description
/--rules.alert.*/コマンドライン引数
タイプ
object
Expand
プロパティー説明

forGracePeriod

string

アラートと復元された状態の間の最小期間。これは、猶予期間よりも長い for が設定されているアラートに対してのみ維持されます。

forOutageTolerance

string

アラートの 'for' の状態を復元するために prometheus の停止を許容する最大時間。

resendDelay

string

Alertmanager にアラートを再送信する前に待機する最小時間。

6.1.284. .spec.securityContext

説明
SecurityContext は、Pod レベルのセキュリティー属性と一般的なコンテナー設定を保持します。これはデフォルトでデフォルトの PodSecurityContext になります。
object
Expand
プロパティー説明

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 の場合、このフィールドは設定できないことに注意してください。

seLinuxOptions

object

すべてのコンテナーに適用される SELinux コンテキスト。指定しない場合、コンテナーランタイムはコンテナーごとにランダムな SELinux コンテキストを割り当てます。SecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値がそのコンテナーに優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

seccompProfile

object

この Pod のコンテナーで使用する seccomp オプション。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

supplementalGroups

配列 (整数)

コンテナーのプライマリー GID に加えて、各コンテナーで実行される最初のプロセスに適用されるグループのリスト。指定しない場合、グループはどのコンテナーにも追加されません。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 の場合は、このフィールドを設定できないことに注意してください。

6.1.285. .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 ユーザーラベルです。

6.1.286. .spec.securityContext.seccompProfile

説明
この Pod のコンテナーで使用する seccomp オプション。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
object
必須
  • type
Expand
プロパティー説明

localhostProfile

string

localhostProfile は、ノード上のファイルで定義されたプロファイルを使用する必要があることを示します。プロファイルが機能するには、ノードで事前に設定されている必要があります。kubelet の設定済みの seccomp プロファイルの場所を基準にして、降順のパスである必要があります。タイプが "Localhost" の場合にのみ設定する必要があります。

type

string

type は、適用される seccomp プロファイルの種類を示します。有効なオプションは次のとおりです。Localhost- ノード上のファイルで定義されたプロファイルを使用する必要があります。RuntimeDefault- コンテナーのランタイムデフォルトプロファイルを使用する必要があります。制限なし - プロファイルを適用しないでください。

6.1.287. .spec.securityContext.sysctls

説明
Sysctl は、Pod に使用される namespace 付き sysctl のリストを保持します。(コンテナーランタイムによる) サポートされていない sysctl を持つ Pod は起動に失敗する可能性があります。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
array

6.1.288. .spec.securityContext.sysctls[]

説明
Sysctl は、設定するカーネルパラメーターを定義します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

設定するプロパティーの名前

value

string

設定するプロパティーの値

6.1.289. .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' コンテナーとして実行する必要があるかどうかを決定します。このフィールドはアルファレベルであり、WindowsHostProcessContainers 機能フラグを有効にするコンポーネントによってのみ尊重されます。機能フラグなしでこのフィールドを設定すると、Pod の検証時にエラーが発生します。Pod のすべてのコンテナーは、同じ有効な HostProcess 値を持っている必要があります (HostProcess コンテナーと非 HostProcess コンテナーを混在させることはできません)。さらに、HostProcess が true の場合、HostNetwork も true に設定する必要があります。

runAsUserName

string

コンテナープロセスのエントリーポイントを実行するための Windows の UserName。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。

6.1.290. .spec.serviceMonitorNamespaceSelector

Description
ServiceMonitor 検出に一致する名前空間のラベル。nil の場合は、自分の名前空間のみを確認してください。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

6.1.291. .spec.serviceMonitorNamespaceSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

6.1.292. .spec.serviceMonitorNamespaceSelector.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

6.1.293. .spec.serviceMonitorSelector

説明
ターゲット検出用に選択される ServiceMonitor。非 推奨: this も podMonitorSelector も指定されていない場合、設定は管理されません。
タイプ
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

6.1.294. .spec.serviceMonitorSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

6.1.295. .spec.serviceMonitorSelector.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

6.1.296. .spec.storage

説明
ストレージの使用方法を指定するストレージ仕様。
object
Expand
プロパティー説明

disableMountSubPath

ブール値

非推奨:subPath の使用は、将来のリリースでデフォルトで無効になります。このオプションは不要になります。DisableMountSubPath を使用すると、ボリュームマウントでの subPath の使用を削除できます。

emptyDir

object

PrometheusStatefulSets によって使用される EmptyDirVolumeSource。指定した場合、volumeClaimTemplate の代わりに使用されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir

ephemeral

object

Prometheus StatefulSets によって使用される EphemeralVolumeSource。これは、k8s 1.21 のベータフィールドであり、k8s 1.19 以降、k8s 1.19 以降では、GenericEphemeralVolume フィーチャーゲートを有効にする必要があります。詳細: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes

volumeClaimTemplate

object

PrometheusStatefulSets で使用される PVC 仕様。

6.1.297. .spec.storage.emptyDir

Description
PrometheusStatefulSets によって使用される EmptyDirVolumeSource。指定した場合、volumeClaimTemplate の代わりに使用されます。詳細: 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 です。これは、制限が未定義であることを意味します。詳細: http://kubernetes.io/docs/user-guide/volumes#emptydir

6.1.298. .spec.storage.ephemeral

説明
Prometheus StatefulSets によって使用される EphemeralVolumeSource。これは、k8s 1.21 のベータフィールドであり、k8s 1.19 以降、k8s 1.19 以降では、GenericEphemeralVolume フィーチャーゲートを有効にする必要があります。詳細: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes
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 であってはなりません。

6.1.299. .spec.storage.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 と同じフィールドがここでも有効です。

6.1.300. .spec.storage.ephemeral.volumeClaimTemplate.metadata

説明
PVC の作成時に PVC にコピーされるラベルとアノテーションが含まれる場合があります。他のフィールドは許可されておらず、検証中に拒否されます。
object

6.1.301. .spec.storage.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 機能ゲートが有効になっている場合、このフィールドは常に DataSourceRef フィールドと同じ内容になります。

dataSourceRef

object

dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これは、空でない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のローカルオブジェクトである可能性があります。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、DataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性のために、両方のフィールド (DataSource と DataSourceRef) は、一方が空でもう一方が空でない場合、自動的に同じ値に設定されます。DataSource と DataSourceRef には 2 つの重要な違いがあります。*DataSource は 2 つの特定のタイプのオブジェクトのみを許可しますが、DataSourceRef は非コアオブジェクトと PersistentVolumeClaim オブジェクトを許可します。* DataSource は許可されていない値を無視 (ドロップ) しますが、DataSourceRef はすべての値を保持し、許可されていない値が指定されている場合はエラーを生成します。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。

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

volumeMode

string

volumeMode は、要求に必要なボリュームのタイプを定義します。Filesystem の値は、要求仕様に含まれていない場合に暗示されます。

volumeName

string

volumeName は、この要求をサポートする PersistentVolume へのバインディング参照です。

6.1.302. .spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource

説明
dataSource フィールドは、次のいずれかを指定するために使用できます。*既存の VolumeSnapshot オブジェクト (snapshot.storage.k8s.io/VolumeSnapshot)*既存の PVC(PersistentVolumeClaim) プロビジョナーまたは外部コントローラーが指定されたデータソースをサポートできる場合、指定されたデータソースのコンテンツに基づく新しいボリューム。AnyVolumeDataSource 機能ゲートが有効になっている場合、このフィールドは常に DataSourceRef フィールドと同じ内容になります。
タイプ
object
必須
  • kind
  • name
Expand
プロパティー説明

apiGroup

string

APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。

kind

string

kind は参照されているリソースのタイプです。

name

string

name は、参照されているリソースの名前です。

6.1.303. .spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef

説明
dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これは、空でない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のローカルオブジェクトである可能性があります。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、DataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性のために、両方のフィールド (DataSource と DataSourceRef) は、一方が空でもう一方が空でない場合、自動的に同じ値に設定されます。DataSource と DataSourceRef には 2 つの重要な違いがあります。*DataSource は 2 つの特定のタイプのオブジェクトのみを許可しますが、DataSourceRef は非コアオブジェクトと PersistentVolumeClaim オブジェクトを許可します。* DataSource は許可されていない値を無視 (ドロップ) しますが、DataSourceRef はすべての値を保持し、許可されていない値が指定されている場合はエラーを生成します。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。
object
必須
  • kind
  • name
Expand
プロパティー説明

apiGroup

string

APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。

kind

string

kind は参照されているリソースのタイプです。

name

string

name は、参照されているリソースの名前です。

6.1.304. .spec.storage.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/ を参照してください。

6.1.305. .spec.storage.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 で結合されます。

6.1.306. .spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

6.1.307. .spec.storage.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

6.1.308. .spec.storage.volumeClaimTemplate

Description
PrometheusStatefulSets で使用される PVC 仕様。
タイプ
object
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

object

EmbeddedMetadata には、EmbeddedResource に関連するメタデータが含まれています。

spec

object

仕様は、Pod 作成者によって要求されたボリュームの望ましい特性を定義します。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

status

object

ステータスは、永続的なボリュームクレームの現在の情報/ステータスを表します。read-only詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

6.1.309. .spec.storage.volumeClaimTemplate.metadata

説明
EmbeddedMetadata には、EmbeddedResource に関連するメタデータが含まれています。
object
Expand
プロパティー説明

annotations

object (string)

アノテーションは、任意のメタデータを保存し、取得するために外部ツールで設定できる、リソースとともに保存される構造化されていないキー値のマップです。これらはクエリーできないため、オブジェクトを変更する場合に維持する必要があります。詳細: http://kubernetes.io/docs/user-guide/annotations

labels

object (string)

オブジェクトの整理と分類 (スコープと選択) に使用できる文字列キーと値のマップ。レプリケーションコントローラーおよびサービスのセレクターと一致する場合があります。詳細: http://kubernetes.io/docs/user-guide/labels

name

string

name は namespace 内で一意である必要があります。リソースの作成時に必要ですが、リソースによっては、クライアントが適切な名前の生成を自動的に要求することを許可する場合があります。name は、主にべき等性と設定定義の作成を目的としています。これを更新することはできません。詳細: http://kubernetes.io/docs/user-guide/identifiers#names

6.1.310. .spec.storage.volumeClaimTemplate.spec

Description
仕様は、Pod 作成者によって要求されたボリュームの望ましい特性を定義します。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
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 機能ゲートが有効になっている場合、このフィールドは常に DataSourceRef フィールドと同じ内容になります。

dataSourceRef

object

dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これは、空でない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のローカルオブジェクトである可能性があります。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、DataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性のために、両方のフィールド (DataSource と DataSourceRef) は、一方が空でもう一方が空でない場合、自動的に同じ値に設定されます。DataSource と DataSourceRef には 2 つの重要な違いがあります。*DataSource は 2 つの特定のタイプのオブジェクトのみを許可しますが、DataSourceRef は非コアオブジェクトと PersistentVolumeClaim オブジェクトを許可します。* DataSource は許可されていない値を無視 (ドロップ) しますが、DataSourceRef はすべての値を保持し、許可されていない値が指定されている場合はエラーを生成します。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。

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

volumeMode

string

volumeMode は、要求に必要なボリュームのタイプを定義します。Filesystem の値は、要求仕様に含まれていない場合に暗示されます。

volumeName

string

volumeName は、この要求をサポートする PersistentVolume へのバインディング参照です。

6.1.311. .spec.storage.volumeClaimTemplate.spec.dataSource

説明
dataSource フィールドは、次のいずれかを指定するために使用できます。*既存の VolumeSnapshot オブジェクト (snapshot.storage.k8s.io/VolumeSnapshot)*既存の PVC(PersistentVolumeClaim) プロビジョナーまたは外部コントローラーが指定されたデータソースをサポートできる場合、指定されたデータソースのコンテンツに基づく新しいボリューム。AnyVolumeDataSource 機能ゲートが有効になっている場合、このフィールドは常に DataSourceRef フィールドと同じ内容になります。
タイプ
object
必須
  • kind
  • name
Expand
プロパティー説明

apiGroup

string

APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。

kind

string

kind は参照されているリソースのタイプです。

name

string

name は、参照されているリソースの名前です。

6.1.312. .spec.storage.volumeClaimTemplate.spec.dataSourceRef

説明
dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これは、空でない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のローカルオブジェクトである可能性があります。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、DataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性のために、両方のフィールド (DataSource と DataSourceRef) は、一方が空でもう一方が空でない場合、自動的に同じ値に設定されます。DataSource と DataSourceRef には 2 つの重要な違いがあります。*DataSource は 2 つの特定のタイプのオブジェクトのみを許可しますが、DataSourceRef は非コアオブジェクトと PersistentVolumeClaim オブジェクトを許可します。* DataSource は許可されていない値を無視 (ドロップ) しますが、DataSourceRef はすべての値を保持し、許可されていない値が指定されている場合はエラーを生成します。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。
object
必須
  • kind
  • name
Expand
プロパティー説明

apiGroup

string

APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。

kind

string

kind は参照されているリソースのタイプです。

name

string

name は、参照されているリソースの名前です。

6.1.313. .spec.storage.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/ を参照してください。

6.1.314. .spec.storage.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 で結合されます。

6.1.315. .spec.storage.volumeClaimTemplate.spec.selector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

6.1.316. .spec.storage.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

6.1.317. .spec.storage.volumeClaimTemplate.status

Description
ステータスは、永続的なボリュームクレームの現在の情報/ステータスを表します。read-only詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
object
Expand
プロパティー説明

accessModes

array (string)

accessModes には、PVC をサポートするボリュームが実際に持つアクセスモードが含まれます。詳細は、https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 を参照してください。

allocatedResources

integer-or-string

allocatedResources は、AllocatedResources 内のストレージリソースで、PVC に割り当てられた容量を追跡します。ボリューム拡張操作が要求された場合、実際の容量よりも大きくなる場合があります。ストレージクォータには、allocatedResources と PVC.spec.resources を比較して大きい方の値が使用されます。allocatedResources が設定されていない場合、PVC.spec.resources のみがクォータの計算に使用されます。ボリューム拡張容量要求が下げられ、進行中の拡張操作がなく、実際のボリューム容量が要求された容量以下である場合にのみ、allocatedResources が引き下げられます。これはアルファフィールドであるため、RecoverVolumeExpansionFailure 機能を有効にする必要があります。

capacity

integer-or-string

capacity は、基礎となるボリュームの実際のリソースを表します。

conditions

array

conditions は永続ボリューム要求の現在の条件です。基礎となる永続ボリュームのサイズを変更すると、Condition は 'ResizeStarted' に設定されます。

conditions[]

object

PersistentVolumeClaimCondition コンテーションで pvc の状態についての詳細

phase

string

phase は PersistentVolumeClaim の現在のフェーズを表します。

resizeStatus

string

resizeStatus は、サイズ変更操作のステータスを格納します。ResizeStatus はデフォルトでは設定されませんが、拡張が完了すると、サイズ変更コントローラーまたは kubelet によって、resizeStatus が空の文字列に設定されます。これはアルファフィールドであるため、RecoverVolumeExpansionFailure 機能を有効にする必要があります。

6.1.318. .spec.storage.volumeClaimTemplate.status.conditions

説明
conditions は永続ボリューム要求の現在の条件です。基礎となる永続ボリュームのサイズを変更すると、Condition は 'ResizeStarted' に設定されます。
array

6.1.319. .spec.storage.volumeClaimTemplate.status.conditions[]

Description
PersistentVolumeClaimCondition コンテーションで pvc の状態についての詳細
タイプ
object
必須
  • status
  • type
Expand
プロパティー説明

lastProbeTime

string

lastProbeTime は、条件を調査した時間です。

lastTransitionTime

string

lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。

message

string

message は、最後の遷移に関する詳細を示し、人間が判読できるメッセージです。

reason

string

一意であり、これは、条件の最後の遷移理由を示す、マシンが理解できる短い文字列である必要があります。"ResizeStarted" と報告された場合は、基礎となる永続ボリュームのサイズが変更されていることを意味します。

status

string

 

type

string

PersistentVolumeClaimConditionType は、PersistentVolumeClaimCondition.Type の有効な値です。

6.1.320. .spec.thanos

Description
Thanos 設定では、Thanos 環境で Prometheus サーバーのさまざまな側面を設定できます。このセクションは実験的なものであり、どのリリースでも非推奨の通知なしに大幅に変更される可能性があります。これは実験的なものであり、どのリリースでも下位互換性がなくても大幅に変更される可能性があります。
タイプ
object
Expand
プロパティー説明

additionalArgs

array

AdditionalArgs を使用して、Thanos コンテナーに追加の引数を設定できます。引数はそのまま Thanos コンテナーに渡されますが、引数が無効であったり、指定された Thanos バージョンでサポートされていない場合は問題が発生する可能性があります。引数が競合する場合 (たとえば、Operator 自体によってすでに設定されている引数)、または無効な引数を指定すると、調整は失敗し、エラーが記録されます。

additionalArgs[]

object

AdditionalArgs リストの一部である引数。

baseImage

string

デフォルト以外の場合は、Thanos ベースイメージ。非推奨: 代わりに image を使用してください

grpcListenLocal

boolean

true の場合、Thanos サイドカーは gRPC エンドポイントのループバックインターフェイスでリッスンします。listenLocal が true の場合は効果がありません。

grpcServerTlsConfig

object

grpcServerTlsConfig は、StoreAPI を提供する gRPC サーバーの TLS パラメーターを設定します。注: 現在、CAFile、CertFile、および KeyFile フィールドのみがサポートされています。'--grpc-server-tls-*'CLI 引数にマップします。

httpListenLocal

boolean

true の場合、Thanos サイドカーは HTTP エンドポイントのループバックインターフェイスでリッスンします。listenLocal が true の場合は効果がありません。

image

string

指定した場合のイメージは、baseImage、tag、sha の組み合わせよりも優先されます。Prometheus Operator が設定されている Thanos のバージョンを確実に認識できるようにするには、バージョンを指定する必要があります。

listenLocal

boolean

true の場合、Thanos サイドカーは HTTP および gRPC エンドポイントのループバックインターフェイスでリッスンします。これは、grpcListenLocal および httpListenLocal よりも優先されます。非推奨: 代わりに grpcListenLocalhttpListenLocal を使用します。

logFormat

string

設定する Thanos サイドカーの LogFormat。

logLevel

string

設定する Thanos サイドカーの LogLevel。

minTime

string

設定する Thanos サイドカーの MinTime。オプションは、RFC3339 形式の定数時間、または -1d や 2h45m などの現在の時間に関連する期間にすることができます。有効な期間の単位は、ms、s、m、h、d、w、y です。

objectStorageConfig

object

ObjectStorageConfig は、Thanos でオブジェクトストレージを設定します。ObjectStorageConfigFile の代替であり、優先度が低くなります。

objectStorageConfigFile

string

ObjectStorageConfigFile は、オブジェクトストレージ設定ファイルのパスを指定します。ObjectStorageConfig と一緒に使用すると、ObjectStorageConfigFile が優先されます。

readyTimeout

string

ReadyTimeout は、Thanos サイドカーが Prometheus の起動を待機する最大時間です。例:10m

resources

object

Resources は、Thanos サイドカーのリソース要件を定義します。指定しない場合、リクエスト/制限は設定されません

sha

string

デプロイする Thanos コンテナーイメージの SHA。デフォルトは バージョン の値です。タグに似ていますが、SHA は不変のコンテナーイメージを明示的にデプロイします。SHA が設定されている場合、バージョンとタグは無視されます。非推奨: 代わりに 'image' を使用します。イメージダイジェストは、イメージ URL の一部として指定できます。

tag

string

デプロイメントする Thanos サイドカーコンテナーイメージのタグ。デフォルトは バージョン の値です。タグが設定されている場合、バージョンは無視されます。非推奨: 代わりに 'image' を使用します。イメージタグは、イメージ URL の一部として指定できます。

tracingConfig

object

TracingConfig は、Thanos でトレースを設定します。これは実験的な機能であり、今後のリリースで重大な変更が加えられる可能性があります。

tracingConfigFile

string

TracingConfig は、トレース設定ファイルのパスを指定します。TracingConfig と一緒に使用すると、TracingConfigFile が優先されます。

version

string

バージョンは、使用する Thanos のバージョンを示します。

volumeMounts

array

VolumeMounts を使用すると、出力 StatefulSet 定義に追加の VolumeMounts を設定できます。指定された VolumeMounts は、thanos-sidecar コンテナー内の他の VolumeMounts に追加されます。

volumeMounts[]

object

VolumeMount は、コンテナー内でのボリュームのマウントについて説明します。

6.1.321. .spec.thanos.additionalArgs

説明
AdditionalArgs を使用して、Thanos コンテナーに追加の引数を設定できます。引数はそのまま Thanos コンテナーに渡されますが、引数が無効であったり、指定された Thanos バージョンでサポートされていない場合は問題が発生する可能性があります。引数が競合する場合 (たとえば、Operator 自体によってすでに設定されている引数)、または無効な引数を指定すると、調整は失敗し、エラーが記録されます。
array

6.1.322. .spec.thanos.additionalArgs[]

説明
AdditionalArgs リストの一部である引数。
object
必須
  • name
Expand
プロパティー説明

name

string

引数の名前 (例: "scrape.discovery-reload-interval")。

value

string

引数の値 (例: 30s)。名前のみの引数は空にできます (例: --storage.tsdb.no-lockfile)

6.1.323. .spec.thanos.grpcServerTlsConfig

説明
grpcServerTlsConfig は、StoreAPI を提供する gRPC サーバーの TLS パラメーターを設定します。注: 現在、CAFile、CertFile、および KeyFile フィールドのみがサポートされています。'--grpc-server-tls-*'CLI 引数にマップします。
object
Expand
プロパティー説明

ca

object

ターゲットに使用する CA 証明書を含む構造体。

caFile

string

ターゲットに使用する Prometheus コンテナー内の CA 証明書へのパス。

cert

object

ターゲットのクライアント証明書ファイルを含む構造体。

certFile

string

ターゲットの Prometheus コンテナー内のクライアント証明書ファイルへのパス。

insecureSkipVerify

boolean

ターゲット証明書の検証を無効にします。

keyFile

string

ターゲットの Prometheus コンテナー内のクライアントキーファイルへのパス。

keySecret

object

ターゲットのクライアントキーファイルを含むシークレット。

serverName

string

ターゲットのホスト名を確認するために使用されます。

6.1.324. .spec.thanos.grpcServerTlsConfig.ca

Description
ターゲットに使用する CA 証明書を含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

6.1.325. .spec.thanos.grpcServerTlsConfig.ca.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

6.1.326. .spec.thanos.grpcServerTlsConfig.ca.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.327. .spec.thanos.grpcServerTlsConfig.cert

Description
ターゲットのクライアント証明書ファイルを含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

6.1.328. .spec.thanos.grpcServerTlsConfig.cert.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

6.1.329. .spec.thanos.grpcServerTlsConfig.cert.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.330. .spec.thanos.grpcServerTlsConfig.keySecret

説明
ターゲットのクライアントキーファイルを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.331. .spec.thanos.objectStorageConfig

Description
ObjectStorageConfig は、Thanos でオブジェクトストレージを設定します。ObjectStorageConfigFile の代替であり、優先度が低くなります。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.332. .spec.thanos.resources

Description
Resources は、Thanos サイドカーのリソース要件を定義します。指定しない場合、リクエスト/制限は設定されません
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/ を参照してください。

6.1.333. .spec.thanos.tracingConfig

Description
TracingConfig は、Thanos でトレースを設定します。これは実験的な機能であり、今後のリリースで重大な変更が加えられる可能性があります。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.334. .spec.thanos.volumeMounts

Description
VolumeMounts を使用すると、出力 StatefulSet 定義に追加の VolumeMounts を設定できます。指定された VolumeMounts は、thanos-sidecar コンテナー内の他の VolumeMounts に追加されます。
タイプ
array

6.1.335. .spec.thanos.volumeMounts[]

説明
VolumeMount は、コンテナー内でのボリュームのマウントを説明します。
object
必須
  • mountPath
  • name
Expand
プロパティー説明

mountPath

string

ボリュームをマウントする必要があるコンテナー内のパス。':' を含めることはできません。

mountPropagation

string

mountPropagation は、マウントがホストからコンテナーに、またはその逆にどのように伝播されるかを決定します。設定されていない場合、MountPropagationNone が使用されます。このフィールドは 1.10 のベータ版です。

name

string

ボリュームの名前に一致する必要があります。

readOnly

boolean

true の場合は読み取り専用、それ以外の場合は読み取り/書き込み (false または指定なし) でマウントされます。デフォルトは false です。

subPath

string

コンテナーのボリュームをマウントする必要があるボリューム内のパス。デフォルトは "" (ボリュームのルート) です。

subPathExpr

string

コンテナーのボリュームをマウントする必要があるボリューム内の拡張パス。SubPath と同様に動作しますが、環境変数参照 $(VAR_NAME) は、コンテナーの環境を使用してデプロイメントされます。デフォルトは "" (ボリュームのルート) です。SubPathExpr と SubPath は相互に排他的です。

6.1.336. .spec.tolerations

説明
指定されている場合、Pod の許容範囲。
array

6.1.337. .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 の場合、値は空である必要があります。それ以外の場合は、通常の文字列のみになります。

6.1.338. .spec.topologySpreadConstraints

説明
指定した場合、Pod のトポロジー拡散制約。
array

6.1.339. .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 のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。null または空のリストは、labelSelector とのみ一致することを意味します。

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 に違反するためです。これはベータフィールドであり、MinDomainsInPodTopologySpread フィーチャーゲートを有効にする必要があります (デフォルトで有効)。

nodeAffinityPolicy

string

nodeAffinityPolicy は、Pod トポロジーの分散スキューを計算するときに Pod の nodeAffinity/nodeSelector をどのように扱うかを示します。オプションは - Honor: nodeAffinity/nodeSelector に一致するノードのみが計算に含まれます。- Ignore: nodeAffinity/nodeSelector は無視されます。すべてのノードが計算に含まれます。この値が nil の場合、この動作は Honor ポリシーと同じです。これは、NodeInclusionPolicyInPodTopologySpread 機能フラグによって有効にされるアルファレベルの機能です。

nodeTaintsPolicy

string

NodeTaintsPolicy は、Pod トポロジースプレッドスキューを計算するときにノードのテイントを処理する方法を示します。オプション: - Honor: テイントのないノードと、受信 Pod が許容範囲でテイントがあるノードが含まれます。- Ignore: ノードのテイントは無視されます。すべてのノードが含まれます。この値が nil の場合、この動作は Ignore ポリシーと同じです。これは、NodeInclusionPolicyInPodTopologySpread 機能フラグによって有効にされるアルファレベルの機能です。

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) になります。つまり、クラスターは依然として不均衡である可能性がありますが、スケジューラーによってクラスターが さらに 不均衡になることはありません。必須フィールドです。

6.1.340. .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 で結合されます。

6.1.341. .spec.topologySpreadConstraints[].labelSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

6.1.342. .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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

6.1.343. .spec.tsdb

説明
ランタイムでのリロードが可能な時系列データベース (TSDB) の設定を定義します。
object
Expand
プロパティー説明

outOfOrderTimeWindow

string

out-of-order/out-of-bounds サンプルが w.r.t に近づいているかを設定します。TSDB の最大時間。サンプルのタイムスタンプが (TSDB.MaxTime - outOfOrderTimeWindow) 以上であれば、順序外/範囲外のサンプルは TSDB に取り込まれます。順序がとれていない取り込みは実験的な機能であり、Prometheus >= v2.39.0 を必要とします。

6.1.344. .spec.volumeMounts

説明
VolumeMounts を使用すると、出力 StatefulSet 定義に追加の VolumeMounts を設定できます。指定された VolumeMounts は、StorageSpec オブジェクトの結果として生成されるプロメテウスコンテナー内の他の VolumeMounts に追加されます。
タイプ
array

6.1.345. .spec.volumeMounts[]

説明
VolumeMount は、コンテナー内でのボリュームのマウントを説明します。
object
必須
  • mountPath
  • name
Expand
プロパティー説明

mountPath

string

ボリュームをマウントする必要があるコンテナー内のパス。':' を含めることはできません。

mountPropagation

string

mountPropagation は、マウントがホストからコンテナーに、またはその逆にどのように伝播されるかを決定します。設定されていない場合、MountPropagationNone が使用されます。このフィールドは 1.10 のベータ版です。

name

string

ボリュームの名前に一致する必要があります。

readOnly

boolean

true の場合は読み取り専用、それ以外の場合は読み取り/書き込み (false または指定なし) でマウントされます。デフォルトは false です。

subPath

string

コンテナーのボリュームをマウントする必要があるボリューム内のパス。デフォルトは "" (ボリュームのルート) です。

subPathExpr

string

コンテナーのボリュームをマウントする必要があるボリューム内の拡張パス。SubPath と同様に動作しますが、環境変数参照 $(VAR_NAME) は、コンテナーの環境を使用してデプロイメントされます。デフォルトは "" (ボリュームのルート) です。SubPathExpr と SubPath は相互に排他的です。

6.1.346. .spec.volumes

説明
ボリュームを使用すると、出力の StatefulSet 定義に追加のボリュームを設定できます。指定されたボリュームは、StorageSpec オブジェクトの結果として生成される他のボリュームに追加されます。
array

6.1.347. .spec.volumes[]

説明
ボリュームは、Pod 内の任意のコンテナーからアクセスできる Pod 内の名前付きボリュームを表します。
object
必須
  • name
Expand
プロパティー説明

awsElasticBlockStore

object

awsElasticBlockStore は、kubelet のホストマシンに割り当てられ、Pod に公開される AWS Disk リソースを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

azureDisk

object

azureDisk は、ホスト上の Azure Data Disk マウントを表し、Pod へのバインドマウントを表します。

azureFile

object

azureFile は、ホスト上の Azure File Service マウントを表し、マウントを Pod にバインドします。

cephfs

object

cephFS は、Pod の有効期間を共有するホストでの Ceph FS マウントを表します。

cinder

object

Cinder は、kubelets ホストマシンに接続およびマウントされた Cinder ボリュームを表します。詳細: 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 ベースのプラグインを使用してプロビジョニング/接続される汎用ボリュームリソースを表します。

flocker

object

flocker は、kubelet のホストマシンに接続されている Flocker ボリュームを表します。これは、実行中の Flocker 制御サービスによって異なります

gcePersistentDisk

object

gcePersistentDisk は、kubelet のホストマシンに接続されてから Pod に公開される GCE ディスクリソースを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

gitRepo

object

gitRepo は、特定のリビジョンの git リポジトリーを表します。非推奨:GitRepo は非推奨です。git レポジトリを使用してコンテナーをプロビジョニングするには、Git を使用してレポジトリのクローンを作成する InitContainer に EmptyDir をマウントしてから、Pod のコンテナーに EmptyDir をマウントします。

glusterfs

object

glusterfs は、Pod の存続期間を共有するホスト上の Glusterfs マウントを表します。詳細: https://examples.k8s.io/volumes/glusterfs/README.md

hostPath

object

hostPath は、コンテナーに直接公開されているホストマシン上の既存のファイルまたはディレクトリーを表します。これは通常、ホストマシンの表示を許可されているシステムエージェントまたはその他の特権的なものに使用されます。ほとんどのコンテナーはこれを必要としません。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) ホストディレクトリーのマウントを使用できる人、およびホストディレクトリーを読み取り/書き込みでマウントできる人/できない人を制限する必要があります。

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 永続ディスクを表します。

portworxVolume

object

portworxVolume は、kubelet ホストマシンに接続およびマウントされた portworx ボリュームを表します。

projected

object

オールインワンリソースシークレット、configmaps、および Downward API のアイテム

quobyte

object

quobyte は、Pod の有効期限を共有するホストでの Quobyte マウントを表します

rbd

object

rbd は、Pod の有効期間を共有するホストの Rados ブロックデバイスマウントを表します。詳細: https://examples.k8s.io/volumes/rbd/README.md

scaleIO

object

scaleIO は、Kubernetes ノードに接続およびマウントされた ScaleIO 永続ボリュームを表します。

secret

object

secret は、このボリュームに入力する必要がある Secret を表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#secret

storageos

object

storageOS は、Kubernetes ノードに接続およびマウントされた StorageOS ボリュームを表します。

vsphereVolume

object

vsphereVolume は、kubelet ホストマシンに接続およびマウントされた vSphere ボリュームを表します。

6.1.348. .spec.volumes[].awsElasticBlockStore

説明
awsElasticBlockStore は、kubelet のホストマシンに割り当てられ、Pod に公開される AWS Disk リソースを表します。詳細: 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 TODO: ファイルシステムのエラーによるマシンの侵害を防ぐにはどうすればよいですか ?

パーティション

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

6.1.349. .spec.volumes[].azureDisk

説明
azureDisk は、ホスト上の Azure Data Disk マウントを表し、Pod へのバインドマウントを表します。
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 設定が強制的に実行されます。

6.1.350. .spec.volumes[].azureFile

説明
azureFile は、ホスト上の Azure File Service マウントを表し、マウントを Pod にバインドします。
object
必須
  • secretName
  • shareName
Expand
プロパティー説明

readOnly

boolean

readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

secretName

string

secretName は、Azure ストレージアカウント名とキーを含むシークレットの名前です。

shareName

string

shareName は Azure 共有名です。

6.1.351. .spec.volumes[].cephfs

説明
cephFS は、Pod の有効期間を共有するホストでの Ceph FS マウントを表します。
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

6.1.352. .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 TODO: その他の便利なルール度を追加。apiVersion、kind、uid

6.1.353. .spec.volumes[].cinder

説明
Cinder は、kubelets ホストマシンに接続およびマウントされた Cinder ボリュームを表します。詳細: 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

6.1.354. .spec.volumes[].cinder.secretRef

説明
secretRef は任意: OpenStack への接続に使用されるパラメーターを含むシークレットオブジェクトを指します。
object
Expand
プロパティー説明

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

6.1.355. .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 TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

任意。ConfigMap かそのキーを定義する必要があるかどうかを指定します。

6.1.356. .spec.volumes[].configMap.items

説明
item が指定されていない場合、参照される ConfigMap の Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。ConfigMap に存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
array

6.1.357. .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 はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。

6.1.358. .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 ドライバーに渡されるドライバー固有のプロパティーを格納します。サポートされている値は、ドライバーのドキュメントを参照してください。

6.1.359. .spec.volumes[].csi.nodePublishSecretRef

説明
nodePublishSecretRef は、CSI NodePublishVolume および NodeUnpublishVolume 呼び出しを完了するために CSI ドライバーに渡す機密情報を含むシークレットオブジェクトへの参照です。このフィールドはオプションであり、シークレットが不要な場合は空の場合があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレット参照が渡されます。
object
Expand
プロパティー説明

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

6.1.360. .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 フィールドを含むファイルを作成するための情報を表します

6.1.361. .spec.volumes[].downwardAPI.items

説明
items は、Downward API ボリュームファイルのリストです
array

6.1.362. .spec.volumes[].downwardAPI.items[]

説明
DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します
object
必須
  • path
Expand
プロパティー説明

fieldRef

object

必須:Pod のフィールドを選択します。アノテーション、ラベル、名前、名前空間のみがサポートされます。

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) のみがサポートされています。

6.1.363. .spec.volumes[].downwardAPI.items[].fieldRef

Description
必須:Pod のフィールドを選択します。アノテーション、ラベル、名前、名前空間のみがサポートされます。
タイプ
object
必須
  • fieldPath
Expand
プロパティー説明

apiVersion

string

FieldPath が記述されているスキーマのバージョン。デフォルトは "v1" です。

fieldPath

string

指定された API バージョンで選択するフィールドのパス。

6.1.364. .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

必須: 選択するリソース

6.1.365. .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 です。これは、制限が未定義であることを意味します。詳細: http://kubernetes.io/docs/user-guide/volumes#emptydir

6.1.366. .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 であってはなりません。

6.1.367. .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 と同じフィールドがここでも有効です。

6.1.368. .spec.volumes[].ephemeral.volumeClaimTemplate.metadata

説明
PVC の作成時に PVC にコピーされるラベルとアノテーションが含まれる場合があります。他のフィールドは許可されておらず、検証中に拒否されます。
object

6.1.369. .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 機能ゲートが有効になっている場合、このフィールドは常に DataSourceRef フィールドと同じ内容になります。

dataSourceRef

object

dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これは、空でない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のローカルオブジェクトである可能性があります。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、DataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性のために、両方のフィールド (DataSource と DataSourceRef) は、一方が空でもう一方が空でない場合、自動的に同じ値に設定されます。DataSource と DataSourceRef には 2 つの重要な違いがあります。*DataSource は 2 つの特定のタイプのオブジェクトのみを許可しますが、DataSourceRef は非コアオブジェクトと PersistentVolumeClaim オブジェクトを許可します。* DataSource は許可されていない値を無視 (ドロップ) しますが、DataSourceRef はすべての値を保持し、許可されていない値が指定されている場合はエラーを生成します。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。

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

volumeMode

string

volumeMode は、要求に必要なボリュームのタイプを定義します。Filesystem の値は、要求仕様に含まれていない場合に暗示されます。

volumeName

string

volumeName は、この要求をサポートする PersistentVolume へのバインディング参照です。

6.1.370. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSource

説明
dataSource フィールドは、次のいずれかを指定するために使用できます。*既存の VolumeSnapshot オブジェクト (snapshot.storage.k8s.io/VolumeSnapshot)*既存の PVC(PersistentVolumeClaim) プロビジョナーまたは外部コントローラーが指定されたデータソースをサポートできる場合、指定されたデータソースのコンテンツに基づく新しいボリューム。AnyVolumeDataSource 機能ゲートが有効になっている場合、このフィールドは常に DataSourceRef フィールドと同じ内容になります。
タイプ
object
必須
  • kind
  • name
Expand
プロパティー説明

apiGroup

string

APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。

kind

string

kind は参照されているリソースのタイプです。

name

string

name は、参照されているリソースの名前です。

6.1.371. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef

説明
dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これは、空でない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のローカルオブジェクトである可能性があります。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、DataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性のために、両方のフィールド (DataSource と DataSourceRef) は、一方が空でもう一方が空でない場合、自動的に同じ値に設定されます。DataSource と DataSourceRef には 2 つの重要な違いがあります。*DataSource は 2 つの特定のタイプのオブジェクトのみを許可しますが、DataSourceRef は非コアオブジェクトと PersistentVolumeClaim オブジェクトを許可します。* DataSource は許可されていない値を無視 (ドロップ) しますが、DataSourceRef はすべての値を保持し、許可されていない値が指定されている場合はエラーを生成します。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。
object
必須
  • kind
  • name
Expand
プロパティー説明

apiGroup

string

APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。

kind

string

kind は参照されているリソースのタイプです。

name

string

name は、参照されているリソースの名前です。

6.1.372. .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/ を参照してください。

6.1.373. .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 で結合されます。

6.1.374. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

6.1.375. .spec.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

6.1.376. .spec.volumes[].fc

説明
fc は、kubelet のホストマシンに接続されてから Pod に公開されるファイバーチャネルリソースを表します。
object
Expand
プロパティー説明

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。TODO: ファイルシステムのエラーがマシンを危険にさらすのを防ぐにはどうすればよいですか ?

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 の組み合わせのいずれかを設定する必要がありますが、両方を同時に設定できません。

6.1.377. .spec.volumes[].flexVolume

説明
flexVolume は、exec ベースのプラグインを使用してプロビジョニング/接続される汎用ボリュームリソースを表します。
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 は、プラグインスクリプトに渡す機密情報を含むシークレットオブジェクトへの参照です。シークレットオブジェクトが指定されていない場合、これは空になる可能性があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレットがプラグインスクリプトに渡されます。

6.1.378. .spec.volumes[].flexVolume.secretRef

説明
secretRef は任意: secretRef は、プラグインスクリプトに渡す機密情報を含むシークレットオブジェクトへの参照です。シークレットオブジェクトが指定されていない場合、これは空になる可能性があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレットがプラグインスクリプトに渡されます。
object
Expand
プロパティー説明

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

6.1.379. .spec.volumes[].flocker

説明
flocker は、kubelet のホストマシンに接続されている Flocker ボリュームを表します。これは、実行中の Flocker 制御サービスによって異なります
object
Expand
プロパティー説明

datasetName

string

datasetName はメタデータとして保存されているデータセットの名前です → Flocker のデータセット上の名前は非推奨として扱うようにしてください。

datasetUUID

string

datasetUUID は、データセットの UUID です。これは Flocker データセットの一意の識別子です

6.1.380. .spec.volumes[].gcePersistentDisk

説明
gcePersistentDisk は、kubelet のホストマシンに接続されてから Pod に公開される GCE ディスクリソースを表します。詳細: 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 TODO: ファイルシステムのエラーによるマシンの侵害を防ぐにはどうすればよいですか ?

パーティション

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

6.1.381. .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 は、指定されたリビジョンのコミットハッシュです。

6.1.382. .spec.volumes[].glusterfs

説明
glusterfs は、Pod の存続期間を共有するホスト上の 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

6.1.383. .spec.volumes[].hostPath

説明
hostPath は、コンテナーに直接公開されているホストマシン上の既存のファイルまたはディレクトリーを表します。これは通常、ホストマシンの表示を許可されているシステムエージェントまたはその他の特権的なものに使用されます。ほとんどのコンテナーはこれを必要としません。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) ホストディレクトリーのマウントを使用できる人、およびホストディレクトリーを読み取り/書き込みでマウントできる人/できない人を制限する必要があります。
object
必須
  • path
Expand
プロパティー説明

path

string

ホスト上のディレクトリーのパス。パスがシンボリックリンクの場合、実際のパスへのリンクをたどります。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

type

string

HostPath ボリュームのデフォルトのタイプは "" です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

6.1.384. .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 TODO: ファイルシステムのエラーによるマシンの侵害を防ぐにはどうすればよいですか ?

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)。

6.1.385. .spec.volumes[].iscsi.secretRef

説明
secretRef は、iSCSI ターゲットおよびイニシエーター認証用の CHAP Secret です。
object
Expand
プロパティー説明

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

6.1.386. .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

6.1.387. .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

6.1.388. .spec.volumes[].photonPersistentDisk

説明
photonPersistentDisk は、kubelets ホストマシンに接続されマウントされた PhotonController 永続ディスクを表します。
object
必須
  • pdID
Expand
プロパティー説明

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

pdID

string

pdID は、Photon Controller の永続ディスクを識別する ID です。

6.1.389. .spec.volumes[].portworxVolume

説明
portworxVolume は、kubelet ホストマシンに接続およびマウントされた portworx ボリュームを表します。
object
必須
  • volumeID
Expand
プロパティー説明

fsType

string

fSType は、マウントするファイルシステムタイプを表します。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

readOnly

boolean

readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

volumeID

string

volumeID は、Portworx ボリュームを一意に識別します

6.1.390. .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

source は、ボリュームプロジェクションのリストです。

sources[]

object

サポートされている他のボリュームタイプと一緒にデプロイメントされる可能性のあるプロジェクション

6.1.391. .spec.volumes[].projected.sources

説明
source は、ボリュームプロジェクションのリストです。
array

6.1.392. .spec.volumes[].projected.sources[]

説明
サポートされている他のボリュームタイプと一緒にデプロイメントされる可能性のあるプロジェクション
object
Expand
プロパティー説明

configMap

object

プロジェクトへの configMap データの configMap 情報

downwardAPI

object

downwardAPI データのプロジェクトへの downwardAPI 情報

secret

object

投影するシークレットデータに関する情報

serviceAccountToken

object

serviceAccountToken は、投影する serviceAccountToken データに関する情報です。

6.1.393. .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 TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

任意。ConfigMap かそのキーを定義する必要があるかどうかを指定します。

6.1.394. .spec.volumes[].projected.sources[].configMap.items

説明
item が指定されていない場合、参照される ConfigMap の Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。ConfigMap に存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
array

6.1.395. .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 はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。

6.1.396. .spec.volumes[].projected.sources[].downwardAPI

説明
downwardAPI データのプロジェクトへの downwardAPI 情報
object
Expand
プロパティー説明

items

array

Items は DownwardAPIVolume ファイルのリストです

items[]

object

DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します

6.1.397. .spec.volumes[].projected.sources[].downwardAPI.items

説明
Items は DownwardAPIVolume ファイルのリストです
array

6.1.398. .spec.volumes[].projected.sources[].downwardAPI.items[]

説明
DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します
object
必須
  • path
Expand
プロパティー説明

fieldRef

object

必須:Pod のフィールドを選択します。アノテーション、ラベル、名前、名前空間のみがサポートされます。

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) のみがサポートされています。

6.1.399. .spec.volumes[].projected.sources[].downwardAPI.items[].fieldRef

Description
必須:Pod のフィールドを選択します。アノテーション、ラベル、名前、名前空間のみがサポートされます。
タイプ
object
必須
  • fieldPath
Expand
プロパティー説明

apiVersion

string

FieldPath が記述されているスキーマのバージョン。デフォルトは "v1" です。

fieldPath

string

指定された API バージョンで選択するフィールドのパス。

6.1.400. .spec.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

必須: 選択するリソース

6.1.401. .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 TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

オプションフィールドは、シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.402. .spec.volumes[].projected.sources[].secret.items

説明
items が指定されていない場合、参照されるシークレットの Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。シークレットに存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
array

6.1.403. .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 はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。

6.1.404. .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 は、トークンのデプロイメント先となるファイルのマウントポイントに対する相対パスです。

6.1.405. .spec.volumes[].quobyte

説明
quobyte は、Pod の有効期限を共有するホストでの 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 は、すでに作成されているクオバイトボリュームを名前で参照する文字列です。

6.1.406. .spec.volumes[].rbd

説明
rbd は、Pod の有効期間を共有するホストの Rados ブロックデバイスマウントを表します。詳細: 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 TODO: ファイルシステムのエラーによるマシンの侵害を防ぐにはどうすればよいですか ?

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

6.1.407. .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 TODO: その他の便利なルール度を追加。apiVersion、kind、uid

6.1.408. .spec.volumes[].scaleIO

説明
scaleIO は、Kubernetes ノードに接続およびマウントされた 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 システムですでに作成されているボリュームの名前です。

6.1.409. .spec.volumes[].scaleIO.secretRef

説明
secretRef は、ScaleIO ユーザーおよびその他の機密情報の秘密を参照します。これが指定されていない場合、ログイン操作は失敗します。
object
Expand
プロパティー説明

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

6.1.410. .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

6.1.411. .spec.volumes[].secret.items

説明
items が指定されていない場合、参照されるシークレットの Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。シークレットに存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
array

6.1.412. .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 はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。

6.1.413. .spec.volumes[].storageos

説明
storageOS は、Kubernetes ノードに接続およびマウントされた 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 が作成されます。

6.1.414. .spec.volumes[].storageos.secretRef

説明
secretRef は、StorageOS API クレデンシャルを取得するために使用するシークレットを指定します。指定しない場合、デフォルト値が試行されます。
object
Expand
プロパティー説明

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

6.1.415. .spec.volumes[].vsphereVolume

説明
vsphereVolume は、kubelet ホストマシンに接続およびマウントされた vSphere ボリュームを表します。
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 を識別するパスです。

6.1.416. .spec.web

説明
WebSpec は、Prometheus の起動時に Web コマンドラインフラグを定義します。
object
Expand
プロパティー説明

httpConfig

object

Web サーバーの HTTP パラメーターを定義します。

pageTitle

string

プロメテウスのウェブページのタイトル

tlsConfig

object

HTTPS の TLS パラメーターを定義します。

6.1.417. .spec.web.httpConfig

説明
Web サーバーの HTTP パラメーターを定義します。
object
Expand
プロパティー説明

headers

object

HTTP 応答に追加できるヘッダーのリスト。

http2

boolean

HTTP/2 サポートを有効にします。HTTP/2 は TLS でのみサポートされることに注意してください。TLSConfig が設定されていない場合、HTTP/2 は無効になります。フィールドの値が変わるたびに、ローリング更新がトリガーされます。

6.1.418. .spec.web.httpConfig.headers

説明
HTTP 応答に追加できるヘッダーのリスト。
object
Expand
プロパティー説明

contentSecurityPolicy

string

HTTP 応答に Content-Security-Policy ヘッダーを設定します。空白の場合は設定しません。

strictTransportSecurity

string

HTTP 応答に Strict-Transport-Security ヘッダーを設定します。空白の場合は設定しません。このヘッダーは、ブラウザーは同じドメインとサブドメインでホストされている Prometheus やその他のアプリケーションを HTTPS 経由で読み込むよう強制する可能性があるため、注意して使用してください。https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security

xContentTypeOptions

string

X-Content-Type-Options ヘッダーを HTTP 応答に設定します。空白の場合は設定しません。許可される値は nosniff です。https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options

xFrameOptions

string

X-Frame-Options ヘッダーを HTTP 応答に設定します。空白の場合は設定しません。許可される値は、deny と sameorigin です。https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options

xXSSProtection

string

すべての応答に X-XSS-Protection ヘッダーを設定します。空白の場合は設定しません。https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection

6.1.419. .spec.web.tlsConfig

説明
HTTPS の TLS パラメーターを定義します。
object
必須
  • cert
  • keySecret
Expand
プロパティー説明

cert

object

サーバーの TLS 証明書が含まれています。

cipherSuites

array (string)

TLS1.2 までの TLS バージョンでサポートされている暗号スイートのリスト。空の場合、Go のデフォルトの暗号スイートが使用されます。利用可能な暗号スイートは、go のドキュメントに記載されています: https://golang.org/pkg/crypto/tls/#pkg-constants

clientAuthType

string

クライアント認証のサーバーポリシー。ClientAuth ポリシーにマップします。clientAuth オプションの詳細については、https://golang.org/pkg/crypto/tls/#ClientAuthType をご覧ください。

client_ca

object

サーバーへのクライアント証明書認証用の CA 証明書が含まれています。

curvePreferences

array (string)

ECDHE ハンドシェイクで使用される楕円曲線を優先順に使用します。利用可能な曲線は、go のドキュメントに記載されています: https://golang.org/pkg/crypto/tls/#CurveID

keySecret

object

サーバーの TLS キーを含むシークレット。

maxVersion

string

許容可能な最大 TLS バージョン。デフォルトは TLS13 です。

minVersion

string

許容可能な最小 TLS バージョン。デフォルトは TLS12 です。

preferServerCipherSuites

boolean

サーバーがクライアントの最も優先される暗号スイートを選択するか、サーバーの最も優先される暗号スイートを選択するかを制御します。true の場合、cipherSuites の要素の順序で表されるサーバーの設定が使用されます。

6.1.420. .spec.web.tlsConfig.cert

説明
サーバーの TLS 証明書が含まれています。
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

6.1.421. .spec.web.tlsConfig.cert.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

6.1.422. .spec.web.tlsConfig.cert.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.423. .spec.web.tlsConfig.client_ca

説明
サーバーへのクライアント証明書認証用の CA 証明書が含まれています。
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

6.1.424. .spec.web.tlsConfig.client_ca.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

6.1.425. .spec.web.tlsConfig.client_ca.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.426. .spec.web.tlsConfig.keySecret

説明
サーバーの TLS キーを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

6.1.427. .status

説明
Prometheus クラスターの最新の観測ステータス。read-only詳細: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
object
必須
  • availableReplicas
  • paused
  • replicas
  • unavailableReplicas
  • updatedReplicas
Expand
プロパティー説明

availableReplicas

integer

この Prometheus デプロイメントの対象となる利用可能な Pod の総数 (少なくとも minReadySeconds の準備ができています)。

conditions

array

Prometheus デプロイメントの現在の状態。

conditions[]

object

PrometheusCondition は、Prometheus リソースに関連付けられたリソースの状態を表します。

paused

boolean

基になるマネージドオブジェクトに対してアクションが実行されているかどうかを表します。削除アクションのみが実行されます。

replicas

integer

この Prometheus デプロイメントの対象となる非終了 Pod の総数 (ラベルはセレクターと一致します)。

shardStatuses

array

リストにはシャードごとに 1 つのエントリーがあります。各エントリーには、シャードのステータスの概要が示されます。

shardStatuses[]

object

 

unavailableReplicas

integer

この Prometheus デプロイメントの対象となる使用できない Pod の総数。

updatedReplicas

integer

この Prometheus デプロイメントの対象であり、目的のバージョン仕様を持つ、終了していない Pod の総数。

6.1.428. .status.conditions

説明
Prometheus デプロイメントの現在の状態。
array

6.1.429. .status.conditions[]

説明
PrometheusCondition は、Prometheus リソースに関連付けられたリソースの状態を表します。
object
必須
  • lastTransitionTime
  • status
  • type
Expand
プロパティー説明

lastTransitionTime

string

lastTransitionTime は、現在のステータスプロパティーが最後に更新された時刻です。

message

string

条件の最後の遷移の詳細を示す、人間が判読できるメッセージ。

observedGeneration

integer

observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。

reason

string

条件の最後の遷移の理由。

status

string

条件のステータス。

type

string

報告される条件のタイプ。

6.1.430. .status.shardStatuses

説明
リストにはシャードごとに 1 つのエントリーがあります。各エントリーには、シャードのステータスの概要が示されます。
array

6.1.431. .status.shardStatuses[]

説明
object
必須
  • availableReplicas
  • replicas
  • shardID
  • unavailableReplicas
  • updatedReplicas
Expand
プロパティー説明

availableReplicas

integer

このシャードのターゲットとなる利用可能な (準備完了となってから少なくとも minReadySeconds が経過している) Pod の総数。

replicas

integer

このシャードがターゲットとする Pod の総数。

shardID

string

シャードの識別子。

unavailableReplicas

integer

このシャードがターゲットとする、使用できない Pod の総数。

updatedReplicas

integer

このシャードがターゲットとする、期待される仕様を持つ終了していない Pod の総数。

6.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/monitoring.coreos.com/v1/prometheuses

    • GET: 種類が Prometheus のオブジェクトをリスト表示します。
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheuses

    • DELETE: Prometheus のコレクションを削除します。
    • GET: 種類が Prometheus のオブジェクトをリスト表示します。
    • POST:Prometheus を作成します。
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheuses/{name}

    • DELETE: Prometheus を削除します。
    • GET: 指定された Prometheus を読み取ります。
    • PATCH: 指定された Prometheus を部分的に更新します。
    • PUT: 指定された Prometheus を置き換えます。
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheuses/{name}/status

    • GET: 指定された Prometheus のステータスを読み取ります。
    • PATCH: 指定された Prometheus のステータスを部分的に更新します。
    • PUT: 指定された Prometheus のステータスを置き換えます。

6.2.1. /apis/monitoring.coreos.com/v1/prometheuses

Expand
表6.1 グローバルクエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

HTTP メソッド
GET
説明
種類が Prometheus のオブジェクトをリスト表示します。
Expand
表6.2 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

PrometheusList スキーマ

401 - Unauthorized

空白

6.2.2. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheuses

Expand
表6.3 グローバルパスパラメーター
パラメーター説明

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

Expand
表6.4 グローバルクエリーパラメーター
パラメーター説明

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
プロメテウスのコレクションを削除する
Expand
表6.5 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表6.6 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
プロメテウスの種類のオブジェクトをリスト表示します
Expand
表6.7 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表6.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

PrometheusList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
Prometheus を作成します。
Expand
表6.9 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

fieldValidation

string

fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表6.10 ボディーパラメーター
パラメーター説明

ボディー

Prometheus スキーマ

 
Expand
表6.11 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Prometheus スキーマ

201 - Created

Prometheus スキーマ

202 - Accepted

Prometheus スキーマ

401 - Unauthorized

空白

6.2.3. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheuses/{name}

Expand
表6.12 グローバルパスパラメーター
パラメーター説明

name

string

プロメテウスの名前

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

Expand
表6.13 グローバルクエリーパラメーター
パラメーター説明

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
Prometheus を削除する
Expand
表6.14 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

gracePeriodSeconds

integer

オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。

orphanDependents

boolean

非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。

propagationPolicy

string

ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。

Expand
表6.15 本文パラメーター
パラメーター説明

body

DeleteOptions スキーマ

 
Expand
表6.16 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定されたプロメテウスを読む
Expand
表6.17 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表6.18 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Prometheus スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された Prometheus を部分的に更新します
Expand
表6.19 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

fieldValidation

string

fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表6.20 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表6.21 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Prometheus スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された Prometheus を置き換える
Expand
表6.22 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

fieldValidation

string

fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表6.23 ボディーパラメーター
パラメーター説明

ボディー

Prometheus スキーマ

 
Expand
表6.24 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Prometheus スキーマ

201 - Created

Prometheus スキーマ

401 - Unauthorized

空白

6.2.4. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheuses/{name}/status

Expand
表6.25 グローバルパスパラメーター
パラメーター説明

name

string

プロメテウスの名前

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

Expand
表6.26 グローバルクエリーパラメーター
パラメーター説明

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
GET
説明
指定された Prometheus のステータスを読み取ります
Expand
表6.27 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表6.28 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Prometheus スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された Prometheus のステータスを部分的に更新します
Expand
表6.29 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

fieldValidation

string

fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表6.30 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表6.31 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Prometheus スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された Prometheus のステータスを置き換えます
Expand
表6.32 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

fieldValidation

string

fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表6.33 ボディーパラメーター
パラメーター説明

ボディー

Prometheus スキーマ

 
Expand
表6.34 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Prometheus スキーマ

201 - Created

Prometheus スキーマ

401 - Unauthorized

空白

第7章 PrometheusRule [monitoring.coreos.com/v1]

説明
PrometheusRule は、Prometheus インスタンスの記録とアラートのルールを定義します
object
必須
  • spec

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

Prometheus に必要なアラートルール定義の仕様。

7.1.1. .spec

説明
Prometheus に必要なアラートルール定義の仕様。
object
Expand
プロパティー説明

groups

array

Prometheus ルールファイルの内容

groups[]

object

RuleGroup は、順次評価される記録およびアラートルールのリストです。注:PartialResponseStrategy は ThanosRuler でのみ使用され、Prometheus インスタンスでは無視されます。このフィールドの有効な値は、警告または中止です。詳細情報: https://github.com/thanos-io/thanos/blob/main/docs/components/rule.md#partial-response

7.1.2. .spec.groups

説明
Prometheus ルールファイルの内容
array

7.1.3. .spec.groups[]

説明
RuleGroup は、順次評価される記録およびアラートルールのリストです。注:PartialResponseStrategy は ThanosRuler でのみ使用され、Prometheus インスタンスでは無視されます。このフィールドの有効な値は、警告または中止です。詳細情報: https://github.com/thanos-io/thanos/blob/main/docs/components/rule.md#partial-response
object
必須
  • name
  • rules
Expand
プロパティー説明

interval

string

 

name

string

 

partial_response_strategy

string

 

rules

array

 

rules[]

object

ルールとは、アラートまたは記録ルールを表します。Prometheus のドキュメントを参照してください: [alerting](https://www.prometheus.io/docs/prometheus/latest/configuration/alerting_rules/) ルール、または [recording](https://www.prometheus.io/docs/prometheus/latest/configuration/recording_rules/#recording-rules) ルール

7.1.4. .spec.groups[].rules

Description
array

7.1.5. .spec.groups[].rules[]

説明
ルールとは、アラートまたは記録ルールを表します。Prometheus のドキュメントを参照してください: [alerting](https://www.prometheus.io/docs/prometheus/latest/configuration/alerting_rules/) ルール、または [recording](https://www.prometheus.io/docs/prometheus/latest/configuration/recording_rules/#recording-rules) ルール
object
必須
  • expr
Expand
プロパティー説明

alert

string

 

annotations

object (string)

 

expr

integer-or-string

 

for

string

 

labels

object (string)

 

record

string

 

7.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/monitoring.coreos.com/v1/prometheusrules

    • GET: 種類が PrometheusRule のオブジェクトをリスト表示します。
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheusrules

    • DELETE: PrometheusRule のコレクションを削除します。
    • GET: 種類が PrometheusRule のオブジェクトをリスト表示します。
    • POST: PrometheusRule を作成します。
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheusrules/{name}

    • DELETE: PrometheusRule を削除します。
    • GET: 指定された PrometheusRule を読み取ります。
    • PATCH: 指定された PrometheusRule を部分的に更新します。
    • PUT: 指定された PrometheusRule を置き換えます。

7.2.1. /apis/monitoring.coreos.com/v1/prometheusrules

Expand
表7.1 グローバルクエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

HTTP メソッド
GET
説明
種類が PrometheusRule のオブジェクトをリスト表示します。
Expand
表7.2 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

PrometheusRuleList スキーマ

401 - Unauthorized

空白

7.2.2. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheusrules

Expand
表7.3 グローバルパスパラメーター
パラメーター説明

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

Expand
表7.4 グローバルクエリーパラメーター
パラメーター説明

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
PrometheusRule のコレクションを削除します
Expand
表7.5 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表7.6 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
PrometheusRule の種類のオブジェクトをリスト表示します
Expand
表7.7 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表7.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

PrometheusRuleList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
PrometheusRule を作成する
Expand
表7.9 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

fieldValidation

string

fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表7.10 ボディーパラメーター
パラメーター説明

ボディー

PrometheusRule スキーマ

 
Expand
表7.11 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

PrometheusRule スキーマ

201 - Created

PrometheusRule スキーマ

202 - Accepted

PrometheusRule スキーマ

401 - Unauthorized

空白

7.2.3. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheusrules/{name}

Expand
表7.12 グローバルパスパラメーター
パラメーター説明

name

string

PrometheusRule の名前

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

Expand
表7.13 グローバルクエリーパラメーター
パラメーター説明

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
PrometheusRule を削除します
Expand
表7.14 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

gracePeriodSeconds

integer

オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。

orphanDependents

boolean

非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。

propagationPolicy

string

ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。

Expand
表7.15 本文パラメーター
パラメーター説明

body

DeleteOptions スキーマ

 
Expand
表7.16 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された PrometheusRule を読み取ります
Expand
表7.17 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表7.18 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

PrometheusRule スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された PrometheusRule を部分的に更新します
Expand
表7.19 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

fieldValidation

string

fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表7.20 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表7.21 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

PrometheusRule スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された PrometheusRule を置き換えます
Expand
表7.22 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

fieldValidation

string

fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表7.23 ボディーパラメーター
パラメーター説明

ボディー

PrometheusRule スキーマ

 
Expand
表7.24 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

PrometheusRule スキーマ

201 - Created

PrometheusRule スキーマ

401 - Unauthorized

空白

第8章 ServiceMonitor [monitoring.coreos.com/v1]

説明
ServiceMonitor は、一連のサービスの監視を定義します。
object
必須
  • spec

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

Prometheus によるターゲット検出に必要なサービス選択の仕様。

8.1.1. .spec

説明
Prometheus によるターゲット検出に必要なサービス選択の仕様。
object
必須
  • endpoints
  • selector
Expand
プロパティー説明

endpoints

array

この ServiceMonitor の一部として許可されているエンドポイントのリスト。

endpoints[]

object

Endpoint は、Prometheus メトリックを提供するスクレイプ可能なエンドポイントを定義します。

jobLabel

string

jobLabel は、関連付けられた Kubernetes Service オブジェクトからラベルを選択します。このラベルは、すべてのメトリクスの job ラベルとして使用されます。例: ServiceMonitor.spec.jobLabel: foo および Service.metadata.labels.foo: bar で、job="bar" ラベルがすべてのメトリクスに追加されます。このフィールドの値が空の場合、または指定されたサービスにそのラベルが存在しない場合、メトリクスの job ラベルのデフォルトは、関連付けられている Kubernetes Service の名前になります。

labelLimit

integer

サンプルに受け入れられるラベルの数のスクレープごとの制限。Prometheus バージョン 2.27.0 以降でのみ有効です。

labelNameLengthLimit

integer

サンプルで受け入れられるラベル名の長さのスクレープごとの制限。Prometheus バージョン 2.27.0 以降でのみ有効です。

labelValueLengthLimit

integer

サンプルに受け入れられるラベル値の長さのスクレープごとの制限。Prometheus バージョン 2.27.0 以降でのみ有効です。

namespaceSelector

object

KubernetesEndpoints オブジェクトが検出される名前空間を選択するためのセレクター。

podTargetLabels

array (string)

PodTargetLabels は、Kubernetes Pod のラベルを作成されたメトリックに転送します。

sampleLimit

integer

SampleLimit は、受け入れられるスクレイプされたサンプルの数に対するスクレイプごとの制限を定義します。

selector

object

エンドポイントオブジェクトを選択するためのセレクター。

targetLabels

array (string)

TargetLabels は、ラベルを Kubernetes サービス から作成されたメトリックに転送します。

targetLimit

integer

TargetLimit は、受け入れられるスクレイプされたターゲットの数の制限を定義します。

8.1.2. .spec.endpoints

Description
この ServiceMonitor の一部として許可されているエンドポイントのリスト。
タイプ
array

8.1.3. .spec.endpoints[]

Description
Endpoint は、Prometheus メトリックを提供するスクレイプ可能なエンドポイントを定義します。
タイプ
object
Expand
プロパティー説明

authorization

object

このエンドポイントの承認セクション

basicAuth

object

BasicAuth を使用すると、エンドポイントは基本認証を介して認証できます。詳細: https://prometheus.io/docs/operating/configuration/#endpoints

bearerTokenFile

string

ターゲットをスクレイピングするためのベアラトークンを読み取るためのファイル。

bearerTokenSecret

object

ターゲットをスクレイピングするためのベアラトークンを読み取るためにマウントする秘密。シークレットは、サービスモニターと同じ名前空間にあり、PrometheusOperator がアクセスできる必要があります。

enableHttp2

boolean

HTTP2 を有効にするかどうか。

followRedirects

boolean

FollowRedirects は、収集リクエストが HTTP 3xx リダイレクトされるかどうかを設定します。

honorLabels

ブール値

HonorLabels は、ターゲットラベルとの衝突時にメトリックのラベルを選択します。

honorTimestamps

ブール値

HonorTimestamps は、Prometheus がスクレイピングされたデータに存在するタイムスタンプを尊重するかどうかを制御します。

interval

string

指定されていない場合に Prometheus のグローバルスクレイプ間隔が使用される場合にスクレイプする間隔。

metricRelabelings

array

取り込み前にサンプルに適用する MetricRelabelConfigs。

metricRelabelings[]

object

RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の <metric_relabel_configs> セクションを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs

oauth2

object

URL の OAuth2。Prometheus バージョン 2.27.0 以降でのみ有効です。

params

object

オプションの HTTPURL パラメーター

params{}

array (string)

 

path

string

メトリックをスクレイプするための HTTP パス。空の場合、Prometheus はデフォルト値 (例: /metrics) を使用します。

port

string

このエンドポイントが参照するサービスポートの名前。targetPort と相互に排他的です。

proxyUrl

string

ProxyURL 例: http://proxyserver:2195 このエンドポイントを介してスクレイプをプロキシーに送信します。

relabelings

array

スクレイピングする前にサンプルに適用する RelabelConfigs。Operator は、いくつかの標準 Kubernetes フィールドのラベルの再設定を自動的に追加します。元のスクレイプジョブの名前は、\__tmp_prometheus_job_name ラベルから取得できます。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

relabelings[]

object

RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の <metric_relabel_configs> セクションを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs

scheme

string

スクレイピングに使用する HTTP スキーム。

scrapeTimeout

string

スクレイプが終了した後のタイムアウト。指定されていない場合、Prometheus グローバルスクレイプのタイムアウトは、後者が使用される Interval 未満でない限り使用されます。

targetPort

integer-or-string

サービスの背後にある Pod のターゲットポートの名前または番号。ポートはコンテナーポートプロパティーで指定する必要があります。ポートと相互に排他的です。

tlsConfig

object

エンドポイントをスクレイピングするときに使用する TLS 設定

8.1.4. .spec.endpoints[].authorization

Description
このエンドポイントの承認セクション
object
Expand
プロパティー説明

credentials

object

リクエストのクレデンシャルを含むシークレットのキー

type

string

認証タイプを設定します。デフォルトは Bearer で、Basic はエラーを引き起こします

8.1.5. .spec.endpoints[].authorization.credentials

Description
リクエストのクレデンシャルを含むシークレットのキー
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

8.1.6. .spec.endpoints[].basicAuth

Description
BasicAuth を使用すると、エンドポイントは基本認証を介して認証できます。詳細: https://prometheus.io/docs/operating/configuration/#endpoints
タイプ
object
Expand
プロパティー説明

password

object

認証用のパスワードを含むサービスモニター名前空間のシークレット。

username

object

認証用のユーザー名を含むサービスモニター名前空間のシークレット。

8.1.7. .spec.endpoints[].basicAuth.password

Description
認証用のパスワードを含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

8.1.8. .spec.endpoints[].basicAuth.username

Description
認証用のユーザー名を含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

8.1.9. .spec.endpoints[].bearerTokenSecret

Description
ターゲットをスクレイピングするためのベアラトークンを読み取るためにマウントする秘密。シークレットは、サービスモニターと同じ名前空間にあり、PrometheusOperator がアクセスできる必要があります。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

8.1.10. .spec.endpoints[].metricRelabelings

Description
取り込み前にサンプルに適用する MetricRelabelConfigs。
array

8.1.11. .spec.endpoints[].metricRelabelings[]

Description
RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の <metric_relabel_configs> セクションを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
タイプ
object
Expand
プロパティー説明

action

string

正規表現のマッチングに基づいて実行するアクション。デフォルトは置換です。大文字および小文字のアクションには、Prometheus >= 2.36 が必要です。

modulus

integer

ソースラベル値のハッシュを取得するためのモジュラス。

regex

string

抽出された値が一致する正規表現。デフォルトは (.*) です。

replacement

string

正規表現が一致する場合に正規表現置換が実行される置換値。正規表現キャプチャグループが利用可能です。デフォルトは $1 です。

separator

string

連結されたソースラベル値の間に配置されたセパレータ。デフォルトは ';' です。

sourceLabels

array (string)

ソースラベルは、既存のラベルから値を選択します。それらのコンテンツは、設定されたセパレーターを使用して連結され、置換、保持、および削除アクションの設定された正規表現と照合されます。

targetLabel

string

結果の値が置換アクションで書き込まれるラベル。置換アクションには必須です。正規表現キャプチャグループが利用可能です。

8.1.12. .spec.endpoints[].oauth2

Description
URL の OAuth2。Prometheus バージョン 2.27.0 以降でのみ有効です。
object
必須
  • clientId
  • clientSecret
  • tokenUrl
Expand
プロパティー説明

clientId

object

OAuth2 クライアント ID を含むシークレットまたは設定マップ

clientSecret

object

OAuth2 クライアントシークレットを含むシークレット

endpointParams

object (string)

トークン URL に追加するパラメーター

scopes

array (string)

トークンリクエストに使用される OAuth2 スコープ

tokenUrl

string

トークンをフェッチする URL

8.1.13. .spec.endpoints[].oauth2.clientId

Description
OAuth2 クライアント ID を含むシークレットまたは設定マップ
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

8.1.14. .spec.endpoints[].oauth2.clientId.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

8.1.15. .spec.endpoints[].oauth2.clientId.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

8.1.16. .spec.endpoints[].oauth2.clientSecret

Description
OAuth2 クライアントシークレットを含むシークレット
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

8.1.17. .spec.endpoints[].params

Description
オプションの HTTPURL パラメーター
タイプ
object

8.1.18. .spec.endpoints[].relabelings

Description
スクレイピングする前にサンプルに適用する RelabelConfigs。Operator は、いくつかの標準 Kubernetes フィールドのラベルの再設定を自動的に追加します。元のスクレイプジョブの名前は、\__tmp_prometheus_job_name ラベルから取得できます。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
array

8.1.19. .spec.endpoints[].relabelings[]

Description
RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の <metric_relabel_configs> セクションを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
タイプ
object
Expand
プロパティー説明

action

string

正規表現のマッチングに基づいて実行するアクション。デフォルトは置換です。大文字および小文字のアクションには、Prometheus >= 2.36 が必要です。

modulus

integer

ソースラベル値のハッシュを取得するためのモジュラス。

regex

string

抽出された値が一致する正規表現。デフォルトは (.*) です。

replacement

string

正規表現が一致する場合に正規表現置換が実行される置換値。正規表現キャプチャグループが利用可能です。デフォルトは $1 です。

separator

string

連結されたソースラベル値の間に配置されたセパレータ。デフォルトは ';' です。

sourceLabels

array (string)

ソースラベルは、既存のラベルから値を選択します。それらのコンテンツは、設定されたセパレーターを使用して連結され、置換、保持、および削除アクションの設定された正規表現と照合されます。

targetLabel

string

結果の値が置換アクションで書き込まれるラベル。置換アクションには必須です。正規表現キャプチャグループが利用可能です。

8.1.20. .spec.endpoints[].tlsConfig

Description
エンドポイントをスクレイピングするときに使用する TLS 設定
タイプ
object
Expand
プロパティー説明

ca

object

ターゲットに使用する CA 証明書を含む構造体。

caFile

string

ターゲットに使用する Prometheus コンテナー内の CA 証明書へのパス。

cert

object

ターゲットのクライアント証明書ファイルを含む構造体。

certFile

string

ターゲットの Prometheus コンテナー内のクライアント証明書ファイルへのパス。

insecureSkipVerify

boolean

ターゲット証明書の検証を無効にします。

keyFile

string

ターゲットの Prometheus コンテナー内のクライアントキーファイルへのパス。

keySecret

object

ターゲットのクライアントキーファイルを含むシークレット。

serverName

string

ターゲットのホスト名を確認するために使用されます。

8.1.21. .spec.endpoints[].tlsConfig.ca

Description
ターゲットに使用する CA 証明書を含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

8.1.22. .spec.endpoints[].tlsConfig.ca.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

8.1.23. .spec.endpoints[].tlsConfig.ca.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

8.1.24. .spec.endpoints[].tlsConfig.cert

Description
ターゲットのクライアント証明書ファイルを含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

8.1.25. .spec.endpoints[].tlsConfig.cert.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

8.1.26. .spec.endpoints[].tlsConfig.cert.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

8.1.27. .spec.endpoints[].tlsConfig.keySecret

説明
ターゲットのクライアントキーファイルを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

8.1.28. .spec.namespaceSelector

Description
KubernetesEndpoints オブジェクトが検出される名前空間を選択するためのセレクター。
タイプ
object
Expand
プロパティー説明

any

boolean

それらを制限するリストとは対照的に、すべての namespace が選択されているかどうかを説明するブール値。

matchNames

array (string)

選択する namespace 名のリスト。

8.1.29. .spec.selector

Description
エンドポイントオブジェクトを選択するためのセレクター。
タイプ
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.30. .spec.selector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

8.1.31. .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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

8.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/monitoring.coreos.com/v1/servicemonitors

    • GET: 種類が ServiceMonitor のオブジェクトをリスト表示します。
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/servicemonitors

    • DELETE: ServiceMonitor のコレクションを削除します。
    • GET: 種類が ServiceMonitor のオブジェクトをリスト表示します。
    • POST: ServiceMonitor を作成します。
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/servicemonitors/{name}

    • DELETE: ServiceMonitor を削除します。
    • GET: 指定された ServiceMonitor を読み取ります。
    • PATCH: 指定された ServiceMonitor を部分的に更新します。
    • PUT: 指定された ServiceMonitor を置き換えます。

8.2.1. /apis/monitoring.coreos.com/v1/servicemonitors

Expand
表8.1 グローバルクエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

HTTP メソッド
GET
説明
種類が ServiceMonitor のオブジェクトをリスト表示します。
Expand
表8.2 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ServiceMonitorList スキーマ

401 - Unauthorized

空白

8.2.2. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/servicemonitors

Expand
表8.3 グローバルパスパラメーター
パラメーター説明

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

Expand
表8.4 グローバルクエリーパラメーター
パラメーター説明

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
ServiceMonitor のコレクションを削除します
Expand
表8.5 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表8.6 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
ServiceMonitor の種類のオブジェクトをリスト表示します
Expand
表8.7 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表8.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ServiceMonitorList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
ServiceMonitor を作成します
Expand
表8.9 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

fieldValidation

string

fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表8.10 ボディーパラメーター
パラメーター説明

ボディー

ServiceMonitor スキーマ

 
Expand
表8.11 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ServiceMonitor スキーマ

201 - Created

ServiceMonitor スキーマ

202 - Accepted

ServiceMonitor スキーマ

401 - Unauthorized

空白

8.2.3. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/servicemonitors/{name}

Expand
表8.12 グローバルパスパラメーター
パラメーター説明

name

string

ServiceMonitor の名前

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

Expand
表8.13 グローバルクエリーパラメーター
パラメーター説明

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
ServiceMonitor を削除します
Expand
表8.14 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

gracePeriodSeconds

integer

オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。

orphanDependents

boolean

非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。

propagationPolicy

string

ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。

Expand
表8.15 本文パラメーター
パラメーター説明

body

DeleteOptions スキーマ

 
Expand
表8.16 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された ServiceMonitor を読み取ります
Expand
表8.17 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表8.18 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ServiceMonitor スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された ServiceMonitor を部分的に更新します
Expand
表8.19 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

fieldValidation

string

fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表8.20 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表8.21 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ServiceMonitor スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された ServiceMonitor を置き換えます。
Expand
表8.22 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

fieldValidation

string

fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表8.23 ボディーパラメーター
パラメーター説明

ボディー

ServiceMonitor スキーマ

 
Expand
表8.24 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ServiceMonitor スキーマ

201 - Created

ServiceMonitor スキーマ

401 - Unauthorized

空白

第9章 ThanosRuler [monitoring.coreos.com/v1]

説明
ThanosRuler は、ThanosRuler デプロイメントを定義します。
object
必須
  • spec

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

ThanosRuler クラスターの望ましい動作の仕様。詳細: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

status

object

ThanosRuler クラスターの最新の観測ステータス。read-onlyapiserver からのリクエストには含まれず、ThanosRulerOperatorAPI 自体からのみ含まれます。詳細: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

9.1.1. .spec

説明
ThanosRuler クラスターの望ましい動作の仕様。詳細: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
object
Expand
プロパティー説明

affinity

object

指定した場合、Pod のスケジューリング制約。

alertDropLabels

array (string)

AlertDropLabels は、ThanosRuler アラートでドロップするラベル名を設定します。レプリカラベル thanos_ruler_replica は、必ずアラートから削除されます。

alertQueryUrl

string

Thanos Ruler がすべてのアラートの 'Source' フィールドに設定する外部クエリー URL。'--alert.query-url'CLI 引数にマップします。

alertRelabelConfigFile

string

AlertRelabelConfigFile は、アラートのラベル再設定の設定ファイルパスを指定します。AlertRelabelConfigs と併用する場合、alertRelabelConfigFile が優先されます。

alertRelabelConfigs

object

AlertRelabelConfigs は、ThanosRuler でのアラートのラベル再設定を設定します。アラートのラベル再設定は、Prometheus 公式ドキュメント (https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs) で指定されている形式を使用する必要があります。これは AlertRelabelConfigFile の代替であり、優先順位は低くなります。

alertmanagersConfig

object

alertmanager に接続するための設定を定義します。thanosv0.10.0 以降でのみ使用できます。alertmanagers.config 引数にマップします。

alertmanagersUrl

array (string)

Alertmanager にアラートを送信するための URL を定義します。Thanos v0.10.0 以降では、代わりに AlertManagersConfig を使用する必要があります。注:AlertManagersConfig が指定されている場合、このフィールドは無視されます。alertmanagers.url 引数にマップします。

containers

array

コンテナーを使用すると、追加のコンテナーを挿入したり、Operator が生成したコンテナーを変更したりできます。これを使用して、認証プロキシーを ThanosRulerPod に追加したり、Operator が生成したコンテナーの動作を変更したりできます。ここで説明するコンテナーは、同じ名前を共有し、戦略的マージパッチを介して変更が行われる場合、Operator が生成したコンテナーを変更します。現在のコンテナー名は、thanos-rulerconfig-reloader です。コンテナーのオーバーライドは、メンテナーがサポートする範囲外であり、そうすることで、この動作が予告なしにいつでも中断する可能性があることを認めます。

containers[]

object

Pod 内で実行する単一のアプリケーションコンテナー。

enforcedNamespaceLabel

string

EnforcedNamespaceLabel は、ユーザーが作成した各アラートおよびメトリクスに元の namespace ラベルを追加します。ラベル値は常に、作成されるオブジェクトの namespace になります。

evaluationInterval

string

連続する評価の間隔。

excludedFromEnforcement

array

元の namespace ラベルの適用から除外される PrometheusRule オブジェクトへの参照のリスト。enforcedNamespaceLabel が true に設定されている場合にのみ適用されます。

excludedFromEnforcement[]

object

ObjectReference は、PodMonitor、ServiceMonitor、Probe、または PrometheusRule オブジェクトを参照します。

externalPrefix

string

Thanos Ruler インスタンスの外部 URL はで利用できます。これは、正しい URL を生成するために必要です。これは、Thanos Ruler が DNS 名のルートから提供されない場合に必要です。

grpcServerTlsConfig

object

GRPCServerTLSConfig は、Thanos Querier が記録されたルールデータを読み取る gRPC サーバーを設定します。注: 現在、CAFile、CertFile、および KeyFile フィールドのみがサポートされています。'--grpc-server-tls-*'CLI 引数にマップします。

hostAliases

array

Pod の hostAliases 設定

hostAliases[]

object

HostAlias は、Pod の hosts ファイルのエントリーとして挿入される IP とホスト名の間のマッピングを保持します。

image

string

Thanos コンテナーイメージの URL。

imagePullSecrets

array

レジストリーから thanos イメージをプルするために使用する、同じ namespace 内のシークレットへの参照のオプションのリストについては、http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod を参照してください。

imagePullSecrets[]

object

LocalObjectReference には、同じ namespace 内で参照オブジェクトを見つけるのに十分な情報が含まれます。

initContainers

array

InitContainers を使用すると、Pod 定義に initContainers を追加できます。これらは、たとえば、外部ソースから ThanosRuler 設定に注入するためのシークレットをフェッチするために使用できます。initContainer の実行中にエラーが発生すると、Pod が再起動します。詳細: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ initContainers を secret フェッチ以外の用途に使用することは、メンテナーがサポートする範囲から完全に外れており、そうすることによって、この動作が予告なしにいつでも壊れる可能性があることに同意したことになります。

initContainers[]

object

Pod 内で実行する単一のアプリケーションコンテナー。

labels

object (string)

ラベルは、ThanosRuler への外部ラベルペアを設定します。デフォルトのレプリカラベル thanos_ruler_replica は、常に Pod の名前の値を持つラベルとして追加され、アラートで削除されます。

listenLocal

boolean

ListenLocal は、Thanos ルーラーがループバックでリッスンするようにし、Pod IP に対してバインドしないようにします。

logFormat

string

設定する ThanosRuler のログ形式。

logLevel

string

設定する ThanosRuler のログレベル。

minReadySeconds

integer

新しく作成された Pod が使用可能であると見なされるために、コンテナーがクラッシュすることなく準備ができる最小秒数。デフォルトは 0 です (Pod は準備ができ次第利用可能と見なされます) これはアルファフィールドであり、StatefulSetMinReadySeconds 機能ゲートを有効にする必要があります。

nodeSelector

object (string)

Pod がスケジュールされているノードを定義します。

objectStorageConfig

object

ObjectStorageConfig は、Thanos でオブジェクトストレージを設定します。ObjectStorageConfigFile の代替であり、優先度が低くなります。

objectStorageConfigFile

string

ObjectStorageConfigFile は、オブジェクトストレージ設定ファイルのパスを指定します。ObjectStorageConfig と一緒に使用すると、ObjectStorageConfigFile が優先されます。

paused

boolean

ThanosRuler のデプロイメントが一時停止されると、基になるオブジェクトに対して削除以外のアクションは実行されません。

podMetadata

object

PodMetadata にはラベルが含まれており、アノテーションは thanos ルーラー Pod に伝達されます。

portName

string

Pod および管理サービスに使用されるポート名。これはデフォルトで Web になります

priorityClassName

string

Pod に割り当てられた優先度クラス

prometheusRulesExcludedFromEnforce

array

PrometheusRulesExcludedFromEnforce - namespace ラベルの追加の適用から除外される Prometheus ルールのリスト。enforcedNamespaceLabel が true に設定されている場合にのみ機能します。各ペアに対して、ruleNamespace と ruleName の両方が設定されていることを確認してください。非推奨: 代わりに、excludedFromEnforcement を使用します。

prometheusRulesExcludedFromEnforce[]

object

PrometheusRuleExcludeConfig を使用すると、ユーザーは、アラートとメトリックの namespace ラベルを適用するときに、除外された PrometheusRule 名とその namespace を無視するように設定できます。

queryConfig

object

thanos クエリーインスタンスに接続するための設定を定義します。これが定義されている場合、QueryEndpoints フィールドは無視されます。query.config CLI 引数にマップします。thanosv0.11.0 以降でのみ使用できます。

queryEndpoints

array (string)

QueryEndpoints は、メトリックのクエリー元となる Thanos クエリーアエンドポイントを定義します。thanos ルーラーの --query フラグにマップします。

replicas

integer

デプロイする thanos ルーラーインスタンスの数。

resources

object

リソースは、単一 Pod のリソース要件を定義します。指定しない場合、リクエスト/制限は設定されません

retention

string

期間 ThanosRuler はのデータを保持するものとします。デフォルトは '24h' で、正規表現 [0-9]+(ms|s|m|h|d|w|y) (ミリ秒、秒、分、時間、日、週、年) と一致する必要があります。

routePrefix

string

ルート接頭辞 ThanosRuler は、の HTTP ハンドラーを登録します。これにより、thanos UI をサブパスで提供できます。

ruleNamespaceSelector

object

Rules 検出用に選択される namespace。指定しない場合、ThanosRuler オブジェクトと同じ namespace のみが使用されます。

ruleSelector

object

アラートと記録のためにマウントする PrometheusRules を選択するためのラベルセレクター。

securityContext

object

SecurityContext は、Pod レベルのセキュリティー属性と一般的なコンテナー設定を保持します。これはデフォルトでデフォルトの PodSecurityContext になります。

serviceAccountName

string

ServiceAccountName は、Thanos Ruler Pod の実行に使用する ServiceAccount の名前です。

storage

object

ストレージの使用方法を指定するストレージ仕様。

tolerations

array

指定されている場合、Pod の許容範囲。

tolerations[]

object

この toleration が割り当てられる Pod は、マッチング Operator <operator> を使用してトリプル <key,value,effect> と一致する taint を許容します。

topologySpreadConstraints

array

指定した場合、Pod のトポロジー拡散制約。

topologySpreadConstraints[]

object

TopologySpreadConstraint は、指定されたトポロジー間で一致する Pod を拡散する方法を指定します。

tracingConfig

object

TracingConfig は、Thanos でトレースを設定します。これは実験的な機能であり、今後のリリースで重大な変更が加えられる可能性があります。

tracingConfigFile

string

TracingConfig は、トレース設定ファイルのパスを指定します。TracingConfig と一緒に使用すると、TracingConfigFile が優先されます。

volumes

array

ボリュームを使用すると、出力の StatefulSet 定義に追加のボリュームを設定できます。指定されたボリュームは、StorageSpec オブジェクトの結果として生成される他のボリュームに追加されます。

volumes[]

object

ボリュームは、Pod 内の任意のコンテナーからアクセスできる Pod 内の名前付きボリュームを表します。

9.1.2. .spec.affinity

説明
指定した場合、Pod のスケジューリング制約。
object
Expand
プロパティー説明

nodeAffinity

object

Pod のノードアフィニティースケジューリングルールを説明します。

podAffinity

object

Pod アフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置します)。

podAntiAffinity

object

Pod の非アフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置しないでください)。

9.1.3. .spec.affinity.nodeAffinity

説明
Pod のノードアフィニティースケジューリングルールを説明します。
object
Expand
プロパティー説明

preferredDuringSchedulingIgnoredDuringExecution

array

スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードが対応する matchExpressions と一致する場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。

preferredDuringSchedulingIgnoredDuringExecution[]

object

空の優先スケジューリング用語は、暗黙の重み 0 を持つすべてのオブジェクトに一致します (つまり、操作なしです)。null の優先スケジューリング用語は、オブジェクトに一致しません (つまり、no-op でもあります)。

requiredDuringSchedulingIgnoredDuringExecution

object

このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (更新など)、システムは最終的に Pod をノードから削除しようとする場合としない場合があります。

9.1.4. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution

説明
スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードが対応する matchExpressions と一致する場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。
array

9.1.5. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

説明
空の優先スケジューリング用語は、暗黙の重み 0 を持つすべてのオブジェクトに一致します (つまり、操作なしです)。null の優先スケジューリング用語は、オブジェクトに一致しません (つまり、no-op でもあります)。
object
必須
  • preference
  • weight
Expand
プロパティー説明

preference

object

対応する重みに関連付けられたノードセレクター用語。

weight

integer

対応する nodeSelectorTerm の一致に関連する重み (1〜100 の範囲)。

9.1.6. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference

説明
対応する重みに関連付けられたノードセレクター用語。
object
Expand
プロパティー説明

matchExpressions

array

ノードのラベルごとのノードセレクター要件のリスト。

matchExpressions[]

object

ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchFields

array

ノードのフィールドごとのノードセレクター要件のリスト。

matchFields[]

object

ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

9.1.7. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions

説明
ノードのラベルごとのノードセレクター要件のリスト。
array

9.1.8. .spec.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 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

9.1.9. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields

説明
ノードのフィールドごとのノードセレクター要件のリスト。
array

9.1.10. .spec.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 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

9.1.11. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

説明
このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (更新など)、システムは最終的に Pod をノードから削除しようとする場合としない場合があります。
object
必須
  • nodeSelectorTerms
Expand
プロパティー説明

nodeSelectorTerms

array

必須。ノードセレクター用語のリスト。用語は OR されています。

nodeSelectorTerms[]

object

null または空のノードセレクター用語はオブジェクトに一致しません。これらの要件は AND で結合されます。TopologySelectorTerm タイプは、NodeSelectorTerm のサブセットを実装します。

9.1.12. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

説明
必須。ノードセレクター用語のリスト。用語は OR されています。
array

9.1.13. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[]

説明
null または空のノードセレクター用語はオブジェクトに一致しません。これらの要件は AND で結合されます。TopologySelectorTerm タイプは、NodeSelectorTerm のサブセットを実装します。
object
Expand
プロパティー説明

matchExpressions

array

ノードのラベルごとのノードセレクター要件のリスト。

matchExpressions[]

object

ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchFields

array

ノードのフィールドごとのノードセレクター要件のリスト。

matchFields[]

object

ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

9.1.14. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions

説明
ノードのラベルごとのノードセレクター要件のリスト。
array

9.1.15. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].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 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

9.1.16. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields

説明
ノードのフィールドごとのノードセレクター要件のリスト。
array

9.1.17. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].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 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

9.1.18. .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 が実行されているノードの値と一致するノードで実行されていることを意味します。

9.1.19. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution

説明
スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードに対応する podAffinityTerm に一致する Pod がある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。
array

9.1.20. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

説明
一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。
object
必須
  • podAffinityTerm
  • weight
Expand
プロパティー説明

podAffinityTerm

object

必須。対応する重みに関連付けられた Pod アフィニティー用語。

weight

integer

対応する podAffinityTerm の一致に関連する重み (1〜100 の範囲)。

9.1.21. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm

説明
必須。対応する重みに関連付けられた Pod アフィニティー用語。
object
必須
  • topologyKey
Expand
プロパティー説明

labelSelector

object

リソースのセット (この場合は Pod) に対するラベルクエリー。

namespaceSelector

object

用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。

namespaces

array (string)

namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび nullnamespaceSelector は、"この Pod の namespace" を意味します

topologyKey

string

この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。

9.1.22. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector

説明
リソースのセット (この場合は 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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

9.1.25. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

9.1.28. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution

説明
このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから削除しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。
array

9.1.29. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[]

説明
この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。
object
必須
  • topologyKey
Expand
プロパティー説明

labelSelector

object

リソースのセット (この場合は Pod) に対するラベルクエリー。

namespaceSelector

object

用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。

namespaces

array (string)

namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび nullnamespaceSelector は、"この Pod の namespace" を意味します

topologyKey

string

この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。

9.1.30. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector

説明
リソースのセット (この場合は 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 で結合されます。

9.1.31. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

9.1.32. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

9.1.33. .spec.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 で結合されます。

9.1.34. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

9.1.35. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

9.1.36. .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 が実行されているノードの値と一致するノードで実行されていることを意味します。

9.1.37. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution

説明
スケジューラーは、このフィールドで指定された非アフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アンチアフィニティー式など) を満たすノードごとに、の要素を反復処理して合計を計算します。このフィールドと、対応する podAffinityTerm に一致する Pod がノードにある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。
array

9.1.38. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

説明
一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。
object
必須
  • podAffinityTerm
  • weight
Expand
プロパティー説明

podAffinityTerm

object

必須。対応する重みに関連付けられた Pod アフィニティー用語。

weight

integer

対応する podAffinityTerm の一致に関連する重み (1〜100 の範囲)。

9.1.39. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm

説明
必須。対応する重みに関連付けられた Pod アフィニティー用語。
object
必須
  • topologyKey
Expand
プロパティー説明

labelSelector

object

リソースのセット (この場合は Pod) に対するラベルクエリー。

namespaceSelector

object

用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。

namespaces

array (string)

namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび nullnamespaceSelector は、"この Pod の namespace" を意味します

topologyKey

string

この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。

9.1.40. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector

説明
リソースのセット (この場合は 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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

9.1.43. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

9.1.46. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution

説明
このフィールドで指定された非アフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定された非アフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから削除しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。
array

9.1.47. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[]

説明
この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。
object
必須
  • topologyKey
Expand
プロパティー説明

labelSelector

object

リソースのセット (この場合は Pod) に対するラベルクエリー。

namespaceSelector

object

用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。

namespaces

array (string)

namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび nullnamespaceSelector は、"この Pod の namespace" を意味します

topologyKey

string

この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。

9.1.48. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector

説明
リソースのセット (この場合は 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 で結合されます。

9.1.49. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

9.1.50. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

9.1.51. .spec.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 で結合されます。

9.1.52. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

9.1.54. .spec.alertRelabelConfigs

説明
AlertRelabelConfigs は、ThanosRuler でのアラートのラベル再設定を設定します。アラートのラベル再設定は、Prometheus 公式ドキュメント (https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs) で指定されている形式を使用する必要があります。これは AlertRelabelConfigFile の代替であり、優先順位は低くなります。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

9.1.55. .spec.alertmanagersConfig

説明
alertmanager に接続するための設定を定義します。thanosv0.10.0 以降でのみ使用できます。alertmanagers.config 引数にマップします。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

9.1.56. .spec.containers

説明
コンテナーを使用すると、追加のコンテナーを挿入したり、Operator が生成したコンテナーを変更したりできます。これを使用して、認証プロキシーを ThanosRulerPod に追加したり、Operator が生成したコンテナーの動作を変更したりできます。ここで説明するコンテナーは、同じ名前を共有し、戦略的マージパッチを介して変更が行われる場合、Operator が生成したコンテナーを変更します。現在のコンテナー名は、thanos-rulerconfig-reloader です。コンテナーのオーバーライドは、メンテナーがサポートする範囲外であり、そうすることで、この動作が予告なしにいつでも中断する可能性があることを認めます。
array

9.1.57. .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 のソースを表します

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

resources

object

このコンテナーに必要なコンピューティングリソース。これは更新できません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

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

コンテナーの作業ディレクトリー。指定しない場合、コンテナーランタイムのデフォルトが使用されます。これは、コンテナーイメージで設定されている可能性があります。これを更新することはできません。

9.1.58. .spec.containers[].env

説明
コンテナーに設定する環境変数のリスト。これは更新できません。
array

9.1.59. .spec.containers[].env[]

説明
EnvVar は、コンテナーに存在する環境変数を表します。
object
必須
  • name
Expand
プロパティー説明

name

string

環境変数の名前。C_IDENTIFIER でなければなりません。

value

string

変数参照 $(VAR_NAME) は、コンテナー内で以前に定義された環境変数と任意のサービス環境変数を使用してデプロイメントされます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。デフォルトは "" です。

valueFrom

object

環境変数の値のソースです。値が空でない場合は使用できません。

9.1.60. .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 でシークレットのキーを選択します

9.1.61. .spec.containers[].env[].valueFrom.configMapKeyRef

説明
ConfigMap のキーを選択します。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

9.1.62. .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 バージョンで選択するフィールドのパス。

9.1.63. .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

必須: 選択するリソース

9.1.64. .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 TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

9.1.65. .spec.containers[].envFrom

説明
コンテナー内の環境変数に入力するソースのリスト。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。これは更新できません。
array

9.1.66. .spec.containers[].envFrom[]

説明
EnvFromSource は、一連の ConfigMap のソースを表します
object
Expand
プロパティー説明

configMapRef

object

選択する ConfigMap

prefix

string

ConfigMap の各キーの前に追加するオプションの識別子。C_IDENTIFIER でなければなりません。

secretRef

object

から選択する秘密

9.1.67. .spec.containers[].envFrom[].configMapRef

説明
選択する ConfigMap
object
Expand
プロパティー説明

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap を定義する必要があるかどうかを指定します

9.1.68. .spec.containers[].envFrom[].secretRef

説明
から選択する秘密
object
Expand
プロパティー説明

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットを定義する必要があるかどうかを指定します

9.1.69. .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

9.1.70. .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 リクエストを指定します。

tcpSocket

object

非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。

9.1.71. .spec.containers[].lifecycle.postStart.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

9.1.72. .spec.containers[].lifecycle.postStart.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

9.1.73. .spec.containers[].lifecycle.postStart.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

9.1.74. .spec.containers[].lifecycle.postStart.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

9.1.75. .spec.containers[].lifecycle.postStart.tcpSocket

説明
非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

9.1.76. .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 リクエストを指定します。

tcpSocket

object

非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。

9.1.77. .spec.containers[].lifecycle.preStop.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

9.1.78. .spec.containers[].lifecycle.preStop.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

9.1.79. .spec.containers[].lifecycle.preStop.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

9.1.80. .spec.containers[].lifecycle.preStop.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

9.1.81. .spec.containers[].lifecycle.preStop.tcpSocket

説明
非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

9.1.82. .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 ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。

httpGet

object

HTTPGet は、実行する http リクエストを指定します。

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

9.1.83. .spec.containers[].livenessProbe.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

9.1.84. .spec.containers[].livenessProbe.grpc

説明
GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
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 によって定義されます。

9.1.85. .spec.containers[].livenessProbe.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

9.1.86. .spec.containers[].livenessProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

9.1.87. .spec.containers[].livenessProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

9.1.88. .spec.containers[].livenessProbe.tcpSocket

説明
TCPSocket は、TCP ポートを含むアクションを指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

9.1.89. .spec.containers[].ports

説明
コンテナーから公開するポートのリスト。ここでポートを指定しなくても、そのポートが公開されるのを防ぐことはできません。コンテナー内のデフォルトの "0.0.0.0" アドレスをリッスンしているポートは、ネットワークからアクセスできます。戦略的マージパッチを使用してこの配列を変更すると、データが破損する可能性があります。詳細は、https://github.com/kubernetes/kubernetes/issues/108255 を参照してください。これは更新できません。
array

9.1.90. .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" です。

9.1.91. .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 ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。

httpGet

object

HTTPGet は、実行する http リクエストを指定します。

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

9.1.92. .spec.containers[].readinessProbe.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

9.1.93. .spec.containers[].readinessProbe.grpc

説明
GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
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 によって定義されます。

9.1.94. .spec.containers[].readinessProbe.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

9.1.95. .spec.containers[].readinessProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

9.1.96. .spec.containers[].readinessProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

9.1.97. .spec.containers[].readinessProbe.tcpSocket

説明
TCPSocket は、TCP ポートを含むアクションを指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

9.1.98. .spec.containers[].resources

説明
このコンテナーに必要なコンピューティングリソース。これは更新できません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。
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/ を参照してください。

9.1.99. .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 の場合は、このフィールドは設定できないことに注意してください。

capabilities

object

コンテナーの実行時に追加/削除する機能。デフォルトは、コンテナーランタイムによって付与されるデフォルトの機能セットです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

privileged

boolean

コンテナーを特権モードで実行します。特権コンテナー内のプロセスは、基本的にホスト上の root と同等です。デフォルトは false です。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

procMount

string

procMount は、コンテナーに使用する proc マウントのタイプを示します。デフォルトは DefaultProcMount で、読み取り専用パスとマスクされたパスにコンテナーランタイムのデフォルトを使用します。これには、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 の場合は、このフィールドを設定できないことに注意してください。

9.1.100. .spec.containers[].securityContext.capabilities

説明
コンテナーの実行時に追加/削除する機能。デフォルトは、コンテナーランタイムによって付与されるデフォルトの機能セットです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
object
Expand
プロパティー説明

add

array (string)

追加された機能

drop

array (string)

削除された機能

9.1.101. .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 ユーザーラベルです。

9.1.102. .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- コンテナーのランタイムデフォルトプロファイルを使用する必要があります。制限なし - プロファイルを適用しないでください。

9.1.103. .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' コンテナーとして実行する必要があるかどうかを決定します。このフィールドはアルファレベルであり、WindowsHostProcessContainers 機能フラグを有効にするコンポーネントによってのみ尊重されます。機能フラグなしでこのフィールドを設定すると、Pod の検証時にエラーが発生します。Pod のすべてのコンテナーは、同じ有効な HostProcess 値を持っている必要があります (HostProcess コンテナーと非 HostProcess コンテナーを混在させることはできません)。さらに、HostProcess が true の場合、HostNetwork も true に設定する必要があります。

runAsUserName

string

コンテナープロセスのエントリーポイントを実行するための Windows の UserName。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。

9.1.104. .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 ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。

httpGet

object

HTTPGet は、実行する http リクエストを指定します。

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

9.1.105. .spec.containers[].startupProbe.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

9.1.106. .spec.containers[].startupProbe.grpc

説明
GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
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 によって定義されます。

9.1.107. .spec.containers[].startupProbe.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

9.1.108. .spec.containers[].startupProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

9.1.109. .spec.containers[].startupProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

9.1.110. .spec.containers[].startupProbe.tcpSocket

説明
TCPSocket は、TCP ポートを含むアクションを指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

9.1.111. .spec.containers[].volumeDevices

説明
volumeDevices は、コンテナーによって使用されるブロックデバイスのリストです。
array

9.1.112. .spec.containers[].volumeDevices[]

説明
volumeDevice は、コンテナー内の raw ブロックデバイスのマッピングを記述します。
object
必須
  • devicePath
  • name
Expand
プロパティー説明

devicePath

string

devicePath は、デバイスがマップされるコンテナー内のパスです。

name

string

name は、Pod 内の persistentVolumeClaim の名前と一致する必要があります

9.1.113. .spec.containers[].volumeMounts

説明
コンテナーのファイルシステムにマウントする Pod ボリューム。これは更新できません。
array

9.1.114. .spec.containers[].volumeMounts[]

説明
VolumeMount は、コンテナー内でのボリュームのマウントを説明します。
object
必須
  • mountPath
  • name
Expand
プロパティー説明

mountPath

string

ボリュームをマウントする必要があるコンテナー内のパス。':' を含めることはできません。

mountPropagation

string

mountPropagation は、マウントがホストからコンテナーに、またはその逆にどのように伝播されるかを決定します。設定されていない場合、MountPropagationNone が使用されます。このフィールドは 1.10 のベータ版です。

name

string

ボリュームの名前に一致する必要があります。

readOnly

boolean

true の場合は読み取り専用、それ以外の場合は読み取り/書き込み (false または指定なし) でマウントされます。デフォルトは false です。

subPath

string

コンテナーのボリュームをマウントする必要があるボリューム内のパス。デフォルトは "" (ボリュームのルート) です。

subPathExpr

string

コンテナーのボリュームをマウントする必要があるボリューム内の拡張パス。SubPath と同様に動作しますが、環境変数参照 $(VAR_NAME) は、コンテナーの環境を使用してデプロイメントされます。デフォルトは "" (ボリュームのルート) です。SubPathExpr と SubPath は相互に排他的です。

9.1.115. .spec.excludedFromEnforcement

説明
元の namespace ラベルの適用から除外される PrometheusRule オブジェクトへの参照のリスト。enforcedNamespaceLabel が true に設定されている場合にのみ適用されます。
array

9.1.116. .spec.excludedFromEnforcement[]

説明
ObjectReference は、PodMonitor、ServiceMonitor、Probe、または PrometheusRule オブジェクトを参照します。
object
必須
  • namespace
  • resource
Expand
プロパティー説明

group

string

参照先のグループ。指定しない場合は、デフォルトで monitoring.coreos.com になります。

name

string

参照先の名前。設定されていない場合、すべてのリソースが一致します。

namespace

string

参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resource

string

参照先のリソース。

9.1.117. .spec.grpcServerTlsConfig

説明
GRPCServerTLSConfig は、Thanos Querier が記録されたルールデータを読み取る gRPC サーバーを設定します。注: 現在、CAFile、CertFile、および KeyFile フィールドのみがサポートされています。'--grpc-server-tls-*'CLI 引数にマップします。
object
Expand
プロパティー説明

ca

object

ターゲットに使用する CA 証明書を含む構造体。

caFile

string

ターゲットに使用する Prometheus コンテナー内の CA 証明書へのパス。

cert

object

ターゲットのクライアント証明書ファイルを含む構造体。

certFile

string

ターゲットの Prometheus コンテナー内のクライアント証明書ファイルへのパス。

insecureSkipVerify

boolean

ターゲット証明書の検証を無効にします。

keyFile

string

ターゲットの Prometheus コンテナー内のクライアントキーファイルへのパス。

keySecret

object

ターゲットのクライアントキーファイルを含むシークレット。

serverName

string

ターゲットのホスト名を確認するために使用されます。

9.1.118. .spec.grpcServerTlsConfig.ca

Description
ターゲットに使用する CA 証明書を含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

9.1.119. .spec.grpcServerTlsConfig.ca.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

9.1.120. .spec.grpcServerTlsConfig.ca.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

9.1.121. .spec.grpcServerTlsConfig.cert

Description
ターゲットのクライアント証明書ファイルを含む構造体。
タイプ
object
Expand
プロパティー説明

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

9.1.122. .spec.grpcServerTlsConfig.cert.configMap

説明
ターゲットに使用するデータを含む ConfigMap。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

9.1.123. .spec.grpcServerTlsConfig.cert.secret

説明
ターゲットに使用するデータを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

9.1.124. .spec.grpcServerTlsConfig.keySecret

説明
ターゲットのクライアントキーファイルを含むシークレット。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

9.1.125. .spec.hostAliases

説明
Pod の hostAliases 設定
array

9.1.126. .spec.hostAliases[]

説明
HostAlias は、Pod の hosts ファイルのエントリーとして挿入される IP とホスト名の間のマッピングを保持します。
object
必須
  • hostnames
  • ip
Expand
プロパティー説明

hostnames

array (string)

上記の IP アドレスのホスト名。

ip

string

ホストファイルエントリーの IP アドレス。

9.1.127. .spec.imagePullSecrets

説明
レジストリーから thanos イメージをプルするために使用する、同じ namespace 内のシークレットへの参照のオプションのリストについては、http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod を参照してください。
array

9.1.128. .spec.imagePullSecrets[]

説明
LocalObjectReference には、同じ namespace 内で参照オブジェクトを見つけるのに十分な情報が含まれます。
object
Expand
プロパティー説明

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

9.1.129. .spec.initContainers

説明
InitContainers を使用すると、Pod 定義に initContainers を追加できます。これらは、たとえば、外部ソースから ThanosRuler 設定に注入するためのシークレットをフェッチするために使用できます。initContainer の実行中にエラーが発生すると、Pod が再起動します。詳細: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ initContainers を secret フェッチ以外の用途に使用することは、メンテナーがサポートする範囲から完全に外れており、そうすることによって、この動作が予告なしにいつでも壊れる可能性があることに同意したことになります。
array

9.1.130. .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 のソースを表します

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

resources

object

このコンテナーに必要なコンピューティングリソース。これは更新できません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

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

コンテナーの作業ディレクトリー。指定しない場合、コンテナーランタイムのデフォルトが使用されます。これは、コンテナーイメージで設定されている可能性があります。これを更新することはできません。

9.1.131. .spec.initContainers[].env

説明
コンテナーに設定する環境変数のリスト。これは更新できません。
array

9.1.132. .spec.initContainers[].env[]

説明
EnvVar は、コンテナーに存在する環境変数を表します。
object
必須
  • name
Expand
プロパティー説明

name

string

環境変数の名前。C_IDENTIFIER でなければなりません。

value

string

変数参照 $(VAR_NAME) は、コンテナー内で以前に定義された環境変数と任意のサービス環境変数を使用してデプロイメントされます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。デフォルトは "" です。

valueFrom

object

環境変数の値のソースです。値が空でない場合は使用できません。

9.1.133. .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 でシークレットのキーを選択します

9.1.134. .spec.initContainers[].env[].valueFrom.configMapKeyRef

説明
ConfigMap のキーを選択します。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

9.1.135. .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 バージョンで選択するフィールドのパス。

9.1.136. .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

必須: 選択するリソース

9.1.137. .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 TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

9.1.138. .spec.initContainers[].envFrom

説明
コンテナー内の環境変数に入力するソースのリスト。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。これは更新できません。
array

9.1.139. .spec.initContainers[].envFrom[]

説明
EnvFromSource は、一連の ConfigMap のソースを表します
object
Expand
プロパティー説明

configMapRef

object

選択する ConfigMap

prefix

string

ConfigMap の各キーの前に追加するオプションの識別子。C_IDENTIFIER でなければなりません。

secretRef

object

から選択する秘密

9.1.140. .spec.initContainers[].envFrom[].configMapRef

説明
選択する ConfigMap
object
Expand
プロパティー説明

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap を定義する必要があるかどうかを指定します

9.1.141. .spec.initContainers[].envFrom[].secretRef

説明
から選択する秘密
object
Expand
プロパティー説明

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットを定義する必要があるかどうかを指定します

9.1.142. .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

9.1.143. .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 リクエストを指定します。

tcpSocket

object

非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。

9.1.144. .spec.initContainers[].lifecycle.postStart.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

9.1.145. .spec.initContainers[].lifecycle.postStart.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

9.1.146. .spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

9.1.147. .spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

9.1.148. .spec.initContainers[].lifecycle.postStart.tcpSocket

説明
非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

9.1.149. .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 リクエストを指定します。

tcpSocket

object

非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。

9.1.150. .spec.initContainers[].lifecycle.preStop.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

9.1.151. .spec.initContainers[].lifecycle.preStop.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

9.1.152. .spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

9.1.153. .spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

9.1.154. .spec.initContainers[].lifecycle.preStop.tcpSocket

説明
非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

9.1.155. .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 ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。

httpGet

object

HTTPGet は、実行する http リクエストを指定します。

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

9.1.156. .spec.initContainers[].livenessProbe.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

9.1.157. .spec.initContainers[].livenessProbe.grpc

説明
GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
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 によって定義されます。

9.1.158. .spec.initContainers[].livenessProbe.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

9.1.159. .spec.initContainers[].livenessProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

9.1.160. .spec.initContainers[].livenessProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

9.1.161. .spec.initContainers[].livenessProbe.tcpSocket

説明
TCPSocket は、TCP ポートを含むアクションを指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

9.1.162. .spec.initContainers[].ports

説明
コンテナーから公開するポートのリスト。ここでポートを指定しなくても、そのポートが公開されるのを防ぐことはできません。コンテナー内のデフォルトの "0.0.0.0" アドレスをリッスンしているポートは、ネットワークからアクセスできます。戦略的マージパッチを使用してこの配列を変更すると、データが破損する可能性があります。詳細は、https://github.com/kubernetes/kubernetes/issues/108255 を参照してください。これは更新できません。
array

9.1.163. .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" です。

9.1.164. .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 ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。

httpGet

object

HTTPGet は、実行する http リクエストを指定します。

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

9.1.165. .spec.initContainers[].readinessProbe.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

9.1.166. .spec.initContainers[].readinessProbe.grpc

説明
GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
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 によって定義されます。

9.1.167. .spec.initContainers[].readinessProbe.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

9.1.168. .spec.initContainers[].readinessProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

9.1.169. .spec.initContainers[].readinessProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

9.1.170. .spec.initContainers[].readinessProbe.tcpSocket

説明
TCPSocket は、TCP ポートを含むアクションを指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

9.1.171. .spec.initContainers[].resources

説明
このコンテナーに必要なコンピューティングリソース。これは更新できません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。
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/ を参照してください。

9.1.172. .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 の場合は、このフィールドは設定できないことに注意してください。

capabilities

object

コンテナーの実行時に追加/削除する機能。デフォルトは、コンテナーランタイムによって付与されるデフォルトの機能セットです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

privileged

boolean

コンテナーを特権モードで実行します。特権コンテナー内のプロセスは、基本的にホスト上の root と同等です。デフォルトは false です。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

procMount

string

procMount は、コンテナーに使用する proc マウントのタイプを示します。デフォルトは DefaultProcMount で、読み取り専用パスとマスクされたパスにコンテナーランタイムのデフォルトを使用します。これには、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 の場合は、このフィールドを設定できないことに注意してください。

9.1.173. .spec.initContainers[].securityContext.capabilities

説明
コンテナーの実行時に追加/削除する機能。デフォルトは、コンテナーランタイムによって付与されるデフォルトの機能セットです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
object
Expand
プロパティー説明

add

array (string)

追加された機能

drop

array (string)

削除された機能

9.1.174. .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 ユーザーラベルです。

9.1.175. .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- コンテナーのランタイムデフォルトプロファイルを使用する必要があります。制限なし - プロファイルを適用しないでください。

9.1.176. .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' コンテナーとして実行する必要があるかどうかを決定します。このフィールドはアルファレベルであり、WindowsHostProcessContainers 機能フラグを有効にするコンポーネントによってのみ尊重されます。機能フラグなしでこのフィールドを設定すると、Pod の検証時にエラーが発生します。Pod のすべてのコンテナーは、同じ有効な HostProcess 値を持っている必要があります (HostProcess コンテナーと非 HostProcess コンテナーを混在させることはできません)。さらに、HostProcess が true の場合、HostNetwork も true に設定する必要があります。

runAsUserName

string

コンテナープロセスのエントリーポイントを実行するための Windows の UserName。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。

9.1.177. .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 ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。

httpGet

object

HTTPGet は、実行する http リクエストを指定します。

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

9.1.178. .spec.initContainers[].startupProbe.exec

説明
Exec は実行するアクションを指定します。
object
Expand
プロパティー説明

command

array (string)

コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。

9.1.179. .spec.initContainers[].startupProbe.grpc

説明
GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
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 によって定義されます。

9.1.180. .spec.initContainers[].startupProbe.httpGet

説明
HTTPGet は、実行する http リクエストを指定します。
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 です。

9.1.181. .spec.initContainers[].startupProbe.httpGet.httpHeaders

説明
リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
array

9.1.182. .spec.initContainers[].startupProbe.httpGet.httpHeaders[]

説明
HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

ヘッダーフィールド名

value

string

ヘッダーフィールド値

9.1.183. .spec.initContainers[].startupProbe.tcpSocket

説明
TCPSocket は、TCP ポートを含むアクションを指定します。
object
必須
  • port
Expand
プロパティー説明

host

string

オプション: 接続するホスト名。デフォルトは Pod IP です。

port

integer-or-string

コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。

9.1.184. .spec.initContainers[].volumeDevices

説明
volumeDevices は、コンテナーによって使用されるブロックデバイスのリストです。
array

9.1.185. .spec.initContainers[].volumeDevices[]

説明
volumeDevice は、コンテナー内の raw ブロックデバイスのマッピングを記述します。
object
必須
  • devicePath
  • name
Expand
プロパティー説明

devicePath

string

devicePath は、デバイスがマップされるコンテナー内のパスです。

name

string

name は、Pod 内の persistentVolumeClaim の名前と一致する必要があります

9.1.186. .spec.initContainers[].volumeMounts

説明
コンテナーのファイルシステムにマウントする Pod ボリューム。これは更新できません。
array

9.1.187. .spec.initContainers[].volumeMounts[]

説明
VolumeMount は、コンテナー内でのボリュームのマウントを説明します。
object
必須
  • mountPath
  • name
Expand
プロパティー説明

mountPath

string

ボリュームをマウントする必要があるコンテナー内のパス。':' を含めることはできません。

mountPropagation

string

mountPropagation は、マウントがホストからコンテナーに、またはその逆にどのように伝播されるかを決定します。設定されていない場合、MountPropagationNone が使用されます。このフィールドは 1.10 のベータ版です。

name

string

ボリュームの名前に一致する必要があります。

readOnly

boolean

true の場合は読み取り専用、それ以外の場合は読み取り/書き込み (false または指定なし) でマウントされます。デフォルトは false です。

subPath

string

コンテナーのボリュームをマウントする必要があるボリューム内のパス。デフォルトは "" (ボリュームのルート) です。

subPathExpr

string

コンテナーのボリュームをマウントする必要があるボリューム内の拡張パス。SubPath と同様に動作しますが、環境変数参照 $(VAR_NAME) は、コンテナーの環境を使用してデプロイメントされます。デフォルトは "" (ボリュームのルート) です。SubPathExpr と SubPath は相互に排他的です。

9.1.188. .spec.objectStorageConfig

説明
ObjectStorageConfig は、Thanos でオブジェクトストレージを設定します。ObjectStorageConfigFile の代替であり、優先度が低くなります。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

9.1.189. .spec.podMetadata

Description
PodMetadata にはラベルが含まれており、アノテーションは thanos ルーラー Pod に伝達されます。
タイプ
object
Expand
プロパティー説明

annotations

object (string)

アノテーションは、任意のメタデータを保存し、取得するために外部ツールで設定できる、リソースとともに保存される構造化されていないキー値のマップです。これらはクエリーできないため、オブジェクトを変更する場合に維持する必要があります。詳細: http://kubernetes.io/docs/user-guide/annotations

labels

object (string)

オブジェクトの整理と分類 (スコープと選択) に使用できる文字列キーと値のマップ。レプリケーションコントローラーおよびサービスのセレクターと一致する場合があります。詳細: http://kubernetes.io/docs/user-guide/labels

name

string

name は namespace 内で一意である必要があります。リソースの作成時に必要ですが、リソースによっては、クライアントが適切な名前の生成を自動的に要求することを許可する場合があります。name は、主にべき等性と設定定義の作成を目的としています。これを更新することはできません。詳細: http://kubernetes.io/docs/user-guide/identifiers#names

9.1.190. .spec.prometheusRulesExcludedFromEnforce

説明
PrometheusRulesExcludedFromEnforce - namespace ラベルの追加の適用から除外される Prometheus ルールのリスト。enforcedNamespaceLabel が true に設定されている場合にのみ機能します。各ペアに対して、ruleNamespace と ruleName の両方が設定されていることを確認してください。非推奨: 代わりに、excludedFromEnforcement を使用します。
array

9.1.191. .spec.prometheusRulesExcludedFromEnforce[]

説明
PrometheusRuleExcludeConfig を使用すると、ユーザーは、アラートとメトリックの namespace ラベルを適用するときに、除外された PrometheusRule 名とその namespace を無視するように設定できます。
object
必須
  • ruleName
  • ruleNamespace
Expand
プロパティー説明

ruleName

string

RuleNamespace- 除外されたルールの名前

ruleNamespace

string

RuleNamespace- 除外されたルールの名前空間

9.1.192. .spec.queryConfig

説明
thanos クエリーインスタンスに接続するための設定を定義します。これが定義されている場合、QueryEndpoints フィールドは無視されます。query.config CLI 引数にマップします。thanosv0.11.0 以降でのみ使用できます。
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

9.1.193. .spec.resources

説明
リソースは、単一 Pod のリソース要件を定義します。指定しない場合、リクエスト/制限は設定されません
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/ を参照してください。

9.1.194. .spec.ruleNamespaceSelector

説明
Rules 検出用に選択される namespace。指定しない場合、ThanosRuler オブジェクトと同じ 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 で結合されます。

9.1.195. .spec.ruleNamespaceSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

9.1.196. .spec.ruleNamespaceSelector.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

9.1.197. .spec.ruleSelector

説明
アラートと記録のためにマウントする PrometheusRules を選択するためのラベルセレクター。
object
Expand
プロパティー説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

9.1.198. .spec.ruleSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

9.1.199. .spec.ruleSelector.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

9.1.200. .spec.securityContext

説明
SecurityContext は、Pod レベルのセキュリティー属性と一般的なコンテナー設定を保持します。これはデフォルトでデフォルトの PodSecurityContext になります。
object
Expand
プロパティー説明

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 の場合、このフィールドは設定できないことに注意してください。

seLinuxOptions

object

すべてのコンテナーに適用される SELinux コンテキスト。指定しない場合、コンテナーランタイムはコンテナーごとにランダムな SELinux コンテキストを割り当てます。SecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値がそのコンテナーに優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

seccompProfile

object

この Pod のコンテナーで使用する seccomp オプション。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。

supplementalGroups

配列 (整数)

コンテナーのプライマリー GID に加えて、各コンテナーで実行される最初のプロセスに適用されるグループのリスト。指定しない場合、グループはどのコンテナーにも追加されません。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 の場合は、このフィールドを設定できないことに注意してください。

9.1.201. .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 ユーザーラベルです。

9.1.202. .spec.securityContext.seccompProfile

説明
この Pod のコンテナーで使用する seccomp オプション。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
object
必須
  • type
Expand
プロパティー説明

localhostProfile

string

localhostProfile は、ノード上のファイルで定義されたプロファイルを使用する必要があることを示します。プロファイルが機能するには、ノードで事前に設定されている必要があります。kubelet の設定済みの seccomp プロファイルの場所を基準にして、降順のパスである必要があります。タイプが "Localhost" の場合にのみ設定する必要があります。

type

string

type は、適用される seccomp プロファイルの種類を示します。有効なオプションは次のとおりです。Localhost- ノード上のファイルで定義されたプロファイルを使用する必要があります。RuntimeDefault- コンテナーのランタイムデフォルトプロファイルを使用する必要があります。制限なし - プロファイルを適用しないでください。

9.1.203. .spec.securityContext.sysctls

説明
Sysctl は、Pod に使用される namespace 付き sysctl のリストを保持します。(コンテナーランタイムによる) サポートされていない sysctl を持つ Pod は起動に失敗する可能性があります。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
array

9.1.204. .spec.securityContext.sysctls[]

説明
Sysctl は、設定するカーネルパラメーターを定義します
object
必須
  • name
  • value
Expand
プロパティー説明

name

string

設定するプロパティーの名前

value

string

設定するプロパティーの値

9.1.205. .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' コンテナーとして実行する必要があるかどうかを決定します。このフィールドはアルファレベルであり、WindowsHostProcessContainers 機能フラグを有効にするコンポーネントによってのみ尊重されます。機能フラグなしでこのフィールドを設定すると、Pod の検証時にエラーが発生します。Pod のすべてのコンテナーは、同じ有効な HostProcess 値を持っている必要があります (HostProcess コンテナーと非 HostProcess コンテナーを混在させることはできません)。さらに、HostProcess が true の場合、HostNetwork も true に設定する必要があります。

runAsUserName

string

コンテナープロセスのエントリーポイントを実行するための Windows の UserName。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。

9.1.206. .spec.storage

説明
ストレージの使用方法を指定するストレージ仕様。
object
Expand
プロパティー説明

disableMountSubPath

ブール値

非推奨:subPath の使用は、将来のリリースでデフォルトで無効になります。このオプションは不要になります。DisableMountSubPath を使用すると、ボリュームマウントでの subPath の使用を削除できます。

emptyDir

object

PrometheusStatefulSets によって使用される EmptyDirVolumeSource。指定した場合、volumeClaimTemplate の代わりに使用されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir

ephemeral

object

Prometheus StatefulSets によって使用される EphemeralVolumeSource。これは、k8s 1.21 のベータフィールドであり、k8s 1.19 以降、k8s 1.19 以降では、GenericEphemeralVolume フィーチャーゲートを有効にする必要があります。詳細: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes

volumeClaimTemplate

object

PrometheusStatefulSets で使用される PVC 仕様。

9.1.207. .spec.storage.emptyDir

Description
PrometheusStatefulSets によって使用される EmptyDirVolumeSource。指定した場合、volumeClaimTemplate の代わりに使用されます。詳細: 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 です。これは、制限が未定義であることを意味します。詳細: http://kubernetes.io/docs/user-guide/volumes#emptydir

9.1.208. .spec.storage.ephemeral

説明
Prometheus StatefulSets によって使用される EphemeralVolumeSource。これは、k8s 1.21 のベータフィールドであり、k8s 1.19 以降、k8s 1.19 以降では、GenericEphemeralVolume フィーチャーゲートを有効にする必要があります。詳細: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes
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 であってはなりません。

9.1.209. .spec.storage.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 と同じフィールドがここでも有効です。

9.1.210. .spec.storage.ephemeral.volumeClaimTemplate.metadata

説明
PVC の作成時に PVC にコピーされるラベルとアノテーションが含まれる場合があります。他のフィールドは許可されておらず、検証中に拒否されます。
object

9.1.211. .spec.storage.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 機能ゲートが有効になっている場合、このフィールドは常に DataSourceRef フィールドと同じ内容になります。

dataSourceRef

object

dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これは、空でない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のローカルオブジェクトである可能性があります。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、DataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性のために、両方のフィールド (DataSource と DataSourceRef) は、一方が空でもう一方が空でない場合、自動的に同じ値に設定されます。DataSource と DataSourceRef には 2 つの重要な違いがあります。*DataSource は 2 つの特定のタイプのオブジェクトのみを許可しますが、DataSourceRef は非コアオブジェクトと PersistentVolumeClaim オブジェクトを許可します。* DataSource は許可されていない値を無視 (ドロップ) しますが、DataSourceRef はすべての値を保持し、許可されていない値が指定されている場合はエラーを生成します。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。

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

volumeMode

string

volumeMode は、要求に必要なボリュームのタイプを定義します。Filesystem の値は、要求仕様に含まれていない場合に暗示されます。

volumeName

string

volumeName は、この要求をサポートする PersistentVolume へのバインディング参照です。

9.1.212. .spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource

説明
dataSource フィールドは、次のいずれかを指定するために使用できます。*既存の VolumeSnapshot オブジェクト (snapshot.storage.k8s.io/VolumeSnapshot)*既存の PVC(PersistentVolumeClaim) プロビジョナーまたは外部コントローラーが指定されたデータソースをサポートできる場合、指定されたデータソースのコンテンツに基づく新しいボリューム。AnyVolumeDataSource 機能ゲートが有効になっている場合、このフィールドは常に DataSourceRef フィールドと同じ内容になります。
タイプ
object
必須
  • kind
  • name
Expand
プロパティー説明

apiGroup

string

APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。

kind

string

kind は参照されているリソースのタイプです。

name

string

name は、参照されているリソースの名前です。

9.1.213. .spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef

説明
dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これは、空でない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のローカルオブジェクトである可能性があります。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、DataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性のために、両方のフィールド (DataSource と DataSourceRef) は、一方が空でもう一方が空でない場合、自動的に同じ値に設定されます。DataSource と DataSourceRef には 2 つの重要な違いがあります。*DataSource は 2 つの特定のタイプのオブジェクトのみを許可しますが、DataSourceRef は非コアオブジェクトと PersistentVolumeClaim オブジェクトを許可します。* DataSource は許可されていない値を無視 (ドロップ) しますが、DataSourceRef はすべての値を保持し、許可されていない値が指定されている場合はエラーを生成します。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。
object
必須
  • kind
  • name
Expand
プロパティー説明

apiGroup

string

APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。

kind

string

kind は参照されているリソースのタイプです。

name

string

name は、参照されているリソースの名前です。

9.1.214. .spec.storage.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/ を参照してください。

9.1.215. .spec.storage.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 で結合されます。

9.1.216. .spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

9.1.217. .spec.storage.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

9.1.218. .spec.storage.volumeClaimTemplate

Description
PrometheusStatefulSets で使用される PVC 仕様。
タイプ
object
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

object

EmbeddedMetadata には、EmbeddedResource に関連するメタデータが含まれています。

spec

object

仕様は、Pod 作成者によって要求されたボリュームの望ましい特性を定義します。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

status

object

ステータスは、永続的なボリュームクレームの現在の情報/ステータスを表します。read-only詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

9.1.219. .spec.storage.volumeClaimTemplate.metadata

説明
EmbeddedMetadata には、EmbeddedResource に関連するメタデータが含まれています。
object
Expand
プロパティー説明

annotations

object (string)

アノテーションは、任意のメタデータを保存し、取得するために外部ツールで設定できる、リソースとともに保存される構造化されていないキー値のマップです。これらはクエリーできないため、オブジェクトを変更する場合に維持する必要があります。詳細: http://kubernetes.io/docs/user-guide/annotations

labels

object (string)

オブジェクトの整理と分類 (スコープと選択) に使用できる文字列キーと値のマップ。レプリケーションコントローラーおよびサービスのセレクターと一致する場合があります。詳細: http://kubernetes.io/docs/user-guide/labels

name

string

name は namespace 内で一意である必要があります。リソースの作成時に必要ですが、リソースによっては、クライアントが適切な名前の生成を自動的に要求することを許可する場合があります。name は、主にべき等性と設定定義の作成を目的としています。これを更新することはできません。詳細: http://kubernetes.io/docs/user-guide/identifiers#names

9.1.220. .spec.storage.volumeClaimTemplate.spec

Description
仕様は、Pod 作成者によって要求されたボリュームの望ましい特性を定義します。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
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 機能ゲートが有効になっている場合、このフィールドは常に DataSourceRef フィールドと同じ内容になります。

dataSourceRef

object

dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これは、空でない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のローカルオブジェクトである可能性があります。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、DataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性のために、両方のフィールド (DataSource と DataSourceRef) は、一方が空でもう一方が空でない場合、自動的に同じ値に設定されます。DataSource と DataSourceRef には 2 つの重要な違いがあります。*DataSource は 2 つの特定のタイプのオブジェクトのみを許可しますが、DataSourceRef は非コアオブジェクトと PersistentVolumeClaim オブジェクトを許可します。* DataSource は許可されていない値を無視 (ドロップ) しますが、DataSourceRef はすべての値を保持し、許可されていない値が指定されている場合はエラーを生成します。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。

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

volumeMode

string

volumeMode は、要求に必要なボリュームのタイプを定義します。Filesystem の値は、要求仕様に含まれていない場合に暗示されます。

volumeName

string

volumeName は、この要求をサポートする PersistentVolume へのバインディング参照です。

9.1.221. .spec.storage.volumeClaimTemplate.spec.dataSource

説明
dataSource フィールドは、次のいずれかを指定するために使用できます。*既存の VolumeSnapshot オブジェクト (snapshot.storage.k8s.io/VolumeSnapshot)*既存の PVC(PersistentVolumeClaim) プロビジョナーまたは外部コントローラーが指定されたデータソースをサポートできる場合、指定されたデータソースのコンテンツに基づく新しいボリューム。AnyVolumeDataSource 機能ゲートが有効になっている場合、このフィールドは常に DataSourceRef フィールドと同じ内容になります。
タイプ
object
必須
  • kind
  • name
Expand
プロパティー説明

apiGroup

string

APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。

kind

string

kind は参照されているリソースのタイプです。

name

string

name は、参照されているリソースの名前です。

9.1.222. .spec.storage.volumeClaimTemplate.spec.dataSourceRef

説明
dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これは、空でない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のローカルオブジェクトである可能性があります。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、DataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性のために、両方のフィールド (DataSource と DataSourceRef) は、一方が空でもう一方が空でない場合、自動的に同じ値に設定されます。DataSource と DataSourceRef には 2 つの重要な違いがあります。*DataSource は 2 つの特定のタイプのオブジェクトのみを許可しますが、DataSourceRef は非コアオブジェクトと PersistentVolumeClaim オブジェクトを許可します。* DataSource は許可されていない値を無視 (ドロップ) しますが、DataSourceRef はすべての値を保持し、許可されていない値が指定されている場合はエラーを生成します。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。
object
必須
  • kind
  • name
Expand
プロパティー説明

apiGroup

string

APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。

kind

string

kind は参照されているリソースのタイプです。

name

string

name は、参照されているリソースの名前です。

9.1.223. .spec.storage.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/ を参照してください。

9.1.224. .spec.storage.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 で結合されます。

9.1.225. .spec.storage.volumeClaimTemplate.spec.selector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

9.1.226. .spec.storage.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

9.1.227. .spec.storage.volumeClaimTemplate.status

Description
ステータスは、永続的なボリュームクレームの現在の情報/ステータスを表します。read-only詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
object
Expand
プロパティー説明

accessModes

array (string)

accessModes には、PVC をサポートするボリュームが実際に持つアクセスモードが含まれます。詳細は、https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 を参照してください。

allocatedResources

integer-or-string

allocatedResources は、AllocatedResources 内のストレージリソースで、PVC に割り当てられた容量を追跡します。ボリューム拡張操作が要求された場合、実際の容量よりも大きくなる場合があります。ストレージクォータには、allocatedResources と PVC.spec.resources を比較して大きい方の値が使用されます。allocatedResources が設定されていない場合、PVC.spec.resources のみがクォータの計算に使用されます。ボリューム拡張容量要求が下げられ、進行中の拡張操作がなく、実際のボリューム容量が要求された容量以下である場合にのみ、allocatedResources が引き下げられます。これはアルファフィールドであるため、RecoverVolumeExpansionFailure 機能を有効にする必要があります。

capacity

integer-or-string

capacity は、基礎となるボリュームの実際のリソースを表します。

conditions

array

conditions は永続ボリューム要求の現在の条件です。基礎となる永続ボリュームのサイズを変更すると、Condition は 'ResizeStarted' に設定されます。

conditions[]

object

PersistentVolumeClaimCondition コンテーションで pvc の状態についての詳細

phase

string

phase は PersistentVolumeClaim の現在のフェーズを表します。

resizeStatus

string

resizeStatus は、サイズ変更操作のステータスを格納します。ResizeStatus はデフォルトでは設定されませんが、拡張が完了すると、サイズ変更コントローラーまたは kubelet によって、resizeStatus が空の文字列に設定されます。これはアルファフィールドであるため、RecoverVolumeExpansionFailure 機能を有効にする必要があります。

9.1.228. .spec.storage.volumeClaimTemplate.status.conditions

説明
conditions は永続ボリューム要求の現在の条件です。基礎となる永続ボリュームのサイズを変更すると、Condition は 'ResizeStarted' に設定されます。
array

9.1.229. .spec.storage.volumeClaimTemplate.status.conditions[]

Description
PersistentVolumeClaimCondition コンテーションで pvc の状態についての詳細
タイプ
object
必須
  • status
  • type
Expand
プロパティー説明

lastProbeTime

string

lastProbeTime は、条件を調査した時間です。

lastTransitionTime

string

lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。

message

string

message は、最後の遷移に関する詳細を示し、人間が判読できるメッセージです。

reason

string

一意であり、これは、条件の最後の遷移理由を示す、マシンが理解できる短い文字列である必要があります。"ResizeStarted" と報告された場合は、基礎となる永続ボリュームのサイズが変更されていることを意味します。

status

string

 

type

string

PersistentVolumeClaimConditionType は、PersistentVolumeClaimCondition.Type の有効な値です。

9.1.230. .spec.tolerations

説明
指定されている場合、Pod の許容範囲。
array

9.1.231. .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 の場合、値は空である必要があります。それ以外の場合は、通常の文字列のみになります。

9.1.232. .spec.topologySpreadConstraints

説明
指定した場合、Pod のトポロジー拡散制約。
array

9.1.233. .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 のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。null または空のリストは、labelSelector とのみ一致することを意味します。

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 に違反するためです。これはベータフィールドであり、MinDomainsInPodTopologySpread フィーチャーゲートを有効にする必要があります (デフォルトで有効)。

nodeAffinityPolicy

string

nodeAffinityPolicy は、Pod トポロジーの分散スキューを計算するときに Pod の nodeAffinity/nodeSelector をどのように扱うかを示します。オプションは - Honor: nodeAffinity/nodeSelector に一致するノードのみが計算に含まれます。- Ignore: nodeAffinity/nodeSelector は無視されます。すべてのノードが計算に含まれます。この値が nil の場合、この動作は Honor ポリシーと同じです。これは、NodeInclusionPolicyInPodTopologySpread 機能フラグによって有効にされるアルファレベルの機能です。

nodeTaintsPolicy

string

NodeTaintsPolicy は、Pod トポロジースプレッドスキューを計算するときにノードのテイントを処理する方法を示します。オプション: - Honor: テイントのないノードと、受信 Pod が許容範囲でテイントがあるノードが含まれます。- Ignore: ノードのテイントは無視されます。すべてのノードが含まれます。この値が nil の場合、この動作は Ignore ポリシーと同じです。これは、NodeInclusionPolicyInPodTopologySpread 機能フラグによって有効にされるアルファレベルの機能です。

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) になります。つまり、クラスターは依然として不均衡である可能性がありますが、スケジューラーによってクラスターが さらに 不均衡になることはありません。必須フィールドです。

9.1.234. .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 で結合されます。

9.1.235. .spec.topologySpreadConstraints[].labelSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

9.1.236. .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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

9.1.237. .spec.tracingConfig

説明
TracingConfig は、Thanos でトレースを設定します。これは実験的な機能であり、今後のリリースで重大な変更が加えられる可能性があります。
タイプ
object
必須
  • key
Expand
プロパティー説明

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

9.1.238. .spec.volumes

説明
ボリュームを使用すると、出力の StatefulSet 定義に追加のボリュームを設定できます。指定されたボリュームは、StorageSpec オブジェクトの結果として生成される他のボリュームに追加されます。
array

9.1.239. .spec.volumes[]

説明
ボリュームは、Pod 内の任意のコンテナーからアクセスできる Pod 内の名前付きボリュームを表します。
object
必須
  • name
Expand
プロパティー説明

awsElasticBlockStore

object

awsElasticBlockStore は、kubelet のホストマシンに割り当てられ、Pod に公開される AWS Disk リソースを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

azureDisk

object

azureDisk は、ホスト上の Azure Data Disk マウントを表し、Pod へのバインドマウントを表します。

azureFile

object

azureFile は、ホスト上の Azure File Service マウントを表し、マウントを Pod にバインドします。

cephfs

object

cephFS は、Pod の有効期間を共有するホストでの Ceph FS マウントを表します。

cinder

object

Cinder は、kubelets ホストマシンに接続およびマウントされた Cinder ボリュームを表します。詳細: 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 ベースのプラグインを使用してプロビジョニング/接続される汎用ボリュームリソースを表します。

flocker

object

flocker は、kubelet のホストマシンに接続されている Flocker ボリュームを表します。これは、実行中の Flocker 制御サービスによって異なります

gcePersistentDisk

object

gcePersistentDisk は、kubelet のホストマシンに接続されてから Pod に公開される GCE ディスクリソースを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

gitRepo

object

gitRepo は、特定のリビジョンの git リポジトリーを表します。非推奨:GitRepo は非推奨です。git レポジトリを使用してコンテナーをプロビジョニングするには、Git を使用してレポジトリのクローンを作成する InitContainer に EmptyDir をマウントしてから、Pod のコンテナーに EmptyDir をマウントします。

glusterfs

object

glusterfs は、Pod の存続期間を共有するホスト上の Glusterfs マウントを表します。詳細: https://examples.k8s.io/volumes/glusterfs/README.md

hostPath

object

hostPath は、コンテナーに直接公開されているホストマシン上の既存のファイルまたはディレクトリーを表します。これは通常、ホストマシンの表示を許可されているシステムエージェントまたはその他の特権的なものに使用されます。ほとんどのコンテナーはこれを必要としません。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) ホストディレクトリーのマウントを使用できる人、およびホストディレクトリーを読み取り/書き込みでマウントできる人/できない人を制限する必要があります。

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 永続ディスクを表します。

portworxVolume

object

portworxVolume は、kubelet ホストマシンに接続およびマウントされた portworx ボリュームを表します。

projected

object

オールインワンリソースシークレット、configmaps、および Downward API のアイテム

quobyte

object

quobyte は、Pod の有効期限を共有するホストでの Quobyte マウントを表します

rbd

object

rbd は、Pod の有効期間を共有するホストの Rados ブロックデバイスマウントを表します。詳細: https://examples.k8s.io/volumes/rbd/README.md

scaleIO

object

scaleIO は、Kubernetes ノードに接続およびマウントされた ScaleIO 永続ボリュームを表します。

secret

object

secret は、このボリュームに入力する必要がある Secret を表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#secret

storageos

object

storageOS は、Kubernetes ノードに接続およびマウントされた StorageOS ボリュームを表します。

vsphereVolume

object

vsphereVolume は、kubelet ホストマシンに接続およびマウントされた vSphere ボリュームを表します。

9.1.240. .spec.volumes[].awsElasticBlockStore

説明
awsElasticBlockStore は、kubelet のホストマシンに割り当てられ、Pod に公開される AWS Disk リソースを表します。詳細: 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 TODO: ファイルシステムのエラーによるマシンの侵害を防ぐにはどうすればよいですか ?

パーティション

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

9.1.241. .spec.volumes[].azureDisk

説明
azureDisk は、ホスト上の Azure Data Disk マウントを表し、Pod へのバインドマウントを表します。
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 設定が強制的に実行されます。

9.1.242. .spec.volumes[].azureFile

説明
azureFile は、ホスト上の Azure File Service マウントを表し、マウントを Pod にバインドします。
object
必須
  • secretName
  • shareName
Expand
プロパティー説明

readOnly

boolean

readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

secretName

string

secretName は、Azure ストレージアカウント名とキーを含むシークレットの名前です。

shareName

string

shareName は Azure 共有名です。

9.1.243. .spec.volumes[].cephfs

説明
cephFS は、Pod の有効期間を共有するホストでの Ceph FS マウントを表します。
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

9.1.244. .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 TODO: その他の便利なルール度を追加。apiVersion、kind、uid

9.1.245. .spec.volumes[].cinder

説明
Cinder は、kubelets ホストマシンに接続およびマウントされた Cinder ボリュームを表します。詳細: 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

9.1.246. .spec.volumes[].cinder.secretRef

説明
secretRef は任意: OpenStack への接続に使用されるパラメーターを含むシークレットオブジェクトを指します。
object
Expand
プロパティー説明

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

9.1.247. .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 TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

任意。ConfigMap かそのキーを定義する必要があるかどうかを指定します。

9.1.248. .spec.volumes[].configMap.items

説明
item が指定されていない場合、参照される ConfigMap の Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。ConfigMap に存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
array

9.1.249. .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 はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。

9.1.250. .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 ドライバーに渡されるドライバー固有のプロパティーを格納します。サポートされている値は、ドライバーのドキュメントを参照してください。

9.1.251. .spec.volumes[].csi.nodePublishSecretRef

説明
nodePublishSecretRef は、CSI NodePublishVolume および NodeUnpublishVolume 呼び出しを完了するために CSI ドライバーに渡す機密情報を含むシークレットオブジェクトへの参照です。このフィールドはオプションであり、シークレットが不要な場合は空の場合があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレット参照が渡されます。
object
Expand
プロパティー説明

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

9.1.252. .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 フィールドを含むファイルを作成するための情報を表します

9.1.253. .spec.volumes[].downwardAPI.items

説明
items は、Downward API ボリュームファイルのリストです
array

9.1.254. .spec.volumes[].downwardAPI.items[]

説明
DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します
object
必須
  • path
Expand
プロパティー説明

fieldRef

object

必須:Pod のフィールドを選択します。アノテーション、ラベル、名前、名前空間のみがサポートされます。

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) のみがサポートされています。

9.1.255. .spec.volumes[].downwardAPI.items[].fieldRef

Description
必須:Pod のフィールドを選択します。アノテーション、ラベル、名前、名前空間のみがサポートされます。
タイプ
object
必須
  • fieldPath
Expand
プロパティー説明

apiVersion

string

FieldPath が記述されているスキーマのバージョン。デフォルトは "v1" です。

fieldPath

string

指定された API バージョンで選択するフィールドのパス。

9.1.256. .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

必須: 選択するリソース

9.1.257. .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 です。これは、制限が未定義であることを意味します。詳細: http://kubernetes.io/docs/user-guide/volumes#emptydir

9.1.258. .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 であってはなりません。

9.1.259. .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 と同じフィールドがここでも有効です。

9.1.260. .spec.volumes[].ephemeral.volumeClaimTemplate.metadata

説明
PVC の作成時に PVC にコピーされるラベルとアノテーションが含まれる場合があります。他のフィールドは許可されておらず、検証中に拒否されます。
object

9.1.261. .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 機能ゲートが有効になっている場合、このフィールドは常に DataSourceRef フィールドと同じ内容になります。

dataSourceRef

object

dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これは、空でない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のローカルオブジェクトである可能性があります。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、DataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性のために、両方のフィールド (DataSource と DataSourceRef) は、一方が空でもう一方が空でない場合、自動的に同じ値に設定されます。DataSource と DataSourceRef には 2 つの重要な違いがあります。*DataSource は 2 つの特定のタイプのオブジェクトのみを許可しますが、DataSourceRef は非コアオブジェクトと PersistentVolumeClaim オブジェクトを許可します。* DataSource は許可されていない値を無視 (ドロップ) しますが、DataSourceRef はすべての値を保持し、許可されていない値が指定されている場合はエラーを生成します。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。

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

volumeMode

string

volumeMode は、要求に必要なボリュームのタイプを定義します。Filesystem の値は、要求仕様に含まれていない場合に暗示されます。

volumeName

string

volumeName は、この要求をサポートする PersistentVolume へのバインディング参照です。

9.1.262. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSource

説明
dataSource フィールドは、次のいずれかを指定するために使用できます。*既存の VolumeSnapshot オブジェクト (snapshot.storage.k8s.io/VolumeSnapshot)*既存の PVC(PersistentVolumeClaim) プロビジョナーまたは外部コントローラーが指定されたデータソースをサポートできる場合、指定されたデータソースのコンテンツに基づく新しいボリューム。AnyVolumeDataSource 機能ゲートが有効になっている場合、このフィールドは常に DataSourceRef フィールドと同じ内容になります。
タイプ
object
必須
  • kind
  • name
Expand
プロパティー説明

apiGroup

string

APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。

kind

string

kind は参照されているリソースのタイプです。

name

string

name は、参照されているリソースの名前です。

9.1.263. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef

説明
dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これは、空でない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のローカルオブジェクトである可能性があります。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、DataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性のために、両方のフィールド (DataSource と DataSourceRef) は、一方が空でもう一方が空でない場合、自動的に同じ値に設定されます。DataSource と DataSourceRef には 2 つの重要な違いがあります。*DataSource は 2 つの特定のタイプのオブジェクトのみを許可しますが、DataSourceRef は非コアオブジェクトと PersistentVolumeClaim オブジェクトを許可します。* DataSource は許可されていない値を無視 (ドロップ) しますが、DataSourceRef はすべての値を保持し、許可されていない値が指定されている場合はエラーを生成します。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。
object
必須
  • kind
  • name
Expand
プロパティー説明

apiGroup

string

APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。

kind

string

kind は参照されているリソースのタイプです。

name

string

name は、参照されているリソースの名前です。

9.1.264. .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/ を参照してください。

9.1.265. .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 で結合されます。

9.1.266. .spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

9.1.267. .spec.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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

9.1.268. .spec.volumes[].fc

説明
fc は、kubelet のホストマシンに接続されてから Pod に公開されるファイバーチャネルリソースを表します。
object
Expand
プロパティー説明

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。TODO: ファイルシステムのエラーがマシンを危険にさらすのを防ぐにはどうすればよいですか ?

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 の組み合わせのいずれかを設定する必要がありますが、両方を同時に設定できません。

9.1.269. .spec.volumes[].flexVolume

説明
flexVolume は、exec ベースのプラグインを使用してプロビジョニング/接続される汎用ボリュームリソースを表します。
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 は、プラグインスクリプトに渡す機密情報を含むシークレットオブジェクトへの参照です。シークレットオブジェクトが指定されていない場合、これは空になる可能性があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレットがプラグインスクリプトに渡されます。

9.1.270. .spec.volumes[].flexVolume.secretRef

説明
secretRef は任意: secretRef は、プラグインスクリプトに渡す機密情報を含むシークレットオブジェクトへの参照です。シークレットオブジェクトが指定されていない場合、これは空になる可能性があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレットがプラグインスクリプトに渡されます。
object
Expand
プロパティー説明

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

9.1.271. .spec.volumes[].flocker

説明
flocker は、kubelet のホストマシンに接続されている Flocker ボリュームを表します。これは、実行中の Flocker 制御サービスによって異なります
object
Expand
プロパティー説明

datasetName

string

datasetName はメタデータとして保存されているデータセットの名前です → Flocker のデータセット上の名前は非推奨として扱うようにしてください。

datasetUUID

string

datasetUUID は、データセットの UUID です。これは Flocker データセットの一意の識別子です

9.1.272. .spec.volumes[].gcePersistentDisk

説明
gcePersistentDisk は、kubelet のホストマシンに接続されてから Pod に公開される GCE ディスクリソースを表します。詳細: 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 TODO: ファイルシステムのエラーによるマシンの侵害を防ぐにはどうすればよいですか ?

パーティション

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

9.1.273. .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 は、指定されたリビジョンのコミットハッシュです。

9.1.274. .spec.volumes[].glusterfs

説明
glusterfs は、Pod の存続期間を共有するホスト上の 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

9.1.275. .spec.volumes[].hostPath

説明
hostPath は、コンテナーに直接公開されているホストマシン上の既存のファイルまたはディレクトリーを表します。これは通常、ホストマシンの表示を許可されているシステムエージェントまたはその他の特権的なものに使用されます。ほとんどのコンテナーはこれを必要としません。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) ホストディレクトリーのマウントを使用できる人、およびホストディレクトリーを読み取り/書き込みでマウントできる人/できない人を制限する必要があります。
object
必須
  • path
Expand
プロパティー説明

path

string

ホスト上のディレクトリーのパス。パスがシンボリックリンクの場合、実際のパスへのリンクをたどります。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

type

string

HostPath ボリュームのデフォルトのタイプは "" です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

9.1.276. .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 TODO: ファイルシステムのエラーによるマシンの侵害を防ぐにはどうすればよいですか ?

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)。

9.1.277. .spec.volumes[].iscsi.secretRef

説明
secretRef は、iSCSI ターゲットおよびイニシエーター認証用の CHAP Secret です。
object
Expand
プロパティー説明

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

9.1.278. .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

9.1.279. .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

9.1.280. .spec.volumes[].photonPersistentDisk

説明
photonPersistentDisk は、kubelets ホストマシンに接続されマウントされた PhotonController 永続ディスクを表します。
object
必須
  • pdID
Expand
プロパティー説明

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

pdID

string

pdID は、Photon Controller の永続ディスクを識別する ID です。

9.1.281. .spec.volumes[].portworxVolume

説明
portworxVolume は、kubelet ホストマシンに接続およびマウントされた portworx ボリュームを表します。
object
必須
  • volumeID
Expand
プロパティー説明

fsType

string

fSType は、マウントするファイルシステムタイプを表します。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

readOnly

boolean

readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

volumeID

string

volumeID は、Portworx ボリュームを一意に識別します

9.1.282. .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

source は、ボリュームプロジェクションのリストです。

sources[]

object

サポートされている他のボリュームタイプと一緒にデプロイメントされる可能性のあるプロジェクション

9.1.283. .spec.volumes[].projected.sources

説明
source は、ボリュームプロジェクションのリストです。
array

9.1.284. .spec.volumes[].projected.sources[]

説明
サポートされている他のボリュームタイプと一緒にデプロイメントされる可能性のあるプロジェクション
object
Expand
プロパティー説明

configMap

object

プロジェクトへの configMap データの configMap 情報

downwardAPI

object

downwardAPI データのプロジェクトへの downwardAPI 情報

secret

object

投影するシークレットデータに関する情報

serviceAccountToken

object

serviceAccountToken は、投影する serviceAccountToken データに関する情報です。

9.1.285. .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 TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

任意。ConfigMap かそのキーを定義する必要があるかどうかを指定します。

9.1.286. .spec.volumes[].projected.sources[].configMap.items

説明
item が指定されていない場合、参照される ConfigMap の Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。ConfigMap に存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
array

9.1.287. .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 はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。

9.1.288. .spec.volumes[].projected.sources[].downwardAPI

説明
downwardAPI データのプロジェクトへの downwardAPI 情報
object
Expand
プロパティー説明

items

array

Items は DownwardAPIVolume ファイルのリストです

items[]

object

DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します

9.1.289. .spec.volumes[].projected.sources[].downwardAPI.items

説明
Items は DownwardAPIVolume ファイルのリストです
array

9.1.290. .spec.volumes[].projected.sources[].downwardAPI.items[]

説明
DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します
object
必須
  • path
Expand
プロパティー説明

fieldRef

object

必須:Pod のフィールドを選択します。アノテーション、ラベル、名前、名前空間のみがサポートされます。

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) のみがサポートされています。

9.1.291. .spec.volumes[].projected.sources[].downwardAPI.items[].fieldRef

Description
必須:Pod のフィールドを選択します。アノテーション、ラベル、名前、名前空間のみがサポートされます。
タイプ
object
必須
  • fieldPath
Expand
プロパティー説明

apiVersion

string

FieldPath が記述されているスキーマのバージョン。デフォルトは "v1" です。

fieldPath

string

指定された API バージョンで選択するフィールドのパス。

9.1.292. .spec.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

必須: 選択するリソース

9.1.293. .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 TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

オプションフィールドは、シークレットかそのキーを定義する必要があるかどうかを指定します。

9.1.294. .spec.volumes[].projected.sources[].secret.items

説明
items が指定されていない場合、参照されるシークレットの Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。シークレットに存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
array

9.1.295. .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 はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。

9.1.296. .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 は、トークンのデプロイメント先となるファイルのマウントポイントに対する相対パスです。

9.1.297. .spec.volumes[].quobyte

説明
quobyte は、Pod の有効期限を共有するホストでの 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 は、すでに作成されているクオバイトボリュームを名前で参照する文字列です。

9.1.298. .spec.volumes[].rbd

説明
rbd は、Pod の有効期間を共有するホストの Rados ブロックデバイスマウントを表します。詳細: 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 TODO: ファイルシステムのエラーによるマシンの侵害を防ぐにはどうすればよいですか ?

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

9.1.299. .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 TODO: その他の便利なルール度を追加。apiVersion、kind、uid

9.1.300. .spec.volumes[].scaleIO

説明
scaleIO は、Kubernetes ノードに接続およびマウントされた 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 システムですでに作成されているボリュームの名前です。

9.1.301. .spec.volumes[].scaleIO.secretRef

説明
secretRef は、ScaleIO ユーザーおよびその他の機密情報の秘密を参照します。これが指定されていない場合、ログイン操作は失敗します。
object
Expand
プロパティー説明

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

9.1.302. .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

9.1.303. .spec.volumes[].secret.items

説明
items が指定されていない場合、参照されるシークレットの Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。シークレットに存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
array

9.1.304. .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 はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。

9.1.305. .spec.volumes[].storageos

説明
storageOS は、Kubernetes ノードに接続およびマウントされた 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 が作成されます。

9.1.306. .spec.volumes[].storageos.secretRef

説明
secretRef は、StorageOS API クレデンシャルを取得するために使用するシークレットを指定します。指定しない場合、デフォルト値が試行されます。
object
Expand
プロパティー説明

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

9.1.307. .spec.volumes[].vsphereVolume

説明
vsphereVolume は、kubelet ホストマシンに接続およびマウントされた vSphere ボリュームを表します。
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 を識別するパスです。

9.1.308. .status

説明
ThanosRuler クラスターの最新の観測ステータス。read-onlyapiserver からのリクエストには含まれず、ThanosRulerOperatorAPI 自体からのみ含まれます。詳細: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
object
必須
  • availableReplicas
  • paused
  • replicas
  • unavailableReplicas
  • updatedReplicas
Expand
プロパティー説明

availableReplicas

integer

この ThanosRuler デプロイメントの対象となる利用可能な Pod の総数 (少なくとも minReadySeconds の準備ができています)。

paused

boolean

基になるマネージドオブジェクトに対してアクションが実行されているかどうかを表します。削除アクションのみが実行されます。

replicas

integer

この ThanosRuler デプロイメントの対象となる非終了 Pod の総数 (ラベルはセレクターと一致します)。

unavailableReplicas

integer

この ThanosRuler デプロイメントの対象となる使用できない Pod の総数。

updatedReplicas

integer

この ThanosRuler デプロイメントの対象であり、目的のバージョン仕様を持つ、終了していない Pod の総数。

9.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/monitoring.coreos.com/v1/thanosrulers

    • GET: 種類が ThanosRuler のオブジェクトをリスト表示します。
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/thanosrulers

    • DELETE: ThanosRuler のコレクションを削除します。
    • GET: 種類が ThanosRuler のオブジェクトをリスト表示します。
    • POST: ThanosRuler を作成します。
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/thanosrulers/{name}

    • DELETE: ThanosRuler を削除します。
    • GET: 指定された ThanosRuler を読み取ります。
    • PATCH: 指定された ThanosRuler を部分的に更新します。
    • PUT: 指定された ThanosRuler を交換してください

9.2.1. /apis/monitoring.coreos.com/v1/thanosrulers

Expand
表9.1 グローバルクエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

HTTP メソッド
GET
説明
種類が ThanosRuler のオブジェクトをリスト表示します。
Expand
表9.2 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ThanosRulerList スキーマ

401 - Unauthorized

空白

9.2.2. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/thanosrulers

Expand
表9.3 グローバルパスパラメーター
パラメーター説明

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

Expand
表9.4 グローバルクエリーパラメーター
パラメーター説明

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
ThanosRuler のコレクションを削除する
Expand
表9.5 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表9.6 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
ThanosRuler の種類のオブジェクトをリスト表示します
Expand
表9.7 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表9.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ThanosRulerList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
ThanosRuler を作成する
Expand
表9.9 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

fieldValidation

string

fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表9.10 ボディーパラメーター
パラメーター説明

ボディー

ThanosRuler スキーマ

 
Expand
表9.11 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ThanosRuler スキーマ

201 - Created

ThanosRuler スキーマ

202 - Accepted

ThanosRuler スキーマ

401 - Unauthorized

空白

9.2.3. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/thanosrulers/{name}

Expand
表9.12 グローバルパスパラメーター
パラメーター説明

name

string

ThanosRuler の名前

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

Expand
表9.13 グローバルクエリーパラメーター
パラメーター説明

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
ThanosRuler を削除する
Expand
表9.14 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

gracePeriodSeconds

integer

オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。

orphanDependents

boolean

非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。

propagationPolicy

string

ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。

Expand
表9.15 本文パラメーター
パラメーター説明

body

DeleteOptions スキーマ

 
Expand
表9.16 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された ThanosRuler を読みます
Expand
表9.17 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表9.18 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ThanosRuler スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された ThanosRuler を部分的に更新します
Expand
表9.19 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

fieldValidation

string

fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表9.20 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表9.21 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ThanosRuler スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された ThanosRuler を置き換えます。
Expand
表9.22 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

fieldValidation

string

fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表9.23 ボディーパラメーター
パラメーター説明

ボディー

ThanosRuler スキーマ

 
Expand
表9.24 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ThanosRuler スキーマ

201 - Created

ThanosRuler スキーマ

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